Importing Gnus v5.8.3.
[elisp/gnus.git-] / lisp / mm-uu.el
1 ;;; mm-uu.el -- Return uu stuffs as mm handles
2 ;; Copyright (c) 1998,99 Free Software Foundation, Inc.
3
4 ;; Author: Shenghuo Zhu <zsh@cs.rochester.edu>
5 ;; Keywords: postscript uudecode binhex shar forward news
6
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
27 ;;; Code:
28
29 (require 'mail-parse)
30 (require 'message)
31 (require 'nnheader)
32 (require 'mm-decode)
33 (require 'mailcap)
34
35 (eval-and-compile
36   (autoload 'binhex-decode-region "binhex")
37   (autoload 'binhex-decode-region-external "binhex")
38   (autoload 'uudecode-decode-region "uudecode")
39   (autoload 'uudecode-decode-region-external "uudecode"))
40
41 (defun mm-uu-copy-to-buffer (from to)
42   "Copy the contents of the current buffer to a fresh buffer."
43   (save-excursion
44     (let ((obuf (current-buffer)))
45       (set-buffer (generate-new-buffer " *mm-uu*"))
46       (insert-buffer-substring obuf from to)
47       (current-buffer))))
48
49 ;;; postscript
50
51 (defconst mm-uu-postscript-begin-line "^%!PS-")
52 (defconst mm-uu-postscript-end-line "^%%EOF$")
53
54 (defconst mm-uu-uu-begin-line "^begin[ \t]+[0-7][0-7][0-7][ \t]+")
55 (defconst mm-uu-uu-end-line "^end[ \t]*$")
56
57 (defcustom mm-uu-decode-function 'uudecode-decode-region
58   "*Function to uudecode.
59 Internal function is done in elisp by default, therefore decoding may
60 appear to be horribly slow . You can make Gnus use the external Unix
61 decoder, such as uudecode."
62   :type '(choice (item :tag "internal" uudecode-decode-region)
63                  (item :tag "external" uudecode-decode-region-external))
64   :group 'gnus-article-mime) 
65
66 (defconst mm-uu-binhex-begin-line
67   "^:...............................................................$")
68 (defconst mm-uu-binhex-end-line ":$")
69
70 (defcustom mm-uu-binhex-decode-function 'binhex-decode-region
71   "*Function to binhex decode.
72 Internal function is done in elisp by default, therefore decoding may
73 appear to be horribly slow . You can make Gnus use the external Unix
74 decoder, such as hexbin."
75   :type '(choice (item :tag "internal" binhex-decode-region)
76                  (item :tag "external" binhex-decode-region-external))
77   :group 'gnus-article-mime) 
78
79 (defconst mm-uu-shar-begin-line "^#! */bin/sh")
80 (defconst mm-uu-shar-end-line "^exit 0\\|^$")
81
82 ;;; Thanks to Edward J. Sabol <sabol@alderaan.gsfc.nasa.gov> and 
83 ;;; Peter von der Ah\'e <pahe@daimi.au.dk>
84 (defconst mm-uu-forward-begin-line "^-+ \\(Start of \\)?Forwarded message")
85 (defconst mm-uu-forward-end-line "^-+ End \\(of \\)?forwarded message")
86
87 (defvar mm-uu-begin-line nil)
88
89 (defconst mm-uu-identifier-alist
90   '((?% . postscript) (?b . uu) (?: . binhex) (?# . shar)
91     (?- . forward)))
92
93 (defvar mm-dissect-disposition "inline"
94   "The default disposition of uu parts.
95 This can be either \"inline\" or \"attachment\".")
96
97 (defun mm-uu-configure-p  (key val)
98   (member (cons key val) mm-uu-configure-list))
99
100 (defun mm-uu-configure (&optional symbol value)
101   (if symbol (set-default symbol value))
102   (setq mm-uu-begin-line nil)
103   (mapcar '(lambda (type)
104              (if (mm-uu-configure-p type 'disabled) 
105                  nil
106                (setq mm-uu-begin-line
107                      (concat mm-uu-begin-line
108                              (if mm-uu-begin-line "\\|")
109                              (symbol-value
110                               (intern (concat "mm-uu-" (symbol-name type)
111                                               "-begin-line")))))))
112           '(uu postscript binhex shar forward)))
113
114 (defcustom mm-uu-configure-list nil
115   "A list of mm-uu configuration.
116 To disable dissecting shar codes, for instance, add
117 `(shar . disabled)' to this list."
118   :type '(repeat (cons 
119                   (choice (item postscript)
120                           (item uu) 
121                           (item binhex)
122                           (item shar)
123                           (item forward))
124                   (choice (item disabled))))
125   :group 'gnus-article-mime
126   :set 'mm-uu-configure) 
127
128 (mm-uu-configure)
129
130 ;;;### autoload
131
132 (defun mm-uu-dissect ()
133   "Dissect the current buffer and return a list of uu handles."
134   (let (text-start start-char end-char
135                    type file-name end-line result text-plain-type 
136                    start-char-1 end-char-1
137                    (case-fold-search t))
138     (save-excursion
139       (save-restriction
140         (mail-narrow-to-head)
141         (goto-char (point-max)))
142       (forward-line)
143       ;;; gnus-decoded is a fake charset, which means no further
144       ;;; decoding.
145       (setq text-start (point)
146             text-plain-type '("text/plain"  (charset . gnus-decoded)))
147       (while (re-search-forward mm-uu-begin-line nil t)
148         (setq start-char (match-beginning 0))
149         (setq type (cdr (assq (aref (match-string 0) 0)
150                               mm-uu-identifier-alist)))
151         (setq file-name
152               (if (and (eq type 'uu)
153                        (looking-at "\\(.+\\)$"))
154                   (and (match-string 1)
155                        (let ((nnheader-file-name-translation-alist
156                               '((?/ . ?,) (? . ?_) (?* . ?_) (?$ . ?_))))
157                          (nnheader-translate-file-chars (match-string 1))))))
158         (forward-line);; in case of failure
159         (setq start-char-1 (point))
160         (setq end-line (symbol-value
161                         (intern (concat "mm-uu-" (symbol-name type)
162                                         "-end-line"))))
163         (when (and (re-search-forward end-line nil t)
164                    (not (eq (match-beginning 0) (match-end 0))))
165           (setq end-char-1 (match-beginning 0))
166           (forward-line)
167           (setq end-char (point))
168           (when (or (not (eq type 'binhex))
169                     (setq file-name
170                           (ignore-errors
171                             (binhex-decode-region start-char end-char t))))
172             (if (> start-char text-start)
173                 (push
174                  (mm-make-handle (mm-uu-copy-to-buffer text-start start-char)
175                                  text-plain-type)
176                  result))
177             (push
178              (cond
179               ((eq type 'postscript)
180                (mm-make-handle (mm-uu-copy-to-buffer start-char end-char)
181                                '("application/postscript")))
182               ((eq type 'forward)
183                (mm-make-handle (mm-uu-copy-to-buffer start-char-1 end-char-1)
184                                '("message/rfc822" (charset . gnus-decoded))))
185               ((eq type 'uu)
186                (mm-make-handle (mm-uu-copy-to-buffer start-char end-char)
187                                (list (or (and file-name
188                                               (string-match "\\.[^\\.]+$" file-name)
189                                               (mailcap-extension-to-mime
190                                                (match-string 0 file-name)))
191                                          "application/octet-stream"))
192                                'x-uuencode nil
193                                (if (and file-name (not (equal file-name "")))
194                                    (list mm-dissect-disposition
195                                          (cons 'filename file-name)))))
196               ((eq type 'binhex)
197                (mm-make-handle (mm-uu-copy-to-buffer start-char end-char)
198                                (list (or (and file-name
199                                               (string-match "\\.[^\\.]+$" file-name)
200                                               (mailcap-extension-to-mime
201                                                (match-string 0 file-name)))
202                                          "application/octet-stream"))
203                                'x-binhex nil
204                                (if (and file-name (not (equal file-name "")))
205                                    (list mm-dissect-disposition
206                                          (cons 'filename file-name)))))
207               ((eq type 'shar)
208                (mm-make-handle (mm-uu-copy-to-buffer start-char end-char)
209                                '("application/x-shar"))))
210              result)
211             (setq text-start end-char))))
212       (when result
213         (if (> (point-max) (1+ text-start))
214             (push
215              (mm-make-handle (mm-uu-copy-to-buffer text-start (point-max))
216                              text-plain-type)
217              result))
218         (setq result (cons "multipart/mixed" (nreverse result))))
219       result)))
220
221 ;;;### autoload
222 (defun mm-uu-test ()
223   "Check whether the current buffer contains uu stuffs."
224   (save-excursion
225     (goto-char (point-min))
226     (let (type end-line result
227                (case-fold-search t))
228       (while (and mm-uu-begin-line
229                   (not result) (re-search-forward mm-uu-begin-line nil t))
230         (forward-line)
231         (setq type (cdr (assq (aref (match-string 0) 0)
232                               mm-uu-identifier-alist)))
233         (setq end-line (symbol-value
234                         (intern (concat "mm-uu-" (symbol-name type)
235                                         "-end-line"))))
236         (if (and (re-search-forward end-line nil t)
237                  (not (eq (match-beginning 0) (match-end 0))))
238             (setq result t)))
239       result)))
240
241 (provide 'mm-uu)
242
243 ;;; mm-uu.el ends here