git.chise.org Git - elisp/gnus.git-/blob - lisp/mm-decode.el

   1 ;;; mm-decode.el --- Functions for decoding MIME things
   2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004
   3 ;;        Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;;      MORIOKA Tomohiko <morioka@jaist.ac.jp>
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (require 'mail-parse)
  29 (require 'gnus-mailcap)
  30 (require 'mm-bodies)
  31 (eval-when-compile (require 'cl)
  32                    (require 'term))
  33
  34 (eval-and-compile
  35   (autoload 'mm-inline-partial "mm-partial")
  36   (autoload 'mm-inline-external-body "mm-extern")
  37   (autoload 'mm-insert-inline "mm-view"))
  38
  39 (add-hook 'gnus-exit-gnus-hook 'mm-destroy-postponed-undisplay-list)
  40
  41 (defgroup mime-display ()
  42   "Display of MIME in mail and news articles."
  43   :link '(custom-manual "(emacs-mime)Display Customization")
  44   :version "21.1"
  45   :group 'mail
  46   :group 'news
  47   :group 'multimedia)
  48
  49 (defgroup mime-security ()
  50   "MIME security in mail and news articles."
  51   :link '(custom-manual "(emacs-mime)Display Customization")
  52   :group 'mail
  53   :group 'news
  54   :group 'multimedia)
  55
  56 ;;; Convenience macros.
  57
  58 (defmacro mm-handle-buffer (handle)
  59   `(nth 0 ,handle))
  60 (defmacro mm-handle-type (handle)
  61   `(nth 1 ,handle))
  62 (defsubst mm-handle-media-type (handle)
  63   (if (stringp (car handle))
  64       (car handle)
  65     (car (mm-handle-type handle))))
  66 (defsubst mm-handle-media-supertype (handle)
  67   (car (split-string (mm-handle-media-type handle) "/")))
  68 (defsubst mm-handle-media-subtype (handle)
  69   (cadr (split-string (mm-handle-media-type handle) "/")))
  70 (defmacro mm-handle-encoding (handle)
  71   `(nth 2 ,handle))
  72 (defmacro mm-handle-undisplayer (handle)
  73   `(nth 3 ,handle))
  74 (defmacro mm-handle-set-undisplayer (handle function)
  75   `(setcar (nthcdr 3 ,handle) ,function))
  76 (defmacro mm-handle-disposition (handle)
  77   `(nth 4 ,handle))
  78 (defmacro mm-handle-description (handle)
  79   `(nth 5 ,handle))
  80 (defmacro mm-handle-cache (handle)
  81   `(nth 6 ,handle))
  82 (defmacro mm-handle-set-cache (handle contents)
  83   `(setcar (nthcdr 6 ,handle) ,contents))
  84 (defmacro mm-handle-id (handle)
  85   `(nth 7 ,handle))
  86 (defmacro mm-handle-multipart-original-buffer (handle)
  87   `(get-text-property 0 'buffer (car ,handle)))
  88 (defmacro mm-handle-multipart-from (handle)
  89   `(get-text-property 0 'from (car ,handle)))
  90 (defmacro mm-handle-multipart-ctl-parameter (handle parameter)
  91   `(get-text-property 0 ,parameter (car ,handle)))
  92
  93 (defmacro mm-make-handle (&optional buffer type encoding undisplayer
  94                                     disposition description cache
  95                                     id)
  96   `(list ,buffer ,type ,encoding ,undisplayer
  97          ,disposition ,description ,cache ,id))
  98
  99 (defcustom mm-text-html-renderer
 100   (cond ((locate-library "w3") 'w3)
 101         ((executable-find "w3m") (if (locate-library "w3m")
 102                                      'w3m
 103                                    'w3m-standalone))
 104         ((executable-find "links") 'links)
 105         ((executable-find "lynx") 'lynx)
 106         (t 'html2text))
 107   "Render of HTML contents.
 108 It is one of defined renderer types, or a rendering function.
 109 The defined renderer types are:
 110 `w3'   : use Emacs/W3;
 111 `w3m'  : use emacs-w3m;
 112 `w3m-standalone': use w3m;
 113 `links': use links;
 114 `lynx' : use lynx;
 115 `html2text' : use html2text;
 116 nil    : use external viewer."
 117   :type '(choice (const w3)
 118                  (const w3m)
 119                  (const w3m-standalone)
 120                  (const links)
 121                  (const lynx)
 122                  (const html2text)
 123                  (const nil)
 124                  (function))
 125   :version "21.3"
 126   :group 'mime-display)
 127
 128 (defvar mm-inline-text-html-renderer nil
 129   "Function used for rendering inline HTML contents.
 130 It is suggested to customize `mm-text-html-renderer' instead.")
 131
 132 (defcustom mm-inline-text-html-with-images nil
 133   "If non-nil, Gnus will allow retrieving images in HTML contents with
 134 the <img> tags.  It has no effect on Emacs/w3.  See also the
 135 documentation for the `mm-w3m-safe-url-regexp' variable."
 136   :type 'boolean
 137   :group 'mime-display)
 138
 139 (defcustom mm-w3m-safe-url-regexp "\\`cid:"
 140   "Regexp matching URLs which are considered to be safe.
 141 Some HTML mails might contain a nasty trick used by spammers, using
 142 the <img> tag which is far more evil than the [Click Here!] button.
 143 It is most likely intended to check whether the ominous spam mail has
 144 reached your eyes or not, in which case the spammer knows for sure
 145 that your email address is valid.  It is done by embedding an
 146 identifier string into a URL that you might automatically retrieve
 147 when displaying the image.  The default value is \"\\\\`cid:\" which only
 148 matches parts embedded to the Multipart/Related type MIME contents and
 149 Gnus will never connect to the spammer's site arbitrarily.  You may
 150 set this variable to nil if you consider all urls to be safe."
 151   :type '(choice (regexp :tag "Regexp")
 152                  (const :tag "All URLs are safe" nil))
 153   :group 'mime-display)
 154
 155 (defcustom mm-inline-text-html-with-w3m-keymap t
 156   "If non-nil, use emacs-w3m command keys in the article buffer."
 157   :type 'boolean
 158   :group 'mime-display)
 159
 160 (defcustom mm-enable-external t
 161   "Indicate whether external MIME handlers should be used.
 162
 163 If t, all defined external MIME handlers are used.  If nil, files are saved by
 164 `mailcap-save-binary-file'.  If it is the symbol `ask', you are prompted
 165 before the external MIME handler is invoked."
 166   :version "21.4"
 167   :type '(choice (const :tag "Always" t)
 168                  (const :tag "Never" nil)
 169                  (const :tag "Ask" ask))
 170   :group 'mime-display)
 171
 172 (defcustom mm-inline-media-tests
 173   '(("image/p?jpeg"
 174      mm-inline-image
 175      (lambda (handle)
 176        (mm-valid-and-fit-image-p 'jpeg handle)))
 177     ("image/png"
 178      mm-inline-image
 179      (lambda (handle)
 180        (mm-valid-and-fit-image-p 'png handle)))
 181     ("image/gif"
 182      mm-inline-image
 183      (lambda (handle)
 184        (mm-valid-and-fit-image-p 'gif handle)))
 185     ("image/tiff"
 186      mm-inline-image
 187      (lambda (handle)
 188        (mm-valid-and-fit-image-p 'tiff handle)) )
 189     ("image/xbm"
 190      mm-inline-image
 191      (lambda (handle)
 192        (mm-valid-and-fit-image-p 'xbm handle)))
 193     ("image/x-xbitmap"
 194      mm-inline-image
 195      (lambda (handle)
 196        (mm-valid-and-fit-image-p 'xbm handle)))
 197     ("image/xpm"
 198      mm-inline-image
 199      (lambda (handle)
 200        (mm-valid-and-fit-image-p 'xpm handle)))
 201     ("image/x-xpixmap"
 202      mm-inline-image
 203      (lambda (handle)
 204        (mm-valid-and-fit-image-p 'xpm handle)))
 205     ("image/bmp"
 206      mm-inline-image
 207      (lambda (handle)
 208        (mm-valid-and-fit-image-p 'bmp handle)))
 209     ("image/x-portable-bitmap"
 210      mm-inline-image
 211      (lambda (handle)
 212        (mm-valid-and-fit-image-p 'pbm handle)))
 213     ("text/plain" mm-inline-text identity)
 214     ("text/enriched" mm-inline-text identity)
 215     ("text/richtext" mm-inline-text identity)
 216     ("text/x-patch" mm-display-patch-inline
 217      (lambda (handle)
 218        (locate-library "diff-mode")))
 219     ("application/emacs-lisp" mm-display-elisp-inline identity)
 220     ("application/x-emacs-lisp" mm-display-elisp-inline identity)
 221     ("text/html"
 222      mm-inline-text-html
 223      (lambda (handle)
 224        (or mm-inline-text-html-renderer
 225            mm-text-html-renderer)))
 226     ("text/x-vcard"
 227      mm-inline-text-vcard
 228      (lambda (handle)
 229        (or (featurep 'vcard)
 230            (locate-library "vcard"))))
 231     ("message/delivery-status" mm-inline-text identity)
 232     ("message/rfc822" mm-inline-message identity)
 233     ("message/partial" mm-inline-partial identity)
 234     ("message/external-body" mm-inline-external-body identity)
 235     ("text/.*" mm-inline-text identity)
 236     ("audio/wav" mm-inline-audio
 237      (lambda (handle)
 238        (and (or (featurep 'nas-sound) (featurep 'native-sound))
 239             (device-sound-enabled-p))))
 240     ("audio/au"
 241      mm-inline-audio
 242      (lambda (handle)
 243        (and (or (featurep 'nas-sound) (featurep 'native-sound))
 244             (device-sound-enabled-p))))
 245     ("application/pgp-signature" ignore identity)
 246     ("application/x-pkcs7-signature" ignore identity)
 247     ("application/pkcs7-signature" ignore identity)
 248     ("application/x-pkcs7-mime" ignore identity)
 249     ("application/pkcs7-mime" ignore identity)
 250     ("multipart/alternative" ignore identity)
 251     ("multipart/mixed" ignore identity)
 252     ("multipart/related" ignore identity)
 253     ;; Disable audio and image
 254     ("audio/.*" ignore ignore)
 255     ("image/.*" ignore ignore)
 256     ;; Default to displaying as text
 257     (".*" mm-inline-text mm-readable-p))
 258   "Alist of media types/tests saying whether types can be displayed inline."
 259   :type '(repeat (list (regexp :tag "MIME type")
 260                        (function :tag "Display function")
 261                        (function :tag "Display test")))
 262   :group 'mime-display)
 263
 264 (defcustom mm-inlined-types
 265   '("image/.*" "text/.*" "message/delivery-status" "message/rfc822"
 266     "message/partial" "message/external-body" "application/emacs-lisp"
 267     "application/x-emacs-lisp"
 268     "application/pgp-signature" "application/x-pkcs7-signature"
 269     "application/pkcs7-signature" "application/x-pkcs7-mime"
 270     "application/pkcs7-mime")
 271   "List of media types that are to be displayed inline.
 272 See also `mm-inline-media-tests', which says how to display a media
 273 type inline."
 274   :type '(repeat string)
 275   :group 'mime-display)
 276
 277 (defcustom mm-keep-viewer-alive-types
 278   '("application/postscript" "application/msword" "application/vnd.ms-excel"
 279     "application/pdf" "application/x-dvi")
 280   "List of media types for which the external viewer will not be killed
 281 when selecting a different article."
 282   :type '(repeat string)
 283   :group 'mime-display)
 284
 285 (defcustom mm-automatic-display
 286   '("text/plain" "text/enriched" "text/richtext" "text/html"
 287     "text/x-vcard" "image/.*" "message/delivery-status" "multipart/.*"
 288     "message/rfc822" "text/x-patch" "application/pgp-signature"
 289     "application/emacs-lisp" "application/x-emacs-lisp"
 290     "application/x-pkcs7-signature"
 291     "application/pkcs7-signature" "application/x-pkcs7-mime"
 292     "application/pkcs7-mime")
 293   "A list of MIME types to be displayed automatically."
 294   :type '(repeat string)
 295   :group 'mime-display)
 296
 297 (defcustom mm-attachment-override-types '("text/x-vcard"
 298                                           "application/pkcs7-mime"
 299                                           "application/x-pkcs7-mime"
 300                                           "application/pkcs7-signature"
 301                                           "application/x-pkcs7-signature")
 302   "Types to have \"attachment\" ignored if they can be displayed inline."
 303   :type '(repeat string)
 304   :group 'mime-display)
 305
 306 (defcustom mm-inline-override-types nil
 307   "Types to be treated as attachments even if they can be displayed inline."
 308   :type '(repeat string)
 309   :group 'mime-display)
 310
 311 (defcustom mm-automatic-external-display nil
 312   "List of MIME type regexps that will be displayed externally automatically."
 313   :type '(repeat string)
 314   :group 'mime-display)
 315
 316 (defcustom mm-discouraged-alternatives nil
 317   "List of MIME types that are discouraged when viewing multipart/alternative.
 318 Viewing agents are supposed to view the last possible part of a message,
 319 as that is supposed to be the richest.  However, users may prefer other
 320 types instead, and this list says what types are most unwanted.  If,
 321 for instance, text/html parts are very unwanted, and text/richtext are
 322 somewhat unwanted, then the value of this variable should be set
 323 to:
 324
 325  (\"text/html\" \"text/richtext\")"
 326   :type '(repeat string)
 327   :group 'mime-display)
 328
 329 (defcustom mm-tmp-directory
 330   (if (fboundp 'temp-directory)
 331       (temp-directory)
 332     (if (boundp 'temporary-file-directory)
 333         temporary-file-directory
 334       "/tmp/"))
 335   "Where mm will store its temporary files."
 336   :type 'directory
 337   :group 'mime-display)
 338
 339 (defcustom mm-inline-large-images nil
 340   "If non-nil, then all images fit in the buffer."
 341   :type 'boolean
 342   :group 'mime-display)
 343
 344 (defvar mm-file-name-rewrite-functions
 345   '(mm-file-name-delete-control mm-file-name-delete-gotchas)
 346   "*List of functions used for rewriting file names of MIME parts.
 347 Each function takes a file name as input and returns a file name.
 348
 349 Ready-made functions include
 350 `mm-file-name-delete-control'
 351 `mm-file-name-delete-gotchas'
 352 `mm-file-name-delete-whitespace',
 353 `mm-file-name-trim-whitespace',
 354 `mm-file-name-collapse-whitespace',
 355 `mm-file-name-replace-whitespace',
 356 `capitalize', `downcase', `upcase', and
 357 `upcase-initials'.")
 358
 359 (defvar mm-path-name-rewrite-functions nil
 360   "*List of functions for rewriting the full file names of MIME parts.
 361 This is used when viewing parts externally, and is meant for
 362 transforming the absolute name so that non-compliant programs can find
 363 the file where it's saved.
 364
 365 Each function takes a file name as input and returns a file name.")
 366
 367 (defvar mm-file-name-replace-whitespace nil
 368   "String used for replacing whitespace characters; default is `\"_\"'.")
 369
 370 (defcustom mm-default-directory nil
 371   "The default directory where mm will save files.
 372 If not set, `default-directory' will be used."
 373   :type '(choice directory (const :tag "Default" nil))
 374   :group 'mime-display)
 375
 376 (defcustom mm-attachment-file-modes 384
 377   "Set the mode bits of saved attachments to this integer."
 378   :type 'integer
 379   :group 'mime-display)
 380
 381 (defcustom mm-external-terminal-program "xterm"
 382   "The program to start an external terminal."
 383   :type 'string
 384   :group 'mime-display)
 385
 386 ;;; Internal variables.
 387
 388 (defvar mm-last-shell-command "")
 389 (defvar mm-content-id-alist nil)
 390 (defvar mm-postponed-undisplay-list nil)
 391
 392 ;; According to RFC2046, in particular, in a digest, the default
 393 ;; Content-Type value for a body part is changed from "text/plain" to
 394 ;; "message/rfc822".
 395 (defvar mm-dissect-default-type "text/plain")
 396
 397 (autoload 'mml2015-verify "mml2015")
 398 (autoload 'mml2015-verify-test "mml2015")
 399 (autoload 'mml-smime-verify "mml-smime")
 400 (autoload 'mml-smime-verify-test "mml-smime")
 401
 402 (defvar mm-verify-function-alist
 403   '(("application/pgp-signature" mml2015-verify "PGP" mml2015-verify-test)
 404     ("application/x-gnus-pgp-signature" mm-uu-pgp-signed-extract-1 "PGP"
 405      mm-uu-pgp-signed-test)
 406     ("application/pkcs7-signature" mml-smime-verify "S/MIME"
 407      mml-smime-verify-test)
 408     ("application/x-pkcs7-signature" mml-smime-verify "S/MIME"
 409      mml-smime-verify-test)))
 410
 411 (defcustom mm-verify-option 'never
 412   "Option of verifying signed parts.
 413 `never', not verify; `always', always verify;
 414 `known', only verify known protocols.  Otherwise, ask user."
 415   :type '(choice (item always)
 416                  (item never)
 417                  (item :tag "only known protocols" known)
 418                  (item :tag "ask" nil))
 419   :group 'mime-security)
 420
 421 (autoload 'mml2015-decrypt "mml2015")
 422 (autoload 'mml2015-decrypt-test "mml2015")
 423
 424 (defvar mm-decrypt-function-alist
 425   '(("application/pgp-encrypted" mml2015-decrypt "PGP" mml2015-decrypt-test)
 426     ("application/x-gnus-pgp-encrypted" mm-uu-pgp-encrypted-extract-1 "PGP"
 427      mm-uu-pgp-encrypted-test)))
 428
 429 (defcustom mm-decrypt-option nil
 430   "Option of decrypting encrypted parts.
 431 `never', not decrypt; `always', always decrypt;
 432 `known', only decrypt known protocols.  Otherwise, ask user."
 433   :type '(choice (item always)
 434                  (item never)
 435                  (item :tag "only known protocols" known)
 436                  (item :tag "ask" nil))
 437   :group 'mime-security)
 438
 439 (defvar mm-viewer-completion-map
 440   (let ((map (make-sparse-keymap 'mm-viewer-completion-map)))
 441     (set-keymap-parent map minibuffer-local-completion-map)
 442     map)
 443   "Keymap for input viewer with completion.")
 444
 445 ;; Should we bind other key to minibuffer-complete-word?
 446 (define-key mm-viewer-completion-map " " 'self-insert-command)
 447
 448 (defvar mm-viewer-completion-map
 449   (let ((map (make-sparse-keymap 'mm-viewer-completion-map)))
 450     (set-keymap-parent map minibuffer-local-completion-map)
 451     map)
 452   "Keymap for input viewer with completion.")
 453
 454 ;; Should we bind other key to minibuffer-complete-word?
 455 (define-key mm-viewer-completion-map " " 'self-insert-command)
 456
 457 ;;; The functions.
 458
 459 (defun mm-alist-to-plist (alist)
 460   "Convert association list ALIST into the equivalent property-list form.
 461 The plist is returned.  This converts from
 462
 463 \((a . 1) (b . 2) (c . 3))
 464
 465 into
 466
 467 \(a 1 b 2 c 3)
 468
 469 The original alist is not modified.  See also `destructive-alist-to-plist'."
 470   (let (plist)
 471     (while alist
 472       (let ((el (car alist)))
 473         (setq plist (cons (cdr el) (cons (car el) plist))))
 474       (setq alist (cdr alist)))
 475     (nreverse plist)))
 476
 477 (defun mm-keep-viewer-alive-p (handle)
 478   "Say whether external viewer for HANDLE should stay alive."
 479   (let ((types mm-keep-viewer-alive-types)
 480         (type (mm-handle-media-type handle))
 481         ty)
 482     (catch 'found
 483       (while (setq ty (pop types))
 484         (when (string-match ty type)
 485           (throw 'found t))))))
 486
 487 (defun mm-handle-set-external-undisplayer (handle function)
 488   "Set the undisplayer for HANDLE to FUNCTION.
 489 Postpone undisplaying of viewers for types in
 490 `mm-keep-viewer-alive-types'."
 491   (if (mm-keep-viewer-alive-p handle)
 492       (let ((new-handle (copy-sequence handle)))
 493         (mm-handle-set-undisplayer new-handle function)
 494         (mm-handle-set-undisplayer handle nil)
 495         (push new-handle mm-postponed-undisplay-list))
 496     (mm-handle-set-undisplayer handle function)))
 497
 498 (defun mm-destroy-postponed-undisplay-list ()
 499   (when mm-postponed-undisplay-list
 500     (message "Destroying external MIME viewers")
 501     (mm-destroy-parts mm-postponed-undisplay-list)))
 502
 503 (defun mm-dissect-buffer (&optional no-strict-mime loose-mime)
 504   "Dissect the current buffer and return a list of MIME handles."
 505   (save-excursion
 506     (let (ct ctl type subtype cte cd description id result from)
 507       (save-restriction
 508         (mail-narrow-to-head)
 509         (when (or no-strict-mime
 510                   loose-mime
 511                   (mail-fetch-field "mime-version"))
 512           (setq ct (mail-fetch-field "content-type")
 513                 ctl (ignore-errors (mail-header-parse-content-type ct))
 514                 cte (mail-fetch-field "content-transfer-encoding")
 515                 cd (mail-fetch-field "content-disposition")
 516                 description (mail-fetch-field "content-description")
 517                 from (mail-fetch-field "from")
 518                 id (mail-fetch-field "content-id"))
 519           ;; FIXME: In some circumstances, this code is running within
 520           ;; an unibyte macro.  mail-extract-address-components
 521           ;; creates unibyte buffers. This `if', though not a perfect
 522           ;; solution, avoids most of them.
 523           (if from
 524               (setq from (cadr (mail-extract-address-components from))))))
 525       (when cte
 526         (setq cte (mail-header-strip cte)))
 527       (if (or (not ctl)
 528               (not (string-match "/" (car ctl))))
 529           (mm-dissect-singlepart
 530            (list mm-dissect-default-type)
 531            (and cte (intern (downcase (mail-header-remove-whitespace
 532                                        (mail-header-remove-comments
 533                                         cte)))))
 534            no-strict-mime
 535            (and cd (ignore-errors (mail-header-parse-content-disposition cd)))
 536            description)
 537         (setq type (split-string (car ctl) "/"))
 538         (setq subtype (cadr type)
 539               type (pop type))
 540         (setq
 541          result
 542          (cond
 543           ((equal type "multipart")
 544            (let ((mm-dissect-default-type (if (equal subtype "digest")
 545                                               "message/rfc822"
 546                                             "text/plain"))
 547                  (start (cdr (assq 'start (cdr ctl)))))
 548              (add-text-properties 0 (length (car ctl))
 549                                   (mm-alist-to-plist (cdr ctl)) (car ctl))
 550
 551              ;; what really needs to be done here is a way to link a
 552              ;; MIME handle back to it's parent MIME handle (in a multilevel
 553              ;; MIME article).  That would probably require changing
 554              ;; the mm-handle API so we simply store the multipart buffert
 555              ;; name as a text property of the "multipart/whatever" string.
 556              (add-text-properties 0 (length (car ctl))
 557                                   (list 'buffer (mm-copy-to-buffer)
 558                                         'from from
 559                                         'start start)
 560                                   (car ctl))
 561              (cons (car ctl) (mm-dissect-multipart ctl))))
 562           (t
 563            (mm-possibly-verify-or-decrypt
 564             (mm-dissect-singlepart
 565              ctl
 566              (and cte (intern (downcase (mail-header-remove-whitespace
 567                                          (mail-header-remove-comments
 568                                           cte)))))
 569              no-strict-mime
 570              (and cd (ignore-errors
 571                        (mail-header-parse-content-disposition cd)))
 572              description id)
 573             ctl))))
 574         (when id
 575           (when (string-match " *<\\(.*\\)> *" id)
 576             (setq id (match-string 1 id)))
 577           (push (cons id result) mm-content-id-alist))
 578         result))))
 579
 580 (defun mm-dissect-singlepart (ctl cte &optional force cdl description id)
 581   (when (or force
 582             (if (equal "text/plain" (car ctl))
 583                 (assoc 'format ctl)
 584               t))
 585     (mm-make-handle
 586      (mm-copy-to-buffer) ctl cte nil cdl description nil id)))
 587
 588 (defun mm-dissect-multipart (ctl)
 589   (goto-char (point-min))
 590   (let* ((boundary (concat "\n--" (mail-content-type-get ctl 'boundary)))
 591          (close-delimiter (concat (regexp-quote boundary) "--[ \t]*$"))
 592          start parts
 593          (end (save-excursion
 594                 (goto-char (point-max))
 595                 (if (re-search-backward close-delimiter nil t)
 596                     (match-beginning 0)
 597                   (point-max)))))
 598     (setq boundary (concat (regexp-quote boundary) "[ \t]*$"))
 599     (while (and (< (point) end) (re-search-forward boundary end t))
 600       (goto-char (match-beginning 0))
 601       (when start
 602         (save-excursion
 603           (save-restriction
 604             (narrow-to-region start (point))
 605             (setq parts (nconc (list (mm-dissect-buffer t)) parts)))))
 606       (end-of-line 2)
 607       (or (looking-at boundary)
 608           (forward-line 1))
 609       (setq start (point)))
 610     (when (and start (< start end))
 611       (save-excursion
 612         (save-restriction
 613           (narrow-to-region start end)
 614           (setq parts (nconc (list (mm-dissect-buffer t)) parts)))))
 615     (mm-possibly-verify-or-decrypt (nreverse parts) ctl)))
 616
 617 (defun mm-copy-to-buffer ()
 618   "Copy the contents of the current buffer to a fresh buffer."
 619   (save-excursion
 620     (let ((flag enable-multibyte-characters)
 621           (new-buffer (generate-new-buffer " *mm*")))
 622       (goto-char (point-min))
 623       (search-forward-regexp "^\n" nil t)
 624       (save-restriction
 625         (narrow-to-region (point) (point-max))
 626         (when flag
 627           (set-buffer-multibyte nil))
 628         (copy-to-buffer new-buffer (point-min) (point-max))
 629         (when flag
 630           (set-buffer-multibyte t)))
 631       new-buffer)))
 632
 633 (defun mm-display-parts (handle &optional no-default)
 634   (if (stringp (car handle))
 635       (mapcar 'mm-display-parts (cdr handle))
 636     (if (bufferp (car handle))
 637         (save-restriction
 638           (narrow-to-region (point) (point))
 639           (mm-display-part handle)
 640           (goto-char (point-max)))
 641       (mapcar 'mm-display-parts handle))))
 642
 643 (defun mm-display-part (handle &optional no-default)
 644   "Display the MIME part represented by HANDLE.
 645 Returns nil if the part is removed; inline if displayed inline;
 646 external if displayed external."
 647   (save-excursion
 648     (mailcap-parse-mailcaps)
 649     (if (mm-handle-displayed-p handle)
 650         (mm-remove-part handle)
 651       (let* ((type (mm-handle-media-type handle))
 652              (method (mailcap-mime-info type))
 653              (filename (or (mail-content-type-get
 654                             (mm-handle-disposition handle) 'filename)
 655                            (mail-content-type-get
 656                             (mm-handle-type handle) 'name)
 657                            "<file>"))
 658              (external mm-enable-external))
 659         (if (and (mm-inlinable-p handle)
 660                  (mm-inlined-p handle))
 661             (progn
 662               (forward-line 1)
 663               (mm-display-inline handle)
 664               'inline)
 665           (when (or method
 666                     (not no-default))
 667             (if (and (not method)
 668                      (equal "text" (car (split-string type))))
 669                 (progn
 670                   (forward-line 1)
 671                   (mm-insert-inline handle (mm-get-part handle))
 672                   'inline)
 673               (if (and method ;; If nil, we always use "save".
 674                        (stringp method) ;; 'mailcap-save-binary-file
 675                        (or (eq mm-enable-external t)
 676                            (and (eq mm-enable-external 'ask)
 677                                 (y-or-n-p
 678                                  (concat
 679                                   "Display part (" type
 680                                   ") using external program"
 681                                   ;; Can non-string method ever happen?
 682                                   (if (stringp method)
 683                                       (concat
 684                                        " \"" (format method filename) "\"")
 685                                     "")
 686                                   "? ")))))
 687                   (setq external t)
 688                 (setq external nil))
 689               (if external
 690                   (mm-display-external
 691                    handle (or method 'mailcap-save-binary-file))
 692                 (mm-display-external
 693                  handle 'mailcap-save-binary-file)))))))))
 694
 695 (defun mm-display-external (handle method)
 696   "Display HANDLE using METHOD."
 697   (let ((outbuf (current-buffer)))
 698     (mm-with-unibyte-buffer
 699       (if (functionp method)
 700           (let ((cur (current-buffer)))
 701             (if (eq method 'mailcap-save-binary-file)
 702                 (progn
 703                   (set-buffer (generate-new-buffer " *mm*"))
 704                   (setq method nil))
 705               (mm-insert-part handle)
 706               (let ((win (get-buffer-window cur t)))
 707                 (when win
 708                   (select-window win)))
 709               (switch-to-buffer (generate-new-buffer " *mm*")))
 710             (buffer-disable-undo)
 711             (mm-set-buffer-file-coding-system mm-binary-coding-system)
 712             (insert-buffer-substring cur)
 713             (goto-char (point-min))
 714             (when method
 715               (message "Viewing with %s" method))
 716             (let ((mm (current-buffer))
 717                   (non-viewer (assq 'non-viewer
 718                                     (mailcap-mime-info
 719                                      (mm-handle-media-type handle) t))))
 720               (unwind-protect
 721                   (if method
 722                       (funcall method)
 723                     (mm-save-part handle))
 724                 (when (and (not non-viewer)
 725                            method)
 726                   (mm-handle-set-undisplayer handle mm)))))
 727         ;; The function is a string to be executed.
 728         (mm-insert-part handle)
 729         (let* ((dir (mm-make-temp-file
 730                      (expand-file-name "emm." mm-tmp-directory) 'dir))
 731                (filename (or
 732                           (mail-content-type-get
 733                            (mm-handle-disposition handle) 'filename)
 734                           (mail-content-type-get
 735                            (mm-handle-type handle) 'name)))
 736                (mime-info (mailcap-mime-info
 737                            (mm-handle-media-type handle) t))
 738                (needsterm (or (assoc "needsterm" mime-info)
 739                               (assoc "needsterminal" mime-info)))
 740                (copiousoutput (assoc "copiousoutput" mime-info))
 741                file buffer)
 742           ;; We create a private sub-directory where we store our files.
 743           (set-file-modes dir 448)
 744           (if filename
 745               (setq file (expand-file-name
 746                           (gnus-map-function mm-file-name-rewrite-functions
 747                                              (file-name-nondirectory filename))
 748                           dir))
 749             (setq file (mm-make-temp-file (expand-file-name "mm." dir))))
 750           (let ((coding-system-for-write mm-binary-coding-system))
 751             (write-region (point-min) (point-max) file nil 'nomesg))
 752           (message "Viewing with %s" method)
 753           (cond
 754            (needsterm
 755             (let ((command (mm-mailcap-command
 756                             method file (mm-handle-type handle))))
 757               (unwind-protect
 758                   (if window-system
 759                       (start-process "*display*" nil
 760                                      mm-external-terminal-program
 761                                      "-e" shell-file-name
 762                                      shell-command-switch command)
 763                     (require 'term)
 764                     (require 'gnus-win)
 765                     (set-buffer
 766                      (setq buffer
 767                            (make-term "display"
 768                                       shell-file-name
 769                                       nil
 770                                       shell-command-switch command)))
 771                     (term-mode)
 772                     (term-char-mode)
 773                     (set-process-sentinel
 774                      (get-buffer-process buffer)
 775                      `(lambda (process state)
 776                         (if (eq 'exit (process-status process))
 777                             (gnus-configure-windows
 778                              ',gnus-current-window-configuration))))
 779                     (gnus-configure-windows 'display-term))
 780                 (mm-handle-set-external-undisplayer handle (cons file buffer)))
 781               (message "Displaying %s..." command))
 782             'external)
 783            (copiousoutput
 784             (with-current-buffer outbuf
 785               (forward-line 1)
 786               (mm-insert-inline
 787                handle
 788                (unwind-protect
 789                    (progn
 790                      (call-process shell-file-name nil
 791                                    (setq buffer
 792                                          (generate-new-buffer " *mm*"))
 793                                    nil
 794                                    shell-command-switch
 795                                    (mm-mailcap-command
 796                                     method file (mm-handle-type handle)))
 797                      (if (buffer-live-p buffer)
 798                          (save-excursion
 799                            (set-buffer buffer)
 800                            (buffer-string))))
 801                  (progn
 802                    (ignore-errors (delete-file file))
 803                    (ignore-errors (delete-directory
 804                                    (file-name-directory file)))
 805                    (ignore-errors (kill-buffer buffer))))))
 806             'inline)
 807            (t
 808             (let ((command (mm-mailcap-command
 809                             method file (mm-handle-type handle))))
 810               (unwind-protect
 811                   (start-process "*display*"
 812                                  (setq buffer
 813                                        (generate-new-buffer " *mm*"))
 814                                  shell-file-name
 815                                  shell-command-switch command)
 816                 (mm-handle-set-external-undisplayer
 817                  handle (cons file buffer)))
 818               (message "Displaying %s..." command))
 819             'external)))))))
 820
 821 (defun mm-mailcap-command (method file type-list)
 822   (let ((ctl (cdr type-list))
 823         (beg 0)
 824         (uses-stdin t)
 825         out sub total)
 826     (while (string-match "%{\\([^}]+\\)}\\|'%s'\\|\"%s\"\\|%s\\|%t\\|%%"
 827                          method beg)
 828       (push (substring method beg (match-beginning 0)) out)
 829       (setq beg (match-end 0)
 830             total (match-string 0 method)
 831             sub (match-string 1 method))
 832       (cond
 833        ((string= total "%%")
 834         (push "%" out))
 835        ((or (string= total "%s")
 836             ;; We do our own quoting.
 837             (string= total "'%s'")
 838             (string= total "\"%s\""))
 839         (setq uses-stdin nil)
 840         (push (shell-quote-argument
 841                (gnus-map-function mm-path-name-rewrite-functions file)) out))
 842        ((string= total "%t")
 843         (push (shell-quote-argument (car type-list)) out))
 844        (t
 845         (push (shell-quote-argument (or (cdr (assq (intern sub) ctl)) "")) out))))
 846     (push (substring method beg (length method)) out)
 847     (when uses-stdin
 848       (push "<" out)
 849       (push (shell-quote-argument
 850              (gnus-map-function mm-path-name-rewrite-functions file))
 851             out))
 852     (mapconcat 'identity (nreverse out) "")))
 853
 854 (defun mm-remove-parts (handles)
 855   "Remove the displayed MIME parts represented by HANDLES."
 856   (if (and (listp handles)
 857            (bufferp (car handles)))
 858       (mm-remove-part handles)
 859     (let (handle)
 860       (while (setq handle (pop handles))
 861         (cond
 862          ((stringp handle)
 863           (when (buffer-live-p (get-text-property 0 'buffer handle))
 864             (kill-buffer (get-text-property 0 'buffer handle))))
 865          ((and (listp handle)
 866                (stringp (car handle)))
 867           (mm-remove-parts (cdr handle)))
 868          (t
 869           (mm-remove-part handle)))))))
 870
 871 (defun mm-destroy-parts (handles)
 872   "Remove the displayed MIME parts represented by HANDLES."
 873   (if (and (listp handles)
 874            (bufferp (car handles)))
 875       (mm-destroy-part handles)
 876     (let (handle)
 877       (while (setq handle (pop handles))
 878         (cond
 879          ((stringp handle)
 880           (when (buffer-live-p (get-text-property 0 'buffer handle))
 881             (kill-buffer (get-text-property 0 'buffer handle))))
 882          ((and (listp handle)
 883                (stringp (car handle)))
 884           (mm-destroy-parts handle))
 885          (t
 886           (mm-destroy-part handle)))))))
 887
 888 (defun mm-remove-part (handle)
 889   "Remove the displayed MIME part represented by HANDLE."
 890   (when (listp handle)
 891     (let ((object (mm-handle-undisplayer handle)))
 892       (ignore-errors
 893         (cond
 894          ;; Internally displayed part.
 895          ((mm-annotationp object)
 896           (delete-annotation object))
 897          ((or (functionp object)
 898               (and (listp object)
 899                    (eq (car object) 'lambda)))
 900           (funcall object))
 901          ;; Externally displayed part.
 902          ((consp object)
 903           (condition-case ()
 904               (while (get-buffer-process (cdr object))
 905                 (interrupt-process (get-buffer-process (cdr object)))
 906                 (message "Waiting for external displayer to die...")
 907                 (sit-for 1))
 908             (quit)
 909             (error))
 910           (ignore-errors (and (cdr object) (kill-buffer (cdr object))))
 911           (message "Waiting for external displayer to die...done")
 912           (ignore-errors (delete-file (car object)))
 913           (ignore-errors (delete-directory (file-name-directory
 914                                             (car object)))))
 915          ((bufferp object)
 916           (when (buffer-live-p object)
 917             (kill-buffer object)))))
 918       (mm-handle-set-undisplayer handle nil))))
 919
 920 (defun mm-display-inline (handle)
 921   (let* ((type (mm-handle-media-type handle))
 922          (function (cadr (mm-assoc-string-match mm-inline-media-tests type))))
 923     (funcall function handle)
 924     (goto-char (point-min))))
 925
 926 (defun mm-assoc-string-match (alist type)
 927   (dolist (elem alist)
 928     (when (string-match (car elem) type)
 929       (return elem))))
 930
 931 (defun mm-automatic-display-p (handle)
 932   "Say whether the user wants HANDLE to be displayed automatically."
 933   (let ((methods mm-automatic-display)
 934         (type (mm-handle-media-type handle))
 935         method result)
 936     (while (setq method (pop methods))
 937       (when (and (not (mm-inline-override-p handle))
 938                  (string-match method type))
 939         (setq result t
 940               methods nil)))
 941     result))
 942
 943 (defun mm-inlinable-p (handle)
 944   "Say whether HANDLE can be displayed inline."
 945   (let ((alist mm-inline-media-tests)
 946         (type (mm-handle-media-type handle))
 947         test)
 948     (while alist
 949       (when (string-match (caar alist) type)
 950         (setq test (caddar alist)
 951               alist nil)
 952         (setq test (funcall test handle)))
 953       (pop alist))
 954     test))
 955
 956 (defun mm-inlined-p (handle)
 957   "Say whether the user wants HANDLE to be displayed inline."
 958   (let ((methods mm-inlined-types)
 959         (type (mm-handle-media-type handle))
 960         method result)
 961     (while (setq method (pop methods))
 962       (when (and (not (mm-inline-override-p handle))
 963                  (string-match method type))
 964         (setq result t
 965               methods nil)))
 966     result))
 967
 968 (defun mm-attachment-override-p (handle)
 969   "Say whether HANDLE should have attachment behavior overridden."
 970   (let ((types mm-attachment-override-types)
 971         (type (mm-handle-media-type handle))
 972         ty)
 973     (catch 'found
 974       (while (setq ty (pop types))
 975         (when (and (string-match ty type)
 976                    (mm-inlinable-p handle))
 977           (throw 'found t))))))
 978
 979 (defun mm-inline-override-p (handle)
 980   "Say whether HANDLE should have inline behavior overridden."
 981   (let ((types mm-inline-override-types)
 982         (type (mm-handle-media-type handle))
 983         ty)
 984     (catch 'found
 985       (while (setq ty (pop types))
 986         (when (string-match ty type)
 987           (throw 'found t))))))
 988
 989 (defun mm-automatic-external-display-p (type)
 990   "Return the user-defined method for TYPE."
 991   (let ((methods mm-automatic-external-display)
 992         method result)
 993     (while (setq method (pop methods))
 994       (when (string-match method type)
 995         (setq result t
 996               methods nil)))
 997     result))
 998
 999 (defun mm-destroy-part (handle)
1000   "Destroy the data structures connected to HANDLE."
1001   (when (listp handle)
1002     (mm-remove-part handle)
1003     (when (buffer-live-p (mm-handle-buffer handle))
1004       (kill-buffer (mm-handle-buffer handle)))))
1005
1006 (defun mm-handle-displayed-p (handle)
1007   "Say whether HANDLE is displayed or not."
1008   (mm-handle-undisplayer handle))
1009
1010 ;;;
1011 ;;; Functions for outputting parts
1012 ;;;
1013
1014 (defun mm-get-part (handle)
1015   "Return the contents of HANDLE as a string."
1016   (mm-with-unibyte-buffer
1017     (insert (with-current-buffer (mm-handle-buffer handle)
1018               (mm-with-unibyte-current-buffer
1019                 (buffer-string))))
1020     (mm-decode-content-transfer-encoding
1021      (mm-handle-encoding handle)
1022      (mm-handle-media-type handle))
1023     (buffer-string)))
1024
1025 (defun mm-insert-part (handle)
1026   "Insert the contents of HANDLE in the current buffer."
1027   (let ((cur (current-buffer)))
1028     (save-excursion
1029       (if (member (mm-handle-media-supertype handle) '("text" "message"))
1030           (with-temp-buffer
1031             (insert-buffer-substring (mm-handle-buffer handle))
1032             (prog1
1033                 (mm-decode-content-transfer-encoding
1034                  (mm-handle-encoding handle)
1035                  (mm-handle-media-type handle))
1036               (let ((temp (current-buffer)))
1037                 (set-buffer cur)
1038                 (insert-buffer-substring temp))))
1039         (mm-with-unibyte-buffer
1040           (insert-buffer-substring (mm-handle-buffer handle))
1041           (prog1
1042               (mm-decode-content-transfer-encoding
1043                (mm-handle-encoding handle)
1044                (mm-handle-media-type handle))
1045             (let ((temp (current-buffer)))
1046               (set-buffer cur)
1047               (insert-buffer-substring temp))))))))
1048
1049 (defun mm-file-name-delete-whitespace (file-name)
1050   "Remove all whitespace characters from FILE-NAME."
1051   (while (string-match "\\s-+" file-name)
1052     (setq file-name (replace-match "" t t file-name)))
1053   file-name)
1054
1055 (defun mm-file-name-trim-whitespace (file-name)
1056   "Remove leading and trailing whitespace characters from FILE-NAME."
1057   (when (string-match "\\`\\s-+" file-name)
1058     (setq file-name (substring file-name (match-end 0))))
1059   (when (string-match "\\s-+\\'" file-name)
1060     (setq file-name (substring file-name 0 (match-beginning 0))))
1061   file-name)
1062
1063 (defun mm-file-name-collapse-whitespace (file-name)
1064   "Collapse multiple whitespace characters in FILE-NAME."
1065   (while (string-match "\\s-\\s-+" file-name)
1066     (setq file-name (replace-match " " t t file-name)))
1067   file-name)
1068
1069 (defun mm-file-name-replace-whitespace (file-name)
1070   "Replace whitespace characters in FILE-NAME with underscores.
1071 Set the option `mm-file-name-replace-whitespace' to any other
1072 string if you do not like underscores."
1073   (let ((s (or mm-file-name-replace-whitespace "_")))
1074     (while (string-match "\\s-" file-name)
1075       (setq file-name (replace-match s t t file-name))))
1076   file-name)
1077
1078 (defun mm-file-name-delete-control (filename)
1079   "Delete control characters from FILENAME."
1080   (gnus-replace-in-string filename "[\x00-\x1f\x7f]" ""))
1081
1082 (defun mm-file-name-delete-gotchas (filename)
1083   "Delete shell gotchas from FILENAME."
1084   (setq filename (gnus-replace-in-string filename "[<>|]" ""))
1085   (gnus-replace-in-string filename "^[.-]+" ""))
1086
1087 (defun mm-save-part (handle)
1088   "Write HANDLE to a file."
1089   (let* ((name (mail-content-type-get (mm-handle-type handle) 'name))
1090          (filename (mail-content-type-get
1091                     (mm-handle-disposition handle) 'filename))
1092          file)
1093     (when filename
1094       (setq filename (gnus-map-function mm-file-name-rewrite-functions
1095                                         (file-name-nondirectory filename))))
1096     (setq file
1097           (mm-with-multibyte
1098             (read-file-name "Save MIME part to: "
1099                             (or mm-default-directory default-directory)
1100                             nil nil (or filename name ""))))
1101     (setq mm-default-directory (file-name-directory file))
1102     (and (or (not (file-exists-p file))
1103              (yes-or-no-p (format "File %s already exists; overwrite? "
1104                                   file)))
1105          (progn
1106            (mm-save-part-to-file handle file)
1107            file))))
1108
1109 (defun mm-save-part-to-file (handle file)
1110   (mm-with-unibyte-buffer
1111     (mm-insert-part handle)
1112     (let ((coding-system-for-write 'binary)
1113           (current-file-modes (default-file-modes))
1114           ;; Don't re-compress .gz & al.  Arguably we should make
1115           ;; `file-name-handler-alist' nil, but that would chop
1116           ;; ange-ftp, which is reasonable to use here.
1117           (inhibit-file-name-operation 'write-region)
1118           (inhibit-file-name-handlers
1119            (cons 'jka-compr-handler inhibit-file-name-handlers)))
1120       (set-default-file-modes mm-attachment-file-modes)
1121       (unwind-protect
1122           (write-region (point-min) (point-max) file)
1123         (set-default-file-modes current-file-modes)))))
1124
1125 (defun mm-pipe-part (handle)
1126   "Pipe HANDLE to a process."
1127   (let* ((name (mail-content-type-get (mm-handle-type handle) 'name))
1128          (command
1129           (read-string "Shell command on MIME part: " mm-last-shell-command)))
1130     (mm-with-unibyte-buffer
1131       (mm-insert-part handle)
1132       (let ((coding-system-for-write 'binary))
1133         (shell-command-on-region (point-min) (point-max) command nil)))))
1134
1135 (defun mm-interactively-view-part (handle)
1136   "Display HANDLE using METHOD."
1137   (let* ((type (mm-handle-media-type handle))
1138          (methods
1139           (mapcar (lambda (i) (list (cdr (assoc 'viewer i))))
1140                   (mailcap-mime-info type 'all)))
1141          (method (let ((minibuffer-local-completion-map
1142                         mm-viewer-completion-map))
1143                    (completing-read "Viewer: " methods))))
1144     (when (string= method "")
1145       (error "No method given"))
1146     (if (string-match "^[^% \t]+$" method)
1147         (setq method (concat method " %s")))
1148     (mm-display-external handle method)))
1149
1150 (defun mm-preferred-alternative (handles &optional preferred)
1151   "Say which of HANDLES are preferred."
1152   (let ((prec (if preferred (list preferred)
1153                 (mm-preferred-alternative-precedence handles)))
1154         p h result type handle)
1155     (while (setq p (pop prec))
1156       (setq h handles)
1157       (while h
1158         (setq handle (car h))
1159         (setq type (mm-handle-media-type handle))
1160         (when (and (equal p type)
1161                    (mm-automatic-display-p handle)
1162                    (or (stringp (car handle))
1163                        (not (mm-handle-disposition handle))
1164                        (equal (car (mm-handle-disposition handle))
1165                               "inline")))
1166           (setq result handle
1167                 h nil
1168                 prec nil))
1169         (pop h)))
1170     result))
1171
1172 (defun mm-preferred-alternative-precedence (handles)
1173   "Return the precedence based on HANDLES and `mm-discouraged-alternatives'."
1174   (let ((seq (nreverse (mapcar #'mm-handle-media-type
1175                                handles))))
1176     (dolist (disc (reverse mm-discouraged-alternatives))
1177       (dolist (elem (copy-sequence seq))
1178         (when (string-match disc elem)
1179           (setq seq (nconc (delete elem seq) (list elem))))))
1180     seq))
1181
1182 (defun mm-get-content-id (id)
1183   "Return the handle(s) referred to by ID."
1184   (cdr (assoc id mm-content-id-alist)))
1185
1186 (defconst mm-image-type-regexps
1187   '(("/\\*.*XPM.\\*/" . xpm)
1188     ("P[1-6]" . pbm)
1189     ("GIF8" . gif)
1190     ("\377\330" . jpeg)
1191     ("\211PNG\r\n" . png)
1192     ("#define" . xbm)
1193     ("\\(MM\0\\*\\)\\|\\(II\\*\0\\)" . tiff)
1194     ("%!PS" . postscript))
1195   "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types.
1196 When the first bytes of an image file match REGEXP, it is assumed to
1197 be of image type IMAGE-TYPE.")
1198
1199 ;; Steal from image.el. image-type-from-data suffers multi-line matching bug.
1200 (defun mm-image-type-from-buffer ()
1201   "Determine the image type from data in the current buffer.
1202 Value is a symbol specifying the image type or nil if type cannot
1203 be determined."
1204   (let ((types mm-image-type-regexps)
1205         type)
1206     (goto-char (point-min))
1207     (while (and types (null type))
1208       (let ((regexp (car (car types)))
1209             (image-type (cdr (car types))))
1210         (when (looking-at regexp)
1211           (setq type image-type))
1212         (setq types (cdr types))))
1213     type))
1214
1215 (defun mm-get-image (handle)
1216   "Return an image instance based on HANDLE."
1217   (let ((type (mm-handle-media-subtype handle))
1218         spec)
1219     ;; Allow some common translations.
1220     (setq type
1221           (cond
1222            ((equal type "x-pixmap")
1223             "xpm")
1224            ((equal type "x-xbitmap")
1225             "xbm")
1226            ((equal type "x-portable-bitmap")
1227             "pbm")
1228            (t type)))
1229     (or (mm-handle-cache handle)
1230         (mm-with-unibyte-buffer
1231           (mm-insert-part handle)
1232           (prog1
1233               (setq spec
1234                     (ignore-errors
1235                       ;; Avoid testing `make-glyph' since W3 may define
1236                       ;; a bogus version of it.
1237                       (if (fboundp 'create-image)
1238                           (create-image (buffer-string)
1239                                         (or (mm-image-type-from-buffer)
1240                                             (intern type))
1241                                         'data-p)
1242                         (mm-create-image-xemacs type))))
1243             (mm-handle-set-cache handle spec))))))
1244
1245 (defun mm-create-image-xemacs (type)
1246   (cond
1247    ((equal type "xbm")
1248     ;; xbm images require special handling, since
1249     ;; the only way to create glyphs from these
1250     ;; (without a ton of work) is to write them
1251     ;; out to a file, and then create a file
1252     ;; specifier.
1253     (let ((file (mm-make-temp-file
1254                  (expand-file-name "emm.xbm"
1255                                    mm-tmp-directory))))
1256       (unwind-protect
1257           (progn
1258             (write-region (point-min) (point-max) file)
1259             (make-glyph (list (cons 'x file))))
1260         (ignore-errors
1261           (delete-file file)))))
1262    (t
1263     (make-glyph
1264      (vector
1265       (or (mm-image-type-from-buffer)
1266           (intern type))
1267       :data (buffer-string))))))
1268
1269 (defun mm-image-fit-p (handle)
1270   "Say whether the image in HANDLE will fit the current window."
1271   (let ((image (mm-get-image handle)))
1272     (if (fboundp 'glyph-width)
1273         ;; XEmacs' glyphs can actually tell us about their width, so
1274         ;; lets be nice and smart about them.
1275         (or mm-inline-large-images
1276             (and (< (glyph-width image) (window-pixel-width))
1277                  (< (glyph-height image) (window-pixel-height))))
1278       (let* ((size (image-size image))
1279              (w (car size))
1280              (h (cdr size)))
1281         (or mm-inline-large-images
1282             (and (< h (1- (window-height))) ; Don't include mode line.
1283                  (< w (window-width))))))))
1284
1285 (defun mm-valid-image-format-p (format)
1286   "Say whether FORMAT can be displayed natively by Emacs."
1287   (cond
1288    ;; Handle XEmacs
1289    ((fboundp 'valid-image-instantiator-format-p)
1290     (valid-image-instantiator-format-p format))
1291    ;; Handle Emacs 21
1292    ((fboundp 'image-type-available-p)
1293     (and (display-graphic-p)
1294          (image-type-available-p format)))
1295    ;; Nobody else can do images yet.
1296    (t
1297     nil)))
1298
1299 (defun mm-valid-and-fit-image-p (format handle)
1300   "Say whether FORMAT can be displayed natively and HANDLE fits the window."
1301   (and (mm-valid-image-format-p format)
1302        (mm-image-fit-p handle)))
1303
1304 (defun mm-find-part-by-type (handles type &optional notp recursive)
1305   "Search in HANDLES for part with TYPE.
1306 If NOTP, returns first non-matching part.
1307 If RECURSIVE, search recursively."
1308   (let (handle)
1309     (while handles
1310       (if (and recursive (stringp (caar handles)))
1311           (if (setq handle (mm-find-part-by-type (cdar handles) type
1312                                                  notp recursive))
1313               (setq handles nil))
1314         (if (if notp
1315                 (not (equal (mm-handle-media-type (car handles)) type))
1316               (equal (mm-handle-media-type (car handles)) type))
1317             (setq handle (car handles)
1318                   handles nil)))
1319       (setq handles (cdr handles)))
1320     handle))
1321
1322 (defun mm-find-raw-part-by-type (ctl type &optional notp)
1323   (goto-char (point-min))
1324   (let* ((boundary (concat "--" (mm-handle-multipart-ctl-parameter ctl
1325                                                                    'boundary)))
1326          (close-delimiter (concat "^" (regexp-quote boundary) "--[ \t]*$"))
1327          start
1328          (end (save-excursion
1329                 (goto-char (point-max))
1330                 (if (re-search-backward close-delimiter nil t)
1331                     (match-beginning 0)
1332                   (point-max))))
1333          result)
1334     (setq boundary (concat "^" (regexp-quote boundary) "[ \t]*$"))
1335     (while (and (not result)
1336                 (re-search-forward boundary end t))
1337       (goto-char (match-beginning 0))
1338       (when start
1339         (save-excursion
1340           (save-restriction
1341             (narrow-to-region start (1- (point)))
1342             (when (let ((ctl (ignore-errors
1343                                (mail-header-parse-content-type
1344                                 (mail-fetch-field "content-type")))))
1345                     (if notp
1346                         (not (equal (car ctl) type))
1347                       (equal (car ctl) type)))
1348               (setq result (buffer-string))))))
1349       (forward-line 1)
1350       (setq start (point)))
1351     (when (and (not result) start)
1352       (save-excursion
1353         (save-restriction
1354           (narrow-to-region start end)
1355           (when (let ((ctl (ignore-errors
1356                              (mail-header-parse-content-type
1357                               (mail-fetch-field "content-type")))))
1358                   (if notp
1359                       (not (equal (car ctl) type))
1360                     (equal (car ctl) type)))
1361             (setq result (buffer-string))))))
1362     result))
1363
1364 (defvar mm-security-handle nil)
1365
1366 (defsubst mm-set-handle-multipart-parameter (handle parameter value)
1367   ;; HANDLE could be a CTL.
1368   (when handle
1369     (put-text-property 0 (length (car handle)) parameter value
1370                        (car handle))))
1371
1372 (defun mm-possibly-verify-or-decrypt (parts ctl)
1373   (let ((type (car ctl))
1374         (subtype (cadr (split-string (car ctl) "/")))
1375         (mm-security-handle ctl) ;; (car CTL) is the type.
1376         protocol func functest)
1377     (cond
1378      ((or (equal type "application/x-pkcs7-mime")
1379           (equal type "application/pkcs7-mime"))
1380       (with-temp-buffer
1381         (when (and (cond
1382                     ((eq mm-decrypt-option 'never) nil)
1383                     ((eq mm-decrypt-option 'always) t)
1384                     ((eq mm-decrypt-option 'known) t)
1385                     (t (y-or-n-p
1386                         (format "Decrypt (S/MIME) part? "))))
1387                    (mm-view-pkcs7 parts))
1388           (setq parts (mm-dissect-buffer t)))))
1389      ((equal subtype "signed")
1390       (unless (and (setq protocol
1391                          (mm-handle-multipart-ctl-parameter ctl 'protocol))
1392                    (not (equal protocol "multipart/mixed")))
1393         ;; The message is broken or draft-ietf-openpgp-multsig-01.
1394         (let ((protocols mm-verify-function-alist))
1395           (while protocols
1396             (if (and (or (not (setq functest (nth 3 (car protocols))))
1397                          (funcall functest parts ctl))
1398                      (mm-find-part-by-type parts (caar protocols) nil t))
1399                 (setq protocol (caar protocols)
1400                       protocols nil)
1401               (setq protocols (cdr protocols))))))
1402       (setq func (nth 1 (assoc protocol mm-verify-function-alist)))
1403       (when (cond
1404              ((eq mm-verify-option 'never) nil)
1405              ((eq mm-verify-option 'always) t)
1406              ((eq mm-verify-option 'known)
1407               (and func
1408                    (or (not (setq functest
1409                                   (nth 3 (assoc protocol
1410                                                 mm-verify-function-alist))))
1411                        (funcall functest parts ctl))))
1412              (t
1413               (y-or-n-p
1414                (format "Verify signed (%s) part? "
1415                        (or (nth 2 (assoc protocol mm-verify-function-alist))
1416                            (format "protocol=%s" protocol))))))
1417         (save-excursion
1418           (if func
1419               (funcall func parts ctl)
1420             (mm-set-handle-multipart-parameter
1421              mm-security-handle 'gnus-details
1422              (format "Unknown sign protocol (%s)" protocol))))))
1423      ((equal subtype "encrypted")
1424       (unless (setq protocol
1425                     (mm-handle-multipart-ctl-parameter ctl 'protocol))
1426         ;; The message is broken.
1427         (let ((parts parts))
1428           (while parts
1429             (if (assoc (mm-handle-media-type (car parts))
1430                        mm-decrypt-function-alist)
1431                 (setq protocol (mm-handle-media-type (car parts))
1432                       parts nil)
1433               (setq parts (cdr parts))))))
1434       (setq func (nth 1 (assoc protocol mm-decrypt-function-alist)))
1435       (when (cond
1436              ((eq mm-decrypt-option 'never) nil)
1437              ((eq mm-decrypt-option 'always) t)
1438              ((eq mm-decrypt-option 'known)
1439               (and func
1440                    (or (not (setq functest
1441                                   (nth 3 (assoc protocol
1442                                                 mm-decrypt-function-alist))))
1443                        (funcall functest parts ctl))))
1444              (t
1445               (y-or-n-p
1446                (format "Decrypt (%s) part? "
1447                        (or (nth 2 (assoc protocol mm-decrypt-function-alist))
1448                            (format "protocol=%s" protocol))))))
1449         (save-excursion
1450           (if func
1451               (setq parts (funcall func parts ctl))
1452             (mm-set-handle-multipart-parameter
1453              mm-security-handle 'gnus-details
1454              (format "Unknown encrypt protocol (%s)" protocol))))))
1455      (t nil))
1456     parts))
1457
1458 (defun mm-multiple-handles (handles)
1459   (and (listp handles)
1460        (> (length handles) 1)
1461        (or (listp (car handles))
1462            (stringp (car handles)))))
1463
1464 (defun mm-complicated-handles (handles)
1465   (and (listp (car handles))
1466        (> (length handles) 1)))
1467
1468 (defun mm-merge-handles (handles1 handles2)
1469   (append
1470    (if (listp (car handles1))
1471        handles1
1472      (list handles1))
1473    (if (listp (car handles2))
1474        handles2
1475      (list handles2))))
1476
1477 (defun mm-readable-p (handle)
1478   "Say whether the content of HANDLE is readable."
1479   (and (< (with-current-buffer (mm-handle-buffer handle)
1480             (buffer-size)) 10000)
1481        (mm-with-unibyte-buffer
1482          (mm-insert-part handle)
1483          (and (eq (mm-body-7-or-8) '7bit)
1484               (not (mm-long-lines-p 76))))))
1485
1486 (provide 'mm-decode)
1487
1488 ;;; mm-decode.el ends here