Revert to 6.80. (Wearing brown paper bag.)
[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                     (let (use-hard-newlines)
450                       (when (and (string= type "text/plain")
451                                  (or (null (assq 'format cont))
452                                      (string= (cdr (assq 'format cont))
453                                               "flowed"))
454                                  (setq use-hard-newlines
455                                        (text-property-any
456                                         (point-min) (point-max) 'hard 't)))
457                         (fill-flowed-encode)
458                         ;; Indicate that `mml-insert-mime-headers' should
459                         ;; insert a "; format=flowed" string unless the
460                         ;; user has already specified it.
461                         (setq flowed (null (assq 'format cont)))))
462                     (setq charset (mm-encode-body charset))
463                     (setq encoding (mm-body-encoding
464                                     charset (cdr (assq 'encoding cont))))))
465                   (setq coded (buffer-string)))
466                 (mml-insert-mime-headers cont type charset encoding flowed)
467                 (insert "\n")
468                 (insert coded))
469             (mm-with-unibyte-buffer
470               (cond
471                ((cdr (assq 'buffer cont))
472                 (insert-buffer-substring (cdr (assq 'buffer cont))))
473                ((and (setq filename (cdr (assq 'filename cont)))
474                      (not (equal (cdr (assq 'nofile cont)) "yes")))
475                 (let ((coding-system-for-read mm-binary-coding-system))
476                   (mm-insert-file-contents filename nil nil nil nil t)))
477                (t
478                 (insert (cdr (assq 'contents cont)))))
479               (setq encoding (mm-encode-buffer type)
480                     coded (mm-string-as-multibyte (buffer-string))))
481             (mml-insert-mime-headers cont type charset encoding nil)
482             (insert "\n")
483             (mm-with-unibyte-current-buffer
484               (insert coded)))))
485        ((eq (car cont) 'external)
486         (insert "Content-Type: message/external-body")
487         (let ((parameters (mml-parameter-string
488                            cont '(expiration size permission)))
489               (name (cdr (assq 'name cont)))
490               (url (cdr (assq 'url cont))))
491           (when name
492             (setq name (mml-parse-file-name name))
493             (if (stringp name)
494                 (mml-insert-parameter
495                  (mail-header-encode-parameter "name" name)
496                  "access-type=local-file")
497               (mml-insert-parameter
498                (mail-header-encode-parameter
499                 "name" (file-name-nondirectory (nth 2 name)))
500                (mail-header-encode-parameter "site" (nth 1 name))
501                (mail-header-encode-parameter
502                 "directory" (file-name-directory (nth 2 name))))
503               (mml-insert-parameter
504                (concat "access-type="
505                        (if (member (nth 0 name) '("ftp@" "anonymous@"))
506                            "anon-ftp"
507                          "ftp")))))
508           (when url
509             (mml-insert-parameter
510              (mail-header-encode-parameter "url" url)
511              "access-type=url"))
512           (when parameters
513             (mml-insert-parameter-string
514              cont '(expiration size permission))))
515         (insert "\n\n")
516         (insert "Content-Type: " (cdr (assq 'type cont)) "\n")
517         (insert "Content-ID: " (message-make-message-id) "\n")
518         (insert "Content-Transfer-Encoding: "
519                 (or (cdr (assq 'encoding cont)) "binary"))
520         (insert "\n\n")
521         (insert (or (cdr (assq 'contents cont))))
522         (insert "\n"))
523        ((eq (car cont) 'multipart)
524         (let* ((type (or (cdr (assq 'type cont)) "mixed"))
525                (mml-generate-default-type (if (equal type "digest")
526                                               "message/rfc822"
527                                             "text/plain"))
528                (handler (assoc type mml-generate-multipart-alist)))
529           (if handler
530               (funcall (cdr handler) cont)
531             ;; No specific handler.  Use default one.
532             (let ((mml-boundary (mml-compute-boundary cont)))
533               (insert (format "Content-Type: multipart/%s; boundary=\"%s\""
534                               type mml-boundary)
535                       (if (cdr (assq 'start cont))
536                           (format "; start=\"%s\"\n" (cdr (assq 'start cont)))
537                         "\n"))
538               (let ((cont cont) part)
539                 (while (setq part (pop cont))
540                   ;; Skip `multipart' and attributes.
541                   (when (and (consp part) (consp (cdr part)))
542                     (insert "\n--" mml-boundary "\n")
543                     (mml-generate-mime-1 part))))
544               (insert "\n--" mml-boundary "--\n")))))
545        (t
546         (error "Invalid element: %S" cont)))
547       ;; handle sign & encrypt tags in a semi-smart way.
548       (let ((sign-item (assoc (cdr (assq 'sign cont)) mml-sign-alist))
549             (encrypt-item (assoc (cdr (assq 'encrypt cont))
550                                  mml-encrypt-alist))
551             sender recipients)
552         (when (or sign-item encrypt-item)
553           (when (setq sender (cdr (assq 'sender cont)))
554             (message-options-set 'mml-sender sender)
555             (message-options-set 'message-sender sender))
556           (if (setq recipients (cdr (assq 'recipients cont)))
557               (message-options-set 'message-recipients recipients))
558           (let ((style (mml-signencrypt-style (first (or sign-item encrypt-item)))))
559             ;; check if: we're both signing & encrypting, both methods
560             ;; are the same (why would they be different?!), and that
561             ;; the signencrypt style allows for combined operation.
562             (if (and sign-item encrypt-item (equal (first sign-item)
563                                                    (first encrypt-item))
564                      (equal style 'combined))
565                 (funcall (nth 1 encrypt-item) cont t)
566               ;; otherwise, revert to the old behavior.
567               (when sign-item
568                 (funcall (nth 1 sign-item) cont))
569               (when encrypt-item
570                 (funcall (nth 1 encrypt-item) cont)))))))))
571
572 (defun mml-compute-boundary (cont)
573   "Return a unique boundary that does not exist in CONT."
574   (let ((mml-boundary (funcall mml-boundary-function
575                                (incf mml-multipart-number))))
576     ;; This function tries again and again until it has found
577     ;; a unique boundary.
578     (while (not (catch 'not-unique
579                   (mml-compute-boundary-1 cont))))
580     mml-boundary))
581
582 (defun mml-compute-boundary-1 (cont)
583   (let (filename)
584     (cond
585      ((eq (car cont) 'part)
586       (with-temp-buffer
587         (cond
588          ((cdr (assq 'buffer cont))
589           (insert-buffer-substring (cdr (assq 'buffer cont))))
590          ((and (setq filename (cdr (assq 'filename cont)))
591                (not (equal (cdr (assq 'nofile cont)) "yes")))
592           (mm-insert-file-contents filename))
593          (t
594           (insert (cdr (assq 'contents cont)))))
595         (goto-char (point-min))
596         (when (re-search-forward (concat "^--" (regexp-quote mml-boundary))
597                                  nil t)
598           (setq mml-boundary (funcall mml-boundary-function
599                                       (incf mml-multipart-number)))
600           (throw 'not-unique nil))))
601      ((eq (car cont) 'multipart)
602       (mapcar 'mml-compute-boundary-1 (cddr cont))))
603     t))
604
605 (defun mml-make-boundary (number)
606   (concat (make-string (% number 60) ?=)
607           (if (> number 17)
608               (format "%x" number)
609             "")
610           mml-base-boundary))
611
612 (defun mml-insert-mime-headers (cont type charset encoding flowed)
613   (let (parameters id disposition description)
614     (setq parameters
615           (mml-parameter-string
616            cont mml-content-type-parameters))
617     (when (or charset
618               parameters
619               flowed
620               (not (equal type mml-generate-default-type))
621               mml-insert-mime-headers-always)
622       (when (consp charset)
623         (error
624          "Can't encode a part with several charsets"))
625       (insert "Content-Type: " type)
626       (when charset
627         (insert "; " (mail-header-encode-parameter
628                       "charset" (symbol-name charset))))
629       (when flowed
630         (insert "; format=flowed"))
631       (when parameters
632         (mml-insert-parameter-string
633          cont mml-content-type-parameters))
634       (insert "\n"))
635     (when (setq id (cdr (assq 'id cont)))
636       (insert "Content-ID: " id "\n"))
637     (setq parameters
638           (mml-parameter-string
639            cont mml-content-disposition-parameters))
640     (when (or (setq disposition (cdr (assq 'disposition cont)))
641               parameters)
642       (insert "Content-Disposition: " (or disposition "inline"))
643       (when parameters
644         (mml-insert-parameter-string
645          cont mml-content-disposition-parameters))
646       (insert "\n"))
647     (unless (eq encoding '7bit)
648       (insert (format "Content-Transfer-Encoding: %s\n" encoding)))
649     (when (setq description (cdr (assq 'description cont)))
650       (insert "Content-Description: "
651               (mail-encode-encoded-word-string description) "\n"))))
652
653 (defun mml-parameter-string (cont types)
654   (let ((string "")
655         value type)
656     (while (setq type (pop types))
657       (when (setq value (cdr (assq type cont)))
658         ;; Strip directory component from the filename parameter.
659         (when (eq type 'filename)
660           (setq value (file-name-nondirectory value)))
661         (setq string (concat string "; "
662                              (mail-header-encode-parameter
663                               (symbol-name type) value)))))
664     (when (not (zerop (length string)))
665       string)))
666
667 (defun mml-insert-parameter-string (cont types)
668   (let (value type)
669     (while (setq type (pop types))
670       (when (setq value (cdr (assq type cont)))
671         ;; Strip directory component from the filename parameter.
672         (when (eq type 'filename)
673           (setq value (file-name-nondirectory value)))
674         (mml-insert-parameter
675          (mail-header-encode-parameter
676           (symbol-name type) value))))))
677
678 (eval-when-compile
679   (defvar ange-ftp-name-format)
680   (defvar efs-path-regexp))
681 (defun mml-parse-file-name (path)
682   (if (if (boundp 'efs-path-regexp)
683           (string-match efs-path-regexp path)
684         (if (boundp 'ange-ftp-name-format)
685             (string-match (car ange-ftp-name-format) path)))
686       (list (match-string 1 path) (match-string 2 path)
687             (substring path (1+ (match-end 2))))
688     path))
689
690 (defun mml-insert-buffer (buffer)
691   "Insert BUFFER at point and quote any MML markup."
692   (save-restriction
693     (narrow-to-region (point) (point))
694     (insert-buffer-substring buffer)
695     (mml-quote-region (point-min) (point-max))
696     (goto-char (point-max))))
697
698 ;;;
699 ;;; Transforming MIME to MML
700 ;;;
701
702 (defun mime-to-mml (&optional handles)
703   "Translate the current buffer (which should be a message) into MML.
704 If HANDLES is non-nil, use it instead reparsing the buffer."
705   ;; First decode the head.
706   (save-restriction
707     (message-narrow-to-head)
708     (mail-decode-encoded-word-region (point-min) (point-max)))
709   (unless handles
710     (setq handles (mm-dissect-buffer t)))
711   (goto-char (point-min))
712   (search-forward "\n\n" nil t)
713   (delete-region (point) (point-max))
714   (if (stringp (car handles))
715       (mml-insert-mime handles)
716     (mml-insert-mime handles t))
717   (mm-destroy-parts handles)
718   (save-restriction
719     (message-narrow-to-head)
720     ;; Remove them, they are confusing.
721     (message-remove-header "Content-Type")
722     (message-remove-header "MIME-Version")
723     (message-remove-header "Content-Disposition")
724     (message-remove-header "Content-Transfer-Encoding")))
725
726 (defun mml-to-mime ()
727   "Translate the current buffer from MML to MIME."
728   (message-encode-message-body)
729   (save-restriction
730     (message-narrow-to-headers-or-head)
731     ;; Skip past any From_ headers.
732     (while (looking-at "From ")
733       (forward-line 1))
734     (let ((mail-parse-charset message-default-charset))
735       (mail-encode-encoded-word-buffer))))
736
737 (defun mml-insert-mime (handle &optional no-markup)
738   (let (textp buffer mmlp)
739     ;; Determine type and stuff.
740     (unless (stringp (car handle))
741       (unless (setq textp (equal (mm-handle-media-supertype handle) "text"))
742         (save-excursion
743           (set-buffer (setq buffer (mml-generate-new-buffer " *mml*")))
744           (mm-insert-part handle)
745           (if (setq mmlp (equal (mm-handle-media-type handle)
746                                 "message/rfc822"))
747               (mime-to-mml)))))
748     (if mmlp
749         (mml-insert-mml-markup handle nil t t)
750       (unless (and no-markup
751                    (equal (mm-handle-media-type handle) "text/plain"))
752         (mml-insert-mml-markup handle buffer textp)))
753     (cond
754      (mmlp
755       (insert-buffer-substring buffer)
756       (goto-char (point-max))
757       (insert "<#/mml>\n"))
758      ((stringp (car handle))
759       (mapcar 'mml-insert-mime (cdr handle))
760       (insert "<#/multipart>\n"))
761      (textp
762       (let ((charset (mail-content-type-get
763                       (mm-handle-type handle) 'charset))
764             (start (point)))
765         (if (eq charset 'gnus-decoded)
766             (mm-insert-part handle)
767           (insert (mm-decode-string (mm-get-part handle) charset)))
768         (mml-quote-region start (point)))
769       (goto-char (point-max)))
770      (t
771       (insert "<#/part>\n")))))
772
773 (defun mml-insert-mml-markup (handle &optional buffer nofile mmlp)
774   "Take a MIME handle and insert an MML tag."
775   (if (stringp (car handle))
776       (progn
777         (insert "<#multipart type=" (mm-handle-media-subtype handle))
778         (let ((start (mm-handle-multipart-ctl-parameter handle 'start)))
779           (when start
780             (insert " start=\"" start "\"")))
781         (insert ">\n"))
782     (if mmlp
783         (insert "<#mml type=" (mm-handle-media-type handle))
784       (insert "<#part type=" (mm-handle-media-type handle)))
785     (dolist (elem (append (cdr (mm-handle-type handle))
786                           (cdr (mm-handle-disposition handle))))
787       (unless (symbolp (cdr elem))
788         (insert " " (symbol-name (car elem)) "=\"" (cdr elem) "\"")))
789     (when (mm-handle-id handle)
790       (insert " id=\"" (mm-handle-id handle) "\""))
791     (when (mm-handle-disposition handle)
792       (insert " disposition=" (car (mm-handle-disposition handle))))
793     (when buffer
794       (insert " buffer=\"" (buffer-name buffer) "\""))
795     (when nofile
796       (insert " nofile=yes"))
797     (when (mm-handle-description handle)
798       (insert " description=\"" (mm-handle-description handle) "\""))
799     (insert ">\n")))
800
801 (defun mml-insert-parameter (&rest parameters)
802   "Insert PARAMETERS in a nice way."
803   (dolist (param parameters)
804     (insert ";")
805     (let ((point (point)))
806       (insert " " param)
807       (when (> (current-column) 71)
808         (goto-char point)
809         (insert "\n ")
810         (end-of-line)))))
811
812 ;;;
813 ;;; Mode for inserting and editing MML forms
814 ;;;
815
816 (defvar mml-mode-map
817   (let ((sign (make-sparse-keymap))
818         (encrypt (make-sparse-keymap))
819         (signpart (make-sparse-keymap))
820         (encryptpart (make-sparse-keymap))
821         (map (make-sparse-keymap))
822         (main (make-sparse-keymap)))
823     (define-key sign "p" 'mml-secure-message-sign-pgpmime)
824     (define-key sign "o" 'mml-secure-message-sign-pgp)
825     (define-key sign "s" 'mml-secure-message-sign-smime)
826     (define-key signpart "p" 'mml-secure-sign-pgpmime)
827     (define-key signpart "o" 'mml-secure-sign-pgp)
828     (define-key signpart "s" 'mml-secure-sign-smime)
829     (define-key encrypt "p" 'mml-secure-message-encrypt-pgpmime)
830     (define-key encrypt "o" 'mml-secure-message-encrypt-pgp)
831     (define-key encrypt "s" 'mml-secure-message-encrypt-smime)
832     (define-key encryptpart "p" 'mml-secure-encrypt-pgpmime)
833     (define-key encryptpart "o" 'mml-secure-encrypt-pgp)
834     (define-key encryptpart "s" 'mml-secure-encrypt-smime)
835     (define-key map "\C-n" 'mml-unsecure-message)
836     (define-key map "f" 'mml-attach-file)
837     (define-key map "b" 'mml-attach-buffer)
838     (define-key map "e" 'mml-attach-external)
839     (define-key map "q" 'mml-quote-region)
840     (define-key map "m" 'mml-insert-multipart)
841     (define-key map "p" 'mml-insert-part)
842     (define-key map "v" 'mml-validate)
843     (define-key map "P" 'mml-preview)
844     (define-key map "s" sign)
845     (define-key map "S" signpart)
846     (define-key map "c" encrypt)
847     (define-key map "C" encryptpart)
848     ;;(define-key map "n" 'mml-narrow-to-part)
849     ;; `M-m' conflicts with `back-to-indentation'.
850     ;; (define-key main "\M-m" map)
851     (define-key main "\C-c\C-m" map)
852     main))
853
854 (easy-menu-define
855   mml-menu mml-mode-map ""
856   `("Attachments"
857     ["Attach File..." mml-attach-file
858      ,@(if (featurep 'xemacs) '(t)
859          '(:help "Attach a file at point"))]
860     ["Attach Buffer..." mml-attach-buffer t]
861     ["Attach External..." mml-attach-external t]
862     ["Insert Part..." mml-insert-part t]
863     ["Insert Multipart..." mml-insert-multipart t]
864     ["PGP/MIME Sign" mml-secure-message-sign-pgpmime t]
865     ["PGP/MIME Encrypt" mml-secure-message-encrypt-pgpmime t]
866     ["PGP Sign" mml-secure-message-sign-pgp t]
867     ["PGP Encrypt" mml-secure-message-encrypt-pgp t]
868     ["S/MIME Sign" mml-secure-message-sign-smime t]
869     ["S/MIME Encrypt" mml-secure-message-encrypt-smime t]
870     ("Secure MIME part"
871      ["PGP/MIME Sign Part" mml-secure-sign-pgpmime t]
872      ["PGP/MIME Encrypt Part" mml-secure-encrypt-pgpmime t]
873      ["PGP Sign Part" mml-secure-sign-pgp t]
874      ["PGP Encrypt Part" mml-secure-encrypt-pgp t]
875      ["S/MIME Sign Part" mml-secure-sign-smime t]
876      ["S/MIME Encrypt Part" mml-secure-encrypt-smime t])
877     ["Encrypt/Sign off" mml-unsecure-message t]
878     ;;["Narrow" mml-narrow-to-part t]
879     ["Quote MML" mml-quote-region t]
880     ["Validate MML" mml-validate t]
881     ["Preview" mml-preview t]))
882
883 (defvar mml-mode nil
884   "Minor mode for editing MML.")
885
886 (defun mml-mode (&optional arg)
887   "Minor mode for editing MML.
888 MML is the MIME Meta Language, a minor mode for composing MIME articles.
889 See Info node `(emacs-mime)Composing'.
890
891 \\{mml-mode-map}"
892   (interactive "P")
893   (when (set (make-local-variable 'mml-mode)
894              (if (null arg) (not mml-mode)
895                (> (prefix-numeric-value arg) 0)))
896     (gnus-add-minor-mode 'mml-mode " MML" mml-mode-map)
897     (easy-menu-add mml-menu mml-mode-map)
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-quote-region (beg end)
940   "Quote the MML tags in the region."
941   (interactive "r")
942   (save-excursion
943     (save-restriction
944       ;; Temporarily narrow the region to defend from changes
945       ;; invalidating END.
946       (narrow-to-region beg end)
947       (goto-char (point-min))
948       ;; Quote parts.
949       (while (re-search-forward
950               "<#!*/?\\(multipart\\|part\\|external\\|mml\\)" nil t)
951         ;; Insert ! after the #.
952         (goto-char (+ (match-beginning 0) 2))
953         (insert "!")))))
954
955 (defun mml-insert-tag (name &rest plist)
956   "Insert an MML tag described by NAME and PLIST."
957   (when (symbolp name)
958     (setq name (symbol-name name)))
959   (insert "<#" name)
960   (while plist
961     (let ((key (pop plist))
962           (value (pop plist)))
963       (when value
964         ;; Quote VALUE if it contains suspicious characters.
965         (when (string-match "[\"'\\~/*;() \t\n]" value)
966           (setq value (with-output-to-string
967                         (let (print-escape-nonascii)
968                           (prin1 value)))))
969         (insert (format " %s=%s" key value)))))
970   (insert ">\n"))
971
972 (defun mml-insert-empty-tag (name &rest plist)
973   "Insert an empty MML tag described by NAME and PLIST."
974   (when (symbolp name)
975     (setq name (symbol-name name)))
976   (apply #'mml-insert-tag name plist)
977   (insert "<#/" name ">\n"))
978
979 ;;; Attachment functions.
980
981 (defun mml-attach-file (file &optional type description)
982   "Attach a file to the outgoing MIME message.
983 The file is not inserted or encoded until you send the message with
984 `\\[message-send-and-exit]' or `\\[message-send]'.
985
986 FILE is the name of the file to attach.  TYPE is its content-type, a
987 string of the form \"type/subtype\".  DESCRIPTION is a one-line
988 description of the attachment."
989   (interactive
990    (let* ((file (mml-minibuffer-read-file "Attach file: "))
991           (type (mml-minibuffer-read-type file))
992           (description (mml-minibuffer-read-description)))
993      (list file type description)))
994   (mml-insert-empty-tag 'part 'type type 'filename file
995                         'disposition "attachment" 'description description))
996
997 (defun mml-attach-buffer (buffer &optional type description)
998   "Attach a buffer to the outgoing MIME message.
999 See `mml-attach-file' for details of operation."
1000   (interactive
1001    (let* ((buffer (read-buffer "Attach buffer: "))
1002           (type (mml-minibuffer-read-type buffer "text/plain"))
1003           (description (mml-minibuffer-read-description)))
1004      (list buffer type description)))
1005   (mml-insert-empty-tag 'part 'type type 'buffer buffer
1006                         'disposition "attachment" 'description description))
1007
1008 (defun mml-attach-external (file &optional type description)
1009   "Attach an external file into the buffer.
1010 FILE is an ange-ftp/efs specification of the part location.
1011 TYPE is the MIME type to use."
1012   (interactive
1013    (let* ((file (mml-minibuffer-read-file "Attach external file: "))
1014           (type (mml-minibuffer-read-type file))
1015           (description (mml-minibuffer-read-description)))
1016      (list file type description)))
1017   (mml-insert-empty-tag 'external 'type type 'name file
1018                         'disposition "attachment" 'description description))
1019
1020 (defun mml-insert-multipart (&optional type)
1021   (interactive (list (completing-read "Multipart type (default mixed): "
1022                                       '(("mixed") ("alternative") ("digest") ("parallel")
1023                                         ("signed") ("encrypted"))
1024                                       nil nil "mixed")))
1025   (or type
1026       (setq type "mixed"))
1027   (mml-insert-empty-tag "multipart" 'type type)
1028   (forward-line -1))
1029
1030 (defun mml-insert-part (&optional type)
1031   (interactive
1032    (list (mml-minibuffer-read-type "")))
1033   (mml-insert-tag 'part 'type type 'disposition "inline")
1034   (forward-line -1))
1035
1036 (defun mml-preview-insert-mail-followup-to ()
1037   "Insert a Mail-Followup-To header before previewing an article.
1038 Should be adopted if code in `message-send-mail' is changed."
1039   (when (and (message-mail-p)
1040              (message-subscribed-p)
1041              (not (mail-fetch-field "mail-followup-to"))
1042              (message-make-mail-followup-to))
1043     (message-position-on-field "Mail-Followup-To" "X-Draft-From")
1044     (insert (message-make-mail-followup-to))))
1045
1046 (defun mml-preview (&optional raw)
1047   "Display current buffer with Gnus, in a new buffer.
1048 If RAW, don't highlight the article."
1049   (interactive "P")
1050   (save-excursion
1051     (let* ((buf (current-buffer))
1052            (message-options message-options)
1053            (message-this-is-mail (message-mail-p))
1054            (message-this-is-news (message-news-p))
1055            (message-posting-charset (or (gnus-setup-posting-charset
1056                                          (save-restriction
1057                                            (message-narrow-to-headers-or-head)
1058                                            (message-fetch-field "Newsgroups")))
1059                                         message-posting-charset)))
1060       (message-options-set-recipient)
1061       (switch-to-buffer (generate-new-buffer
1062                          (concat (if raw "*Raw MIME preview of "
1063                                    "*MIME preview of ") (buffer-name))))
1064       (erase-buffer)
1065       (insert-buffer-substring buf)
1066       (mml-preview-insert-mail-followup-to)
1067       (let ((message-deletable-headers (if (message-news-p)
1068                                            nil
1069                                          message-deletable-headers)))
1070         (message-generate-headers
1071          (copy-sequence (if (message-news-p)
1072                             message-required-news-headers
1073                           message-required-mail-headers))))
1074       (if (re-search-forward
1075            (concat "^" (regexp-quote mail-header-separator) "\n") nil t)
1076           (replace-match "\n"))
1077       (let ((mail-header-separator ""));; mail-header-separator is removed.
1078         (mml-to-mime))
1079       (if raw
1080           (when (fboundp 'set-buffer-multibyte)
1081             (let ((s (buffer-string)))
1082               ;; Insert the content into unibyte buffer.
1083               (erase-buffer)
1084               (mm-disable-multibyte)
1085               (insert s)))
1086         (let ((gnus-newsgroup-charset (car message-posting-charset))
1087               gnus-article-prepare-hook gnus-original-article-buffer)
1088           (run-hooks 'gnus-article-decode-hook)
1089           (let ((gnus-newsgroup-name "dummy")
1090                 (gnus-newsrc-hashtb (or gnus-newsrc-hashtb
1091                                         (gnus-make-hashtable 5))))
1092             (gnus-article-prepare-display))))
1093       ;; Disable article-mode-map.
1094       (use-local-map nil)
1095       (gnus-make-local-hook 'kill-buffer-hook)
1096       (add-hook 'kill-buffer-hook
1097                 (lambda ()
1098                   (mm-destroy-parts gnus-article-mime-handles)) nil t)
1099       (setq buffer-read-only t)
1100       (local-set-key "q" (lambda () (interactive) (kill-buffer nil)))
1101       (local-set-key "=" (lambda () (interactive) (delete-other-windows)))
1102       (local-set-key "\r"
1103                      (lambda ()
1104                        (interactive)
1105                        (widget-button-press (point))))
1106       (local-set-key gnus-mouse-2
1107                      (lambda (event)
1108                        (interactive "@e")
1109                        (widget-button-press (widget-event-point event) event)))
1110       (goto-char (point-min)))))
1111
1112 (defun mml-validate ()
1113   "Validate the current MML document."
1114   (interactive)
1115   (mml-parse))
1116
1117 (defun mml-tweak-part (cont)
1118   "Tweak a MML part."
1119   (let ((tweak (cdr (assq 'tweak cont)))
1120         func)
1121     (cond
1122      (tweak
1123       (setq func
1124             (or (cdr (assoc tweak mml-tweak-function-alist))
1125                 (intern tweak))))
1126      (mml-tweak-type-alist
1127       (let ((alist mml-tweak-type-alist)
1128             (type (or (cdr (assq 'type cont)) "text/plain")))
1129         (while alist
1130           (if (string-match (caar alist) type)
1131               (setq func (cdar alist)
1132                     alist nil)
1133             (setq alist (cdr alist)))))))
1134     (if func
1135         (funcall func cont)
1136       cont)
1137     (let ((alist mml-tweak-sexp-alist))
1138       (while alist
1139         (if (eval (caar alist))
1140             (funcall (cdar alist) cont))
1141         (setq alist (cdr alist)))))
1142   cont)
1143
1144 (defun mml-tweak-externalize-attachments (cont)
1145   "Tweak attached files as external parts."
1146   (let (filename-cons)
1147     (when (and (eq (car cont) 'part)
1148                (not (cdr (assq 'buffer cont)))
1149                (and (setq filename-cons (assq 'filename cont))
1150                     (not (equal (cdr (assq 'nofile cont)) "yes"))))
1151       (setcar cont 'external)
1152       (setcar filename-cons 'name))))
1153
1154 (provide 'mml)
1155
1156 ;;; mml.el ends here