1 ;;; mm-decode.el --- Functions for decoding MIME things
2 ;; Copyright (C) 1998 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
31 ;;; Convenience macros.
33 (defmacro mm-handle-buffer (handle)
35 (defmacro mm-handle-type (handle)
37 (defmacro mm-handle-encoding (handle)
39 (defmacro mm-handle-undisplayer (handle)
41 (defmacro mm-handle-set-undisplayer (handle function)
42 `(setcar (nthcdr 3 ,handle) ,function))
43 (defmacro mm-handle-disposition (handle)
45 (defmacro mm-handle-description (handle)
48 (defvar mm-inline-media-tests
49 '(("image/jpeg" mm-inline-image (featurep 'jpeg))
50 ("image/png" mm-inline-image (featurep 'png))
51 ("image/gif" mm-inline-image (featurep 'gif))
52 ("image/tiff" mm-inline-image (featurep 'tiff))
53 ("image/xbm" mm-inline-image (eq (device-type) 'x))
54 ("image/xpm" mm-inline-image (featurep 'xpm))
55 ("image/bmp" mm-inline-image (featurep 'bmp))
56 ("text/plain" mm-inline-text t)
57 ("text/enriched" mm-inline-text t)
58 ("text/richtext" mm-inline-text t)
59 ("text/html" mm-inline-text (locate-library "w3"))
60 ("message/delivery-status" mm-inline-text t)
61 ("audio/wav" mm-inline-audio
62 (and (or (featurep 'nas-sound) (featurep 'native-sound))
63 (device-sound-enabled-p)))
64 ("audio/au" mm-inline-audio
65 (and (or (featurep 'nas-sound) (featurep 'native-sound))
66 (device-sound-enabled-p))))
67 "Alist of media types/test that say whether the media types can be displayed inline.")
69 (defvar mm-user-display-methods
70 '(("image/.*" . inline)
72 ("message/delivery-status" . inline)))
74 (defvar mm-user-automatic-display
75 '("text/plain" "text/enriched" "text/richtext" "text/html" "image/gif"
76 "message/delivery-status" "multipart/.*"))
78 (defvar mm-alternative-precedence
79 '("text/plain" "text/enriched" "text/richtext" "text/html")
80 "List that describes the precedence of alternative parts.")
82 (defvar mm-tmp-directory "/tmp/"
83 "Where mm will store its temporary files.")
85 ;;; Internal variables.
87 (defvar mm-dissection-list nil)
88 (defvar mm-last-shell-command "")
89 (defvar mm-content-id-alist nil)
93 (defun mm-dissect-buffer (&optional no-strict-mime)
94 "Dissect the current buffer and return a list of MIME handles."
96 (let (ct ctl type subtype cte cd description id result)
99 (when (and (or no-strict-mime
100 (mail-fetch-field "mime-version"))
101 (setq ct (mail-fetch-field "content-type")))
102 (setq ctl (condition-case () (mail-header-parse-content-type ct)
104 cte (mail-fetch-field "content-transfer-encoding")
105 cd (mail-fetch-field "content-disposition")
106 description (mail-fetch-field "content-description")
107 id (mail-fetch-field "content-id"))))
109 (mm-dissect-singlepart '("text/plain") nil no-strict-mime nil nil)
110 (setq type (split-string (car ctl) "/"))
111 (setq subtype (cadr type)
116 ((equal type "multipart")
117 (cons (car ctl) (mm-dissect-multipart ctl)))
119 (mm-dissect-singlepart
121 (and cte (intern (downcase (mail-header-remove-whitespace
122 (mail-header-remove-comments
125 (and cd (condition-case ()
126 (mail-header-parse-content-disposition cd)
129 (push (cons id result) mm-content-id-alist))
132 (defun mm-dissect-singlepart (ctl cte &optional force cdl description)
134 (not (equal "text/plain" (car ctl))))
135 (let ((res (list (mm-copy-to-buffer) ctl cte nil cdl description)))
136 (push (car res) mm-dissection-list)
139 (defun mm-remove-all-parts ()
140 "Remove all MIME handles."
142 (mapcar 'mm-remove-part mm-dissection-list)
143 (setq mm-dissection-list nil))
145 (defun mm-dissect-multipart (ctl)
146 (goto-char (point-min))
147 (let* ((boundary (concat "\n--" (mail-content-type-get ctl 'boundary)))
148 (close-delimiter (concat boundary "--[ \t]*$"))
151 (goto-char (point-max))
152 (if (re-search-backward close-delimiter nil t)
155 (while (search-forward boundary end t)
156 (goto-char (match-beginning 0))
160 (narrow-to-region start (point))
161 (setq parts (nconc (list (mm-dissect-buffer t)) parts)))))
163 (setq start (point)))
167 (narrow-to-region start end)
168 (setq parts (nconc (list (mm-dissect-buffer t)) parts)))))
171 (defun mm-copy-to-buffer ()
172 "Copy the contents of the current buffer to a fresh buffer."
174 (let ((obuf (current-buffer))
176 (goto-char (point-min))
177 (search-forward "\n\n" nil t)
179 (set-buffer (generate-new-buffer " *mm*"))
180 (insert-buffer-substring obuf beg)
183 (defun mm-inlinable-part-p (type)
184 "Say whether TYPE can be displayed inline."
185 (eq (mm-user-method type) 'inline))
187 (defun mm-display-part (handle &optional no-default)
188 "Display the MIME part represented by HANDLE."
190 (mailcap-parse-mailcaps)
191 (if (mm-handle-displayed-p handle)
192 (mm-remove-part handle)
193 (let* ((type (car (mm-handle-type handle)))
194 (method (mailcap-mime-info type))
195 (user-method (mm-user-method type)))
196 (if (eq user-method 'inline)
199 (mm-display-inline handle))
200 (when (or user-method
204 handle (or user-method method 'mailcap-save-binary-file))))))))
206 (defun mm-display-external (handle method)
207 "Display HANDLE using METHOD."
208 (mm-with-unibyte-buffer
209 (insert-buffer-substring (mm-handle-buffer handle))
210 (mm-decode-content-transfer-encoding
211 (mm-handle-encoding handle) (car (mm-handle-type handle)))
212 (if (functionp method)
213 (let ((cur (current-buffer)))
214 (if (eq method 'mailcap-save-binary-file)
215 (set-buffer (generate-new-buffer "*mm*"))
216 (let ((win (get-buffer-window cur t)))
218 (select-window win)))
219 (switch-to-buffer (generate-new-buffer "*mm*")))
220 (buffer-disable-undo)
221 (mm-set-buffer-file-coding-system 'no-conversion)
222 (insert-buffer-substring cur)
223 (message "Viewing with %s" method)
224 (let ((mm (current-buffer)))
227 (mm-handle-set-undisplayer handle mm))))
228 (let* ((dir (make-temp-name (expand-file-name "emm." mm-tmp-directory)))
229 (filename (mail-content-type-get
230 (mm-handle-disposition handle) 'filename))
231 (needsterm (assoc "needsterm"
233 (car (mm-handle-type handle)) t)))
235 ;; We create a private sub-directory where we store our files.
237 (set-file-modes dir 448)
239 (setq file (expand-file-name (file-name-nondirectory filename)
241 (setq file (make-temp-name (expand-file-name "mm." dir))))
242 (write-region (point-min) (point-max)
243 file nil 'nomesg nil 'no-conversion)
244 (message "Viewing with %s" method)
248 (start-process "*display*" nil
250 "-e" shell-file-name "-c"
252 (mm-quote-arg file)))
253 (start-process "*display*" (generate-new-buffer "*mm*")
256 (mm-quote-arg file)))))
257 (mm-handle-set-undisplayer handle (cons file process)))
258 (message "Displaying %s..." (format method file))))))
260 (defun mm-remove-parts (handles)
261 "Remove the displayed MIME parts represented by HANDLE."
262 (if (and (listp handles)
263 (bufferp (car handles)))
264 (mm-remove-part handles)
266 (while (setq handle (pop handles))
271 (stringp (car handle)))
272 (mm-remove-parts (cdr handle)))
274 (mm-remove-part handle)))))))
276 (defun mm-destroy-parts (handles)
277 "Remove the displayed MIME parts represented by HANDLE."
278 (if (and (listp handles)
279 (bufferp (car handles)))
280 (mm-destroy-part handles)
282 (while (setq handle (pop handles))
287 (stringp (car handle)))
288 (mm-destroy-parts (cdr handle)))
290 (mm-destroy-part handle)))))))
292 (defun mm-remove-part (handle)
293 "Remove the displayed MIME part represented by HANDLE."
295 (let ((object (mm-handle-undisplayer handle)))
298 ;; Internally displayed part.
299 ((mm-annotationp object)
300 (delete-annotation object))
301 ((or (functionp object)
303 (eq (car object) 'lambda)))
305 ;; Externally displayed part.
308 (delete-file (car object))
311 (delete-directory (file-name-directory (car object)))
314 (kill-process (cdr object))
317 (when (buffer-live-p object)
318 (kill-buffer object))))
320 (mm-handle-set-undisplayer handle nil))))
322 (defun mm-display-inline (handle)
323 (let* ((type (car (mm-handle-type handle)))
324 (function (cadr (assoc type mm-inline-media-tests))))
325 (funcall function handle)
326 (goto-char (point-min))))
328 (defun mm-inlinable-p (type)
329 "Say whether TYPE can be displayed inline."
330 (let ((alist mm-inline-media-tests)
333 (when (equal type (caar alist))
334 (setq test (caddar alist)
336 (setq test (eval test)))
340 (defun mm-user-method (type)
341 "Return the user-defined method for TYPE."
342 (let ((methods mm-user-display-methods)
344 (while (setq method (pop methods))
345 (when (string-match (car method) type)
346 (when (or (not (eq (cdr method) 'inline))
347 (mm-inlinable-p type))
348 (setq result (cdr method)
352 (defun mm-automatic-display-p (type)
353 "Return the user-defined method for TYPE."
354 (let ((methods mm-user-automatic-display)
356 (while (setq method (pop methods))
357 (when (string-match method type)
362 (defun add-mime-display-method (type method)
363 "Make parts of TYPE be displayed with METHOD.
364 This overrides entries in the mailcap file."
365 (push (cons type method) mm-user-display-methods))
367 (defun mm-destroy-part (handle)
368 "Destroy the data structures connected to HANDLE."
370 (mm-remove-part handle)
371 (when (buffer-live-p (mm-handle-buffer handle))
372 (kill-buffer (mm-handle-buffer handle)))))
374 (defun mm-handle-displayed-p (handle)
375 "Say whether HANDLE is displayed or not."
376 (mm-handle-undisplayer handle))
378 (defun mm-quote-arg (arg)
379 "Return a version of ARG that is safe to evaluate in a shell."
380 (let ((pos 0) new-pos accum)
381 ;; *** bug: we don't handle newline characters properly
382 (while (setq new-pos (string-match "[!`\"$\\& \t{} ]" arg pos))
383 (push (substring arg pos new-pos) accum)
385 (push (list (aref arg new-pos)) accum)
386 (setq pos (1+ new-pos)))
389 (apply 'concat (nconc (nreverse accum) (list (substring arg pos)))))))
392 ;;; Functions for outputting parts
395 (defun mm-get-part (handle)
396 "Return the contents of HANDLE as a string."
397 (mm-with-unibyte-buffer
398 (insert-buffer-substring (mm-handle-buffer handle))
399 (mm-decode-content-transfer-encoding
400 (mm-handle-encoding handle)
401 (car (mm-handle-type handle)))
404 (defvar mm-default-directory nil)
406 (defun mm-save-part (handle)
407 "Write HANDLE to a file."
408 (let* ((name (mail-content-type-get (mm-handle-type handle) 'name))
409 (filename (mail-content-type-get
410 (mm-handle-disposition handle) 'filename))
413 (setq filename (file-name-nondirectory filename)))
415 (read-file-name "Save MIME part to: "
417 (or filename name "")
418 (or mm-default-directory default-directory))))
419 (setq mm-default-directory (file-name-directory file))
420 (mm-with-unibyte-buffer
421 (insert-buffer-substring (mm-handle-buffer handle))
422 (mm-decode-content-transfer-encoding
423 (mm-handle-encoding handle)
424 (car (mm-handle-type handle)))
425 (when (or (not (file-exists-p file))
426 (yes-or-no-p (format "File %s already exists; overwrite? "
428 (write-region (point-min) (point-max) file)))))
430 (defun mm-pipe-part (handle)
431 "Pipe HANDLE to a process."
432 (let* ((name (mail-content-type-get (mm-handle-type handle) 'name))
434 (read-string "Shell command on MIME part: " mm-last-shell-command)))
435 (mm-with-unibyte-buffer
436 (insert-buffer-substring (mm-handle-buffer handle))
437 (mm-decode-content-transfer-encoding
438 (mm-handle-encoding handle)
439 (car (mm-handle-type handle)))
440 (shell-command-on-region (point-min) (point-max) command nil))))
442 (defun mm-interactively-view-part (handle)
443 "Display HANDLE using METHOD."
444 (let* ((type (car (mm-handle-type handle)))
446 (mapcar (lambda (i) (list (cdr (assoc 'viewer i))))
447 (mailcap-mime-info type 'all)))
448 (method (completing-read "Viewer: " methods)))
449 (mm-display-external (copy-sequence handle) method)))
451 (defun mm-preferred-alternative (handles &optional preferred)
452 "Say which of HANDLES are preferred."
453 (let ((prec (if preferred (list preferred) mm-alternative-precedence))
455 (while (setq p (pop prec))
459 (if (stringp (caar h))
461 (car (mm-handle-type (car h)))))
462 (when (and (equal p type)
463 (mm-automatic-display-p type)
464 (or (stringp (caar h))
465 (not (mm-handle-disposition (car h)))
466 (equal (car (mm-handle-disposition (car h)))
474 (defun mm-get-content-id (id)
475 "Return the handle(s) referred to by ID."
476 (cdr (assoc id mm-content-id-alist)))
480 ;; mm-decode.el ends here