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.24 1995/11/14 06:14:37 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
106 (apply (function regexp-or) mime-viewer/ignored-field-list))
108 (defvar mime-viewer/announcement-for-message/partial
109 (if (and (>= emacs-major-version 19) window-system)
111 \[[ This is message/partial style split message. ]]
112 \[[ Please press `v' key in this buffer ]]
113 \[[ or click here by mouse button-2. ]]"
115 \[[ This is message/partial style split message. ]]
116 \[[ Please press `v' key in this buffer. ]]"
120 ;;; @@ predicate functions
123 (defun mime-viewer/header-visible-p (rcnum cinfo &optional ctype)
127 (mime::content-info/type
128 (mime-article/rcnum-to-cinfo (cdr rcnum) cinfo)
130 (member ctype mime-viewer/childrens-header-showing-Content-Type-list)
133 (defun mime-viewer/body-visible-p (rcnum cinfo &optional ctype)
137 (mime::content-info/type
138 (setq ccinfo (mime-article/rcnum-to-cinfo rcnum cinfo))
141 (and (member ctype mime-viewer/default-showing-Content-Type-list)
142 (if (string-equal ctype "application/octet-stream")
145 (setq ccinfo (mime-article/rcnum-to-cinfo rcnum cinfo))
147 (member (mime::content-info/encoding ccinfo)
148 '(nil "7bit" "8bit"))
154 ;;; @@ content subject
157 (defun mime-viewer/insert-content-subject
158 (rcnum cinfo ctype params subj)
160 (narrow-to-region (point)(point))
162 (let ((access-type (assoc "access-type" params))
163 (num (or (assoc-value "x-part-number" params)
167 (format "%s" (1+ num))
173 (let ((server (assoc "server" params)))
174 (setq access-type (cdr access-type))
176 (format "[%s %s ([%s] %s)]\n" num subj
177 access-type (cdr server))
178 (let ((site (assoc-value "site" params))
179 (dir (assoc-value "directory" params))
181 (format "[%s %s ([%s] %s:%s)]\n" num subj
182 access-type site dir)
184 (format "[%s %s (%s)]\n" num subj ctype)
186 (tm:add-button (point-min)(1- (point-max))
187 (function mime-viewer/play-content))
190 (defun mime-viewer/default-content-subject-function
191 (rcnum cinfo ctype params subj)
192 (if (and (consp rcnum)
195 mime-viewer/content-subject-omitting-Content-Type-list))
197 (mime-viewer/insert-content-subject
198 rcnum cinfo ctype params subj)
201 (defvar mime-viewer/content-subject-function
202 (function mime-viewer/default-content-subject-function))
205 ;;; @@ content header filter
208 (defun mime-viewer/default-content-header-filter ()
209 (goto-char (point-min))
210 (while (and (re-search-forward mime-viewer/ignored-field-regexp nil t)
216 (re-search-forward "^\\([^ \t]\\|$\\)" nil t)
220 (mime/decode-message-header)
223 (defvar mime-viewer/content-header-filter-alist nil)
226 ;;; @@ content filter
229 (defvar mime-viewer/content-filter-alist
230 '(("text/plain" . mime-viewer/filter-text/plain)
231 ("application/pgp" . mime-viewer/filter-text/plain)
232 (nil . mime-viewer/filter-text/plain)))
234 (defun mime-viewer/default-content-filter (rcnum cinfo ctype params subj)
238 ;;; @@ content separator
241 (defun mime-viewer/default-content-separator (rcnum cinfo ctype params subj)
242 (if (and (not (mime-viewer/header-visible-p rcnum cinfo ctype))
243 (not (mime-viewer/body-visible-p rcnum cinfo ctype))
246 (goto-char (point-max))
251 ;;; @@ buffer local variables
254 (defvar mime/show-mode-old-window-configuration nil)
255 (defvar mime::preview/mother-buffer nil)
257 (defvar mime::article/content-info nil)
258 (defvar mime::article/preview-buffer nil)
260 (defvar mime::preview/article-buffer nil)
261 (defvar mime::preview/content-list nil)
262 (defvar mime::preview/original-major-mode nil)
265 ;;; @@ quitting method
268 (defvar mime-viewer/quitting-method-alist
269 '((mime/show-message-mode
270 . mime-viewer/quitting-method-for-mime/show-message-mode)))
272 (defvar mime-viewer/over-to-previous-method-alist nil)
273 (defvar mime-viewer/over-to-next-method-alist nil)
279 ;; hack from Gnus 5.0.4.
281 (defvar mime-viewer/x-face-command
282 "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | xv -quit -"
283 "String to be executed to display an X-Face field.
284 The command will be executed in a sub-shell asynchronously.
285 The compressed face will be piped to this command.")
287 (defun mime-viewer/x-face-function ()
288 "Function to display X-Face field. You can redefine to customize."
289 ;; 1995/10/12 (c.f. tm-eng:130)
290 ;; fixed by Eric Ding <ericding@San-Jose.ate.slb.com>
292 (narrow-to-region (point-min) (re-search-forward "^$" nil t))
294 (goto-char (point-min))
295 (if (re-search-forward "^X-Face:[ \t]*" nil t)
296 (let ((beg (match-end 0))
297 (end (rfc822/field-end))
299 (call-process-region beg end "sh" nil 0 nil
300 "-c" mime-viewer/x-face-command)
304 ;;; @ data structures
307 ;;; @@ preview-content-info
310 (define-structure mime::preview-content-info
311 point-min point-max buffer content-info)
317 (defun mime-viewer/setup-buffer (&optional ctl encoding ibuf obuf)
323 (make-variable-buffer-local 'mime::article/content-info)
324 (setq mime::article/content-info (mime/parse-message ctl encoding))
325 (let ((ret (mime-viewer/make-preview-buffer obuf)))
326 (make-variable-buffer-local 'mime::article/preview-buffer)
327 (setq mime::article/preview-buffer (car ret))
330 (defun mime-viewer/make-preview-buffer (&optional obuf)
331 (let ((cinfo mime::article/content-info)
332 (the-buf (current-buffer))
336 (setq obuf (concat "*Preview-" (buffer-name the-buf) "*"))
338 (setq pcl (mime/flatten-content-info cinfo))
339 (let ((bf (get-buffer obuf)))
343 (setq buffer-read-only nil)
346 (setq bf (get-buffer-create obuf))
349 (make-variable-buffer-local 'mime::preview/article-buffer)
350 (setq mime::preview/article-buffer the-buf)
351 (make-variable-buffer-local 'mime::preview/original-major-mode)
352 (setq mime::preview/original-major-mode mode)
353 (setq major-mode 'mime/viewer-mode)
354 (setq mode-name "MIME-View")
359 (mime-viewer/display-content content cinfo the-buf obuf)
362 (set-buffer-modified-p nil)
363 (setq buffer-read-only t)
368 (defun mime-viewer/display-content (content cinfo ibuf obuf)
369 (let* ((beg (mime::content-info/point-min content))
370 (end (mime::content-info/point-max content))
371 (ctype (mime::content-info/type content))
372 (params (mime::content-info/parameters content))
373 (encoding (mime::content-info/encoding content))
374 (rcnum (mime::content-info/rcnum content))
378 (setq he (if (re-search-forward "^$" nil t)
385 (narrow-to-region beg end)
387 (mime-eword/decode-string
388 (mime-viewer/get-subject params encoding)))
392 (narrow-to-region nb nb)
393 (funcall mime-viewer/content-subject-function
394 rcnum cinfo ctype params subj)
396 (if (mime-viewer/header-visible-p rcnum cinfo ctype)
397 (mime-viewer/display-header beg he obuf)
399 (cond ((mime-viewer/body-visible-p rcnum cinfo ctype)
400 (mime-viewer/display-body he end obuf
401 rcnum cinfo ctype params subj encoding)
403 ((equal ctype "message/partial")
404 (mime-viewer/display-message/partial obuf)
407 (null (mime::content-info/children cinfo))
410 (goto-char (point-max))
411 (mime-viewer/insert-content-subject rcnum cinfo ctype params subj)
413 (t (set-buffer obuf))
415 (mime-viewer/default-content-separator rcnum cinfo ctype params subj)
418 (setq ne (point-max))
420 (mime::preview-content-info/create nb (1- ne) ibuf content)
425 (defun mime-viewer/display-header (beg end obuf)
426 (let ((str (buffer-substring beg end))
427 (f (assq major-mode mime-viewer/content-header-filter-alist))
432 (narrow-to-region (point)(point))
434 (if (and f (setq f (cdr f)))
436 (mime-viewer/default-content-header-filter)
438 (run-hooks 'mime-viewer/content-header-filter-hook)
441 (defun mime-viewer/display-body (beg end obuf
442 rcnum cinfo ctype params subj encoding)
443 (let ((str (buffer-substring beg end))
447 (setq be (point-max))
448 (narrow-to-region be be)
450 (let ((f (assoc-value ctype mime-viewer/content-filter-alist)))
451 (if (and f (fboundp f))
452 (funcall f ctype params encoding)
453 (mime-viewer/default-content-filter rcnum cinfo ctype params subj)
457 (defun mime-viewer/display-message/partial (obuf)
460 (goto-char (point-max))
461 (if (not (search-backward "\n\n" nil t))
464 (let ((be (point-max)))
465 (narrow-to-region be be)
466 (insert mime-viewer/announcement-for-message/partial)
467 (tm:add-button (point-min)(point-max)
468 (function mime-viewer/play-content))
471 (defun mime-viewer/get-subject (param &optional encoding)
472 (if (member (or encoding
473 (cdr (assq 'encoding param))
475 mime-viewer/uuencode-encoding-name-list)
477 (or (if (re-search-forward "^begin [0-9]+ " nil t)
478 (if (looking-at ".+$")
479 (buffer-substring (match-beginning 0)(match-end 0))
483 (or (and (setq ret (assoc "name" param))
484 (rfc822/strip-quoted-string (cdr ret))
486 (and (setq ret (assoc "x-name" param))
487 (rfc822/strip-quoted-string (cdr ret))
492 (goto-char (point-min))
493 (narrow-to-region (point-min)
494 (or (and (search-forward "\n\n" nil t)
499 (rfc822/get-field-body "Content-Description")
500 (rfc822/get-field-body "Subject")
506 ;;; @ content information
509 (defun mime-article/point-content-number (p &optional cinfo)
511 (setq cinfo mime::article/content-info)
513 (let ((b (mime::content-info/point-min cinfo))
514 (e (mime::content-info/point-max cinfo))
515 (c (mime::content-info/children cinfo))
517 (if (and (<= b p)(<= p e))
518 (or (let (co ret (sn 0))
522 (setq ret (mime-article/point-content-number p co))
523 (cond ((eq ret t) (throw 'tag (list sn)))
524 (ret (throw 'tag (cons sn ret)))
531 (defun mime-article/rcnum-to-cinfo (rcnum &optional cinfo)
533 (setq cinfo mime::article/content-info)
538 (equal (mime::content-info/rcnum ci) rcnum)
540 (mime/flatten-content-info cinfo)
543 (defun mime-article/cnum-to-cinfo (cn &optional cinfo)
545 (setq cinfo mime::article/content-info)
552 (let ((rc (nth sn (mime::content-info/children cinfo))))
554 (mime-article/cnum-to-cinfo (cdr cn) rc)
558 (defun mime/flatten-content-info (&optional cinfo)
560 (setq cinfo mime::article/content-info)
562 (let ((dest (list cinfo))
563 (rcl (mime::content-info/children cinfo))
566 (setq dest (nconc dest (mime/flatten-content-info (car rcl))))
571 (defun mime::point-preview-content (p &optional pcl)
573 (setq pcl mime::preview/content-list)
579 (if (and (<= (mime::preview-content-info/point-min cell) p)
580 (<= p (mime::preview-content-info/point-max cell))
593 (defvar mime-viewer/code-converter-alist
594 '((mime/show-message-mode . mime/code-convert-region-to-emacs))
597 (defun mime-viewer/default-code-convert-region
598 (beg end charset &optional encoding)
599 (if (member encoding '("quoted-printable" "base64"))
600 (mime/code-convert-region-to-emacs beg (point-max) charset)
603 (defun mime-preview/decode-text-region (beg end charset encoding)
604 (mime/decode-region encoding beg end)
605 (let* ((mode mime::preview/original-major-mode)
606 (m (assq mode mime-viewer/code-converter-alist))
608 (if (and m (fboundp (setq m (cdr m))))
609 (funcall m beg (point-max) charset encoding)
610 (mime-viewer/default-code-convert-region
611 beg (point-max) charset encoding)
614 (defun mime-viewer/filter-text/plain (ctype params encoding)
615 (let ((charset (cdr (assoc "charset" params)))
616 (beg (point-min)) (end (point-max))
618 (mime-preview/decode-text-region beg end charset encoding)
620 (goto-char (point-max))
621 (if (not (eq (char-after (1- (point))) ?\n))
624 (if browse-url-browser-function
626 (goto-char (point-min))
627 (while (re-search-forward tm:URL-regexp nil t)
628 (tm:add-button (match-beginning 0)(match-end 0)
629 (function tm:browse-url))
631 (run-hooks 'mime-viewer/plain-text-preview-hook)
635 ;;; @ MIME viewer mode
638 (defvar mime/viewer-mode-map nil)
639 (if (null mime/viewer-mode-map)
641 (setq mime/viewer-mode-map (make-keymap))
642 (suppress-keymap mime/viewer-mode-map)
643 (define-key mime/viewer-mode-map
644 "u" (function mime-viewer/up-content))
645 (define-key mime/viewer-mode-map
646 "p" (function mime-viewer/previous-content))
647 (define-key mime/viewer-mode-map
648 "n" (function mime-viewer/next-content))
649 (define-key mime/viewer-mode-map
650 " " (function mime-viewer/scroll-up-content))
651 (define-key mime/viewer-mode-map
652 "\M- " (function mime-viewer/scroll-down-content))
653 (define-key mime/viewer-mode-map
654 "\177" (function mime-viewer/scroll-down-content))
655 (define-key mime/viewer-mode-map
656 "\C-m" (function mime-viewer/next-line-content))
657 (define-key mime/viewer-mode-map
658 "\C-\M-m" (function mime-viewer/previous-line-content))
659 (define-key mime/viewer-mode-map
660 "v" (function mime-viewer/play-content))
661 (define-key mime/viewer-mode-map
662 "e" (function mime-viewer/extract-content))
663 (define-key mime/viewer-mode-map
664 "\C-c\C-p" (function mime-viewer/print-content))
665 (define-key mime/viewer-mode-map
666 "f" (function mime-viewer/display-x-face))
667 (define-key mime/viewer-mode-map
668 "q" (function mime-viewer/quit))
669 (define-key mime/viewer-mode-map
670 "\C-c\C-x" (function mime-viewer/kill-buffer))
672 (define-key mime/viewer-mode-map
673 mouse-button-2 (function tm:button-dispatcher))
677 (defun mime/viewer-mode (&optional mother ctl encoding ibuf obuf)
678 "Major mode for viewing MIME message.
680 Here is a list of the standard keys for mime/viewer-mode.
685 u Move to upper content
686 p Move to previous content
687 n Move to next content
688 SPC Scroll up or move to next content
689 M-SPC Scroll down or move to previous content
690 DEL Scroll down or move to previous content
691 RET Move to next line
692 M-RET Move to previous line
693 v Decode current content as `play mode'
694 e Decode current content as `extract mode'
695 C-c C-p Decode current content as `print mode'
698 button-2 Move to point under the mouse cursor
699 and decode current content as `play mode'
702 Here are all the commands with their current binding,
705 \\{mime/viewer-mode-map}
708 (let ((buf (get-buffer mime/output-buffer-name)))
714 (let ((ret (mime-viewer/setup-buffer ctl encoding ibuf obuf)))
716 (switch-to-buffer (car ret))
719 (make-variable-buffer-local
720 'mime/show-mode-old-window-configuration)
721 (setq mime/show-mode-old-window-configuration
722 (current-window-configuration))
723 (make-variable-buffer-local 'mime::preview/mother-buffer)
724 (setq mime::preview/mother-buffer mother)
726 (use-local-map mime/viewer-mode-map)
727 (make-variable-buffer-local 'mime::preview/content-list)
728 (setq mime::preview/content-list (nth 1 ret))
730 (let ((ce (mime::preview-content-info/point-max
731 (car mime::preview/content-list)
734 (goto-char (point-min))
735 (search-forward "\n\n" nil t)
736 (setq e (match-end 0))
740 (run-hooks 'mime/viewer-mode-hook)
743 (defun mime-preview/point-content-number (point)
744 (save-window-excursion
745 (let ((pc (mime::point-preview-content (point)))
747 (switch-to-buffer (mime::preview-content-info/buffer pc))
748 (setq cinfo (mime::preview-content-info/content-info pc))
749 (mime-article/point-content-number (mime::content-info/point-min cinfo))
752 (defun mime-preview/cinfo-to-pcinfo (cinfo)
753 (let ((rpcl mime::preview/content-list) cell)
756 (setq cell (car rpcl))
757 (if (eq cinfo (mime::preview-content-info/content-info cell))
760 (setq rpcl (cdr rpcl))
763 (autoload 'mime-preview/decode-content "tm-play")
765 (defvar mime-viewer/decoding-mode "play" "MIME body decoding mode")
767 (defun mime-viewer/play-content ()
769 (let ((mime-viewer/decoding-mode "play"))
770 (mime-preview/decode-content)
773 (defun mime-viewer/extract-content ()
775 (let ((mime-viewer/decoding-mode "extract"))
776 (mime-preview/decode-content)
779 (defun mime-viewer/print-content ()
781 (let ((mime-viewer/decoding-mode "print"))
782 (mime-preview/decode-content)
785 (defun mime-viewer/display-x-face ()
787 (save-window-excursion
788 (set-buffer mime::preview/article-buffer)
789 (mime-viewer/x-face-function)
792 (defun mime-viewer/up-content ()
794 (let ((pc (mime::point-preview-content (point))) cinfo
795 (the-buf (current-buffer))
797 (switch-to-buffer (mime::preview-content-info/buffer pc))
798 (setq cinfo (mime::preview-content-info/content-info pc))
799 (setq rcnum (mime::content-info/rcnum cinfo))
801 (mime-viewer/quit the-buf
802 (mime::preview-content-info/buffer pc)
804 (setq r (mime-article/rcnum-to-cinfo (cdr rcnum)))
805 (switch-to-buffer the-buf)
807 (let ((rpcl mime::preview/content-list) cell)
809 (setq cell (car rpcl))
810 (if (eq r (mime::preview-content-info/content-info cell))
812 (goto-char (mime::preview-content-info/point-min cell))
815 (setq rpcl (cdr rpcl))
819 (defun mime-viewer/previous-content ()
821 (let* ((pcl mime::preview/content-list)
823 (i (- (length pcl) 1))
827 (setq beg (mime::preview-content-info/point-min (nth i pcl)))
829 (throw 'tag (goto-char beg))
833 (let ((f (assq mime::preview/original-major-mode
834 mime-viewer/over-to-previous-method-alist)))
841 (defun mime-viewer/next-content ()
843 (let ((pcl mime::preview/content-list)
848 (setq beg (mime::preview-content-info/point-min (car pcl)))
850 (throw 'tag (goto-char beg))
854 (let ((f (assq mime::preview/original-major-mode
855 mime-viewer/over-to-next-method-alist)))
862 (defun mime-viewer/scroll-up-content (&optional h)
865 (setq h (- (window-height) 1))
867 (let ((pcl mime::preview/content-list)
873 (setq beg (mime::preview-content-info/point-min (car pcl)))
887 (defun mime-viewer/scroll-down-content (&optional h)
890 (setq h (- (window-height) 1))
892 (let ((pcl mime::preview/content-list)
896 (or (let ((i (- (length pcl) 1)))
899 (setq beg (mime::preview-content-info/point-min
912 (defun mime-viewer/next-line-content ()
914 (mime-viewer/scroll-up-content 1)
917 (defun mime-viewer/previous-line-content ()
919 (mime-viewer/scroll-down-content 1)
922 (defun mime-viewer/quit (&optional the-buf buf)
925 (setq the-buf (current-buffer))
928 (setq buf (mime::preview-content-info/buffer
929 (mime::point-preview-content (point))))
932 (switch-to-buffer buf)
933 (assq major-mode mime-viewer/quitting-method-alist)
937 (switch-to-buffer the-buf)
942 (defun mime-viewer/kill-buffer ()
944 (kill-buffer (current-buffer))
953 (run-hooks 'tm-view-load-hook)