2002-01-24 Katsumi Yamaoka <yamaoka@jpl.org>
[gnus] / lisp / mm-view.el
1 ;;; mm-view.el --- functions for viewing MIME objects
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
3
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; This file is part of GNU Emacs.
6
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
10 ;; any later version.
11
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 ;; GNU General Public License for more details.
16
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
19 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 ;; Boston, MA 02111-1307, USA.
21
22 ;;; Commentary:
23
24 ;;; Code:
25
26 (eval-when-compile (require 'cl))
27 (require 'mail-parse)
28 (require 'mailcap)
29 (require 'mm-bodies)
30 (require 'mm-decode)
31
32 (eval-and-compile
33   (autoload 'gnus-article-prepare-display "gnus-art")
34   (autoload 'vcard-parse-string "vcard")
35   (autoload 'vcard-format-string "vcard")
36   (autoload 'fill-flowed "flow-fill")
37   (unless (fboundp 'diff-mode)
38     (autoload 'diff-mode "diff-mode" "" t nil)))
39
40 ;;;
41 ;;; Functions for displaying various formats inline
42 ;;;
43
44 (defun mm-inline-image-emacs (handle)
45   (let ((b (point-marker))
46         buffer-read-only)
47     (insert "\n")
48     (put-image (mm-get-image handle) b)
49     (mm-handle-set-undisplayer
50      handle
51      `(lambda () (remove-images ,b (1+ ,b))))))
52
53 (defun mm-inline-image-xemacs (handle)
54   (insert "\n")
55   (forward-char -1)
56   (let ((b (point))
57         (annot (make-annotation (mm-get-image handle) nil 'text))
58         buffer-read-only)
59     (mm-handle-set-undisplayer
60      handle
61      `(lambda ()
62         (let (buffer-read-only)
63           (delete-annotation ,annot)
64           (delete-region ,(set-marker (make-marker) b)
65                          ,(set-marker (make-marker) (point))))))
66     (set-extent-property annot 'mm t)
67     (set-extent-property annot 'duplicable t)))
68
69 (eval-and-compile
70   (if (featurep 'xemacs)
71       (defalias 'mm-inline-image 'mm-inline-image-xemacs)
72     (defalias 'mm-inline-image 'mm-inline-image-emacs)))
73
74 (defvar mm-w3-setup nil)
75 (defun mm-setup-w3 ()
76   (unless mm-w3-setup
77     (require 'w3)
78     (w3-do-setup)
79     (require 'url)
80     (require 'w3-vars)
81     (require 'url-vars)
82     (setq mm-w3-setup t)))
83
84 (defun mm-inline-text-html-render-with-w3 (handle)
85   (mm-setup-w3)
86   (let ((text (mm-get-part handle))
87         (b (point))
88         (url-standalone-mode t)
89         (w3-honor-stylesheets nil)
90         (w3-delay-image-loads t)
91         (url-current-object
92          (url-generic-parse-url (format "cid:%s" (mm-handle-id handle))))
93         (width (window-width))
94         (charset (mail-content-type-get
95                   (mm-handle-type handle) 'charset)))
96     (save-excursion
97       (insert text)
98       (save-restriction
99         (narrow-to-region b (point))
100         (goto-char (point-min))
101         (if (or (and (boundp 'w3-meta-content-type-charset-regexp)
102                      (re-search-forward
103                       w3-meta-content-type-charset-regexp nil t))
104                 (and (boundp 'w3-meta-charset-content-type-regexp)
105                      (re-search-forward
106                       w3-meta-charset-content-type-regexp nil t)))
107             (setq charset
108                   (or (let ((bsubstr (buffer-substring-no-properties
109                                       (match-beginning 2)
110                                       (match-end 2))))
111                         (if (fboundp 'w3-coding-system-for-mime-charset)
112                             (w3-coding-system-for-mime-charset bsubstr)
113                           (mm-charset-to-coding-system bsubstr)))
114                       charset)))
115         (delete-region (point-min) (point-max))
116         (insert (mm-decode-string text charset))
117         (save-window-excursion
118           (save-restriction
119             (let ((w3-strict-width width)
120                   ;; Don't let w3 set the global version of
121                   ;; this variable.
122                   (fill-column fill-column)
123                   (w3-honor-stylesheets nil)
124                   (w3-delay-image-loads t)
125                   (url-standalone-mode t))
126               (condition-case var
127                   (w3-region (point-min) (point-max))
128                 (error
129                  (delete-region (point-min) (point-max))
130                  (let ((b (point))
131                        (charset (mail-content-type-get
132                                  (mm-handle-type handle) 'charset)))
133                    (if (or (eq charset 'gnus-decoded)
134                            (eq mail-parse-charset 'gnus-decoded))
135                        (save-restriction
136                          (narrow-to-region (point) (point))
137                          (mm-insert-part handle)
138                          (goto-char (point-max)))
139                      (insert (mm-decode-string (mm-get-part handle)
140                                                charset))))
141                  (message
142                   "Error while rendering html; showing as text/plain"))))))
143         (mm-handle-set-undisplayer
144          handle
145          `(lambda ()
146             (let (buffer-read-only)
147               (if (functionp 'remove-specifier)
148                   (mapcar (lambda (prop)
149                             (remove-specifier
150                              (face-property 'default prop)
151                              (current-buffer)))
152                           '(background background-pixmap foreground)))
153               (delete-region ,(point-min-marker)
154                              ,(point-max-marker)))))))))
155
156 (defvar mm-w3m-minor-mode nil)
157 (make-variable-buffer-local 'mm-w3m-minor-mode)
158 (defvar mm-w3m-setup nil)
159 (defun mm-setup-w3m ()
160   (unless mm-w3m-setup
161     (require 'w3m)
162     (gnus-add-minor-mode 'mm-w3m-minor-mode " w3m" w3m-mode-map)
163     (setq mm-w3m-setup t)))
164
165 (defun mm-inline-text-html-render-with-w3m (handle)
166   (mm-setup-w3m)
167   (let ((text (mm-get-part handle))
168         (b (point)))
169     (save-excursion
170       (insert text)
171       (save-restriction
172         (narrow-to-region b (point))
173         (goto-char (point-min))
174         (w3m-region (point-min) (point-max))
175         (setq mm-w3m-minor-mode t))
176       (mm-handle-set-undisplayer
177        handle
178        `(lambda ()
179           (let (buffer-read-only)
180             (setq mm-w3m-minor-mode nil)
181             (if (functionp 'remove-specifier)
182                 (mapcar (lambda (prop)
183                           (remove-specifier
184                            (face-property 'default prop)
185                            (current-buffer)))
186                         '(background background-pixmap foreground)))
187             (delete-region ,(point-min-marker)
188                            ,(point-max-marker))))))))
189
190 (defun mm-inline-text (handle)
191   (let ((type (mm-handle-media-subtype handle))
192         buffer-read-only)
193     (cond
194      ((equal type "html")
195       (funcall mm-inline-text-html-renderer handle))
196      ((equal type "x-vcard")
197       (mm-insert-inline
198        handle
199        (concat "\n-- \n"
200                (ignore-errors
201                  (if (fboundp 'vcard-pretty-print)
202                      (vcard-pretty-print (mm-get-part handle))
203                    (vcard-format-string
204                     (vcard-parse-string (mm-get-part handle)
205                                         'vcard-standard-filter)))))))
206      (t
207       (let ((b (point))
208             (charset (mail-content-type-get
209                       (mm-handle-type handle) 'charset)))
210         (if (or (eq charset 'gnus-decoded)
211                 ;; This is probably not entirely correct, but
212                 ;; makes rfc822 parts with embedded multiparts work.
213                 (eq mail-parse-charset 'gnus-decoded))
214             (save-restriction
215               (narrow-to-region (point) (point))
216               (mm-insert-part handle)
217               (goto-char (point-max)))
218           (insert (mm-decode-string (mm-get-part handle) charset)))
219         (when (and (equal type "plain")
220                    (equal (cdr (assoc 'format (mm-handle-type handle)))
221                           "flowed"))
222           (save-restriction
223             (narrow-to-region b (point))
224             (goto-char b)
225             (fill-flowed)
226             (goto-char (point-max))))
227         (save-restriction
228           (narrow-to-region b (point))
229           (set-text-properties (point-min) (point-max) nil)
230           (when (or (equal type "enriched")
231                     (equal type "richtext"))
232             (enriched-decode (point-min) (point-max)))
233           (mm-handle-set-undisplayer
234            handle
235            `(lambda ()
236               (let (buffer-read-only)
237                 (delete-region ,(point-min-marker)
238                                ,(point-max-marker)))))))))))
239
240 (defun mm-insert-inline (handle text)
241   "Insert TEXT inline from HANDLE."
242   (let ((b (point)))
243     (insert text)
244     (mm-handle-set-undisplayer
245      handle
246      `(lambda ()
247         (let (buffer-read-only)
248           (delete-region ,(set-marker (make-marker) b)
249                          ,(set-marker (make-marker) (point))))))))
250
251 (defun mm-inline-audio (handle)
252   (message "Not implemented"))
253
254 (defun mm-view-sound-file ()
255   (message "Not implemented"))
256
257 (defun mm-w3-prepare-buffer ()
258   (require 'w3)
259   (let ((url-standalone-mode t)
260         (w3-honor-stylesheets nil)
261         (w3-delay-image-loads t))
262     (w3-prepare-buffer)))
263
264 (defun mm-view-message ()
265   (mm-enable-multibyte)
266   (let (handles)
267     (let (gnus-article-mime-handles)
268       ;; Double decode problem may happen.  See mm-inline-message.
269       (run-hooks 'gnus-article-decode-hook)
270       (gnus-article-prepare-display)
271       (setq handles gnus-article-mime-handles))
272     (when handles
273       (setq gnus-article-mime-handles
274             (mm-merge-handles gnus-article-mime-handles handles))))
275   (fundamental-mode)
276   (goto-char (point-min)))
277
278 (defun mm-inline-message (handle)
279   (let ((b (point))
280         (bolp (bolp))
281         (charset (mail-content-type-get
282                   (mm-handle-type handle) 'charset))
283         gnus-displaying-mime handles)
284     (when (and charset
285                (stringp charset))
286       (setq charset (intern (downcase charset)))
287       (when (eq charset 'us-ascii)
288         (setq charset nil)))
289     (save-excursion
290       (save-restriction
291         (narrow-to-region b b)
292         (mm-insert-part handle)
293         (let (gnus-article-mime-handles
294               ;; disable prepare hook
295               gnus-article-prepare-hook
296               (gnus-newsgroup-charset
297                (or charset gnus-newsgroup-charset)))
298           (run-hooks 'gnus-article-decode-hook)
299           (gnus-article-prepare-display)
300           (setq handles gnus-article-mime-handles))
301         (goto-char (point-min))
302         (unless bolp
303           (insert "\n"))
304         (goto-char (point-max))
305         (unless (bolp)
306           (insert "\n"))
307         (insert "----------\n\n")
308         (when handles
309           (setq gnus-article-mime-handles
310                 (mm-merge-handles gnus-article-mime-handles handles)))
311         (mm-handle-set-undisplayer
312          handle
313          `(lambda ()
314             (let (buffer-read-only)
315               (if (fboundp 'remove-specifier)
316                   ;; This is only valid on XEmacs.
317                   (mapcar (lambda (prop)
318                             (remove-specifier
319                              (face-property 'default prop) (current-buffer)))
320                           '(background background-pixmap foreground)))
321               (delete-region ,(point-min-marker) ,(point-max-marker)))))))))
322
323 (defun mm-display-inline-fontify (handle mode)
324   (let (text)
325     ;; XEmacs @#$@ version of font-lock refuses to fully turn itself
326     ;; on for buffers whose name begins with " ".  That's why we use
327     ;; save-current-buffer/get-buffer-create rather than
328     ;; with-temp-buffer.
329     (save-current-buffer
330       (set-buffer (generate-new-buffer "*fontification*"))
331       (unwind-protect
332           (progn
333             (buffer-disable-undo)
334             (mm-insert-part handle)
335             (funcall mode)
336             (require 'font-lock)
337             (let ((font-lock-verbose nil))
338               ;; I find font-lock a bit too verbose.
339               (font-lock-fontify-buffer))
340             ;; By default, XEmacs font-lock uses non-duplicable text
341             ;; properties.  This code forces all the text properties
342             ;; to be copied along with the text.
343             (when (fboundp 'extent-list)
344               (map-extents (lambda (ext ignored)
345                              (set-extent-property ext 'duplicable t)
346                              nil)
347                            nil nil nil nil nil 'text-prop))
348             (setq text (buffer-string)))
349         (kill-buffer (current-buffer))))
350     (mm-insert-inline handle text)))
351
352 ;; Shouldn't these functions check whether the user even wants to use
353 ;; font-lock?  At least under XEmacs, this fontification is pretty
354 ;; much unconditional.  Also, it would be nice to change for the size
355 ;; of the fontified region.
356
357 (defun mm-display-patch-inline (handle)
358   (mm-display-inline-fontify handle 'diff-mode))
359
360 (defun mm-display-elisp-inline (handle)
361   (mm-display-inline-fontify handle 'emacs-lisp-mode))
362
363 ;;      id-signedData OBJECT IDENTIFIER ::= { iso(1) member-body(2)
364 ;;          us(840) rsadsi(113549) pkcs(1) pkcs7(7) 2 }
365 (defvar mm-pkcs7-signed-magic
366   (mm-string-as-unibyte
367    (apply 'concat
368           (mapcar 'char-to-string
369                   (list ?\x30 ?\x5c ?\x28 ?\x80 ?\x5c ?\x7c ?\x81 ?\x2e ?\x5c
370                         ?\x7c ?\x82 ?\x2e ?\x2e ?\x5c ?\x7c ?\x83 ?\x2e ?\x2e
371                         ?\x2e ?\x5c ?\x29 ?\x06 ?\x09 ?\x5c ?\x2a ?\x86 ?\x48
372                         ?\x86 ?\xf7 ?\x0d ?\x01 ?\x07 ?\x02)))))
373   
374 ;;      id-envelopedData OBJECT IDENTIFIER ::= { iso(1) member-body(2)
375 ;;          us(840) rsadsi(113549) pkcs(1) pkcs7(7) 3 }
376 (defvar mm-pkcs7-enveloped-magic
377   (mm-string-as-unibyte
378    (apply 'concat
379           (mapcar 'char-to-string
380                   (list ?\x30 ?\x5c ?\x28 ?\x80 ?\x5c ?\x7c ?\x81 ?\x2e ?\x5c
381                         ?\x7c ?\x82 ?\x2e ?\x2e ?\x5c ?\x7c ?\x83 ?\x2e ?\x2e
382                         ?\x2e ?\x5c ?\x29 ?\x06 ?\x09 ?\x5c ?\x2a ?\x86 ?\x48
383                         ?\x86 ?\xf7 ?\x0d ?\x01 ?\x07 ?\x03)))))
384   
385 (defun mm-view-pkcs7-get-type (handle)
386   (mm-with-unibyte-buffer
387     (mm-insert-part handle)
388     (cond ((looking-at mm-pkcs7-enveloped-magic)
389            'enveloped)
390           ((looking-at mm-pkcs7-signed-magic)
391            'signed)
392           (t
393            (error "Could not identify PKCS#7 type")))))
394
395 (defun mm-view-pkcs7 (handle)
396   (case (mm-view-pkcs7-get-type handle)
397     (enveloped (mm-view-pkcs7-decrypt handle))
398     (otherwise (error "Unknown or unimplemented PKCS#7 type"))))
399
400 (defun mm-view-pkcs7-decrypt (handle)
401   (insert-buffer (mm-handle-buffer handle))
402   (goto-char (point-min))
403   (insert "MIME-Version: 1.0\n")
404   (mm-insert-headers "application/pkcs7-mime" "base64" "smime.p7m")
405   (smime-decrypt-region
406    (point-min) (point-max)
407    (if (= (length smime-keys) 1)
408        (cadar smime-keys)
409      (smime-get-key-by-email
410       (completing-read "Decrypt this part with which key? "
411                        smime-keys nil nil
412                        (and (listp (car-safe smime-keys))
413                             (caar smime-keys)))))))
414
415 (provide 'mm-view)
416
417 ;;; mm-view.el ends here