cgit.sxemacs.org Git - gnus/blob - lisp/mm-decode.el

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