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