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.17 1995/10/19 07:55:54 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 (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::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 ;; 1995/10/12 (c.f. tm-eng:130)
282 ;; fixed by Eric Ding <ericding@San-Jose.ate.slb.com>
284 (narrow-to-region (point-min) (re-search-forward "^$" nil t))
286 (goto-char (point-min))
287 (if (re-search-forward "^X-Face:[ \t]*" nil t)
288 (let ((beg (match-end 0))
289 (end (rfc822/field-end))
291 (call-process-region beg end "sh" nil 0 nil
292 "-c" mime-viewer/x-face-command)
296 ;;; @ data structures
299 ;;; @@ preview-content-info
302 (define-structure mime::preview-content-info
303 point-min point-max buffer content-info)
309 (defun mime-viewer/setup-buffer (&optional ctl encoding ibuf obuf)
315 (make-variable-buffer-local 'mime::article/content-info)
316 (setq mime::article/content-info (mime/parse-message ctl encoding))
317 (let ((ret (mime-viewer/make-preview-buffer obuf)))
318 (make-variable-buffer-local 'mime::article/preview-buffer)
319 (setq mime::article/preview-buffer (car ret))
322 (defun mime-viewer/make-preview-buffer (&optional obuf)
323 (let ((cinfo mime::article/content-info)
324 (the-buf (current-buffer))
328 (setq obuf (concat "*Preview-" (buffer-name the-buf) "*"))
330 (setq pcl (mime/flatten-content-info cinfo))
331 (let ((bf (get-buffer obuf)))
335 (setq buffer-read-only nil)
338 (setq bf (get-buffer-create obuf))
341 (make-variable-buffer-local 'mime::preview/article-buffer)
342 (setq mime::preview/article-buffer the-buf)
343 (make-variable-buffer-local 'mime::preview/original-major-mode)
344 (setq mime::preview/original-major-mode mode)
345 (setq major-mode 'mime/viewer-mode)
346 (setq mode-name "MIME-View")
351 (mime-viewer/display-content content cinfo the-buf obuf)
354 (set-buffer-modified-p nil)
355 (setq buffer-read-only t)
360 (defun mime-viewer/display-content (content cinfo ibuf obuf)
361 (let* ((beg (mime::content-info/point-min content))
362 (end (mime::content-info/point-max content))
363 (ctype (mime::content-info/type content))
364 (params (mime::content-info/parameters content))
365 (encoding (mime::content-info/encoding content))
366 (rcnum (mime::content-info/rcnum content))
370 (setq he (if (re-search-forward "^$" nil t)
377 (narrow-to-region beg end)
379 (mime-eword/decode-string
380 (mime-viewer/get-subject params encoding)))
384 (narrow-to-region nb nb)
385 (funcall mime-viewer/content-subject-function
386 rcnum cinfo ctype params subj)
388 (if (mime-viewer/header-visible-p rcnum cinfo ctype)
389 (mime-viewer/display-header beg he obuf)
391 (cond ((mime-viewer/body-visible-p rcnum cinfo ctype)
392 (mime-viewer/display-body he end obuf
393 rcnum cinfo ctype params subj encoding)
395 ((equal ctype "message/partial")
396 (mime-viewer/display-message/partial obuf)
399 (null (mime::content-info/children cinfo))
402 (goto-char (point-max))
403 (mime-viewer/insert-content-subject rcnum cinfo ctype params subj)
405 (t (set-buffer obuf))
407 (mime-viewer/default-content-separator rcnum cinfo ctype params subj)
410 (setq ne (point-max))
412 (mime::preview-content-info/create nb (1- ne) ibuf content)
417 (defun mime-viewer/display-header (beg end obuf)
418 (let ((str (buffer-substring beg end))
419 (f (assq major-mode mime-viewer/content-header-filter-alist))
424 (narrow-to-region (point)(point))
426 (if (and f (setq f (cdr f)))
428 (mime-viewer/default-content-header-filter)
430 (run-hooks 'mime-viewer/content-header-filter-hook)
433 (defun mime-viewer/display-body (beg end obuf
434 rcnum cinfo ctype params subj encoding)
435 (let ((str (buffer-substring beg end))
439 (setq be (point-max))
440 (narrow-to-region be be)
442 (let ((f (assoc-value ctype mime-viewer/content-filter-alist)))
443 (if (and f (fboundp f))
444 (funcall f ctype params encoding)
445 (mime-viewer/default-content-filter rcnum cinfo ctype params subj)
449 (defun mime-viewer/display-message/partial (obuf)
452 (goto-char (point-max))
453 (if (not (search-backward "\n\n" nil t))
456 (let ((be (point-max)))
457 (narrow-to-region be be)
458 (insert mime-viewer/announcement-for-message/partial)
459 (tm:add-button (point-min)(point-max)
460 (function mime-viewer/play-content))
463 (defun mime-viewer/get-subject (param &optional encoding)
464 (if (member (or encoding
465 (cdr (assq 'encoding param))
467 mime-viewer/uuencode-encoding-name-list)
469 (or (if (re-search-forward "^begin [0-9]+ " nil t)
470 (if (looking-at ".+$")
471 (buffer-substring (match-beginning 0)(match-end 0))
475 (or (and (setq ret (assoc "name" param))
476 (rfc822/strip-quoted-string (cdr ret))
478 (and (setq ret (assoc "x-name" param))
479 (rfc822/strip-quoted-string (cdr ret))
484 (goto-char (point-min))
485 (narrow-to-region (point-min)
486 (or (and (search-forward "\n\n" nil t)
491 (rfc822/get-field-body "Content-Description")
492 (rfc822/get-field-body "Subject")
498 ;;; @ content information
501 (defun mime-article/point-content-number (p &optional cinfo)
503 (setq cinfo mime::article/content-info)
505 (let ((b (mime::content-info/point-min cinfo))
506 (e (mime::content-info/point-max cinfo))
507 (c (mime::content-info/children cinfo))
509 (if (and (<= b p)(<= p e))
510 (or (let (co ret (sn 0))
514 (setq ret (mime-article/point-content-number p co))
515 (cond ((eq ret t) (throw 'tag (list sn)))
516 (ret (throw 'tag (cons sn ret)))
523 (defun mime-article/rcnum-to-cinfo (rcnum &optional cinfo)
525 (setq cinfo mime::article/content-info)
530 (equal (mime::content-info/rcnum ci) rcnum)
532 (mime/flatten-content-info cinfo)
535 (defun mime-article/cnum-to-cinfo (cn &optional cinfo)
537 (setq cinfo mime::article/content-info)
544 (let ((rc (nth sn (mime::content-info/children cinfo))))
546 (mime-article/cnum-to-cinfo (cdr cn) rc)
550 (defun mime/flatten-content-info (&optional cinfo)
552 (setq cinfo mime::article/content-info)
554 (let ((dest (list cinfo))
555 (rcl (mime::content-info/children cinfo))
558 (setq dest (nconc dest (mime/flatten-content-info (car rcl))))
563 (defun mime::point-preview-content (p &optional pcl)
565 (setq pcl mime::preview/content-list)
571 (if (and (<= (mime::preview-content-info/point-min cell) p)
572 (<= p (mime::preview-content-info/point-max cell))
585 (defvar mime-viewer/code-converter-alist nil)
587 (defun mime-viewer/default-code-convert-region
588 (beg end charset &optional encoding)
589 (if (member encoding '("quoted-printable" "base64"))
590 (mime/code-convert-region-to-emacs beg (point-max) charset)
593 (defun mime-viewer/filter-text/plain (ctype params encoding)
594 (let ((charset (cdr (assoc "charset" params)))
595 (beg (point-min)) (end (point-max))
597 (goto-char (point-min))
598 (cond ((string= encoding "quoted-printable")
599 (quoted-printable-decode-region beg end)
601 ((string= encoding "base64")
602 (base64-decode-region beg end)
604 (let* ((mode mime::preview/original-major-mode)
605 (m (assq mode mime-viewer/code-converter-alist))
607 (if (and m (fboundp (setq m (cdr m))))
608 (funcall m beg (point-max) charset encoding)
609 (mime-viewer/default-code-convert-region beg (point-max)
612 (goto-char (point-max))
613 (if (not (eq (char-after (1- (point))) ?\n))
616 (if browse-url-browser-function
618 (goto-char (point-min))
619 (while (re-search-forward tm:URL-regexp nil t)
620 (tm:add-button (match-beginning 0)(match-end 0)
621 (function tm:browse-url))
623 (run-hooks 'mime-viewer/plain-text-preview-hook)
627 ;;; @ MIME viewer mode
630 (defvar mime/viewer-mode-map nil)
631 (if (null mime/viewer-mode-map)
633 (setq mime/viewer-mode-map (make-keymap))
634 (suppress-keymap mime/viewer-mode-map)
635 (define-key mime/viewer-mode-map
636 "u" (function mime-viewer/up-content))
637 (define-key mime/viewer-mode-map
638 "p" (function mime-viewer/previous-content))
639 (define-key mime/viewer-mode-map
640 "n" (function mime-viewer/next-content))
641 (define-key mime/viewer-mode-map
642 " " (function mime-viewer/scroll-up-content))
643 (define-key mime/viewer-mode-map
644 "\M- " (function mime-viewer/scroll-down-content))
645 (define-key mime/viewer-mode-map
646 "\177" (function mime-viewer/scroll-down-content))
647 (define-key mime/viewer-mode-map
648 "\C-m" (function mime-viewer/next-line-content))
649 (define-key mime/viewer-mode-map
650 "\C-\M-m" (function mime-viewer/previous-line-content))
651 (define-key mime/viewer-mode-map
652 "v" (function mime-viewer/play-content))
653 (define-key mime/viewer-mode-map
654 "e" (function mime-viewer/extract-content))
655 (define-key mime/viewer-mode-map
656 "\C-c\C-p" (function mime-viewer/print-content))
657 (define-key mime/viewer-mode-map
658 "f" (function mime-viewer/display-x-face))
659 (define-key mime/viewer-mode-map
660 "q" (function mime-viewer/quit))
661 (define-key mime/viewer-mode-map
662 "\C-c\C-x" (function mime-viewer/kill-buffer))
664 (define-key mime/viewer-mode-map
665 mouse-button-2 (function tm:button-dispatcher))
669 (defun mime/viewer-mode (&optional mother ctl encoding ibuf obuf)
670 "Major mode for viewing MIME message.
672 Here is a list of the standard keys for mime/viewer-mode.
677 u Move to upper content
678 p Move to previous content
679 n Move to next content
680 SPC Scroll up or move to next content
681 M-SPC Scroll down or move to previous content
682 DEL Scroll down or move to previous content
683 RET Move to next line
684 M-RET Move to previous line
685 v Decode current content as `play mode'
686 e Decode current content as `extract mode'
687 C-c C-p Decode current content as `print mode'
690 button-2 Move to point under the mouse cursor
691 and decode current content as `play mode'
694 Here are all the commands with their current binding,
697 \\{mime/viewer-mode-map}
700 (setq mime-viewer/ignored-field-regexp
702 (mapconcat (function regexp-quote)
703 mime-viewer/ignored-field-list "\\|")
705 (let ((buf (get-buffer mime/output-buffer-name)))
711 (let ((ret (mime-viewer/setup-buffer ctl encoding ibuf obuf)))
713 (switch-to-buffer (car ret))
716 (make-variable-buffer-local
717 'mime/show-mode-old-window-configuration)
718 (setq mime/show-mode-old-window-configuration
719 (current-window-configuration))
720 (make-variable-buffer-local 'mime/mother-buffer)
721 (setq mime/mother-buffer mother)
723 (use-local-map mime/viewer-mode-map)
724 (make-variable-buffer-local 'mime::preview/content-list)
725 (setq mime::preview/content-list (nth 1 ret))
727 (let ((ce (mime::preview-content-info/point-max
728 (car mime::preview/content-list)
731 (goto-char (point-min))
732 (search-forward "\n\n" nil t)
733 (setq e (match-end 0))
737 (run-hooks 'mime/viewer-mode-hook)
740 (defun mime-preview/point-content-number (point)
741 (save-window-excursion
742 (let ((pc (mime::point-preview-content (point)))
744 (switch-to-buffer (mime::preview-content-info/buffer pc))
745 (setq cinfo (mime::preview-content-info/content-info pc))
746 (mime-article/point-content-number (mime::content-info/point-min cinfo))
749 (defun mime-preview/cinfo-to-pcinfo (cinfo)
750 (let ((rpcl mime::preview/content-list) cell)
753 (setq cell (car rpcl))
754 (if (eq cinfo (mime::preview-content-info/content-info cell))
757 (setq rpcl (cdr rpcl))
760 (autoload 'mime-preview/decode-content "tm-play")
762 (defvar mime-viewer/decoding-mode "play" "MIME body decoding mode")
764 (defun mime-viewer/play-content ()
766 (let ((mime-viewer/decoding-mode "play"))
767 (mime-preview/decode-content)
770 (defun mime-viewer/extract-content ()
772 (let ((mime-viewer/decoding-mode "extract"))
773 (mime-preview/decode-content)
776 (defun mime-viewer/print-content ()
778 (let ((mime-viewer/decoding-mode "print"))
779 (mime-preview/decode-content)
782 (defun mime-viewer/display-x-face ()
784 (save-window-excursion
785 (set-buffer mime::preview/article-buffer)
786 (mime-viewer/x-face-function)
789 (defun mime-viewer/up-content ()
791 (let ((pc (mime::point-preview-content (point))) cinfo
792 (the-buf (current-buffer))
794 (switch-to-buffer (mime::preview-content-info/buffer pc))
795 (setq cinfo (mime::preview-content-info/content-info pc))
796 (setq rcnum (mime::content-info/rcnum cinfo))
798 (mime-viewer/quit the-buf
799 (mime::preview-content-info/buffer pc)
801 (setq r (mime-article/rcnum-to-cinfo (cdr rcnum)))
802 (switch-to-buffer the-buf)
804 (let ((rpcl mime::preview/content-list) cell)
806 (setq cell (car rpcl))
807 (if (eq r (mime::preview-content-info/content-info cell))
809 (goto-char (mime::preview-content-info/point-min cell))
812 (setq rpcl (cdr rpcl))
816 (defun mime-viewer/previous-content ()
818 (let* ((pcl mime::preview/content-list)
820 (i (- (length pcl) 1))
824 (setq beg (mime::preview-content-info/point-min (nth i pcl)))
826 (throw 'tag (goto-char beg))
832 (defun mime-viewer/next-content ()
834 (let ((pcl mime::preview/content-list)
839 (setq beg (mime::preview-content-info/point-min (car pcl)))
841 (throw 'tag (goto-char beg))
847 (defun mime-viewer/scroll-up-content (&optional h)
850 (setq h (- (window-height) 1))
852 (let ((pcl mime::preview/content-list)
858 (setq beg (mime::preview-content-info/point-min (car pcl)))
872 (defun mime-viewer/scroll-down-content (&optional h)
875 (setq h (- (window-height) 1))
877 (let ((pcl mime::preview/content-list)
881 (or (let ((i (- (length pcl) 1)))
884 (setq beg (mime::preview-content-info/point-min
897 (defun mime-viewer/next-line-content ()
899 (mime-viewer/scroll-up-content 1)
902 (defun mime-viewer/previous-line-content ()
904 (mime-viewer/scroll-down-content 1)
907 (defun mime-viewer/quit (&optional the-buf buf)
910 (setq the-buf (current-buffer))
913 (setq buf (mime::preview-content-info/buffer
914 (mime::point-preview-content (point))))
917 (switch-to-buffer buf)
918 (assoc major-mode mime-viewer/quitting-method-alist)
922 (switch-to-buffer the-buf)
927 (defun mime-viewer/kill-buffer ()
929 (kill-buffer (current-buffer))
938 (run-hooks 'tm-view-load-hook)