* SEMI-MK (install-semi-package): Install mime-setup.el(c).
[elisp/semi.git] / mime-view.el
1 ;;; mime-view.el --- interactive MIME viewer for GNU Emacs
2
3 ;; Copyright (C) 1995,1996,1997,1998,1999 Free Software Foundation, Inc.
4
5 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; Created: 1994/07/13
7 ;;      Renamed: 1994/08/31 from tm-body.el
8 ;;      Renamed: 1997/02/19 from tm-view.el
9 ;; Keywords: MIME, multimedia, mail, news
10
11 ;; This file is part of SEMI (Sample of Elastic MIME Interfaces).
12
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.
17
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.
22
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.
27
28 ;;; Code:
29
30 (require 'emu)
31 (require 'mime)
32 (require 'semi-def)
33 (require 'calist)
34 (require 'alist)
35 (require 'mailcap)
36
37
38 ;;; @ version
39 ;;;
40
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) ")"))
46
47
48 ;;; @ variables
49 ;;;
50
51 (defgroup mime-view nil
52   "MIME view mode"
53   :group 'mime)
54
55 (defcustom mime-view-find-every-acting-situation t
56   "*Find every available acting-situation if non-nil."
57   :group 'mime-view
58   :type 'boolean)
59
60 (defcustom mime-acting-situation-examples-file "~/.mime-example"
61   "*File name of example about acting-situation demonstrated by user."
62   :group 'mime-view
63   :type 'file)
64
65
66 ;;; @ in raw-buffer (representation space)
67 ;;;
68
69 (defvar mime-preview-buffer nil
70   "MIME-preview buffer corresponding with the (raw) buffer.")
71 (make-variable-buffer-local 'mime-preview-buffer)
72
73
74 (defvar mime-raw-representation-type-alist
75   '((mime-show-message-mode     . binary)
76     (mime-temp-message-mode     . binary)
77     (t                          . cooked)
78     )
79   "Alist of major-mode vs. representation-type of mime-raw-buffer.
80 Each element looks like (SYMBOL . REPRESENTATION-TYPE).  SYMBOL is
81 major-mode or t.  t means default.  REPRESENTATION-TYPE must be
82 `binary' or `cooked'.")
83
84
85 (defun mime-raw-find-entity-from-point (point &optional message-info)
86   "Return entity from POINT in mime-raw-buffer.
87 If optional argument MESSAGE-INFO is not specified,
88 `mime-message-structure' is used."
89   (or message-info
90       (setq message-info mime-message-structure))
91   (if (and (<= (mime-entity-point-min message-info) point)
92            (<= point (mime-entity-point-max message-info)))
93       (let ((children (mime-entity-children message-info)))
94         (catch 'tag
95           (while children
96             (let ((ret
97                    (mime-raw-find-entity-from-point point (car children))))
98               (if ret
99                   (throw 'tag ret)
100                 ))
101             (setq children (cdr children)))
102           message-info))))
103
104
105 ;;; @ in preview-buffer (presentation space)
106 ;;;
107
108 (defvar mime-mother-buffer nil
109   "Mother buffer corresponding with the (MIME-preview) buffer.
110 If current MIME-preview buffer is generated by other buffer, such as
111 message/partial, it is called `mother-buffer'.")
112 (make-variable-buffer-local 'mime-mother-buffer)
113
114 (defvar mime-raw-buffer nil
115   "Raw buffer corresponding with the (MIME-preview) buffer.")
116 (make-variable-buffer-local 'mime-raw-buffer)
117
118 (defvar mime-preview-original-window-configuration nil
119   "Window-configuration before mime-view-mode is called.")
120 (make-variable-buffer-local 'mime-preview-original-window-configuration)
121
122 (defun mime-preview-original-major-mode (&optional recursive)
123   "Return major-mode of original buffer.
124 If optional argument RECURSIVE is non-nil and current buffer has
125 mime-mother-buffer, it returns original major-mode of the
126 mother-buffer."
127   (if (and recursive mime-mother-buffer)
128       (save-excursion
129         (set-buffer mime-mother-buffer)
130         (mime-preview-original-major-mode recursive)
131         )
132     (save-excursion
133       (set-buffer
134        (mime-entity-buffer
135         (get-text-property (point-min) 'mime-view-entity)))
136       major-mode)))
137
138
139 ;;; @ entity information
140 ;;;
141
142 (defun mime-entity-situation (entity &optional situation)
143   "Return situation of ENTITY."
144   (let (rest param name)
145     ;; Content-Type
146     (unless (assq 'type situation)
147       (setq rest (or (mime-entity-content-type entity)
148                      (make-mime-content-type 'text 'plain))
149             situation (cons (car rest) situation)
150             rest (cdr rest))
151       )
152     (unless (assq 'subtype situation)
153       (or rest
154           (setq rest (or (cdr (mime-entity-content-type entity))
155                          '((subtype . plain)))))
156       (setq situation (cons (car rest) situation)
157             rest (cdr rest))
158       )
159     (while rest
160       (setq param (car rest))
161       (or (assoc (car param) situation)
162           (setq situation (cons param situation)))
163       (setq rest (cdr rest)))
164     
165     ;; Content-Disposition
166     (setq rest nil)
167     (unless (assq 'disposition-type situation)
168       (setq rest (mime-entity-content-disposition entity))
169       (if rest
170           (setq situation (cons (cons 'disposition-type
171                                       (mime-content-disposition-type rest))
172                                 situation)
173                 rest (mime-content-disposition-parameters rest))
174         ))
175     (while rest
176       (setq param (car rest)
177             name (car param))
178       (if (cond ((string= name "filename")
179                  (if (assq 'filename situation)
180                      nil
181                    (setq name 'filename)))
182                 ((string= name "creation-date")
183                  (if (assq 'creation-date situation)
184                      nil
185                    (setq name 'creation-date)))
186                 ((string= name "modification-date")
187                  (if (assq 'modification-date situation)
188                      nil
189                    (setq name 'modification-date)))
190                 ((string= name "read-date")
191                  (if (assq 'read-date situation)
192                      nil
193                    (setq name 'read-date)))
194                 ((string= name "size")
195                  (if (assq 'size situation)
196                      nil
197                    (setq name 'size)))
198                 (t (setq name (cons 'disposition name))
199                    (if (assoc name situation)
200                        nil
201                      name)))
202           (setq situation
203                 (cons (cons name (cdr param))
204                       situation)))
205       (setq rest (cdr rest)))
206     
207     ;; Content-Transfer-Encoding
208     (or (assq 'encoding situation)
209         (setq situation
210               (cons (cons 'encoding (or (mime-entity-encoding entity)
211                                         "7bit"))
212                     situation)))
213
214     ;; major-mode
215     (or (assq 'major-mode situation)
216         (setq situation
217               (cons (cons 'major-mode
218                           (with-current-buffer (mime-entity-buffer entity)
219                             major-mode))
220                     situation)))
221     
222     situation))
223
224 (defun mime-view-entity-title (entity)
225   (or (mime-read-field 'Content-Description entity)
226       (mime-read-field 'Subject entity)
227       (mime-entity-filename entity)
228       ""))
229
230
231 (defsubst mime-raw-point-to-entity-node-id (point &optional message-info)
232   "Return entity-node-id from POINT in mime-raw-buffer.
233 If optional argument MESSAGE-INFO is not specified,
234 `mime-message-structure' is used."
235   (mime-entity-node-id (mime-raw-find-entity-from-point point message-info)))
236
237 (defsubst mime-raw-point-to-entity-number (point &optional message-info)
238   "Return entity-number from POINT in mime-raw-buffer.
239 If optional argument MESSAGE-INFO is not specified,
240 `mime-message-structure' is used."
241   (mime-entity-number (mime-raw-find-entity-from-point point message-info)))
242
243 (defun mime-raw-flatten-message-info (&optional message-info)
244   "Return list of entity in mime-raw-buffer.
245 If optional argument MESSAGE-INFO is not specified,
246 `mime-message-structure' is used."
247   (or message-info
248       (setq message-info mime-message-structure))
249   (let ((dest (list message-info))
250         (rcl (mime-entity-children message-info)))
251     (while rcl
252       (setq dest (nconc dest (mime-raw-flatten-message-info (car rcl))))
253       (setq rcl (cdr rcl)))
254     dest))
255
256
257 ;;; @ presentation of preview
258 ;;;
259
260 ;;; @@ entity-button
261 ;;;
262
263 ;;; @@@ predicate function
264 ;;;
265
266 (defun mime-view-entity-button-visible-p (entity)
267   "Return non-nil if header of ENTITY is visible.
268 Please redefine this function if you want to change default setting."
269   (let ((media-type (mime-entity-media-type entity))
270         (media-subtype (mime-entity-media-subtype entity)))
271     (or (not (eq media-type 'application))
272         (and (not (eq media-subtype 'x-selection))
273              (or (not (eq media-subtype 'octet-stream))
274                  (let ((mother-entity (mime-entity-parent entity)))
275                    (or (not (eq (mime-entity-media-type mother-entity)
276                                 'multipart))
277                        (not (eq (mime-entity-media-subtype mother-entity)
278                                 'encrypted)))
279                    )
280                  )))))
281
282 ;;; @@@ entity button generator
283 ;;;
284
285 (defun mime-view-insert-entity-button (entity)
286   "Insert entity-button of ENTITY."
287   (let ((entity-node-id (mime-entity-node-id entity))
288         (params (mime-entity-parameters entity))
289         (subject (mime-view-entity-title entity)))
290     (mime-insert-button
291      (let ((access-type (assoc "access-type" params))
292            (num (or (cdr (assoc "x-part-number" params))
293                     (if (consp entity-node-id)
294                         (mapconcat (function
295                                     (lambda (num)
296                                       (format "%s" (1+ num))
297                                       ))
298                                    (reverse entity-node-id) ".")
299                       "0"))
300                 ))
301        (cond (access-type
302               (let ((server (assoc "server" params)))
303                 (setq access-type (cdr access-type))
304                 (if server
305                     (format "%s %s ([%s] %s)"
306                             num subject access-type (cdr server))
307                 (let ((site (cdr (assoc "site" params)))
308                       (dir (cdr (assoc "directory" params)))
309                       (url (cdr (assoc "url" params)))
310                       )
311                   (if url
312                       (format "%s %s ([%s] %s)"
313                               num subject access-type url)
314                     (format "%s %s ([%s] %s:%s)"
315                             num subject access-type site dir))
316                   )))
317             )
318            (t
319             (let ((media-type (mime-entity-media-type entity))
320                   (media-subtype (mime-entity-media-subtype entity))
321                   (charset (cdr (assoc "charset" params)))
322                   (encoding (mime-entity-encoding entity)))
323               (concat
324                num " " subject
325                (let ((rest
326                       (format " <%s/%s%s%s>"
327                               media-type media-subtype
328                               (if charset
329                                   (concat "; " charset)
330                                 "")
331                               (if encoding
332                                   (concat " (" encoding ")")
333                                 ""))))
334                  (if (>= (+ (current-column)(length rest))(window-width))
335                      "\n\t")
336                  rest)))
337             )))
338      (function mime-preview-play-current-entity))
339     ))
340
341
342 ;;; @@ entity-header
343 ;;;
344
345 (defvar mime-header-presentation-method-alist nil
346   "Alist of major mode vs. corresponding header-presentation-method functions.
347 Each element looks like (SYMBOL . FUNCTION).
348 SYMBOL must be major mode in raw-buffer or t.  t means default.
349 Interface of FUNCTION must be (ENTITY SITUATION).")
350
351 (defvar mime-view-ignored-field-list
352   '(".*Received:" ".*Path:" ".*Id:" "^References:"
353     "^Replied:" "^Errors-To:"
354     "^Lines:" "^Sender:" ".*Host:" "^Xref:"
355     "^Content-Type:" "^Precedence:"
356     "^Status:" "^X-VM-.*:")
357   "All fields that match this list will be hidden in MIME preview buffer.
358 Each elements are regexp of field-name.")
359
360 (defvar mime-view-visible-field-list '("^Dnas.*:" "^Message-Id:")
361   "All fields that match this list will be displayed in MIME preview buffer.
362 Each elements are regexp of field-name.")
363
364
365 ;;; @@ entity-body
366 ;;;
367
368 ;;; @@@ predicate function
369 ;;;
370
371 (defun mime-calist::field-match-method-as-default-rule (calist
372                                                         field-type field-value)
373   (let ((s-field (assq field-type calist)))
374     (cond ((null s-field)
375            (cons (cons field-type field-value) calist)
376            )
377           (t calist))))
378
379 (define-calist-field-match-method
380   'header #'mime-calist::field-match-method-as-default-rule)
381
382 (define-calist-field-match-method
383   'body #'mime-calist::field-match-method-as-default-rule)
384
385
386 (defvar mime-preview-condition nil
387   "Condition-tree about how to display entity.")
388
389 (ctree-set-calist-strictly
390  'mime-preview-condition '((type . application)(subtype . octet-stream)
391                            (encoding . nil)
392                            (body . visible)))
393 (ctree-set-calist-strictly
394  'mime-preview-condition '((type . application)(subtype . octet-stream)
395                            (encoding . "7bit")
396                            (body . visible)))
397 (ctree-set-calist-strictly
398  'mime-preview-condition '((type . application)(subtype . octet-stream)
399                            (encoding . "8bit")
400                            (body . visible)))
401
402 (ctree-set-calist-strictly
403  'mime-preview-condition '((type . application)(subtype . pgp)
404                            (body . visible)))
405
406 (ctree-set-calist-strictly
407  'mime-preview-condition '((type . application)(subtype . x-latex)
408                            (body . visible)))
409
410 (ctree-set-calist-strictly
411  'mime-preview-condition '((type . application)(subtype . x-selection)
412                            (body . visible)))
413
414 (ctree-set-calist-strictly
415  'mime-preview-condition '((type . application)(subtype . x-comment)
416                            (body . visible)))
417
418 (ctree-set-calist-strictly
419  'mime-preview-condition '((type . message)(subtype . delivery-status)
420                            (body . visible)))
421
422 (ctree-set-calist-strictly
423  'mime-preview-condition
424  '((body . visible)
425    (body-presentation-method . mime-display-text/plain)))
426
427 (ctree-set-calist-strictly
428  'mime-preview-condition
429  '((type . nil)
430    (body . visible)
431    (body-presentation-method . mime-display-text/plain)))
432
433 (ctree-set-calist-strictly
434  'mime-preview-condition
435  '((type . text)(subtype . enriched)
436    (body . visible)
437    (body-presentation-method . mime-display-text/enriched)))
438
439 (ctree-set-calist-strictly
440  'mime-preview-condition
441  '((type . text)(subtype . richtext)
442    (body . visible)
443    (body-presentation-method . mime-display-text/richtext)))
444
445 (ctree-set-calist-strictly
446  'mime-preview-condition
447  '((type . text)(subtype . t)
448    (body . visible)
449    (body-presentation-method . mime-display-text/plain)))
450
451 (ctree-set-calist-strictly
452  'mime-preview-condition
453  '((type . multipart)(subtype . alternative)
454    (body . visible)
455    (body-presentation-method . mime-display-multipart/alternative)))
456
457 (ctree-set-calist-strictly
458  'mime-preview-condition '((type . message)(subtype . partial)
459                            (body-presentation-method
460                             . mime-display-message/partial-button)))
461
462 (ctree-set-calist-strictly
463  'mime-preview-condition '((type . message)(subtype . rfc822)
464                            (body-presentation-method . nil)
465                            (childrens-situation (header . visible)
466                                                 (entity-button . invisible))))
467
468 (ctree-set-calist-strictly
469  'mime-preview-condition '((type . message)(subtype . news)
470                            (body-presentation-method . nil)
471                            (childrens-situation (header . visible)
472                                                 (entity-button . invisible))))
473
474
475 ;;; @@@ entity presentation
476 ;;;
477
478 (defun mime-display-text/plain (entity situation)
479   (save-restriction
480     (narrow-to-region (point-max)(point-max))
481     (mime-insert-text-content entity)
482     (run-hooks 'mime-text-decode-hook)
483     (goto-char (point-max))
484     (if (not (eq (char-after (1- (point))) ?\n))
485         (insert "\n")
486       )
487     (mime-add-url-buttons)
488     (run-hooks 'mime-display-text/plain-hook)
489     ))
490
491 (defun mime-display-text/richtext (entity situation)
492   (save-restriction
493     (narrow-to-region (point-max)(point-max))
494     (mime-insert-text-content entity)
495     (run-hooks 'mime-text-decode-hook)
496     (let ((beg (point-min)))
497       (remove-text-properties beg (point-max) '(face nil))
498       (richtext-decode beg (point-max))
499       )))
500
501 (defun mime-display-text/enriched (entity situation)
502   (save-restriction
503     (narrow-to-region (point-max)(point-max))
504     (mime-insert-text-content entity)
505     (run-hooks 'mime-text-decode-hook)
506     (let ((beg (point-min)))
507       (remove-text-properties beg (point-max) '(face nil))
508       (enriched-decode beg (point-max))
509       )))
510
511 (defvar mime-view-announcement-for-message/partial
512   (if (and (>= emacs-major-version 19) window-system)
513       "\
514 \[[ This is message/partial style split message. ]]
515 \[[ Please press `v' key in this buffer          ]]
516 \[[ or click here by mouse button-2.             ]]"
517     "\
518 \[[ This is message/partial style split message. ]]
519 \[[ Please press `v' key in this buffer.         ]]"
520     ))
521
522 (defun mime-display-message/partial-button (&optional entity situation)
523   (save-restriction
524     (goto-char (point-max))
525     (if (not (search-backward "\n\n" nil t))
526         (insert "\n")
527       )
528     (goto-char (point-max))
529     (narrow-to-region (point-max)(point-max))
530     (insert mime-view-announcement-for-message/partial)
531     (mime-add-button (point-min)(point-max)
532                      #'mime-preview-play-current-entity)
533     ))
534
535 (defun mime-display-multipart/mixed (entity situation)
536   (let ((children (mime-entity-children entity))
537         (default-situation
538           (cdr (assq 'childrens-situation situation))))
539     (while children
540       (mime-display-entity (car children) nil default-situation)
541       (setq children (cdr children))
542       )))
543
544 (defcustom mime-view-type-subtype-score-alist
545   '(((text . enriched) . 3)
546     ((text . richtext) . 2)
547     ((text . plain)    . 1)
548     (t . 0))
549   "Alist MEDIA-TYPE vs corresponding score.
550 MEDIA-TYPE must be (TYPE . SUBTYPE), TYPE or t.  t means default."
551   :group 'mime-view
552   :type '(repeat (cons (choice :tag "Media-Type"
553                                (cons :tag "Type/Subtype"
554                                      (symbol :tag "Primary-type")
555                                      (symbol :tag "Subtype"))
556                                (symbol :tag "Type")
557                                (const :tag "Default" t))
558                        integer)))
559
560 (defun mime-display-multipart/alternative (entity situation)
561   (let* ((children (mime-entity-children entity))
562          (default-situation
563            (cdr (assq 'childrens-situation situation)))
564          (i 0)
565          (p 0)
566          (max-score 0)
567          (situations
568           (mapcar (function
569                    (lambda (child)
570                      (let ((situation
571                             (or (ctree-match-calist
572                                  mime-preview-condition
573                                  (append (mime-entity-situation child)
574                                          default-situation))
575                                 default-situation)))
576                        (if (cdr (assq 'body-presentation-method situation))
577                            (let ((score
578                                   (cdr
579                                    (or (assoc
580                                         (cons
581                                          (cdr (assq 'type situation))
582                                          (cdr (assq 'subtype situation)))
583                                         mime-view-type-subtype-score-alist)
584                                        (assq
585                                         (cdr (assq 'type situation))
586                                         mime-view-type-subtype-score-alist)
587                                        (assq
588                                         t
589                                         mime-view-type-subtype-score-alist)
590                                        ))))
591                              (if (> score max-score)
592                                  (setq p i
593                                        max-score score)
594                                )))
595                        (setq i (1+ i))
596                        situation)
597                      ))
598                   children)))
599     (setq i 0)
600     (while children
601       (let ((child (car children))
602             (situation (car situations)))
603         (mime-display-entity child (if (= i p)
604                                        situation
605                                      (del-alist 'body-presentation-method
606                                                 (copy-alist situation))))
607         )
608       (setq children (cdr children)
609             situations (cdr situations)
610             i (1+ i))
611       )))
612
613
614 ;;; @ acting-condition
615 ;;;
616
617 (defvar mime-acting-condition nil
618   "Condition-tree about how to process entity.")
619
620 (if (file-readable-p mailcap-file)
621     (let ((entries (mailcap-parse-file)))
622       (while entries
623         (let ((entry (car entries))
624               view print shared)
625           (while entry
626             (let* ((field (car entry))
627                    (field-type (car field)))
628               (cond ((eq field-type 'view)  (setq view field))
629                     ((eq field-type 'print) (setq print field))
630                     ((memq field-type '(compose composetyped edit)))
631                     (t (setq shared (cons field shared))))
632               )
633             (setq entry (cdr entry))
634             )
635           (setq shared (nreverse shared))
636           (ctree-set-calist-with-default
637            'mime-acting-condition
638            (append shared (list '(mode . "play")(cons 'method (cdr view)))))
639           (if print
640               (ctree-set-calist-with-default
641                'mime-acting-condition
642                (append shared
643                        (list '(mode . "print")(cons 'method (cdr view))))
644                ))
645           )
646         (setq entries (cdr entries))
647         )))
648
649 (ctree-set-calist-strictly
650  'mime-acting-condition
651  '((type . application)(subtype . octet-stream)
652    (mode . "play")
653    (method . mime-detect-content)
654    ))
655
656 (ctree-set-calist-with-default
657  'mime-acting-condition
658  '((mode . "extract")
659    (method . mime-save-content)))
660
661 (ctree-set-calist-strictly
662  'mime-acting-condition
663  '((type . text)(subtype . x-rot13-47)(mode . "play")
664    (method . mime-view-caesar)
665    ))
666 (ctree-set-calist-strictly
667  'mime-acting-condition
668  '((type . text)(subtype . x-rot13-47-48)(mode . "play")
669    (method . mime-view-caesar)
670    ))
671
672 (ctree-set-calist-strictly
673  'mime-acting-condition
674  '((type . message)(subtype . rfc822)(mode . "play")
675    (method . mime-view-message/rfc822)
676    ))
677 (ctree-set-calist-strictly
678  'mime-acting-condition
679  '((type . message)(subtype . partial)(mode . "play")
680    (method . mime-store-message/partial-piece)
681    ))
682
683 (ctree-set-calist-strictly
684  'mime-acting-condition
685  '((type . message)(subtype . external-body)
686    ("access-type" . "anon-ftp")
687    (method . mime-view-message/external-anon-ftp)
688    ))
689
690 (ctree-set-calist-strictly
691  'mime-acting-condition
692  '((type . message)(subtype . external-body)
693    ("access-type" . "url")
694    (method . mime-view-message/external-url)
695    ))
696
697 (ctree-set-calist-strictly
698  'mime-acting-condition
699  '((type . application)(subtype . octet-stream)
700    (method . mime-save-content)
701    ))
702
703
704 ;;; @ quitting method
705 ;;;
706
707 (defvar mime-preview-quitting-method-alist
708   '((mime-show-message-mode
709      . mime-preview-quitting-method-for-mime-show-message-mode))
710   "Alist of major-mode vs. quitting-method of mime-view.")
711
712 (defvar mime-preview-over-to-previous-method-alist nil
713   "Alist of major-mode vs. over-to-previous-method of mime-view.")
714
715 (defvar mime-preview-over-to-next-method-alist nil
716   "Alist of major-mode vs. over-to-next-method of mime-view.")
717
718
719 ;;; @ following method
720 ;;;
721
722 (defvar mime-preview-following-method-alist nil
723   "Alist of major-mode vs. following-method of mime-view.")
724
725 (defvar mime-view-following-required-fields-list
726   '("From"))
727
728
729 ;;; @ buffer setup
730 ;;;
731
732 (defun mime-display-entity (entity &optional situation
733                                    default-situation preview-buffer)
734   (or preview-buffer
735       (setq preview-buffer (current-buffer)))
736   (let* ((raw-buffer (mime-entity-buffer entity))
737          (start (mime-entity-point-min entity))
738          e nb ne)
739     (set-buffer raw-buffer)
740     (goto-char start)
741     (or situation
742         (setq situation
743               (or (ctree-match-calist mime-preview-condition
744                                       (append (mime-entity-situation entity)
745                                               default-situation))
746                   default-situation)))
747     (let ((button-is-invisible
748            (eq (cdr (assq 'entity-button situation)) 'invisible))
749           (header-is-visible
750            (eq (cdr (assq 'header situation)) 'visible))
751           (header-presentation-method
752            (or (cdr (assq 'header-presentation-method situation))
753                (cdr (assq major-mode mime-header-presentation-method-alist))))
754           (body-presentation-method
755            (cdr (assq 'body-presentation-method situation)))
756           (children (mime-entity-children entity)))
757       (set-buffer preview-buffer)
758       (setq nb (point))
759       (narrow-to-region nb nb)
760       (or button-is-invisible
761           (if (mime-view-entity-button-visible-p entity)
762               (mime-view-insert-entity-button entity)
763             ))
764       (when header-is-visible
765         (if header-presentation-method
766             (funcall header-presentation-method entity situation)
767           (mime-insert-header entity
768                               mime-view-ignored-field-list
769                               mime-view-visible-field-list))
770         (goto-char (point-max))
771         (insert "\n")
772         (run-hooks 'mime-display-header-hook)
773         )
774       (cond (children)
775             ((functionp body-presentation-method)
776              (funcall body-presentation-method entity situation)
777              )
778             (t
779              (when button-is-invisible
780                (goto-char (point-max))
781                (mime-view-insert-entity-button entity)
782                )
783              (or header-is-visible
784                  (progn
785                    (goto-char (point-max))
786                    (insert "\n")
787                    ))
788              ))
789       (setq ne (point-max))
790       (widen)
791       (put-text-property nb ne 'mime-view-entity entity)
792       (goto-char ne)
793       (if children
794           (if (functionp body-presentation-method)
795               (funcall body-presentation-method entity situation)
796             (mime-display-multipart/mixed entity situation)
797             ))
798       )))
799
800
801 ;;; @ MIME viewer mode
802 ;;;
803
804 (defconst mime-view-menu-title "MIME-View")
805 (defconst mime-view-menu-list
806   '((up          "Move to upper entity"    mime-preview-move-to-upper)
807     (previous    "Move to previous entity" mime-preview-move-to-previous)
808     (next        "Move to next entity"     mime-preview-move-to-next)
809     (scroll-down "Scroll-down"             mime-preview-scroll-down-entity)
810     (scroll-up   "Scroll-up"               mime-preview-scroll-up-entity)
811     (play        "Play current entity"     mime-preview-play-current-entity)
812     (extract     "Extract current entity"  mime-preview-extract-current-entity)
813     (print       "Print current entity"    mime-preview-print-current-entity)
814     )
815   "Menu for MIME Viewer")
816
817 (cond ((featurep 'xemacs)
818        (defvar mime-view-xemacs-popup-menu
819          (cons mime-view-menu-title
820                (mapcar (function
821                         (lambda (item)
822                           (vector (nth 1 item)(nth 2 item) t)
823                           ))
824                        mime-view-menu-list)))
825        (defun mime-view-xemacs-popup-menu (event)
826          "Popup the menu in the MIME Viewer buffer"
827          (interactive "e")
828          (select-window (event-window event))
829          (set-buffer (event-buffer event))
830          (popup-menu 'mime-view-xemacs-popup-menu))
831        (defvar mouse-button-2 'button2)
832        )
833       (t
834        (defvar mouse-button-2 [mouse-2])
835        ))
836
837 (defun mime-view-define-keymap (&optional default)
838   (let ((mime-view-mode-map (if (keymapp default)
839                                 (copy-keymap default)
840                               (make-sparse-keymap)
841                               )))
842     (define-key mime-view-mode-map
843       "u"        (function mime-preview-move-to-upper))
844     (define-key mime-view-mode-map
845       "p"        (function mime-preview-move-to-previous))
846     (define-key mime-view-mode-map
847       "n"        (function mime-preview-move-to-next))
848     (define-key mime-view-mode-map
849       "\e\t"     (function mime-preview-move-to-previous))
850     (define-key mime-view-mode-map
851       "\t"       (function mime-preview-move-to-next))
852     (define-key mime-view-mode-map
853       " "        (function mime-preview-scroll-up-entity))
854     (define-key mime-view-mode-map
855       "\M- "     (function mime-preview-scroll-down-entity))
856     (define-key mime-view-mode-map
857       "\177"     (function mime-preview-scroll-down-entity))
858     (define-key mime-view-mode-map
859       "\C-m"     (function mime-preview-next-line-entity))
860     (define-key mime-view-mode-map
861       "\C-\M-m"  (function mime-preview-previous-line-entity))
862     (define-key mime-view-mode-map
863       "v"        (function mime-preview-play-current-entity))
864     (define-key mime-view-mode-map
865       "e"        (function mime-preview-extract-current-entity))
866     (define-key mime-view-mode-map
867       "\C-c\C-p" (function mime-preview-print-current-entity))
868     (define-key mime-view-mode-map
869       "a"        (function mime-preview-follow-current-entity))
870     (define-key mime-view-mode-map
871       "q"        (function mime-preview-quit))
872     (define-key mime-view-mode-map
873       "\C-c\C-x" (function mime-preview-kill-buffer))
874     ;; (define-key mime-view-mode-map
875     ;;   "<"        (function beginning-of-buffer))
876     ;; (define-key mime-view-mode-map
877     ;;   ">"        (function end-of-buffer))
878     (define-key mime-view-mode-map
879       "?"        (function describe-mode))
880     (define-key mime-view-mode-map
881       [tab] (function mime-preview-move-to-next))
882     (define-key mime-view-mode-map
883       [delete] (function mime-preview-scroll-down-entity))
884     (define-key mime-view-mode-map
885       [backspace] (function mime-preview-scroll-down-entity))
886     (if (functionp default)
887         (cond ((featurep 'xemacs)
888                (set-keymap-default-binding mime-view-mode-map default)
889                )
890               (t
891                (setq mime-view-mode-map
892                      (append mime-view-mode-map (list (cons t default))))
893                )))
894     (if mouse-button-2
895         (define-key mime-view-mode-map
896           mouse-button-2 (function mime-button-dispatcher))
897       )
898     (cond ((featurep 'xemacs)
899            (define-key mime-view-mode-map
900              mouse-button-3 (function mime-view-xemacs-popup-menu))
901            )
902           ((>= emacs-major-version 19)
903            (define-key mime-view-mode-map [menu-bar mime-view]
904              (cons mime-view-menu-title
905                    (make-sparse-keymap mime-view-menu-title)))
906            (mapcar (function
907                     (lambda (item)
908                       (define-key mime-view-mode-map
909                         (vector 'menu-bar 'mime-view (car item))
910                         (cons (nth 1 item)(nth 2 item))
911                         )
912                       ))
913                    (reverse mime-view-menu-list)
914                    )
915            ))
916     (use-local-map mime-view-mode-map)
917     (run-hooks 'mime-view-define-keymap-hook)
918     ))
919
920 (defsubst mime-maybe-hide-echo-buffer ()
921   "Clear mime-echo buffer and delete window for it."
922   (let ((buf (get-buffer mime-echo-buffer-name)))
923     (if buf
924         (save-excursion
925           (set-buffer buf)
926           (erase-buffer)
927           (let ((win (get-buffer-window buf)))
928             (if win
929                 (delete-window win)
930               ))
931           (bury-buffer buf)
932           ))))
933
934 (defvar mime-view-redisplay nil)
935
936 ;;;###autoload
937 (defun mime-display-message (message &optional preview-buffer
938                                      mother default-keymap-or-function)
939   "View MESSAGE in MIME-View mode.
940
941 Optional argument PREVIEW-BUFFER specifies the buffer of the
942 presentation.  It must be either nil or a name of preview buffer.
943
944 Optional argument MOTHER specifies mother-buffer of the preview-buffer.
945
946 Optional argument DEFAULT-KEYMAP-OR-FUNCTION is nil, keymap or
947 function.  If it is a keymap, keymap of MIME-View mode will be added
948 to it.  If it is a function, it will be bound as default binding of
949 keymap of MIME-View mode."
950   (mime-maybe-hide-echo-buffer)
951   (let ((win-conf (current-window-configuration))
952         (raw-buffer (mime-entity-buffer message)))
953     (or preview-buffer
954         (setq preview-buffer
955               (concat "*Preview-" (buffer-name raw-buffer) "*")))
956     (set-buffer raw-buffer)
957     (setq mime-preview-buffer preview-buffer)
958     (let ((inhibit-read-only t))
959       (set-buffer (get-buffer-create preview-buffer))
960       (widen)
961       (erase-buffer)
962       (setq mime-raw-buffer raw-buffer)
963       (if mother
964           (setq mime-mother-buffer mother)
965         )
966       (setq mime-preview-original-window-configuration win-conf)
967       (setq major-mode 'mime-view-mode)
968       (setq mode-name "MIME-View")
969       (mime-display-entity message nil
970                            '((entity-button . invisible)
971                              (header . visible))
972                            preview-buffer)
973       (mime-view-define-keymap default-keymap-or-function)
974       (let ((point
975              (next-single-property-change (point-min) 'mime-view-entity)))
976         (if point
977             (goto-char point)
978           (goto-char (point-min))
979           (search-forward "\n\n" nil t)
980           ))
981       (run-hooks 'mime-view-mode-hook)
982       (set-buffer-modified-p nil)
983       (setq buffer-read-only t)
984       (or (get-buffer-window preview-buffer)
985           (let ((r-win (get-buffer-window raw-buffer)))
986             (if r-win
987                 (set-window-buffer r-win preview-buffer)
988               (let ((m-win (and mother (get-buffer-window mother))))
989                 (if m-win
990                     (set-window-buffer m-win preview-buffer)
991                   (switch-to-buffer preview-buffer)
992                   )))))
993       )))
994
995 ;;;###autoload
996 (defun mime-view-buffer (&optional raw-buffer preview-buffer mother
997                                    default-keymap-or-function
998                                    representation-type)
999   "View RAW-BUFFER in MIME-View mode.
1000 Optional argument PREVIEW-BUFFER is either nil or a name of preview
1001 buffer.
1002 Optional argument DEFAULT-KEYMAP-OR-FUNCTION is nil, keymap or
1003 function.  If it is a keymap, keymap of MIME-View mode will be added
1004 to it.  If it is a function, it will be bound as default binding of
1005 keymap of MIME-View mode.
1006 Optional argument REPRESENTATION-TYPE is representation-type of
1007 message.  It must be nil, `binary' or `cooked'.  If it is nil,
1008 `cooked' is used as default."
1009   (interactive)
1010   (or raw-buffer
1011       (setq raw-buffer (current-buffer)))
1012   (or representation-type
1013       (setq representation-type
1014             (save-excursion
1015               (set-buffer raw-buffer)
1016               (cdr (or (assq major-mode mime-raw-representation-type-alist)
1017                        (assq t mime-raw-representation-type-alist)))
1018               )))
1019   (if (eq representation-type 'binary)
1020       (setq representation-type 'buffer)
1021     )
1022   (mime-display-message
1023    (mime-open-entity representation-type raw-buffer)
1024    preview-buffer mother default-keymap-or-function))
1025
1026 (defun mime-view-mode (&optional mother ctl encoding
1027                                  raw-buffer preview-buffer
1028                                  default-keymap-or-function)
1029   "Major mode for viewing MIME message.
1030
1031 Here is a list of the standard keys for mime-view-mode.
1032
1033 key             feature
1034 ---             -------
1035
1036 u               Move to upper content
1037 p or M-TAB      Move to previous content
1038 n or TAB        Move to next content
1039 SPC             Scroll up or move to next content
1040 M-SPC or DEL    Scroll down or move to previous content
1041 RET             Move to next line
1042 M-RET           Move to previous line
1043 v               Decode current content as `play mode'
1044 e               Decode current content as `extract mode'
1045 C-c C-p         Decode current content as `print mode'
1046 a               Followup to current content.
1047 q               Quit
1048 button-2        Move to point under the mouse cursor
1049                 and decode current content as `play mode'
1050 "
1051   (interactive)
1052   (unless mime-view-redisplay
1053     (save-excursion
1054       (if raw-buffer (set-buffer raw-buffer))
1055       (let ((type
1056              (cdr
1057               (or (assq major-mode mime-raw-representation-type-alist)
1058                   (assq t mime-raw-representation-type-alist)))))
1059         (if (eq type 'binary)
1060             (setq type 'buffer)
1061           )
1062         (setq mime-message-structure (mime-open-entity type raw-buffer))
1063         (or (mime-entity-content-type mime-message-structure)
1064             (mime-entity-set-content-type-internal
1065              mime-message-structure ctl))
1066         )
1067       (or (mime-entity-encoding mime-message-structure)
1068           (mime-entity-set-encoding-internal mime-message-structure encoding))
1069       ))
1070   (mime-display-message mime-message-structure preview-buffer
1071                         mother default-keymap-or-function)
1072   )
1073
1074
1075 ;;; @@ playing
1076 ;;;
1077
1078 (autoload 'mime-preview-play-current-entity "mime-play"
1079   "Play current entity." t)
1080
1081 (defun mime-preview-extract-current-entity (&optional ignore-examples)
1082   "Extract current entity into file (maybe).
1083 It decodes current entity to call internal or external method as
1084 \"extract\" mode.  The method is selected from variable
1085 `mime-acting-condition'."
1086   (interactive "P")
1087   (mime-preview-play-current-entity ignore-examples "extract")
1088   )
1089
1090 (defun mime-preview-print-current-entity (&optional ignore-examples)
1091   "Print current entity (maybe).
1092 It decodes current entity to call internal or external method as
1093 \"print\" mode.  The method is selected from variable
1094 `mime-acting-condition'."
1095   (interactive "P")
1096   (mime-preview-play-current-entity ignore-examples "print")
1097   )
1098
1099
1100 ;;; @@ following
1101 ;;;
1102
1103 (defun mime-preview-follow-current-entity ()
1104   "Write follow message to current entity.
1105 It calls following-method selected from variable
1106 `mime-preview-following-method-alist'."
1107   (interactive)
1108   (let (entity)
1109     (while (null (setq entity
1110                        (get-text-property (point) 'mime-view-entity)))
1111       (backward-char)
1112       )
1113     (let* ((p-beg
1114             (previous-single-property-change (point) 'mime-view-entity))
1115            p-end
1116            (entity-node-id (mime-entity-node-id entity))
1117            (len (length entity-node-id))
1118            )
1119       (cond ((null p-beg)
1120              (setq p-beg
1121                    (if (eq (next-single-property-change (point-min)
1122                                                         'mime-view-entity)
1123                            (point))
1124                        (point)
1125                      (point-min)))
1126              )
1127             ((eq (next-single-property-change p-beg 'mime-view-entity)
1128                  (point))
1129              (setq p-beg (point))
1130              ))
1131       (setq p-end (next-single-property-change p-beg 'mime-view-entity))
1132       (cond ((null p-end)
1133              (setq p-end (point-max))
1134              )
1135             ((null entity-node-id)
1136              (setq p-end (point-max))
1137              )
1138             (t
1139              (save-excursion
1140                (goto-char p-end)
1141                (catch 'tag
1142                  (let (e)
1143                    (while (setq e
1144                                 (next-single-property-change
1145                                  (point) 'mime-view-entity))
1146                      (goto-char e)
1147                      (let ((rc (mime-entity-node-id
1148                                 (get-text-property (point)
1149                                                    'mime-view-entity))))
1150                        (or (equal entity-node-id
1151                                   (nthcdr (- (length rc) len) rc))
1152                            (throw 'tag nil)
1153                            ))
1154                      (setq p-end e)
1155                      ))
1156                  (setq p-end (point-max))
1157                  ))
1158              ))
1159       (let* ((mode (mime-preview-original-major-mode 'recursive))
1160              (new-name
1161               (format "%s-%s" (buffer-name) (reverse entity-node-id)))
1162              new-buf
1163              (the-buf (current-buffer))
1164              (a-buf mime-raw-buffer)
1165              fields)
1166         (save-excursion
1167           (set-buffer (setq new-buf (get-buffer-create new-name)))
1168           (erase-buffer)
1169           (insert-buffer-substring the-buf p-beg p-end)
1170           (goto-char (point-min))
1171           (let ((entity-node-id (mime-entity-node-id entity)) ci str)
1172             (while (progn
1173                      (setq
1174                       str
1175                       (save-excursion
1176                         (set-buffer a-buf)
1177                         (setq ci
1178                               (mime-find-entity-from-node-id entity-node-id))
1179                         (save-restriction
1180                           (narrow-to-region
1181                            (mime-entity-point-min ci)
1182                            (mime-entity-point-max ci)
1183                            )
1184                           (std11-header-string-except
1185                            (concat "^"
1186                                    (apply (function regexp-or) fields)
1187                                    ":") ""))))
1188                      (if (and
1189                           (eq (mime-entity-media-type ci) 'message)
1190                           (eq (mime-entity-media-subtype ci) 'rfc822))
1191                          nil
1192                        (if str
1193                            (insert str)
1194                          )
1195                        entity-node-id))
1196               (setq fields (std11-collect-field-names)
1197                     entity-node-id (cdr entity-node-id))
1198               )
1199             )
1200           (let ((rest mime-view-following-required-fields-list))
1201             (while rest
1202               (let ((field-name (car rest)))
1203                 (or (std11-field-body field-name)
1204                     (insert
1205                      (format
1206                       (concat field-name
1207                               ": "
1208                               (save-excursion
1209                                 (set-buffer the-buf)
1210                                 (set-buffer mime-mother-buffer)
1211                                 (set-buffer mime-raw-buffer)
1212                                 (std11-field-body field-name)
1213                                 )
1214                               "\n")))
1215                     ))
1216               (setq rest (cdr rest))
1217               ))
1218           (mime-decode-header-in-buffer)
1219           )
1220         (let ((f (cdr (assq mode mime-preview-following-method-alist))))
1221           (if (functionp f)
1222               (funcall f new-buf)
1223             (message
1224              (format
1225               "Sorry, following method for %s is not implemented yet."
1226               mode))
1227             ))
1228         ))))
1229
1230
1231 ;;; @@ moving
1232 ;;;
1233
1234 (defun mime-preview-move-to-upper ()
1235   "Move to upper entity.
1236 If there is no upper entity, call function `mime-preview-quit'."
1237   (interactive)
1238   (let (cinfo)
1239     (while (null (setq cinfo
1240                        (get-text-property (point) 'mime-view-entity)))
1241       (backward-char)
1242       )
1243     (let ((r (mime-entity-parent cinfo))
1244           point)
1245       (catch 'tag
1246         (while (setq point (previous-single-property-change
1247                             (point) 'mime-view-entity))
1248           (goto-char point)
1249           (if (eq r (get-text-property (point) 'mime-view-entity))
1250               (throw 'tag t)
1251             )
1252           )
1253         (mime-preview-quit)
1254         ))))
1255
1256 (defun mime-preview-move-to-previous ()
1257   "Move to previous entity.
1258 If there is no previous entity, it calls function registered in
1259 variable `mime-preview-over-to-previous-method-alist'."
1260   (interactive)
1261   (while (null (get-text-property (point) 'mime-view-entity))
1262     (backward-char)
1263     )
1264   (let ((point (previous-single-property-change (point) 'mime-view-entity)))
1265     (if point
1266         (if (get-text-property (1- point) 'mime-view-entity)
1267             (goto-char point)
1268           (goto-char (1- point))
1269           (mime-preview-move-to-previous)
1270           )
1271       (let ((f (assq (mime-preview-original-major-mode)
1272                      mime-preview-over-to-previous-method-alist)))
1273         (if f
1274             (funcall (cdr f))
1275           ))
1276       )))
1277
1278 (defun mime-preview-move-to-next ()
1279   "Move to next entity.
1280 If there is no previous entity, it calls function registered in
1281 variable `mime-preview-over-to-next-method-alist'."
1282   (interactive)
1283   (while (and (not (eobp))
1284               (null (get-text-property (point) 'mime-view-entity)))
1285     (forward-char)
1286     )
1287   (let ((point (next-single-property-change (point) 'mime-view-entity)))
1288     (if point
1289         (progn
1290           (goto-char point)
1291           (if (null (get-text-property point 'mime-view-entity))
1292               (mime-preview-move-to-next)
1293             ))
1294       (let ((f (assq (mime-preview-original-major-mode)
1295                      mime-preview-over-to-next-method-alist)))
1296         (if f
1297             (funcall (cdr f))
1298           ))
1299       )))
1300
1301 (defun mime-preview-scroll-up-entity (&optional h)
1302   "Scroll up current entity.
1303 If reached to (point-max), it calls function registered in variable
1304 `mime-preview-over-to-next-method-alist'."
1305   (interactive)
1306   (or h
1307       (setq h (1- (window-height)))
1308       )
1309   (if (= (point) (point-max))
1310       (let ((f (assq (mime-preview-original-major-mode)
1311                      mime-preview-over-to-next-method-alist)))
1312         (if f
1313             (funcall (cdr f))
1314           ))
1315     (let ((point
1316            (or (next-single-property-change (point) 'mime-view-entity)
1317                (point-max))))
1318       (forward-line h)
1319       (if (> (point) point)
1320           (goto-char point)
1321         )
1322       )))
1323
1324 (defun mime-preview-scroll-down-entity (&optional h)
1325   "Scroll down current entity.
1326 If reached to (point-min), it calls function registered in variable
1327 `mime-preview-over-to-previous-method-alist'."
1328   (interactive)
1329   (or h
1330       (setq h (1- (window-height)))
1331       )
1332   (if (= (point) (point-min))
1333       (let ((f (assq (mime-preview-original-major-mode)
1334                      mime-preview-over-to-previous-method-alist)))
1335         (if f
1336             (funcall (cdr f))
1337           ))
1338     (let ((point
1339            (or (previous-single-property-change (point) 'mime-view-entity)
1340                (point-min))))
1341       (forward-line (- h))
1342       (if (< (point) point)
1343           (goto-char point)
1344         ))))
1345
1346 (defun mime-preview-next-line-entity ()
1347   (interactive)
1348   (mime-preview-scroll-up-entity 1)
1349   )
1350
1351 (defun mime-preview-previous-line-entity ()
1352   (interactive)
1353   (mime-preview-scroll-down-entity 1)
1354   )
1355
1356
1357 ;;; @@ quitting
1358 ;;;
1359
1360 (defun mime-preview-quit ()
1361   "Quit from MIME-preview buffer.
1362 It calls function registered in variable
1363 `mime-preview-quitting-method-alist'."
1364   (interactive)
1365   (let ((r (assq (mime-preview-original-major-mode)
1366                  mime-preview-quitting-method-alist)))
1367     (if r
1368         (funcall (cdr r))
1369       )))
1370
1371 (defun mime-preview-kill-buffer ()
1372   (interactive)
1373   (kill-buffer (current-buffer))
1374   )
1375
1376
1377 ;;; @ end
1378 ;;;
1379
1380 (provide 'mime-view)
1381
1382 (run-hooks 'mime-view-load-hook)
1383
1384 ;;; mime-view.el ends here