1 ;;; mh-mime.el --- MH-E MIME support
3 ;; Copyright (C) 1993, 1995, 2001-2011 Free Software Foundation, Inc.
5 ;; Author: Bill Wohler <wohler@newt.com>
6 ;; Maintainer: Bill Wohler <wohler@newt.com>
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;; Message composition of MIME message is done with either MH-style
28 ;; directives for mhn or mhbuild (MH 6.8 or later) or MML (MIME Meta
32 ;; Paragraph code should not fill # lines if MIME enabled.
33 ;; Implement mh-auto-mh-to-mime (if non-nil, \\[mh-send-letter]
34 ;; invokes mh-mh-to-mime automatically before sending.)
35 ;; Actually, instead of mh-auto-mh-to-mime,
36 ;; should read automhnproc from profile.
37 ;; MIME option to mh-forward command to move to content-description
45 (require 'mh-gnus
) ;needed because mh-gnus.el not compiled
54 (autoload 'article-emphasize
"gnus-art")
55 (autoload 'gnus-eval-format
"gnus-spec")
56 (autoload 'mail-content-type-get
"mail-parse")
57 (autoload 'mail-decode-encoded-word-string
"mail-parse")
58 (autoload 'mail-header-parse-content-type
"mail-parse")
59 (autoload 'mail-header-strip
"mail-parse")
60 (autoload 'mail-strip-quoted-names
"mail-utils")
61 (autoload 'message-options-get
"message")
62 (autoload 'message-options-set
"message")
63 (autoload 'message-options-set-recipient
"message")
64 (autoload 'mm-decode-body
"mm-bodies")
65 (autoload 'mm-uu-dissect
"mm-uu")
66 (autoload 'mml-unsecure-message
"mml-sec")
67 (autoload 'rfc2047-decode-region
"rfc2047")
68 (autoload 'widget-convert-button
"wid-edit")
74 ;; This has to be a macro, since we do: (setf (mh-buffer-data) ...)
76 (defmacro mh-buffer-data
()
77 "Convenience macro to get the MIME data structures of the current buffer."
78 `(gethash (current-buffer) mh-globals-hash
))
80 ;; Structure to keep track of MIME handles on a per buffer basis.
81 (mh-defstruct (mh-buffer-data (:conc-name mh-mime-
)
82 (:constructor mh-make-buffer-data
))
83 (handles ()) ; List of MIME handles
84 (handles-cache (make-hash-table)) ; Cache to avoid multiple decodes of
86 (parts-count 0) ; The button number is generated from
88 (part-index-hash (make-hash-table))) ; Avoid incrementing the part number
91 (defvar mh-mm-inline-media-tests
95 (mm-valid-and-fit-image-p 'jpeg handle
)))
99 (mm-valid-and-fit-image-p 'png handle
)))
103 (mm-valid-and-fit-image-p 'gif handle
)))
107 (mm-valid-and-fit-image-p 'tiff handle
)) )
111 (mm-valid-and-fit-image-p 'xbm handle
)))
115 (mm-valid-and-fit-image-p 'xbm handle
)))
119 (mm-valid-and-fit-image-p 'xpm handle
)))
123 (mm-valid-and-fit-image-p 'xpm handle
)))
127 (mm-valid-and-fit-image-p 'bmp handle
)))
128 ("image/x-portable-bitmap"
131 (mm-valid-and-fit-image-p 'pbm handle
)))
132 ("text/plain" mm-inline-text identity
)
133 ("text/enriched" mm-inline-text identity
)
134 ("text/richtext" mm-inline-text identity
)
135 ("text/x-patch" mm-display-patch-inline
137 (locate-library "diff-mode")))
138 ("application/emacs-lisp" mm-display-elisp-inline identity
)
139 ("application/x-emacs-lisp" mm-display-elisp-inline identity
)
141 ,(if (fboundp 'mm-inline-text-html
) 'mm-inline-text-html
'mm-inline-text
)
143 (or (and (boundp 'mm-inline-text-html-renderer
)
144 mm-inline-text-html-renderer
)
145 (and (boundp 'mm-text-html-renderer
) mm-text-html-renderer
))))
147 mh-mm-inline-text-vcard
149 (or (featurep 'vcard
)
150 (locate-library "vcard"))))
151 ("message/delivery-status" mm-inline-text identity
)
152 ("message/rfc822" mh-mm-inline-message identity
)
153 ;;("message/partial" mm-inline-partial identity)
154 ;;("message/external-body" mm-inline-external-body identity)
155 ("text/.*" mm-inline-text identity
)
156 ("audio/wav" mm-inline-audio
158 (and (or (featurep 'nas-sound
) (featurep 'native-sound
))
159 (device-sound-enabled-p))))
163 (and (or (featurep 'nas-sound
) (featurep 'native-sound
))
164 (device-sound-enabled-p))))
165 ("application/pgp-signature" ignore identity
)
166 ("application/x-pkcs7-signature" ignore identity
)
167 ("application/pkcs7-signature" ignore identity
)
168 ("application/x-pkcs7-mime" ignore identity
)
169 ("application/pkcs7-mime" ignore identity
)
170 ("multipart/alternative" ignore identity
)
171 ("multipart/mixed" ignore identity
)
172 ("multipart/related" ignore identity
)
173 ;; Disable audio and image
174 ("audio/.*" ignore ignore
)
175 ("image/.*" ignore ignore
)
176 ;; Default to displaying as text
177 (".*" mm-inline-text mh-mm-readable-p
))
178 "Alist of media types/tests saying whether types can be displayed inline.")
180 (defvar mh-mime-save-parts-directory nil
181 "Default to use for `mh-mime-save-parts-default-directory'.
184 ;; Copied from gnus-art.el (should be checked for other cool things that can
185 ;; be added to the buttons)
186 (defvar mh-mime-button-commands
187 '((mh-press-button "\r" "Toggle Display")))
188 (defvar mh-mime-button-map
189 (let ((map (make-sparse-keymap)))
190 (unless (>= (string-to-number emacs-version
) 21)
191 ;; XEmacs doesn't care.
192 (set-keymap-parent map mh-show-mode-map
))
194 (define-key map
[mouse-2
] 'mh-push-button
))
196 (define-key map
'(button2) 'mh-push-button
))
197 (dolist (c mh-mime-button-commands
)
198 (define-key map
(cadr c
) (car c
)))
200 (defvar mh-mime-button-line-format-alist
205 (defvar mh-mime-button-line-format
"%{%([%p. %d%T]%)%}%e\n")
206 (defvar mh-mime-security-button-pressed nil
)
207 (defvar mh-mime-security-button-line-format
"%{%([[%t:%i]%D]%)%}\n")
208 (defvar mh-mime-security-button-end-line-format
"%{%([[End of %t]%D]%)%}\n")
209 (defvar mh-mime-security-button-line-format-alist
213 (?D pressed-details ?s
)))
214 (defvar mh-mime-security-button-map
215 (let ((map (make-sparse-keymap)))
216 (unless (>= (string-to-number emacs-version
) 21)
217 (set-keymap-parent map mh-show-mode-map
))
218 (define-key map
"\r" 'mh-press-button
)
220 (define-key map
[mouse-2
] 'mh-push-button
))
222 (define-key map
'(button2) 'mh-push-button
))
227 ;;; MH-Folder Commands
232 (defun mh-display-with-external-viewer (part-index)
233 "View attachment externally.
235 If Emacs does not know how to view an attachment, you could save
236 it into a file and then run some program to open it. It is
237 easier, however, to launch the program directly from MH-E with
238 this command. While you'll most likely use this to view
239 spreadsheets and documents, it is also useful to use your browser
240 to view HTML attachments with higher fidelity than what Emacs can
243 This command displays the attachment associated with the button
244 under the cursor. If the cursor is not located over a button,
245 then the cursor first moves to the next button, wrapping to the
246 beginning of the message if necessary. You can provide a numeric
247 prefix argument PART-INDEX to view the attachment labeled with
250 This command tries to provide a reasonable default for the viewer
251 by calling the Emacs function `mailcap-mime-info'. This function
252 usually reads the file \"/etc/mailcap\"."
254 (when (consp part-index
) (setq part-index
(car part-index
)))
255 (mh-folder-mime-action
258 (let* ((part (get-text-property (point) 'mh-data
))
259 (type (mm-handle-media-type part
))
260 (methods (mapcar (lambda (x) (list (cdr (assoc 'viewer x
))))
261 (mailcap-mime-info type
'all
)))
263 (prompt (format "Viewer%s: " (if def
264 (format " (default %s)" def
)
266 (method (completing-read prompt methods nil nil nil nil def
))
267 (folder mh-show-folder-buffer
)
268 (buffer-read-only nil
))
269 (when (string-match "^[^% \t]+$" method
)
270 (setq method
(concat method
" %s")))
271 (flet ((mm-handle-set-external-undisplayer (handle function
)
272 (mh-handle-set-external-undisplayer folder handle function
)))
273 (unwind-protect (mm-display-external part method
)
274 (set-buffer-modified-p nil
)))))
278 (defun mh-folder-inline-mime-part (part-index)
279 "Show attachment verbatim.
281 You can view the raw contents of an attachment with this command.
282 This command displays (or hides) the contents of the attachment
283 associated with the button under the cursor verbatim. If the
284 cursor is not located over a button, then the cursor first moves
285 to the next button, wrapping to the beginning of the message if
288 You can also provide a numeric prefix argument PART-INDEX to view
289 the attachment labeled with that number."
291 (when (consp part-index
) (setq part-index
(car part-index
)))
292 (mh-folder-mime-action part-index
#'mh-mime-inline-part nil
))
294 (defun mh-mime-inline-part ()
295 "Toggle display of the raw MIME part."
297 (let* ((buffer-read-only nil
)
298 (data (get-text-property (point) 'mh-data
))
299 (inserted-flag (get-text-property (point) 'mh-mime-inserted
))
300 (displayed-flag (mm-handle-displayed-p data
))
303 (cond ((and data
(not inserted-flag
) (not displayed-flag
))
304 (let ((contents (mm-get-part data
)))
305 (add-text-properties (mh-line-beginning-position)
306 (mh-line-end-position) '(mh-mime-inserted t
))
307 (setq start
(point-marker))
309 (mm-insert-inline data contents
)
310 (setq end
(point-marker))
312 start
(progn (goto-char start
) (mh-line-end-position))
313 `(mh-region (,start .
,end
)))))
314 ((and data
(or inserted-flag displayed-flag
))
316 (message "MIME part already inserted")))
318 (set-buffer-modified-p nil
)))
321 (defun mh-folder-save-mime-part (part-index)
322 "Save (output) attachment.
324 This command saves the attachment associated with the button under the
325 cursor. If the cursor is not located over a button, then the cursor
326 first moves to the next button, wrapping to the beginning of the
327 message if necessary.
329 You can also provide a numeric prefix argument PART-INDEX to save the
330 attachment labeled with that number.
332 This command prompts you for a filename and suggests a specific name
335 (when (consp part-index
) (setq part-index
(car part-index
)))
336 (mh-folder-mime-action part-index
#'mh-mime-save-part nil
))
338 (defun mh-mime-save-part ()
339 "Save MIME part at point."
341 (let ((data (get-text-property (point) 'mh-data
)))
343 (let ((mm-default-directory
344 (file-name-as-directory (or mh-mime-save-parts-directory
345 default-directory
))))
346 (mh-mm-save-part data
)
347 (setq mh-mime-save-parts-directory mm-default-directory
)))))
350 (defun mh-folder-toggle-mime-part (part-index)
353 This command displays (or hides) the attachment associated with
354 the button under the cursor. If the cursor is not located over a
355 button, then the cursor first moves to the next button, wrapping
356 to the beginning of the message if necessary. This command has
357 the advantage over related commands of working from the MH-Folder
360 You can also provide a numeric prefix argument PART-INDEX to view
361 the attachment labeled with that number. If Emacs does not know
362 how to display the attachment, then Emacs offers to save the
363 attachment in a file."
365 (when (consp part-index
) (setq part-index
(car part-index
)))
366 (mh-folder-mime-action part-index
#'mh-press-button t
))
369 (defun mh-mime-save-parts (prompt)
372 You can save all of the attachments at once with this command.
373 The attachments are saved in the directory specified by the
374 option `mh-mime-save-parts-default-directory' unless you use a
375 prefix argument PROMPT in which case you are prompted for the
376 directory. These directories may be superseded by MH profile
377 components, since this function calls on \"mhstore\" (\"mhn\") to
380 (let ((msg (if (eq major-mode
'mh-show-mode
)
381 (mh-show-buffer-message-number)
383 (folder (if (eq major-mode
'mh-show-mode
)
384 mh-show-folder-buffer
386 (command (if (mh-variant-p 'nmh
) "mhstore" "mhn"))
390 (equal nil mh-mime-save-parts-default-directory
)
391 (equal t mh-mime-save-parts-default-directory
))
392 (not mh-mime-save-parts-directory
))
393 (read-directory-name "Store in directory: " nil nil t
))
395 (equal t mh-mime-save-parts-default-directory
))
396 mh-mime-save-parts-directory
)
397 (read-directory-name (format
398 "Store in directory (default %s): "
399 mh-mime-save-parts-directory
)
400 "" mh-mime-save-parts-directory t
""))
401 ((stringp mh-mime-save-parts-default-directory
)
402 mh-mime-save-parts-default-directory
)
404 mh-mime-save-parts-directory
))))
405 (if (and (equal directory
"") mh-mime-save-parts-directory
)
406 (setq directory mh-mime-save-parts-directory
))
407 (if (not (file-directory-p directory
))
408 (message "No directory specified")
409 (if (equal nil mh-mime-save-parts-default-directory
)
410 (setq mh-mime-save-parts-directory directory
))
411 (with-current-buffer (get-buffer-create mh-log-buffer
)
413 (setq mh-mime-save-parts-directory directory
)
414 (let ((initial-size (mh-truncate-log-buffer)))
416 (expand-file-name command mh-progs
) nil t nil
417 (mh-list-to-string (list folder msg
"-auto"
418 (if (not (mh-variant-p 'nmh
))
420 (if (> (buffer-size) initial-size
)
421 (save-window-excursion
422 (switch-to-buffer-other-window mh-log-buffer
)
426 (defun mh-toggle-mh-decode-mime-flag ()
427 "Toggle the value of `mh-decode-mime-flag'."
429 (setq mh-decode-mime-flag
(not mh-decode-mime-flag
))
431 (message "%s" (if mh-decode-mime-flag
432 "Processing attachments normally"
433 "Displaying raw message")))
436 (defun mh-toggle-mime-buttons ()
437 "Toggle option `mh-display-buttons-for-inline-parts-flag'."
439 (setq mh-display-buttons-for-inline-parts-flag
440 (not mh-display-buttons-for-inline-parts-flag
))
445 ;;; MIME Display Routines
447 (defun mh-mm-inline-message (handle)
448 "Display message, HANDLE.
449 The function decodes the message and displays it. It avoids
450 decoding the same message multiple times."
452 (clean-message-header mh-clean-message-header-flag
)
453 (invisible-headers mh-invisible-header-fields-compiled
)
454 (visible-headers nil
))
457 (narrow-to-region b b
)
458 (mm-insert-part handle
)
460 (or (gethash handle
(mh-mime-handles-cache (mh-buffer-data)))
461 (setf (gethash handle
(mh-mime-handles-cache (mh-buffer-data)))
462 (let ((handles (mm-dissect-buffer nil
)))
464 (mh-mm-uu-dissect-text-parts handles
)
465 (setq handles
(mm-uu-dissect)))
466 (setf (mh-mime-handles (mh-buffer-data))
468 handles
(mh-mime-handles (mh-buffer-data))))
471 (goto-char (point-min))
473 (cond (clean-message-header
474 (mh-clean-msg-header (point-min)
477 (goto-char (point-min)))
479 (mh-start-of-uncleaned-message)))
480 (mh-decode-message-header)
482 ;; The other highlighting types don't need anything special
483 (when (eq mh-highlight-citation-style
'gnus
)
484 (mh-gnus-article-highlight-citation))
485 (goto-char (point-min))
486 (insert "\n------- Forwarded Message\n\n")
488 (mh-display-emphasis)
489 (mm-handle-set-undisplayer
492 (let (buffer-read-only)
493 (if (fboundp 'remove-specifier
)
494 ;; This is only valid on XEmacs.
495 (mapcar (lambda (prop)
497 (face-property 'default prop
) (current-buffer)))
498 '(background background-pixmap foreground
)))
499 (delete-region ,(point-min-marker) ,(point-max-marker)))))))))
502 (defun mh-decode-message-header ()
503 "Decode RFC2047 encoded message header fields."
504 (when mh-decode-mime-flag
505 (let ((buffer-read-only nil
))
506 (rfc2047-decode-region (point-min) (mh-mail-header-end)))))
509 (defun mh-decode-message-subject ()
510 "Decode RFC2047 encoded message header fields."
511 (when mh-decode-mime-flag
513 (let ((buffer-read-only nil
))
514 (rfc2047-decode-region (progn (mh-goto-header-field "Subject:") (point))
515 (progn (mh-header-field-end) (point)))))))
518 (defun mh-mime-display (&optional pre-dissected-handles
)
519 "Display (and possibly decode) MIME handles.
520 Optional argument, PRE-DISSECTED-HANDLES is a list of MIME
521 handles. If present they are displayed otherwise the buffer is
522 parsed and then displayed."
524 (folder mh-show-folder-buffer
)
525 (raw-message-data (buffer-string)))
526 (flet ((mm-handle-set-external-undisplayer
528 (mh-handle-set-external-undisplayer folder handle function
)))
529 (goto-char (point-min))
530 (unless (search-forward "\n\n" nil t
)
531 (goto-char (point-max))
536 ;; If needed dissect the current buffer
537 (if pre-dissected-handles
538 (setq handles pre-dissected-handles
)
539 (if (setq handles
(mm-dissect-buffer nil
))
540 (mh-mm-uu-dissect-text-parts handles
)
541 (setq handles
(mm-uu-dissect)))
542 (setf (mh-mime-handles (mh-buffer-data))
543 (mh-mm-merge-handles handles
544 (mh-mime-handles (mh-buffer-data))))
546 (mh-decode-message-body)))
549 (or (not (stringp (car handles
)))
551 ;; Go to start of message body
552 (goto-char (point-min))
553 (or (search-forward "\n\n" nil t
)
554 (goto-char (point-max)))
557 (delete-region (point) (point-max))
559 ;; Display the MIME handles
560 (mh-mime-display-part handles
))
562 (mh-signature-highlight))))
564 (message "Could not display body: %s" (error-message-string err
))
565 (delete-region (point-min) (point-max))
566 (insert raw-message-data
))))))
568 (defun mh-decode-message-body ()
569 "Decode message based on charset.
570 If message has been encoded for transfer take that into account."
571 (let (ct charset cte
)
572 (goto-char (point-min))
573 (re-search-forward "\n\n" nil t
)
575 (narrow-to-region (point-min) (point))
576 (setq ct
(ignore-errors (mail-header-parse-content-type
577 (message-fetch-field "Content-Type" t
)))
578 charset
(mail-content-type-get ct
'charset
)
579 cte
(message-fetch-field "Content-Transfer-Encoding")))
580 (when (stringp cte
) (setq cte
(mail-header-strip cte
)))
581 (when (or (not ct
) (equal (car ct
) "text/plain"))
583 (narrow-to-region (min (1+ (mh-mail-header-end)) (point-max))
585 (mm-decode-body charset
586 (and cte
(intern (downcase
587 (gnus-strip-whitespace cte
))))
590 (defun mh-mime-display-part (handle)
591 "Decides the viewer to call based on the type of HANDLE."
594 ((not (stringp (car handle
)))
595 (mh-mime-display-single handle
))
596 ((equal (car handle
) "multipart/alternative")
597 (mh-mime-display-alternative (cdr handle
)))
598 ((and mh-pgp-support-flag
599 (or (equal (car handle
) "multipart/signed")
600 (equal (car handle
) "multipart/encrypted")))
601 (mh-mime-display-security handle
))
603 (mh-mime-display-mixed (cdr handle
)))))
605 (defun mh-mime-display-mixed (handles)
606 "Display the list of MIME parts, HANDLES recursively."
607 (mapcar #'mh-mime-display-part handles
))
609 (defun mh-mime-display-alternative (handles)
610 "Choose among the alternatives, HANDLES the part that will be displayed.
611 If no part is preferred then all the parts are displayed."
612 (let* ((preferred (mm-preferred-alternative handles
))
613 (others (loop for x in handles unless
(eq x preferred
) collect x
)))
614 (cond ((and preferred
615 (stringp (car preferred
)))
616 (mh-mime-display-part preferred
)
617 (mh-mime-maybe-display-alternatives others
))
620 (narrow-to-region (point) (if (eobp) (point) (1+ (point))))
621 (mh-mime-display-single preferred
)
622 (mh-mime-maybe-display-alternatives others
)
623 (goto-char (point-max))))
625 (mh-mime-display-mixed handles
)))))
627 (defun mh-mime-maybe-display-alternatives (alternatives)
628 "Show buttons for ALTERNATIVES.
629 If `mh-mime-display-alternatives-flag' is non-nil then display
630 buttons for alternative parts that are usually suppressed."
631 (when (and mh-display-buttons-for-alternatives-flag alternatives
)
632 (insert "\n----------------------------------------------------\n")
633 (insert "Alternatives:\n")
634 (dolist (x alternatives
)
636 (mh-insert-mime-button x
(mh-mime-part-index x
) nil
))
637 (insert "\n----------------------------------------------------\n")))
639 (defun mh-mime-display-security (handle)
640 "Display PGP encrypted/signed message, HANDLE."
642 (narrow-to-region (point) (point))
644 (mh-insert-mime-security-button handle
)
645 (mh-mime-display-mixed (cdr handle
))
647 (let ((mh-mime-security-button-line-format
648 mh-mime-security-button-end-line-format
))
649 (mh-insert-mime-security-button handle
))
650 (mh-mm-set-handle-multipart-parameter
651 handle
'mh-region
(cons (point-min-marker) (point-max-marker)))))
653 (defun mh-mime-display-single (handle)
654 "Display a leaf node, HANDLE in the MIME tree."
655 (let* ((type (mm-handle-media-type handle
))
656 (small-image-flag (mh-small-image-p handle
))
657 (attachmentp (equal (car (mm-handle-disposition handle
))
659 (inlinep (and (equal (car (mm-handle-disposition handle
)) "inline")
660 (mm-inlinable-p handle
)
661 (mm-inlined-p handle
)))
662 (displayp (or inlinep
; show if inline OR
663 (mh-inline-vcard-p handle
); inline vcard OR
664 (and (not attachmentp
) ; if not an attachment
665 (or small-image-flag
; and small image
666 ; and user wants inline
668 (mm-handle-media-supertype handle
)
670 (mm-inlinable-p handle
)
671 (mm-inlined-p handle
)))))))
673 (narrow-to-region (point) (if (eobp) (point) (1+ (point))))
674 (cond ((and mh-pgp-support-flag
675 (equal type
"application/pgp-signature"))
676 nil
) ; skip signatures as they are already handled...
679 (mh-insert-mime-button handle
(mh-mime-part-index handle
) nil
))
681 (not mh-display-buttons-for-inline-parts-flag
))
682 (or (mm-display-part handle
)
683 (mm-display-part handle
))
684 (mh-signature-highlight handle
))
686 mh-display-buttons-for-inline-parts-flag
)
688 (mh-insert-mime-button handle
(mh-mime-part-index handle
) nil
)
690 (mh-mm-display-part handle
)))
691 (goto-char (point-max)))))
693 ;; There is a bug in Gnus inline image display due to which an extra line
694 ;; gets inserted every time it is viewed. To work around that problem we are
695 ;; using an extra property 'mh-region to remember the region that is added
696 ;; when the button is clicked. The region is then deleted to make sure that
697 ;; no extra lines get inserted.
698 (defun mh-mm-display-part (handle)
699 "Toggle display of button for MIME part, HANDLE."
701 (let ((id (get-text-property (point) 'mh-part
))
703 (window (selected-window))
704 (mail-parse-charset 'nil
)
705 (mail-parse-ignored-charsets nil
)
706 region buffer-read-only
)
709 (let ((win (get-buffer-window (current-buffer) t
)))
714 (if (mm-handle-displayed-p handle
)
715 ;; This will remove the part.
717 ;; Delete the button and displayed part (if any)
718 (let ((region (get-text-property point
'mh-region
)))
720 (mh-funcall-if-exists
721 remove-images
(car region
) (cdr region
)))
722 (mm-display-part handle
)
724 (delete-region (car region
) (cdr region
))))
725 ;; Delete button (if it still remains). This happens for
726 ;; externally displayed parts where the previous step does
729 (delete-region (point) (progn (forward-line) (point)))))
731 (delete-region (point) (progn (forward-line 1) (point)))
732 (narrow-to-region (point) (point))
733 ;; Maybe we need another unwind-protect here.
734 (when (equal (mm-handle-media-supertype handle
) "image")
736 (when (and (not (eq (ignore-errors (mm-display-part handle
))
738 (equal (mm-handle-media-supertype handle
)
740 (goto-char (point-min))
742 (when (equal (mm-handle-media-supertype handle
) "text")
743 (when (eq mh-highlight-citation-style
'gnus
)
744 (mh-gnus-article-highlight-citation))
746 (mh-display-emphasis)
747 (mh-signature-highlight handle
))
748 (setq region
(cons (progn (goto-char (point-min))
750 (progn (goto-char (point-max))
752 (when (window-live-p window
)
753 (select-window window
))
756 (mh-insert-mime-button handle id
(mm-handle-displayed-p handle
))
759 (add-text-properties (mh-line-beginning-position)
760 (mh-line-end-position)
761 `(mh-region ,region
)))))))
763 (defun mh-mime-part-index (handle)
764 "Generate the button number for MIME part, HANDLE.
765 Notice that a hash table is used to display the same number when
766 buttons need to be displayed multiple times (for instance when
767 nested messages are opened)."
768 (or (gethash handle
(mh-mime-part-index-hash (mh-buffer-data)))
769 (setf (gethash handle
(mh-mime-part-index-hash (mh-buffer-data)))
770 (incf (mh-mime-parts-count (mh-buffer-data))))))
772 (defun mh-small-image-p (handle)
773 "Decide whether HANDLE is a \"small\" image that can be displayed inline.
774 This is only useful if a Content-Disposition header is not present."
775 (let ((media-test (caddr (assoc (car (mm-handle-type handle
))
776 mh-mm-inline-media-tests
)))
777 (mm-inline-large-images t
))
779 (equal (mm-handle-media-supertype handle
) "image")
780 (funcall media-test handle
) ; Since mm-inline-large-images is T,
781 ; this only tells us if the image is
782 ; something that emacs can display
783 (let* ((image (mm-get-image handle
)))
785 (and (mh-funcall-if-exists glyphp image
)
786 (< (glyph-width image
)
787 (or mh-max-inline-image-width
(window-pixel-width)))
788 (< (glyph-height image
)
789 (or mh-max-inline-image-height
790 (window-pixel-height)))))
792 (let ((size (mh-funcall-if-exists image-size image
)))
794 (< (cdr size
) (or mh-max-inline-image-height
795 (1- (window-height))))
796 (< (car size
) (or mh-max-inline-image-width
797 (window-width)))))))))))
799 (defun mh-inline-vcard-p (handle)
800 "Decide if HANDLE is a vcard that must be displayed inline."
801 (let ((type (mm-handle-type handle
)))
802 (and (or (featurep 'vcard
) (fboundp 'vcard-pretty-print
))
804 (equal (car type
) "text/x-vcard")
808 (goto-char (point-min))
809 (not (mh-signature-separator-p)))))))
811 (defun mh-signature-highlight (&optional handle
)
812 "Highlight message signature in HANDLE.
813 The optional argument, HANDLE is a MIME handle if the function is
814 being used to highlight the signature in a MIME part."
816 (cond ((not handle
) "^-- $")
817 ((not (and (equal (mm-handle-media-supertype handle
) "text")
818 (equal (mm-handle-media-subtype handle
) "html")))
820 ((eq (mh-mm-text-html-renderer) 'lynx
) "^ --$")
823 (goto-char (point-max))
824 (when (re-search-backward regexp nil t
)
826 (let ((ov (make-overlay (point) (point-max))))
827 (overlay-put ov
'face
'mh-show-signature
)
828 (overlay-put ov
'evaporate t
)))
830 (set-extent-property (make-extent (point) (point-max))
831 'face
'mh-show-signature
))))))
843 (defun mh-insert-mime-button (handle index displayed
)
844 "Insert MIME button for HANDLE.
845 INDEX is the part number that will be DISPLAYED. It is also used
846 by commands like \"K v\" which operate on individual MIME parts."
847 ;; The button could be displayed by a previous decode. In that case
848 ;; undisplay it if we need a hidden button.
849 (when (and (mm-handle-displayed-p handle
) (not displayed
))
850 (mm-display-part handle
))
851 (let ((name (or (mail-content-type-get (mm-handle-type handle
) 'name
)
852 (mail-content-type-get (mm-handle-disposition handle
)
854 (mail-content-type-get (mm-handle-type handle
) 'url
)
856 (type (mm-handle-media-type handle
))
857 (description (mail-decode-encoded-word-string
858 (or (mm-handle-description handle
) "")))
859 (dots (if (or displayed
(mm-handle-displayed-p handle
)) " " "..."))
861 (if (string-match ".*/" name
) (setq name
(substring name
(match-end 0))))
862 (setq long-type
(concat type
(and (not (equal name
""))
863 (concat "; " name
))))
864 (unless (equal description
"")
865 (setq long-type
(concat " --- " long-type
)))
866 (unless (bolp) (insert "\n"))
869 mh-mime-button-line-format mh-mime-button-line-format-alist
870 `(,@(mh-gnus-local-map-property mh-mime-button-map
)
871 mh-callback mh-mm-display-part
875 (widget-convert-button
878 :action
'mh-widget-press-button
879 :button-keymap mh-mime-button-map
881 "Mouse-2 click or press RET (in show buffer) to toggle display")
882 (dolist (ov (mh-funcall-if-exists overlays-in begin end
))
883 (mh-funcall-if-exists overlay-put ov
'evaporate t
))))
886 (defvar mm-verify-function-alist
) ; < Emacs 22
887 (defvar mm-decrypt-function-alist
) ; < Emacs 22
889 (defvar pressed-details
))
891 (defun mh-insert-mime-security-button (handle)
892 "Display buttons for PGP message, HANDLE."
893 (let* ((protocol (mh-mm-handle-multipart-ctl-parameter handle
'protocol
))
894 (crypto-type (or (nth 2 (assoc protocol mm-verify-function-alist
))
895 (nth 2 (assoc protocol mm-decrypt-function-alist
))
897 (type (concat crypto-type
898 (if (equal (car handle
) "multipart/signed")
899 " Signed" " Encrypted")
901 (info (or (mh-mm-handle-multipart-ctl-parameter handle
'gnus-info
)
903 (details (mh-mm-handle-multipart-ctl-parameter handle
'gnus-details
))
904 pressed-details begin end face
)
905 (setq details
(if details
(concat "\n" details
) ""))
906 (setq pressed-details
(if mh-mime-security-button-pressed details
""))
907 (setq face
(mh-mime-security-button-face info
))
908 (unless (bolp) (insert "\n"))
911 mh-mime-security-button-line-format
912 mh-mime-security-button-line-format-alist
913 `(,@(mh-gnus-local-map-property mh-mime-security-button-map
)
914 mh-button-pressed
,mh-mime-security-button-pressed
915 mh-callback mh-mime-security-press-button
916 mh-line-format
,mh-mime-security-button-line-format
919 (widget-convert-button 'link begin end
921 :action
'mh-widget-press-button
922 :button-keymap mh-mime-security-button-map
924 :help-echo
"Mouse-2 click or press RET (in show buffer) to see security details.")
925 (dolist (ov (mh-funcall-if-exists overlays-in begin end
))
926 (mh-funcall-if-exists overlay-put ov
'evaporate t
))
927 (when (equal info
"Failed")
928 (let* ((type (if (equal (car handle
) "multipart/signed")
929 "verification" "decryption"))
930 (warning (if (equal type
"decryption")
931 "(passphrase may be incorrect)" "")))
932 (message "%s %s failed %s" crypto-type type warning
)))))
934 (defun mh-mime-security-button-face (info)
935 "Return the button face to use for encrypted/signed mail based on INFO."
936 (cond ((string-match "OK" info
) ;Decrypted mail
938 ((string-match "Failed" info
) ;Decryption failed or signature invalid
940 ((string-match "Undecided" info
);Unprocessed mail
941 'mh-show-pgg-unknown
)
942 ((string-match "Untrusted" info
);Key not trusted
943 'mh-show-pgg-unknown
)
951 (defun mh-folder-mime-action (part-index action include-security-flag
)
952 "Go to PART-INDEX and carry out ACTION.
954 If PART-INDEX is nil then go to the next part in the buffer. The
955 search for the next buffer wraps around if end of buffer is reached.
956 If argument INCLUDE-SECURITY-FLAG is non-nil then include security
957 info buttons when searching for a suitable parts."
958 (unless mh-showing-mode
960 (mh-in-show-buffer (mh-show-buffer)
964 (let ((part (get-text-property p
'mh-part
)))
965 (and (integerp part
) (= part part-index
)))))
967 (if include-security-flag
968 (get-text-property p
'mh-data
)
969 (integerp (get-text-property p
'mh-part
)))))))
971 (cond ((and (get-text-property point
'mh-part
)
972 (or (null part-index
)
973 (= (get-text-property point
'mh-part
) part-index
)))
975 ((and (get-text-property point
'mh-data
)
976 include-security-flag
980 (mh-goto-next-button nil criterion
)
981 (if (= (point) point
)
982 (message "No matching MIME part found")
983 (funcall action
)))))))
986 (defun mh-goto-next-button (backward-flag &optional criterion
)
987 "Search for next button satisfying criterion.
989 If BACKWARD-FLAG is non-nil search backward in the buffer for a mime
991 If CRITERION is a function or a symbol which has a function binding
992 then that function must return non-nil at the button we stop."
993 (unless (or (and (symbolp criterion
) (fboundp criterion
))
994 (functionp criterion
))
995 (setq criterion
(lambda (x) t
)))
996 ;; Move to the next button in the buffer satisfying criterion
997 (goto-char (or (save-excursion
999 ;; Find point before current button
1000 (let ((point-before-current-button
1002 (while (get-text-property (point) 'mh-data
)
1003 (unless (= (forward-line
1004 (if backward-flag
1 -
1))
1007 (goto-char (point-min))
1008 (goto-char (point-max)))))
1010 ;; Skip over current button
1011 (while (and (get-text-property (point) 'mh-data
)
1012 (not (if backward-flag
(bobp) (eobp))))
1013 (forward-line (if backward-flag -
1 1)))
1014 ;; Stop at next MIME button if any exists.
1017 (unless (= (forward-line
1018 (if backward-flag -
1 1))
1021 (goto-char (point-max))
1022 (goto-char (point-min)))
1023 (beginning-of-line))
1025 point-before-current-button
)
1026 (when (and (get-text-property (point) 'mh-data
)
1027 (funcall criterion
(point)))
1028 (return-from loop
(point))))
1032 (defun mh-widget-press-button (widget el
)
1033 "Callback for widget, WIDGET.
1034 Parameter EL is unused."
1035 (goto-char (widget-get widget
:from
))
1038 (defun mh-press-button ()
1039 "View contents of button.
1041 This command is a toggle so if you use it again on the same
1042 attachment, the attachment is hidden."
1044 (let ((mm-inline-media-tests mh-mm-inline-media-tests
)
1045 (data (get-text-property (point) 'mh-data
))
1046 (function (get-text-property (point) 'mh-callback
))
1047 (buffer-read-only nil
)
1048 (folder mh-show-folder-buffer
))
1049 (flet ((mm-handle-set-external-undisplayer
1051 (mh-handle-set-external-undisplayer folder handle function
)))
1052 (when (and function
(eolp))
1054 (unwind-protect (and function
(funcall function data
))
1055 (set-buffer-modified-p nil
)))))
1057 (defun mh-push-button (event)
1058 "Click MIME button for EVENT.
1060 If the MIME part is visible then it is removed. Otherwise the
1061 part is displayed. This function is called when the mouse is used
1062 to click the MIME button."
1064 (mh-do-at-event-location event
1065 (let ((folder mh-show-folder-buffer
)
1066 (mm-inline-media-tests mh-mm-inline-media-tests
)
1067 (data (get-text-property (point) 'mh-data
))
1068 (function (get-text-property (point) 'mh-callback
)))
1069 (flet ((mm-handle-set-external-undisplayer (handle func
)
1070 (mh-handle-set-external-undisplayer folder handle func
)))
1071 (and function
(funcall function data
))))))
1073 (defun mh-handle-set-external-undisplayer (folder handle function
)
1074 "Replacement for `mm-handle-set-external-undisplayer'.
1076 This is only called in recent versions of Gnus. The MIME handles
1077 are stored in data structures corresponding to MH-E folder buffer
1078 FOLDER instead of in Gnus (as in the original). The MIME part,
1079 HANDLE is associated with the undisplayer FUNCTION."
1080 (if (mh-mm-keep-viewer-alive-p handle
)
1081 (let ((new-handle (copy-sequence handle
)))
1082 (mm-handle-set-undisplayer new-handle function
)
1083 (mm-handle-set-undisplayer handle nil
)
1084 (with-current-buffer folder
1085 (push new-handle
(mh-mime-handles (mh-buffer-data)))))
1086 (mm-handle-set-undisplayer handle function
)))
1088 (defun mh-mime-security-press-button (handle)
1089 "Callback from security button for part HANDLE."
1090 (if (mh-mm-handle-multipart-ctl-parameter handle
'gnus-info
)
1091 (mh-mime-security-show-details handle
)
1092 (let ((region (mh-mm-handle-multipart-ctl-parameter handle
'mh-region
))
1094 (setq point
(point))
1095 (goto-char (car region
))
1096 (delete-region (car region
) (cdr region
))
1097 (with-current-buffer (mh-mm-handle-multipart-ctl-parameter handle
'buffer
)
1098 (let* ((mm-verify-option 'known
)
1099 (mm-decrypt-option 'known
)
1100 (new (mh-mm-possibly-verify-or-decrypt (cdr handle
) handle
)))
1101 (unless (eq new
(cdr handle
))
1102 (mh-mm-destroy-parts (cdr handle
))
1103 (setcdr handle new
))))
1104 (mh-mime-display-security handle
)
1105 (goto-char point
))))
1107 ;; I rewrote the security part because Gnus doesn't seem to ever minimize
1108 ;; the button. That is once the mime-security button is pressed there seems
1109 ;; to be no way of getting rid of the inserted text.
1110 (defun mh-mime-security-show-details (handle)
1111 "Toggle display of detailed security info for HANDLE."
1112 (let ((details (mh-mm-handle-multipart-ctl-parameter handle
'gnus-details
)))
1114 (let ((mh-mime-security-button-pressed
1115 (not (get-text-property (point) 'mh-button-pressed
)))
1116 (mh-mime-security-button-line-format
1117 (get-text-property (point) 'mh-line-format
)))
1119 (while (eq (get-text-property (point) 'mh-line-format
)
1120 mh-mime-security-button-line-format
)
1124 (narrow-to-region (point) (point))
1125 (mh-insert-mime-security-button handle
))
1128 (or (text-property-not-all
1130 'mh-line-format mh-mime-security-button-line-format
)
1132 (forward-line -
1)))))
1136 ;;; Miscellaneous Article Washing
1139 (defun mh-add-missing-mime-version-header ()
1140 "Some mail programs don't put a MIME-Version header.
1141 I have seen this only in spam, so maybe we shouldn't fix
1144 (goto-char (point-min))
1145 (re-search-forward "\n\n" nil t
)
1147 (narrow-to-region (point-min) (point))
1148 (when (and (message-fetch-field "content-type")
1149 (not (message-fetch-field "mime-version")))
1150 (goto-char (point-min))
1151 (insert "MIME-Version: 1.0\n")))))
1154 (defun mh-display-smileys ()
1156 (when (and mh-graphical-smileys-flag
(mh-small-show-buffer-p))
1157 (mh-funcall-if-exists smiley-region
(point-min) (point-max))))
1160 (defun mh-display-emphasis ()
1161 "Display graphical emphasis."
1162 (when (and mh-graphical-emphasis-flag
(mh-small-show-buffer-p))
1163 (flet ((article-goto-body ())) ; shadow this function to do nothing
1165 (goto-char (point-min))
1166 (article-emphasize)))))
1168 (defun mh-small-show-buffer-p ()
1169 "Check if show buffer is small.
1170 This is used to decide if smileys and graphical emphasis should be
1173 (when (and (boundp 'font-lock-maximum-size
) font-lock-maximum-size
)
1174 (cond ((numberp font-lock-maximum-size
)
1175 (setq max font-lock-maximum-size
))
1176 ((listp font-lock-maximum-size
)
1177 (setq max
(cdr (or (assoc 'mh-show-mode font-lock-maximum-size
)
1178 (assoc t font-lock-maximum-size
)))))))
1179 (or (not (numberp max
)) (>= (/ max
8) (buffer-size)))))
1183 ;;; MH-Letter Commands
1185 ;; MH-E commands are alphabetical; specific support routines follow command.
1188 (defun mh-compose-forward (&optional description folder range
)
1189 "Add tag to forward a message.
1191 You are prompted for a content DESCRIPTION, the name of the
1192 FOLDER in which the messages to forward are located, and a RANGE
1193 of messages, which defaults to the current message in that
1194 folder. Check the documentation of `mh-interactive-range' to see
1195 how RANGE is read in interactive use.
1197 The option `mh-compose-insertion' controls what type of tags are inserted."
1200 (mml-minibuffer-read-description))
1202 (mh-prompt-for-folder "Message from"
1203 mh-sent-from-folder nil
))
1205 (if (and (equal folder mh-sent-from-folder
)
1206 (numberp mh-sent-from-msg
))
1208 (nth 0 (mh-translate-range folder
"cur"))))
1210 (mh-read-range "Forward" folder
1212 (number-to-string default
))
1215 (list description folder range
)))
1216 (let ((messages (mapconcat 'identity
(mh-list-to-string range
) " ")))
1217 (dolist (message (mh-translate-range folder messages
))
1218 (if (equal mh-compose-insertion
'mml
)
1219 (mh-mml-forward-message description folder
(format "%s" message
))
1220 (mh-mh-forward-message description folder
(format "%s" message
))))))
1223 (defun mh-mml-forward-message (description folder message
)
1224 "Forward a message as attachment.
1226 The function will prompt the user for a DESCRIPTION, a FOLDER and
1228 (let ((msg (if (and (equal message
"") (numberp mh-sent-from-msg
))
1230 (string-to-number message
))))
1231 (cond ((integerp msg
)
1232 (mml-attach-file (format "%s%s/%d"
1233 mh-user-path
(substring folder
1) msg
)
1235 (if (string= "" description
) nil description
)
1237 (t (error "The message number, %s, is not a integer" msg
)))))
1239 (defun mh-mh-forward-message (&optional description folder messages
)
1240 "Add tag to forward a message.
1241 You are prompted for a content DESCRIPTION, the name of the
1242 FOLDER in which the messages to forward are located, and the
1245 See also \\[mh-mh-to-mime]."
1247 (mml-minibuffer-read-description)
1248 (mh-prompt-for-folder "Message from" mh-sent-from-folder nil
)
1249 (read-string (concat "Messages"
1250 (if (numberp mh-sent-from-msg
)
1251 (format " (default %d): "
1257 (not (string= description
""))
1258 (insert description
))
1261 (not (string= folder
""))
1262 (insert " " folder
))
1264 (not (string= messages
"")))
1265 (let ((start (point)))
1266 (insert " " messages
)
1267 (subst-char-in-region start
(point) ?
, ?
))
1268 (if (numberp mh-sent-from-msg
)
1269 (insert " " (int-to-string mh-sent-from-msg
))))
1273 (defun mh-compose-insertion (&optional inline
)
1274 "Add tag to include a file such as an image or sound.
1276 You are prompted for the filename containing the object, the
1277 media type if it cannot be determined automatically, and a
1278 content description. If you're using MH-style directives, you
1279 will also be prompted for additional attributes.
1281 The option `mh-compose-insertion' controls what type of tags are
1282 inserted. Optional argument INLINE means make it an inline
1285 (if (equal mh-compose-insertion
'mml
)
1287 (mh-mml-attach-file "inline")
1288 (mh-mml-attach-file))
1289 (call-interactively 'mh-mh-attach-file
)))
1291 (defun mh-mml-attach-file (&optional disposition
)
1292 "Add a tag to insert a MIME message part from a file.
1294 You are prompted for the filename containing the object, the
1295 media type if it cannot be determined automatically, a content
1296 description and the DISPOSITION of the attachment.
1298 This is basically `mml-attach-file' from Gnus, modified such that a prefix
1299 argument yields an \"inline\" disposition and Content-Type is determined
1301 (let* ((file (mml-minibuffer-read-file "Attach file: "))
1302 (type (mh-minibuffer-read-type file
))
1303 (description (mml-minibuffer-read-description))
1304 (dispos (or disposition
1305 (mh-mml-minibuffer-read-disposition type
))))
1306 (mml-insert-empty-tag 'part
'type type
'filename file
1307 'disposition dispos
'description description
)))
1309 (defun mh-mh-attach-file (filename type description attributes
)
1310 "Add a tag to insert a MIME message part from a file.
1311 You are prompted for the FILENAME containing the object, the
1312 media TYPE if it cannot be determined automatically, and a
1313 content DESCRIPTION. In addition, you are also prompted for
1314 additional ATTRIBUTES.
1316 See also \\[mh-mh-to-mime]."
1317 (interactive (let ((filename (mml-minibuffer-read-file "Attach file: ")))
1320 (mh-minibuffer-read-type filename
)
1321 (mml-minibuffer-read-description)
1322 (read-string "Attributes: "
1324 (file-name-nondirectory filename
)
1326 (mh-mh-compose-type filename type description attributes
))
1328 (defun mh-mh-compose-type (filename type
1329 &optional description attributes comment
)
1330 "Insert an MH-style directive to insert a file.
1331 The file specified by FILENAME is encoded as TYPE. An optional
1332 DESCRIPTION is used as the Content-Description field, optional
1333 set of ATTRIBUTES and an optional COMMENT can also be included."
1337 (insert "; " attributes
))
1339 (insert " (" comment
")"))
1342 (insert description
))
1343 (insert "] " (expand-file-name filename
))
1347 (defun mh-mh-compose-anon-ftp (host filename type description
)
1348 "Add tag to include anonymous ftp reference to a file.
1350 You can have your message initiate an \"ftp\" transfer when the
1351 recipient reads the message. You are prompted for the remote HOST
1352 and FILENAME, the media TYPE, and the content DESCRIPTION.
1354 See also \\[mh-mh-to-mime]."
1356 (read-string "Remote host: ")
1357 (read-string "Remote filename: ")
1358 (mh-minibuffer-read-type "DUMMY-FILENAME")
1359 (mml-minibuffer-read-description)))
1360 (mh-mh-compose-external-type "anon-ftp" host filename
1364 (defun mh-mh-compose-external-compressed-tar (host filename description
)
1365 "Add tag to include anonymous ftp reference to a compressed tar file.
1367 In addition to retrieving the file via anonymous \"ftp\" as per
1368 the command \\[mh-mh-compose-anon-ftp], the file will also be
1369 uncompressed and untarred. You are prompted for the remote HOST
1370 and FILENAME and the content DESCRIPTION.
1372 See also \\[mh-mh-to-mime]."
1374 (read-string "Remote host: ")
1375 (read-string "Remote filename: ")
1376 (mml-minibuffer-read-description)))
1377 (mh-mh-compose-external-type "anon-ftp" host filename
1378 "application/octet-stream"
1380 "type=tar; conversions=x-compress"
1383 ;; RFC 2045 - Multipurpose Internet Mail Extensions (MIME) Part One:
1384 ;; Format of Internet Message Bodies.
1385 ;; RFC 2046 - Multipurpose Internet Mail Extensions (MIME) Part Two:
1387 ;; RFC 2049 - Multipurpose Internet Mail Extensions (MIME) Part Five:
1388 ;; Conformance Criteria and Examples.
1389 ;; RFC 2017 - Definition of the URL MIME External-Body Access-Type
1390 ;; RFC 1738 - Uniform Resource Locators (URL)
1391 (defvar mh-access-types
1392 '(("anon-ftp") ; RFC2046 Anonymous File Transfer Protocol
1393 ("file") ; RFC1738 Host-specific file names
1394 ("ftp") ; RFC2046 File Transfer Protocol
1395 ("gopher") ; RFC1738 The Gopher Protocol
1396 ("http") ; RFC1738 Hypertext Transfer Protocol
1397 ("local-file") ; RFC2046 Local file access
1398 ("mail-server") ; RFC2046 mail-server Electronic mail address
1399 ("mailto") ; RFC1738 Electronic mail address
1400 ("news") ; RFC1738 Usenet news
1401 ("nntp") ; RFC1738 Usenet news using NNTP access
1402 ("propspero") ; RFC1738 Prospero Directory Service
1403 ("telnet") ; RFC1738 Telnet
1404 ("tftp") ; RFC2046 Trivial File Transfer Protocol
1405 ("url") ; RFC2017 URL scheme MIME access-type Protocol
1406 ("wais")) ; RFC1738 Wide Area Information Servers
1407 "Valid MIME access-type values.")
1410 (defun mh-mh-compose-external-type (access-type host filename type
1411 &optional description
1412 attributes parameters
1414 "Add tag to refer to a remote file.
1416 This command is a general utility for referencing external files.
1417 In fact, all of the other commands that insert directives to
1418 access external files call this command. You are prompted for the
1419 ACCESS-TYPE, remote HOST and FILENAME, and content TYPE. If you
1420 provide a prefix argument, you are also prompted for a content
1421 DESCRIPTION, ATTRIBUTES, PARAMETERS, and a COMMENT.
1423 See also \\[mh-mh-to-mime]."
1425 (completing-read "Access type: " mh-access-types
)
1426 (read-string "Remote host: ")
1427 (read-string "Remote filename: ")
1428 (mh-minibuffer-read-type "DUMMY-FILENAME")
1429 (if current-prefix-arg
(mml-minibuffer-read-description))
1430 (if current-prefix-arg
(read-string "Attributes: "))
1431 (if current-prefix-arg
(read-string "Parameters: "))
1432 (if current-prefix-arg
(read-string "Comment: "))))
1436 (insert "; " attributes
))
1438 (insert " (" comment
") "))
1441 (insert description
))
1443 (insert "access-type=" access-type
"; ")
1444 (insert "site=" host
)
1445 (insert "; name=" (file-name-nondirectory filename
))
1446 (let ((directory (file-name-directory filename
)))
1448 (insert "; directory=\"" directory
"\"")))
1450 (insert "; " parameters
))
1453 (defvar mh-mh-to-mime-args nil
1454 "Extra arguments for \\[mh-mh-to-mime] to pass to the \"mhbuild\" command.
1455 The arguments are passed to \"mhbuild\" if \\[mh-mh-to-mime] is
1456 given a prefix argument. Normally default arguments to
1457 \"mhbuild\" are specified in the MH profile.")
1460 (defun mh-mh-to-mime (&optional extra-args
)
1461 "Compose MIME message from MH-style directives.
1463 Typically, you send a message with attachments just like any other
1464 message. However, you may take a sneak preview of the MIME encoding if
1465 you wish by running this command.
1467 If you wish to pass additional arguments to \"mhbuild\" (\"mhn\")
1468 to affect how it builds your message, use the option
1469 `mh-mh-to-mime-args'. For example, you can build a consistency
1470 check into the message by setting `mh-mh-to-mime-args' to
1471 \"-check\". The recipient of your message can then run \"mhbuild
1472 -check\" on the message--\"mhbuild\" (\"mhn\") will complain if
1473 the message has been corrupted on the way. This command only
1474 consults this option when given a prefix argument EXTRA-ARGS.
1476 The hook `mh-mh-to-mime-hook' is called after the message has been
1479 The effects of this command can be undone by running
1480 \\[mh-mh-to-mime-undo]."
1482 (mh-mh-quote-unescaped-sharp)
1484 (message "Running %s..." (if (mh-variant-p 'nmh
) "mhbuild" "mhn"))
1486 ((mh-variant-p 'nmh
)
1487 (mh-exec-cmd-error nil
1489 (if extra-args mh-mh-to-mime-args
)
1492 (mh-exec-cmd-error (format "mhdraft=%s" buffer-file-name
)
1494 (if extra-args mh-mh-to-mime-args
)
1496 (revert-buffer t t t
)
1497 (message "Running %s...done" (if (mh-variant-p 'nmh
) "mhbuild" "mhn"))
1498 (run-hooks 'mh-mh-to-mime-hook
))
1500 (defun mh-mh-quote-unescaped-sharp ()
1501 "Quote \"#\" characters that haven't been quoted for \"mhbuild\".
1502 If the \"#\" character is present in the first column, but it isn't
1503 part of a MH-style directive then \"mhbuild\" gives an error.
1504 This function will quote all such characters."
1506 (goto-char (point-min))
1507 (while (re-search-forward "^#" nil t
)
1509 (unless (mh-mh-directive-present-p (point) (mh-line-end-position))
1511 (goto-char (mh-line-end-position)))))
1514 (defun mh-mh-to-mime-undo (noconfirm)
1515 "Undo effects of \\[mh-mh-to-mime].
1517 It does this by reverting to a backup file. You are prompted to
1518 confirm this action, but you can avoid the confirmation by adding
1519 a prefix argument NOCONFIRM."
1521 (if (null buffer-file-name
)
1522 (error "Buffer does not seem to be associated with any file"))
1523 (let ((backup-strings '("," "#"))
1525 (while (and backup-strings
1528 (concat (file-name-directory buffer-file-name
)
1529 (car backup-strings
)
1530 (file-name-nondirectory buffer-file-name
)
1532 (setq backup-strings
(cdr backup-strings
)))
1534 (error "Backup file for %s no longer exists" buffer-file-name
))
1536 (yes-or-no-p (format "Revert buffer from file %s? "
1538 (error "Revert not confirmed"))
1539 (let ((buffer-read-only nil
))
1541 (insert-file-contents backup-file
))
1542 (after-find-file nil nil nil nil t
)))
1545 (defvar mh-identity-pgg-default-user-id
)
1548 (defun mh-mml-secure-message-encrypt (method)
1549 "Add tag to encrypt the message.
1551 A proper multipart message is created for you when you send the
1552 message. Use the command \\[mh-mml-unsecure-message] to remove
1553 this tag. Use a prefix argument METHOD to be prompted for one of
1554 the possible security methods (see `mh-mml-method-default')."
1555 (interactive (list (mh-mml-query-cryptographic-method)))
1556 (mh-secure-message method
"encrypt" mh-identity-pgg-default-user-id
))
1559 (defun mh-mml-secure-message-sign (method)
1560 "Add tag to sign the message.
1562 A proper multipart message is created for you when you send the
1563 message. Use the command \\[mh-mml-unsecure-message] to remove
1564 this tag. Use a prefix argument METHOD to be prompted for one of
1565 the possible security methods (see `mh-mml-method-default')."
1566 (interactive (list (mh-mml-query-cryptographic-method)))
1567 (mh-secure-message method
"sign" mh-identity-pgg-default-user-id
))
1570 (defun mh-mml-secure-message-signencrypt (method)
1571 "Add tag to encrypt and sign the message.
1573 A proper multipart message is created for you when you send the
1574 message. Use the command \\[mh-mml-unsecure-message] to remove
1575 this tag. Use a prefix argument METHOD to be prompted for one of
1576 the possible security methods (see `mh-mml-method-default')."
1577 (interactive (list (mh-mml-query-cryptographic-method)))
1578 (mh-secure-message method
"signencrypt" mh-identity-pgg-default-user-id
))
1580 (defvar mh-mml-cryptographic-method-history
())
1582 (defun mh-mml-query-cryptographic-method ()
1583 "Read the cryptographic method to use."
1584 (if current-prefix-arg
1585 (let ((def (or (car mh-mml-cryptographic-method-history
)
1586 mh-mml-method-default
)))
1587 (completing-read (format "Method (default %s): " def
)
1588 '(("pgp") ("pgpmime") ("smime"))
1589 nil t nil
'mh-mml-cryptographic-method-history def
))
1590 mh-mml-method-default
))
1592 (defun mh-secure-message (method mode
&optional identity
)
1593 "Add tag to encrypt or sign message.
1595 METHOD should be one of: \"pgpmime\", \"pgp\", \"smime\".
1596 MODE should be one of: \"sign\", \"encrypt\", \"signencrypt\", \"none\".
1597 IDENTITY is optionally the default-user-id to use."
1598 (if (not mh-pgp-support-flag
)
1599 (error "Your version of Gnus does not support PGP/GPG")
1600 ;; Check the arguments
1601 (let ((valid-methods (list "pgpmime" "pgp" "smime"))
1602 (valid-modes (list "sign" "encrypt" "signencrypt" "none")))
1603 (if (not (member method valid-methods
))
1604 (error "Method %s is invalid" method
))
1605 (if (not (member mode valid-modes
))
1606 (error "Mode %s is invalid" mode
))
1607 (mml-unsecure-message)
1608 (if (not (string= mode
"none"))
1610 (goto-char (point-min))
1611 (mh-goto-header-end 1)
1612 (if mh-identity-pgg-default-user-id
1613 (mml-insert-tag 'secure
'method method
'mode mode
1614 'sender mh-identity-pgg-default-user-id
)
1615 (mml-insert-tag 'secure
'method method
'mode mode
)))))))
1618 (defun mh-mml-to-mime ()
1619 "Compose MIME message from MML tags.
1621 Typically, you send a message with attachments just like any
1622 other message. However, you may take a sneak preview of the MIME
1623 encoding if you wish by running this command.
1625 This action can be undone by running \\[undo]."
1628 (when mh-pgp-support-flag
1629 ;; PGP requires actual e-mail addresses, not aliases.
1630 ;; Parse the recipients and sender from the message.
1631 (message-options-set-recipient)
1632 ;; Do an alias lookup on sender (if From field is present).
1633 (when (message-options-get 'message-sender
)
1634 (message-options-set 'message-sender
1635 (mail-strip-quoted-names
1637 (message-options-get 'message-sender
)))))
1638 ;; Do an alias lookup on recipients
1639 (message-options-set 'message-recipients
1642 (mail-strip-quoted-names (mh-alias-expand ali
)))
1643 (split-string (message-options-get 'message-recipients
) "[, ]+")
1645 (let ((saved-text (buffer-string))
1646 (buffer (current-buffer))
1647 (modified-flag (buffer-modified-p)))
1648 (condition-case err
(mml-to-mime)
1650 (with-current-buffer buffer
1651 (delete-region (point-min) (point-max))
1653 (set-buffer-modified-p modified-flag
))
1654 (error (error-message-string err
))))))
1657 (defun mh-mml-unsecure-message ()
1658 "Remove any secure message tags."
1660 (if (not mh-pgp-support-flag
)
1661 (error "Your version of Gnus does not support PGP/GPG")
1662 (mml-unsecure-message)))
1666 ;;; Support Routines for MH-Letter Commands
1669 (defun mh-mml-tag-present-p ()
1670 "Check if the current buffer has text which may be a MML tag."
1672 (goto-char (point-min))
1675 "\\(<#\\(mml\\|part\\)\\(.\\|\n\\)*>[ \n\t]*<#/\\(mml\\|part\\)>\\|"
1679 (defvar mh-media-type-regexp
1680 (concat (regexp-opt '("text" "image" "audio" "video" "application"
1681 "multipart" "message") t
)
1683 "Regexp matching valid media types used in MIME attachment compositions.")
1686 (defun mh-mh-directive-present-p (&optional begin end
)
1687 "Check if the text between BEGIN and END might be a MH-style directive.
1688 The optional argument BEGIN defaults to the beginning of the
1689 buffer, while END defaults to the end of the buffer."
1690 (unless begin
(setq begin
(point-min)))
1691 (unless end
(setq end
(point-max)))
1693 (block search-for-mh-directive
1695 (while (re-search-forward "^#" end t
)
1696 (let ((s (buffer-substring-no-properties
1697 (point) (mh-line-end-position))))
1698 (cond ((equal s
""))
1699 ((string-match "^forw[ \t\n]+" s
)
1700 (return-from search-for-mh-directive t
))
1701 (t (let ((first-token (car (split-string s
"[ \t;@]"))))
1702 (when (and first-token
1703 (string-match mh-media-type-regexp
1705 (return-from search-for-mh-directive t
)))))))
1708 (defun mh-minibuffer-read-type (filename &optional default
)
1709 "Return the content type associated with the given FILENAME.
1710 If the \"file\" command exists and recognizes the given file,
1711 then its value is returned\; otherwise, the user is prompted for
1712 a type (see `mailcap-mime-types').
1713 Optional argument DEFAULT is returned if a type isn't entered."
1714 (mailcap-parse-mimetypes)
1715 (let* ((default (or default
1716 (mm-default-file-encoding filename
)
1717 "application/octet-stream"))
1718 (probed-type (mh-file-mime-type filename
))
1719 (type (or (and (not (equal probed-type
"application/octet-stream"))
1722 (format "Content type (default %s): " default
)
1723 (mapcar 'list
(mailcap-mime-types))))))
1724 (if (not (equal type
""))
1729 (defun mh-file-mime-type (filename)
1730 "Return MIME type of FILENAME from file command.
1731 Returns nil if file command not on system."
1733 ((not (mh-have-file-command))
1734 nil
) ;no file command, exit now
1735 ((not (and (file-exists-p filename
)
1736 (file-readable-p filename
)))
1737 nil
) ;no file or not readable, ditto
1739 (let ((tmp-buffer (get-buffer-create mh-temp-buffer
)))
1740 (with-current-buffer tmp-buffer
1743 (call-process "file" nil
'(t nil
) nil
"-b" "-i"
1744 (expand-file-name filename
))
1745 (goto-char (point-min))
1746 (if (not (re-search-forward mh-media-type-regexp nil t
))
1748 (mh-file-mime-type-substitute (match-string 0) filename
)))
1749 (kill-buffer tmp-buffer
)))))))
1751 (defvar mh-file-mime-type-substitutions
1752 '(("application/msword" "\.xls" "application/ms-excel")
1753 ("application/msword" "\.ppt" "application/ms-powerpoint")
1754 ("text/plain" "\.vcf" "text/x-vcard")
1755 ("text/rtf" "\.rtf" "application/rtf")
1756 ("application/x-zip" "\.sxc" "application/vnd.sun.xml.calc")
1757 ("application/x-zip" "\.sxd" "application/vnd.sun.xml.draw")
1758 ("application/x-zip" "\.sxi" "application/vnd.sun.xml.impress")
1759 ("application/x-zip" "\.sxw" "application/vnd.sun.xml.writer")
1760 ("application/x-zip" "\.odg" "application/vnd.oasis.opendocument.graphics")
1761 ("application/x-zip" "\.odi" "application/vnd.oasis.opendocument.image")
1762 ("application/x-zip" "\.odp"
1763 "application/vnd.oasis.opendocument.presentation")
1764 ("application/x-zip" "\.ods"
1765 "application/vnd.oasis.opendocument.spreadsheet")
1766 ("application/x-zip" "\.odt" "application/vnd.oasis.opendocument.text"))
1767 "Substitutions to make for Content-Type returned from file command.
1768 The first element is the Content-Type returned by the file command.
1769 The second element is a regexp matching the file name, usually the
1771 The third element is the Content-Type to replace with.")
1773 (defun mh-file-mime-type-substitute (content-type filename
)
1774 "Return possibly changed CONTENT-TYPE on the FILENAME.
1775 Substitutions are made from the `mh-file-mime-type-substitutions'
1777 (let ((subst mh-file-mime-type-substitutions
)
1778 (type) (match) (answer content-type
)
1779 (case-fold-search t
))
1781 (setq type
(car (car subst
))
1782 match
(elt (car subst
) 1))
1783 (if (and (string-equal content-type type
)
1784 (string-match match filename
))
1785 (setq answer
(elt (car subst
) 2)
1787 (setq subst
(cdr subst
))))
1790 (defvar mh-have-file-command
'undefined
1791 "Cached value of function `mh-have-file-command'.
1792 Do not reference this variable directly as it might not have been
1793 initialized. Always use the command `mh-have-file-command'.")
1796 (defun mh-have-file-command ()
1797 "Return t if 'file' command is on the system.
1798 'file -i' is used to get MIME type of composition insertion."
1799 (when (eq mh-have-file-command
'undefined
)
1800 (setq mh-have-file-command
1801 (and (fboundp 'executable-find
)
1802 (executable-find "file") ; file command exists
1803 ; and accepts -i and -b args.
1804 (zerop (call-process "file" nil nil nil
"-i" "-b"
1805 (expand-file-name "inc" mh-progs
))))))
1806 mh-have-file-command
)
1813 (defun mh-mime-cleanup ()
1814 "Free the decoded MIME parts."
1815 (let ((mime-data (gethash (current-buffer) mh-globals-hash
)))
1816 ;; This is for Emacs, what about XEmacs?
1817 (mh-funcall-if-exists remove-images
(point-min) (point-max))
1819 (mh-mm-destroy-parts (mh-mime-handles mime-data
))
1820 (remhash (current-buffer) mh-globals-hash
))))
1823 (defun mh-destroy-postponed-handles ()
1824 "Free MIME data for externally displayed MIME parts."
1825 (let ((mime-data (mh-buffer-data)))
1827 (mh-mm-destroy-parts (mh-mime-handles mime-data
)))
1828 (remhash (current-buffer) mh-globals-hash
)))
1833 ;; indent-tabs-mode: nil
1834 ;; sentence-end-double-space: nil
1837 ;;; mh-mime.el ends here