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