Importing pgnus-0.55
[elisp/gnus.git-] / lisp / mm-decode.el
index 4c4d23f..196f8cc 100644 (file)
 
 ;;; Code:
 
-(require 'drums)
+(require 'mail-parse)
 (require 'mailcap)
 (require 'mm-bodies)
 
+;;; Convenience macros.
+
+(defmacro mm-handle-buffer (handle)
+  `(nth 0 ,handle))
+(defmacro mm-handle-type (handle)
+  `(nth 1 ,handle))
+(defmacro mm-handle-encoding (handle)
+  `(nth 2 ,handle))
+(defmacro mm-handle-undisplayer (handle)
+  `(nth 3 ,handle))
+(defmacro mm-handle-set-undisplayer (handle function)
+  `(setcar (nthcdr 3 ,handle) ,function))
+(defmacro mm-handle-disposition (handle)
+  `(nth 4 ,handle))
+(defmacro mm-handle-description (handle)
+  `(nth 5 ,handle))
+
 (defvar mm-inline-media-tests
-  '(("image/jpeg" mm-inline-image (featurep 'jpeg))
-    ("image/png" mm-inline-image (featurep 'png))
-    ("image/gif" mm-inline-image (featurep 'gif))
-    ("image/tiff" mm-inline-image (featurep 'tiff))
-    ("image/xbm" mm-inline-image (eq (device-type) 'x))
-    ("image/xpm" mm-inline-image (featurep 'xpm))
-    ("image/bmp" mm-inline-image (featurep 'bmp))
+  '(("image/jpeg" mm-inline-image
+     (and window-system (featurep 'jpeg) (mm-image-fit-p handle)))
+    ("image/png" mm-inline-image
+     (and window-system (featurep 'png) (mm-image-fit-p handle)))
+    ("image/gif" mm-inline-image
+     (and window-system (featurep 'gif) (mm-image-fit-p handle)))
+    ("image/tiff" mm-inline-image
+     (and window-system (featurep 'tiff) (mm-image-fit-p handle)))
+    ("image/xbm" mm-inline-image
+     (and window-system (fboundp 'device-type)
+         (eq (device-type) 'x)))
+    ("image/xpm" mm-inline-image
+     (and window-system (featurep 'xpm)))
+    ("image/bmp" mm-inline-image
+     (and window-system (featurep 'bmp)))
     ("text/plain" mm-inline-text t)
-    ("text/html" mm-inline-text (featurep 'w3))
+    ("text/enriched" mm-inline-text t)
+    ("text/richtext" mm-inline-text t)
+    ("text/html" mm-inline-text (locate-library "w3"))
+    ("message/delivery-status" mm-inline-text t)
     ("audio/wav" mm-inline-audio
      (and (or (featurep 'nas-sound) (featurep 'native-sound))
          (device-sound-enabled-p)))
 
 (defvar mm-user-display-methods
   '(("image/.*" . inline)
-    ("text/.*" . inline)))
+    ("text/.*" . inline)
+    ("message/delivery-status" . inline)))
 
 (defvar mm-user-automatic-display
-  '("text/plain" "image/gif"))
+  '("text/plain" "text/enriched" "text/richtext" "text/html" 
+    "image/.*" "message/delivery-status" "multipart/.*"))
+
+(defvar mm-alternative-precedence
+  '("image/jpeg" "image/gif" "text/html" "text/enriched"
+    "text/richtext" "text/plain")
+  "List that describes the precedence of alternative parts.")
 
 (defvar mm-tmp-directory "/tmp/"
   "Where mm will store its temporary files.")
 
 (defvar mm-dissection-list nil)
 (defvar mm-last-shell-command "")
+(defvar mm-content-id-alist nil)
+
+;;; The functions.
 
 (defun mm-dissect-buffer (&optional no-strict-mime)
   "Dissect the current buffer and return a list of MIME handles."
   (save-excursion
-    (let (ct ctl type subtype cte)
+    (let (ct ctl type subtype cte cd description id result)
       (save-restriction
-       (drums-narrow-to-header)
+       (mail-narrow-to-head)
        (when (and (or no-strict-mime
                       (mail-fetch-field "mime-version"))
                   (setq ct (mail-fetch-field "content-type")))
-         (setq ctl (drums-parse-content-type ct))
-         (setq cte (mail-fetch-field "content-transfer-encoding"))))
-      (when ctl
+         (setq ctl (condition-case () (mail-header-parse-content-type ct)
+                     (error nil))
+               cte (mail-fetch-field "content-transfer-encoding")
+               cd (mail-fetch-field "content-disposition")
+               description (mail-fetch-field "content-description")
+               id (mail-fetch-field "content-id"))))
+      (if (not ctl)
+         (mm-dissect-singlepart
+          '("text/plain") nil no-strict-mime nil description)
        (setq type (split-string (car ctl) "/"))
        (setq subtype (cadr type)
              type (pop type))
-       (cond
-        ((equal type "multipart")
-         (mm-dissect-multipart ctl))
-        (t
-         (mm-dissect-singlepart ctl (and cte (intern cte))
-                                no-strict-mime)))))))
-
-(defun mm-dissect-singlepart (ctl cte &optional force)
+       (setq
+        result
+        (cond
+         ((equal type "multipart")
+          (cons (car ctl) (mm-dissect-multipart ctl)))
+         (t
+          (mm-dissect-singlepart
+           ctl
+           (and cte (intern (downcase (mail-header-remove-whitespace
+                                       (mail-header-remove-comments
+                                        cte)))))
+           no-strict-mime
+           (and cd (condition-case ()
+                       (mail-header-parse-content-disposition cd)
+                     (error nil)))
+           description))))
+       (when id
+         (when (string-match " *<\\(.*\\)> *" id)
+           (setq id (match-string 1 id)))
+         (push (cons id result) mm-content-id-alist))
+       result))))
+
+(defun mm-dissect-singlepart (ctl cte &optional force cdl description)
   (when (or force
            (not (equal "text/plain" (car ctl))))
-    (let ((res (list (list (mm-copy-to-buffer) ctl cte nil))))
+    (let ((res (list (mm-copy-to-buffer) ctl cte nil cdl description)))
       (push (car res) mm-dissection-list)
       res)))
 
 
 (defun mm-dissect-multipart (ctl)
   (goto-char (point-min))
-  (let ((boundary (concat "\n--" (drums-content-type-get ctl 'boundary)))
-       start parts end)
-    (while (search-forward boundary nil t)
-      (forward-line -1)
+  (let* ((boundary (concat "\n--" (mail-content-type-get ctl 'boundary)))
+       (close-delimiter (concat (regexp-quote boundary) "--[ \t]*$"))
+       start parts 
+       (end (save-excursion    
+              (goto-char (point-max))
+              (if (re-search-backward close-delimiter nil t)
+                  (match-beginning 0)
+                (point-max)))))
+    (while (search-forward boundary end t)
+      (goto-char (match-beginning 0))
       (when start
        (save-excursion
          (save-restriction
            (narrow-to-region start (point))
-           (setq parts (nconc (mm-dissect-buffer t) parts)))))
+           (setq parts (nconc (list (mm-dissect-buffer t)) parts)))))
       (forward-line 2)
       (setq start (point)))
+    (when start
+      (save-excursion
+       (save-restriction
+         (narrow-to-region start end)
+         (setq parts (nconc (list (mm-dissect-buffer t)) parts)))))
     (nreverse parts)))
 
 (defun mm-copy-to-buffer ()
     (let ((obuf (current-buffer))
          beg)
       (goto-char (point-min))
-      (search-forward "\n\n" nil t)
+      (search-forward-regexp "^\n" nil t)
       (setq beg (point))
       (set-buffer (generate-new-buffer " *mm*"))
       (insert-buffer-substring obuf beg)
       (current-buffer))))
 
-(defun mm-display-part (handle)
-  "Display the MIME part represented by HANDLE."
+(defun mm-inlinable-part-p (type)
+  "Say whether TYPE can be displayed inline."
+  (eq (mm-user-method type) 'inline))
+
+(defun mm-display-part (handle &optional no-default)
+  "Display the MIME part represented by HANDLE.
+Returns nil if the part is removed; inline if displayed inline;
+external if displayed external."
   (save-excursion
     (mailcap-parse-mailcaps)
-    (if (nth 3 handle)
+    (if (mm-handle-displayed-p handle)
        (mm-remove-part handle)
-      (let* ((type (caadr handle))
+      (let* ((type (car (mm-handle-type handle)))
             (method (mailcap-mime-info type))
             (user-method (mm-user-method type)))
        (if (eq user-method 'inline)
            (progn
              (forward-line 1)
              (mm-display-inline handle))
-         (mm-display-external handle (or user-method method)))))))
+         (when (or user-method
+                   method
+                   (not no-default))
+           (if (and (not user-method)
+                    (not method)
+                    (equal "text" (car (split-string type))))
+               (progn
+                 (mm-insert-inline handle (mm-get-part handle))
+                 'inline)
+             (mm-display-external
+              handle (or user-method method
+                         'mailcap-save-binary-file))
+             'external)))))))
 
 (defun mm-display-external (handle method)
   "Display HANDLE using METHOD."
   (mm-with-unibyte-buffer
-    (insert-buffer-substring (car handle))
-    (mm-decode-content-transfer-encoding (nth 2 handle))
+    (insert-buffer-substring (mm-handle-buffer handle))
+    (mm-decode-content-transfer-encoding
+     (mm-handle-encoding handle) (car (mm-handle-type handle)))
     (if (functionp method)
        (let ((cur (current-buffer)))
-         (switch-to-buffer (generate-new-buffer "*mm*"))
+         (if (eq method 'mailcap-save-binary-file)
+             (progn
+               (set-buffer (generate-new-buffer "*mm*"))
+               (setq method nil))
+           (let ((win (get-buffer-window cur t)))
+             (when win
+               (select-window win)))
+           (switch-to-buffer (generate-new-buffer "*mm*")))
+         (buffer-disable-undo)
+         (mm-set-buffer-file-coding-system mm-binary-coding-system)
          (insert-buffer-substring cur)
-         (funcall method)
-         (setcar (nthcdr 3 handle) (current-buffer)))
-      (let* ((file (make-temp-name (expand-file-name "emm." mm-tmp-directory)))
-            process)
-       (write-region (point-min) (point-max)
-                     file nil 'nomesg nil 'no-conversion)
-       (setq process
-             (start-process "*display*" nil shell-file-name
-                            "-c" (format method file)))
-       (setcar (nthcdr 3 handle) (cons file process))
+         (message "Viewing with %s" method)
+         (let ((mm (current-buffer)))
+           (unwind-protect
+               (if method
+                   (funcall method)
+                 (mm-save-part handle))
+             (mm-handle-set-undisplayer handle mm))))
+      (let* ((dir (make-temp-name (expand-file-name "emm." mm-tmp-directory)))
+            (filename (mail-content-type-get
+                       (mm-handle-disposition handle) 'filename))
+            (needsterm (assoc "needsterm"
+                              (mailcap-mime-info
+                               (car (mm-handle-type handle)) t)))
+            process file)
+       ;; We create a private sub-directory where we store our files.
+       (make-directory dir)
+       (set-file-modes dir 448)
+       (if filename
+           (setq file (expand-file-name (file-name-nondirectory filename)
+                                        dir))
+         (setq file (make-temp-name (expand-file-name "mm." dir))))
+       (write-region (point-min) (point-max) file nil 'nomesg)
+       (message "Viewing with %s" method)
+       (unwind-protect
+           (setq process
+                 (if needsterm
+                     (start-process "*display*" nil
+                                    "xterm"
+                                    "-e" shell-file-name "-c"
+                                    (format method
+                                            (mm-quote-arg file)))
+                   (start-process "*display*" (generate-new-buffer "*mm*")
+                                  shell-file-name
+                                  "-c" (format method
+                                               (mm-quote-arg file)))))
+         (mm-handle-set-undisplayer handle (cons file process)))
        (message "Displaying %s..." (format method file))))))
 
+(defun mm-remove-parts (handles)
+  "Remove the displayed MIME parts represented by HANDLE."
+  (if (and (listp handles)
+          (bufferp (car handles)))
+      (mm-remove-part handles)
+    (let (handle)
+      (while (setq handle (pop handles))
+       (cond
+        ((stringp handle)
+         )
+        ((and (listp handle)
+              (stringp (car handle)))
+         (mm-remove-parts (cdr handle)))
+        (t
+         (mm-remove-part handle)))))))
+
+(defun mm-destroy-parts (handles)
+  "Remove the displayed MIME parts represented by HANDLE."
+  (if (and (listp handles)
+          (bufferp (car handles)))
+      (mm-destroy-part handles)
+    (let (handle)
+      (while (setq handle (pop handles))
+       (cond
+        ((stringp handle)
+         )
+        ((and (listp handle)
+              (stringp (car handle)))
+         (mm-destroy-parts (cdr handle)))
+        (t
+         (mm-destroy-part handle)))))))
+
 (defun mm-remove-part (handle)
   "Remove the displayed MIME part represented by HANDLE."
-  (let ((object (nth 3 handle)))
-    (cond
-     ;; Internally displayed part.
-     ((mm-annotationp object)
-      (delete-annotation object))
-     ((or (functionp object)
-         (and (listp object)
-              (eq (car object) 'lambda)))
-      (funcall object))
-     ;; Externally displayed part.
-     ((consp object)
+  (when (listp handle)
+    (let ((object (mm-handle-undisplayer handle)))
       (condition-case ()
-         (delete-file (car object))
+         (cond
+          ;; Internally displayed part.
+          ((mm-annotationp object)
+           (delete-annotation object))
+          ((or (functionp object)
+               (and (listp object)
+                    (eq (car object) 'lambda)))
+           (funcall object))
+          ;; Externally displayed part.
+          ((consp object)
+           (condition-case ()
+               (delete-file (car object))
+             (error nil))
+           (condition-case ()
+               (delete-directory (file-name-directory (car object)))
+             (error nil))
+           (condition-case ()
+               (kill-process (cdr object))
+             (error nil)))
+          ((bufferp object)
+           (when (buffer-live-p object)
+             (kill-buffer object))))
        (error nil))
-      (condition-case ()
-         (kill-process (cdr object))
-       (error nil)))
-     ((bufferp object)
-      (when (buffer-live-p object)
-       (kill-buffer object))))
-    (setcar (nthcdr 3 handle) nil)))
+      (mm-handle-set-undisplayer handle nil))))
 
 (defun mm-display-inline (handle)
-  (let* ((type (caadr handle))
+  (let* ((type (car (mm-handle-type handle)))
         (function (cadr (assoc type mm-inline-media-tests))))
-    (funcall function handle)))
-        
+    (funcall function handle)
+    (goto-char (point-min))))
+
 (defun mm-inlinable-p (type)
   "Say whether TYPE can be displayed inline."
   (let ((alist mm-inline-media-tests)
   (let ((methods mm-user-automatic-display)
        method result)
     (while (setq method (pop methods))
-      (when (string-match method type)
+      (when (and (string-match method type)
+                (mm-inlinable-p type))
        (setq result t
              methods nil)))
     result))
@@ -229,15 +393,20 @@ This overrides entries in the mailcap file."
 
 (defun mm-destroy-part (handle)
   "Destroy the data structures connected to HANDLE."
-  (mm-remove-part handle)
-  (when (buffer-live-p (car handle))
-    (kill-buffer (car handle))))
-
+  (when (listp handle)
+    (mm-remove-part handle)
+    (when (buffer-live-p (mm-handle-buffer handle))
+      (kill-buffer (mm-handle-buffer handle)))))
+
+(defun mm-handle-displayed-p (handle)
+  "Say whether HANDLE is displayed or not."
+  (mm-handle-undisplayer handle))
+  
 (defun mm-quote-arg (arg)
   "Return a version of ARG that is safe to evaluate in a shell."
   (let ((pos 0) new-pos accum)
     ;; *** bug: we don't handle newline characters properly
-    (while (setq new-pos (string-match "[!`\"$\\& \t{}]" arg pos))
+    (while (setq new-pos (string-match "[;!`\"$\\& \t{} ]" arg pos))
       (push (substring arg pos new-pos) accum)
       (push "\\" accum)
       (push (list (aref arg new-pos)) accum)
@@ -247,85 +416,143 @@ This overrides entries in the mailcap file."
       (apply 'concat (nconc (nreverse accum) (list (substring arg pos)))))))
 
 ;;;
-;;; Functions for displaying various formats inline
+;;; Functions for outputting parts
 ;;;
 
-(defun mm-inline-image (handle)
-  (let ((type (cadr (split-string (caadr handle) "/")))
-       image)
-    (mm-with-unibyte-buffer
-      (insert-buffer-substring (car handle))
-      (mm-decode-content-transfer-encoding (nth 2 handle))
-      (setq image (make-image-specifier
-                  (vector (intern type) :data (buffer-string)))))
-    (let ((annot (make-annotation image nil 'text)))
-      (set-extent-property annot 'mm t)
-      (set-extent-property annot 'duplicable t)
-      (setcar (nthcdr 3 handle) annot))))
-
-(defun mm-inline-text (handle)
-  (let ((type (cadr (split-string (caadr handle) "/")))
-       text buffer-read-only)
-    (mm-with-unibyte-buffer
-      (insert-buffer-substring (car handle))
-      (mm-decode-content-transfer-encoding (nth 2 handle))
-      (setq text (buffer-string)))
-    (cond
-     ((equal type "plain")
-      (let ((b (point)))
-       (insert text)
-       (save-restriction
-         (narrow-to-region b (point))
-         (let ((charset (drums-content-type-get (nth 1 handle) 'charset)))
-           (when charset
-             (mm-decode-body charset nil)))
-         (setcar
-          (nthcdr 3 handle)
-          `(lambda ()
-             (let (buffer-read-only)
-               (delete-region ,(set-marker (make-marker) (point-min))
-                              ,(set-marker (make-marker) (point-max)))))))))
-     )))
-
-(defun mm-inline-audio (handle)
-  (message "Not implemented"))
+(defun mm-get-part (handle)
+  "Return the contents of HANDLE as a string."
+  (mm-with-unibyte-buffer
+    (insert-buffer-substring (mm-handle-buffer handle))
+    (mm-decode-content-transfer-encoding
+     (mm-handle-encoding handle)
+     (car (mm-handle-type handle)))
+    (buffer-string)))
 
-;;;
-;;; Functions for outputting parts
-;;;
+(defvar mm-default-directory nil)
 
 (defun mm-save-part (handle)
   "Write HANDLE to a file."
-  (let* ((name (drums-content-type-get (cadr handle) 'name))
-        (file (read-file-name "Save MIME part to: "
-                              (expand-file-name
-                               (or name "") default-directory))))
+  (let* ((name (mail-content-type-get (mm-handle-type handle) 'name))
+        (filename (mail-content-type-get
+                   (mm-handle-disposition handle) 'filename))
+        file)
+    (when filename
+      (setq filename (file-name-nondirectory filename)))
+    (setq file
+         (read-file-name "Save MIME part to: "
+                         (expand-file-name
+                          (or filename name "")
+                          (or mm-default-directory default-directory))))
+    (setq mm-default-directory (file-name-directory file))
     (mm-with-unibyte-buffer
-      (insert-buffer-substring (car handle))
-      (mm-decode-content-transfer-encoding (nth 2 handle))
+      (insert-buffer-substring (mm-handle-buffer handle))
+      (mm-decode-content-transfer-encoding
+       (mm-handle-encoding handle)
+       (car (mm-handle-type handle)))
       (when (or (not (file-exists-p file))
-               (yes-or-no-p (format "File %s already exists; overwrite? ")))
-       (write-region (point-min) (point-max) file)))))
+               (yes-or-no-p (format "File %s already exists; overwrite? "
+                                    file)))
+       ;; Now every coding system is 100% binary within mm-with-unibyte-buffer
+       ;; Is text still special?
+      (let ((coding-system-for-write
+             (if (equal "text" (car (split-string
+                                     (car (mm-handle-type handle)) "/")))
+                 buffer-file-coding-system
+               'binary)))
+        (write-region (point-min) (point-max) file))))))
 
 (defun mm-pipe-part (handle)
   "Pipe HANDLE to a process."
-  (let* ((name (drums-content-type-get (cadr handle) 'name))
+  (let* ((name (mail-content-type-get (mm-handle-type handle) 'name))
         (command
          (read-string "Shell command on MIME part: " mm-last-shell-command)))
     (mm-with-unibyte-buffer
-      (insert-buffer-substring (car handle))
-      (mm-decode-content-transfer-encoding (nth 2 handle))
+      (insert-buffer-substring (mm-handle-buffer handle))
+      (mm-decode-content-transfer-encoding
+       (mm-handle-encoding handle)
+       (car (mm-handle-type handle)))
       (shell-command-on-region (point-min) (point-max) command nil))))
 
 (defun mm-interactively-view-part (handle)
   "Display HANDLE using METHOD."
-  (let* ((type (caadr handle))
+  (let* ((type (car (mm-handle-type handle)))
         (methods
-         (mapcar (lambda (i) (list (cdr (assoc "viewer" i))))
+         (mapcar (lambda (i) (list (cdr (assoc 'viewer i))))
                  (mailcap-mime-info type 'all)))
         (method (completing-read "Viewer: " methods)))
     (mm-display-external (copy-sequence handle) method)))
 
+(defun mm-preferred-alternative (handles &optional preferred)
+  "Say which of HANDLES are preferred."
+  (let ((prec (if preferred (list preferred) mm-alternative-precedence))
+       p h result type handle)
+    (while (setq p (pop prec))
+      (setq h handles)
+      (while h
+       (setq type
+             (if (stringp (caar h))
+                 (caar h)
+               (car (mm-handle-type (car h)))))
+       (setq handle (car h))
+       (when (and (equal p type)
+                  (mm-automatic-display-p type)
+                  (or (stringp (caar h))
+                      (not (mm-handle-disposition (car h)))
+                      (equal (car (mm-handle-disposition (car h)))
+                             "inline")))
+         (setq result (car h)
+               h nil
+               prec nil))
+       (pop h)))
+    result))
+
+(defun mm-get-content-id (id)
+  "Return the handle(s) referred to by ID."
+  (cdr (assoc id mm-content-id-alist)))
+
+(defun mm-get-image (handle)
+  "Return an image instance based on HANDLE."
+  (let ((type (cadr (split-string (car (mm-handle-type handle)) "/"))))
+    (mm-with-unibyte-buffer
+      (insert-buffer-substring (mm-handle-buffer handle))
+      (mm-decode-content-transfer-encoding
+       (mm-handle-encoding handle)
+       (car (mm-handle-type handle)))
+      (make-image-specifier
+       (vector (intern type) :data (buffer-string))))))
+
+(defun mm-image-fit-p (handle)
+  "Say whether the image in HANDLE will fit the current window."
+  (let ((image (make-annotation (mm-get-image handle))))
+    (and (< (glyph-width (annotation-glyph image))
+           (window-pixel-width))
+        (< (glyph-height (annotation-glyph image))
+           (window-pixel-height)))))
+
+(defun url-cid (url)
+  (set-buffer (get-buffer-create url-working-buffer))
+  (let ((content-type nil)
+       (encoding nil)
+       (part nil)
+       (data nil))
+    (if (not (string-match "^cid:\\(.*\\)" url))
+       (message "Malformed CID URL: %s" url)
+      (setq url (url-unhex-string (match-string 1 url))
+           part (mm-get-content-id url))
+      (if (not part)
+         (message "Unknown CID encounterred: %s" url)
+       (setq data (buffer-string nil nil (mm-handle-buffer part))
+             content-type (mm-handle-type part)
+             encoding (symbol-name (mm-handle-encoding part)))
+       (if (= 0 (length content-type)) (setq content-type "text/plain"))
+       (if (= 0 (length encoding)) (setq encoding "8bit"))
+       (setq url-current-content-length (length data)
+             url-current-mime-type content-type
+             url-current-mime-encoding encoding
+             url-current-mime-headers (list (cons "content-type" content-type)
+                                            (cons "content-encoding" encoding)))
+       (and data (insert data))))))
+
 (provide 'mm-decode)
 
 ;; mm-decode.el ends here