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.20 1995/10/24 00:21:02 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-article/decode-message/partial))
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 (rcnum cinfo &optional ctype)
113 (mime::content-info/type
114 (mime-article/rcnum-to-cinfo (cdr rcnum) cinfo)
116 (member ctype mime-viewer/childrens-header-showing-Content-Type-list)
119 (defun mime-viewer/body-visible-p (rcnum cinfo &optional ctype)
123 (mime::content-info/type
124 (setq ccinfo (mime-article/rcnum-to-cinfo rcnum 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/rcnum-to-cinfo rcnum cinfo))
133 (member (mime::content-info/encoding ccinfo)
134 '(nil "7bit" "8bit"))
140 ;;; @@ content subject
143 (defun mime-viewer/insert-content-subject
144 (rcnum 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 (rcnum cinfo ctype params subj)
178 (if (and (consp rcnum)
181 mime-viewer/content-subject-omitting-Content-Type-list))
183 (mime-viewer/insert-content-subject
184 rcnum 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 (rcnum cinfo ctype params subj)
224 ;;; @@ content separator
227 (defun mime-viewer/default-content-separator (rcnum cinfo ctype params subj)
228 (if (and (not (mime-viewer/header-visible-p rcnum cinfo ctype))
229 (not (mime-viewer/body-visible-p rcnum cinfo ctype))
232 (goto-char (point-max))
237 ;;; @@ buffer local variables
240 (defvar mime/show-mode-old-window-configuration nil)
241 (defvar mime/mother-buffer nil)
243 (defvar mime::article/content-info nil)
244 (defvar mime::article/preview-buffer nil)
246 (defvar mime::preview/article-buffer nil)
247 (defvar mime::preview/content-list nil)
248 (defvar mime::preview/original-major-mode nil)
251 ;;; @@ quitting method
254 (defvar mime-viewer/quitting-method-alist
255 '((mime/show-message-mode
257 (set-window-configuration
258 mime/show-mode-old-window-configuration)
259 (let ((mother mime/mother-buffer))
261 (mime::preview-content-info/buffer
262 (car mime::preview/content-list)))
263 (mime-viewer/kill-buffer)
264 (pop-to-buffer mother)
265 (goto-char (point-min))
266 (mime-viewer/up-content)
274 ;; hack from Gnus 5.0.4.
276 (defvar mime-viewer/x-face-command
277 "{ echo '/* Width=48, Height=48 */'; uncompface; } | icontopbm | xv -quit -"
278 "String to be executed to display an X-Face field.
279 The command will be executed in a sub-shell asynchronously.
280 The compressed face will be piped to this command.")
282 (defun mime-viewer/x-face-function ()
283 "Function to display X-Face field. You can redefine to customize."
284 ;; 1995/10/12 (c.f. tm-eng:130)
285 ;; fixed by Eric Ding <ericding@San-Jose.ate.slb.com>
287 (narrow-to-region (point-min) (re-search-forward "^$" nil t))
289 (goto-char (point-min))
290 (if (re-search-forward "^X-Face:[ \t]*" nil t)
291 (let ((beg (match-end 0))
292 (end (rfc822/field-end))
294 (call-process-region beg end "sh" nil 0 nil
295 "-c" mime-viewer/x-face-command)
299 ;;; @ data structures
302 ;;; @@ preview-content-info
305 (define-structure mime::preview-content-info
306 point-min point-max buffer content-info)
312 (defun mime-viewer/setup-buffer (&optional ctl encoding ibuf obuf)
318 (make-variable-buffer-local 'mime::article/content-info)
319 (setq mime::article/content-info (mime/parse-message ctl encoding))
320 (let ((ret (mime-viewer/make-preview-buffer obuf)))
321 (make-variable-buffer-local 'mime::article/preview-buffer)
322 (setq mime::article/preview-buffer (car ret))
325 (defun mime-viewer/make-preview-buffer (&optional obuf)
326 (let ((cinfo mime::article/content-info)
327 (the-buf (current-buffer))
331 (setq obuf (concat "*Preview-" (buffer-name the-buf) "*"))
333 (setq pcl (mime/flatten-content-info cinfo))
334 (let ((bf (get-buffer obuf)))
338 (setq buffer-read-only nil)
341 (setq bf (get-buffer-create obuf))
344 (make-variable-buffer-local 'mime::preview/article-buffer)
345 (setq mime::preview/article-buffer the-buf)
346 (make-variable-buffer-local 'mime::preview/original-major-mode)
347 (setq mime::preview/original-major-mode mode)
348 (setq major-mode 'mime/viewer-mode)
349 (setq mode-name "MIME-View")
354 (mime-viewer/display-content content cinfo the-buf obuf)
357 (set-buffer-modified-p nil)
358 (setq buffer-read-only t)
363 (defun mime-viewer/display-content (content cinfo ibuf obuf)
364 (let* ((beg (mime::content-info/point-min content))
365 (end (mime::content-info/point-max content))
366 (ctype (mime::content-info/type content))
367 (params (mime::content-info/parameters content))
368 (encoding (mime::content-info/encoding content))
369 (rcnum (mime::content-info/rcnum content))
373 (setq he (if (re-search-forward "^$" nil t)
380 (narrow-to-region beg end)
382 (mime-eword/decode-string
383 (mime-viewer/get-subject params encoding)))
387 (narrow-to-region nb nb)
388 (funcall mime-viewer/content-subject-function
389 rcnum cinfo ctype params subj)
391 (if (mime-viewer/header-visible-p rcnum cinfo ctype)
392 (mime-viewer/display-header beg he obuf)
394 (cond ((mime-viewer/body-visible-p rcnum cinfo ctype)
395 (mime-viewer/display-body he end obuf
396 rcnum cinfo ctype params subj encoding)
398 ((equal ctype "message/partial")
399 (mime-viewer/display-message/partial obuf)
402 (null (mime::content-info/children cinfo))
405 (goto-char (point-max))
406 (mime-viewer/insert-content-subject rcnum cinfo ctype params subj)
408 (t (set-buffer obuf))
410 (mime-viewer/default-content-separator rcnum cinfo ctype params subj)
413 (setq ne (point-max))
415 (mime::preview-content-info/create nb (1- ne) ibuf content)
420 (defun mime-viewer/display-header (beg end obuf)
421 (let ((str (buffer-substring beg end))
422 (f (assq major-mode mime-viewer/content-header-filter-alist))
427 (narrow-to-region (point)(point))
429 (if (and f (setq f (cdr f)))
431 (mime-viewer/default-content-header-filter)
433 (run-hooks 'mime-viewer/content-header-filter-hook)
436 (defun mime-viewer/display-body (beg end obuf
437 rcnum cinfo ctype params subj encoding)
438 (let ((str (buffer-substring beg end))
442 (setq be (point-max))
443 (narrow-to-region be be)
445 (let ((f (assoc-value ctype mime-viewer/content-filter-alist)))
446 (if (and f (fboundp f))
447 (funcall f ctype params encoding)
448 (mime-viewer/default-content-filter rcnum cinfo ctype params subj)
452 (defun mime-viewer/display-message/partial (obuf)
455 (goto-char (point-max))
456 (if (not (search-backward "\n\n" nil t))
459 (let ((be (point-max)))
460 (narrow-to-region be be)
461 (insert mime-viewer/announcement-for-message/partial)
462 (tm:add-button (point-min)(point-max)
463 (function mime-viewer/play-content))
466 (defun mime-viewer/get-subject (param &optional encoding)
467 (if (member (or encoding
468 (cdr (assq 'encoding param))
470 mime-viewer/uuencode-encoding-name-list)
472 (or (if (re-search-forward "^begin [0-9]+ " nil t)
473 (if (looking-at ".+$")
474 (buffer-substring (match-beginning 0)(match-end 0))
478 (or (and (setq ret (assoc "name" param))
479 (rfc822/strip-quoted-string (cdr ret))
481 (and (setq ret (assoc "x-name" param))
482 (rfc822/strip-quoted-string (cdr ret))
487 (goto-char (point-min))
488 (narrow-to-region (point-min)
489 (or (and (search-forward "\n\n" nil t)
494 (rfc822/get-field-body "Content-Description")
495 (rfc822/get-field-body "Subject")
501 ;;; @ content information
504 (defun mime-article/point-content-number (p &optional cinfo)
506 (setq cinfo mime::article/content-info)
508 (let ((b (mime::content-info/point-min cinfo))
509 (e (mime::content-info/point-max cinfo))
510 (c (mime::content-info/children cinfo))
512 (if (and (<= b p)(<= p e))
513 (or (let (co ret (sn 0))
517 (setq ret (mime-article/point-content-number p co))
518 (cond ((eq ret t) (throw 'tag (list sn)))
519 (ret (throw 'tag (cons sn ret)))
526 (defun mime-article/rcnum-to-cinfo (rcnum &optional cinfo)
528 (setq cinfo mime::article/content-info)
533 (equal (mime::content-info/rcnum ci) rcnum)
535 (mime/flatten-content-info cinfo)
538 (defun mime-article/cnum-to-cinfo (cn &optional cinfo)
540 (setq cinfo mime::article/content-info)
547 (let ((rc (nth sn (mime::content-info/children cinfo))))
549 (mime-article/cnum-to-cinfo (cdr cn) rc)
553 (defun mime/flatten-content-info (&optional cinfo)
555 (setq cinfo mime::article/content-info)
557 (let ((dest (list cinfo))
558 (rcl (mime::content-info/children cinfo))
561 (setq dest (nconc dest (mime/flatten-content-info (car rcl))))
566 (defun mime::point-preview-content (p &optional pcl)
568 (setq pcl mime::preview/content-list)
574 (if (and (<= (mime::preview-content-info/point-min cell) p)
575 (<= p (mime::preview-content-info/point-max cell))
588 (defvar mime-viewer/code-converter-alist nil)
590 (defun mime-viewer/default-code-convert-region
591 (beg end charset &optional encoding)
592 (if (member encoding '("quoted-printable" "base64"))
593 (mime/code-convert-region-to-emacs beg (point-max) charset)
596 (defun mime-viewer/filter-text/plain (ctype params encoding)
597 (let ((charset (cdr (assoc "charset" params)))
598 (beg (point-min)) (end (point-max))
600 (mime/decode-region encoding beg end)
601 (let* ((mode mime::preview/original-major-mode)
602 (m (assq mode mime-viewer/code-converter-alist))
604 (if (and m (fboundp (setq m (cdr m))))
605 (funcall m beg (point-max) charset encoding)
606 (mime-viewer/default-code-convert-region beg (point-max)
609 (goto-char (point-max))
610 (if (not (eq (char-after (1- (point))) ?\n))
613 (if browse-url-browser-function
615 (goto-char (point-min))
616 (while (re-search-forward tm:URL-regexp nil t)
617 (tm:add-button (match-beginning 0)(match-end 0)
618 (function tm:browse-url))
620 (run-hooks 'mime-viewer/plain-text-preview-hook)
624 ;;; @ MIME viewer mode
627 (defvar mime/viewer-mode-map nil)
628 (if (null mime/viewer-mode-map)
630 (setq mime/viewer-mode-map (make-keymap))
631 (suppress-keymap mime/viewer-mode-map)
632 (define-key mime/viewer-mode-map
633 "u" (function mime-viewer/up-content))
634 (define-key mime/viewer-mode-map
635 "p" (function mime-viewer/previous-content))
636 (define-key mime/viewer-mode-map
637 "n" (function mime-viewer/next-content))
638 (define-key mime/viewer-mode-map
639 " " (function mime-viewer/scroll-up-content))
640 (define-key mime/viewer-mode-map
641 "\M- " (function mime-viewer/scroll-down-content))
642 (define-key mime/viewer-mode-map
643 "\177" (function mime-viewer/scroll-down-content))
644 (define-key mime/viewer-mode-map
645 "\C-m" (function mime-viewer/next-line-content))
646 (define-key mime/viewer-mode-map
647 "\C-\M-m" (function mime-viewer/previous-line-content))
648 (define-key mime/viewer-mode-map
649 "v" (function mime-viewer/play-content))
650 (define-key mime/viewer-mode-map
651 "e" (function mime-viewer/extract-content))
652 (define-key mime/viewer-mode-map
653 "\C-c\C-p" (function mime-viewer/print-content))
654 (define-key mime/viewer-mode-map
655 "f" (function mime-viewer/display-x-face))
656 (define-key mime/viewer-mode-map
657 "q" (function mime-viewer/quit))
658 (define-key mime/viewer-mode-map
659 "\C-c\C-x" (function mime-viewer/kill-buffer))
661 (define-key mime/viewer-mode-map
662 mouse-button-2 (function tm:button-dispatcher))
666 (defun mime/viewer-mode (&optional mother ctl encoding ibuf obuf)
667 "Major mode for viewing MIME message.
669 Here is a list of the standard keys for mime/viewer-mode.
674 u Move to upper content
675 p Move to previous content
676 n Move to next content
677 SPC Scroll up or move to next content
678 M-SPC Scroll down or move to previous content
679 DEL Scroll down or move to previous content
680 RET Move to next line
681 M-RET Move to previous line
682 v Decode current content as `play mode'
683 e Decode current content as `extract mode'
684 C-c C-p Decode current content as `print mode'
687 button-2 Move to point under the mouse cursor
688 and decode current content as `play mode'
691 Here are all the commands with their current binding,
694 \\{mime/viewer-mode-map}
697 (setq mime-viewer/ignored-field-regexp
699 (mapconcat (function regexp-quote)
700 mime-viewer/ignored-field-list "\\|")
702 (let ((buf (get-buffer mime/output-buffer-name)))
708 (let ((ret (mime-viewer/setup-buffer ctl encoding ibuf obuf)))
710 (switch-to-buffer (car ret))
713 (make-variable-buffer-local
714 'mime/show-mode-old-window-configuration)
715 (setq mime/show-mode-old-window-configuration
716 (current-window-configuration))
717 (make-variable-buffer-local 'mime/mother-buffer)
718 (setq mime/mother-buffer mother)
720 (use-local-map mime/viewer-mode-map)
721 (make-variable-buffer-local 'mime::preview/content-list)
722 (setq mime::preview/content-list (nth 1 ret))
724 (let ((ce (mime::preview-content-info/point-max
725 (car mime::preview/content-list)
728 (goto-char (point-min))
729 (search-forward "\n\n" nil t)
730 (setq e (match-end 0))
734 (run-hooks 'mime/viewer-mode-hook)
737 (defun mime-preview/point-content-number (point)
738 (save-window-excursion
739 (let ((pc (mime::point-preview-content (point)))
741 (switch-to-buffer (mime::preview-content-info/buffer pc))
742 (setq cinfo (mime::preview-content-info/content-info pc))
743 (mime-article/point-content-number (mime::content-info/point-min cinfo))
746 (defun mime-preview/cinfo-to-pcinfo (cinfo)
747 (let ((rpcl mime::preview/content-list) cell)
750 (setq cell (car rpcl))
751 (if (eq cinfo (mime::preview-content-info/content-info cell))
754 (setq rpcl (cdr rpcl))
757 (autoload 'mime-preview/decode-content "tm-play")
759 (defvar mime-viewer/decoding-mode "play" "MIME body decoding mode")
761 (defun mime-viewer/play-content ()
763 (let ((mime-viewer/decoding-mode "play"))
764 (mime-preview/decode-content)
767 (defun mime-viewer/extract-content ()
769 (let ((mime-viewer/decoding-mode "extract"))
770 (mime-preview/decode-content)
773 (defun mime-viewer/print-content ()
775 (let ((mime-viewer/decoding-mode "print"))
776 (mime-preview/decode-content)
779 (defun mime-viewer/display-x-face ()
781 (save-window-excursion
782 (set-buffer mime::preview/article-buffer)
783 (mime-viewer/x-face-function)
786 (defun mime-viewer/up-content ()
788 (let ((pc (mime::point-preview-content (point))) cinfo
789 (the-buf (current-buffer))
791 (switch-to-buffer (mime::preview-content-info/buffer pc))
792 (setq cinfo (mime::preview-content-info/content-info pc))
793 (setq rcnum (mime::content-info/rcnum cinfo))
795 (mime-viewer/quit the-buf
796 (mime::preview-content-info/buffer pc)
798 (setq r (mime-article/rcnum-to-cinfo (cdr rcnum)))
799 (switch-to-buffer the-buf)
801 (let ((rpcl mime::preview/content-list) cell)
803 (setq cell (car rpcl))
804 (if (eq r (mime::preview-content-info/content-info cell))
806 (goto-char (mime::preview-content-info/point-min cell))
809 (setq rpcl (cdr rpcl))
813 (defun mime-viewer/previous-content ()
815 (let* ((pcl mime::preview/content-list)
817 (i (- (length pcl) 1))
821 (setq beg (mime::preview-content-info/point-min (nth i pcl)))
823 (throw 'tag (goto-char beg))
829 (defun mime-viewer/next-content ()
831 (let ((pcl mime::preview/content-list)
836 (setq beg (mime::preview-content-info/point-min (car pcl)))
838 (throw 'tag (goto-char beg))
844 (defun mime-viewer/scroll-up-content (&optional h)
847 (setq h (- (window-height) 1))
849 (let ((pcl mime::preview/content-list)
855 (setq beg (mime::preview-content-info/point-min (car pcl)))
869 (defun mime-viewer/scroll-down-content (&optional h)
872 (setq h (- (window-height) 1))
874 (let ((pcl mime::preview/content-list)
878 (or (let ((i (- (length pcl) 1)))
881 (setq beg (mime::preview-content-info/point-min
894 (defun mime-viewer/next-line-content ()
896 (mime-viewer/scroll-up-content 1)
899 (defun mime-viewer/previous-line-content ()
901 (mime-viewer/scroll-down-content 1)
904 (defun mime-viewer/quit (&optional the-buf buf)
907 (setq the-buf (current-buffer))
910 (setq buf (mime::preview-content-info/buffer
911 (mime::point-preview-content (point))))
914 (switch-to-buffer buf)
915 (assoc major-mode mime-viewer/quitting-method-alist)
919 (switch-to-buffer the-buf)
924 (defun mime-viewer/kill-buffer ()
926 (kill-buffer (current-buffer))
935 (run-hooks 'tm-view-load-hook)