1 ;;; mm-view.el --- functions for viewing MIME objects
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; This file is part of GNU Emacs.
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)
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.
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.
26 (eval-when-compile (require 'cl))
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)))
40 (defvar mm-text-html-renderer-alist
41 '((w3 . mm-inline-text-html-render-with-w3)
42 (w3m . mm-inline-text-html-render-with-w3m)
43 (links mm-inline-render-with-file
44 mm-links-remove-leading-blank
46 (lynx mm-inline-render-with-stdin nil
47 "lynx" "-dump" "-force_html" "-stdin"))
48 "The attributes of renderer types for text/html.")
50 (defvar mm-text-html-washer-alist
51 '((w3 . gnus-article-wash-html-with-w3)
52 (w3m . gnus-article-wash-html-with-w3m)
53 (links mm-inline-wash-with-file
54 mm-links-remove-leading-blank
56 (lynx mm-inline-wash-with-stdin nil
57 "lynx" "-dump" "-force_html" "-stdin"))
58 "The attributes of washer types for text/html.")
60 ;;; Internal variables.
63 ;;; Functions for displaying various formats inline
66 (defun mm-inline-image-emacs (handle)
67 (let ((b (point-marker))
70 (put-image (mm-get-image handle) b)
71 (mm-handle-set-undisplayer
73 `(lambda () (remove-images ,b (1+ ,b))))))
75 (defun mm-inline-image-xemacs (handle)
79 (annot (make-annotation (mm-get-image handle) nil 'text))
81 (mm-handle-set-undisplayer
84 (let (buffer-read-only)
85 (delete-annotation ,annot)
86 (delete-region ,(set-marker (make-marker) b)
87 ,(set-marker (make-marker) (point))))))
88 (set-extent-property annot 'mm t)
89 (set-extent-property annot 'duplicable t)))
92 (if (featurep 'xemacs)
93 (defalias 'mm-inline-image 'mm-inline-image-xemacs)
94 (defalias 'mm-inline-image 'mm-inline-image-emacs)))
96 (defvar mm-w3-setup nil)
104 (setq mm-w3-setup t)))
106 (defun mm-inline-text-html-render-with-w3 (handle)
108 (let ((text (mm-get-part handle))
110 (url-standalone-mode t)
111 (url-gateway-unplugged t)
112 (w3-honor-stylesheets nil)
113 (w3-delay-image-loads t)
115 (url-generic-parse-url (format "cid:%s" (mm-handle-id handle))))
116 (width (window-width))
117 (charset (mail-content-type-get
118 (mm-handle-type handle) 'charset)))
122 (narrow-to-region b (point))
123 (goto-char (point-min))
124 (if (or (and (boundp 'w3-meta-content-type-charset-regexp)
126 w3-meta-content-type-charset-regexp nil t))
127 (and (boundp 'w3-meta-charset-content-type-regexp)
129 w3-meta-charset-content-type-regexp nil t)))
131 (or (let ((bsubstr (buffer-substring-no-properties
134 (if (fboundp 'w3-coding-system-for-mime-charset)
135 (w3-coding-system-for-mime-charset bsubstr)
136 (mm-charset-to-coding-system bsubstr)))
138 (delete-region (point-min) (point-max))
139 (insert (mm-decode-string text charset))
140 (save-window-excursion
142 (let ((w3-strict-width width)
143 ;; Don't let w3 set the global version of
145 (fill-column fill-column))
147 (w3-region (point-min) (point-max))
149 (delete-region (point-min) (point-max))
151 (charset (mail-content-type-get
152 (mm-handle-type handle) 'charset)))
153 (if (or (eq charset 'gnus-decoded)
154 (eq mail-parse-charset 'gnus-decoded))
156 (narrow-to-region (point) (point))
157 (mm-insert-part handle)
158 (goto-char (point-max)))
159 (insert (mm-decode-string (mm-get-part handle)
162 "Error while rendering html; showing as text/plain"))))))
163 (mm-handle-set-undisplayer
166 (let (buffer-read-only)
167 (if (functionp 'remove-specifier)
168 (mapcar (lambda (prop)
170 (face-property 'default prop)
172 '(background background-pixmap foreground)))
173 (delete-region ,(point-min-marker)
174 ,(point-max-marker)))))))))
176 (defvar mm-w3m-mode-map nil
177 "Local keymap for inlined text/html part rendered by emacs-w3m. It will
178 be different from `w3m-mode-map' to use in the article buffer.")
180 (defvar mm-w3m-mode-command-alist
188 (w3m-antenna-add-current-url)
189 (w3m-bookmark-add-current-url)
190 (w3m-bookmark-add-this-url)
196 (w3m-edit-current-url)
200 (w3m-goto-url-new-session)
202 (w3m-history-restore-position)
203 (w3m-history-store-position)
206 (w3m-previous-buffer)
208 (w3m-redisplay-with-charset)
209 (w3m-reload-this-page)
210 (w3m-scroll-down-or-previous-url)
211 (w3m-scroll-up-or-next-url)
216 (w3m-view-parent-page)
217 (w3m-view-previous-page)
220 "Alist of commands to use for emacs-w3m in the article buffer. Each
221 element looks like (FROM-COMMAND . TO-COMMAND); FROM-COMMAND should be
222 registered in `w3m-mode-map' which will be substituted by TO-COMMAND
223 in `mm-w3m-mode-map'. If TO-COMMAND is nil, an article command key
224 will not be substituted.")
226 (defvar mm-w3m-mode-dont-bind-keys (list [up] [right] [left] [down])
227 "List of keys which should not be bound for the emacs-w3m commands.")
229 (defvar mm-w3m-setup nil
230 "Whether gnus-article-mode has been setup to use emacs-w3m.")
232 (defun mm-setup-w3m ()
233 "Setup gnus-article-mode to use emacs-w3m."
236 (unless mm-w3m-mode-map
237 (setq mm-w3m-mode-map (copy-keymap w3m-mode-map))
238 (dolist (def mm-w3m-mode-command-alist)
240 (substitute-key-definition (car def) (cdr def) mm-w3m-mode-map)
242 (dolist (key mm-w3m-mode-dont-bind-keys)
244 (define-key mm-w3m-mode-map key nil)
246 (unless (assq 'gnus-article-mode w3m-cid-retrieve-function-alist)
247 (push (cons 'gnus-article-mode 'mm-w3m-cid-retrieve)
248 w3m-cid-retrieve-function-alist))
249 (setq mm-w3m-setup t)))
251 (defun mm-w3m-cid-retrieve (url &rest args)
252 "Insert a content pointed by URL if it has the cid: scheme."
253 (when (string-match "\\`cid:" url)
254 (setq url (concat "<" (substring url (match-end 0)) ">"))
256 (dolist (handle (with-current-buffer w3m-current-buffer
257 gnus-article-mime-handles))
258 (when (and (listp handle)
259 (equal url (mm-handle-id handle)))
260 (mm-insert-part handle)
261 (throw 'found-handle (mm-handle-media-type handle)))))))
263 (defun mm-inline-text-html-render-with-w3m (handle)
264 "Render a text/html part using emacs-w3m."
266 (let ((text (mm-get-part handle))
268 (charset (mail-content-type-get (mm-handle-type handle) 'charset)))
272 (narrow-to-region b (point))
273 (goto-char (point-min))
274 (when (re-search-forward w3m-meta-content-type-charset-regexp nil t)
275 (setq charset (or (w3m-charset-to-coding-system (match-string 2))
278 (delete-region (point-min) (point-max))
279 (insert (mm-decode-string text charset)))
280 (let ((w3m-safe-url-regexp (if mm-inline-text-html-with-images
283 (w3m-display-inline-images mm-inline-text-html-with-images)
285 (w3m-region (point-min) (point-max)))
286 (when mm-inline-text-html-with-w3m-keymap
288 (point-min) (point-max)
289 (append '(mm-inline-text-html-with-w3m t)
290 (gnus-local-map-property mm-w3m-mode-map)))))
291 (mm-handle-set-undisplayer
294 (let (buffer-read-only)
295 (if (functionp 'remove-specifier)
296 (mapcar (lambda (prop)
298 (face-property 'default prop)
300 '(background background-pixmap foreground)))
301 (delete-region ,(point-min-marker)
302 ,(point-max-marker))))))))
304 (defun mm-links-remove-leading-blank ()
305 ;; Delete the annoying three spaces preceding each line of links
307 (goto-char (point-min))
308 (while (re-search-forward "^ " nil t)
309 (delete-region (match-beginning 0) (match-end 0))))
311 (defun mm-inline-wash-with-file (post-func cmd &rest args)
312 (let ((file (make-temp-name
313 (expand-file-name "mm" mm-tmp-directory))))
314 (let ((coding-system-for-write 'binary))
315 (write-region (point-min) (point-max) file nil 'silent))
316 (delete-region (point-min) (point-max))
318 (apply 'call-process cmd nil t nil (mapcar 'eval args))
320 (and post-func (funcall post-func))))
322 (defun mm-inline-wash-with-stdin (post-func cmd &rest args)
323 (let ((coding-system-for-write 'binary))
324 (apply 'call-process-region (point-min) (point-max)
326 (and post-func (funcall post-func)))
328 (defun mm-inline-render-with-file (handle post-func cmd &rest args)
329 (let ((source (mm-get-part handle)))
332 (mm-with-unibyte-buffer
334 (apply 'mm-inline-wash-with-file post-func cmd args)
337 (defun mm-inline-render-with-stdin (handle post-func cmd &rest args)
338 (let ((source (mm-get-part handle)))
341 (mm-with-unibyte-buffer
343 (apply 'mm-inline-wash-with-stdin post-func cmd args)
346 (defun mm-inline-render-with-function (handle func &rest args)
347 (let ((source (mm-get-part handle)))
350 (mm-with-unibyte-buffer
355 (defun mm-inline-text-html (handle)
356 (let* ((func (or mm-inline-text-html-renderer mm-text-html-renderer))
357 (entry (assq func mm-text-html-renderer-alist))
360 (setq func (cdr entry)))
362 ((gnus-functionp func)
363 (funcall func handle))
365 (apply (car func) handle (cdr func))))))
367 (defun mm-inline-text-vcard (handle)
368 (let (buffer-read-only)
373 (if (fboundp 'vcard-pretty-print)
374 (vcard-pretty-print (mm-get-part handle))
376 (vcard-parse-string (mm-get-part handle)
377 'vcard-standard-filter))))))))
379 (defun mm-inline-text (handle)
381 (type (mm-handle-media-subtype handle))
382 (charset (mail-content-type-get
383 (mm-handle-type handle) 'charset))
385 (if (or (eq charset 'gnus-decoded)
386 ;; This is probably not entirely correct, but
387 ;; makes rfc822 parts with embedded multiparts work.
388 (eq mail-parse-charset 'gnus-decoded))
390 (narrow-to-region (point) (point))
391 (mm-insert-part handle)
392 (goto-char (point-max)))
393 (insert (mm-decode-string (mm-get-part handle) charset)))
394 (when (and (equal type "plain")
395 (equal (cdr (assoc 'format (mm-handle-type handle)))
398 (narrow-to-region b (point))
401 (goto-char (point-max))))
403 (narrow-to-region b (point))
404 (set-text-properties (point-min) (point-max) nil)
405 (when (or (equal type "enriched")
406 (equal type "richtext"))
407 (enriched-decode (point-min) (point-max)))
408 (mm-handle-set-undisplayer
411 (let (buffer-read-only)
412 (delete-region ,(point-min-marker)
413 ,(point-max-marker))))))))
415 (defun mm-insert-inline (handle text)
416 "Insert TEXT inline from HANDLE."
419 (mm-handle-set-undisplayer
422 (let (buffer-read-only)
423 (delete-region ,(set-marker (make-marker) b)
424 ,(set-marker (make-marker) (point))))))))
426 (defun mm-inline-audio (handle)
427 (message "Not implemented"))
429 (defun mm-view-sound-file ()
430 (message "Not implemented"))
432 (defun mm-w3-prepare-buffer ()
434 (let ((url-standalone-mode t)
435 (url-gateway-unplugged t)
436 (w3-honor-stylesheets nil)
437 (w3-delay-image-loads t))
438 (w3-prepare-buffer)))
440 (defun mm-view-message ()
441 (mm-enable-multibyte)
443 (let (gnus-article-mime-handles)
444 ;; Double decode problem may happen. See mm-inline-message.
445 (run-hooks 'gnus-article-decode-hook)
446 (gnus-article-prepare-display)
447 (setq handles gnus-article-mime-handles))
449 (setq gnus-article-mime-handles
450 (mm-merge-handles gnus-article-mime-handles handles))))
452 (goto-char (point-min)))
454 (defun mm-inline-message (handle)
457 (charset (mail-content-type-get
458 (mm-handle-type handle) 'charset))
459 gnus-displaying-mime handles)
462 (setq charset (intern (downcase charset)))
463 (when (eq charset 'us-ascii)
467 (narrow-to-region b b)
468 (mm-insert-part handle)
469 (let (gnus-article-mime-handles
470 ;; disable prepare hook
471 gnus-article-prepare-hook
472 (gnus-newsgroup-charset
473 (or charset gnus-newsgroup-charset)))
474 (run-hooks 'gnus-article-decode-hook)
475 (gnus-article-prepare-display)
476 (setq handles gnus-article-mime-handles))
477 (goto-char (point-min))
480 (goto-char (point-max))
483 (insert "----------\n\n")
485 (setq gnus-article-mime-handles
486 (mm-merge-handles gnus-article-mime-handles handles)))
487 (mm-handle-set-undisplayer
490 (let (buffer-read-only)
491 (if (fboundp 'remove-specifier)
492 ;; This is only valid on XEmacs.
493 (mapcar (lambda (prop)
495 (face-property 'default prop) (current-buffer)))
496 '(background background-pixmap foreground)))
497 (delete-region ,(point-min-marker) ,(point-max-marker)))))))))
499 (defun mm-display-inline-fontify (handle mode)
501 ;; XEmacs @#$@ version of font-lock refuses to fully turn itself
502 ;; on for buffers whose name begins with " ". That's why we use
503 ;; save-current-buffer/get-buffer-create rather than
506 (set-buffer (generate-new-buffer "*fontification*"))
509 (buffer-disable-undo)
510 (mm-insert-part handle)
513 (let ((font-lock-verbose nil))
514 ;; I find font-lock a bit too verbose.
515 (font-lock-fontify-buffer))
516 ;; By default, XEmacs font-lock uses non-duplicable text
517 ;; properties. This code forces all the text properties
518 ;; to be copied along with the text.
519 (when (fboundp 'extent-list)
520 (map-extents (lambda (ext ignored)
521 (set-extent-property ext 'duplicable t)
523 nil nil nil nil nil 'text-prop))
524 (setq text (buffer-string)))
525 (kill-buffer (current-buffer))))
526 (mm-insert-inline handle text)))
528 ;; Shouldn't these functions check whether the user even wants to use
529 ;; font-lock? At least under XEmacs, this fontification is pretty
530 ;; much unconditional. Also, it would be nice to change for the size
531 ;; of the fontified region.
533 (defun mm-display-patch-inline (handle)
534 (mm-display-inline-fontify handle 'diff-mode))
536 (defun mm-display-elisp-inline (handle)
537 (mm-display-inline-fontify handle 'emacs-lisp-mode))
539 ;; id-signedData OBJECT IDENTIFIER ::= { iso(1) member-body(2)
540 ;; us(840) rsadsi(113549) pkcs(1) pkcs7(7) 2 }
541 (defvar mm-pkcs7-signed-magic
542 (mm-string-as-unibyte
544 (mapcar 'char-to-string
545 (list ?\x30 ?\x5c ?\x28 ?\x80 ?\x5c ?\x7c ?\x81 ?\x2e ?\x5c
546 ?\x7c ?\x82 ?\x2e ?\x2e ?\x5c ?\x7c ?\x83 ?\x2e ?\x2e
547 ?\x2e ?\x5c ?\x29 ?\x06 ?\x09 ?\x5c ?\x2a ?\x86 ?\x48
548 ?\x86 ?\xf7 ?\x0d ?\x01 ?\x07 ?\x02)))))
550 ;; id-envelopedData OBJECT IDENTIFIER ::= { iso(1) member-body(2)
551 ;; us(840) rsadsi(113549) pkcs(1) pkcs7(7) 3 }
552 (defvar mm-pkcs7-enveloped-magic
553 (mm-string-as-unibyte
555 (mapcar 'char-to-string
556 (list ?\x30 ?\x5c ?\x28 ?\x80 ?\x5c ?\x7c ?\x81 ?\x2e ?\x5c
557 ?\x7c ?\x82 ?\x2e ?\x2e ?\x5c ?\x7c ?\x83 ?\x2e ?\x2e
558 ?\x2e ?\x5c ?\x29 ?\x06 ?\x09 ?\x5c ?\x2a ?\x86 ?\x48
559 ?\x86 ?\xf7 ?\x0d ?\x01 ?\x07 ?\x03)))))
561 (defun mm-view-pkcs7-get-type (handle)
562 (mm-with-unibyte-buffer
563 (mm-insert-part handle)
564 (cond ((looking-at mm-pkcs7-enveloped-magic)
566 ((looking-at mm-pkcs7-signed-magic)
569 (error "Could not identify PKCS#7 type")))))
571 (defun mm-view-pkcs7 (handle)
572 (case (mm-view-pkcs7-get-type handle)
573 (enveloped (mm-view-pkcs7-decrypt handle))
574 (otherwise (error "Unknown or unimplemented PKCS#7 type"))))
576 (defun mm-view-pkcs7-decrypt (handle)
577 (insert-buffer (mm-handle-buffer handle))
578 (goto-char (point-min))
579 (insert "MIME-Version: 1.0\n")
580 (mm-insert-headers "application/pkcs7-mime" "base64" "smime.p7m")
581 (smime-decrypt-region
582 (point-min) (point-max)
583 (if (= (length smime-keys) 1)
585 (smime-get-key-by-email
586 (completing-read "Decrypt this part with which key? "
588 (and (listp (car-safe smime-keys))
589 (caar smime-keys)))))))
593 ;;; mm-view.el ends here