1 ;;; mime-view.el --- interactive MIME viewer for GNU Emacs
3 ;; Copyright (C) 1995,96,97,98,99,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
690 '((type . multipart)(subtype . t)
692 (body-presentation-method . mime-display-multipart/mixed)))
694 (ctree-set-calist-strictly
695 'mime-preview-condition
696 '((type . message)(subtype . partial)
698 (body-presentation-method . mime-display-message/partial-button)))
700 (ctree-set-calist-strictly
701 'mime-preview-condition
702 '((type . message)(subtype . rfc822)
704 (body-presentation-method . mime-display-multipart/mixed)
705 (childrens-situation (header . visible)
706 (entity-button . invisible))))
708 (ctree-set-calist-strictly
709 'mime-preview-condition
710 '((type . message)(subtype . news)
712 (body-presentation-method . mime-display-multipart/mixed)
713 (childrens-situation (header . visible)
714 (entity-button . invisible))))
717 ;;; @@@ entity presentation
720 (defun mime-display-text/plain (entity situation)
722 (narrow-to-region (point-max)(point-max))
723 (mime-insert-text-content entity)
724 (run-hooks 'mime-text-decode-hook)
725 (goto-char (point-max))
726 (if (not (eq (char-after (1- (point))) ?\n))
729 (mime-add-url-buttons)
730 (run-hooks 'mime-display-text/plain-hook)
733 (defun mime-display-text/richtext (entity situation)
735 (narrow-to-region (point-max)(point-max))
736 (mime-insert-text-content entity)
737 (run-hooks 'mime-text-decode-hook)
738 (let ((beg (point-min)))
739 (remove-text-properties beg (point-max) '(face nil))
740 (richtext-decode beg (point-max))
743 (defun mime-display-text/enriched (entity situation)
745 (narrow-to-region (point-max)(point-max))
746 (mime-insert-text-content entity)
747 (run-hooks 'mime-text-decode-hook)
748 (let ((beg (point-min)))
749 (remove-text-properties beg (point-max) '(face nil))
750 (enriched-decode beg (point-max))
754 (defvar mime-view-announcement-for-message/partial
755 (if (and (>= emacs-major-version 19) window-system)
757 \[[ This is message/partial style split message. ]]
758 \[[ Please press `v' key in this buffer ]]
759 \[[ or click here by mouse button-2. ]]"
761 \[[ This is message/partial style split message. ]]
762 \[[ Please press `v' key in this buffer. ]]"
765 (defun mime-display-message/partial-button (&optional entity situation)
767 (goto-char (point-max))
768 (if (not (search-backward "\n\n" nil t))
771 (goto-char (point-max))
772 (narrow-to-region (point-max)(point-max))
773 (insert mime-view-announcement-for-message/partial)
774 (mime-add-button (point-min)(point-max)
775 #'mime-preview-play-current-entity)
778 (defun mime-display-multipart/mixed (entity situation)
779 (let ((children (mime-entity-children entity))
780 (original-major-mode-cell (assq 'major-mode situation))
782 (cdr (assq 'childrens-situation situation))))
783 (if original-major-mode-cell
784 (setq default-situation
785 (cons original-major-mode-cell default-situation)))
787 (mime-display-entity (car children) nil default-situation)
788 (setq children (cdr children))
791 (defcustom mime-view-type-subtype-score-alist
792 '(((text . enriched) . 3)
793 ((text . richtext) . 2)
796 "Alist MEDIA-TYPE vs corresponding score.
797 MEDIA-TYPE must be (TYPE . SUBTYPE), TYPE or t. t means default."
799 :type '(repeat (cons (choice :tag "Media-Type"
800 (cons :tag "Type/Subtype"
801 (symbol :tag "Primary-type")
802 (symbol :tag "Subtype"))
804 (const :tag "Default" t))
807 (defun mime-display-multipart/alternative (entity situation)
808 (let* ((children (mime-entity-children entity))
809 (original-major-mode-cell (assq 'major-mode situation))
811 (cdr (assq 'childrens-situation situation)))
816 (if original-major-mode-cell
817 (setq default-situation
818 (cons original-major-mode-cell default-situation)))
823 (mime-find-entity-preview-situation
824 child default-situation)))
825 (if (cdr (assq 'body-presentation-method situation))
830 (cdr (assq 'type situation))
831 (cdr (assq 'subtype situation)))
832 mime-view-type-subtype-score-alist)
834 (cdr (assq 'type situation))
835 mime-view-type-subtype-score-alist)
838 mime-view-type-subtype-score-alist)
840 (if (> score max-score)
850 (let ((child (car children))
851 (situation (car situations)))
852 (mime-display-entity child (if (= i p)
854 (del-alist 'body-presentation-method
855 (copy-alist situation))))
857 (setq children (cdr children)
858 situations (cdr situations)
863 ;;; @ acting-condition
866 (defvar mime-acting-condition nil
867 "Condition-tree about how to process entity.")
869 (if (file-readable-p mailcap-file)
870 (let ((entries (mailcap-parse-file)))
872 (let ((entry (car entries))
875 (let* ((field (car entry))
876 (field-type (car field)))
877 (cond ((eq field-type 'view) (setq view field))
878 ((eq field-type 'print) (setq print field))
879 ((memq field-type '(compose composetyped edit)))
880 (t (setq shared (cons field shared))))
882 (setq entry (cdr entry))
884 (setq shared (nreverse shared))
885 (ctree-set-calist-with-default
886 'mime-acting-condition
887 (append shared (list '(mode . "play")(cons 'method (cdr view)))))
889 (ctree-set-calist-with-default
890 'mime-acting-condition
892 (list '(mode . "print")(cons 'method (cdr view))))
895 (setq entries (cdr entries))
898 (ctree-set-calist-strictly
899 'mime-acting-condition
900 '((type . application)(subtype . octet-stream)
902 (method . mime-detect-content)
905 (ctree-set-calist-with-default
906 'mime-acting-condition
908 (method . mime-save-content)))
910 (ctree-set-calist-strictly
911 'mime-acting-condition
912 '((type . text)(subtype . x-rot13-47)(mode . "play")
913 (method . mime-view-caesar)
915 (ctree-set-calist-strictly
916 'mime-acting-condition
917 '((type . text)(subtype . x-rot13-47-48)(mode . "play")
918 (method . mime-view-caesar)
921 (ctree-set-calist-strictly
922 'mime-acting-condition
923 '((type . message)(subtype . rfc822)(mode . "play")
924 (method . mime-view-message/rfc822)
926 (ctree-set-calist-strictly
927 'mime-acting-condition
928 '((type . message)(subtype . partial)(mode . "play")
929 (method . mime-store-message/partial-piece)
932 (ctree-set-calist-strictly
933 'mime-acting-condition
934 '((type . message)(subtype . external-body)
935 ("access-type" . "anon-ftp")
936 (method . mime-view-message/external-anon-ftp)
939 (ctree-set-calist-strictly
940 'mime-acting-condition
941 '((type . message)(subtype . external-body)
942 ("access-type" . "url")
943 (method . mime-view-message/external-url)
946 (ctree-set-calist-strictly
947 'mime-acting-condition
948 '((type . application)(subtype . octet-stream)
949 (method . mime-save-content)
953 ;;; @ quitting method
956 (defvar mime-preview-quitting-method-alist
957 '((mime-show-message-mode
958 . mime-preview-quitting-method-for-mime-show-message-mode))
959 "Alist of major-mode vs. quitting-method of mime-view.")
961 (defvar mime-preview-over-to-previous-method-alist nil
962 "Alist of major-mode vs. over-to-previous-method of mime-view.")
964 (defvar mime-preview-over-to-next-method-alist nil
965 "Alist of major-mode vs. over-to-next-method of mime-view.")
968 ;;; @ following method
971 (defvar mime-preview-following-method-alist nil
972 "Alist of major-mode vs. following-method of mime-view.")
974 (defvar mime-view-following-required-fields-list
981 (defun mime-display-entity (entity &optional situation
982 default-situation preview-buffer)
984 (setq preview-buffer (current-buffer)))
985 (let* (e nb ne nhb nbb)
986 (in-calist-package 'mime-view)
989 (mime-find-entity-preview-situation entity default-situation)))
990 (let ((button-is-invisible
991 (eq (cdr (or (assq '*entity-button situation)
992 (assq 'entity-button situation)))
995 (eq (cdr (or (assq '*header situation)
996 (assq 'header situation)))
999 (eq (cdr (or (assq '*body situation)
1000 (assq 'body situation)))
1002 (children (mime-entity-children entity)))
1003 (set-buffer preview-buffer)
1005 (narrow-to-region nb nb)
1006 (or button-is-invisible
1007 ;; (if (mime-view-entity-button-visible-p entity)
1008 (mime-view-insert-entity-button entity)
1011 (if header-is-visible
1012 (let ((header-presentation-method
1013 (or (cdr (assq 'header-presentation-method situation))
1014 (cdr (assq (cdr (assq 'major-mode situation))
1015 mime-header-presentation-method-alist)))))
1017 (if header-presentation-method
1018 (funcall header-presentation-method entity situation)
1019 (mime-insert-header entity
1020 mime-view-ignored-field-list
1021 mime-view-visible-field-list))
1022 (run-hooks 'mime-display-header-hook)
1023 (put-text-property nhb (point-max) 'mime-view-entity-header entity)
1024 (goto-char (point-max))
1029 (let ((body-presentation-method
1030 (cdr (assq 'body-presentation-method situation))))
1031 (if (functionp body-presentation-method)
1032 (funcall body-presentation-method entity situation)
1033 (mime-display-text/plain entity situation)))
1034 (when button-is-invisible
1035 (goto-char (point-max))
1036 (mime-view-insert-entity-button entity)
1038 (unless header-is-visible
1039 (goto-char (point-max))
1042 (setq ne (point-max))
1044 (put-text-property nb ne 'mime-view-entity entity)
1045 (put-text-property nb ne 'mime-view-situation situation)
1046 (put-text-property nbb ne 'mime-view-entity-body entity)
1048 (if (and children body-is-visible)
1049 (let ((body-presentation-method
1050 (cdr (assq 'body-presentation-method situation))))
1051 (if (functionp body-presentation-method)
1052 (funcall body-presentation-method entity situation)
1053 (mime-display-multipart/mixed entity situation))))
1057 ;;; @ MIME viewer mode
1060 (defconst mime-view-menu-title "MIME-View")
1061 (defconst mime-view-menu-list
1062 '((up "Move to upper entity" mime-preview-move-to-upper)
1063 (previous "Move to previous entity" mime-preview-move-to-previous)
1064 (next "Move to next entity" mime-preview-move-to-next)
1065 (scroll-down "Scroll-down" mime-preview-scroll-down-entity)
1066 (scroll-up "Scroll-up" mime-preview-scroll-up-entity)
1067 (play "Play current entity" mime-preview-play-current-entity)
1068 (extract "Extract current entity" mime-preview-extract-current-entity)
1069 (print "Print current entity" mime-preview-print-current-entity)
1071 "Menu for MIME Viewer")
1073 (cond ((featurep 'xemacs)
1074 (defvar mime-view-xemacs-popup-menu
1075 (cons mime-view-menu-title
1078 (vector (nth 1 item)(nth 2 item) t)
1080 mime-view-menu-list)))
1081 (defun mime-view-xemacs-popup-menu (event)
1082 "Popup the menu in the MIME Viewer buffer"
1084 (select-window (event-window event))
1085 (set-buffer (event-buffer event))
1086 (popup-menu 'mime-view-xemacs-popup-menu))
1087 (defvar mouse-button-2 'button2)
1090 (defvar mime-view-popup-menu
1091 (let ((menu (make-sparse-keymap mime-view-menu-title)))
1095 (list (intern (nth 1 item)) 'menu-item
1096 (nth 1 item)(nth 2 item))
1098 mime-view-menu-list))))
1099 (defun mime-view-popup-menu (event)
1100 "Popup the menu in the MIME Viewer buffer"
1102 (let ((menu mime-view-popup-menu) events func)
1103 (setq events (x-popup-menu t menu))
1105 (setq func (lookup-key menu (apply #'vector events)))
1108 (defvar mouse-button-2 [mouse-2])
1111 (defun mime-view-define-keymap (&optional default)
1112 (let ((mime-view-mode-map (if (keymapp default)
1113 (copy-keymap default)
1114 (make-sparse-keymap)
1116 (define-key mime-view-mode-map
1117 "u" (function mime-preview-move-to-upper))
1118 (define-key mime-view-mode-map
1119 "p" (function mime-preview-move-to-previous))
1120 (define-key mime-view-mode-map
1121 "n" (function mime-preview-move-to-next))
1122 (define-key mime-view-mode-map
1123 "\e\t" (function mime-preview-move-to-previous))
1124 (define-key mime-view-mode-map
1125 "\t" (function mime-preview-move-to-next))
1126 (define-key mime-view-mode-map
1127 " " (function mime-preview-scroll-up-entity))
1128 (define-key mime-view-mode-map
1129 "\M- " (function mime-preview-scroll-down-entity))
1130 (define-key mime-view-mode-map
1131 "\177" (function mime-preview-scroll-down-entity))
1132 (define-key mime-view-mode-map
1133 "\C-m" (function mime-preview-next-line-entity))
1134 (define-key mime-view-mode-map
1135 "\C-\M-m" (function mime-preview-previous-line-entity))
1136 (define-key mime-view-mode-map
1137 "v" (function mime-preview-play-current-entity))
1138 (define-key mime-view-mode-map
1139 "e" (function mime-preview-extract-current-entity))
1140 (define-key mime-view-mode-map
1141 "\C-c\C-p" (function mime-preview-print-current-entity))
1142 (define-key mime-view-mode-map
1143 "\C-c\C-t\C-h" (function mime-preview-toggle-header))
1144 (define-key mime-view-mode-map
1145 "\C-c\C-t\C-b" (function mime-preview-toggle-body))
1146 (define-key mime-view-mode-map
1147 "a" (function mime-preview-follow-current-entity))
1148 (define-key mime-view-mode-map
1149 "q" (function mime-preview-quit))
1150 (define-key mime-view-mode-map
1151 "\C-c\C-x" (function mime-preview-kill-buffer))
1152 ;; (define-key mime-view-mode-map
1153 ;; "<" (function beginning-of-buffer))
1154 ;; (define-key mime-view-mode-map
1155 ;; ">" (function end-of-buffer))
1156 (define-key mime-view-mode-map
1157 "?" (function describe-mode))
1158 (define-key mime-view-mode-map
1159 [tab] (function mime-preview-move-to-next))
1160 (define-key mime-view-mode-map
1161 [delete] (function mime-preview-scroll-down-entity))
1162 (define-key mime-view-mode-map
1163 [backspace] (function mime-preview-scroll-down-entity))
1164 (if (functionp default)
1165 (cond ((featurep 'xemacs)
1166 (set-keymap-default-binding mime-view-mode-map default)
1169 (setq mime-view-mode-map
1170 (append mime-view-mode-map (list (cons t default))))
1173 (define-key mime-view-mode-map
1174 mouse-button-2 (function mime-button-dispatcher))
1176 (cond ((featurep 'xemacs)
1177 (define-key mime-view-mode-map
1178 mouse-button-3 (function mime-view-xemacs-popup-menu))
1180 ((>= emacs-major-version 19)
1181 (define-key mime-view-mode-map
1182 mouse-button-3 (function mime-view-popup-menu))
1183 (define-key mime-view-mode-map [menu-bar mime-view]
1184 (cons mime-view-menu-title
1185 (make-sparse-keymap mime-view-menu-title)))
1188 (define-key mime-view-mode-map
1189 (vector 'menu-bar 'mime-view (car item))
1190 (cons (nth 1 item)(nth 2 item))
1193 (reverse mime-view-menu-list)
1196 (use-local-map mime-view-mode-map)
1197 (run-hooks 'mime-view-define-keymap-hook)
1200 (defsubst mime-maybe-hide-echo-buffer ()
1201 "Clear mime-echo buffer and delete window for it."
1202 (let ((buf (get-buffer mime-echo-buffer-name)))
1207 (let ((win (get-buffer-window buf)))
1214 (defvar mime-view-redisplay nil)
1217 (defun mime-display-message (message &optional preview-buffer
1218 mother default-keymap-or-function
1219 original-major-mode)
1220 "View MESSAGE in MIME-View mode.
1222 Optional argument PREVIEW-BUFFER specifies the buffer of the
1223 presentation. It must be either nil or a name of preview buffer.
1225 Optional argument MOTHER specifies mother-buffer of the preview-buffer.
1227 Optional argument DEFAULT-KEYMAP-OR-FUNCTION is nil, keymap or
1228 function. If it is a keymap, keymap of MIME-View mode will be added
1229 to it. If it is a function, it will be bound as default binding of
1230 keymap of MIME-View mode."
1231 (mime-maybe-hide-echo-buffer)
1232 (let ((win-conf (current-window-configuration)))
1234 (setq preview-buffer
1235 (concat "*Preview-" (mime-entity-name message) "*")))
1236 (or original-major-mode
1237 (setq original-major-mode major-mode))
1238 (let ((inhibit-read-only t))
1239 (set-buffer (get-buffer-create preview-buffer))
1243 (setq mime-mother-buffer mother)
1245 (setq mime-preview-original-window-configuration win-conf)
1246 (setq major-mode 'mime-view-mode)
1247 (setq mode-name "MIME-View")
1248 (mime-display-entity message nil
1249 `((entity-button . invisible)
1251 (major-mode . ,original-major-mode))
1253 (mime-view-define-keymap default-keymap-or-function)
1255 (next-single-property-change (point-min) 'mime-view-entity)))
1258 (goto-char (point-min))
1259 (search-forward "\n\n" nil t)
1261 (run-hooks 'mime-view-mode-hook)
1262 (set-buffer-modified-p nil)
1263 (setq buffer-read-only t)
1267 (defun mime-view-buffer (&optional raw-buffer preview-buffer mother
1268 default-keymap-or-function
1269 representation-type)
1270 "View RAW-BUFFER in MIME-View mode.
1271 Optional argument PREVIEW-BUFFER is either nil or a name of preview
1273 Optional argument DEFAULT-KEYMAP-OR-FUNCTION is nil, keymap or
1274 function. If it is a keymap, keymap of MIME-View mode will be added
1275 to it. If it is a function, it will be bound as default binding of
1276 keymap of MIME-View mode.
1277 Optional argument REPRESENTATION-TYPE is representation-type of
1278 message. It must be nil, `binary' or `cooked'. If it is nil,
1279 `cooked' is used as default."
1282 (setq raw-buffer (current-buffer)))
1283 (or representation-type
1284 (setq representation-type
1286 (set-buffer raw-buffer)
1287 (cdr (or (assq major-mode mime-raw-representation-type-alist)
1288 (assq t mime-raw-representation-type-alist)))
1290 (if (eq representation-type 'binary)
1291 (setq representation-type 'buffer)
1293 (setq preview-buffer (mime-display-message
1294 (mime-open-entity representation-type raw-buffer)
1295 preview-buffer mother default-keymap-or-function))
1296 (or (get-buffer-window preview-buffer)
1297 (let ((r-win (get-buffer-window raw-buffer)))
1299 (set-window-buffer r-win preview-buffer)
1300 (let ((m-win (and mother (get-buffer-window mother))))
1302 (set-window-buffer m-win preview-buffer)
1303 (switch-to-buffer preview-buffer)
1306 (defun mime-view-mode (&optional mother ctl encoding
1307 raw-buffer preview-buffer
1308 default-keymap-or-function)
1309 "Major mode for viewing MIME message.
1311 Here is a list of the standard keys for mime-view-mode.
1316 u Move to upper content
1317 p or M-TAB Move to previous content
1318 n or TAB Move to next content
1319 SPC Scroll up or move to next content
1320 M-SPC or DEL Scroll down or move to previous content
1321 RET Move to next line
1322 M-RET Move to previous line
1323 v Decode current content as `play mode'
1324 e Decode current content as `extract mode'
1325 C-c C-p Decode current content as `print mode'
1326 a Followup to current content.
1328 button-2 Move to point under the mouse cursor
1329 and decode current content as `play mode'
1332 (unless mime-view-redisplay
1334 (if raw-buffer (set-buffer raw-buffer))
1337 (or (assq major-mode mime-raw-representation-type-alist)
1338 (assq t mime-raw-representation-type-alist)))))
1339 (if (eq type 'binary)
1342 (setq mime-message-structure (mime-open-entity type raw-buffer))
1343 (or (mime-entity-content-type mime-message-structure)
1344 (mime-entity-set-content-type-internal
1345 mime-message-structure ctl))
1347 (or (mime-entity-encoding mime-message-structure)
1348 (mime-entity-set-encoding-internal mime-message-structure encoding))
1350 (mime-display-message mime-message-structure preview-buffer
1351 mother default-keymap-or-function)
1358 (defun mime-preview-find-boundary-info (&optional get-mother)
1362 (while (null (setq entity
1363 (get-text-property (point) 'mime-view-entity)))
1365 (setq p-beg (previous-single-property-change (point) 'mime-view-entity))
1366 (setq entity-node-id (mime-entity-node-id entity))
1367 (setq len (length entity-node-id))
1370 (if (eq (next-single-property-change (point-min)
1376 ((eq (next-single-property-change p-beg 'mime-view-entity)
1378 (setq p-beg (point))
1380 (setq p-end (next-single-property-change p-beg 'mime-view-entity))
1382 (setq p-end (point-max))
1384 ((null entity-node-id)
1385 (setq p-end (point-max))
1393 (next-single-property-change
1394 (point) 'mime-view-entity))
1396 (let ((rc (mime-entity-node-id
1397 (get-text-property (1- (point))
1398 'mime-view-entity))))
1399 (or (and (>= (setq i (- (length rc) len)) 0)
1400 (equal entity-node-id (nthcdr i rc)))
1403 (setq p-end (point-max))))
1405 (vector p-beg p-end entity)))
1411 (autoload 'mime-preview-play-current-entity "mime-play"
1412 "Play current entity." t)
1414 (defun mime-preview-extract-current-entity (&optional ignore-examples)
1415 "Extract current entity into file (maybe).
1416 It decodes current entity to call internal or external method as
1417 \"extract\" mode. The method is selected from variable
1418 `mime-acting-condition'."
1420 (mime-preview-play-current-entity ignore-examples "extract")
1423 (defun mime-preview-print-current-entity (&optional ignore-examples)
1424 "Print current entity (maybe).
1425 It decodes current entity to call internal or external method as
1426 \"print\" mode. The method is selected from variable
1427 `mime-acting-condition'."
1429 (mime-preview-play-current-entity ignore-examples "print")
1436 (defun mime-preview-follow-current-entity ()
1437 "Write follow message to current entity.
1438 It calls following-method selected from variable
1439 `mime-preview-following-method-alist'."
1441 (let ((entity (mime-preview-find-boundary-info t))
1444 (setq p-beg (aref entity 0)
1445 p-end (aref entity 1)
1446 entity (aref entity 2))
1447 (if (get-text-property p-beg 'mime-view-entity-body)
1450 (next-single-property-change
1451 p-beg 'mime-view-entity-body nil
1452 (or (next-single-property-change p-beg 'mime-view-entity)
1454 (let* ((mode (mime-preview-original-major-mode 'recursive))
1455 (entity-node-id (mime-entity-node-id entity))
1457 (format "%s-%s" (buffer-name) (reverse entity-node-id)))
1459 (the-buf (current-buffer))
1462 (set-buffer (setq new-buf (get-buffer-create new-name)))
1465 (insert-buffer-substring the-buf pb-beg p-end)
1466 (goto-char (point-min))
1467 (let ((current-entity
1468 (if (and (eq (mime-entity-media-type entity) 'message)
1469 (eq (mime-entity-media-subtype entity) 'rfc822))
1470 (car (mime-entity-children entity))
1473 (while (and current-entity
1474 (if (and (eq (mime-entity-media-type
1475 current-entity) 'message)
1476 (eq (mime-entity-media-subtype
1477 current-entity) 'rfc822))
1479 (mime-insert-header current-entity fields)
1481 (setq fields (std11-collect-field-names)
1482 current-entity (mime-entity-parent current-entity))
1484 (let ((rest mime-view-following-required-fields-list)
1487 (setq field-name (car rest))
1488 (or (std11-field-body field-name)
1491 (set-buffer the-buf)
1492 (let ((entity (when mime-mother-buffer
1493 (set-buffer mime-mother-buffer)
1494 (get-text-property (point)
1495 'mime-view-entity))))
1497 (null (setq ret (mime-entity-fetch-field
1498 entity field-name))))
1499 (setq entity (mime-entity-parent entity)))))
1501 (insert (concat field-name ": " ret "\n"))
1503 (setq rest (cdr rest))
1506 (let ((f (cdr (assq mode mime-preview-following-method-alist))))
1511 "Sorry, following method for %s is not implemented yet."
1520 (defun mime-preview-move-to-upper ()
1521 "Move to upper entity.
1522 If there is no upper entity, call function `mime-preview-quit'."
1525 (while (null (setq cinfo
1526 (get-text-property (point) 'mime-view-entity)))
1529 (let ((r (mime-entity-parent cinfo))
1532 (while (setq point (previous-single-property-change
1533 (point) 'mime-view-entity))
1535 (when (eq r (get-text-property (point) 'mime-view-entity))
1536 (if (or (eq mime-preview-move-scroll t)
1537 (and mime-preview-move-scroll
1540 (move-to-window-line -1)
1541 (forward-line (* -1 next-screen-context-lines))
1544 (recenter next-screen-context-lines))
1551 (defun mime-preview-move-to-previous ()
1552 "Move to previous entity.
1553 If there is no previous entity, it calls function registered in
1554 variable `mime-preview-over-to-previous-method-alist'."
1556 (while (and (not (bobp))
1557 (null (get-text-property (point) 'mime-view-entity)))
1560 (let ((point (previous-single-property-change (point) 'mime-view-entity)))
1562 (>= point (point-min)))
1563 (if (get-text-property (1- point) 'mime-view-entity)
1564 (progn (goto-char point)
1566 (or (eq mime-preview-move-scroll t)
1567 (and mime-preview-move-scroll
1570 (move-to-window-line 0)
1571 (forward-line next-screen-context-lines)
1574 (recenter (* -1 next-screen-context-lines))))
1575 (goto-char (1- point))
1576 (mime-preview-move-to-previous)
1578 (let ((f (assq (mime-preview-original-major-mode)
1579 mime-preview-over-to-previous-method-alist)))
1585 (defun mime-preview-move-to-next ()
1586 "Move to next entity.
1587 If there is no previous entity, it calls function registered in
1588 variable `mime-preview-over-to-next-method-alist'."
1590 (while (and (not (eobp))
1591 (null (get-text-property (point) 'mime-view-entity)))
1594 (let ((point (next-single-property-change (point) 'mime-view-entity)))
1596 (<= point (point-max)))
1599 (if (null (get-text-property point 'mime-view-entity))
1600 (mime-preview-move-to-next)
1602 (or (eq mime-preview-move-scroll t)
1603 (and mime-preview-move-scroll
1606 (move-to-window-line -1)
1608 (* -1 next-screen-context-lines))
1611 (recenter next-screen-context-lines))
1613 (let ((f (assq (mime-preview-original-major-mode)
1614 mime-preview-over-to-next-method-alist)))
1620 (defun mime-preview-scroll-up-entity (&optional h)
1621 "Scroll up current entity.
1622 If reached to (point-max), it calls function registered in variable
1623 `mime-preview-over-to-next-method-alist'."
1626 (let ((f (assq (mime-preview-original-major-mode)
1627 mime-preview-over-to-next-method-alist)))
1632 (or (next-single-property-change (point) 'mime-view-entity)
1634 (bottom (window-end (selected-window))))
1637 (progn (goto-char point)
1638 (recenter next-screen-context-lines))
1642 (goto-char (point-max)))))
1645 (defun mime-preview-scroll-down-entity (&optional h)
1646 "Scroll down current entity.
1647 If reached to (point-min), it calls function registered in variable
1648 `mime-preview-over-to-previous-method-alist'."
1651 (let ((f (assq (mime-preview-original-major-mode)
1652 mime-preview-over-to-previous-method-alist)))
1657 (or (previous-single-property-change (point) 'mime-view-entity)
1659 (top (window-start (selected-window))))
1662 (progn (goto-char point)
1663 (recenter (* -1 next-screen-context-lines)))
1666 (beginning-of-buffer
1667 (goto-char (point-min)))))
1670 (defun mime-preview-next-line-entity (&optional lines)
1671 "Scroll up one line (or prefix LINES lines).
1672 If LINES is negative, scroll down LINES lines."
1674 (mime-preview-scroll-up-entity (or lines 1))
1677 (defun mime-preview-previous-line-entity (&optional lines)
1678 "Scrroll down one line (or prefix LINES lines).
1679 If LINES is negative, scroll up LINES lines."
1681 (mime-preview-scroll-down-entity (or lines 1))
1688 (defun mime-preview-toggle-header ()
1690 (let ((situation (mime-preview-find-boundary-info))
1692 (setq p-beg (aref situation 0)
1693 p-end (aref situation 1)
1694 entity (aref situation 2)
1695 situation (get-text-property p-beg 'mime-view-situation))
1696 (let ((cell (assq '*header situation)))
1698 (setq cell (assq 'header situation)))
1699 (if (eq (cdr cell) 'visible)
1700 (setq situation (put-alist '*header 'invisible situation))
1701 (setq situation (put-alist '*header 'visible situation))))
1703 (let ((inhibit-read-only t))
1704 (delete-region p-beg p-end)
1705 (mime-display-entity entity situation)))
1706 (let ((ret (assoc situation mime-preview-situation-example-list)))
1708 (setcdr ret (1+ (cdr ret)))
1709 (add-to-list 'mime-preview-situation-example-list
1710 (cons situation 0))))))
1712 (defun mime-preview-toggle-body ()
1714 (let ((situation (mime-preview-find-boundary-info))
1716 (setq p-beg (aref situation 0)
1717 p-end (aref situation 1)
1718 entity (aref situation 2)
1719 situation (get-text-property p-beg 'mime-view-situation))
1720 (let ((cell (assq '*body situation)))
1722 (setq cell (assq 'body situation)))
1723 (if (eq (cdr cell) 'visible)
1724 (setq situation (put-alist '*body 'invisible situation))
1725 (setq situation (put-alist '*body 'visible situation))))
1727 (let ((inhibit-read-only t))
1728 (delete-region p-beg p-end)
1729 (mime-display-entity entity situation)
1731 (let ((ret (assoc situation mime-preview-situation-example-list)))
1733 (setcdr ret (1+ (cdr ret)))
1734 (add-to-list 'mime-preview-situation-example-list
1735 (cons situation 0))))))
1741 (defun mime-preview-quit ()
1742 "Quit from MIME-preview buffer.
1743 It calls function registered in variable
1744 `mime-preview-quitting-method-alist'."
1746 (let ((r (assq (mime-preview-original-major-mode)
1747 mime-preview-quitting-method-alist)))
1752 (defun mime-preview-kill-buffer ()
1754 (kill-buffer (current-buffer))
1761 (provide 'mime-view)
1763 (let* ((file mime-situation-examples-file)
1764 (buffer (get-buffer-create " *mime-example*")))
1765 (if (file-readable-p file)
1770 (insert-file-contents file)
1775 (while (and (> (length mime-preview-situation-example-list)
1776 mime-preview-situation-example-list-max-size)
1778 (setq mime-preview-situation-example-list
1779 (mime-reduce-situation-examples
1780 mime-preview-situation-example-list))
1783 (error (setq mime-preview-situation-example-list nil)))
1784 ;; (let ((rest mime-preview-situation-example-list))
1786 ;; (ctree-set-calist-strictly 'mime-preview-condition
1788 ;; (setq rest (cdr rest))))
1791 (while (and (> (length mime-acting-situation-example-list)
1792 mime-acting-situation-example-list-max-size)
1794 (setq mime-acting-situation-example-list
1795 (mime-reduce-situation-examples
1796 mime-acting-situation-example-list))
1799 (error (setq mime-acting-situation-example-list nil)))
1801 (kill-buffer buffer))))
1803 ;;; mime-view.el ends here