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