cgit.sxemacs.org Git - gnus/blob - lisp/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           beg)
 668       (goto-char (point-min))
 669       (search-forward-regexp "^\n" nil t)
 670       (setq beg (point))
 671     (with-current-buffer
 672        ;; Preserve the data's unibyteness (for url-insert-file-contents).
 673        (let ((default-enable-multibyte-characters (mm-multibyte-p)))
 674           (generate-new-buffer " *mm*"))
 675       (insert-buffer-substring obuf beg)
 676       (current-buffer))))
 677
 678 (defun mm-display-parts (handle &optional no-default)
 679   (if (stringp (car handle))
 680       (mapcar 'mm-display-parts (cdr handle))
 681     (if (bufferp (car handle))
 682         (save-restriction
 683           (narrow-to-region (point) (point))
 684           (mm-display-part handle)
 685           (goto-char (point-max)))
 686       (mapcar 'mm-display-parts handle))))
 687
 688 (defun mm-display-part (handle &optional no-default)
 689   "Display the MIME part represented by HANDLE.
 690 Returns nil if the part is removed; inline if displayed inline;
 691 external if displayed external."
 692   (save-excursion
 693     (mailcap-parse-mailcaps)
 694     (if (mm-handle-displayed-p handle)
 695         (mm-remove-part handle)
 696       (let* ((ehandle (if (equal (mm-handle-media-type handle)
 697                                  "message/external-body")
 698                           (progn
 699                             (unless (mm-handle-cache handle)
 700                               (mm-extern-cache-contents handle))
 701                             (mm-handle-cache handle))
 702                         handle))
 703              (type (mm-handle-media-type ehandle))
 704              (method (mailcap-mime-info type))
 705              (filename (or (mail-content-type-get
 706                             (mm-handle-disposition handle) 'filename)
 707                            (mail-content-type-get
 708                             (mm-handle-type handle) 'name)
 709                            "<file>"))
 710              (external mm-enable-external))
 711         (if (and (mm-inlinable-p ehandle)
 712                  (mm-inlined-p ehandle))
 713             (progn
 714               (forward-line 1)
 715               (mm-display-inline handle)
 716               'inline)
 717           (when (or method
 718                     (not no-default))
 719             (if (and (not method)
 720                      (equal "text" (car (split-string type "/"))))
 721                 (progn
 722                   (forward-line 1)
 723                   (mm-insert-inline handle (mm-get-part handle))
 724                   'inline)
 725               (setq external
 726                     (and method ;; If nil, we always use "save".
 727                        (stringp method) ;; 'mailcap-save-binary-file
 728                        (or (eq mm-enable-external t)
 729                            (and (eq mm-enable-external 'ask)
 730                                 (y-or-n-p
 731                                  (concat
 732                                   "Display part (" type
 733                                   ") using external program"
 734                                   ;; Can non-string method ever happen?
 735                                   (if (stringp method)
 736                                       (concat
 737                                        " \"" (format method filename) "\"")
 738                                     "")
 739                                     "? "))))))
 740               (if external
 741                   (mm-display-external
 742                    handle (or method 'mailcap-save-binary-file))
 743                 (mm-display-external
 744                  handle 'mailcap-save-binary-file)))))))))
 745
 746 (declare-function gnus-configure-windows "gnus-win" (setting &optional force))
 747
 748 (defun mm-display-external (handle method)
 749   "Display HANDLE using METHOD."
 750   (let ((outbuf (current-buffer)))
 751     (mm-with-unibyte-buffer
 752       (if (functionp method)
 753           (let ((cur (current-buffer)))
 754             (if (eq method 'mailcap-save-binary-file)
 755                 (progn
 756                   (set-buffer (generate-new-buffer " *mm*"))
 757                   (setq method nil))
 758               (mm-insert-part handle)
 759               (mm-add-meta-html-tag handle)
 760               (let ((win (get-buffer-window cur t)))
 761                 (when win
 762                   (select-window win)))
 763               (switch-to-buffer (generate-new-buffer " *mm*")))
 764             (buffer-disable-undo)
 765             (mm-set-buffer-file-coding-system mm-binary-coding-system)
 766             (insert-buffer-substring cur)
 767             (goto-char (point-min))
 768             (when method
 769               (message "Viewing with %s" method))
 770             (let ((mm (current-buffer))
 771                   (non-viewer (assq 'non-viewer
 772                                     (mailcap-mime-info
 773                                      (mm-handle-media-type handle) t))))
 774               (unwind-protect
 775                   (if method
 776                       (funcall method)
 777                     (mm-save-part handle))
 778                 (when (and (not non-viewer)
 779                            method)
 780                   (mm-handle-set-undisplayer handle mm)))))
 781         ;; The function is a string to be executed.
 782         (mm-insert-part handle)
 783         (mm-add-meta-html-tag handle)
 784         (let* ((dir (mm-make-temp-file
 785                      (expand-file-name "emm." mm-tmp-directory) 'dir))
 786                (filename (or
 787                           (mail-content-type-get
 788                            (mm-handle-disposition handle) 'filename)
 789                           (mail-content-type-get
 790                            (mm-handle-type handle) 'name)))
 791                (mime-info (mailcap-mime-info
 792                            (mm-handle-media-type handle) t))
 793                (needsterm (or (assoc "needsterm" mime-info)
 794                               (assoc "needsterminal" mime-info)))
 795                (copiousoutput (assoc "copiousoutput" mime-info))
 796                file buffer)
 797           ;; We create a private sub-directory where we store our files.
 798           (set-file-modes dir 448)
 799           (if filename
 800               (setq file (expand-file-name
 801                           (gnus-map-function mm-file-name-rewrite-functions
 802                                              (file-name-nondirectory filename))
 803                           dir))
 804             ;; Use nametemplate (defined in RFC1524) if it is specified
 805             ;; in mailcap.
 806             (let ((suffix (cdr (assoc "nametemplate" mime-info))))
 807               (if (and suffix
 808                        (string-match "\\`%s\\(\\..+\\)\\'" suffix))
 809                   (setq suffix (match-string 1 suffix))
 810                 ;; Otherwise, use a suffix according to
 811                 ;; `mailcap-mime-extensions'.
 812                 (setq suffix (car (rassoc (mm-handle-media-type handle)
 813                                           mailcap-mime-extensions))))
 814               (setq file (mm-make-temp-file (expand-file-name "mm." dir)
 815                                             nil suffix))))
 816           (let ((coding-system-for-write mm-binary-coding-system))
 817             (write-region (point-min) (point-max) file nil 'nomesg))
 818           (message "Viewing with %s" method)
 819           (cond
 820            (needsterm
 821             (let ((command (mm-mailcap-command
 822                             method file (mm-handle-type handle))))
 823               (unwind-protect
 824                   (if window-system
 825                       (start-process "*display*" nil
 826                                      mm-external-terminal-program
 827                                      "-e" shell-file-name
 828                                      shell-command-switch command)
 829                     (require 'term)
 830                     (require 'gnus-win)
 831                     (set-buffer
 832                      (setq buffer
 833                            (make-term "display"
 834                                       shell-file-name
 835                                       nil
 836                                       shell-command-switch command)))
 837                     (term-mode)
 838                     (term-char-mode)
 839                     (set-process-sentinel
 840                      (get-buffer-process buffer)
 841                      `(lambda (process state)
 842                         (if (eq 'exit (process-status process))
 843                             (gnus-configure-windows
 844                              ',gnus-current-window-configuration))))
 845                     (gnus-configure-windows 'display-term))
 846                 (mm-handle-set-external-undisplayer handle (cons file buffer)))
 847               (message "Displaying %s..." command))
 848             'external)
 849            (copiousoutput
 850             (with-current-buffer outbuf
 851               (forward-line 1)
 852               (mm-insert-inline
 853                handle
 854                (unwind-protect
 855                    (progn
 856                      (call-process shell-file-name nil
 857                                    (setq buffer
 858                                          (generate-new-buffer " *mm*"))
 859                                    nil
 860                                    shell-command-switch
 861                                    (mm-mailcap-command
 862                                     method file (mm-handle-type handle)))
 863                      (if (buffer-live-p buffer)
 864                          (with-current-buffer buffer
 865                            (buffer-string))))
 866                  (progn
 867                    (ignore-errors (delete-file file))
 868                    (ignore-errors (delete-directory
 869                                    (file-name-directory file)))
 870                    (ignore-errors (kill-buffer buffer))))))
 871             'inline)
 872            (t
 873             ;; Deleting the temp file should be postponed for some wrappers,
 874             ;; shell scripts, and so on, which might exit right after having
 875             ;; started a viewer command as a background job.
 876             (let ((command (mm-mailcap-command
 877                             method file (mm-handle-type handle))))
 878               (unwind-protect
 879                   (progn
 880                     (start-process "*display*"
 881                                    (setq buffer
 882                                          (generate-new-buffer " *mm*"))
 883                                    shell-file-name
 884                                    shell-command-switch command)
 885                     (set-process-sentinel
 886                      (get-buffer-process buffer)
 887                      (lexical-let ;; Don't use `let'.
 888                          ;; Function used to remove temp file and directory.
 889                          ((fn `(lambda nil
 890                                  ;; Don't use `ignore-errors'.
 891                                  (condition-case nil
 892                                      (delete-file ,file)
 893                                    (error))
 894                                  (condition-case nil
 895                                      (delete-directory
 896                                       ,(file-name-directory file))
 897                                    (error))))
 898                           ;; Form uses to kill the process buffer and
 899                           ;; remove the undisplayer.
 900                           (fm `(progn
 901                                  (kill-buffer ,buffer)
 902                                  ,(macroexpand
 903                                    (list 'mm-handle-set-undisplayer
 904                                          (list 'quote handle)
 905                                          nil))))
 906                           ;; Message to be issued when the process exits.
 907                           (done (format "Displaying %s...done" command))
 908                           ;; In particular, the timer object (which is
 909                           ;; a vector in Emacs but is a list in XEmacs)
 910                           ;; requires that it is lexically scoped.
 911                           (timer (run-at-time 2.0 nil 'ignore)))
 912                        (if (featurep 'xemacs)
 913                            (lambda (process state)
 914                              (when (eq 'exit (process-status process))
 915                                (if (memq timer itimer-list)
 916                                    (set-itimer-function timer fn)
 917                                  (funcall fn))
 918                                (ignore-errors (eval fm))
 919                                (message "%s" done)))
 920                          (lambda (process state)
 921                            (when (eq 'exit (process-status process))
 922                              (if (memq timer timer-list)
 923                                  (timer-set-function timer fn)
 924                                (funcall fn))
 925                              (ignore-errors (eval fm))
 926                              (message "%s" done)))))))
 927                 (mm-handle-set-external-undisplayer
 928                  handle (cons file buffer)))
 929               (message "Displaying %s..." command))
 930             'external)))))))
 931
 932 (defun mm-mailcap-command (method file type-list)
 933   (let ((ctl (cdr type-list))
 934         (beg 0)
 935         (uses-stdin t)
 936         out sub total)
 937     (while (string-match "%{\\([^}]+\\)}\\|'%s'\\|\"%s\"\\|%s\\|%t\\|%%"
 938                          method beg)
 939       (push (substring method beg (match-beginning 0)) out)
 940       (setq beg (match-end 0)
 941             total (match-string 0 method)
 942             sub (match-string 1 method))
 943       (cond
 944        ((string= total "%%")
 945         (push "%" out))
 946        ((or (string= total "%s")
 947             ;; We do our own quoting.
 948             (string= total "'%s'")
 949             (string= total "\"%s\""))
 950         (setq uses-stdin nil)
 951         (push (shell-quote-argument
 952                (gnus-map-function mm-path-name-rewrite-functions file)) out))
 953        ((string= total "%t")
 954         (push (shell-quote-argument (car type-list)) out))
 955        (t
 956         (push (shell-quote-argument (or (cdr (assq (intern sub) ctl)) "")) out))))
 957     (push (substring method beg (length method)) out)
 958     (when uses-stdin
 959       (push "<" out)
 960       (push (shell-quote-argument
 961              (gnus-map-function mm-path-name-rewrite-functions file))
 962             out))
 963     (mapconcat 'identity (nreverse out) "")))
 964
 965 (defun mm-remove-parts (handles)
 966   "Remove the displayed MIME parts represented by HANDLES."
 967   (if (and (listp handles)
 968            (bufferp (car handles)))
 969       (mm-remove-part handles)
 970     (let (handle)
 971       (while (setq handle (pop handles))
 972         (cond
 973          ((stringp handle)
 974           (when (buffer-live-p (get-text-property 0 'buffer handle))
 975             (kill-buffer (get-text-property 0 'buffer handle))))
 976          ((and (listp handle)
 977                (stringp (car handle)))
 978           (mm-remove-parts (cdr handle)))
 979          (t
 980           (mm-remove-part handle)))))))
 981
 982 (defun mm-destroy-parts (handles)
 983   "Remove the displayed MIME parts represented by HANDLES."
 984   (if (and (listp handles)
 985            (bufferp (car handles)))
 986       (mm-destroy-part handles)
 987     (let (handle)
 988       (while (setq handle (pop handles))
 989         (cond
 990          ((stringp handle)
 991           (when (buffer-live-p (get-text-property 0 'buffer handle))
 992             (kill-buffer (get-text-property 0 'buffer handle))))
 993          ((and (listp handle)
 994                (stringp (car handle)))
 995           (mm-destroy-parts handle))
 996          (t
 997           (mm-destroy-part handle)))))))
 998
 999 (defun mm-remove-part (handle)
1000   "Remove the displayed MIME part represented by HANDLE."
1001   (when (listp handle)
1002     (let ((object (mm-handle-undisplayer handle)))
1003       (ignore-errors
1004         (cond
1005          ;; Internally displayed part.
1006          ((mm-annotationp object)
1007           (if (featurep 'xemacs)
1008               (delete-annotation object)))
1009          ((or (functionp object)
1010               (and (listp object)
1011                    (eq (car object) 'lambda)))
1012           (funcall object))
1013          ;; Externally displayed part.
1014          ((consp object)
1015           (condition-case ()
1016               (while (get-buffer-process (cdr object))
1017                 (interrupt-process (get-buffer-process (cdr object)))
1018                 (message "Waiting for external displayer to die...")
1019                 (sit-for 1))
1020             (quit)
1021             (error))
1022           (ignore-errors (and (cdr object) (kill-buffer (cdr object))))
1023           (message "Waiting for external displayer to die...done")
1024           (ignore-errors (delete-file (car object)))
1025           (ignore-errors (delete-directory (file-name-directory
1026                                             (car object)))))
1027          ((bufferp object)
1028           (when (buffer-live-p object)
1029             (kill-buffer object)))))
1030       (mm-handle-set-undisplayer handle nil))))
1031
1032 (defun mm-display-inline (handle)
1033   (let* ((type (mm-handle-media-type handle))
1034          (function (cadr (mm-assoc-string-match mm-inline-media-tests type))))
1035     (funcall function handle)
1036     (goto-char (point-min))))
1037
1038 (defun mm-assoc-string-match (alist type)
1039   (dolist (elem alist)
1040     (when (string-match (car elem) type)
1041       (return elem))))
1042
1043 (defun mm-automatic-display-p (handle)
1044   "Say whether the user wants HANDLE to be displayed automatically."
1045   (let ((methods mm-automatic-display)
1046         (type (mm-handle-media-type handle))
1047         method result)
1048     (while (setq method (pop methods))
1049       (when (and (not (mm-inline-override-p handle))
1050                  (string-match method type))
1051         (setq result t
1052               methods nil)))
1053     result))
1054
1055 (defun mm-inlinable-p (handle &optional type)
1056   "Say whether HANDLE can be displayed inline.
1057 TYPE is the mime-type of the object; it defaults to the one given
1058 in HANDLE."
1059   (unless type (setq type (mm-handle-media-type handle)))
1060   (let ((alist mm-inline-media-tests)
1061         test)
1062     (while alist
1063       (when (string-match (caar alist) type)
1064         (setq test (caddar alist)
1065               alist nil)
1066         (setq test (funcall test handle)))
1067       (pop alist))
1068     test))
1069
1070 (defun mm-inlined-p (handle)
1071   "Say whether the user wants HANDLE to be displayed inline."
1072   (let ((methods mm-inlined-types)
1073         (type (mm-handle-media-type handle))
1074         method result)
1075     (while (setq method (pop methods))
1076       (when (and (not (mm-inline-override-p handle))
1077                  (string-match method type))
1078         (setq result t
1079               methods nil)))
1080     result))
1081
1082 (defun mm-attachment-override-p (handle)
1083   "Say whether HANDLE should have attachment behavior overridden."
1084   (let ((types mm-attachment-override-types)
1085         (type (mm-handle-media-type handle))
1086         ty)
1087     (catch 'found
1088       (while (setq ty (pop types))
1089         (when (and (string-match ty type)
1090                    (mm-inlinable-p handle))
1091           (throw 'found t))))))
1092
1093 (defun mm-inline-override-p (handle)
1094   "Say whether HANDLE should have inline behavior overridden."
1095   (let ((types mm-inline-override-types)
1096         (type (mm-handle-media-type handle))
1097         ty)
1098     (catch 'found
1099       (while (setq ty (pop types))
1100         (when (string-match ty type)
1101           (throw 'found t))))))
1102
1103 (defun mm-automatic-external-display-p (type)
1104   "Return the user-defined method for TYPE."
1105   (let ((methods mm-automatic-external-display)
1106         method result)
1107     (while (setq method (pop methods))
1108       (when (string-match method type)
1109         (setq result t
1110               methods nil)))
1111     result))
1112
1113 (defun mm-destroy-part (handle)
1114   "Destroy the data structures connected to HANDLE."
1115   (when (listp handle)
1116     (mm-remove-part handle)
1117     (when (buffer-live-p (mm-handle-buffer handle))
1118       (kill-buffer (mm-handle-buffer handle)))))
1119
1120 (defun mm-handle-displayed-p (handle)
1121   "Say whether HANDLE is displayed or not."
1122   (mm-handle-undisplayer handle))
1123
1124 ;;;
1125 ;;; Functions for outputting parts
1126 ;;;
1127
1128 (defmacro mm-with-part (handle &rest forms)
1129   "Run FORMS in the temp buffer containing the contents of HANDLE."
1130   `(let* ((handle ,handle)
1131           ;; The multibyteness of the temp buffer should be turned on
1132           ;; if inserting a multibyte string.  Contrarily, the buffer's
1133           ;; multibyteness should be off if inserting a unibyte string,
1134           ;; especially if a string contains 8bit data.
1135           (default-enable-multibyte-characters
1136             (with-current-buffer (mm-handle-buffer handle)
1137               (mm-multibyte-p))))
1138      (with-temp-buffer
1139        (insert-buffer-substring (mm-handle-buffer handle))
1140        (mm-disable-multibyte)
1141        (mm-decode-content-transfer-encoding
1142         (mm-handle-encoding handle)
1143         (mm-handle-media-type handle))
1144        ,@forms)))
1145 (put 'mm-with-part 'lisp-indent-function 1)
1146 (put 'mm-with-part 'edebug-form-spec '(body))
1147
1148 (defun mm-get-part (handle &optional no-cache)
1149   "Return the contents of HANDLE as a string.
1150 If NO-CACHE is non-nil, cached contents of a message/external-body part
1151 are ignored."
1152   (if (and (not no-cache)
1153            (equal (mm-handle-media-type handle) "message/external-body"))
1154       (progn
1155         (unless (mm-handle-cache handle)
1156           (mm-extern-cache-contents handle))
1157         (with-current-buffer (mm-handle-buffer (mm-handle-cache handle))
1158           (buffer-string)))
1159     (mm-with-part handle
1160       (buffer-string))))
1161
1162 (defun mm-insert-part (handle &optional no-cache)
1163   "Insert the contents of HANDLE in the current buffer.
1164 If NO-CACHE is non-nil, cached contents of a message/external-body part
1165 are ignored."
1166   (let ((text (cond ((eq (mail-content-type-get (mm-handle-type handle)
1167                                                 'charset)
1168                          'gnus-decoded)
1169                      (with-current-buffer (mm-handle-buffer handle)
1170                        (buffer-string)))
1171                     ((mm-multibyte-p)
1172                      (mm-string-to-multibyte (mm-get-part handle no-cache)))
1173                     (t
1174                      (mm-get-part handle no-cache)))))
1175     (save-restriction
1176       (widen)
1177       (goto-char
1178        (prog1
1179            (point)
1180          (if (and (eq (get-char-property (max (point-min) (1- (point))) 'face)
1181                       'mm-uu-extract)
1182                   (eq (get-char-property 0 'face text) 'mm-uu-extract))
1183              ;; Separate the extracted parts that have the same faces.
1184              (insert "\n" text)
1185            (insert text)))))))
1186
1187 (defun mm-file-name-delete-whitespace (file-name)
1188   "Remove all whitespace characters from FILE-NAME."
1189   (while (string-match "\\s-+" file-name)
1190     (setq file-name (replace-match "" t t file-name)))
1191   file-name)
1192
1193 (defun mm-file-name-trim-whitespace (file-name)
1194   "Remove leading and trailing whitespace characters from FILE-NAME."
1195   (when (string-match "\\`\\s-+" file-name)
1196     (setq file-name (substring file-name (match-end 0))))
1197   (when (string-match "\\s-+\\'" file-name)
1198     (setq file-name (substring file-name 0 (match-beginning 0))))
1199   file-name)
1200
1201 (defun mm-file-name-collapse-whitespace (file-name)
1202   "Collapse multiple whitespace characters in FILE-NAME."
1203   (while (string-match "\\s-\\s-+" file-name)
1204     (setq file-name (replace-match " " t t file-name)))
1205   file-name)
1206
1207 (defun mm-file-name-replace-whitespace (file-name)
1208   "Replace whitespace characters in FILE-NAME with underscores.
1209 Set the option `mm-file-name-replace-whitespace' to any other
1210 string if you do not like underscores."
1211   (let ((s (or mm-file-name-replace-whitespace "_")))
1212     (while (string-match "\\s-" file-name)
1213       (setq file-name (replace-match s t t file-name))))
1214   file-name)
1215
1216 (defun mm-file-name-delete-control (filename)
1217   "Delete control characters from FILENAME."
1218   (gnus-replace-in-string filename "[\x00-\x1f\x7f]" ""))
1219
1220 (defun mm-file-name-delete-gotchas (filename)
1221   "Delete shell gotchas from FILENAME."
1222   (setq filename (gnus-replace-in-string filename "[<>|]" ""))
1223   (gnus-replace-in-string filename "^[.-]+" ""))
1224
1225 (defun mm-save-part (handle &optional prompt)
1226   "Write HANDLE to a file.
1227 PROMPT overrides the default one used to ask user for a file name."
1228   (let ((filename (or (mail-content-type-get
1229                        (mm-handle-disposition handle) 'filename)
1230                       (mail-content-type-get
1231                        (mm-handle-type handle) 'name)))
1232         file)
1233     (when filename
1234       (setq filename (gnus-map-function mm-file-name-rewrite-functions
1235                                         (file-name-nondirectory filename))))
1236     (setq file
1237           (mm-with-multibyte
1238            (read-file-name (or prompt "Save MIME part to: ")
1239                            (or mm-default-directory default-directory)
1240                            nil nil (or filename ""))))
1241     (setq mm-default-directory (file-name-directory file))
1242     (and (or (not (file-exists-p file))
1243              (yes-or-no-p (format "File %s already exists; overwrite? "
1244                                   file)))
1245          (progn
1246            (mm-save-part-to-file handle file)
1247            file))))
1248
1249 (defun mm-add-meta-html-tag (handle &optional charset)
1250   "Add meta html tag to specify CHARSET of HANDLE in the current buffer.
1251 CHARSET defaults to the one HANDLE specifies.  Existing meta tag that
1252 specifies charset will not be modified.  Return t if meta tag is added
1253 or replaced."
1254   (when (equal (mm-handle-media-type handle) "text/html")
1255     (when (or charset
1256               (setq charset (mail-content-type-get (mm-handle-type handle)
1257                                                    'charset)))
1258       (setq charset (format "\
1259 <meta http-equiv=\"Content-Type\" content=\"text/html; charset=%s\">" charset))
1260       (let ((case-fold-search t))
1261         (goto-char (point-min))
1262         (if (re-search-forward "\
1263 <meta\\s-+http-equiv=[\"']?content-type[\"']?\\s-+content=[\"']\
1264 text/\\(\\sw+\\)\\(?:\;\\s-*charset=\\(.+?\\)\\)?[\"'][^>]*>" nil t)
1265             (if (and (match-beginning 2)
1266                      (string-match "\\`html\\'" (match-string 1)))
1267                 ;; Don't modify existing meta tag.
1268                 nil
1269               ;; Replace it with the one specifying charset.
1270               (replace-match charset)
1271               t)
1272           (if (re-search-forward "<head>\\s-*" nil t)
1273               (insert charset "\n")
1274             (re-search-forward "<html\\(?:\\s-+[^>]+\\|\\s-*\\)>\\s-*" nil t)
1275             (insert "<head>\n" charset "\n</head>\n"))
1276           t)))))
1277
1278 (defun mm-save-part-to-file (handle file)
1279   (mm-with-unibyte-buffer
1280     (mm-insert-part handle)
1281     (mm-add-meta-html-tag handle)
1282     (let ((current-file-modes (default-file-modes)))
1283       (set-default-file-modes mm-attachment-file-modes)
1284       (unwind-protect
1285           ;; Don't re-compress .gz & al.  Arguably we should make
1286           ;; `file-name-handler-alist' nil, but that would chop
1287           ;; ange-ftp, which is reasonable to use here.
1288           (mm-write-region (point-min) (point-max) file nil nil nil 'binary t)
1289         (set-default-file-modes current-file-modes)))))
1290
1291 (defun mm-pipe-part (handle)
1292   "Pipe HANDLE to a process."
1293   (let* ((name (mail-content-type-get (mm-handle-type handle) 'name))
1294          (command
1295           (read-string "Shell command on MIME part: " mm-last-shell-command)))
1296     (mm-with-unibyte-buffer
1297       (mm-insert-part handle)
1298       (mm-add-meta-html-tag handle)
1299       (let ((coding-system-for-write 'binary))
1300         (shell-command-on-region (point-min) (point-max) command nil)))))
1301
1302 (defun mm-interactively-view-part (handle)
1303   "Display HANDLE using METHOD."
1304   (let* ((type (mm-handle-media-type handle))
1305          (methods
1306           (mapcar (lambda (i) (list (cdr (assoc 'viewer i))))
1307                   (mailcap-mime-info type 'all)))
1308          (method (let ((minibuffer-local-completion-map
1309                         mm-viewer-completion-map))
1310                    (completing-read "Viewer: " methods))))
1311     (when (string= method "")
1312       (error "No method given"))
1313     (if (string-match "^[^% \t]+$" method)
1314         (setq method (concat method " %s")))
1315     (mm-display-external handle method)))
1316
1317 (defun mm-preferred-alternative (handles &optional preferred)
1318   "Say which of HANDLES are preferred."
1319   (let ((prec (if preferred (list preferred)
1320                 (mm-preferred-alternative-precedence handles)))
1321         p h result type handle)
1322     (while (setq p (pop prec))
1323       (setq h handles)
1324       (while h
1325         (setq handle (car h))
1326         (setq type (mm-handle-media-type handle))
1327         (when (and (equal p type)
1328                    (mm-automatic-display-p handle)
1329                    (or (stringp (car handle))
1330                        (not (mm-handle-disposition handle))
1331                        (equal (car (mm-handle-disposition handle))
1332                               "inline")))
1333           (setq result handle
1334                 h nil
1335                 prec nil))
1336         (pop h)))
1337     result))
1338
1339 (defun mm-preferred-alternative-precedence (handles)
1340   "Return the precedence based on HANDLES and `mm-discouraged-alternatives'."
1341   (let ((seq (nreverse (mapcar #'mm-handle-media-type
1342                                handles))))
1343     (dolist (disc (reverse mm-discouraged-alternatives))
1344       (dolist (elem (copy-sequence seq))
1345         (when (string-match disc elem)
1346           (setq seq (nconc (delete elem seq) (list elem))))))
1347     seq))
1348
1349 (defun mm-get-content-id (id)
1350   "Return the handle(s) referred to by ID."
1351   (cdr (assoc id mm-content-id-alist)))
1352
1353 (defconst mm-image-type-regexps
1354   '(("/\\*.*XPM.\\*/" . xpm)
1355     ("P[1-6]" . pbm)
1356     ("GIF8" . gif)
1357     ("\377\330" . jpeg)
1358     ("\211PNG\r\n" . png)
1359     ("#define" . xbm)
1360     ("\\(MM\0\\*\\)\\|\\(II\\*\0\\)" . tiff)
1361     ("%!PS" . postscript))
1362   "Alist of (REGEXP . IMAGE-TYPE) pairs used to auto-detect image types.
1363 When the first bytes of an image file match REGEXP, it is assumed to
1364 be of image type IMAGE-TYPE.")
1365
1366 ;; Steal from image.el. image-type-from-data suffers multi-line matching bug.
1367 (defun mm-image-type-from-buffer ()
1368   "Determine the image type from data in the current buffer.
1369 Value is a symbol specifying the image type or nil if type cannot
1370 be determined."
1371   (let ((types mm-image-type-regexps)
1372         type)
1373     (goto-char (point-min))
1374     (while (and types (null type))
1375       (let ((regexp (car (car types)))
1376             (image-type (cdr (car types))))
1377         (when (looking-at regexp)
1378           (setq type image-type))
1379         (setq types (cdr types))))
1380     type))
1381
1382 (defun mm-get-image (handle)
1383   "Return an image instance based on HANDLE."
1384   (let ((type (mm-handle-media-subtype handle))
1385         spec)
1386     ;; Allow some common translations.
1387     (setq type
1388           (cond
1389            ((equal type "x-pixmap")
1390             "xpm")
1391            ((equal type "x-xbitmap")
1392             "xbm")
1393            ((equal type "x-portable-bitmap")
1394             "pbm")
1395            (t type)))
1396     (or (mm-handle-cache handle)
1397         (mm-with-unibyte-buffer
1398           (mm-insert-part handle)
1399           (prog1
1400               (setq spec
1401                     (ignore-errors
1402                       ;; Avoid testing `make-glyph' since W3 may define
1403                       ;; a bogus version of it.
1404                       (if (fboundp 'create-image)
1405                           (create-image (buffer-string)
1406                                         (or (mm-image-type-from-buffer)
1407                                             (intern type))
1408                                         'data-p)
1409                         (mm-create-image-xemacs type))))
1410             (mm-handle-set-cache handle spec))))))
1411
1412 (defun mm-create-image-xemacs (type)
1413   (when (featurep 'xemacs)
1414     (cond
1415      ((equal type "xbm")
1416       ;; xbm images require special handling, since
1417       ;; the only way to create glyphs from these
1418       ;; (without a ton of work) is to write them
1419       ;; out to a file, and then create a file
1420       ;; specifier.
1421       (let ((file (mm-make-temp-file
1422                    (expand-file-name "emm" mm-tmp-directory)
1423                    nil ".xbm")))
1424         (unwind-protect
1425             (progn
1426               (write-region (point-min) (point-max) file)
1427               (make-glyph (list (cons 'x file))))
1428           (ignore-errors
1429             (delete-file file)))))
1430      (t
1431       (make-glyph
1432        (vector
1433         (or (mm-image-type-from-buffer)
1434             (intern type))
1435         :data (buffer-string)))))))
1436
1437 (defun mm-image-fit-p (handle)
1438   "Say whether the image in HANDLE will fit the current window."
1439   (let ((image (mm-get-image handle)))
1440     (or (not image)
1441         (if (featurep 'xemacs)
1442             ;; XEmacs' glyphs can actually tell us about their width, so
1443             ;; lets be nice and smart about them.
1444             (or mm-inline-large-images
1445                 (and (<= (glyph-width image) (window-pixel-width))
1446                      (<= (glyph-height image) (window-pixel-height))))
1447           (let* ((size (image-size image))
1448                  (w (car size))
1449                  (h (cdr size)))
1450             (or mm-inline-large-images
1451                 (and (<= h (1- (window-height))) ; Don't include mode line.
1452                      (<= w (window-width)))))))))
1453
1454 (defun mm-valid-image-format-p (format)
1455   "Say whether FORMAT can be displayed natively by Emacs."
1456   (cond
1457    ;; Handle XEmacs
1458    ((fboundp 'valid-image-instantiator-format-p)
1459     (valid-image-instantiator-format-p format))
1460    ;; Handle Emacs 21
1461    ((fboundp 'image-type-available-p)
1462     (and (display-graphic-p)
1463          (image-type-available-p format)))
1464    ;; Nobody else can do images yet.
1465    (t
1466     nil)))
1467
1468 (defun mm-valid-and-fit-image-p (format handle)
1469   "Say whether FORMAT can be displayed natively and HANDLE fits the window."
1470   (and (mm-valid-image-format-p format)
1471        (mm-image-fit-p handle)))
1472
1473 (defun mm-find-part-by-type (handles type &optional notp recursive)
1474   "Search in HANDLES for part with TYPE.
1475 If NOTP, returns first non-matching part.
1476 If RECURSIVE, search recursively."
1477   (let (handle)
1478     (while handles
1479       (if (and recursive (stringp (caar handles)))
1480           (if (setq handle (mm-find-part-by-type (cdar handles) type
1481                                                  notp recursive))
1482               (setq handles nil))
1483         (if (if notp
1484                 (not (equal (mm-handle-media-type (car handles)) type))
1485               (equal (mm-handle-media-type (car handles)) type))
1486             (setq handle (car handles)
1487                   handles nil)))
1488       (setq handles (cdr handles)))
1489     handle))
1490
1491 (defun mm-find-raw-part-by-type (ctl type &optional notp)
1492   (goto-char (point-min))
1493   (let* ((boundary (concat "--" (mm-handle-multipart-ctl-parameter ctl
1494                                                                    'boundary)))
1495          (close-delimiter (concat "^" (regexp-quote boundary) "--[ \t]*$"))
1496          start
1497          (end (save-excursion
1498                 (goto-char (point-max))
1499                 (if (re-search-backward close-delimiter nil t)
1500                     (match-beginning 0)
1501                   (point-max))))
1502          result)
1503     (setq boundary (concat "^" (regexp-quote boundary) "[ \t]*$"))
1504     (while (and (not result)
1505                 (re-search-forward boundary end t))
1506       (goto-char (match-beginning 0))
1507       (when start
1508         (save-excursion
1509           (save-restriction
1510             (narrow-to-region start (1- (point)))
1511             (when (let* ((ct (mail-fetch-field "content-type"))
1512                          (ctl (and ct (mail-header-parse-content-type ct))))
1513                     (if notp
1514                         (not (equal (car ctl) type))
1515                       (equal (car ctl) type)))
1516               (setq result (buffer-string))))))
1517       (forward-line 1)
1518       (setq start (point)))
1519     (when (and (not result) start)
1520       (save-excursion
1521         (save-restriction
1522           (narrow-to-region start end)
1523           (when (let* ((ct (mail-fetch-field "content-type"))
1524                        (ctl (and ct (mail-header-parse-content-type ct))))
1525                   (if notp
1526                       (not (equal (car ctl) type))
1527                     (equal (car ctl) type)))
1528             (setq result (buffer-string))))))
1529     result))
1530
1531 (defvar mm-security-handle nil)
1532
1533 (defsubst mm-set-handle-multipart-parameter (handle parameter value)
1534   ;; HANDLE could be a CTL.
1535   (when handle
1536     (put-text-property 0 (length (car handle)) parameter value
1537                        (car handle))))
1538
1539 (autoload 'mm-view-pkcs7 "mm-view")
1540
1541 (defun mm-possibly-verify-or-decrypt (parts ctl)
1542   (let ((type (car ctl))
1543         (subtype (cadr (split-string (car ctl) "/")))
1544         (mm-security-handle ctl) ;; (car CTL) is the type.
1545         protocol func functest)
1546     (cond
1547      ((or (equal type "application/x-pkcs7-mime")
1548           (equal type "application/pkcs7-mime"))
1549       (with-temp-buffer
1550         (when (and (cond
1551                     ((eq mm-decrypt-option 'never) nil)
1552                     ((eq mm-decrypt-option 'always) t)
1553                     ((eq mm-decrypt-option 'known) t)
1554                     (t (y-or-n-p
1555                         (format "Decrypt (S/MIME) part? "))))
1556                    (mm-view-pkcs7 parts))
1557           (setq parts (mm-dissect-buffer t)))))
1558      ((equal subtype "signed")
1559       (unless (and (setq protocol
1560                          (mm-handle-multipart-ctl-parameter ctl 'protocol))
1561                    (not (equal protocol "multipart/mixed")))
1562         ;; The message is broken or draft-ietf-openpgp-multsig-01.
1563         (let ((protocols mm-verify-function-alist))
1564           (while protocols
1565             (if (and (or (not (setq functest (nth 3 (car protocols))))
1566                          (funcall functest parts ctl))
1567                      (mm-find-part-by-type parts (caar protocols) nil t))
1568                 (setq protocol (caar protocols)
1569                       protocols nil)
1570               (setq protocols (cdr protocols))))))
1571       (setq func (nth 1 (assoc protocol mm-verify-function-alist)))
1572       (when (cond
1573              ((eq mm-verify-option 'never) nil)
1574              ((eq mm-verify-option 'always) t)
1575              ((eq mm-verify-option 'known)
1576               (and func
1577                    (or (not (setq functest
1578                                   (nth 3 (assoc protocol
1579                                                 mm-verify-function-alist))))
1580                        (funcall functest parts ctl))))
1581              (t
1582               (y-or-n-p
1583                (format "Verify signed (%s) part? "
1584                        (or (nth 2 (assoc protocol mm-verify-function-alist))
1585                            (format "protocol=%s" protocol))))))
1586         (save-excursion
1587           (if func
1588               (setq parts (funcall func parts ctl))
1589             (mm-set-handle-multipart-parameter
1590              mm-security-handle 'gnus-details
1591              (format "Unknown sign protocol (%s)" protocol))))))
1592      ((equal subtype "encrypted")
1593       (unless (setq protocol
1594                     (mm-handle-multipart-ctl-parameter ctl 'protocol))
1595         ;; The message is broken.
1596         (let ((parts parts))
1597           (while parts
1598             (if (assoc (mm-handle-media-type (car parts))
1599                        mm-decrypt-function-alist)
1600                 (setq protocol (mm-handle-media-type (car parts))
1601                       parts nil)
1602               (setq parts (cdr parts))))))
1603       (setq func (nth 1 (assoc protocol mm-decrypt-function-alist)))
1604       (when (cond
1605              ((eq mm-decrypt-option 'never) nil)
1606              ((eq mm-decrypt-option 'always) t)
1607              ((eq mm-decrypt-option 'known)
1608               (and func
1609                    (or (not (setq functest
1610                                   (nth 3 (assoc protocol
1611                                                 mm-decrypt-function-alist))))
1612                        (funcall functest parts ctl))))
1613              (t
1614               (y-or-n-p
1615                (format "Decrypt (%s) part? "
1616                        (or (nth 2 (assoc protocol mm-decrypt-function-alist))
1617                            (format "protocol=%s" protocol))))))
1618         (save-excursion
1619           (if func
1620               (setq parts (funcall func parts ctl))
1621             (mm-set-handle-multipart-parameter
1622              mm-security-handle 'gnus-details
1623              (format "Unknown encrypt protocol (%s)" protocol))))))
1624      (t nil))
1625     parts))
1626
1627 (defun mm-multiple-handles (handles)
1628   (and (listp handles)
1629        (> (length handles) 1)
1630        (or (listp (car handles))
1631            (stringp (car handles)))))
1632
1633 (defun mm-complicated-handles (handles)
1634   (and (listp (car handles))
1635        (> (length handles) 1)))
1636
1637 (defun mm-merge-handles (handles1 handles2)
1638   (append
1639    (if (listp (car handles1))
1640        handles1
1641      (list handles1))
1642    (if (listp (car handles2))
1643        handles2
1644      (list handles2))))
1645
1646 (defun mm-readable-p (handle)
1647   "Say whether the content of HANDLE is readable."
1648   (and (< (with-current-buffer (mm-handle-buffer handle)
1649             (buffer-size)) 10000)
1650        (mm-with-unibyte-buffer
1651          (mm-insert-part handle)
1652          (and (eq (mm-body-7-or-8) '7bit)
1653               (not (mm-long-lines-p 76))))))
1654
1655 (provide 'mm-decode)
1656
1657 ;; arch-tag: 4f35d360-56b8-4030-9388-3ed82d359b9b
1658 ;;; mm-decode.el ends here