1 ;;; mml.el --- A package for parsing and validating MML documents
2 ;; Copyright (C) 1998,99 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to the
19 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 ;; Boston, MA 02111-1307, USA.
32 (autoload 'message-make-message-id "message"))
34 (defvar mml-syntax-table
35 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
36 (modify-syntax-entry ?\\ "/" table)
37 (modify-syntax-entry ?< "(" table)
38 (modify-syntax-entry ?> ")" table)
39 (modify-syntax-entry ?@ "w" table)
40 (modify-syntax-entry ?/ "w" table)
41 (modify-syntax-entry ?= " " table)
42 (modify-syntax-entry ?* " " table)
43 (modify-syntax-entry ?\; " " table)
44 (modify-syntax-entry ?\' " " table)
48 "Parse the current buffer as an MML document."
49 (goto-char (point-min))
50 (let ((table (syntax-table)))
53 (set-syntax-table mml-syntax-table)
55 (set-syntax-table table))))
58 "Parse the current buffer as an MML document."
59 (let (struct tag point contents charsets warn)
60 (while (and (not (eobp))
61 (not (looking-at "<#/multipart")))
63 ((looking-at "<#multipart")
64 (push (nconc (mml-read-tag) (mml-parse-1)) struct))
65 ((looking-at "<#external")
66 (push (nconc (mml-read-tag) (list (cons 'contents (mml-read-part))))
69 (if (looking-at "<#part")
70 (setq tag (mml-read-tag))
71 (setq tag (list 'part '(type . "text/plain"))
74 contents (mml-read-part)
75 charsets (mm-find-mime-charset-region point (point)))
76 (if (< (length charsets) 2)
77 (push (nconc tag (list (cons 'contents contents)))
79 (let ((nstruct (mml-parse-singlepart-with-multiple-charsets
85 "Warning: Your message contains %d parts. Really send? "
87 (error "Edit your message to use only one charset"))
88 (setq struct (nconc nstruct struct)))))))
93 (defun mml-parse-singlepart-with-multiple-charsets (orig-tag beg end)
95 (narrow-to-region beg end)
96 (goto-char (point-min))
97 (let ((current (mm-mime-charset (char-charset (following-char))))
98 charset struct space newline paragraph)
101 ;; The charset remains the same.
102 ((or (eq (setq charset (mm-mime-charset
103 (char-charset (following-char)))) 'us-ascii)
104 (eq charset current)))
105 ;; The initial charset was ascii.
106 ((eq current 'us-ascii)
107 (setq current charset
111 ;; We have a change in charsets.
115 (list (cons 'contents
116 (buffer-substring-no-properties
117 beg (or paragraph newline space (point))))))
119 (setq beg (or paragraph newline space (point))
124 ;; Compute places where it might be nice to break the part.
126 ((memq (following-char) '(? ?\t))
127 (setq space (1+ (point))))
128 ((eq (following-char) ?\n)
129 (setq newline (1+ (point))))
130 ((and (eq (following-char) ?\n)
132 (eq (char-after (1- (point))) ?\n))
133 (setq paragraph (point))))
135 ;; Do the final part.
136 (unless (= beg (point))
137 (push (append orig-tag
138 (list (cons 'contents
139 (buffer-substring-no-properties
144 (defun mml-read-tag ()
145 "Read a tag and return the contents."
146 (let (contents name elem val)
148 (setq name (buffer-substring-no-properties
149 (point) (progn (forward-sexp 1) (point))))
150 (skip-chars-forward " \t\n")
151 (while (not (looking-at ">"))
152 (setq elem (buffer-substring-no-properties
153 (point) (progn (forward-sexp 1) (point))))
154 (skip-chars-forward "= \t\n")
155 (setq val (buffer-substring-no-properties
156 (point) (progn (forward-sexp 1) (point))))
157 (when (string-match "^\"\\(.*\\)\"$" val)
158 (setq val (match-string 1 val)))
159 (push (cons (intern elem) val) contents)
160 (skip-chars-forward " \t\n"))
162 (skip-chars-forward " \t\n")
163 (cons (intern name) (nreverse contents))))
165 (defun mml-read-part ()
166 "Return the buffer up till the next part, multipart or closing part or multipart."
168 ;; If the tag ended at the end of the line, we go to the next line.
169 (when (looking-at "[ \t]*\n")
171 (if (re-search-forward
172 "<#\\(/\\)?\\(multipart\\|part\\|external\\)." nil t)
174 (buffer-substring-no-properties beg (match-beginning 0))
175 (if (or (not (match-beginning 1))
176 (equal (match-string 2) "multipart"))
177 (goto-char (match-beginning 0))
178 (when (looking-at "[ \t]*\n")
180 (buffer-substring-no-properties beg (goto-char (point-max))))))
182 (defvar mml-boundary nil)
183 (defvar mml-base-boundary "-=-=")
184 (defvar mml-multipart-number 0)
186 (defun mml-generate-mime ()
187 "Generate a MIME message based on the current MML document."
188 (let ((cont (mml-parse))
189 (mml-multipart-number 0))
193 (if (and (consp (car cont))
195 (mml-generate-mime-1 (car cont))
196 (mml-generate-mime-1 (nconc (list 'multipart '(type . "mixed"))
200 (defun mml-generate-mime-1 (cont)
202 ((eq (car cont) 'part)
203 (let (coded encoding charset filename type)
204 (setq type (or (cdr (assq 'type cont)) "text/plain"))
205 (if (member (car (split-string type "/")) '("text" "message"))
208 ((cdr (assq 'buffer cont))
209 (insert-buffer-substring (cdr (assq 'buffer cont))))
210 ((setq filename (cdr (assq 'filename cont)))
211 (mm-insert-file-contents filename))
214 (narrow-to-region (point) (point))
215 (insert (cdr (assq 'contents cont)))
216 ;; Remove quotes from quoted tags.
217 (goto-char (point-min))
218 (while (re-search-forward
219 "<#!+/?\\(part\\|multipart\\|external\\)" nil t)
220 (delete-region (+ (match-beginning 0) 2)
221 (+ (match-beginning 0) 3))))))
222 (setq charset (mm-encode-body))
223 (setq encoding (mm-body-encoding charset))
224 (setq coded (buffer-string)))
225 (mm-with-unibyte-buffer
227 ((cdr (assq 'buffer cont))
228 (insert-buffer-substring (cdr (assq 'buffer cont))))
229 ((setq filename (cdr (assq 'filename cont)))
230 (mm-insert-file-contents filename))
232 (insert (cdr (assq 'contents cont)))))
233 (setq encoding (mm-encode-buffer type)
234 coded (buffer-string))))
235 (mml-insert-mime-headers cont type charset encoding)
238 ((eq (car cont) 'external)
239 (insert "Content-Type: message/external-body")
240 (let ((parameters (mml-parameter-string
241 cont '(expiration size permission)))
242 (name (cdr (assq 'name cont))))
244 (setq name (mml-parse-file-name name))
246 (mml-insert-parameter
247 (mail-header-encode-parameter "name" name)
248 "access-type=local-file")
249 (mml-insert-parameter
250 (mail-header-encode-parameter
251 "name" (file-name-nondirectory (nth 2 name)))
252 (mail-header-encode-parameter "site" (nth 1 name))
253 (mail-header-encode-parameter
254 "directory" (file-name-directory (nth 2 name))))
255 (mml-insert-parameter
256 (concat "access-type="
257 (if (member (nth 0 name) '("ftp@" "anonymous@"))
261 (mml-insert-parameter-string
262 cont '(expiration size permission))))
264 (insert "Content-Type: " (cdr (assq 'type cont)) "\n")
265 (insert "Content-ID: " (message-make-message-id) "\n")
266 (insert "Content-Transfer-Encoding: "
267 (or (cdr (assq 'encoding cont)) "binary"))
269 (insert (or (cdr (assq 'contents cont))))
271 ((eq (car cont) 'multipart)
272 (let ((mml-boundary (mml-compute-boundary cont)))
273 (insert (format "Content-Type: multipart/%s; boundary=\"%s\"\n"
274 (or (cdr (assq 'type cont)) "mixed")
277 (setq cont (cddr cont))
279 (insert "\n--" mml-boundary "\n")
280 (mml-generate-mime-1 (pop cont)))
281 (insert "\n--" mml-boundary "--\n")))
283 (error "Invalid element: %S" cont))))
285 (defun mml-compute-boundary (cont)
286 "Return a unique boundary that does not exist in CONT."
287 (let ((mml-boundary (mml-make-boundary)))
288 ;; This function tries again and again until it has found
289 ;; a unique boundary.
290 (while (not (catch 'not-unique
291 (mml-compute-boundary-1 cont))))
294 (defun mml-compute-boundary-1 (cont)
297 ((eq (car cont) 'part)
300 ((cdr (assq 'buffer cont))
301 (insert-buffer-substring (cdr (assq 'buffer cont))))
302 ((setq filename (cdr (assq 'filename cont)))
303 (mm-insert-file-contents filename))
305 (insert (cdr (assq 'contents cont)))))
306 (goto-char (point-min))
307 (when (re-search-forward (concat "^--" (regexp-quote mml-boundary))
309 (setq mml-boundary (mml-make-boundary))
310 (throw 'not-unique nil))))
311 ((eq (car cont) 'multipart)
312 (mapcar 'mml-compute-boundary-1 (cddr cont))))
315 (defun mml-make-boundary ()
316 (concat (make-string (% (incf mml-multipart-number) 60) ?=)
317 (if (> mml-multipart-number 17)
318 (format "%x" mml-multipart-number)
322 (defun mml-make-string (num string)
324 (while (not (zerop (decf num)))
325 (setq out (concat out string)))
328 (defun mml-insert-mime-headers (cont type charset encoding)
329 (let (parameters disposition description)
331 (mml-parameter-string
332 cont '(name access-type expiration size permission)))
335 (not (equal type "text/plain")))
336 (when (consp charset)
338 "Can't encode a part with several charsets."))
339 (insert "Content-Type: " type)
341 (insert "; " (mail-header-encode-parameter
342 "charset" (symbol-name charset))))
344 (mml-insert-parameter-string
345 cont '(name access-type expiration size permission)))
348 (mml-parameter-string
349 cont '(filename creation-date modification-date read-date)))
350 (when (or (setq disposition (cdr (assq 'disposition cont)))
352 (insert "Content-Disposition: " (or disposition "inline"))
354 (mml-insert-parameter-string
355 cont '(filename creation-date modification-date read-date)))
357 (unless (eq encoding '7bit)
358 (insert (format "Content-Transfer-Encoding: %s\n" encoding)))
359 (when (setq description (cdr (assq 'description cont)))
360 (insert "Content-Description: "
361 (mail-encode-encoded-word-string description) "\n"))))
363 (defun mml-parameter-string (cont types)
366 (while (setq type (pop types))
367 (when (setq value (cdr (assq type cont)))
368 ;; Strip directory component from the filename parameter.
369 (when (eq type 'filename)
370 (setq value (file-name-nondirectory value)))
371 (setq string (concat string "; "
372 (mail-header-encode-parameter
373 (symbol-name type) value)))))
374 (when (not (zerop (length string)))
377 (defun mml-insert-parameter-string (cont types)
379 (while (setq type (pop types))
380 (when (setq value (cdr (assq type cont)))
381 ;; Strip directory component from the filename parameter.
382 (when (eq type 'filename)
383 (setq value (file-name-nondirectory value)))
384 (mml-insert-parameter
385 (mail-header-encode-parameter
386 (symbol-name type) value))))))
388 (defvar ange-ftp-path-format)
389 (defvar efs-path-regexp)
390 (defun mml-parse-file-name (path)
391 (if (if (boundp 'efs-path-regexp)
392 (string-match efs-path-regexp path)
393 (if (boundp 'ange-ftp-path-format)
394 (string-match (car ange-ftp-path-format))))
395 (list (match-string 1 path) (match-string 2 path)
396 (substring path (1+ (match-end 2))))
399 (defun mml-insert-buffer (buffer)
400 "Insert BUFFER at point and quote any MML markup."
402 (narrow-to-region (point) (point))
403 (insert-buffer-substring buffer)
404 (mml-quote-region (point-min) (point-max))
405 (goto-char (point-max))))
408 ;;; Transforming MIME to MML
411 (defun mime-to-mml ()
412 "Translate the current buffer (which should be a message) into MML."
413 ;; First decode the head.
415 (message-narrow-to-head)
416 (mail-decode-encoded-word-region (point-min) (point-max)))
417 (let ((handles (mm-dissect-buffer t)))
418 (goto-char (point-min))
419 (search-forward "\n\n" nil t)
420 (delete-region (point) (point-max))
421 (if (stringp (car handles))
422 (mml-insert-mime handles)
423 (mml-insert-mime handles t))
424 (mm-destroy-parts handles)))
426 (defun mml-to-mime ()
427 "Translate the current buffer from MML to MIME."
428 (message-encode-message-body)
430 (message-narrow-to-headers)
431 (mail-encode-encoded-word-buffer)))
433 (defun mml-insert-mime (handle &optional no-markup)
435 ;; Determine type and stuff.
436 (unless (stringp (car handle))
437 (unless (setq textp (equal
439 (car (mm-handle-type handle)) "/"))
442 (set-buffer (setq buffer (generate-new-buffer " *mml*")))
443 (mm-insert-part handle))))
445 (mml-insert-mml-markup handle buffer))
447 ((stringp (car handle))
448 (mapcar 'mml-insert-mime (cdr handle))
449 (insert "<#/multipart>\n"))
451 (mm-insert-part handle)
452 (goto-char (point-max)))
454 (insert "<#/part>\n")))))
456 (defun mml-insert-mml-markup (handle &optional buffer)
457 "Take a MIME handle and insert an MML tag."
458 (if (stringp (car handle))
459 (insert "<#multipart type=" (cadr (split-string (car handle) "/"))
461 (insert "<#part type=" (car (mm-handle-type handle)))
462 (dolist (elem (append (cdr (mm-handle-type handle))
463 (cdr (mm-handle-disposition handle))))
464 (insert " " (symbol-name (car elem)) "=\"" (cdr elem) "\""))
465 (when (mm-handle-disposition handle)
466 (insert " disposition=" (car (mm-handle-disposition handle))))
468 (insert " buffer=\"" (buffer-name buffer) "\""))
469 (when (mm-handle-description handle)
470 (insert " description=\"" (mm-handle-description handle) "\""))
471 (equal (split-string (car (mm-handle-type handle)) "/") "text")
474 (defun mml-insert-parameter (&rest parameters)
475 "Insert PARAMETERS in a nice way."
476 (dolist (param parameters)
478 (let ((point (point)))
480 (when (> (current-column) 71)
486 ;;; Mode for inserting and editing MML forms
490 (let ((map (make-sparse-keymap))
491 (main (make-sparse-keymap)))
492 (define-key map "f" 'mml-attach-file)
493 (define-key map "b" 'mml-attach-buffer)
494 (define-key map "e" 'mml-attach-external)
495 (define-key map "q" 'mml-quote-region)
496 (define-key map "m" 'mml-insert-multipart)
497 (define-key map "p" 'mml-insert-part)
498 (define-key map "v" 'mml-validate)
499 (define-key map "P" 'mml-preview)
500 (define-key main "\M-m" map)
504 mml-menu mml-mode-map ""
507 ["File" mml-attach-file t]
508 ["Buffer" mml-attach-buffer t]
509 ["External" mml-attach-external t])
511 ["Multipart" mml-insert-multipart t]
512 ["Part" mml-insert-part t])
513 ["Quote" mml-quote-region t]
514 ["Validate" mml-validate t]
515 ["Preview" mml-preview t]))
518 "Minor mode for editing MML.")
520 (defun mml-mode (&optional arg)
521 "Minor mode for editing MML.
525 (if (not (set (make-local-variable 'mml-mode)
526 (if (null arg) (not mml-mode)
527 (> (prefix-numeric-value arg) 0))))
529 (set (make-local-variable 'mml-mode) t)
530 (unless (assq 'mml-mode minor-mode-alist)
531 (push `(mml-mode " MML") minor-mode-alist))
532 (unless (assq 'mml-mode minor-mode-map-alist)
533 (push (cons 'mml-mode mml-mode-map)
534 minor-mode-map-alist)))
535 (run-hooks 'mml-mode-hook))
538 ;;; Helper functions for reading MIME stuff from the minibuffer and
539 ;;; inserting stuff to the buffer.
542 (defun mml-minibuffer-read-file (prompt)
543 (let ((file (read-file-name prompt nil nil t)))
544 ;; Prevent some common errors. This is inspired by similar code in
546 (when (file-directory-p file)
547 (error "%s is a directory, cannot attach" file))
548 (unless (file-exists-p file)
549 (error "No such file: %s" file))
550 (unless (file-readable-p file)
551 (error "Permission denied: %s" file))
554 (defun mml-minibuffer-read-type (name &optional default)
555 (let* ((default (or default
556 (mm-default-file-encoding name)
557 ;; Perhaps here we should check what the file
558 ;; looks like, and offer text/plain if it looks
560 "application/octet-stream"))
561 (string (completing-read
562 (format "Content type (default %s): " default)
567 (mapcar (lambda (m) (cdr m))
568 mailcap-mime-extensions)
576 (let ((type (cdr (assq 'type (cdr m)))))
577 (if (equal (cadr (split-string type "/"))
584 (if (not (equal string ""))
588 (defun mml-minibuffer-read-description ()
589 (let ((description (read-string "One line description: ")))
590 (when (string-match "\\`[ \t]*\\'" description)
591 (setq description nil))
594 (defun mml-quote-region (beg end)
595 "Quote the MML tags in the region."
599 ;; Temporarily narrow the region to defend from changes
601 (narrow-to-region beg end)
602 (goto-char (point-min))
604 (while (re-search-forward
605 "<#/?!*\\(multipart\\|part\\|external\\)" nil t)
606 (goto-char (match-beginning 1))
609 (defun mml-insert-tag (name &rest plist)
610 "Insert an MML tag described by NAME and PLIST."
612 (setq name (symbol-name name)))
615 (let ((key (pop plist))
618 ;; Quote VALUE if it contains suspicious characters.
619 (when (string-match "[\"\\~/* \t\n]" value)
620 (setq value (prin1-to-string value)))
621 (insert (format " %s=%s" key value)))))
622 (insert ">\n<#/" name ">\n"))
624 ;;; Attachment functions.
626 (defun mml-attach-file (file &optional type description)
627 "Attach a file to the outgoing MIME message.
628 The file is not inserted or encoded until you send the message with
629 `\\[message-send-and-exit]' or `\\[message-send]'.
631 FILE is the name of the file to attach. TYPE is its content-type, a
632 string of the form \"type/subtype\". DESCRIPTION is a one-line
633 description of the attachment."
635 (let* ((file (mml-minibuffer-read-file "Attach file: "))
636 (type (mml-minibuffer-read-type file))
637 (description (mml-minibuffer-read-description)))
638 (list file type description)))
639 (mml-insert-tag 'part 'type type 'filename file 'disposition "attachment"
640 'description description))
642 (defun mml-attach-buffer (buffer &optional type description)
643 "Attach a buffer to the outgoing MIME message.
644 See `mml-attach-file' for details of operation."
646 (let* ((buffer (read-buffer "Attach buffer: "))
647 (type (mml-minibuffer-read-type buffer "text/plain"))
648 (description (mml-minibuffer-read-description)))
649 (list buffer type description)))
650 (mml-insert-tag 'part 'type type 'buffer buffer 'disposition "attachment"
651 'description description))
653 (defun mml-attach-external (file &optional type description)
654 "Attach an external file into the buffer.
655 FILE is an ange-ftp/efs specification of the part location.
656 TYPE is the MIME type to use."
658 (let* ((file (mml-minibuffer-read-file "Attach external file: "))
659 (type (mml-minibuffer-read-type file))
660 (description (mml-minibuffer-read-description)))
661 (list file type description)))
662 (mml-insert-tag 'external 'type type 'name file 'disposition "attachment"
663 'description description))
665 (defun mml-insert-multipart (&optional type)
666 (interactive (list (completing-read "Multipart type (default mixed): "
667 '(("mixed") ("alternative") ("digest") ("parallel")
668 ("signed") ("encrypted"))
672 (mml-insert-tag "multipart" 'type type)
675 (defun mml-preview (&optional raw)
676 "Display current buffer with Gnus, in a new buffer.
677 If RAW, don't highlight the article."
679 (let ((buf (current-buffer)))
680 (switch-to-buffer (get-buffer-create
681 (concat (if raw "*Raw MIME preview of "
682 "*MIME preview of ") (buffer-name))))
687 (run-hooks 'gnus-article-decode-hook)
688 (let ((gnus-newsgroup-name "dummy"))
689 (gnus-article-prepare-display)))
691 (setq buffer-read-only t)
692 (goto-char (point-min))))
694 (defun mml-validate ()
695 "Validate the current MML document."