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.9 1995/10/03 04:56:10 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 . "audio/basic")
43 (method "tm-au" nil 'file 'type 'encoding 'mode 'name))
45 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
46 ((type . "image/jpeg")
47 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
48 ((type . "image/tiff")
49 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
50 ((type . "image/x-tiff")
51 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
52 ((type . "image/x-xbm")
53 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
54 ((type . "image/x-pic")
55 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
56 ((type . "video/mpeg")
57 (method "tm-mpeg" nil 'file 'type 'encoding 'mode 'name))
58 ((type . "application/octet-stream")
59 (method "tm-file" nil 'file 'type 'encoding 'mode 'name))
60 ;;((type . "message/external-body")
61 ;; (method "xterm" nil
62 ;; "-e" "showexternal"
63 ;; 'file '"access-type" '"name" '"site" '"directory"))
64 ((type . "message/partial")
65 (method . mime/decode-message/partial-region))
67 "-m" "tm" "-x" "-d" "-z" "-e" 'file)(mode . "play"))
68 ((method "tm-file" nil 'file 'type 'encoding 'mode 'name)
72 (defvar mime-viewer/childrens-header-showing-Content-Type-list
73 '("message/rfc822" "message/news"))
75 (defvar mime-viewer/default-showing-Content-Type-list
76 '("text/plain" "text/richtext" "text/enriched"
77 "text/x-latex" "application/x-latex"
78 "application/octet-stream" nil
80 "application/x-selection" "application/x-comment"))
82 (defvar mime-viewer/content-subject-omitting-Content-Type-list
83 '("application/x-selection"))
85 (defvar mime-viewer/uuencode-encoding-name-list '("x-uue" "x-uuencode"))
87 (defvar mime-viewer/ignored-field-list
88 '("Received" "Return-Path" "Replied" "Errors-To"
89 "Lines" "Sender" "Path" "Nntp-Posting-Host"
90 "Content-Type" "Precedence" "X-Face"))
92 (defvar mime-viewer/ignored-field-regexp)
94 (defvar mime-viewer/announcement-for-message/partial
95 (if (and (>= emacs-major-version 19) window-system)
97 \[[ This is message/partial style split message. ]]
98 \[[ Please press `v' key in this buffer ]]
99 \[[ or click here by mouse button-2. ]]"
101 \[[ This is message/partial style split message. ]]
102 \[[ Please press `v' key in this buffer. ]]"
106 ;;; @@ predicate functions
109 (defun mime-viewer/header-visible-p (cnum cinfo &optional ctype)
113 (mime::content-info/type
114 (mime-article/cnum-to-cinfo (butlast cnum) cinfo)
116 (member ctype mime-viewer/childrens-header-showing-Content-Type-list)
119 (defun mime-viewer/body-visible-p (cnum cinfo &optional ctype)
123 (mime::content-info/type
124 (setq ccinfo (mime-article/cnum-to-cinfo cnum cinfo))
127 (and (member ctype mime-viewer/default-showing-Content-Type-list)
128 (if (string-equal ctype "application/octet-stream")
131 (setq ccinfo (mime-article/cnum-to-cinfo cnum cinfo))
133 (member (mime::content-info/encoding ccinfo)
134 '(nil "7bit" "8bit"))
140 ;;; @@ content subject
143 (defun mime-viewer/insert-content-subject
144 (cnum cinfo ctype params subj)
146 (narrow-to-region (point)(point))
148 (let ((access-type (assoc "access-type" params))
149 (num (or (assoc-value "x-part-number" params)
153 (format "%s" (1+ num))
159 (let ((server (assoc "server" params)))
160 (setq access-type (cdr access-type))
162 (format "[%s %s ([%s] %s)]\n" num subj
163 access-type (cdr server))
164 (let ((site (assoc-value "site" params))
165 (dir (assoc-value "directory" params))
167 (format "[%s %s ([%s] %s:%s)]\n" num subj
168 access-type site dir)
170 (format "[%s %s (%s)]\n" num subj ctype)
172 (tm:add-button (point-min)(1- (point-max))
173 (function mime-viewer/play-content))
176 (defun mime-viewer/default-content-subject-function
177 (cnum cinfo ctype params subj)
178 (if (and (listp cnum)
181 mime-viewer/content-subject-omitting-Content-Type-list))
183 (mime-viewer/insert-content-subject
184 cnum cinfo ctype params subj)
187 (defvar mime-viewer/content-subject-function
188 (function mime-viewer/default-content-subject-function))
191 ;;; @@ content header filter
194 (defun mime-viewer/default-content-header-filter ()
195 (goto-char (point-min))
196 (while (and (re-search-forward mime-viewer/ignored-field-regexp nil t)
202 (re-search-forward "^\\([^ \t]\\|$\\)" nil t)
206 (mime/decode-message-header)
209 (defvar mime-viewer/content-header-filter-alist nil)
212 ;;; @@ content filter
215 (defvar mime-viewer/content-filter-alist
216 '(("text/plain" . mime-viewer/filter-text/plain)
217 ("application/pgp" . mime-viewer/filter-text/plain)
218 (nil . mime-viewer/filter-text/plain)))
220 (defun mime-viewer/default-content-filter (cnum cinfo ctype params subj)
224 ;;; @@ content separator
227 (defun mime-viewer/default-content-separator (cnum cinfo ctype params subj)
228 (if (and (not (mime-viewer/header-visible-p cnum cinfo ctype))
229 (not (mime-viewer/body-visible-p cnum cinfo ctype))
232 (goto-char (point-max))
237 ;;; @@ buffer local variables
240 (defvar mime::article/content-info nil)
241 (defvar mime::article/preview-buffer nil)
243 (defvar mime::preview/article-buffer nil)
244 (defvar mime::preview/content-list nil)
245 (defvar mime::preview/original-major-mode nil)
248 ;;; @@ quitting method
251 (defvar mime-viewer/quitting-method-alist
252 '((mime/show-message-mode
254 (set-window-configuration
255 mime/show-mode-old-window-configuration)
256 (let ((mother mime/mother-buffer))
258 (mime::preview-content-info/buffer
259 (car mime::preview/content-list)))
260 (mime-viewer/kill-buffer)
261 (pop-to-buffer mother)
262 (goto-char (point-min))
263 (mime-viewer/up-content)
271 ;; hack from Gnus 5.0.4.
273 (defvar mime-viewer/x-face-command
274 "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | xv -quit -"
275 "String to be executed to display an X-Face field.
276 The command will be executed in a sub-shell asynchronously.
277 The compressed face will be piped to this command.")
279 (defun mime-viewer/x-face-function ()
280 "Function to display X-Face field. You can redefine to customize."
281 (goto-char (point-min))
282 (if (re-search-forward "^X-Face:[ \t]*" nil t)
283 (let ((beg (match-end 0))
284 (end (message/field-end))
286 (call-process-region beg end "sh" nil 0 nil
287 "-c" mime-viewer/x-face-command)
291 ;;; @ data structures
294 ;;; @@ preview-content-info
297 (define-structure mime::preview-content-info
298 point-min point-max buffer content-info)
304 (defun mime-viewer/setup-buffer (&optional ctl encoding ibuf obuf)
310 (make-variable-buffer-local 'mime::article/content-info)
311 (setq mime::article/content-info (mime/parse-message ctl encoding))
312 (let ((ret (mime-viewer/make-preview-buffer obuf)))
313 (make-variable-buffer-local 'mime::article/preview-buffer)
314 (setq mime::article/preview-buffer (car ret))
317 (defun mime-viewer/make-preview-buffer (&optional obuf)
318 (let ((cinfo mime::article/content-info)
319 (the-buf (current-buffer))
323 (setq obuf (concat "*Preview-" (buffer-name the-buf) "*"))
325 (setq pcl (mime/flatten-content-info cinfo))
326 (let ((bf (get-buffer obuf)))
330 (setq buffer-read-only nil)
333 (setq bf (get-buffer-create obuf))
336 (make-variable-buffer-local 'mime::preview/article-buffer)
337 (setq mime::preview/article-buffer the-buf)
338 (make-variable-buffer-local 'mime::preview/original-major-mode)
339 (setq mime::preview/original-major-mode mode)
340 (setq major-mode 'mime/viewer-mode)
341 (setq mode-name "MIME-View")
346 (mime-viewer/display-content content cinfo the-buf obuf)
349 (set-buffer-modified-p nil)
350 (setq buffer-read-only t)
355 (defun mime-viewer/display-content (content cinfo ibuf obuf)
356 (let* ((beg (mime::content-info/point-min content))
357 (end (mime::content-info/point-max content))
358 (ctype (mime::content-info/type content))
359 (params (mime::content-info/parameters content))
360 (encoding (mime::content-info/encoding content))
361 (cnum (mime::get-point-content-number beg cinfo))
365 (setq he (if (re-search-forward "^$" nil t)
372 (narrow-to-region beg end)
373 (setq subj (mime-viewer/get-subject params encoding))
377 (narrow-to-region nb nb)
378 (funcall mime-viewer/content-subject-function
379 cnum cinfo ctype params subj)
381 (if (mime-viewer/header-visible-p cnum cinfo ctype)
382 (mime-viewer/display-header beg he obuf)
384 (cond ((mime-viewer/body-visible-p cnum cinfo ctype)
385 (mime-viewer/display-body he end obuf
386 cnum cinfo ctype params subj encoding)
388 ((equal ctype "message/partial")
389 (mime-viewer/display-message/partial obuf)
392 (null (mime::content-info/children cinfo))
395 (goto-char (point-max))
396 (mime-viewer/insert-content-subject cnum cinfo ctype params subj)
398 (t (set-buffer obuf))
400 (mime-viewer/default-content-separator cnum cinfo ctype params subj)
403 (setq ne (point-max))
405 (mime::preview-content-info/create nb (1- ne) ibuf content)
410 (defun mime-viewer/display-header (beg end obuf)
411 (let ((str (buffer-substring beg end))
412 (f (assq major-mode mime-viewer/content-header-filter-alist))
417 (narrow-to-region (point)(point))
419 (if (and f (setq f (cdr f)))
421 (mime-viewer/default-content-header-filter)
423 (run-hooks 'mime-viewer/content-header-filter-hook)
426 (defun mime-viewer/display-body (beg end obuf
427 cnum cinfo ctype params subj encoding)
428 (let ((str (buffer-substring beg end))
432 (setq be (point-max))
433 (narrow-to-region be be)
435 (let ((f (assoc-value ctype mime-viewer/content-filter-alist)))
436 (if (and f (fboundp f))
437 (funcall f ctype params encoding)
438 (mime-viewer/default-content-filter cnum cinfo ctype params subj)
442 (defun mime-viewer/display-message/partial (obuf)
445 (goto-char (point-max))
446 (if (not (search-backward "\n\n" nil t))
449 (let ((be (point-max)))
450 (narrow-to-region be be)
451 (insert mime-viewer/announcement-for-message/partial)
452 (tm:add-button (point-min)(point-max)
453 (function mime-viewer/play-content))
456 (defun mime-viewer/get-subject (param &optional encoding)
457 (if (member (or encoding
458 (cdr (assq 'encoding param))
460 mime-viewer/uuencode-encoding-name-list)
462 (or (if (re-search-forward "^begin [0-9]+ " nil t)
463 (if (looking-at ".+$")
464 (buffer-substring (match-beginning 0)(match-end 0))
468 (or (and (setq ret (assoc "name" param))
469 (message/strip-quoted-string (cdr ret))
471 (and (setq ret (assoc "x-name" param))
472 (message/strip-quoted-string (cdr ret))
477 (goto-char (point-min))
478 (narrow-to-region (point-min)
479 (or (and (search-forward "\n\n" nil t)
484 (message/get-field-body "Content-Description")
485 (message/get-field-body "Subject")
491 ;;; @ content information
494 (defun mime::get-point-content-number (p &optional cinfo)
496 (setq cinfo mime::article/content-info)
498 (let ((b (mime::content-info/point-min cinfo))
499 (e (mime::content-info/point-max cinfo))
500 (c (mime::content-info/children cinfo))
502 (if (and (<= b p)(<= p e))
503 (or (let (co ret (sn 0))
507 (setq ret (mime::get-point-content-number p co))
508 (cond ((eq ret t) (throw 'tag (list sn)))
509 (ret (throw 'tag (cons sn ret)))
516 (defun mime-article/cnum-to-cinfo (cn &optional cinfo)
518 (setq cinfo mime::article/content-info)
525 (let ((rc (nth sn (mime::content-info/children cinfo))))
527 (mime-article/cnum-to-cinfo (cdr cn) rc)
531 (defun mime/flatten-content-info (&optional cinfo)
533 (setq cinfo mime::article/content-info)
535 (let ((dest (list cinfo))
536 (rcl (mime::content-info/children cinfo))
539 (setq dest (nconc dest (mime/flatten-content-info (car rcl))))
544 (defun mime::point-preview-content (p &optional pcl)
546 (setq pcl mime::preview/content-list)
552 (if (and (<= (mime::preview-content-info/point-min cell) p)
553 (<= p (mime::preview-content-info/point-max cell))
566 (defvar mime-viewer/code-converter-alist nil)
568 (defun mime-viewer/default-code-convert-region
569 (beg end charset &optional encoding)
570 (if (member encoding '("quoted-printable" "base64"))
571 (mime/code-convert-region-to-emacs beg (point-max) charset)
574 (defun mime-viewer/filter-text/plain (ctype params encoding)
575 (let ((charset (cdr (assoc "charset" params)))
576 (beg (point-min)) (end (point-max))
578 (goto-char (point-min))
579 (cond ((string= encoding "quoted-printable")
580 (quoted-printable-decode-region beg end)
582 ((string= encoding "base64")
583 (base64-decode-region beg end)
585 (let* ((mode mime::preview/original-major-mode)
586 (m (assq mode mime-viewer/code-converter-alist))
588 (if (and m (fboundp (setq m (cdr m))))
589 (funcall m beg (point-max) charset encoding)
590 (mime-viewer/default-code-convert-region beg (point-max)
593 (goto-char (point-max))
594 (if (not (eq (char-after (1- (point))) ?\n))
597 (if browse-url-browser-function
599 (goto-char (point-min))
600 (while (re-search-forward tm:URL-regexp nil t)
601 (tm:add-button (match-beginning 0)(match-end 0)
602 (function tm:browse-url))
604 (run-hooks 'mime-viewer/plain-text-preview-hook)
608 ;;; @ MIME viewer mode
611 (defvar mime/viewer-mode-map nil)
612 (if (null mime/viewer-mode-map)
614 (setq mime/viewer-mode-map (make-keymap))
615 (suppress-keymap mime/viewer-mode-map)
616 (define-key mime/viewer-mode-map
617 "u" (function mime-viewer/up-content))
618 (define-key mime/viewer-mode-map
619 "p" (function mime-viewer/previous-content))
620 (define-key mime/viewer-mode-map
621 "n" (function mime-viewer/next-content))
622 (define-key mime/viewer-mode-map
623 " " (function mime-viewer/scroll-up-content))
624 (define-key mime/viewer-mode-map
625 "\M- " (function mime-viewer/scroll-down-content))
626 (define-key mime/viewer-mode-map
627 "\177" (function mime-viewer/scroll-down-content))
628 (define-key mime/viewer-mode-map
629 "\C-m" (function mime-viewer/next-line-content))
630 (define-key mime/viewer-mode-map
631 "\C-\M-m" (function mime-viewer/previous-line-content))
632 (define-key mime/viewer-mode-map
633 "v" (function mime-viewer/play-content))
634 (define-key mime/viewer-mode-map
635 "e" (function mime-viewer/extract-content))
636 (define-key mime/viewer-mode-map
637 "\C-c\C-p" (function mime-viewer/print-content))
638 (define-key mime/viewer-mode-map
639 "f" (function mime-viewer/display-x-face))
640 (define-key mime/viewer-mode-map
641 "q" (function mime-viewer/quit))
642 (define-key mime/viewer-mode-map
643 "\C-c\C-x" (function mime-viewer/kill-buffer))
645 (define-key mime/viewer-mode-map
646 mouse-button-2 (function tm:button-dispatcher))
650 (defun mime/viewer-mode (&optional mother ctl encoding ibuf obuf)
651 "Major mode for viewing MIME message.
653 Here is a list of the standard keys for mime/viewer-mode.
658 u Move to upper content
659 p Move to previous content
660 n Move to next content
661 SPC Scroll up or move to next content
662 M-SPC Scroll down or move to previous content
663 DEL Scroll down or move to previous content
664 RET Move to next line
665 M-RET Move to previous line
666 v Decode current content as `play mode'
667 e Decode current content as `extract mode'
668 C-c C-p Decode current content as `print mode'
671 button-2 Move to point under the mouse cursor
672 and decode current content as `play mode'
675 Here are all the commands with their current binding,
678 \\{mime/viewer-mode-map}
681 (setq mime-viewer/ignored-field-regexp
683 (mapconcat (function regexp-quote)
684 mime-viewer/ignored-field-list "\\|")
686 (let ((buf (get-buffer mime/output-buffer-name)))
692 (let ((ret (mime-viewer/setup-buffer ctl encoding ibuf obuf)))
694 (switch-to-buffer (car ret))
697 (make-variable-buffer-local
698 'mime/show-mode-old-window-configuration)
699 (setq mime/show-mode-old-window-configuration
700 (current-window-configuration))
701 (make-variable-buffer-local 'mime/mother-buffer)
702 (setq mime/mother-buffer mother)
704 (use-local-map mime/viewer-mode-map)
705 (make-variable-buffer-local 'mime::preview/content-list)
706 (setq mime::preview/content-list (nth 1 ret))
708 (let ((ce (mime::preview-content-info/point-max
709 (car mime::preview/content-list)
712 (goto-char (point-min))
713 (search-forward "\n\n" nil t)
714 (setq e (match-end 0))
718 (run-hooks 'mime/viewer-mode-hook)
721 (defun mime-preview/point-content-number (point)
722 (save-window-excursion
723 (let ((pc (mime::point-preview-content (point)))
725 (switch-to-buffer (mime::preview-content-info/buffer pc))
726 (setq cinfo (mime::preview-content-info/content-info pc))
727 (mime::get-point-content-number (mime::content-info/point-min cinfo))
730 (defun mime-preview/cinfo-to-pcinfo (cinfo)
731 (let ((rpcl mime::preview/content-list) cell)
734 (setq cell (car rpcl))
735 (if (eq cinfo (mime::preview-content-info/content-info cell))
738 (setq rpcl (cdr rpcl))
741 (autoload 'mime-preview/decode-content "tm-play")
743 (defvar mime-viewer/decoding-mode "play" "MIME body decoding mode")
745 (defun mime-viewer/play-content ()
747 (let ((mime-viewer/decoding-mode "play"))
748 (mime-preview/decode-content)
751 (defun mime-viewer/play-content-mouse (e)
754 (mime-viewer/play-content)
757 (defun mime-viewer/extract-content ()
759 (let ((mime-viewer/decoding-mode "extract"))
760 (mime-preview/decode-content)
763 (defun mime-viewer/print-content ()
765 (let ((mime-viewer/decoding-mode "print"))
766 (mime-preview/decode-content)
769 (defun mime-viewer/display-x-face ()
771 (save-window-excursion
772 (set-buffer mime::preview/article-buffer)
773 (mime-viewer/x-face-function)
776 (defun mime-viewer/up-content ()
778 (let ((pc (mime::point-preview-content (point))) cinfo
779 (the-buf (current-buffer))
781 (switch-to-buffer (mime::preview-content-info/buffer pc))
782 (setq cinfo (mime::preview-content-info/content-info pc))
783 (setq cn (mime::get-point-content-number
784 (mime::content-info/point-min cinfo)))
786 (mime-viewer/quit the-buf
787 (mime::preview-content-info/buffer pc)
789 (setq r (mime-article/cnum-to-cinfo (butlast cn)))
790 (switch-to-buffer the-buf)
792 (let ((rpcl mime::preview/content-list) cell)
794 (setq cell (car rpcl))
795 (if (eq r (mime::preview-content-info/content-info cell))
797 (goto-char (mime::preview-content-info/point-min cell))
800 (setq rpcl (cdr rpcl))
804 (defun mime-viewer/previous-content ()
806 (let* ((pcl mime::preview/content-list)
808 (i (- (length pcl) 1))
812 (setq beg (mime::preview-content-info/point-min (nth i pcl)))
814 (throw 'tag (goto-char beg))
820 (defun mime-viewer/next-content ()
822 (let ((pcl mime::preview/content-list)
827 (setq beg (mime::preview-content-info/point-min (car pcl)))
829 (throw 'tag (goto-char beg))
835 (defun mime-viewer/scroll-up-content (&optional h)
838 (setq h (- (window-height) 1))
840 (let ((pcl mime::preview/content-list)
846 (setq beg (mime::preview-content-info/point-min (car pcl)))
860 (defun mime-viewer/scroll-down-content (&optional h)
863 (setq h (- (window-height) 1))
865 (let ((pcl mime::preview/content-list)
869 (or (let ((i (- (length pcl) 1)))
872 (setq beg (mime::preview-content-info/point-min
885 (defun mime-viewer/next-line-content ()
887 (mime-viewer/scroll-up-content 1)
890 (defun mime-viewer/previous-line-content ()
892 (mime-viewer/scroll-down-content 1)
895 (defun mime-viewer/quit (&optional the-buf buf)
898 (setq the-buf (current-buffer))
901 (setq buf (mime::preview-content-info/buffer
902 (mime::point-preview-content (point))))
905 (switch-to-buffer buf)
906 (assoc major-mode mime-viewer/quitting-method-alist)
910 (switch-to-buffer the-buf)
915 (defun mime-viewer/kill-buffer ()
917 (kill-buffer (current-buffer))
926 (run-hooks 'tm-view-load-hook)