2 ;;; tm-view.el --- interactive MIME viewer for GNU Emacs
4 ;;; Copyright (C) 1995 Free Software Foundation, Inc.
5 ;;; Copyright (C) 1994,1995 MORIOKA Tomohiko
7 ;;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
8 ;;; Keywords: mail, news, MIME, multimedia
10 ;;; This file is part of tm (Tools for MIME).
27 (defconst mime-viewer/RCS-ID
28 "$Id: tm-view.el,v 7.25 1995/11/15 13:57:33 morioka Exp $")
30 (defconst mime-viewer/version (get-version-string mime-viewer/RCS-ID))
31 (defconst mime/viewer-version mime-viewer/version)
37 (defvar mime/content-decoding-condition
38 '(((type . "text/plain")
39 (method "tm-plain" nil 'file 'type 'encoding 'mode 'name))
40 ;;((type . "text/x-latex")
41 ;; (method "tm-latex" nil 'file 'type 'encoding 'mode 'name))
42 ((type . "text/x-rot13-47")
43 (method . mime-article/decode-caesar))
45 ((type . "audio/basic")
46 (method "tm-au" nil 'file 'type 'encoding 'mode 'name))
49 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
50 ((type . "image/jpeg")
51 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
52 ((type . "image/tiff")
53 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
54 ((type . "image/x-tiff")
55 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
56 ((type . "image/x-xbm")
57 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
58 ((type . "image/x-pic")
59 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
61 ((type . "video/mpeg")
62 (method "tm-mpeg" nil 'file 'type 'encoding 'mode 'name))
64 ((type . "application/octet-stream")
65 (method "tm-file" nil 'file 'type 'encoding 'mode 'name))
67 ;;((type . "message/external-body")
68 ;; (method "xterm" nil
69 ;; "-e" "showexternal"
70 ;; 'file '"access-type" '"name" '"site" '"directory"))
71 ((type . "message/rfc822")
72 (method . mime-article/view-message/rfc822))
73 ((type . "message/partial")
74 (method . mime-article/decode-message/partial))
77 "-m" "tm" "-x" "-d" "-z" "-e" 'file)(mode . "play"))
78 ((method "tm-file" nil 'file 'type 'encoding 'mode 'name)
82 (defvar mime-viewer/childrens-header-showing-Content-Type-list
83 '("message/rfc822" "message/news"))
85 (defvar mime-viewer/default-showing-Content-Type-list
86 '("text/plain" "text/richtext" "text/enriched"
87 "text/x-latex" "application/x-latex"
88 "application/octet-stream" nil
90 "application/x-selection" "application/x-comment"))
92 (defvar mime-viewer/content-subject-omitting-Content-Type-list
93 '("application/x-selection"))
95 (defvar mime-viewer/uuencode-encoding-name-list '("x-uue" "x-uuencode"))
97 (defvar mime-viewer/ignored-field-list
98 '("Received" "Return-Path" "Replied" "Errors-To"
99 "Lines" "Sender" "Path" "Nntp-Posting-Host"
100 "Content-Type" "Precedence" "X-Face"
102 "All fields that match this list will be hidden in MIME preview buffer.
103 Each elements are regexp of field-name. [tm-view.el]")
105 (defvar mime-viewer/ignored-field-regexp
107 (apply (function regexp-or) mime-viewer/ignored-field-list)
110 (defvar mime-viewer/announcement-for-message/partial
111 (if (and (>= emacs-major-version 19) window-system)
113 \[[ This is message/partial style split message. ]]
114 \[[ Please press `v' key in this buffer ]]
115 \[[ or click here by mouse button-2. ]]"
117 \[[ This is message/partial style split message. ]]
118 \[[ Please press `v' key in this buffer. ]]"
122 ;;; @@ predicate functions
125 (defun mime-viewer/header-visible-p (rcnum cinfo &optional ctype)
129 (mime::content-info/type
130 (mime-article/rcnum-to-cinfo (cdr rcnum) cinfo)
132 (member ctype mime-viewer/childrens-header-showing-Content-Type-list)
135 (defun mime-viewer/body-visible-p (rcnum cinfo &optional ctype)
139 (mime::content-info/type
140 (setq ccinfo (mime-article/rcnum-to-cinfo rcnum cinfo))
143 (and (member ctype mime-viewer/default-showing-Content-Type-list)
144 (if (string-equal ctype "application/octet-stream")
147 (setq ccinfo (mime-article/rcnum-to-cinfo rcnum cinfo))
149 (member (mime::content-info/encoding ccinfo)
150 '(nil "7bit" "8bit"))
156 ;;; @@ content subject
159 (defun mime-viewer/insert-content-subject
160 (rcnum cinfo ctype params subj)
162 (narrow-to-region (point)(point))
164 (let ((access-type (assoc "access-type" params))
165 (num (or (assoc-value "x-part-number" params)
169 (format "%s" (1+ num))
175 (let ((server (assoc "server" params)))
176 (setq access-type (cdr access-type))
178 (format "[%s %s ([%s] %s)]\n" num subj
179 access-type (cdr server))
180 (let ((site (assoc-value "site" params))
181 (dir (assoc-value "directory" params))
183 (format "[%s %s ([%s] %s:%s)]\n" num subj
184 access-type site dir)
186 (format "[%s %s (%s)]\n" num subj ctype)
188 (tm:add-button (point-min)(1- (point-max))
189 (function mime-viewer/play-content))
192 (defun mime-viewer/default-content-subject-function
193 (rcnum cinfo ctype params subj)
194 (if (and (consp rcnum)
197 mime-viewer/content-subject-omitting-Content-Type-list))
199 (mime-viewer/insert-content-subject
200 rcnum cinfo ctype params subj)
203 (defvar mime-viewer/content-subject-function
204 (function mime-viewer/default-content-subject-function))
207 ;;; @@ content header filter
210 (defun mime-viewer/default-content-header-filter ()
211 (goto-char (point-min))
212 (while (and (re-search-forward mime-viewer/ignored-field-regexp nil t)
218 (re-search-forward "^\\([^ \t]\\|$\\)" nil t)
222 (mime/decode-message-header)
225 (defvar mime-viewer/content-header-filter-alist nil)
228 ;;; @@ content filter
231 (defvar mime-viewer/content-filter-alist
232 '(("text/plain" . mime-viewer/filter-text/plain)
233 ("application/pgp" . mime-viewer/filter-text/plain)
234 (nil . mime-viewer/filter-text/plain)))
236 (defun mime-viewer/default-content-filter (rcnum cinfo ctype params subj)
240 ;;; @@ content separator
243 (defun mime-viewer/default-content-separator (rcnum cinfo ctype params subj)
244 (if (and (not (mime-viewer/header-visible-p rcnum cinfo ctype))
245 (not (mime-viewer/body-visible-p rcnum cinfo ctype))
248 (goto-char (point-max))
253 ;;; @@ buffer local variables
256 (defvar mime/show-mode-old-window-configuration nil)
257 (defvar mime::preview/mother-buffer nil)
259 (defvar mime::article/content-info nil)
260 (defvar mime::article/preview-buffer nil)
262 (defvar mime::preview/article-buffer nil)
263 (defvar mime::preview/content-list nil)
264 (defvar mime::preview/original-major-mode nil)
267 ;;; @@ quitting method
270 (defvar mime-viewer/quitting-method-alist
271 '((mime/show-message-mode
272 . mime-viewer/quitting-method-for-mime/show-message-mode)))
274 (defvar mime-viewer/over-to-previous-method-alist nil)
275 (defvar mime-viewer/over-to-next-method-alist nil)
281 ;; hack from Gnus 5.0.4.
283 (defvar mime-viewer/x-face-command
284 "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | xv -quit -"
285 "String to be executed to display an X-Face field.
286 The command will be executed in a sub-shell asynchronously.
287 The compressed face will be piped to this command.")
289 (defun mime-viewer/x-face-function ()
290 "Function to display X-Face field. You can redefine to customize."
291 ;; 1995/10/12 (c.f. tm-eng:130)
292 ;; fixed by Eric Ding <ericding@San-Jose.ate.slb.com>
294 (narrow-to-region (point-min) (re-search-forward "^$" nil t))
296 (goto-char (point-min))
297 (if (re-search-forward "^X-Face:[ \t]*" nil t)
298 (let ((beg (match-end 0))
299 (end (rfc822/field-end))
301 (call-process-region beg end "sh" nil 0 nil
302 "-c" mime-viewer/x-face-command)
306 ;;; @ data structures
309 ;;; @@ preview-content-info
312 (define-structure mime::preview-content-info
313 point-min point-max buffer content-info)
319 (defun mime-viewer/setup-buffer (&optional ctl encoding ibuf obuf)
325 (make-variable-buffer-local 'mime::article/content-info)
326 (setq mime::article/content-info (mime/parse-message ctl encoding))
327 (let ((ret (mime-viewer/make-preview-buffer obuf)))
328 (make-variable-buffer-local 'mime::article/preview-buffer)
329 (setq mime::article/preview-buffer (car ret))
332 (defun mime-viewer/make-preview-buffer (&optional obuf)
333 (let ((cinfo mime::article/content-info)
334 (the-buf (current-buffer))
338 (setq obuf (concat "*Preview-" (buffer-name the-buf) "*"))
340 (setq pcl (mime/flatten-content-info cinfo))
341 (let ((bf (get-buffer obuf)))
345 (setq buffer-read-only nil)
348 (setq bf (get-buffer-create obuf))
351 (make-variable-buffer-local 'mime::preview/article-buffer)
352 (setq mime::preview/article-buffer the-buf)
353 (make-variable-buffer-local 'mime::preview/original-major-mode)
354 (setq mime::preview/original-major-mode mode)
355 (setq major-mode 'mime/viewer-mode)
356 (setq mode-name "MIME-View")
361 (mime-viewer/display-content content cinfo the-buf obuf)
364 (set-buffer-modified-p nil)
365 (setq buffer-read-only t)
370 (defun mime-viewer/display-content (content cinfo ibuf obuf)
371 (let* ((beg (mime::content-info/point-min content))
372 (end (mime::content-info/point-max content))
373 (ctype (mime::content-info/type content))
374 (params (mime::content-info/parameters content))
375 (encoding (mime::content-info/encoding content))
376 (rcnum (mime::content-info/rcnum content))
380 (setq he (if (re-search-forward "^$" nil t)
387 (narrow-to-region beg end)
389 (mime-eword/decode-string
390 (mime-viewer/get-subject params encoding)))
394 (narrow-to-region nb nb)
395 (funcall mime-viewer/content-subject-function
396 rcnum cinfo ctype params subj)
398 (if (mime-viewer/header-visible-p rcnum cinfo ctype)
399 (mime-viewer/display-header beg he obuf)
401 (cond ((mime-viewer/body-visible-p rcnum cinfo ctype)
402 (mime-viewer/display-body he end obuf
403 rcnum cinfo ctype params subj encoding)
405 ((equal ctype "message/partial")
406 (mime-viewer/display-message/partial obuf)
409 (null (mime::content-info/children cinfo))
412 (goto-char (point-max))
413 (mime-viewer/insert-content-subject rcnum cinfo ctype params subj)
415 (t (set-buffer obuf))
417 (mime-viewer/default-content-separator rcnum cinfo ctype params subj)
420 (setq ne (point-max))
422 (mime::preview-content-info/create nb (1- ne) ibuf content)
427 (defun mime-viewer/display-header (beg end obuf)
428 (let ((str (buffer-substring beg end))
429 (f (assq major-mode mime-viewer/content-header-filter-alist))
434 (narrow-to-region (point)(point))
436 (if (and f (setq f (cdr f)))
438 (mime-viewer/default-content-header-filter)
440 (run-hooks 'mime-viewer/content-header-filter-hook)
443 (defun mime-viewer/display-body (beg end obuf
444 rcnum cinfo ctype params subj encoding)
445 (let ((str (buffer-substring beg end))
449 (setq be (point-max))
450 (narrow-to-region be be)
452 (let ((f (assoc-value ctype mime-viewer/content-filter-alist)))
453 (if (and f (fboundp f))
454 (funcall f ctype params encoding)
455 (mime-viewer/default-content-filter rcnum cinfo ctype params subj)
459 (defun mime-viewer/display-message/partial (obuf)
462 (goto-char (point-max))
463 (if (not (search-backward "\n\n" nil t))
466 (let ((be (point-max)))
467 (narrow-to-region be be)
468 (insert mime-viewer/announcement-for-message/partial)
469 (tm:add-button (point-min)(point-max)
470 (function mime-viewer/play-content))
473 (defun mime-viewer/get-subject (param &optional encoding)
474 (if (member (or encoding
475 (cdr (assq 'encoding param))
477 mime-viewer/uuencode-encoding-name-list)
479 (or (if (re-search-forward "^begin [0-9]+ " nil t)
480 (if (looking-at ".+$")
481 (buffer-substring (match-beginning 0)(match-end 0))
485 (or (and (setq ret (assoc "name" param))
486 (rfc822/strip-quoted-string (cdr ret))
488 (and (setq ret (assoc "x-name" param))
489 (rfc822/strip-quoted-string (cdr ret))
494 (goto-char (point-min))
495 (narrow-to-region (point-min)
496 (or (and (search-forward "\n\n" nil t)
501 (rfc822/get-field-body "Content-Description")
502 (rfc822/get-field-body "Subject")
508 ;;; @ content information
511 (defun mime-article/point-content-number (p &optional cinfo)
513 (setq cinfo mime::article/content-info)
515 (let ((b (mime::content-info/point-min cinfo))
516 (e (mime::content-info/point-max cinfo))
517 (c (mime::content-info/children cinfo))
519 (if (and (<= b p)(<= p e))
520 (or (let (co ret (sn 0))
524 (setq ret (mime-article/point-content-number p co))
525 (cond ((eq ret t) (throw 'tag (list sn)))
526 (ret (throw 'tag (cons sn ret)))
533 (defun mime-article/rcnum-to-cinfo (rcnum &optional cinfo)
535 (setq cinfo mime::article/content-info)
540 (equal (mime::content-info/rcnum ci) rcnum)
542 (mime/flatten-content-info cinfo)
545 (defun mime-article/cnum-to-cinfo (cn &optional cinfo)
547 (setq cinfo mime::article/content-info)
554 (let ((rc (nth sn (mime::content-info/children cinfo))))
556 (mime-article/cnum-to-cinfo (cdr cn) rc)
560 (defun mime/flatten-content-info (&optional cinfo)
562 (setq cinfo mime::article/content-info)
564 (let ((dest (list cinfo))
565 (rcl (mime::content-info/children cinfo))
568 (setq dest (nconc dest (mime/flatten-content-info (car rcl))))
573 (defun mime::point-preview-content (p &optional pcl)
575 (setq pcl mime::preview/content-list)
581 (if (and (<= (mime::preview-content-info/point-min cell) p)
582 (<= p (mime::preview-content-info/point-max cell))
595 (defvar mime-viewer/code-converter-alist
596 '((mime/show-message-mode . mime/code-convert-region-to-emacs))
599 (defun mime-viewer/default-code-convert-region
600 (beg end charset &optional encoding)
601 (if (member encoding '("quoted-printable" "base64"))
602 (mime/code-convert-region-to-emacs beg (point-max) charset)
605 (defun mime-preview/decode-text-region (beg end charset encoding)
606 (mime/decode-region encoding beg end)
607 (let* ((mode mime::preview/original-major-mode)
608 (m (assq mode mime-viewer/code-converter-alist))
610 (if (and m (fboundp (setq m (cdr m))))
611 (funcall m beg (point-max) charset encoding)
612 (mime-viewer/default-code-convert-region
613 beg (point-max) charset encoding)
616 (defun mime-viewer/filter-text/plain (ctype params encoding)
617 (let ((charset (cdr (assoc "charset" params)))
618 (beg (point-min)) (end (point-max))
620 (mime-preview/decode-text-region beg end charset encoding)
622 (goto-char (point-max))
623 (if (not (eq (char-after (1- (point))) ?\n))
626 (if browse-url-browser-function
628 (goto-char (point-min))
629 (while (re-search-forward tm:URL-regexp nil t)
630 (tm:add-button (match-beginning 0)(match-end 0)
631 (function tm:browse-url))
633 (run-hooks 'mime-viewer/plain-text-preview-hook)
637 ;;; @ MIME viewer mode
640 (defvar mime/viewer-mode-map nil)
641 (if (null mime/viewer-mode-map)
643 (setq mime/viewer-mode-map (make-keymap))
644 (suppress-keymap mime/viewer-mode-map)
645 (define-key mime/viewer-mode-map
646 "u" (function mime-viewer/up-content))
647 (define-key mime/viewer-mode-map
648 "p" (function mime-viewer/previous-content))
649 (define-key mime/viewer-mode-map
650 "n" (function mime-viewer/next-content))
651 (define-key mime/viewer-mode-map
652 " " (function mime-viewer/scroll-up-content))
653 (define-key mime/viewer-mode-map
654 "\M- " (function mime-viewer/scroll-down-content))
655 (define-key mime/viewer-mode-map
656 "\177" (function mime-viewer/scroll-down-content))
657 (define-key mime/viewer-mode-map
658 "\C-m" (function mime-viewer/next-line-content))
659 (define-key mime/viewer-mode-map
660 "\C-\M-m" (function mime-viewer/previous-line-content))
661 (define-key mime/viewer-mode-map
662 "v" (function mime-viewer/play-content))
663 (define-key mime/viewer-mode-map
664 "e" (function mime-viewer/extract-content))
665 (define-key mime/viewer-mode-map
666 "\C-c\C-p" (function mime-viewer/print-content))
667 (define-key mime/viewer-mode-map
668 "f" (function mime-viewer/display-x-face))
669 (define-key mime/viewer-mode-map
670 "q" (function mime-viewer/quit))
671 (define-key mime/viewer-mode-map
672 "\C-c\C-x" (function mime-viewer/kill-buffer))
674 (define-key mime/viewer-mode-map
675 mouse-button-2 (function tm:button-dispatcher))
679 (defun mime/viewer-mode (&optional mother ctl encoding ibuf obuf)
680 "Major mode for viewing MIME message.
682 Here is a list of the standard keys for mime/viewer-mode.
687 u Move to upper content
688 p Move to previous content
689 n Move to next content
690 SPC Scroll up or move to next content
691 M-SPC Scroll down or move to previous content
692 DEL Scroll down or move to previous content
693 RET Move to next line
694 M-RET Move to previous line
695 v Decode current content as `play mode'
696 e Decode current content as `extract mode'
697 C-c C-p Decode current content as `print mode'
700 button-2 Move to point under the mouse cursor
701 and decode current content as `play mode'
704 Here are all the commands with their current binding,
707 \\{mime/viewer-mode-map}
710 (let ((buf (get-buffer mime/output-buffer-name)))
716 (let ((ret (mime-viewer/setup-buffer ctl encoding ibuf obuf)))
718 (switch-to-buffer (car ret))
721 (make-variable-buffer-local
722 'mime/show-mode-old-window-configuration)
723 (setq mime/show-mode-old-window-configuration
724 (current-window-configuration))
725 (make-variable-buffer-local 'mime::preview/mother-buffer)
726 (setq mime::preview/mother-buffer mother)
728 (use-local-map mime/viewer-mode-map)
729 (make-variable-buffer-local 'mime::preview/content-list)
730 (setq mime::preview/content-list (nth 1 ret))
732 (let ((ce (mime::preview-content-info/point-max
733 (car mime::preview/content-list)
736 (goto-char (point-min))
737 (search-forward "\n\n" nil t)
738 (setq e (match-end 0))
742 (run-hooks 'mime/viewer-mode-hook)
745 (defun mime-preview/point-content-number (point)
746 (save-window-excursion
747 (let ((pc (mime::point-preview-content (point)))
749 (switch-to-buffer (mime::preview-content-info/buffer pc))
750 (setq cinfo (mime::preview-content-info/content-info pc))
751 (mime-article/point-content-number (mime::content-info/point-min cinfo))
754 (defun mime-preview/cinfo-to-pcinfo (cinfo)
755 (let ((rpcl mime::preview/content-list) cell)
758 (setq cell (car rpcl))
759 (if (eq cinfo (mime::preview-content-info/content-info cell))
762 (setq rpcl (cdr rpcl))
765 (autoload 'mime-preview/decode-content "tm-play")
767 (defvar mime-viewer/decoding-mode "play" "MIME body decoding mode")
769 (defun mime-viewer/play-content ()
771 (let ((mime-viewer/decoding-mode "play"))
772 (mime-preview/decode-content)
775 (defun mime-viewer/extract-content ()
777 (let ((mime-viewer/decoding-mode "extract"))
778 (mime-preview/decode-content)
781 (defun mime-viewer/print-content ()
783 (let ((mime-viewer/decoding-mode "print"))
784 (mime-preview/decode-content)
787 (defun mime-viewer/display-x-face ()
789 (save-window-excursion
790 (set-buffer mime::preview/article-buffer)
791 (mime-viewer/x-face-function)
794 (defun mime-viewer/up-content ()
796 (let ((pc (mime::point-preview-content (point))) cinfo
797 (the-buf (current-buffer))
799 (switch-to-buffer (mime::preview-content-info/buffer pc))
800 (setq cinfo (mime::preview-content-info/content-info pc))
801 (setq rcnum (mime::content-info/rcnum cinfo))
803 (mime-viewer/quit the-buf
804 (mime::preview-content-info/buffer pc)
806 (setq r (mime-article/rcnum-to-cinfo (cdr rcnum)))
807 (switch-to-buffer the-buf)
809 (let ((rpcl mime::preview/content-list) cell)
811 (setq cell (car rpcl))
812 (if (eq r (mime::preview-content-info/content-info cell))
814 (goto-char (mime::preview-content-info/point-min cell))
817 (setq rpcl (cdr rpcl))
821 (defun mime-viewer/previous-content ()
823 (let* ((pcl mime::preview/content-list)
825 (i (- (length pcl) 1))
829 (setq beg (mime::preview-content-info/point-min (nth i pcl)))
831 (throw 'tag (goto-char beg))
835 (let ((f (assq mime::preview/original-major-mode
836 mime-viewer/over-to-previous-method-alist)))
843 (defun mime-viewer/next-content ()
845 (let ((pcl mime::preview/content-list)
850 (setq beg (mime::preview-content-info/point-min (car pcl)))
852 (throw 'tag (goto-char beg))
856 (let ((f (assq mime::preview/original-major-mode
857 mime-viewer/over-to-next-method-alist)))
864 (defun mime-viewer/scroll-up-content (&optional h)
867 (setq h (- (window-height) 1))
869 (let ((pcl mime::preview/content-list)
875 (setq beg (mime::preview-content-info/point-min (car pcl)))
889 (defun mime-viewer/scroll-down-content (&optional h)
892 (setq h (- (window-height) 1))
894 (let ((pcl mime::preview/content-list)
898 (or (let ((i (- (length pcl) 1)))
901 (setq beg (mime::preview-content-info/point-min
914 (defun mime-viewer/next-line-content ()
916 (mime-viewer/scroll-up-content 1)
919 (defun mime-viewer/previous-line-content ()
921 (mime-viewer/scroll-down-content 1)
924 (defun mime-viewer/quit (&optional the-buf buf)
927 (setq the-buf (current-buffer))
930 (setq buf (mime::preview-content-info/buffer
931 (mime::point-preview-content (point))))
934 (switch-to-buffer buf)
935 (assq major-mode mime-viewer/quitting-method-alist)
939 (switch-to-buffer the-buf)
944 (defun mime-viewer/kill-buffer ()
946 (kill-buffer (current-buffer))
955 (run-hooks 'tm-view-load-hook)