Reinident.
[gnus] / lisp / mml.el
1 ;;; mml.el --- A package for parsing and validating MML documents
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; This file is part of GNU Emacs.
7
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
11 ;; any later version.
12
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 ;; GNU General Public License for more details.
17
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
22
23 ;;; Commentary:
24
25 ;;; Code:
26
27 (require 'mm-util)
28 (require 'mm-bodies)
29 (require 'mm-encode)
30 (require 'mm-decode)
31 (require 'mml-sec)
32 (eval-when-compile (require 'cl))
33
34 (eval-and-compile
35   (autoload 'message-make-message-id "message")
36   (autoload 'gnus-setup-posting-charset "gnus-msg")
37   (autoload 'gnus-make-local-hook "gnus-util")
38   (autoload 'message-fetch-field "message")
39   (autoload 'fill-flowed-encode "flow-fill")
40   (autoload 'message-posting-charset "message")
41   (autoload 'x-dnd-get-local-file-name "x-dnd"))
42
43 (defcustom mml-content-type-parameters
44   '(name access-type expiration size permission format)
45   "*A list of acceptable parameters in MML tag.
46 These parameters are generated in Content-Type header if exists."
47   :type '(repeat (symbol :tag "Parameter"))
48   :group 'message)
49
50 (defcustom mml-content-disposition-parameters
51   '(filename creation-date modification-date read-date)
52   "*A list of acceptable parameters in MML tag.
53 These parameters are generated in Content-Disposition header if exists."
54   :type '(repeat (symbol :tag "Parameter"))
55   :group 'message)
56
57 (defcustom mml-insert-mime-headers-always nil
58   "If non-nil, always put Content-Type: text/plain at top of empty parts.
59 It is necessary to work against a bug in certain clients."
60   :type 'boolean
61   :group 'message)
62
63 (defvar mml-tweak-type-alist nil
64   "A list of (TYPE . FUNCTION) for tweaking MML parts.
65 TYPE is a string containing a regexp to match the MIME type.  FUNCTION
66 is a Lisp function which is called with the MML handle to tweak the
67 part.  This variable is used only when no TWEAK parameter exists in
68 the MML handle.")
69
70 (defvar mml-tweak-function-alist nil
71   "A list of (NAME . FUNCTION) for tweaking MML parts.
72 NAME is a string containing the name of the TWEAK parameter in the MML
73 handle.  FUNCTION is a Lisp function which is called with the MML
74 handle to tweak the part.")
75
76 (defvar mml-tweak-sexp-alist
77   '((mml-externalize-attachments . mml-tweak-externalize-attachments))
78   "A list of (SEXP . FUNCTION) for tweaking MML parts.
79 SEXP is an s-expression.  If the evaluation of SEXP is non-nil, FUNCTION
80 is called.  FUNCTION is a Lisp function which is called with the MML
81 handle to tweak the part.")
82
83 (defvar mml-externalize-attachments nil
84   "*If non-nil, local-file attachments are generated as external parts.")
85
86 (defvar mml-generate-multipart-alist nil
87   "*Alist of multipart generation functions.
88 Each entry has the form (NAME . FUNCTION), where
89 NAME is a string containing the name of the part (without the
90 leading \"/multipart/\"),
91 FUNCTION is a Lisp function which is called to generate the part.
92
93 The Lisp function has to supply the appropriate MIME headers and the
94 contents of this part.")
95
96 (defvar mml-syntax-table
97   (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
98     (modify-syntax-entry ?\\ "/" table)
99     (modify-syntax-entry ?< "(" table)
100     (modify-syntax-entry ?> ")" table)
101     (modify-syntax-entry ?@ "w" table)
102     (modify-syntax-entry ?/ "w" table)
103     (modify-syntax-entry ?= " " table)
104     (modify-syntax-entry ?* " " table)
105     (modify-syntax-entry ?\; " " table)
106     (modify-syntax-entry ?\' " " table)
107     table))
108
109 (defvar mml-boundary-function 'mml-make-boundary
110   "A function called to suggest a boundary.
111 The function may be called several times, and should try to make a new
112 suggestion each time.  The function is called with one parameter,
113 which is a number that says how many times the function has been
114 called for this message.")
115
116 (defvar mml-confirmation-set nil
117   "A list of symbols, each of which disables some warning.
118 `unknown-encoding': always send messages contain characters with
119 unknown encoding; `use-ascii': always use ASCII for those characters
120 with unknown encoding; `multipart': always send messages with more than
121 one charsets.")
122
123 (defvar mml-generate-default-type "text/plain")
124
125 (defvar mml-buffer-list nil)
126
127 (defun mml-generate-new-buffer (name)
128   (let ((buf (generate-new-buffer name)))
129     (push buf mml-buffer-list)
130     buf))
131
132 (defun mml-destroy-buffers ()
133   (let (kill-buffer-hook)
134     (mapcar 'kill-buffer mml-buffer-list)
135     (setq mml-buffer-list nil)))
136
137 (defun mml-parse ()
138   "Parse the current buffer as an MML document."
139   (save-excursion
140     (goto-char (point-min))
141     (with-syntax-table mml-syntax-table
142       (mml-parse-1))))
143
144 (defun mml-parse-1 ()
145   "Parse the current buffer as an MML document."
146   (let (struct tag point contents charsets warn use-ascii no-markup-p raw)
147     (while (and (not (eobp))
148                 (not (looking-at "<#/multipart")))
149       (cond
150        ((looking-at "<#secure")
151         ;; The secure part is essentially a meta-meta tag, which
152         ;; expands to either a part tag if there are no other parts in
153         ;; the document or a multipart tag if there are other parts
154         ;; included in the message
155         (let* (secure-mode
156                (taginfo (mml-read-tag))
157                (recipients (cdr (assq 'recipients taginfo)))
158                (sender (cdr (assq 'sender taginfo)))
159                (location (cdr (assq 'tag-location taginfo)))
160                (mode (cdr (assq 'mode taginfo)))
161                (method (cdr (assq 'method taginfo)))
162                tags)
163           (save-excursion
164             (if (re-search-forward
165                  "<#/?\\(multipart\\|part\\|external\\|mml\\)." nil t)
166                 (setq secure-mode "multipart")
167               (setq secure-mode "part")))
168           (save-excursion
169             (goto-char location)
170             (re-search-forward "<#secure[^\n]*>\n"))
171           (delete-region (match-beginning 0) (match-end 0))
172           (cond ((string= mode "sign")
173                  (setq tags (list "sign" method)))
174                 ((string= mode "encrypt")
175                  (setq tags (list "encrypt" method)))
176                 ((string= mode "signencrypt")
177                  (setq tags (list "sign" method "encrypt" method))))
178           (eval `(mml-insert-tag ,secure-mode
179                                  ,@tags
180                                  ,(if recipients "recipients")
181                                  ,recipients
182                                  ,(if sender "sender")
183                                  ,sender))
184           ;; restart the parse
185           (goto-char location)))
186        ((looking-at "<#multipart")
187         (push (nconc (mml-read-tag) (mml-parse-1)) struct))
188        ((looking-at "<#external")
189         (push (nconc (mml-read-tag) (list (cons 'contents (mml-read-part))))
190               struct))
191        (t
192         (if (or (looking-at "<#part") (looking-at "<#mml"))
193             (setq tag (mml-read-tag)
194                   no-markup-p nil
195                   warn nil)
196           (setq tag (list 'part '(type . "text/plain"))
197                 no-markup-p t
198                 warn t))
199         (setq raw (cdr (assq 'raw tag))
200               point (point)
201               contents (mml-read-part (eq 'mml (car tag)))
202               charsets (cond
203                         (raw nil)
204                         ((assq 'charset tag)
205                          (list
206                           (intern (downcase (cdr (assq 'charset tag))))))
207                         (t
208                          (mm-find-mime-charset-region point (point)
209                                                       mm-hack-charsets))))
210         (when (and (not raw) (memq nil charsets))
211           (if (or (memq 'unknown-encoding mml-confirmation-set)
212                   (message-options-get 'unknown-encoding)
213                   (and (y-or-n-p "\
214 Message contains characters with unknown encoding.  Really send? ")
215                        (message-options-set 'unknown-encoding t)))
216               (if (setq use-ascii
217                         (or (memq 'use-ascii mml-confirmation-set)
218                             (message-options-get 'use-ascii)
219                             (and (y-or-n-p "Use ASCII as charset? ")
220                                  (message-options-set 'use-ascii t))))
221                   (setq charsets (delq nil charsets))
222                 (setq warn nil))
223             (error "Edit your message to remove those characters")))
224         (if (or raw
225                 (eq 'mml (car tag))
226                 (< (length charsets) 2))
227             (if (or (not no-markup-p)
228                     (string-match "[^ \t\r\n]" contents))
229                 ;; Don't create blank parts.
230                 (push (nconc tag (list (cons 'contents contents)))
231                       struct))
232           (let ((nstruct (mml-parse-singlepart-with-multiple-charsets
233                           tag point (point) use-ascii)))
234             (when (and warn
235                        (not (memq 'multipart mml-confirmation-set))
236                        (not (message-options-get 'multipart))
237                        (not (and (y-or-n-p (format "\
238 A message part needs to be split into %d charset parts.  Really send? "
239                                                    (length nstruct)))
240                                  (message-options-set 'multipart t))))
241               (error "Edit your message to use only one charset"))
242             (setq struct (nconc nstruct struct)))))))
243     (unless (eobp)
244       (forward-line 1))
245     (nreverse struct)))
246
247 (defun mml-parse-singlepart-with-multiple-charsets
248   (orig-tag beg end &optional use-ascii)
249   (save-excursion
250     (save-restriction
251       (narrow-to-region beg end)
252       (goto-char (point-min))
253       (let ((current (or (mm-mime-charset (mm-charset-after))
254                          (and use-ascii 'us-ascii)))
255             charset struct space newline paragraph)
256         (while (not (eobp))
257           (setq charset (mm-mime-charset (mm-charset-after)))
258           (cond
259            ;; The charset remains the same.
260            ((eq charset 'us-ascii))
261            ((or (and use-ascii (not charset))
262                 (eq charset current))
263             (setq space nil
264                   newline nil
265                   paragraph nil))
266            ;; The initial charset was ascii.
267            ((eq current 'us-ascii)
268             (setq current charset
269                   space nil
270                   newline nil
271                   paragraph nil))
272            ;; We have a change in charsets.
273            (t
274             (push (append
275                    orig-tag
276                    (list (cons 'contents
277                                (buffer-substring-no-properties
278                                 beg (or paragraph newline space (point))))))
279                   struct)
280             (setq beg (or paragraph newline space (point))
281                   current charset
282                   space nil
283                   newline nil
284                   paragraph nil)))
285           ;; Compute places where it might be nice to break the part.
286           (cond
287            ((memq (following-char) '(?  ?\t))
288             (setq space (1+ (point))))
289            ((and (eq (following-char) ?\n)
290                  (not (bobp))
291                  (eq (char-after (1- (point))) ?\n))
292             (setq paragraph (point)))
293            ((eq (following-char) ?\n)
294             (setq newline (1+ (point)))))
295           (forward-char 1))
296         ;; Do the final part.
297         (unless (= beg (point))
298           (push (append orig-tag
299                         (list (cons 'contents
300                                     (buffer-substring-no-properties
301                                      beg (point)))))
302                 struct))
303         struct))))
304
305 (defun mml-read-tag ()
306   "Read a tag and return the contents."
307   (let ((orig-point (point))
308         contents name elem val)
309     (forward-char 2)
310     (setq name (buffer-substring-no-properties
311                 (point) (progn (forward-sexp 1) (point))))
312     (skip-chars-forward " \t\n")
313     (while (not (looking-at ">[ \t]*\n?"))
314       (setq elem (buffer-substring-no-properties
315                   (point) (progn (forward-sexp 1) (point))))
316       (skip-chars-forward "= \t\n")
317       (setq val (buffer-substring-no-properties
318                  (point) (progn (forward-sexp 1) (point))))
319       (when (string-match "^\"\\(.*\\)\"$" val)
320         (setq val (match-string 1 val)))
321       (push (cons (intern elem) val) contents)
322       (skip-chars-forward " \t\n"))
323     (goto-char (match-end 0))
324     ;; Don't skip the leading space.
325     ;;(skip-chars-forward " \t\n")
326     ;; Put the tag location into the returned contents
327     (setq contents (append (list (cons 'tag-location orig-point)) contents))
328     (cons (intern name) (nreverse contents))))
329
330 (defun mml-buffer-substring-no-properties-except-hard-newlines (start end)
331   (let ((str (buffer-substring-no-properties start end))
332         (bufstart start) tmp)
333     (while (setq tmp (text-property-any start end 'hard 't))
334       (set-text-properties (- tmp bufstart) (- tmp bufstart -1)
335                            '(hard t) str)
336       (setq start (1+ tmp)))
337     str))
338
339 (defun mml-read-part (&optional mml)
340   "Return the buffer up till the next part, multipart or closing part or multipart.
341 If MML is non-nil, return the buffer up till the correspondent mml tag."
342   (let ((beg (point)) (count 1))
343     ;; If the tag ended at the end of the line, we go to the next line.
344     (when (looking-at "[ \t]*\n")
345       (forward-line 1))
346     (if mml
347         (progn
348           (while (and (> count 0) (not (eobp)))
349             (if (re-search-forward "<#\\(/\\)?mml." nil t)
350                 (setq count (+ count (if (match-beginning 1) -1 1)))
351               (goto-char (point-max))))
352           (mml-buffer-substring-no-properties-except-hard-newlines
353            beg (if (> count 0)
354                    (point)
355                  (match-beginning 0))))
356       (if (re-search-forward
357            "<#\\(/\\)?\\(multipart\\|part\\|external\\|mml\\)." nil t)
358           (prog1
359               (mml-buffer-substring-no-properties-except-hard-newlines
360                beg (match-beginning 0))
361             (if (or (not (match-beginning 1))
362                     (equal (match-string 2) "multipart"))
363                 (goto-char (match-beginning 0))
364               (when (looking-at "[ \t]*\n")
365                 (forward-line 1))))
366         (mml-buffer-substring-no-properties-except-hard-newlines
367          beg (goto-char (point-max)))))))
368
369 (defvar mml-boundary nil)
370 (defvar mml-base-boundary "-=-=")
371 (defvar mml-multipart-number 0)
372
373 (defun mml-generate-mime ()
374   "Generate a MIME message based on the current MML document."
375   (let ((cont (mml-parse))
376         (mml-multipart-number mml-multipart-number))
377     (if (not cont)
378         nil
379       (with-temp-buffer
380         (if (and (consp (car cont))
381                  (= (length cont) 1))
382             (mml-generate-mime-1 (car cont))
383           (mml-generate-mime-1 (nconc (list 'multipart '(type . "mixed"))
384                                       cont)))
385         (buffer-string)))))
386
387 (defun mml-generate-mime-1 (cont)
388   (let ((mm-use-ultra-safe-encoding
389          (or mm-use-ultra-safe-encoding (assq 'sign cont))))
390     (save-restriction
391       (narrow-to-region (point) (point))
392       (mml-tweak-part cont)
393       (cond
394        ((or (eq (car cont) 'part) (eq (car cont) 'mml))
395         (let ((raw (cdr (assq 'raw cont)))
396               coded encoding charset filename type flowed)
397           (setq type (or (cdr (assq 'type cont)) "text/plain"))
398           (if (and (not raw)
399                    (member (car (split-string type "/")) '("text" "message")))
400               (progn
401                 (with-temp-buffer
402                   (setq charset (mm-charset-to-coding-system
403                                  (cdr (assq 'charset cont))))
404                   (when (eq charset 'ascii)
405                     (setq charset nil))
406                   (cond
407                    ((cdr (assq 'buffer cont))
408                     (insert-buffer-substring (cdr (assq 'buffer cont))))
409                    ((and (setq filename (cdr (assq 'filename cont)))
410                          (not (equal (cdr (assq 'nofile cont)) "yes")))
411                     (let ((coding-system-for-read charset))
412                       (mm-insert-file-contents filename)))
413                    ((eq 'mml (car cont))
414                     (insert (cdr (assq 'contents cont))))
415                    (t
416                     (save-restriction
417                       (narrow-to-region (point) (point))
418                       (insert (cdr (assq 'contents cont)))
419                       ;; Remove quotes from quoted tags.
420                       (goto-char (point-min))
421                       (while (re-search-forward
422                               "<#!+/?\\(part\\|multipart\\|external\\|mml\\)"
423                               nil t)
424                         (delete-region (+ (match-beginning 0) 2)
425                                        (+ (match-beginning 0) 3))))))
426                   (cond
427                    ((eq (car cont) 'mml)
428                     (let ((mml-boundary (mml-compute-boundary cont))
429                           (mml-generate-default-type "text/plain"))
430                       (mml-to-mime))
431                     (let ((mm-7bit-chars (concat mm-7bit-chars "\x1b")))
432                       ;; ignore 0x1b, it is part of iso-2022-jp
433                       (setq encoding (mm-body-7-or-8))))
434                    ((string= (car (split-string type "/")) "message")
435                     (let ((mm-7bit-chars (concat mm-7bit-chars "\x1b")))
436                       ;; ignore 0x1b, it is part of iso-2022-jp
437                       (setq encoding (mm-body-7-or-8))))
438                    (t
439                     ;; Only perform format=flowed filling on text/plain
440                     ;; parts where there either isn't a format parameter
441                     ;; in the mml tag or it says "flowed" and there
442                     ;; actually are hard newlines in the text.
443                     (let (use-hard-newlines)
444                       (when (and (string= type "text/plain")
445                                  (or (null (assq 'format cont))
446                                      (string= (cdr (assq 'format cont))
447                                               "flowed"))
448                                  (setq use-hard-newlines
449                                        (text-property-any
450                                         (point-min) (point-max) 'hard 't)))
451                         (fill-flowed-encode)
452                         ;; Indicate that `mml-insert-mime-headers' should
453                         ;; insert a "; format=flowed" string unless the
454                         ;; user has already specified it.
455                         (setq flowed (null (assq 'format cont)))))
456                     (setq charset (mm-encode-body charset))
457                     (setq encoding (mm-body-encoding
458                                     charset (cdr (assq 'encoding cont))))))
459                   (setq coded (buffer-string)))
460                 (mml-insert-mime-headers cont type charset encoding flowed)
461                 (insert "\n")
462                 (insert coded))
463             (mm-with-unibyte-buffer
464               (cond
465                ((cdr (assq 'buffer cont))
466                 (insert-buffer-substring (cdr (assq 'buffer cont))))
467                ((and (setq filename (cdr (assq 'filename cont)))
468                      (not (equal (cdr (assq 'nofile cont)) "yes")))
469                 (let ((coding-system-for-read mm-binary-coding-system))
470                   (mm-insert-file-contents filename nil nil nil nil t)))
471                (t
472                 (insert (cdr (assq 'contents cont)))))
473               (setq encoding (mm-encode-buffer type)
474                     coded (mm-string-as-multibyte (buffer-string))))
475             (mml-insert-mime-headers cont type charset encoding nil)
476             (insert "\n")
477             (mm-with-unibyte-current-buffer
478               (insert coded)))))
479        ((eq (car cont) 'external)
480         (insert "Content-Type: message/external-body")
481         (let ((parameters (mml-parameter-string
482                            cont '(expiration size permission)))
483               (name (cdr (assq 'name cont)))
484               (url (cdr (assq 'url cont))))
485           (when name
486             (setq name (mml-parse-file-name name))
487             (if (stringp name)
488                 (mml-insert-parameter
489                  (mail-header-encode-parameter "name" name)
490                  "access-type=local-file")
491               (mml-insert-parameter
492                (mail-header-encode-parameter
493                 "name" (file-name-nondirectory (nth 2 name)))
494                (mail-header-encode-parameter "site" (nth 1 name))
495                (mail-header-encode-parameter
496                 "directory" (file-name-directory (nth 2 name))))
497               (mml-insert-parameter
498                (concat "access-type="
499                        (if (member (nth 0 name) '("ftp@" "anonymous@"))
500                            "anon-ftp"
501                          "ftp")))))
502           (when url
503             (mml-insert-parameter
504              (mail-header-encode-parameter "url" url)
505              "access-type=url"))
506           (when parameters
507             (mml-insert-parameter-string
508              cont '(expiration size permission))))
509         (insert "\n\n")
510         (insert "Content-Type: " (cdr (assq 'type cont)) "\n")
511         (insert "Content-ID: " (message-make-message-id) "\n")
512         (insert "Content-Transfer-Encoding: "
513                 (or (cdr (assq 'encoding cont)) "binary"))
514         (insert "\n\n")
515         (insert (or (cdr (assq 'contents cont))))
516         (insert "\n"))
517        ((eq (car cont) 'multipart)
518         (let* ((type (or (cdr (assq 'type cont)) "mixed"))
519                (mml-generate-default-type (if (equal type "digest")
520                                               "message/rfc822"
521                                             "text/plain"))
522                (handler (assoc type mml-generate-multipart-alist)))
523           (if handler
524               (funcall (cdr handler) cont)
525             ;; No specific handler.  Use default one.
526             (let ((mml-boundary (mml-compute-boundary cont)))
527               (insert (format "Content-Type: multipart/%s; boundary=\"%s\""
528                               type mml-boundary)
529                       (if (cdr (assq 'start cont))
530                           (format "; start=\"%s\"\n" (cdr (assq 'start cont)))
531                         "\n"))
532               (let ((cont cont) part)
533                 (while (setq part (pop cont))
534                   ;; Skip `multipart' and attributes.
535                   (when (and (consp part) (consp (cdr part)))
536                     (insert "\n--" mml-boundary "\n")
537                     (mml-generate-mime-1 part))))
538               (insert "\n--" mml-boundary "--\n")))))
539        (t
540         (error "Invalid element: %S" cont)))
541       ;; handle sign & encrypt tags in a semi-smart way.
542       (let ((sign-item (assoc (cdr (assq 'sign cont)) mml-sign-alist))
543             (encrypt-item (assoc (cdr (assq 'encrypt cont))
544                                  mml-encrypt-alist))
545             sender recipients)
546         (when (or sign-item encrypt-item)
547           (when (setq sender (cdr (assq 'sender cont)))
548             (message-options-set 'mml-sender sender)
549             (message-options-set 'message-sender sender))
550           (if (setq recipients (cdr (assq 'recipients cont)))
551               (message-options-set 'message-recipients recipients))
552           (let ((style (mml-signencrypt-style
553                         (first (or sign-item encrypt-item)))))
554             ;; check if: we're both signing & encrypting, both methods
555             ;; are the same (why would they be different?!), and that
556             ;; the signencrypt style allows for combined operation.
557             (if (and sign-item encrypt-item (equal (first sign-item)
558                                                    (first encrypt-item))
559                      (equal style 'combined))
560                 (funcall (nth 1 encrypt-item) cont t)
561               ;; otherwise, revert to the old behavior.
562               (when sign-item
563                 (funcall (nth 1 sign-item) cont))
564               (when encrypt-item
565                 (funcall (nth 1 encrypt-item) cont)))))))))
566
567 (defun mml-compute-boundary (cont)
568   "Return a unique boundary that does not exist in CONT."
569   (let ((mml-boundary (funcall mml-boundary-function
570                                (incf mml-multipart-number))))
571     ;; This function tries again and again until it has found
572     ;; a unique boundary.
573     (while (not (catch 'not-unique
574                   (mml-compute-boundary-1 cont))))
575     mml-boundary))
576
577 (defun mml-compute-boundary-1 (cont)
578   (let (filename)
579     (cond
580      ((eq (car cont) 'part)
581       (with-temp-buffer
582         (cond
583          ((cdr (assq 'buffer cont))
584           (insert-buffer-substring (cdr (assq 'buffer cont))))
585          ((and (setq filename (cdr (assq 'filename cont)))
586                (not (equal (cdr (assq 'nofile cont)) "yes")))
587           (mm-insert-file-contents filename nil nil nil nil t))
588          (t
589           (insert (cdr (assq 'contents cont)))))
590         (goto-char (point-min))
591         (when (re-search-forward (concat "^--" (regexp-quote mml-boundary))
592                                  nil t)
593           (setq mml-boundary (funcall mml-boundary-function
594                                       (incf mml-multipart-number)))
595           (throw 'not-unique nil))))
596      ((eq (car cont) 'multipart)
597       (mapcar 'mml-compute-boundary-1 (cddr cont))))
598     t))
599
600 (defun mml-make-boundary (number)
601   (concat (make-string (% number 60) ?=)
602           (if (> number 17)
603               (format "%x" number)
604             "")
605           mml-base-boundary))
606
607 (defun mml-insert-mime-headers (cont type charset encoding flowed)
608   (let (parameters id disposition description)
609     (setq parameters
610           (mml-parameter-string
611            cont mml-content-type-parameters))
612     (when (or charset
613               parameters
614               flowed
615               (not (equal type mml-generate-default-type))
616               mml-insert-mime-headers-always)
617       (when (consp charset)
618         (error
619          "Can't encode a part with several charsets"))
620       (insert "Content-Type: " type)
621       (when charset
622         (insert "; " (mail-header-encode-parameter
623                       "charset" (symbol-name charset))))
624       (when flowed
625         (insert "; format=flowed"))
626       (when parameters
627         (mml-insert-parameter-string
628          cont mml-content-type-parameters))
629       (insert "\n"))
630     (when (setq id (cdr (assq 'id cont)))
631       (insert "Content-ID: " id "\n"))
632     (setq parameters
633           (mml-parameter-string
634            cont mml-content-disposition-parameters))
635     (when (or (setq disposition (cdr (assq 'disposition cont)))
636               parameters)
637       (insert "Content-Disposition: " (or disposition "inline"))
638       (when parameters
639         (mml-insert-parameter-string
640          cont mml-content-disposition-parameters))
641       (insert "\n"))
642     (unless (eq encoding '7bit)
643       (insert (format "Content-Transfer-Encoding: %s\n" encoding)))
644     (when (setq description (cdr (assq 'description cont)))
645       (insert "Content-Description: "
646               (mail-encode-encoded-word-string description) "\n"))))
647
648 (defun mml-parameter-string (cont types)
649   (let ((string "")
650         value type)
651     (while (setq type (pop types))
652       (when (setq value (cdr (assq type cont)))
653         ;; Strip directory component from the filename parameter.
654         (when (eq type 'filename)
655           (setq value (file-name-nondirectory value)))
656         (setq string (concat string "; "
657                              (mail-header-encode-parameter
658                               (symbol-name type) value)))))
659     (when (not (zerop (length string)))
660       string)))
661
662 (defun mml-insert-parameter-string (cont types)
663   (let (value type)
664     (while (setq type (pop types))
665       (when (setq value (cdr (assq type cont)))
666         ;; Strip directory component from the filename parameter.
667         (when (eq type 'filename)
668           (setq value (file-name-nondirectory value)))
669         (mml-insert-parameter
670          (mail-header-encode-parameter
671           (symbol-name type) value))))))
672
673 (eval-when-compile
674   (defvar ange-ftp-name-format)
675   (defvar efs-path-regexp))
676 (defun mml-parse-file-name (path)
677   (if (if (boundp 'efs-path-regexp)
678           (string-match efs-path-regexp path)
679         (if (boundp 'ange-ftp-name-format)
680             (string-match (car ange-ftp-name-format) path)))
681       (list (match-string 1 path) (match-string 2 path)
682             (substring path (1+ (match-end 2))))
683     path))
684
685 (defun mml-insert-buffer (buffer)
686   "Insert BUFFER at point and quote any MML markup."
687   (save-restriction
688     (narrow-to-region (point) (point))
689     (insert-buffer-substring buffer)
690     (mml-quote-region (point-min) (point-max))
691     (goto-char (point-max))))
692
693 ;;;
694 ;;; Transforming MIME to MML
695 ;;;
696
697 (defun mime-to-mml (&optional handles)
698   "Translate the current buffer (which should be a message) into MML.
699 If HANDLES is non-nil, use it instead reparsing the buffer."
700   ;; First decode the head.
701   (save-restriction
702     (message-narrow-to-head)
703     (mail-decode-encoded-word-region (point-min) (point-max)))
704   (unless handles
705     (setq handles (mm-dissect-buffer t)))
706   (goto-char (point-min))
707   (search-forward "\n\n" nil t)
708   (delete-region (point) (point-max))
709   (if (stringp (car handles))
710       (mml-insert-mime handles)
711     (mml-insert-mime handles t))
712   (mm-destroy-parts handles)
713   (save-restriction
714     (message-narrow-to-head)
715     ;; Remove them, they are confusing.
716     (message-remove-header "Content-Type")
717     (message-remove-header "MIME-Version")
718     (message-remove-header "Content-Disposition")
719     (message-remove-header "Content-Transfer-Encoding")))
720
721 (defun mml-to-mime ()
722   "Translate the current buffer from MML to MIME."
723   (message-encode-message-body)
724   (save-restriction
725     (message-narrow-to-headers-or-head)
726     ;; Skip past any From_ headers.
727     (while (looking-at "From ")
728       (forward-line 1))
729     (let ((mail-parse-charset message-default-charset))
730       (mail-encode-encoded-word-buffer))))
731
732 (defun mml-insert-mime (handle &optional no-markup)
733   (let (textp buffer mmlp)
734     ;; Determine type and stuff.
735     (unless (stringp (car handle))
736       (unless (setq textp (equal (mm-handle-media-supertype handle) "text"))
737         (save-excursion
738           (set-buffer (setq buffer (mml-generate-new-buffer " *mml*")))
739           (mm-insert-part handle)
740           (if (setq mmlp (equal (mm-handle-media-type handle)
741                                 "message/rfc822"))
742               (mime-to-mml)))))
743     (if mmlp
744         (mml-insert-mml-markup handle nil t t)
745       (unless (and no-markup
746                    (equal (mm-handle-media-type handle) "text/plain"))
747         (mml-insert-mml-markup handle buffer textp)))
748     (cond
749      (mmlp
750       (insert-buffer-substring buffer)
751       (goto-char (point-max))
752       (insert "<#/mml>\n"))
753      ((stringp (car handle))
754       (mapcar 'mml-insert-mime (cdr handle))
755       (insert "<#/multipart>\n"))
756      (textp
757       (let ((charset (mail-content-type-get
758                       (mm-handle-type handle) 'charset))
759             (start (point)))
760         (if (eq charset 'gnus-decoded)
761             (mm-insert-part handle)
762           (insert (mm-decode-string (mm-get-part handle) charset)))
763         (mml-quote-region start (point)))
764       (goto-char (point-max)))
765      (t
766       (insert "<#/part>\n")))))
767
768 (defun mml-insert-mml-markup (handle &optional buffer nofile mmlp)
769   "Take a MIME handle and insert an MML tag."
770   (if (stringp (car handle))
771       (progn
772         (insert "<#multipart type=" (mm-handle-media-subtype handle))
773         (let ((start (mm-handle-multipart-ctl-parameter handle 'start)))
774           (when start
775             (insert " start=\"" start "\"")))
776         (insert ">\n"))
777     (if mmlp
778         (insert "<#mml type=" (mm-handle-media-type handle))
779       (insert "<#part type=" (mm-handle-media-type handle)))
780     (dolist (elem (append (cdr (mm-handle-type handle))
781                           (cdr (mm-handle-disposition handle))))
782       (unless (symbolp (cdr elem))
783         (insert " " (symbol-name (car elem)) "=\"" (cdr elem) "\"")))
784     (when (mm-handle-id handle)
785       (insert " id=\"" (mm-handle-id handle) "\""))
786     (when (mm-handle-disposition handle)
787       (insert " disposition=" (car (mm-handle-disposition handle))))
788     (when buffer
789       (insert " buffer=\"" (buffer-name buffer) "\""))
790     (when nofile
791       (insert " nofile=yes"))
792     (when (mm-handle-description handle)
793       (insert " description=\"" (mm-handle-description handle) "\""))
794     (insert ">\n")))
795
796 (defun mml-insert-parameter (&rest parameters)
797   "Insert PARAMETERS in a nice way."
798   (dolist (param parameters)
799     (insert ";")
800     (let ((point (point)))
801       (insert " " param)
802       (when (> (current-column) 71)
803         (goto-char point)
804         (insert "\n ")
805         (end-of-line)))))
806
807 ;;;
808 ;;; Mode for inserting and editing MML forms
809 ;;;
810
811 (defvar mml-mode-map
812   (let ((sign (make-sparse-keymap))
813         (encrypt (make-sparse-keymap))
814         (signpart (make-sparse-keymap))
815         (encryptpart (make-sparse-keymap))
816         (map (make-sparse-keymap))
817         (main (make-sparse-keymap)))
818     (define-key sign "p" 'mml-secure-message-sign-pgpmime)
819     (define-key sign "o" 'mml-secure-message-sign-pgp)
820     (define-key sign "s" 'mml-secure-message-sign-smime)
821     (define-key signpart "p" 'mml-secure-sign-pgpmime)
822     (define-key signpart "o" 'mml-secure-sign-pgp)
823     (define-key signpart "s" 'mml-secure-sign-smime)
824     (define-key encrypt "p" 'mml-secure-message-encrypt-pgpmime)
825     (define-key encrypt "o" 'mml-secure-message-encrypt-pgp)
826     (define-key encrypt "s" 'mml-secure-message-encrypt-smime)
827     (define-key encryptpart "p" 'mml-secure-encrypt-pgpmime)
828     (define-key encryptpart "o" 'mml-secure-encrypt-pgp)
829     (define-key encryptpart "s" 'mml-secure-encrypt-smime)
830     (define-key map "\C-n" 'mml-unsecure-message)
831     (define-key map "f" 'mml-attach-file)
832     (define-key map "b" 'mml-attach-buffer)
833     (define-key map "e" 'mml-attach-external)
834     (define-key map "q" 'mml-quote-region)
835     (define-key map "m" 'mml-insert-multipart)
836     (define-key map "p" 'mml-insert-part)
837     (define-key map "v" 'mml-validate)
838     (define-key map "P" 'mml-preview)
839     (define-key map "s" sign)
840     (define-key map "S" signpart)
841     (define-key map "c" encrypt)
842     (define-key map "C" encryptpart)
843     ;;(define-key map "n" 'mml-narrow-to-part)
844     ;; `M-m' conflicts with `back-to-indentation'.
845     ;; (define-key main "\M-m" map)
846     (define-key main "\C-c\C-m" map)
847     main))
848
849 (easy-menu-define
850   mml-menu mml-mode-map ""
851   `("Attachments"
852     ["Attach File..." mml-attach-file
853      ,@(if (featurep 'xemacs) '(t)
854          '(:help "Attach a file at point"))]
855     ["Attach Buffer..." mml-attach-buffer t]
856     ["Attach External..." mml-attach-external t]
857     ["Insert Part..." mml-insert-part t]
858     ["Insert Multipart..." mml-insert-multipart t]
859     ["PGP/MIME Sign" mml-secure-message-sign-pgpmime t]
860     ["PGP/MIME Encrypt" mml-secure-message-encrypt-pgpmime t]
861     ["PGP Sign" mml-secure-message-sign-pgp t]
862     ["PGP Encrypt" mml-secure-message-encrypt-pgp t]
863     ["S/MIME Sign" mml-secure-message-sign-smime t]
864     ["S/MIME Encrypt" mml-secure-message-encrypt-smime t]
865     ("Secure MIME part"
866      ["PGP/MIME Sign Part" mml-secure-sign-pgpmime t]
867      ["PGP/MIME Encrypt Part" mml-secure-encrypt-pgpmime t]
868      ["PGP Sign Part" mml-secure-sign-pgp t]
869      ["PGP Encrypt Part" mml-secure-encrypt-pgp t]
870      ["S/MIME Sign Part" mml-secure-sign-smime t]
871      ["S/MIME Encrypt Part" mml-secure-encrypt-smime t])
872     ["Encrypt/Sign off" mml-unsecure-message t]
873     ;;["Narrow" mml-narrow-to-part t]
874     ["Quote MML" mml-quote-region t]
875     ["Validate MML" mml-validate t]
876     ["Preview" mml-preview t]))
877
878 (defvar mml-mode nil
879   "Minor mode for editing MML.")
880
881 (defun mml-mode (&optional arg)
882   "Minor mode for editing MML.
883 MML is the MIME Meta Language, a minor mode for composing MIME articles.
884 See Info node `(emacs-mime)Composing'.
885
886 \\{mml-mode-map}"
887   (interactive "P")
888   (when (set (make-local-variable 'mml-mode)
889              (if (null arg) (not mml-mode)
890                (> (prefix-numeric-value arg) 0)))
891     (add-minor-mode 'mml-mode " MML" mml-mode-map)
892     (easy-menu-add mml-menu mml-mode-map)
893     (when (boundp 'x-dnd-protocol-alist)
894       (set (make-local-variable 'x-dnd-protocol-alist)
895            '(("^file:///" . mml-x-dnd-attach-file)
896              ("^file://"  . x-dnd-open-file)
897              ("^file:"    . mml-x-dnd-attach-file))))
898     (run-hooks 'mml-mode-hook)))
899
900 ;;;
901 ;;; Helper functions for reading MIME stuff from the minibuffer and
902 ;;; inserting stuff to the buffer.
903 ;;;
904
905 (defun mml-minibuffer-read-file (prompt)
906   (let* ((completion-ignored-extensions nil)
907          (file (read-file-name prompt nil nil t)))
908     ;; Prevent some common errors.  This is inspired by similar code in
909     ;; VM.
910     (when (file-directory-p file)
911       (error "%s is a directory, cannot attach" file))
912     (unless (file-exists-p file)
913       (error "No such file: %s" file))
914     (unless (file-readable-p file)
915       (error "Permission denied: %s" file))
916     file))
917
918 (defun mml-minibuffer-read-type (name &optional default)
919   (mailcap-parse-mimetypes)
920   (let* ((default (or default
921                       (mm-default-file-encoding name)
922                       ;; Perhaps here we should check what the file
923                       ;; looks like, and offer text/plain if it looks
924                       ;; like text/plain.
925                       "application/octet-stream"))
926          (string (completing-read
927                   (format "Content type (default %s): " default)
928                   (mapcar 'list (mailcap-mime-types)))))
929     (if (not (equal string ""))
930         string
931       default)))
932
933 (defun mml-minibuffer-read-description ()
934   (let ((description (read-string "One line description: ")))
935     (when (string-match "\\`[ \t]*\\'" description)
936       (setq description nil))
937     description))
938
939 (defun mml-minibuffer-read-disposition (type &optional default)
940   (let* ((default (or default
941                       (if (string-match "^text/.*" type)
942                           "inline"
943                         "attachment")))
944         (disposition (completing-read 
945                       (format "Disposition: (default %s): " default)
946                       '(("attachment") ("inline") (""))
947                       nil
948                       nil)))
949     (if (not (equal disposition ""))
950         disposition
951       default)))
952
953 (defun mml-quote-region (beg end)
954   "Quote the MML tags in the region."
955   (interactive "r")
956   (save-excursion
957     (save-restriction
958       ;; Temporarily narrow the region to defend from changes
959       ;; invalidating END.
960       (narrow-to-region beg end)
961       (goto-char (point-min))
962       ;; Quote parts.
963       (while (re-search-forward
964               "<#!*/?\\(multipart\\|part\\|external\\|mml\\)" nil t)
965         ;; Insert ! after the #.
966         (goto-char (+ (match-beginning 0) 2))
967         (insert "!")))))
968
969 (defun mml-insert-tag (name &rest plist)
970   "Insert an MML tag described by NAME and PLIST."
971   (when (symbolp name)
972     (setq name (symbol-name name)))
973   (insert "<#" name)
974   (while plist
975     (let ((key (pop plist))
976           (value (pop plist)))
977       (when value
978         ;; Quote VALUE if it contains suspicious characters.
979         (when (string-match "[\"'\\~/*;() \t\n]" value)
980           (setq value (with-output-to-string
981                         (let (print-escape-nonascii)
982                           (prin1 value)))))
983         (insert (format " %s=%s" key value)))))
984   (insert ">\n"))
985
986 (defun mml-insert-empty-tag (name &rest plist)
987   "Insert an empty MML tag described by NAME and PLIST."
988   (when (symbolp name)
989     (setq name (symbol-name name)))
990   (apply #'mml-insert-tag name plist)
991   (insert "<#/" name ">\n"))
992
993 ;;; Attachment functions.
994
995 (defun mml-attach-file (file &optional type description disposition)
996   "Attach a file to the outgoing MIME message.
997 The file is not inserted or encoded until you send the message with
998 `\\[message-send-and-exit]' or `\\[message-send]'.
999
1000 FILE is the name of the file to attach.  TYPE is its content-type, a
1001 string of the form \"type/subtype\".  DESCRIPTION is a one-line
1002 description of the attachment."
1003   (interactive
1004    (let* ((file (mml-minibuffer-read-file "Attach file: "))
1005           (type (mml-minibuffer-read-type file))
1006           (description (mml-minibuffer-read-description))
1007           (disposition (mml-minibuffer-read-disposition type)))
1008      (list file type description disposition)))
1009   (mml-insert-empty-tag 'part
1010                         'type type
1011                         'filename file
1012                         'disposition (or disposition "attachment")
1013                         'description description))
1014
1015 (defun mml-x-dnd-attach-file (uri action)
1016   "Attach a drag and drop file."
1017   (let ((file (x-dnd-get-local-file-name uri t)))
1018     (when (and file (file-regular-p file))
1019       (let* ((type (mml-minibuffer-read-type file))
1020             (description (mml-minibuffer-read-description))
1021             (disposition (mml-minibuffer-read-disposition type)))
1022         (mml-attach-file file type description disposition)))))
1023
1024 (defun mml-attach-buffer (buffer &optional type description)
1025   "Attach a buffer to the outgoing MIME message.
1026 See `mml-attach-file' for details of operation."
1027   (interactive
1028    (let* ((buffer (read-buffer "Attach buffer: "))
1029           (type (mml-minibuffer-read-type buffer "text/plain"))
1030           (description (mml-minibuffer-read-description)))
1031      (list buffer type description)))
1032   (mml-insert-empty-tag 'part 'type type 'buffer buffer
1033                         'disposition "attachment" 'description description))
1034
1035 (defun mml-attach-external (file &optional type description)
1036   "Attach an external file into the buffer.
1037 FILE is an ange-ftp/efs specification of the part location.
1038 TYPE is the MIME type to use."
1039   (interactive
1040    (let* ((file (mml-minibuffer-read-file "Attach external file: "))
1041           (type (mml-minibuffer-read-type file))
1042           (description (mml-minibuffer-read-description)))
1043      (list file type description)))
1044   (mml-insert-empty-tag 'external 'type type 'name file
1045                         'disposition "attachment" 'description description))
1046
1047 (defun mml-insert-multipart (&optional type)
1048   (interactive (list (completing-read "Multipart type (default mixed): "
1049                                       '(("mixed") ("alternative") ("digest") ("parallel")
1050                                         ("signed") ("encrypted"))
1051                                       nil nil "mixed")))
1052   (or type
1053       (setq type "mixed"))
1054   (mml-insert-empty-tag "multipart" 'type type)
1055   (forward-line -1))
1056
1057 (defun mml-insert-part (&optional type)
1058   (interactive
1059    (list (mml-minibuffer-read-type "")))
1060   (mml-insert-tag 'part 'type type 'disposition "inline")
1061   (forward-line -1))
1062
1063 (defun mml-preview-insert-mail-followup-to ()
1064   "Insert a Mail-Followup-To header before previewing an article.
1065 Should be adopted if code in `message-send-mail' is changed."
1066   (when (and (message-mail-p)
1067              (message-subscribed-p)
1068              (not (mail-fetch-field "mail-followup-to"))
1069              (message-make-mail-followup-to))
1070     (message-position-on-field "Mail-Followup-To" "X-Draft-From")
1071     (insert (message-make-mail-followup-to))))
1072
1073 (defun mml-preview (&optional raw)
1074   "Display current buffer with Gnus, in a new buffer.
1075 If RAW, don't highlight the article."
1076   (interactive "P")
1077   (save-excursion
1078     (let* ((buf (current-buffer))
1079            (message-options message-options)
1080            (message-this-is-mail (message-mail-p))
1081            (message-this-is-news (message-news-p))
1082            (message-posting-charset (or (gnus-setup-posting-charset
1083                                          (save-restriction
1084                                            (message-narrow-to-headers-or-head)
1085                                            (message-fetch-field "Newsgroups")))
1086                                         message-posting-charset)))
1087       (message-options-set-recipient)
1088       (switch-to-buffer (generate-new-buffer
1089                          (concat (if raw "*Raw MIME preview of "
1090                                    "*MIME preview of ") (buffer-name))))
1091       (when (boundp 'gnus-buffers)
1092         (push (current-buffer) gnus-buffers))
1093       (erase-buffer)
1094       (insert-buffer-substring buf)
1095       (mml-preview-insert-mail-followup-to)
1096       (let ((message-deletable-headers (if (message-news-p)
1097                                            nil
1098                                          message-deletable-headers)))
1099         (message-generate-headers
1100          (copy-sequence (if (message-news-p)
1101                             message-required-news-headers
1102                           message-required-mail-headers))))
1103       (if (re-search-forward
1104            (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
1105           (replace-match "\n"))
1106       (let ((mail-header-separator ""));; mail-header-separator is removed.
1107         (mml-to-mime))
1108       (if raw
1109           (when (fboundp 'set-buffer-multibyte)
1110             (let ((s (buffer-string)))
1111               ;; Insert the content into unibyte buffer.
1112               (erase-buffer)
1113               (mm-disable-multibyte)
1114               (insert s)))
1115         (let ((gnus-newsgroup-charset (car message-posting-charset))
1116               gnus-article-prepare-hook gnus-original-article-buffer)
1117           (run-hooks 'gnus-article-decode-hook)
1118           (let ((gnus-newsgroup-name "dummy")
1119                 (gnus-newsrc-hashtb (or gnus-newsrc-hashtb
1120                                         (gnus-make-hashtable 5))))
1121             (gnus-article-prepare-display))))
1122       ;; Disable article-mode-map.
1123       (use-local-map nil)
1124       (gnus-make-local-hook 'kill-buffer-hook)
1125       (add-hook 'kill-buffer-hook
1126                 (lambda ()
1127                   (mm-destroy-parts gnus-article-mime-handles)) nil t)
1128       (setq buffer-read-only t)
1129       (local-set-key "q" (lambda () (interactive) (kill-buffer nil)))
1130       (local-set-key "=" (lambda () (interactive) (delete-other-windows)))
1131       (local-set-key "\r"
1132                      (lambda ()
1133                        (interactive)
1134                        (widget-button-press (point))))
1135       (local-set-key gnus-mouse-2
1136                      (lambda (event)
1137                        (interactive "@e")
1138                        (widget-button-press (widget-event-point event) event)))
1139       (goto-char (point-min)))))
1140
1141 (defun mml-validate ()
1142   "Validate the current MML document."
1143   (interactive)
1144   (mml-parse))
1145
1146 (defun mml-tweak-part (cont)
1147   "Tweak a MML part."
1148   (let ((tweak (cdr (assq 'tweak cont)))
1149         func)
1150     (cond
1151      (tweak
1152       (setq func
1153             (or (cdr (assoc tweak mml-tweak-function-alist))
1154                 (intern tweak))))
1155      (mml-tweak-type-alist
1156       (let ((alist mml-tweak-type-alist)
1157             (type (or (cdr (assq 'type cont)) "text/plain")))
1158         (while alist
1159           (if (string-match (caar alist) type)
1160               (setq func (cdar alist)
1161                     alist nil)
1162             (setq alist (cdr alist)))))))
1163     (if func
1164         (funcall func cont)
1165       cont)
1166     (let ((alist mml-tweak-sexp-alist))
1167       (while alist
1168         (if (eval (caar alist))
1169             (funcall (cdar alist) cont))
1170         (setq alist (cdr alist)))))
1171   cont)
1172
1173 (defun mml-tweak-externalize-attachments (cont)
1174   "Tweak attached files as external parts."
1175   (let (filename-cons)
1176     (when (and (eq (car cont) 'part)
1177                (not (cdr (assq 'buffer cont)))
1178                (and (setq filename-cons (assq 'filename cont))
1179                     (not (equal (cdr (assq 'nofile cont)) "yes"))))
1180       (setcar cont 'external)
1181       (setcar filename-cons 'name))))
1182
1183 (provide 'mml)
1184
1185 ;;; mml.el ends here