1 ;;; mime-view.el --- interactive MIME viewer for GNU Emacs
3 ;; Copyright (C) 1995,1996,1997,1998,1999,2000 Free Software Foundation, Inc.
5 ;; Author: MORIOKA Tomohiko <tomo@m17n.org>
7 ;; Renamed: 1994/08/31 from tm-body.el
8 ;; Renamed: 1997/02/19 from tm-view.el
9 ;; Keywords: MIME, multimedia, mail, news
11 ;; This file is part of SEMI (Sample of Elastic MIME Interfaces).
13 ;; This program is free software; you can redistribute it and/or
14 ;; modify it under the terms of the GNU General Public License as
15 ;; published by the Free Software Foundation; either version 2, or (at
16 ;; your option) any later version.
18 ;; This program is distributed in the hope that it will be useful, but
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 ;; General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
41 (defconst mime-view-version
42 (concat (mime-product-name mime-user-interface-product) " MIME-View "
43 (mapconcat #'number-to-string
44 (mime-product-version mime-user-interface-product) ".")
45 " (" (mime-product-code-name mime-user-interface-product) ")"))
51 (defgroup mime-view nil
55 (defvar mime-view-find-every-situations t
56 "*Find every available situations if non-nil.")
58 (defcustom mime-situation-examples-file "~/.mime-example"
59 "*File name of situation-examples demonstrated by user."
63 (defcustom mime-preview-move-scroll nil
64 "*Decides whether to scroll when moving to next entity.
65 When t, scroll the buffer. Non-nil but not t means scroll when
66 the next entity is within next-screen-context-lines from top or
67 buttom. Nil means don't scroll at all."
69 :type '(choice (const :tag "Off" nil)
71 (sexp :tag "Situation" 1)))
74 ;;; @ in raw-buffer (representation space)
77 (defvar mime-preview-buffer nil
78 "MIME-preview buffer corresponding with the (raw) buffer.")
79 (make-variable-buffer-local 'mime-preview-buffer)
82 (defvar mime-raw-representation-type-alist
83 '((mime-show-message-mode . binary)
84 (mime-temp-message-mode . binary)
87 "Alist of major-mode vs. representation-type of mime-raw-buffer.
88 Each element looks like (SYMBOL . REPRESENTATION-TYPE). SYMBOL is
89 major-mode or t. t means default. REPRESENTATION-TYPE must be
90 `binary' or `cooked'.")
93 ;;; @ in preview-buffer (presentation space)
96 (defvar mime-mother-buffer nil
97 "Mother buffer corresponding with the (MIME-preview) buffer.
98 If current MIME-preview buffer is generated by other buffer, such as
99 message/partial, it is called `mother-buffer'.")
100 (make-variable-buffer-local 'mime-mother-buffer)
102 ;; (defvar mime-raw-buffer nil
103 ;; "Raw buffer corresponding with the (MIME-preview) buffer.")
104 ;; (make-variable-buffer-local 'mime-raw-buffer)
106 (defvar mime-preview-original-window-configuration nil
107 "Window-configuration before mime-view-mode is called.")
108 (make-variable-buffer-local 'mime-preview-original-window-configuration)
110 (defun mime-preview-original-major-mode (&optional recursive point)
111 "Return major-mode of original buffer.
112 If optional argument RECURSIVE is non-nil and current buffer has
113 mime-mother-buffer, it returns original major-mode of the
115 (if (and recursive mime-mother-buffer)
117 (set-buffer mime-mother-buffer)
118 (mime-preview-original-major-mode recursive)
120 (cdr (assq 'major-mode
121 (get-text-property (or point
122 (if (> (point) (buffer-size))
123 (max (1- (point-max)) (point-min))
125 'mime-view-situation)))))
128 ;;; @ entity information
131 (defun mime-entity-situation (entity &optional situation)
132 "Return situation of ENTITY."
133 (let (rest param name)
135 (unless (assq 'type situation)
136 (setq rest (or (mime-entity-content-type entity)
137 (make-mime-content-type 'text 'plain))
138 situation (cons (car rest) situation)
141 (unless (assq 'subtype situation)
143 (setq rest (or (cdr (mime-entity-content-type entity))
144 '((subtype . plain)))))
145 (setq situation (cons (car rest) situation)
149 (setq param (car rest))
150 (or (assoc (car param) situation)
151 (setq situation (cons param situation)))
152 (setq rest (cdr rest)))
154 ;; Content-Disposition
156 (unless (assq 'disposition-type situation)
157 (setq rest (mime-entity-content-disposition entity))
159 (setq situation (cons (cons 'disposition-type
160 (mime-content-disposition-type rest))
162 rest (mime-content-disposition-parameters rest))
165 (setq param (car rest)
167 (if (cond ((string= name "filename")
168 (if (assq 'filename situation)
170 (setq name 'filename)))
171 ((string= name "creation-date")
172 (if (assq 'creation-date situation)
174 (setq name 'creation-date)))
175 ((string= name "modification-date")
176 (if (assq 'modification-date situation)
178 (setq name 'modification-date)))
179 ((string= name "read-date")
180 (if (assq 'read-date situation)
182 (setq name 'read-date)))
183 ((string= name "size")
184 (if (assq 'size situation)
187 (t (setq name (cons 'disposition name))
188 (if (assoc name situation)
192 (cons (cons name (cdr param))
194 (setq rest (cdr rest)))
196 ;; Content-Transfer-Encoding
197 (or (assq 'encoding situation)
199 (cons (cons 'encoding (or (mime-entity-encoding entity)
205 (defsubst mime-delq-null-situation (situations field
206 &optional ignored-value)
209 (let* ((situation (car situations))
210 (cell (assq field situation)))
212 (or (eq (cdr cell) ignored-value)
213 (setq dest (cons situation dest))
215 (setq situations (cdr situations)))
218 (defun mime-compare-situation-with-example (situation example)
219 (let ((example (copy-alist example))
222 (let* ((cell (car situation))
224 (ecell (assoc key example)))
226 (if (equal cell ecell)
227 (setq match (1+ match))
228 (setq example (delq ecell example))
231 (setq situation (cdr situation))
236 (defun mime-sort-situation (situation)
246 (disposition-type . 6)
250 (let ((ret (assq a-t order)))
252 (setq a-order (cdr ret))
258 (let ((ret (assq b-t order)))
260 (setq b-order (cdr ret))
265 (if (= a-order b-order)
266 (string< (format "%s" a-t)(format "%s" b-t))
271 (defun mime-unify-situations (entity-situation
272 condition situation-examples
273 &optional required-name ignored-value)
275 (in-calist-package 'mime-view)
277 (ctree-find-calist condition entity-situation
278 mime-view-find-every-situations))
280 (setq ret (mime-delq-null-situation ret required-name ignored-value)))
281 (or (assq 'ignore-examples entity-situation)
289 (let ((situation (car rest))
290 (examples situation-examples))
293 (mime-compare-situation-with-example
294 situation (caar examples)))
295 (ret-score (car ret)))
296 (cond ((> ret-score max-score)
297 (setq max-score ret-score
298 max-escore (cdar examples)
299 max-examples (list (cdr ret))
300 max-situations (list situation))
302 ((= ret-score max-score)
303 (cond ((> (cdar examples) max-escore)
304 (setq max-escore (cdar examples)
305 max-examples (list (cdr ret))
306 max-situations (list situation))
308 ((= (cdar examples) max-escore)
310 (cons (cdr ret) max-examples))
311 (or (member situation max-situations)
313 (cons situation max-situations)))
315 (setq examples (cdr examples))))
316 (setq rest (cdr rest)))
318 (setq ret max-situations)
320 (let* ((example (car max-examples))
322 (assoc example situation-examples)))
324 (setcdr cell (1+ (cdr cell)))
325 (setq situation-examples
326 (cons (cons example 0)
329 (setq max-examples (cdr max-examples))
331 (cons ret situation-examples)
332 ;; ret: list of situations
333 ;; situation-examples: new examples (notoce that contents of
334 ;; argument `situation-examples' has bees modified)
337 (defun mime-view-entity-title (entity)
338 (or (mime-entity-read-field entity 'Content-Description)
339 (mime-entity-read-field entity 'Subject)
340 (mime-entity-filename entity)
343 (defvar mime-preview-situation-example-list nil)
344 (defvar mime-preview-situation-example-list-max-size 16)
345 ;; (defvar mime-preview-situation-example-condition nil)
347 (defun mime-find-entity-preview-situation (entity
348 &optional default-situation)
350 (mime-unify-situations
351 (append (mime-entity-situation entity)
353 mime-preview-condition
354 mime-preview-situation-example-list)))
355 (setq mime-preview-situation-example-list
361 (defvar mime-acting-situation-example-list nil)
362 (defvar mime-acting-situation-example-list-max-size 16)
364 (defun mime-save-situation-examples ()
365 (if (or mime-preview-situation-example-list
366 mime-acting-situation-example-list)
367 (let* ((file mime-situation-examples-file)
368 (buffer (get-buffer-create " *mime-example*")))
372 (setq buffer-file-name file)
374 (insert ";;; " (file-name-nondirectory file) "\n")
375 (insert "\n;; This file is generated automatically by "
376 mime-view-version "\n\n")
377 (insert ";;; Code:\n\n")
378 (if mime-preview-situation-example-list
379 (pp `(setq mime-preview-situation-example-list
380 ',mime-preview-situation-example-list)
382 (if mime-acting-situation-example-list
383 (pp `(setq mime-acting-situation-example-list
384 ',mime-acting-situation-example-list)
387 (file-name-nondirectory file)
390 (kill-buffer buffer)))))
392 (add-hook 'kill-emacs-hook 'mime-save-situation-examples)
394 (defun mime-reduce-situation-examples (situation-examples)
395 (let ((len (length situation-examples))
403 ir situation-examples)
407 jr situation-examples)
411 (setq ret (mime-compare-situation-with-example (car ic)(car jc))
413 det-ret (+ (length (car ic))(length (car jc)))
414 det-org (length (cdr ret))
415 freq (+ (cdr ic)(cdr jc)))
416 (cond ((< max-sim sim)
423 dest (cons (cdr ret) freq))
426 (cond ((> min-det-ret det-ret)
427 (setq min-det-ret det-ret
432 dest (cons (cdr ret) freq))
434 ((= min-det-ret det-ret)
435 (cond ((> min-det-org det-org)
436 (setq min-det-org det-org
440 dest (cons (cdr ret) freq))
442 ((= min-det-org det-org)
443 (cond ((> min-freq freq)
447 dest (cons (cdr ret) freq))
461 (setq jr (nthcdr (1- d-j) situation-examples))
462 (setcdr jr (cddr jr))
464 (setq situation-examples
465 (cdr situation-examples))
466 (setq ir (nthcdr (1- d-i) situation-examples))
467 (setcdr ir (cddr ir))
469 (if (setq ir (assoc (car dest) situation-examples))
471 (setcdr ir (+ (cdr ir)(cdr dest)))
473 (cons dest situation-examples)
474 ;; situation-examples may be modified.
478 ;;; @ presentation of preview
484 ;;; @@@ predicate function
487 ;; (defun mime-view-entity-button-visible-p (entity)
488 ;; "Return non-nil if header of ENTITY is visible.
489 ;; Please redefine this function if you want to change default setting."
490 ;; (let ((media-type (mime-entity-media-type entity))
491 ;; (media-subtype (mime-entity-media-subtype entity)))
492 ;; (or (not (eq media-type 'application))
493 ;; (and (not (eq media-subtype 'x-selection))
494 ;; (or (not (eq media-subtype 'octet-stream))
495 ;; (let ((mother-entity (mime-entity-parent entity)))
496 ;; (or (not (eq (mime-entity-media-type mother-entity)
498 ;; (not (eq (mime-entity-media-subtype mother-entity)
503 ;;; @@@ entity button generator
506 (defun mime-view-insert-entity-button (entity)
507 "Insert entity-button of ENTITY."
508 (let ((entity-node-id (mime-entity-node-id entity))
509 (params (mime-entity-parameters entity))
510 (subject (mime-view-entity-title entity)))
512 (let ((access-type (assoc "access-type" params))
513 (num (or (cdr (assoc "x-part-number" params))
514 (if (consp entity-node-id)
517 (format "%s" (1+ num))
519 (reverse entity-node-id) ".")
523 (let ((server (assoc "server" params)))
524 (setq access-type (cdr access-type))
526 (format "%s %s ([%s] %s)"
527 num subject access-type (cdr server))
528 (let ((site (cdr (assoc "site" params)))
529 (dir (cdr (assoc "directory" params)))
530 (url (cdr (assoc "url" params)))
533 (format "%s %s ([%s] %s)"
534 num subject access-type url)
535 (format "%s %s ([%s] %s:%s)"
536 num subject access-type site dir))
540 (let ((media-type (mime-entity-media-type entity))
541 (media-subtype (mime-entity-media-subtype entity))
542 (charset (cdr (assoc "charset" params)))
543 (encoding (mime-entity-encoding entity)))
547 (format " <%s/%s%s%s>"
548 media-type media-subtype
550 (concat "; " charset)
553 (concat " (" encoding ")")
555 (if (>= (+ (current-column)(length rest))(window-width))
559 (function mime-preview-play-current-entity))
566 (defvar mime-header-presentation-method-alist nil
567 "Alist of major mode vs. corresponding header-presentation-method functions.
568 Each element looks like (SYMBOL . FUNCTION).
569 SYMBOL must be major mode in raw-buffer or t. t means default.
570 Interface of FUNCTION must be (ENTITY SITUATION).")
572 (defvar mime-view-ignored-field-list
573 '(".*Received:" ".*Path:" ".*Id:" "^References:"
574 "^Replied:" "^Errors-To:"
575 "^Lines:" "^Sender:" ".*Host:" "^Xref:"
576 "^Content-Type:" "^Precedence:"
577 "^Status:" "^X-VM-.*:")
578 "All fields that match this list will be hidden in MIME preview buffer.
579 Each elements are regexp of field-name.")
581 (defvar mime-view-visible-field-list '("^Dnas.*:" "^Message-Id:")
582 "All fields that match this list will be displayed in MIME preview buffer.
583 Each elements are regexp of field-name.")
589 ;;; @@@ predicate function
592 (in-calist-package 'mime-view)
594 (defun mime-calist::field-match-method-as-default-rule (calist
595 field-type field-value)
596 (let ((s-field (assq field-type calist)))
597 (cond ((null s-field)
598 (cons (cons field-type field-value) calist)
602 (define-calist-field-match-method
603 'header #'mime-calist::field-match-method-as-default-rule)
605 (define-calist-field-match-method
606 'body #'mime-calist::field-match-method-as-default-rule)
609 (defvar mime-preview-condition nil
610 "Condition-tree about how to display entity.")
612 (ctree-set-calist-strictly
613 'mime-preview-condition '((type . application)(subtype . octet-stream)
616 (ctree-set-calist-strictly
617 'mime-preview-condition '((type . application)(subtype . octet-stream)
620 (ctree-set-calist-strictly
621 'mime-preview-condition '((type . application)(subtype . octet-stream)
625 (ctree-set-calist-strictly
626 'mime-preview-condition '((type . application)(subtype . pgp)
629 (ctree-set-calist-strictly
630 'mime-preview-condition '((type . application)(subtype . x-latex)
633 (ctree-set-calist-strictly
634 'mime-preview-condition '((type . application)(subtype . x-selection)
637 (ctree-set-calist-strictly
638 'mime-preview-condition '((type . application)(subtype . x-comment)
641 (ctree-set-calist-strictly
642 'mime-preview-condition '((type . message)(subtype . delivery-status)
645 (ctree-set-calist-strictly
646 'mime-preview-condition
648 (body-presentation-method . mime-display-text/plain)))
650 (ctree-set-calist-strictly
651 'mime-preview-condition
654 (body-presentation-method . mime-display-text/plain)))
656 (ctree-set-calist-strictly
657 'mime-preview-condition
658 '((type . text)(subtype . enriched)
660 (body-presentation-method . mime-display-text/enriched)))
662 (ctree-set-calist-strictly
663 'mime-preview-condition
664 '((type . text)(subtype . richtext)
666 (body-presentation-method . mime-display-text/richtext)))
668 (autoload 'mime-display-application/x-postpet "postpet")
670 (ctree-set-calist-strictly
671 'mime-preview-condition
672 '((type . application)(subtype . x-postpet)
674 (body-presentation-method . mime-display-application/x-postpet)))
676 (ctree-set-calist-strictly
677 'mime-preview-condition
678 '((type . text)(subtype . t)
680 (body-presentation-method . mime-display-text/plain)))
682 (ctree-set-calist-strictly
683 'mime-preview-condition
684 '((type . multipart)(subtype . alternative)
686 (body-presentation-method . mime-display-multipart/alternative)))
688 (ctree-set-calist-strictly
689 'mime-preview-condition '((type . message)(subtype . partial)
690 (body-presentation-method
691 . mime-display-message/partial-button)))
693 (ctree-set-calist-strictly
694 'mime-preview-condition '((type . message)(subtype . rfc822)
695 (body-presentation-method . nil)
696 (childrens-situation (header . visible)
697 (entity-button . invisible))))
699 (ctree-set-calist-strictly
700 'mime-preview-condition '((type . message)(subtype . news)
701 (body-presentation-method . nil)
702 (childrens-situation (header . visible)
703 (entity-button . invisible))))
706 ;;; @@@ entity presentation
709 (defun mime-display-text/plain (entity situation)
711 (narrow-to-region (point-max)(point-max))
712 (mime-insert-text-content entity)
713 (run-hooks 'mime-text-decode-hook)
714 (goto-char (point-max))
715 (if (not (eq (char-after (1- (point))) ?\n))
718 (mime-add-url-buttons)
719 (run-hooks 'mime-display-text/plain-hook)
722 (defun mime-display-text/richtext (entity situation)
724 (narrow-to-region (point-max)(point-max))
725 (mime-insert-text-content entity)
726 (run-hooks 'mime-text-decode-hook)
727 (let ((beg (point-min)))
728 (remove-text-properties beg (point-max) '(face nil))
729 (richtext-decode beg (point-max))
732 (defun mime-display-text/enriched (entity situation)
734 (narrow-to-region (point-max)(point-max))
735 (mime-insert-text-content entity)
736 (run-hooks 'mime-text-decode-hook)
737 (let ((beg (point-min)))
738 (remove-text-properties beg (point-max) '(face nil))
739 (enriched-decode beg (point-max))
743 (defvar mime-view-announcement-for-message/partial
744 (if (and (>= emacs-major-version 19) window-system)
746 \[[ This is message/partial style split message. ]]
747 \[[ Please press `v' key in this buffer ]]
748 \[[ or click here by mouse button-2. ]]"
750 \[[ This is message/partial style split message. ]]
751 \[[ Please press `v' key in this buffer. ]]"
754 (defun mime-display-message/partial-button (&optional entity situation)
756 (goto-char (point-max))
757 (if (not (search-backward "\n\n" nil t))
760 (goto-char (point-max))
761 (narrow-to-region (point-max)(point-max))
762 (insert mime-view-announcement-for-message/partial)
763 (mime-add-button (point-min)(point-max)
764 #'mime-preview-play-current-entity)
767 (defun mime-display-multipart/mixed (entity situation)
768 (let ((children (mime-entity-children entity))
769 (original-major-mode-cell (assq 'major-mode situation))
771 (cdr (assq 'childrens-situation situation))))
772 (if original-major-mode-cell
773 (setq default-situation
774 (cons original-major-mode-cell default-situation)))
776 (mime-display-entity (car children) nil default-situation)
777 (setq children (cdr children))
780 (defcustom mime-view-type-subtype-score-alist
781 '(((text . enriched) . 3)
782 ((text . richtext) . 2)
785 "Alist MEDIA-TYPE vs corresponding score.
786 MEDIA-TYPE must be (TYPE . SUBTYPE), TYPE or t. t means default."
788 :type '(repeat (cons (choice :tag "Media-Type"
789 (cons :tag "Type/Subtype"
790 (symbol :tag "Primary-type")
791 (symbol :tag "Subtype"))
793 (const :tag "Default" t))
796 (defun mime-display-multipart/alternative (entity situation)
797 (let* ((children (mime-entity-children entity))
798 (original-major-mode-cell (assq 'major-mode situation))
800 (cdr (assq 'childrens-situation situation)))
805 (if original-major-mode-cell
806 (setq default-situation
807 (cons original-major-mode-cell default-situation)))
812 (mime-find-entity-preview-situation
813 child default-situation)))
814 (if (cdr (assq 'body-presentation-method situation))
819 (cdr (assq 'type situation))
820 (cdr (assq 'subtype situation)))
821 mime-view-type-subtype-score-alist)
823 (cdr (assq 'type situation))
824 mime-view-type-subtype-score-alist)
827 mime-view-type-subtype-score-alist)
829 (if (> score max-score)
839 (let ((child (car children))
840 (situation (car situations)))
841 (mime-display-entity child (if (= i p)
843 (del-alist 'body-presentation-method
844 (copy-alist situation))))
846 (setq children (cdr children)
847 situations (cdr situations)
852 ;;; @ acting-condition
855 (defvar mime-acting-condition nil
856 "Condition-tree about how to process entity.")
858 (if (file-readable-p mailcap-file)
859 (let ((entries (mailcap-parse-file)))
861 (let ((entry (car entries))
864 (let* ((field (car entry))
865 (field-type (car field)))
866 (cond ((eq field-type 'view) (setq view field))
867 ((eq field-type 'print) (setq print field))
868 ((memq field-type '(compose composetyped edit)))
869 (t (setq shared (cons field shared))))
871 (setq entry (cdr entry))
873 (setq shared (nreverse shared))
874 (ctree-set-calist-with-default
875 'mime-acting-condition
876 (append shared (list '(mode . "play")(cons 'method (cdr view)))))
878 (ctree-set-calist-with-default
879 'mime-acting-condition
881 (list '(mode . "print")(cons 'method (cdr view))))
884 (setq entries (cdr entries))
887 (ctree-set-calist-strictly
888 'mime-acting-condition
889 '((type . application)(subtype . octet-stream)
891 (method . mime-detect-content)
894 (ctree-set-calist-with-default
895 'mime-acting-condition
897 (method . mime-save-content)))
899 (ctree-set-calist-strictly
900 'mime-acting-condition
901 '((type . text)(subtype . x-rot13-47)(mode . "play")
902 (method . mime-view-caesar)
904 (ctree-set-calist-strictly
905 'mime-acting-condition
906 '((type . text)(subtype . x-rot13-47-48)(mode . "play")
907 (method . mime-view-caesar)
910 (ctree-set-calist-strictly
911 'mime-acting-condition
912 '((type . message)(subtype . rfc822)(mode . "play")
913 (method . mime-view-message/rfc822)
915 (ctree-set-calist-strictly
916 'mime-acting-condition
917 '((type . message)(subtype . partial)(mode . "play")
918 (method . mime-store-message/partial-piece)
921 (ctree-set-calist-strictly
922 'mime-acting-condition
923 '((type . message)(subtype . external-body)
924 ("access-type" . "anon-ftp")
925 (method . mime-view-message/external-anon-ftp)
928 (ctree-set-calist-strictly
929 'mime-acting-condition
930 '((type . message)(subtype . external-body)
931 ("access-type" . "url")
932 (method . mime-view-message/external-url)
935 (ctree-set-calist-strictly
936 'mime-acting-condition
937 '((type . application)(subtype . octet-stream)
938 (method . mime-save-content)
942 ;;; @ quitting method
945 (defvar mime-preview-quitting-method-alist
946 '((mime-show-message-mode
947 . mime-preview-quitting-method-for-mime-show-message-mode))
948 "Alist of major-mode vs. quitting-method of mime-view.")
950 (defvar mime-preview-over-to-previous-method-alist nil
951 "Alist of major-mode vs. over-to-previous-method of mime-view.")
953 (defvar mime-preview-over-to-next-method-alist nil
954 "Alist of major-mode vs. over-to-next-method of mime-view.")
957 ;;; @ following method
960 (defvar mime-preview-following-method-alist nil
961 "Alist of major-mode vs. following-method of mime-view.")
963 (defvar mime-view-following-required-fields-list
970 (defun mime-display-entity (entity &optional situation
971 default-situation preview-buffer)
973 (setq preview-buffer (current-buffer)))
974 (let* (e nb ne nhb nbb)
975 (mime-goto-header-start-point entity)
976 (in-calist-package 'mime-view)
979 (mime-find-entity-preview-situation entity default-situation)))
980 (let ((button-is-invisible
981 (eq (cdr (or (assq '*entity-button situation)
982 (assq 'entity-button situation)))
985 (eq (cdr (or (assq '*header situation)
986 (assq 'header situation)))
988 (header-presentation-method
989 (or (cdr (assq 'header-presentation-method situation))
990 (cdr (assq (cdr (assq 'major-mode situation))
991 mime-header-presentation-method-alist))))
992 (body-presentation-method
993 (cdr (assq 'body-presentation-method situation)))
994 (children (mime-entity-children entity)))
995 (set-buffer preview-buffer)
997 (narrow-to-region nb nb)
998 (or button-is-invisible
999 ;; (if (mime-view-entity-button-visible-p entity)
1000 (mime-view-insert-entity-button entity)
1003 (when header-is-visible
1005 (if header-presentation-method
1006 (funcall header-presentation-method entity situation)
1007 (mime-insert-header entity
1008 mime-view-ignored-field-list
1009 mime-view-visible-field-list))
1010 (run-hooks 'mime-display-header-hook)
1011 (put-text-property nhb (point-max) 'mime-view-entity-header entity)
1012 (goto-char (point-max))
1017 ((functionp body-presentation-method)
1018 (funcall body-presentation-method entity situation)
1021 (when button-is-invisible
1022 (goto-char (point-max))
1023 (mime-view-insert-entity-button entity)
1025 (or header-is-visible
1027 (goto-char (point-max))
1031 (setq ne (point-max))
1033 (put-text-property nb ne 'mime-view-entity entity)
1034 (put-text-property nb ne 'mime-view-situation situation)
1035 (put-text-property nbb ne 'mime-view-entity-body entity)
1038 (if (functionp body-presentation-method)
1039 (funcall body-presentation-method entity situation)
1040 (mime-display-multipart/mixed entity situation)
1045 ;;; @ MIME viewer mode
1048 (defconst mime-view-menu-title "MIME-View")
1049 (defconst mime-view-menu-list
1050 '((up "Move to upper entity" mime-preview-move-to-upper)
1051 (previous "Move to previous entity" mime-preview-move-to-previous)
1052 (next "Move to next entity" mime-preview-move-to-next)
1053 (scroll-down "Scroll-down" mime-preview-scroll-down-entity)
1054 (scroll-up "Scroll-up" mime-preview-scroll-up-entity)
1055 (play "Play current entity" mime-preview-play-current-entity)
1056 (extract "Extract current entity" mime-preview-extract-current-entity)
1057 (print "Print current entity" mime-preview-print-current-entity)
1059 "Menu for MIME Viewer")
1061 (cond ((featurep 'xemacs)
1062 (defvar mime-view-xemacs-popup-menu
1063 (cons mime-view-menu-title
1066 (vector (nth 1 item)(nth 2 item) t)
1068 mime-view-menu-list)))
1069 (defun mime-view-xemacs-popup-menu (event)
1070 "Popup the menu in the MIME Viewer buffer"
1072 (select-window (event-window event))
1073 (set-buffer (event-buffer event))
1074 (popup-menu 'mime-view-xemacs-popup-menu))
1075 (defvar mouse-button-2 'button2)
1078 (defvar mime-view-popup-menu
1079 (let ((menu (make-sparse-keymap mime-view-menu-title)))
1083 (list (intern (nth 1 item)) 'menu-item
1084 (nth 1 item)(nth 2 item))
1086 mime-view-menu-list))))
1087 (defun mime-view-popup-menu (event)
1088 "Popup the menu in the MIME Viewer buffer"
1090 (let ((menu mime-view-popup-menu) events func)
1091 (setq events (x-popup-menu t menu))
1093 (setq func (lookup-key menu (apply #'vector events)))
1096 (defvar mouse-button-2 [mouse-2])
1099 (defun mime-view-define-keymap (&optional default)
1100 (let ((mime-view-mode-map (if (keymapp default)
1101 (copy-keymap default)
1102 (make-sparse-keymap)
1104 (define-key mime-view-mode-map
1105 "u" (function mime-preview-move-to-upper))
1106 (define-key mime-view-mode-map
1107 "p" (function mime-preview-move-to-previous))
1108 (define-key mime-view-mode-map
1109 "n" (function mime-preview-move-to-next))
1110 (define-key mime-view-mode-map
1111 "\e\t" (function mime-preview-move-to-previous))
1112 (define-key mime-view-mode-map
1113 "\t" (function mime-preview-move-to-next))
1114 (define-key mime-view-mode-map
1115 " " (function mime-preview-scroll-up-entity))
1116 (define-key mime-view-mode-map
1117 "\M- " (function mime-preview-scroll-down-entity))
1118 (define-key mime-view-mode-map
1119 "\177" (function mime-preview-scroll-down-entity))
1120 (define-key mime-view-mode-map
1121 "\C-m" (function mime-preview-next-line-entity))
1122 (define-key mime-view-mode-map
1123 "\C-\M-m" (function mime-preview-previous-line-entity))
1124 (define-key mime-view-mode-map
1125 "v" (function mime-preview-play-current-entity))
1126 (define-key mime-view-mode-map
1127 "e" (function mime-preview-extract-current-entity))
1128 (define-key mime-view-mode-map
1129 "\C-c\C-p" (function mime-preview-print-current-entity))
1130 (define-key mime-view-mode-map
1131 "\C-c\C-t\C-h" (function mime-preview-toggle-header))
1132 (define-key mime-view-mode-map
1133 "a" (function mime-preview-follow-current-entity))
1134 (define-key mime-view-mode-map
1135 "q" (function mime-preview-quit))
1136 (define-key mime-view-mode-map
1137 "\C-c\C-x" (function mime-preview-kill-buffer))
1138 ;; (define-key mime-view-mode-map
1139 ;; "<" (function beginning-of-buffer))
1140 ;; (define-key mime-view-mode-map
1141 ;; ">" (function end-of-buffer))
1142 (define-key mime-view-mode-map
1143 "?" (function describe-mode))
1144 (define-key mime-view-mode-map
1145 [tab] (function mime-preview-move-to-next))
1146 (define-key mime-view-mode-map
1147 [delete] (function mime-preview-scroll-down-entity))
1148 (define-key mime-view-mode-map
1149 [backspace] (function mime-preview-scroll-down-entity))
1150 (if (functionp default)
1151 (cond ((featurep 'xemacs)
1152 (set-keymap-default-binding mime-view-mode-map default)
1155 (setq mime-view-mode-map
1156 (append mime-view-mode-map (list (cons t default))))
1159 (define-key mime-view-mode-map
1160 mouse-button-2 (function mime-button-dispatcher))
1162 (cond ((featurep 'xemacs)
1163 (define-key mime-view-mode-map
1164 mouse-button-3 (function mime-view-xemacs-popup-menu))
1166 ((>= emacs-major-version 19)
1167 (define-key mime-view-mode-map
1168 mouse-button-3 (function mime-view-popup-menu))
1169 (define-key mime-view-mode-map [menu-bar mime-view]
1170 (cons mime-view-menu-title
1171 (make-sparse-keymap mime-view-menu-title)))
1174 (define-key mime-view-mode-map
1175 (vector 'menu-bar 'mime-view (car item))
1176 (cons (nth 1 item)(nth 2 item))
1179 (reverse mime-view-menu-list)
1182 (use-local-map mime-view-mode-map)
1183 (run-hooks 'mime-view-define-keymap-hook)
1186 (defsubst mime-maybe-hide-echo-buffer ()
1187 "Clear mime-echo buffer and delete window for it."
1188 (let ((buf (get-buffer mime-echo-buffer-name)))
1193 (let ((win (get-buffer-window buf)))
1200 (defvar mime-view-redisplay nil)
1203 (defun mime-display-message (message &optional preview-buffer
1204 mother default-keymap-or-function
1205 original-major-mode)
1206 "View MESSAGE in MIME-View mode.
1208 Optional argument PREVIEW-BUFFER specifies the buffer of the
1209 presentation. It must be either nil or a name of preview buffer.
1211 Optional argument MOTHER specifies mother-buffer of the preview-buffer.
1213 Optional argument DEFAULT-KEYMAP-OR-FUNCTION is nil, keymap or
1214 function. If it is a keymap, keymap of MIME-View mode will be added
1215 to it. If it is a function, it will be bound as default binding of
1216 keymap of MIME-View mode."
1217 (mime-maybe-hide-echo-buffer)
1218 (let ((win-conf (current-window-configuration)))
1220 (setq preview-buffer
1221 (concat "*Preview-" (mime-entity-name message) "*")))
1222 (or original-major-mode
1223 (setq original-major-mode major-mode))
1224 (let ((inhibit-read-only t))
1225 (set-buffer (get-buffer-create preview-buffer))
1229 (setq mime-mother-buffer mother)
1231 (setq mime-preview-original-window-configuration win-conf)
1232 (setq major-mode 'mime-view-mode)
1233 (setq mode-name "MIME-View")
1234 (mime-display-entity message nil
1235 `((entity-button . invisible)
1237 (major-mode . ,original-major-mode))
1239 (mime-view-define-keymap default-keymap-or-function)
1241 (next-single-property-change (point-min) 'mime-view-entity)))
1244 (goto-char (point-min))
1245 (search-forward "\n\n" nil t)
1247 (run-hooks 'mime-view-mode-hook)
1248 (set-buffer-modified-p nil)
1249 (setq buffer-read-only t)
1253 (defun mime-view-buffer (&optional raw-buffer preview-buffer mother
1254 default-keymap-or-function
1255 representation-type)
1256 "View RAW-BUFFER in MIME-View mode.
1257 Optional argument PREVIEW-BUFFER is either nil or a name of preview
1259 Optional argument DEFAULT-KEYMAP-OR-FUNCTION is nil, keymap or
1260 function. If it is a keymap, keymap of MIME-View mode will be added
1261 to it. If it is a function, it will be bound as default binding of
1262 keymap of MIME-View mode.
1263 Optional argument REPRESENTATION-TYPE is representation-type of
1264 message. It must be nil, `binary' or `cooked'. If it is nil,
1265 `cooked' is used as default."
1268 (setq raw-buffer (current-buffer)))
1269 (or representation-type
1270 (setq representation-type
1272 (set-buffer raw-buffer)
1273 (cdr (or (assq major-mode mime-raw-representation-type-alist)
1274 (assq t mime-raw-representation-type-alist)))
1276 (if (eq representation-type 'binary)
1277 (setq representation-type 'buffer)
1279 (setq preview-buffer (mime-display-message
1280 (mime-open-entity representation-type raw-buffer)
1281 preview-buffer mother default-keymap-or-function))
1282 (or (get-buffer-window preview-buffer)
1283 (let ((r-win (get-buffer-window raw-buffer)))
1285 (set-window-buffer r-win preview-buffer)
1286 (let ((m-win (and mother (get-buffer-window mother))))
1288 (set-window-buffer m-win preview-buffer)
1289 (switch-to-buffer preview-buffer)
1292 (defun mime-view-mode (&optional mother ctl encoding
1293 raw-buffer preview-buffer
1294 default-keymap-or-function)
1295 "Major mode for viewing MIME message.
1297 Here is a list of the standard keys for mime-view-mode.
1302 u Move to upper content
1303 p or M-TAB Move to previous content
1304 n or TAB Move to next content
1305 SPC Scroll up or move to next content
1306 M-SPC or DEL Scroll down or move to previous content
1307 RET Move to next line
1308 M-RET Move to previous line
1309 v Decode current content as `play mode'
1310 e Decode current content as `extract mode'
1311 C-c C-p Decode current content as `print mode'
1312 a Followup to current content.
1314 button-2 Move to point under the mouse cursor
1315 and decode current content as `play mode'
1318 (unless mime-view-redisplay
1320 (if raw-buffer (set-buffer raw-buffer))
1323 (or (assq major-mode mime-raw-representation-type-alist)
1324 (assq t mime-raw-representation-type-alist)))))
1325 (if (eq type 'binary)
1328 (setq mime-message-structure (mime-open-entity type raw-buffer))
1329 (or (mime-entity-content-type mime-message-structure)
1330 (mime-entity-set-content-type-internal
1331 mime-message-structure ctl))
1333 (or (mime-entity-encoding mime-message-structure)
1334 (mime-entity-set-encoding-internal mime-message-structure encoding))
1336 (mime-display-message mime-message-structure preview-buffer
1337 mother default-keymap-or-function)
1344 (defun mime-preview-find-boundary-info (&optional get-mother)
1348 (while (null (setq entity
1349 (get-text-property (point) 'mime-view-entity)))
1351 (setq p-beg (previous-single-property-change (point) 'mime-view-entity))
1352 (setq entity-node-id (mime-entity-node-id entity))
1353 (setq len (length entity-node-id))
1356 (if (eq (next-single-property-change (point-min)
1362 ((eq (next-single-property-change p-beg 'mime-view-entity)
1364 (setq p-beg (point))
1366 (setq p-end (next-single-property-change p-beg 'mime-view-entity))
1368 (setq p-end (point-max))
1370 ((null entity-node-id)
1371 (setq p-end (point-max))
1379 (next-single-property-change
1380 (point) 'mime-view-entity))
1382 (let ((rc (mime-entity-node-id
1383 (get-text-property (1- (point))
1384 'mime-view-entity))))
1385 (or (and (>= (setq i (- (length rc) len)) 0)
1386 (equal entity-node-id (nthcdr i rc)))
1389 (setq p-end (point-max))))
1391 (vector p-beg p-end entity)))
1397 (autoload 'mime-preview-play-current-entity "mime-play"
1398 "Play current entity." t)
1400 (defun mime-preview-extract-current-entity (&optional ignore-examples)
1401 "Extract current entity into file (maybe).
1402 It decodes current entity to call internal or external method as
1403 \"extract\" mode. The method is selected from variable
1404 `mime-acting-condition'."
1406 (mime-preview-play-current-entity ignore-examples "extract")
1409 (defun mime-preview-print-current-entity (&optional ignore-examples)
1410 "Print current entity (maybe).
1411 It decodes current entity to call internal or external method as
1412 \"print\" mode. The method is selected from variable
1413 `mime-acting-condition'."
1415 (mime-preview-play-current-entity ignore-examples "print")
1422 (defun mime-preview-follow-current-entity ()
1423 "Write follow message to current entity.
1424 It calls following-method selected from variable
1425 `mime-preview-following-method-alist'."
1427 (let ((entity (mime-preview-find-boundary-info t))
1430 (setq p-beg (aref entity 0)
1431 p-end (aref entity 1)
1432 entity (aref entity 2))
1433 (if (get-text-property p-beg 'mime-view-entity-body)
1436 (next-single-property-change
1437 p-beg 'mime-view-entity-body nil
1438 (or (next-single-property-change p-beg 'mime-view-entity)
1440 (let* ((mode (mime-preview-original-major-mode 'recursive))
1441 (entity-node-id (mime-entity-node-id entity))
1443 (format "%s-%s" (buffer-name) (reverse entity-node-id)))
1445 (the-buf (current-buffer))
1448 (set-buffer (setq new-buf (get-buffer-create new-name)))
1451 (insert-buffer-substring the-buf pb-beg p-end)
1452 (goto-char (point-min))
1453 (let ((current-entity
1454 (if (and (eq (mime-entity-media-type entity) 'message)
1455 (eq (mime-entity-media-subtype entity) 'rfc822))
1456 (car (mime-entity-children entity))
1459 (while (and current-entity
1460 (if (and (eq (mime-entity-media-type
1461 current-entity) 'message)
1462 (eq (mime-entity-media-subtype
1463 current-entity) 'rfc822))
1465 (mime-insert-header current-entity fields)
1467 (setq fields (std11-collect-field-names)
1468 current-entity (mime-entity-parent current-entity))
1470 (let ((rest mime-view-following-required-fields-list)
1473 (setq field-name (car rest))
1474 (or (std11-field-body field-name)
1477 (set-buffer the-buf)
1478 (let ((entity (when mime-mother-buffer
1479 (set-buffer mime-mother-buffer)
1480 (get-text-property (point)
1481 'mime-view-entity))))
1483 (null (setq ret (mime-entity-fetch-field
1484 entity field-name))))
1485 (setq entity (mime-entity-parent entity)))))
1487 (insert (concat field-name ": " ret "\n"))
1489 (setq rest (cdr rest))
1492 (let ((f (cdr (assq mode mime-preview-following-method-alist))))
1497 "Sorry, following method for %s is not implemented yet."
1506 (defun mime-preview-move-to-upper ()
1507 "Move to upper entity.
1508 If there is no upper entity, call function `mime-preview-quit'."
1511 (while (null (setq cinfo
1512 (get-text-property (point) 'mime-view-entity)))
1515 (let ((r (mime-entity-parent cinfo))
1518 (while (setq point (previous-single-property-change
1519 (point) 'mime-view-entity))
1521 (when (eq r (get-text-property (point) 'mime-view-entity))
1522 (if (or (eq mime-preview-move-scroll t)
1523 (and mime-preview-move-scroll
1526 (move-to-window-line -1)
1527 (forward-line (* -1 next-screen-context-lines))
1530 (recenter next-screen-context-lines))
1537 (defun mime-preview-move-to-previous ()
1538 "Move to previous entity.
1539 If there is no previous entity, it calls function registered in
1540 variable `mime-preview-over-to-previous-method-alist'."
1542 (while (and (not (bobp))
1543 (null (get-text-property (point) 'mime-view-entity)))
1546 (let ((point (previous-single-property-change (point) 'mime-view-entity)))
1548 (>= point (point-min)))
1549 (if (get-text-property (1- point) 'mime-view-entity)
1550 (progn (goto-char point)
1552 (or (eq mime-preview-move-scroll t)
1553 (and mime-preview-move-scroll
1556 (move-to-window-line 0)
1557 (forward-line next-screen-context-lines)
1560 (recenter (* -1 next-screen-context-lines))))
1561 (goto-char (1- point))
1562 (mime-preview-move-to-previous)
1564 (let ((f (assq (mime-preview-original-major-mode)
1565 mime-preview-over-to-previous-method-alist)))
1571 (defun mime-preview-move-to-next ()
1572 "Move to next entity.
1573 If there is no previous entity, it calls function registered in
1574 variable `mime-preview-over-to-next-method-alist'."
1576 (while (and (not (eobp))
1577 (null (get-text-property (point) 'mime-view-entity)))
1580 (let ((point (next-single-property-change (point) 'mime-view-entity)))
1582 (<= point (point-max)))
1585 (if (null (get-text-property point 'mime-view-entity))
1586 (mime-preview-move-to-next)
1588 (or (eq mime-preview-move-scroll t)
1589 (and mime-preview-move-scroll
1592 (move-to-window-line -1)
1594 (* -1 next-screen-context-lines))
1597 (recenter next-screen-context-lines))
1599 (let ((f (assq (mime-preview-original-major-mode)
1600 mime-preview-over-to-next-method-alist)))
1606 (defun mime-preview-scroll-up-entity (&optional h)
1607 "Scroll up current entity.
1608 If reached to (point-max), it calls function registered in variable
1609 `mime-preview-over-to-next-method-alist'."
1612 (let ((f (assq (mime-preview-original-major-mode)
1613 mime-preview-over-to-next-method-alist)))
1618 (or (next-single-property-change (point) 'mime-view-entity)
1620 (bottom (window-end (selected-window))))
1623 (progn (goto-char point)
1624 (recenter next-screen-context-lines))
1628 (goto-char (point-max)))))
1631 (defun mime-preview-scroll-down-entity (&optional h)
1632 "Scroll down current entity.
1633 If reached to (point-min), it calls function registered in variable
1634 `mime-preview-over-to-previous-method-alist'."
1637 (let ((f (assq (mime-preview-original-major-mode)
1638 mime-preview-over-to-previous-method-alist)))
1643 (or (previous-single-property-change (point) 'mime-view-entity)
1645 (top (window-start (selected-window))))
1648 (progn (goto-char point)
1649 (recenter (* -1 next-screen-context-lines)))
1652 (beginning-of-buffer
1653 (goto-char (point-min)))))
1656 (defun mime-preview-next-line-entity (&optional lines)
1657 "Scroll up one line (or prefix LINES lines).
1658 If LINES is negative, scroll down LINES lines."
1660 (mime-preview-scroll-up-entity (or lines 1))
1663 (defun mime-preview-previous-line-entity (&optional lines)
1664 "Scrroll down one line (or prefix LINES lines).
1665 If LINES is negative, scroll up LINES lines."
1667 (mime-preview-scroll-down-entity (or lines 1))
1674 (defun mime-preview-toggle-header ()
1676 (let ((situation (mime-preview-find-boundary-info))
1678 (setq p-beg (aref situation 0)
1679 p-end (aref situation 1)
1680 entity (aref situation 2)
1681 situation (get-text-property p-beg 'mime-view-situation))
1682 (let ((cell (assq '*header situation)))
1684 (setq cell (assq 'header situation)))
1685 (if (eq (cdr cell) 'visible)
1686 (setq situation (put-alist '*header 'invisible situation))
1687 (setq situation (put-alist '*header 'visible situation))))
1689 (let ((inhibit-read-only t))
1690 (delete-region p-beg p-end)
1691 (mime-display-entity entity situation)))
1692 ;; (ctree-set-calist-strictly 'mime-preview-condition situation)
1693 (let ((ret (assoc situation mime-preview-situation-example-list)))
1695 (setcdr ret (1+ (cdr ret)))
1696 (add-to-list 'mime-preview-situation-example-list
1697 (cons situation 0))))))
1703 (defun mime-preview-quit ()
1704 "Quit from MIME-preview buffer.
1705 It calls function registered in variable
1706 `mime-preview-quitting-method-alist'."
1708 (let ((r (assq (mime-preview-original-major-mode)
1709 mime-preview-quitting-method-alist)))
1714 (defun mime-preview-kill-buffer ()
1716 (kill-buffer (current-buffer))
1723 (provide 'mime-view)
1725 (let* ((file mime-situation-examples-file)
1726 (buffer (get-buffer-create " *mime-example*")))
1727 (if (file-readable-p file)
1732 (insert-file-contents file)
1737 (while (and (> (length mime-preview-situation-example-list)
1738 mime-preview-situation-example-list-max-size)
1740 (setq mime-preview-situation-example-list
1741 (mime-reduce-situation-examples
1742 mime-preview-situation-example-list))
1745 (error (setq mime-preview-situation-example-list nil)))
1746 ;; (let ((rest mime-preview-situation-example-list))
1748 ;; (ctree-set-calist-strictly 'mime-preview-condition
1750 ;; (setq rest (cdr rest))))
1753 (while (and (> (length mime-acting-situation-example-list)
1754 mime-acting-situation-example-list-max-size)
1756 (setq mime-acting-situation-example-list
1757 (mime-reduce-situation-examples
1758 mime-acting-situation-example-list))
1761 (error (setq mime-acting-situation-example-list nil)))
1763 (kill-buffer buffer))))
1765 ;;; mime-view.el ends here