Importing Pterodactyl Gnus v0.97.
[elisp/gnus.git-] / lisp / mm-decode.el
index 83cf901..693c60e 100644 (file)
   `(nth 0 ,handle))
 (defmacro mm-handle-type (handle)
   `(nth 1 ,handle))
+(defsubst mm-handle-media-type (handle)
+  (if (stringp (car handle))
+      (car handle)
+    (car (mm-handle-type handle))))
+(defsubst mm-handle-media-supertype (handle)
+  (car (split-string (mm-handle-media-type handle) "/")))
+(defsubst mm-handle-media-subtype (handle)
+  (cadr (split-string (mm-handle-media-type handle) "/")))
 (defmacro mm-handle-encoding (handle)
   `(nth 2 ,handle))
 (defmacro mm-handle-undisplayer (handle)
         ,disposition ,description ,cache ,id))
 
 (defvar mm-inline-media-tests
-  '(("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/x-xbitmap" mm-inline-image
-     (and window-system (fboundp 'device-type)
-         (eq (device-type) 'x)))
-    ("image/xpm" mm-inline-image
-     (and window-system (featurep 'xpm)))
-    ("image/x-pixmap" 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/enriched" mm-inline-text t)
-    ("text/richtext" mm-inline-text t)
-    ("text/html" mm-inline-text (locate-library "w3"))
-    ("text/x-vcard" mm-inline-text (locate-library "vcard"))
-    ("message/delivery-status" mm-inline-text t)
-    ("message/rfc822" mm-inline-message t)
-    ("text/.*" mm-inline-text t)
+  '(("image/jpeg"
+     mm-inline-image
+     (lambda (handle)
+       (mm-valid-and-fit-image-p 'jpeg handle)))
+    ("image/png"
+     mm-inline-image
+     (lambda (handle)
+       (mm-valid-and-fit-image-p 'png handle)))
+    ("image/gif"
+     mm-inline-image
+     (lambda (handle)
+       (mm-valid-and-fit-image-p 'gif handle)))
+    ("image/tiff"
+     mm-inline-image
+     (lambda (handle)
+       (mm-valid-and-fit-image-p 'tiff handle)) )
+    ("image/xbm"
+     mm-inline-image
+     (lambda (handle)
+       (mm-valid-and-fit-image-p 'xbm handle)))
+    ("image/x-xbitmap"
+     mm-inline-image
+     (lambda (handle)
+       (mm-valid-and-fit-image-p 'xbm handle)))
+    ("image/xpm"
+     mm-inline-image
+     (lambda (handle)
+       (mm-valid-and-fit-image-p 'xpm handle)))
+    ("image/x-pixmap"
+     mm-inline-image
+     (lambda (handle)
+       (mm-valid-and-fit-image-p 'xpm handle)))
+    ("image/bmp"
+     mm-inline-image
+     (lambda (handle)
+       (mm-valid-and-fit-image-p 'bmp handle)))
+    ("text/plain" mm-inline-text identity)
+    ("text/enriched" mm-inline-text identity)
+    ("text/richtext" mm-inline-text identity)
+    ("text/html"
+     mm-inline-text
+     (lambda (handle)
+       (locate-library "w3")))
+    ("text/x-vcard"
+     mm-inline-text
+     (lambda (handle)
+       (locate-library "vcard")))
+    ("message/delivery-status" mm-inline-text identity)
+    ("message/rfc822" mm-inline-message identity)
+    ("text/.*" mm-inline-text identity)
     ("audio/wav" mm-inline-audio
-     (and (or (featurep 'nas-sound) (featurep 'native-sound))
-         (device-sound-enabled-p)))
-    ("audio/au" mm-inline-audio
-     (and (or (featurep 'nas-sound) (featurep 'native-sound))
-         (device-sound-enabled-p)))
-    ("multipart/alternative" ignore t)
-    ("multipart/mixed" ignore t)
-    ("multipart/related" ignore t))
+     (lambda (handle)
+       (and (or (featurep 'nas-sound) (featurep 'native-sound))
+           (device-sound-enabled-p))))
+    ("audio/au"
+     mm-inline-audio
+     (lambda (handle)
+       (and (or (featurep 'nas-sound) (featurep 'native-sound))
+           (device-sound-enabled-p))))
+    ("multipart/alternative" ignore identity)
+    ("multipart/mixed" ignore identity)
+    ("multipart/related" ignore identity))
   "Alist of media types/test that say whether the media types can be displayed inline.")
 
-(defvar mm-user-display-methods
-  '(("image/.*" . inline)
-    ("text/.*" . inline)
-    ("message/delivery-status" . inline)
-    ("message/rfc822" . inline)))
-
-(defvar mm-user-automatic-display
+(defvar mm-inlined-types
+  '("image/.*" "text/.*" "message/delivery-status" "message/rfc822")
+  "List of media types that are to be displayed inline.")
+  
+(defvar mm-automatic-display
   '("text/plain" "text/enriched" "text/richtext" "text/html"
     "text/x-vcard" "image/.*" "message/delivery-status" "multipart/.*"
-    "message/rfc822"))
+    "message/rfc822")
+  "A list of MIME types to be displayed automatically.")
 
-(defvar mm-attachment-override-types
-  '("text/plain" "text/x-vcard")
+(defvar mm-attachment-override-types '("text/plain" "text/x-vcard")
   "Types that should have \"attachment\" ignored if they can be displayed inline.")
 
-(defvar mm-user-automatic-external-display nil
+(defvar mm-automatic-external-display nil
   "List of MIME type regexps that will be displayed externally automatically.")
 
-(defvar mm-alternative-precedence
-  '("multipart/related" "multipart/mixed" "multipart/alternative"
-    "image/jpeg" "image/gif" "text/html" "text/enriched"
-    "text/richtext" "text/plain")
-  "List that describes the precedence of alternative parts.")
+(defvar mm-discouraged-alternatives nil
+  "List of MIME types that are discouraged when viewing multipart/alternative.
+Viewing agents are supposed to view the last possible part of a message,
+as that is supposed to be the richest.  However, users may prefer other
+types instead, and this list says what types are most unwanted.  If,
+for instance, text/html parts are very unwanted, and text/richtech are
+somewhat unwanted, then the value of this variable should be set
+to:
+
+ (\"text/html\" \"text/richtext\")")
 
 (defvar mm-tmp-directory
   (cond ((fboundp 'temp-directory) (temp-directory))
        ("/tmp/"))
   "Where mm will store its temporary files.")
 
-(defvar mm-all-images-fit nil
+(defvar mm-inline-large-images nil
   "If non-nil, then all images fit in the buffer.")
 
 ;;; Internal variables.
       (insert-buffer-substring obuf beg)
       (current-buffer))))
 
-(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;
@@ -244,27 +276,23 @@ external if displayed external."
     (mailcap-parse-mailcaps)
     (if (mm-handle-displayed-p handle)
        (mm-remove-part handle)
-      (let* ((type (car (mm-handle-type handle)))
-            (method (mailcap-mime-info type))
-            (user-method (mm-user-method type)))
-       (if (eq user-method 'inline)
+      (let* ((type (mm-handle-media-type handle))
+            (method (mailcap-mime-info type)))
+       (if (mm-inlined-p handle)
            (progn
              (forward-line 1)
              (mm-display-inline handle)
              'inline)
-         (when (or user-method
-                   method
+         (when (or method
                    (not no-default))
-           (if (and (not user-method)
-                    (not method)
+           (if (and (not method)
                     (equal "text" (car (split-string type))))
                (progn
                  (forward-line 1)
                  (mm-insert-inline handle (mm-get-part handle))
                  'inline)
              (mm-display-external
-              handle (or user-method method
-                         'mailcap-save-binary-file))
+              handle (or method 'mailcap-save-binary-file))
              'external)))))))
 
 (defun mm-display-external (handle method)
@@ -288,7 +316,7 @@ external if displayed external."
          (let ((mm (current-buffer))
                (non-viewer (assoc "non-viewer"
                                   (mailcap-mime-info
-                                   (car (mm-handle-type handle)) t))))
+                                   (mm-handle-media-type handle) t))))
            (unwind-protect
                (if method
                    (funcall method)
@@ -301,9 +329,10 @@ external if displayed external."
       (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)))
+            (mime-info (mailcap-mime-info
+                        (mm-handle-media-type handle) t))
+            (needsterm (or (assoc "needsterm" mime-info)
+                           (assoc "needsterminal" mime-info)))
             process file buffer)
        ;; We create a private sub-directory where we store our files.
        (make-directory dir)
@@ -320,16 +349,36 @@ external if displayed external."
                      (start-process "*display*" nil
                                     "xterm"
                                     "-e" shell-file-name "-c"
-                                    (format method
-                                            (mm-quote-arg file)))
+                                    (mm-mailcap-command
+                                     method file (mm-handle-type handle)))
                    (start-process "*display*"
                                   (setq buffer (generate-new-buffer "*mm*"))
                                   shell-file-name
-                                  "-c" (format method
-                                               (mm-quote-arg file)))))
+                                  "-c"
+                                  (mm-mailcap-command
+                                   method file (mm-handle-type handle)))))
          (mm-handle-set-undisplayer handle (cons file buffer)))
        (message "Displaying %s..." (format method file))))))
 
+(defun mm-mailcap-command (method file type-list)
+  (let ((ctl (cdr type-list))
+       (beg 0)
+       out sub total)
+    (while (string-match "%{\\([^}]+\\)}\\|%s\\|%t" method beg)
+      (push (substring method beg (match-beginning 0)) out)
+      (setq beg (match-end 0)
+           total (match-string 0 method)
+           sub (match-string 1 method))
+      (cond
+       ((string= total "%s")
+       (push (mm-quote-arg file) out))
+       ((string= total "%t")
+       (push (mm-quote-arg (car type-list)) out))
+       (t
+       (push (mm-quote-arg (or (cdr (assq (intern sub) ctl)) "")) out))))
+    (push (substring method beg (length method)) out)
+    (mapconcat 'identity (nreverse out) "")))
+    
 (defun mm-remove-parts (handles)
   "Remove the displayed MIME parts represented by HANDLE."
   (if (and (listp handles)
@@ -386,59 +435,67 @@ external if displayed external."
       (mm-handle-set-undisplayer handle nil))))
 
 (defun mm-display-inline (handle)
-  (let* ((type (car (mm-handle-type handle)))
-        (function (cadr (assoc type mm-inline-media-tests))))
+  (let* ((type (mm-handle-media-type handle))
+        (function (cadr (mm-assoc-string-match mm-inline-media-tests type))))
     (funcall function handle)
     (goto-char (point-min))))
 
-(defun mm-inlinable-p (type)
-  "Say whether TYPE can be displayed inline."
+(defun mm-assoc-string-match (alist type)
+  (dolist (elem alist)
+    (when (string-match (car elem) type)
+      (return elem))))
+
+(defun mm-inlinable-p (handle)
+  "Say whether HANDLE can be displayed inline."
   (let ((alist mm-inline-media-tests)
+       (type (mm-handle-media-type handle))
        test)
     (while alist
-      (when (equal type (caar alist))
+      (when (string-match (caar alist) type)
        (setq test (caddar alist)
              alist nil)
-       (setq test (eval test)))
+       (setq test (funcall test handle)))
       (pop alist))
     test))
 
-(defun mm-user-method (type)
-  "Return the user-defined method for TYPE."
-  (let ((methods mm-user-display-methods)
+(defun mm-automatic-display-p (handle)
+  "Say whether the user wants HANDLE to be displayed automatically."
+  (let ((methods mm-automatic-display)
+       (type (mm-handle-media-type handle))
        method result)
     (while (setq method (pop methods))
-      (when (string-match (car method) type)
-       (when (or (not (eq (cdr method) 'inline))
-                 (mm-inlinable-p type))
-         (setq result (cdr method)
-               methods nil))))
+      (when (and (string-match method type)
+                (mm-inlinable-p handle))
+       (setq result t
+             methods nil)))
     result))
 
-(defun mm-automatic-display-p (type)
-  "Return the user-defined method for TYPE."
-  (let ((methods mm-user-automatic-display)
+(defun mm-inlined-p (handle)
+  "Say whether the user wants HANDLE to be displayed automatically."
+  (let ((methods mm-inlined-types)
+       (type (mm-handle-media-type handle))
        method result)
     (while (setq method (pop methods))
       (when (and (string-match method type)
-                (mm-inlinable-p type))
+                (mm-inlinable-p handle))
        (setq result t
              methods nil)))
     result))
 
-(defun mm-attachment-override-p (type)
-  "Say whether TYPE should have attachment behavior overridden."
+(defun mm-attachment-override-p (handle)
+  "Say whether HANDLE should have attachment behavior overridden."
   (let ((types mm-attachment-override-types)
+       (type (mm-handle-media-type handle))
        ty)
     (catch 'found
       (while (setq ty (pop types))
        (when (and (string-match ty type)
-                  (mm-inlinable-p type))
+                  (mm-inlinable-p handle))
          (throw 'found t))))))
 
 (defun mm-automatic-external-display-p (type)
   "Return the user-defined method for TYPE."
-  (let ((methods mm-user-automatic-external-display)
+  (let ((methods mm-automatic-external-display)
        method result)
     (while (setq method (pop methods))
       (when (string-match method type)
@@ -446,11 +503,6 @@ external if displayed external."
              methods nil)))
     result))
 
-(defun add-mime-display-method (type method)
-  "Make parts of TYPE be displayed with METHOD.
-This overrides entries in the mailcap file."
-  (push (cons type method) mm-user-display-methods))
-
 (defun mm-destroy-part (handle)
   "Destroy the data structures connected to HANDLE."
   (when (listp handle)
@@ -462,19 +514,6 @@ This overrides entries in the mailcap file."
   "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))
-      (push (substring arg pos new-pos) accum)
-      (push "\\" accum)
-      (push (list (aref arg new-pos)) accum)
-      (setq pos (1+ new-pos)))
-    (if (= pos 0)
-        arg
-      (apply 'concat (nconc (nreverse accum) (list (substring arg pos)))))))
-
 ;;;
 ;;; Functions for outputting parts
 ;;;
@@ -489,14 +528,23 @@ This overrides entries in the mailcap file."
   "Insert the contents of HANDLE in the current buffer."
   (let ((cur (current-buffer)))
     (save-excursion
-      (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)))
-       (let ((temp (current-buffer)))
-         (set-buffer cur)
-         (insert-buffer-substring temp))))))
+      (if (member (mm-handle-media-supertype handle) '("text" "message"))
+         (with-temp-buffer
+           (insert-buffer-substring (mm-handle-buffer handle))
+           (mm-decode-content-transfer-encoding
+            (mm-handle-encoding handle)
+            (mm-handle-media-type handle))
+           (let ((temp (current-buffer)))
+             (set-buffer cur)
+             (insert-buffer-substring temp)))
+       (mm-with-unibyte-buffer
+         (insert-buffer-substring (mm-handle-buffer handle))
+         (mm-decode-content-transfer-encoding
+          (mm-handle-encoding handle)
+          (mm-handle-media-type handle))
+         (let ((temp (current-buffer)))
+           (set-buffer cur)
+           (insert-buffer-substring temp)))))))
 
 (defvar mm-default-directory nil)
 
@@ -514,28 +562,25 @@ This overrides entries in the mailcap file."
                           (or filename name "")
                           (or mm-default-directory default-directory))))
     (setq mm-default-directory (file-name-directory file))
-    (mm-with-unibyte-buffer
-      (mm-insert-part handle)
-      (when (or (not (file-exists-p 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))
-           ;; Don't re-compress .gz & al.  Arguably we should make
-           ;; `file-name-handler-alist' nil, but that would chop
-           ;; ange-ftp which it's reasonable to use here.
-           (inhibit-file-name-operation 'write-region)
-           (inhibit-file-name-handlers
-            (if (equal (car (mm-handle-type handle))
-                       "application/octet-stream")
-                (cons 'jka-compr-handler inhibit-file-name-handlers)
-              inhibit-file-name-handlers)))
-        (write-region (point-min) (point-max) file))))))
+    (when (or (not (file-exists-p file))
+             (yes-or-no-p (format "File %s already exists; overwrite? "
+                                  file)))
+      (mm-save-part-to-file handle file))))
+
+(defun mm-save-part-to-file (handle file)
+  (mm-with-unibyte-buffer
+    (mm-insert-part handle)
+    (let ((coding-system-for-write 'binary)
+         ;; Don't re-compress .gz & al.  Arguably we should make
+         ;; `file-name-handler-alist' nil, but that would chop
+         ;; ange-ftp, which is reasonable to use here.
+         (inhibit-file-name-operation 'write-region)
+         (inhibit-file-name-handlers
+          (if (equal (mm-handle-media-type handle)
+                     "application/octet-stream")
+              (cons 'jka-compr-handler inhibit-file-name-handlers)
+            inhibit-file-name-handlers)))
+      (write-region (point-min) (point-max) file))))
 
 (defun mm-pipe-part (handle)
   "Pipe HANDLE to a process."
@@ -548,7 +593,7 @@ This overrides entries in the mailcap file."
 
 (defun mm-interactively-view-part (handle)
   "Display HANDLE using METHOD."
-  (let* ((type (car (mm-handle-type handle)))
+  (let* ((type (mm-handle-media-type handle))
         (methods
          (mapcar (lambda (i) (list (cdr (assoc 'viewer i))))
                  (mailcap-mime-info type 'all)))
@@ -557,35 +602,44 @@ This overrides entries in the mailcap file."
 
 (defun mm-preferred-alternative (handles &optional preferred)
   "Say which of HANDLES are preferred."
-  (let ((prec (if preferred (list preferred) mm-alternative-precedence))
+  (let ((prec (if preferred (list preferred)
+               (mm-preferred-alternative-precedence handles)))
        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))
+       (setq type (mm-handle-media-type handle))
        (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)))
+                  (mm-automatic-display-p handle)
+                  (or (stringp (car handle))
+                      (not (mm-handle-disposition handle))
+                      (equal (car (mm-handle-disposition handle))
                              "inline")))
-         (setq result (car h)
+         (setq result handle
                h nil
                prec nil))
        (pop h)))
     result))
 
+(defun mm-preferred-alternative-precedence (handles)
+  "Return the precedence based on HANDLES and mm-discouraged-alternatives."
+  (let ((seq (nreverse (mapcar (lambda (h)
+                                (mm-handle-media-type h))
+                              handles))))
+    (dolist (disc (reverse mm-discouraged-alternatives))
+      (dolist (elem (copy-sequence seq))
+       (when (string-match disc elem)
+         (setq seq (nconc (delete elem seq) (list elem))))))
+    seq))
+
 (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)) "/")))
+  (let ((type (mm-handle-media-subtype handle))
        spec)
     ;; Allow some common translations.
     (setq type
@@ -601,26 +655,45 @@ This overrides entries in the mailcap file."
          (prog1
              (setq spec
                    (ignore-errors
-                     (make-glyph
-                      (cond
-                       ((equal type "xbm")
-                        (let ((height 32)
-                              (width 32))
-                          (forward-line 2)
-                          (vector 'xbm :data (list height width
-                                                   (buffer-substring
-                                                    (point) (point-max))))))
-                       (t
+                     (cond
+                      ((equal type "xbm")
+                       ;; xbm images require special handling, since
+                       ;; the only way to create glyphs from these
+                       ;; (without a ton of work) is to write them
+                       ;; out to a file, and then create a file
+                       ;; specifier.
+                       (let ((file (make-temp-name
+                                    (expand-file-name "emm.xbm"
+                                                      mm-tmp-directory))))
+                         (unwind-protect
+                             (progn
+                               (write-region (point-min) (point-max) file)
+                               (make-glyph (list (cons 'x file))))
+                           (ignore-errors
+                             (delete-file file)))))
+                      (t
+                       (make-glyph
                         (vector (intern type) :data (buffer-string)))))))
            (mm-handle-set-cache handle spec))))))
 
 (defun mm-image-fit-p (handle)
   "Say whether the image in HANDLE will fit the current window."
   (let ((image (mm-get-image handle)))
-    (or mm-all-images-fit
+    (or mm-inline-large-images
        (and (< (glyph-width image) (window-pixel-width))
             (< (glyph-height image) (window-pixel-height))))))
 
+(defun mm-valid-image-format-p (format)
+  "Say whether FORMAT can be displayed natively by Emacs."
+  (and (fboundp 'valid-image-instantiator-format-p)
+       (valid-image-instantiator-format-p format)))
+
+(defun mm-valid-and-fit-image-p (format handle)
+  "Say whether FORMAT can be displayed natively and HANDLE fits the window."
+  (and window-system
+       (mm-valid-image-format-p format)
+       (mm-image-fit-p handle)))
+
 (provide 'mm-decode)
 
 ;; mm-decode.el ends here