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