code.delx.au - gnu-emacs/blob - lisp/gnus/mm-decode.el

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