1 ;;; mm-uu.el --- Return uu stuff as mm handles
3 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
7 ;; Keywords: postscript uudecode binhex shar forward gnatsweb pgp
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 3, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
30 (eval-when-compile (require 'cl))
37 (autoload 'uudecode-decode-region "uudecode")
38 (autoload 'uudecode-decode-region-external "uudecode")
39 (autoload 'uudecode-decode-region-internal "uudecode")
41 (autoload 'binhex-decode-region "binhex")
42 (autoload 'binhex-decode-region-external "binhex")
43 (autoload 'binhex-decode-region-internal "binhex")
45 (autoload 'yenc-decode-region "yenc")
46 (autoload 'yenc-extract-filename "yenc")
48 (defcustom mm-uu-decode-function 'uudecode-decode-region
49 "*Function to uudecode.
50 Internal function is done in Lisp by default, therefore decoding may
51 appear to be horribly slow. You can make Gnus use an external
52 decoder, such as uudecode."
54 (function-item :tag "Auto detect" uudecode-decode-region)
55 (function-item :tag "Internal" uudecode-decode-region-internal)
56 (function-item :tag "External" uudecode-decode-region-external))
57 :group 'gnus-article-mime)
59 (defcustom mm-uu-binhex-decode-function 'binhex-decode-region
60 "*Function to binhex decode.
61 Internal function is done in elisp by default, therefore decoding may
62 appear to be horribly slow . You can make Gnus use the external Unix
63 decoder, such as hexbin."
64 :type '(choice (function-item :tag "Auto detect" binhex-decode-region)
65 (function-item :tag "Internal" binhex-decode-region-internal)
66 (function-item :tag "External" binhex-decode-region-external))
67 :group 'gnus-article-mime)
69 (defvar mm-uu-yenc-decode-function 'yenc-decode-region)
71 (defvar mm-uu-beginning-regexp nil)
73 (defvar mm-dissect-disposition "inline"
74 "The default disposition of uu parts.
75 This can be either \"inline\" or \"attachment\".")
77 (defcustom mm-uu-emacs-sources-regexp "\\.emacs\\.sources"
78 "The regexp of Emacs sources groups."
81 :group 'gnus-article-mime)
83 (defcustom mm-uu-diff-groups-regexp
84 "\\(gmane\\|gnu\\)\\..*\\(diff\\|commit\\|cvs\\|bug\\|devel\\)"
85 "Regexp matching diff groups."
88 :group 'gnus-article-mime)
90 (defcustom mm-uu-tex-groups-regexp "\\.tex\\>"
91 "*Regexp matching TeX groups."
94 :group 'gnus-article-mime)
96 (defvar mm-uu-type-alist
100 mm-uu-postscript-extract
102 (uu ;; Maybe we should have a more strict test here.
103 "^begin[ \t]+0?[0-7][0-7][0-7][ \t]+"
112 mm-uu-binhex-filename)
114 "^=ybegin.*size=[0-9]+.*name=.*$"
115 "^=yend.*size=[0-9]+"
123 ;; Thanks to Edward J. Sabol <sabol@alderaan.gsfc.nasa.gov> and
124 ;; Peter von der Ah\'e <pahe@daimi.au.dk>
125 "^-+ \\(Start of \\)?Forwarded message"
126 "^-+ End \\(of \\)?forwarded message"
127 mm-uu-forward-extract
131 "^----gnatsweb-attachment----"
133 mm-uu-gnatsweb-extract)
135 "^-----BEGIN PGP SIGNED MESSAGE-----"
136 "^-----END PGP SIGNATURE-----"
137 mm-uu-pgp-signed-extract
141 "^-----BEGIN PGP MESSAGE-----"
142 "^-----END PGP MESSAGE-----"
143 mm-uu-pgp-encrypted-extract
147 "^-----BEGIN PGP PUBLIC KEY BLOCK-----"
148 "^-----END PGP PUBLIC KEY BLOCK-----"
149 mm-uu-pgp-key-extract
150 mm-uu-gpg-key-skip-to-last
153 "^;;;?[ \t]*[^ \t]+\\.el[ \t]*--"
154 "^;;;?[ \t]*\\([^ \t]+\\.el\\)[ \t]+ends here"
155 mm-uu-emacs-sources-extract
157 mm-uu-emacs-sources-test)
165 ;; Text enclosed with tags similar to `message-mark-insert-begin' and
166 ;; `message-mark-insert-end'. Don't use those variables to avoid
167 ;; dependency on `message.el'.
168 "^-+[8<>]*-\\{9,\\}[a-z ]+-\\{9,\\}[a-z ]+-\\{9,\\}[8<>]*-+$"
169 "^-+[8<>]*-\\{9,\\}[a-z ]+-\\{9,\\}[a-z ]+-\\{9,\\}[8<>]*-+$"
170 (lambda () (mm-uu-verbatim-marks-extract 0 -1 1 -1))
172 ;; Omitting [a-z8<] leads to false positives (bogus signature separators
173 ;; and mailing list banners).
175 "^ *\\(-\\|_\\)\\{30,\\}.*[a-z8<].*\\(-\\|_\\)\\{30,\\} *$"
176 "^ *\\(-\\|_\\)\\{30,\\}.*[a-z8<].*\\(-\\|_\\)\\{30,\\} *$"
177 (lambda () (mm-uu-verbatim-marks-extract 0 0 1 -1))
180 ;; slrn-style verbatim marks, see
181 ;; http://www.slrn.org/manual/slrn-manual-6.html#ss6.81
184 (lambda () (mm-uu-verbatim-marks-extract 0 0))
187 "^\\([\\\\%][^\n]+\n\\)*\\\\documentclass.*[[{%]"
192 "A list of specifications for non-MIME attachments.
193 Each element consist of the following entries: label,
194 start-regexp, end-regexp, extract-function, test-function.
196 After modifying this list you must run \\[mm-uu-configure].
198 You can disable elements from this list by customizing
199 `mm-uu-configure-list'.")
201 (defcustom mm-uu-configure-list '((shar . disabled))
202 "A list of mm-uu configuration.
203 To disable dissecting shar codes, for instance, add
204 `(shar . disabled)' to this list."
206 :options (mapcar (lambda (entry)
207 (list (car entry) '(const disabled)))
209 :group 'gnus-article-mime)
211 (defvar mm-uu-text-plain-type '("text/plain" (charset . gnus-decoded))
212 "MIME type and parameters for text/plain parts.
213 `gnus-decoded' is a fake charset, which means no further decoding.")
217 (defsubst mm-uu-type (entry)
220 (defsubst mm-uu-beginning-regexp (entry)
223 (defsubst mm-uu-end-regexp (entry)
226 (defsubst mm-uu-function-extract (entry)
229 (defsubst mm-uu-function-1 (entry)
232 (defsubst mm-uu-function-2 (entry)
235 ;; In Emacs 22, we could use `min-colors' in the face definition. But Emacs
236 ;; 21 and XEmacs don't support it.
237 (defcustom mm-uu-hide-markers
238 (< 16 (or (and (fboundp 'defined-colors)
239 (length (defined-colors)))
240 (and (fboundp 'device-color-cells)
241 (device-color-cells))
243 "If non-nil, hide verbatim markers.
244 The value should be nil on displays where the face
245 `mm-uu-extract' isn't distinguishable to the face `default'."
246 :type '(choice (const :tag "Hide" t)
247 (const :tag "Don't hide" nil))
248 :version "23.0" ;; No Gnus
249 :group 'gnus-article-mime)
251 (defface mm-uu-extract '(;; Colors from `gnus-cite-3' plus background:
254 (:foreground "light yellow"
255 :background "dark green"))
258 (:foreground "dark green"
259 :background "light yellow"))
262 "Face for extracted buffers."
263 ;; See `mm-uu-verbatim-marks-extract'.
264 :version "23.0" ;; No Gnus
265 :group 'gnus-article-mime)
267 (defun mm-uu-copy-to-buffer (&optional from to properties)
268 "Copy the contents of the current buffer to a fresh buffer.
271 If PROPERTIES is non-nil, PROPERTIES are applied to the buffer,
272 see `set-text-properties'. If PROPERTIES equals t, this means to
273 apply the face `mm-uu-extract'."
274 (let ((obuf (current-buffer))
276 ;; Might not exist in non-MULE XEmacs
277 (when (boundp 'buffer-file-coding-system)
278 buffer-file-coding-system)))
279 (with-current-buffer (generate-new-buffer " *mm-uu*")
280 (setq buffer-file-coding-system coding-system)
281 (insert-buffer-substring obuf from to)
282 (cond ((eq properties t)
283 (set-text-properties (point-min) (point-max)
284 '(face mm-uu-extract)))
286 (set-text-properties (point-min) (point-max) properties)))
289 (defun mm-uu-configure-p (key val)
290 (member (cons key val) mm-uu-configure-list))
292 (defun mm-uu-configure (&optional symbol value)
293 "Configure detection of non-MIME attachments."
295 (if symbol (set-default symbol value))
296 (setq mm-uu-beginning-regexp nil)
297 (mapcar (lambda (entry)
298 (if (mm-uu-configure-p (mm-uu-type entry) 'disabled)
300 (setq mm-uu-beginning-regexp
301 (concat mm-uu-beginning-regexp
302 (if mm-uu-beginning-regexp "\\|")
303 (mm-uu-beginning-regexp entry)))))
313 (defun mm-uu-uu-filename ()
314 (if (looking-at ".+")
316 (let ((nnheader-file-name-translation-alist
317 '((?/ . ?,) (?\ . ?_) (?* . ?_) (?$ . ?_))))
318 (nnheader-translate-file-chars (match-string 0))))))
320 (defun mm-uu-binhex-filename ()
323 (binhex-decode-region start-point end-point t))))
325 (defun mm-uu-yenc-filename ()
326 (goto-char start-point)
329 (yenc-extract-filename))))
331 (defun mm-uu-forward-test ()
333 (goto-char start-point)
335 (looking-at "[\r\n]*[a-zA-Z][a-zA-Z0-9-]*:")))
337 (defun mm-uu-postscript-extract ()
338 (mm-make-handle (mm-uu-copy-to-buffer start-point end-point)
339 '("application/postscript")))
341 (defun mm-uu-verbatim-marks-extract (start-offset end-offset
345 (let ((start (or (and mm-uu-hide-markers
349 (end (or (and mm-uu-hide-markers
354 (mm-uu-copy-to-buffer
355 (progn (goto-char start-point)
358 (progn (goto-char end-point)
362 '("text/x-verbatim" (charset . gnus-decoded)))))
364 (defun mm-uu-latex-extract ()
366 (mm-uu-copy-to-buffer start-point end-point t)
367 ;; application/x-tex?
368 '("text/x-verbatim" (charset . gnus-decoded))))
370 (defun mm-uu-emacs-sources-extract ()
371 (mm-make-handle (mm-uu-copy-to-buffer start-point end-point)
372 '("application/emacs-lisp" (charset . gnus-decoded))
374 (list mm-dissect-disposition
375 (cons 'filename file-name))))
377 (defvar gnus-newsgroup-name)
379 (defun mm-uu-emacs-sources-test ()
380 (setq file-name (match-string 1))
381 (and gnus-newsgroup-name
382 mm-uu-emacs-sources-regexp
383 (string-match mm-uu-emacs-sources-regexp gnus-newsgroup-name)))
385 (defun mm-uu-diff-extract ()
386 (mm-make-handle (mm-uu-copy-to-buffer start-point end-point)
387 '("text/x-patch" (charset . gnus-decoded))))
389 (defun mm-uu-diff-test ()
390 (and gnus-newsgroup-name
391 mm-uu-diff-groups-regexp
392 (string-match mm-uu-diff-groups-regexp gnus-newsgroup-name)))
394 (defun mm-uu-latex-test ()
395 (and gnus-newsgroup-name
396 mm-uu-tex-groups-regexp
397 (string-match mm-uu-tex-groups-regexp gnus-newsgroup-name)))
399 (defun mm-uu-forward-extract ()
400 (mm-make-handle (mm-uu-copy-to-buffer
401 (progn (goto-char start-point) (forward-line) (point))
402 (progn (goto-char end-point) (forward-line -1) (point)))
403 '("message/rfc822" (charset . gnus-decoded))))
405 (defun mm-uu-uu-extract ()
406 (mm-make-handle (mm-uu-copy-to-buffer start-point end-point)
407 (list (or (and file-name
408 (string-match "\\.[^\\.]+$"
410 (mailcap-extension-to-mime
411 (match-string 0 file-name)))
412 "application/octet-stream"))
414 (if (and file-name (not (equal file-name "")))
415 (list mm-dissect-disposition
416 (cons 'filename file-name)))))
418 (defun mm-uu-binhex-extract ()
419 (mm-make-handle (mm-uu-copy-to-buffer start-point end-point)
420 (list (or (and file-name
421 (string-match "\\.[^\\.]+$" file-name)
422 (mailcap-extension-to-mime
423 (match-string 0 file-name)))
424 "application/octet-stream"))
426 (if (and file-name (not (equal file-name "")))
427 (list mm-dissect-disposition
428 (cons 'filename file-name)))))
430 (defvar gnus-original-article-buffer) ; gnus.el
432 (defun mm-uu-yenc-extract ()
433 ;; This might not be exactly correct, but we sure can't get the
434 ;; binary data from the article buffer, since that's already in a
435 ;; non-binary charset. So get it from the original article buffer.
436 (mm-make-handle (save-excursion
437 (set-buffer gnus-original-article-buffer)
438 (mm-uu-copy-to-buffer start-point end-point))
439 (list (or (and file-name
440 (string-match "\\.[^\\.]+$" file-name)
441 (mailcap-extension-to-mime
442 (match-string 0 file-name)))
443 "application/octet-stream"))
445 (if (and file-name (not (equal file-name "")))
446 (list mm-dissect-disposition
447 (cons 'filename file-name)))))
450 (defun mm-uu-shar-extract ()
451 (mm-make-handle (mm-uu-copy-to-buffer start-point end-point)
452 '("application/x-shar")))
454 (defun mm-uu-gnatsweb-extract ()
456 (goto-char start-point)
458 (narrow-to-region (point) end-point)
459 (mm-dissect-buffer t)))
461 (defun mm-uu-pgp-signed-test (&rest rest)
464 (mml2015-clear-verify-function)
466 ((eq mm-verify-option 'never) nil)
467 ((eq mm-verify-option 'always) t)
468 ((eq mm-verify-option 'known) t)
470 (y-or-n-p "Verify pgp signed part? ")
473 (defvar gnus-newsgroup-charset)
475 (defun mm-uu-pgp-signed-extract-1 (handles ctl)
476 (let ((buf (mm-uu-copy-to-buffer (point-min) (point-max))))
477 (with-current-buffer buf
478 (if (mm-uu-pgp-signed-test)
480 (mml2015-clean-buffer)
481 (let ((coding-system-for-write (or gnus-newsgroup-charset
483 (coding-system-for-read (or gnus-newsgroup-charset
485 (funcall (mml2015-clear-verify-function))))
486 (when (and mml2015-use (null (mml2015-clear-verify-function)))
487 (mm-set-handle-multipart-parameter
488 mm-security-handle 'gnus-details
489 (format "Clear verification not supported by `%s'.\n" mml2015-use)))
490 (mml2015-extract-cleartext-signature))
491 (list (mm-make-handle buf mm-uu-text-plain-type)))))
493 (defun mm-uu-pgp-signed-extract ()
494 (let ((mm-security-handle (list (format "multipart/signed"))))
495 (mm-set-handle-multipart-parameter
496 mm-security-handle 'protocol "application/x-gnus-pgp-signature")
498 (narrow-to-region start-point end-point)
499 (add-text-properties 0 (length (car mm-security-handle))
500 (list 'buffer (mm-uu-copy-to-buffer))
501 (car mm-security-handle))
502 (setcdr mm-security-handle
503 (mm-uu-pgp-signed-extract-1 nil
504 mm-security-handle)))
507 (defun mm-uu-pgp-encrypted-test (&rest rest)
510 (mml2015-clear-decrypt-function)
512 ((eq mm-decrypt-option 'never) nil)
513 ((eq mm-decrypt-option 'always) t)
514 ((eq mm-decrypt-option 'known) t)
516 (y-or-n-p "Decrypt pgp encrypted part? ")
519 (defun mm-uu-pgp-encrypted-extract-1 (handles ctl)
520 (let ((buf (mm-uu-copy-to-buffer (point-min) (point-max)))
523 ;; Make sure there's a blank line between header and body.
524 (with-current-buffer buf
525 (goto-char (point-min))
529 (looking-at "[^\t\n ]+:")
530 (looking-at "[^\t\n ]+:\\|[\t ]"))
532 (unless (memq (char-after) '(?\n nil))
535 (narrow-to-region (point-min) (point))
536 (setq charset (mail-fetch-field "charset")))
537 (if (and (mm-uu-pgp-encrypted-test)
539 (mml2015-clean-buffer)
540 (funcall (mml2015-clear-decrypt-function))
541 (equal (mm-handle-multipart-ctl-parameter mm-security-handle
547 (setq charset gnus-newsgroup-charset))
548 (setq charset (mm-charset-to-coding-system charset))
549 (not (eq charset 'ascii)))
550 ;; Assume that buffer's multibyteness is turned off.
551 ;; See `mml2015-pgg-clear-decrypt'.
552 (insert (mm-decode-coding-string (prog1
555 (mm-enable-multibyte))
557 (mm-enable-multibyte))
558 (list (mm-make-handle buf mm-uu-text-plain-type)))
559 (list (mm-make-handle buf '("application/pgp-encrypted")))))))
561 (defun mm-uu-pgp-encrypted-extract ()
562 (let ((mm-security-handle (list (format "multipart/encrypted"))))
563 (mm-set-handle-multipart-parameter
564 mm-security-handle 'protocol "application/x-gnus-pgp-encrypted")
566 (narrow-to-region start-point end-point)
567 (add-text-properties 0 (length (car mm-security-handle))
568 (list 'buffer (mm-uu-copy-to-buffer))
569 (car mm-security-handle))
570 (setcdr mm-security-handle
571 (mm-uu-pgp-encrypted-extract-1 nil
572 mm-security-handle)))
575 (defun mm-uu-gpg-key-skip-to-last ()
576 (let ((point (point))
577 (end-regexp (mm-uu-end-regexp entry))
578 (beginning-regexp (mm-uu-beginning-regexp entry)))
579 (when (and end-regexp
580 (not (mm-uu-configure-p (mm-uu-type entry) 'disabled)))
581 (while (re-search-forward end-regexp nil t)
582 (skip-chars-forward " \t\n\r")
583 (if (looking-at beginning-regexp)
584 (setq point (match-end 0)))))
587 (defun mm-uu-pgp-key-extract ()
588 (let ((buf (mm-uu-copy-to-buffer start-point end-point)))
590 '("application/pgp-keys"))))
593 (defun mm-uu-dissect (&optional noheader mime-type)
594 "Dissect the current buffer and return a list of uu handles.
595 The optional NOHEADER means there's no header in the buffer.
596 MIME-TYPE specifies a MIME type and parameters, which defaults to the
597 value of `mm-uu-text-plain-type'."
598 (let ((case-fold-search t)
599 (mm-uu-text-plain-type (or mime-type mm-uu-text-plain-type))
600 text-start start-point end-point file-name result entry func)
602 (goto-char (point-min))
607 ((search-forward "\n\n" nil t)
609 (t (goto-char (point-max))))
610 (setq text-start (point))
611 (while (re-search-forward mm-uu-beginning-regexp nil t)
612 (setq start-point (match-beginning 0)
614 (let ((alist mm-uu-type-alist)
615 (beginning-regexp (match-string 0)))
617 (if (string-match (mm-uu-beginning-regexp (car alist))
619 (setq entry (car alist))
621 (if (setq func (mm-uu-function-1 entry))
623 (forward-line);; in case of failure
624 (when (and (not (mm-uu-configure-p (mm-uu-type entry) 'disabled))
625 (let ((end-regexp (mm-uu-end-regexp entry)))
627 (or (setq end-point (point-max)) t)
629 (re-search-forward end-regexp nil t)
631 (setq end-point (point)))))
632 (or (not (setq func (mm-uu-function-2 entry)))
634 (if (and (> start-point text-start)
636 (goto-char text-start)
637 (re-search-forward "." start-point t)))
639 (mm-make-handle (mm-uu-copy-to-buffer text-start start-point)
640 mm-uu-text-plain-type)
643 (funcall (mm-uu-function-extract entry))
645 (goto-char (setq text-start end-point))))
647 (if (and (> (point-max) (1+ text-start))
649 (goto-char text-start)
650 (re-search-forward "." nil t)))
652 (mm-make-handle (mm-uu-copy-to-buffer text-start (point-max))
653 mm-uu-text-plain-type)
655 (setq result (cons "multipart/mixed" (nreverse result))))
659 (defun mm-uu-dissect-text-parts (handle &optional decoded)
660 "Dissect text parts and put uu handles into HANDLE.
661 Assume text has been decoded if DECODED is non-nil."
662 (let ((buffer (mm-handle-buffer handle)))
663 (cond ((stringp buffer)
664 (dolist (elem (cdr handle))
665 (mm-uu-dissect-text-parts elem decoded)))
667 (let ((type (mm-handle-media-type handle))
668 (case-fold-search t) ;; string-match
669 children charset encoding)
672 ;; Mutt still uses application/pgp even though
673 ;; it has already been withdrawn.
674 (string-match "\\`text/\\|\\`application/pgp\\'" type)
677 (with-current-buffer buffer
680 (eq (setq charset (mail-content-type-get
681 (mm-handle-type handle)
686 t (cons type '((charset . gnus-decoded)))))
689 (mm-with-multibyte-buffer
690 (insert (mm-decode-string (mm-get-part handle)
693 t (cons type '((charset . gnus-decoded))))))
694 ((setq encoding (mm-handle-encoding handle))
696 ;; Inherit the multibyteness of the `buffer'.
698 (insert-buffer-substring buffer)
699 (mm-decode-content-transfer-encoding
701 (mm-uu-dissect t (list type))))
704 (mm-uu-dissect t (list type)))))))
705 ;; Ignore it if a given part is dissected into a single
706 ;; part of which the type is the same as the given one.
707 (if (and (<= (length children) 2)
708 (string-equal (mm-handle-media-type (cadr children))
710 (kill-buffer (mm-handle-buffer (cadr children)))
712 (setcdr handle (cdr children))
713 (setcar handle (car children)) ;; "multipart/mixed"
714 (dolist (elem (cdr children))
715 (mm-uu-dissect-text-parts elem decoded))))))
717 (dolist (elem handle)
718 (mm-uu-dissect-text-parts elem decoded))))))
722 ;; arch-tag: 7db076bf-53db-4320-aa19-ca76a1d2ab2c
723 ;;; mm-uu.el ends here