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).
30 (defconst mime-viewer/RCS-ID
31 "$Id: tm-view.el,v 7.6 1995/09/26 11:53:46 morioka Exp $")
33 (defconst mime-viewer/version (get-version-string mime-viewer/RCS-ID))
34 (defconst mime/viewer-version mime-viewer/version)
40 (defvar mime/content-decoding-condition
41 '(((type . "text/plain")
42 (method "tm-plain" nil 'file 'type 'encoding 'mode 'name))
43 ;;((type . "text/x-latex")
44 ;; (method "tm-latex" nil 'file 'type 'encoding 'mode 'name))
45 ((type . "audio/basic")
46 (method "tm-au" nil 'file 'type 'encoding 'mode 'name))
48 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
49 ((type . "image/jpeg")
50 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
51 ((type . "image/tiff")
52 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
53 ((type . "image/x-tiff")
54 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
55 ((type . "image/x-xbm")
56 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
57 ((type . "image/x-pic")
58 (method "tm-image" nil 'file 'type 'encoding 'mode 'name))
59 ((type . "video/mpeg")
60 (method "tm-mpeg" nil 'file 'type 'encoding 'mode 'name))
61 ((type . "application/octet-stream")
62 (method "tm-file" nil 'file 'type 'encoding 'mode 'name))
63 ;;((type . "message/external-body")
64 ;; (method "xterm" nil
65 ;; "-e" "showexternal"
66 ;; 'file '"access-type" '"name" '"site" '"directory"))
67 ((type . "message/partial")
68 (method . mime/decode-message/partial-region))
70 "-m" "tm" "-x" "-d" "-z" "-e" 'file)(mode . "play"))
71 ((method "tm-file" nil 'file 'type 'encoding 'mode 'name)
75 (defvar mime-viewer/childrens-header-showing-Content-Type-list
76 '("message/rfc822" "message/news"))
78 (defvar mime-viewer/default-showing-Content-Type-list
79 '("text/plain" "text/richtext" "text/enriched"
80 "text/x-latex" "application/x-latex"
81 "application/octet-stream" nil
83 "application/x-selection" "application/x-comment"))
85 (defvar mime-viewer/content-subject-omitting-Content-Type-list
86 '("application/x-selection"))
88 (defvar mime-viewer/uuencode-encoding-name-list '("x-uue" "x-uuencode"))
90 (defvar mime-viewer/ignored-field-list
91 '("Received" "Return-Path" "Replied" "Errors-To"
92 "Lines" "Sender" "Path" "Nntp-Posting-Host"
93 "Content-Type" "Precedence" "X-Face"))
95 (defvar mime-viewer/ignored-field-regexp)
97 (defvar mime-viewer/announcement-for-message/partial
98 (if (and (>= emacs-major-version 19) window-system)
100 \[[ This is message/partial style split message. ]]
101 \[[ Please press `v' key in this buffer ]]
102 \[[ or click here by mouse button-2. ]]"
104 \[[ This is message/partial style split message. ]]
105 \[[ Please press `v' key in this buffer. ]]"
109 ;;; @@ predicate functions
112 (defun mime-viewer/header-visible-p (cnum cinfo &optional ctype)
116 (mime::content-info/type
117 (mime-article/cnum-to-cinfo (butlast cnum) cinfo)
119 (member ctype mime-viewer/childrens-header-showing-Content-Type-list)
122 (defun mime-viewer/body-visible-p (cnum cinfo &optional ctype)
126 (mime::content-info/type
127 (setq ccinfo (mime-article/cnum-to-cinfo cnum cinfo))
130 (and (member ctype mime-viewer/default-showing-Content-Type-list)
131 (if (string-equal ctype "application/octet-stream")
134 (setq ccinfo (mime-article/cnum-to-cinfo cnum cinfo))
136 (member (mime::content-info/encoding ccinfo)
137 '(nil "7bit" "8bit"))
143 ;;; @@ content subject
146 (defun mime-viewer/insert-content-subject
147 (cnum cinfo ctype params subj)
149 (narrow-to-region (point)(point))
151 (let ((access-type (assoc "access-type" params))
152 (num (or (assoc-value "x-part-number" params)
156 (format "%s" (1+ num))
162 (let ((server (assoc "server" params)))
163 (setq access-type (cdr access-type))
165 (format "[%s %s ([%s] %s)]\n" num subj
166 access-type (cdr server))
167 (let ((site (assoc-value "site" params))
168 (dir (assoc-value "directory" params))
170 (format "[%s %s ([%s] %s:%s)]\n" num subj
171 access-type site dir)
173 (format "[%s %s (%s)]\n" num subj ctype)
175 (tm:add-button (point-min)(1- (point-max))
176 (function mime-viewer/play-content))
179 (defun mime-viewer/default-content-subject-function
180 (cnum cinfo ctype params subj)
181 (if (and (listp cnum)
184 mime-viewer/content-subject-omitting-Content-Type-list))
186 (mime-viewer/insert-content-subject
187 cnum cinfo ctype params subj)
190 (defvar mime-viewer/content-subject-function
191 (function mime-viewer/default-content-subject-function))
194 ;;; @@ content header filter
197 (defun mime-viewer/default-content-header-filter ()
198 (goto-char (point-min))
199 (while (and (re-search-forward mime-viewer/ignored-field-regexp nil t)
205 (re-search-forward "^\\([^ \t]\\|$\\)" nil t)
209 (mime/decode-message-header)
212 (defvar mime-viewer/content-header-filter-alist nil)
215 ;;; @@ content filter
218 (defvar mime-viewer/content-filter-alist
219 '(("text/plain" . mime-viewer/filter-text/plain)
220 ("application/pgp" . mime-viewer/filter-text/plain)
221 (nil . mime-viewer/filter-text/plain)))
223 (defun mime-viewer/default-content-filter (cnum cinfo ctype params subj)
227 ;;; @@ content separator
230 (defun mime-viewer/default-content-separator (cnum cinfo ctype params subj)
231 (if (and (not (mime-viewer/header-visible-p cnum cinfo ctype))
232 (not (mime-viewer/body-visible-p cnum cinfo ctype))
235 (goto-char (point-max))
240 ;;; @@ buffer local variables
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 (goto-char (point-min))
285 (if (re-search-forward "^X-Face:[ \t]*" nil t)
286 (let ((beg (match-end 0))
287 (end (message/field-end))
289 (call-process-region beg end "sh" nil 0 nil
290 "-c" mime-viewer/x-face-command)
294 ;;; @ data structures
297 ;;; @@ preview-content-info
300 (define-structure mime::preview-content-info
301 point-min point-max buffer content-info)
307 (defun mime-viewer/setup-buffer (&optional ctl encoding ibuf obuf)
313 (make-variable-buffer-local 'mime::article/content-info)
314 (setq mime::article/content-info (mime/parse-message ctl encoding))
315 (let ((ret (mime-viewer/make-preview-buffer obuf)))
316 (make-variable-buffer-local 'mime::article/preview-buffer)
317 (setq mime::article/preview-buffer (car ret))
320 (defun mime-viewer/make-preview-buffer (&optional obuf)
321 (let ((cinfo mime::article/content-info)
322 (the-buf (current-buffer))
326 (setq obuf (concat "*Preview-" (buffer-name the-buf) "*"))
328 (setq pcl (mime/flatten-content-info cinfo))
329 (let ((bf (get-buffer obuf)))
333 (setq buffer-read-only nil)
336 (setq bf (get-buffer-create obuf))
339 (make-variable-buffer-local 'mime::preview/article-buffer)
340 (setq mime::preview/article-buffer the-buf)
341 (make-variable-buffer-local 'mime::preview/original-major-mode)
342 (setq mime::preview/original-major-mode mode)
343 (setq major-mode 'mime/viewer-mode)
344 (setq mode-name "MIME-View")
349 (mime-viewer/display-content content cinfo the-buf obuf)
352 (set-buffer-modified-p nil)
353 (setq buffer-read-only t)
358 (defun mime-viewer/display-content (content cinfo ibuf obuf)
359 (let* ((beg (mime::content-info/point-min content))
360 (end (mime::content-info/point-max content))
361 (ctype (mime::content-info/type content))
362 (params (mime::content-info/parameters content))
363 (encoding (mime::content-info/encoding content))
364 (cnum (mime::get-point-content-number beg cinfo))
368 (setq he (if (re-search-forward "^$" nil t)
374 (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 (mime-viewer/insert-content-subject cnum cinfo ctype params subj)
397 (t (set-buffer obuf))
399 (mime-viewer/default-content-separator cnum cinfo ctype params subj)
402 (setq ne (point-max))
404 (mime::preview-content-info/create nb (1- ne) ibuf content)
409 (defun mime-viewer/display-header (beg end obuf)
410 (let ((str (buffer-substring beg end))
411 (f (assq major-mode mime-viewer/content-header-filter-alist))
416 (narrow-to-region (point)(point))
418 (if (and f (setq f (cdr f)))
420 (mime-viewer/default-content-header-filter)
422 (run-hooks 'mime-viewer/content-header-filter-hook)
425 (defun mime-viewer/display-body (beg end obuf
426 cnum cinfo ctype params subj encoding)
427 (let ((str (buffer-substring beg end))
431 (setq be (point-max))
432 (narrow-to-region be be)
434 (let ((f (assoc-value ctype mime-viewer/content-filter-alist)))
435 (if (and f (fboundp f))
436 (funcall f ctype params encoding)
437 (mime-viewer/default-content-filter cnum cinfo ctype params subj)
441 (defun mime-viewer/display-message/partial (obuf)
444 (goto-char (point-max))
445 (if (not (search-backward "\n\n" nil t))
448 (let ((be (point-max)))
449 (narrow-to-region be be)
450 (insert mime-viewer/announcement-for-message/partial)
451 (tm:add-button (point-min)(point-max)
452 (function mime-viewer/play-content))
455 (defun mime-viewer/get-subject (param &optional encoding)
456 (if (member (or encoding
457 (cdr (assq 'encoding param))
459 mime-viewer/uuencode-encoding-name-list)
461 (or (if (re-search-forward "^begin [0-9]+ " nil t)
462 (if (looking-at ".+$")
463 (buffer-substring (match-beginning 0)(match-end 0))
467 (or (and (setq ret (assoc "name" param))
468 (message/strip-quoted-string (cdr ret))
470 (and (setq ret (assoc "x-name" param))
471 (message/strip-quoted-string (cdr ret))
476 (goto-char (point-min))
477 (narrow-to-region (point-min)
478 (or (and (search-forward "\n\n" nil t)
483 (message/get-field-body "Content-Description")
484 (message/get-field-body "Subject")
490 ;;; @ content information
493 (defun mime::get-point-content-number (p &optional cinfo)
495 (setq cinfo mime::article/content-info)
497 (let ((b (mime::content-info/point-min cinfo))
498 (e (mime::content-info/point-max cinfo))
499 (c (mime::content-info/children cinfo))
501 (if (and (<= b p)(<= p e))
502 (or (let (co ret (sn 0))
506 (setq ret (mime::get-point-content-number p co))
507 (cond ((eq ret t) (throw 'tag (list sn)))
508 (ret (throw 'tag (cons sn ret)))
515 (defun mime-article/cnum-to-cinfo (cn &optional cinfo)
517 (setq cinfo mime::article/content-info)
524 (let ((rc (nth sn (mime::content-info/children cinfo))))
526 (mime-article/cnum-to-cinfo (cdr cn) rc)
530 (defun mime/flatten-content-info (&optional cinfo)
532 (setq cinfo mime::article/content-info)
534 (let ((dest (list cinfo))
535 (rcl (mime::content-info/children cinfo))
538 (setq dest (nconc dest (mime/flatten-content-info (car rcl))))
543 (defun mime::point-preview-content (p &optional pcl)
545 (setq pcl mime::preview/content-list)
551 (if (and (<= (mime::preview-content-info/point-min cell) p)
552 (<= p (mime::preview-content-info/point-max cell))
565 (defvar mime-viewer/code-converter-alist nil)
567 (defun mime-viewer/default-code-convert-region
568 (beg end charset &optional encoding)
569 (if (member encoding '("quoted-printable" "base64"))
570 (mime/code-convert-region-to-emacs beg (point-max) charset)
573 (defun mime-viewer/filter-text/plain (ctype params encoding)
574 (let ((charset (cdr (assoc "charset" params)))
575 (beg (point-min)) (end (point-max))
577 (goto-char (point-min))
578 (cond ((string= encoding "quoted-printable")
579 (quoted-printable-decode-region beg end)
581 ((string= encoding "base64")
582 (base64-decode-region beg end)
584 (let* ((mode mime::preview/original-major-mode)
585 (m (assq mode mime-viewer/code-converter-alist))
587 (if (and m (fboundp (setq m (cdr m))))
588 (funcall m beg (point-max) charset encoding)
589 (mime-viewer/default-code-convert-region beg (point-max)
592 (goto-char (point-max))
593 (if (not (eq (char-after (1- (point))) ?\n))
596 (if browse-url-browser-function
598 (goto-char (point-min))
599 (while (re-search-forward tm:URL-regexp nil t)
600 (tm:add-button (match-beginning 0)(match-end 0)
601 (function tm:browse-url))
603 (run-hooks 'mime-viewer/plain-text-preview-hook)
607 ;;; @ MIME viewer mode
610 (defvar mime/viewer-mode-map nil)
611 (if (null mime/viewer-mode-map)
613 (setq mime/viewer-mode-map (make-keymap))
614 (suppress-keymap mime/viewer-mode-map)
615 (define-key mime/viewer-mode-map
616 "u" (function mime-viewer/up-content))
617 (define-key mime/viewer-mode-map
618 "p" (function mime-viewer/previous-content))
619 (define-key mime/viewer-mode-map
620 "n" (function mime-viewer/next-content))
621 (define-key mime/viewer-mode-map
622 " " (function mime-viewer/scroll-up-content))
623 (define-key mime/viewer-mode-map
624 "\M- " (function mime-viewer/scroll-down-content))
625 (define-key mime/viewer-mode-map
626 "\177" (function mime-viewer/scroll-down-content))
627 (define-key mime/viewer-mode-map
628 "\C-m" (function mime-viewer/next-line-content))
629 (define-key mime/viewer-mode-map
630 "\C-\M-m" (function mime-viewer/previous-line-content))
631 (define-key mime/viewer-mode-map
632 "v" (function mime-viewer/play-content))
633 (define-key mime/viewer-mode-map
634 "e" (function mime-viewer/extract-content))
635 (define-key mime/viewer-mode-map
636 "\C-c\C-p" (function mime-viewer/print-content))
637 (define-key mime/viewer-mode-map
638 "f" (function mime-viewer/display-x-face))
639 (define-key mime/viewer-mode-map
640 "q" (function mime-viewer/quit))
641 (define-key mime/viewer-mode-map
642 "\C-c\C-x" (function mime-viewer/kill-buffer))
644 (define-key mime/viewer-mode-map
645 mouse-button-2 (function tm:button-dispatcher))
649 (defun mime/viewer-mode (&optional mother ctl encoding ibuf obuf)
650 "Major mode for viewing MIME message.
652 Here is a list of the standard keys for mime/viewer-mode.
657 u Move to upper content
658 p Move to previous content
659 n Move to next content
660 SPC Scroll up or move to next content
661 M-SPC Scroll down or move to previous content
662 DEL Scroll down or move to previous content
663 RET Move to next line
664 M-RET Move to previous line
665 v Decode current content as `play mode'
666 e Decode current content as `extract mode'
667 C-c C-p Decode current content as `print mode'
670 button-2 Move to point under the mouse cursor
671 and decode current content as `play mode'
674 Here are all the commands with their current binding,
677 \\{mime/viewer-mode-map}
680 (setq mime-viewer/ignored-field-regexp
682 (mapconcat (function regexp-quote)
683 mime-viewer/ignored-field-list "\\|")
685 (let ((buf (get-buffer mime/output-buffer-name)))
691 (let ((ret (mime-viewer/setup-buffer ctl encoding ibuf obuf)))
693 (switch-to-buffer (car ret))
696 (make-variable-buffer-local
697 'mime/show-mode-old-window-configuration)
698 (setq mime/show-mode-old-window-configuration
699 (current-window-configuration))
700 (make-variable-buffer-local 'mime/mother-buffer)
701 (setq mime/mother-buffer mother)
703 (use-local-map mime/viewer-mode-map)
704 (make-variable-buffer-local 'mime::preview/content-list)
705 (setq mime::preview/content-list (nth 1 ret))
707 (let ((ce (mime::preview-content-info/point-max
708 (car mime::preview/content-list)
711 (goto-char (point-min))
712 (search-forward "\n\n" nil t)
713 (setq e (match-end 0))
717 (run-hooks 'mime/viewer-mode-hook)
720 (defun mime-preview/point-content-number (point)
721 (save-window-excursion
722 (let ((pc (mime::point-preview-content (point)))
724 (switch-to-buffer (mime::preview-content-info/buffer pc))
725 (setq cinfo (mime::preview-content-info/content-info pc))
726 (mime::get-point-content-number (mime::content-info/point-min cinfo))
729 (defun mime-preview/cinfo-to-pcinfo (cinfo)
730 (let ((rpcl mime::preview/content-list) cell)
733 (setq cell (car rpcl))
734 (if (eq cinfo (mime::preview-content-info/content-info cell))
737 (setq rpcl (cdr rpcl))
740 (autoload 'mime-preview/decode-content "tm-play")
742 (defvar mime-viewer/decoding-mode "play" "MIME body decoding mode")
744 (defun mime-viewer/play-content ()
746 (let ((mime-viewer/decoding-mode "play"))
747 (mime-preview/decode-content)
750 (defun mime-viewer/play-content-mouse (e)
753 (mime-viewer/play-content)
756 (defun mime-viewer/extract-content ()
758 (let ((mime-viewer/decoding-mode "extract"))
759 (mime-preview/decode-content)
762 (defun mime-viewer/print-content ()
764 (let ((mime-viewer/decoding-mode "print"))
765 (mime-preview/decode-content)
768 (defun mime-viewer/display-x-face ()
770 (save-window-excursion
771 (set-buffer mime::preview/article-buffer)
772 (mime-viewer/x-face-function)
775 (defun mime-viewer/up-content ()
777 (let ((pc (mime::point-preview-content (point))) cinfo
778 (the-buf (current-buffer))
780 (switch-to-buffer (mime::preview-content-info/buffer pc))
781 (setq cinfo (mime::preview-content-info/content-info pc))
782 (setq cn (mime::get-point-content-number
783 (mime::content-info/point-min cinfo)))
785 (mime-viewer/quit the-buf
786 (mime::preview-content-info/buffer pc)
788 (setq r (mime-article/cnum-to-cinfo (butlast cn)))
789 (switch-to-buffer the-buf)
791 (let ((rpcl mime::preview/content-list) cell)
793 (setq cell (car rpcl))
794 (if (eq r (mime::preview-content-info/content-info cell))
796 (goto-char (mime::preview-content-info/point-min cell))
799 (setq rpcl (cdr rpcl))
803 (defun mime-viewer/previous-content ()
805 (let* ((pcl mime::preview/content-list)
807 (i (- (length pcl) 1))
811 (setq beg (mime::preview-content-info/point-min (nth i pcl)))
813 (throw 'tag (goto-char beg))
819 (defun mime-viewer/next-content ()
821 (let ((pcl mime::preview/content-list)
826 (setq beg (mime::preview-content-info/point-min (car pcl)))
828 (throw 'tag (goto-char beg))
834 (defun mime-viewer/scroll-up-content (&optional h)
837 (setq h (- (window-height) 1))
839 (let ((pcl mime::preview/content-list)
845 (setq beg (mime::preview-content-info/point-min (car pcl)))
859 (defun mime-viewer/scroll-down-content (&optional h)
862 (setq h (- (window-height) 1))
864 (let ((pcl mime::preview/content-list)
868 (or (let ((i (- (length pcl) 1)))
871 (setq beg (mime::preview-content-info/point-min
884 (defun mime-viewer/next-line-content ()
886 (mime-viewer/scroll-up-content 1)
889 (defun mime-viewer/previous-line-content ()
891 (mime-viewer/scroll-down-content 1)
894 (defun mime-viewer/quit (&optional the-buf buf)
897 (setq the-buf (current-buffer))
900 (setq buf (mime::preview-content-info/buffer
901 (mime::point-preview-content (point))))
904 (switch-to-buffer buf)
905 (assoc major-mode mime-viewer/quitting-method-alist)
909 (switch-to-buffer the-buf)
914 (defun mime-viewer/kill-buffer ()
916 (kill-buffer (current-buffer))
925 (run-hooks 'tm-view-load-hook)