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.
31 (autoload 'message-make-message-id "message"))
33 (defvar mml-syntax-table
34 (let ((table (copy-syntax-table emacs-lisp-mode-syntax-table)))
35 (modify-syntax-entry ?\\ "/" table)
36 (modify-syntax-entry ?< "(" table)
37 (modify-syntax-entry ?> ")" table)
38 (modify-syntax-entry ?@ "w" table)
39 (modify-syntax-entry ?/ "w" table)
40 (modify-syntax-entry ?= " " table)
41 (modify-syntax-entry ?* " " table)
42 (modify-syntax-entry ?\; " " table)
43 (modify-syntax-entry ?\' " " table)
47 "Parse the current buffer as an MML document."
48 (goto-char (point-min))
49 (let ((table (syntax-table)))
52 (set-syntax-table mml-syntax-table)
54 (set-syntax-table table))))
57 "Parse the current buffer as an MML document."
58 (let (struct tag point contents charsets warn)
59 (while (and (not (eobp))
60 (not (looking-at "<#/multipart")))
62 ((looking-at "<#multipart")
63 (push (nconc (mml-read-tag) (mml-parse-1)) struct))
64 ((looking-at "<#external")
65 (push (nconc (mml-read-tag) (list (cons 'contents (mml-read-part))))
68 (if (looking-at "<#part")
69 (setq tag (mml-read-tag))
70 (setq tag (list 'part '(type . "text/plain"))
73 contents (mml-read-part)
74 charsets (mm-find-mime-charset-region point (point)))
75 (if (< (length charsets) 2)
76 (push (nconc tag (list (cons 'contents contents)))
78 (let ((nstruct (mml-parse-singlepart-with-multiple-charsets
84 "Warning: Your message contains %d parts. Really send? "
86 (error "Edit your message to use only one charset"))
87 (setq struct (nconc nstruct struct)))))))
92 (defun mml-parse-singlepart-with-multiple-charsets (orig-tag beg end)
94 (narrow-to-region beg end)
95 (goto-char (point-min))
96 (let ((current (mm-mime-charset (char-charset (following-char))))
97 charset struct space newline paragraph)
100 ;; The charset remains the same.
101 ((or (eq (setq charset (mm-mime-charset
102 (char-charset (following-char)))) 'us-ascii)
103 (eq charset current)))
104 ;; The initial charset was ascii.
105 ((eq current 'us-ascii)
106 (setq current charset
110 ;; We have a change in charsets.
114 (list (cons 'contents
115 (buffer-substring-no-properties
116 beg (or paragraph newline space (point))))))
118 (setq beg (or paragraph newline space (point))
123 ;; Compute places where it might be nice to break the part.
125 ((memq (following-char) '(? ?\t))
126 (setq space (1+ (point))))
127 ((eq (following-char) ?\n)
128 (setq newline (1+ (point))))
129 ((and (eq (following-char) ?\n)
131 (eq (char-after (1- (point))) ?\n))
132 (setq paragraph (point))))
134 ;; Do the final part.
135 (unless (= beg (point))
136 (push (append orig-tag
137 (list (cons 'contents
138 (buffer-substring-no-properties
143 (defun mml-read-tag ()
144 "Read a tag and return the contents."
145 (let (contents name elem val)
147 (setq name (buffer-substring-no-properties
148 (point) (progn (forward-sexp 1) (point))))
149 (skip-chars-forward " \t\n")
150 (while (not (looking-at ">"))
151 (setq elem (buffer-substring-no-properties
152 (point) (progn (forward-sexp 1) (point))))
153 (skip-chars-forward "= \t\n")
154 (setq val (buffer-substring-no-properties
155 (point) (progn (forward-sexp 1) (point))))
156 (when (string-match "^\"\\(.*\\)\"$" val)
157 (setq val (match-string 1 val)))
158 (push (cons (intern elem) val) contents)
159 (skip-chars-forward " \t\n"))
161 (skip-chars-forward " \t\n")
162 (cons (intern name) (nreverse contents))))
164 (defun mml-read-part ()
165 "Return the buffer up till the next part, multipart or closing part or multipart."
167 ;; If the tag ended at the end of the line, we go to the next line.
168 (when (looking-at "[ \t]*\n")
170 (if (re-search-forward
171 "<#\\(/\\)?\\(multipart\\|part\\|external\\)." nil t)
173 (buffer-substring-no-properties beg (match-beginning 0))
174 (if (or (not (match-beginning 1))
175 (equal (match-string 2) "multipart"))
176 (goto-char (match-beginning 0))
177 (when (looking-at "[ \t]*\n")
179 (buffer-substring-no-properties beg (goto-char (point-max))))))
181 (defvar mml-boundary nil)
182 (defvar mml-base-boundary "-=-=")
183 (defvar mml-multipart-number 0)
185 (defun mml-generate-mime ()
186 "Generate a MIME message based on the current MML document."
187 (let ((cont (mml-parse))
188 (mml-multipart-number 0))
192 (if (and (consp (car cont))
194 (mml-generate-mime-1 (car cont))
195 (mml-generate-mime-1 (nconc (list 'multipart '(type . "mixed"))
199 (defun mml-generate-mime-1 (cont)
201 ((eq (car cont) 'part)
202 (let (coded encoding charset filename type)
203 (setq type (or (cdr (assq 'type cont)) "text/plain"))
204 (if (equal (car (split-string type "/")) "text")
207 ((cdr (assq 'buffer cont))
208 (insert-buffer-substring (cdr (assq 'buffer cont))))
209 ((setq filename (cdr (assq 'filename cont)))
210 (insert-file-contents-literally filename))
213 (narrow-to-region (point) (point))
214 (insert (cdr (assq 'contents cont)))
215 ;; Remove quotes from quoted tags.
216 (goto-char (point-min))
217 (while (re-search-forward
218 "<#!+/?\\(part\\|multipart\\|external\\)" nil t)
219 (delete-region (+ (match-beginning 0) 2)
220 (+ (match-beginning 0) 3))))))
221 (setq charset (mm-encode-body))
222 (setq encoding (mm-body-encoding charset))
223 (setq coded (buffer-string)))
224 (mm-with-unibyte-buffer
226 ((cdr (assq 'buffer cont))
227 (insert-buffer-substring (cdr (assq 'buffer cont))))
228 ((setq filename (cdr (assq 'filename cont)))
229 (insert-file-contents-literally filename))
231 (insert (cdr (assq 'contents cont)))))
232 (setq encoding (mm-encode-buffer type)
233 coded (buffer-string))))
234 (mml-insert-mime-headers cont type charset encoding)
237 ((eq (car cont) 'external)
238 (insert "Content-Type: message/external-body")
239 (let ((parameters (mml-parameter-string
240 cont '(expiration size permission)))
241 (name (cdr (assq 'name cont))))
243 (setq name (mml-parse-file-name name))
245 (insert ";\n " (mail-header-encode-parameter "name" name)
246 "\";\n access-type=local-file")
249 (mail-header-encode-parameter
250 "name" (file-name-nondirectory (nth 2 name)))
251 (mail-header-encode-parameter "site" (nth 1 name))
252 (mail-header-encode-parameter
253 "directory" (file-name-directory (nth 2 name)))))
254 (insert ";\n access-type="
255 (if (member (nth 0 name) '("ftp@" "anonymous@"))
259 (insert parameters)))
261 (insert "Content-Type: " (cdr (assq 'type cont)) "\n")
262 (insert "Content-ID: " (message-make-message-id) "\n")
263 (insert "Content-Transfer-Encoding: "
264 (or (cdr (assq 'encoding cont)) "binary"))
266 (insert (or (cdr (assq 'contents cont))))
268 ((eq (car cont) 'multipart)
269 (let ((mml-boundary (mml-compute-boundary cont)))
270 (insert (format "Content-Type: multipart/%s; boundary=\"%s\"\n"
271 (or (cdr (assq 'type cont)) "mixed")
274 (setq cont (cddr cont))
276 (insert "\n--" mml-boundary "\n")
277 (mml-generate-mime-1 (pop cont)))
278 (insert "\n--" mml-boundary "--\n")))
280 (error "Invalid element: %S" cont))))
282 (defun mml-compute-boundary (cont)
283 "Return a unique boundary that does not exist in CONT."
284 (let ((mml-boundary (mml-make-boundary)))
285 ;; This function tries again and again until it has found
286 ;; a unique boundary.
287 (while (not (catch 'not-unique
288 (mml-compute-boundary-1 cont))))
291 (defun mml-compute-boundary-1 (cont)
294 ((eq (car cont) 'part)
297 ((cdr (assq 'buffer cont))
298 (insert-buffer-substring (cdr (assq 'buffer cont))))
299 ((setq filename (cdr (assq 'filename cont)))
300 (insert-file-contents-literally filename))
302 (insert (cdr (assq 'contents cont)))))
303 (goto-char (point-min))
304 (when (re-search-forward (concat "^--" (regexp-quote mml-boundary))
306 (setq mml-boundary (mml-make-boundary))
307 (throw 'not-unique nil))))
308 ((eq (car cont) 'multipart)
309 (mapcar 'mml-compute-boundary-1 (cddr cont))))
312 (defun mml-make-boundary ()
313 (concat (make-string (% (incf mml-multipart-number) 60) ?=)
314 (if (> mml-multipart-number 17)
315 (format "%x" mml-multipart-number)
319 (defun mml-make-string (num string)
321 (while (not (zerop (decf num)))
322 (setq out (concat out string)))
325 (defun mml-insert-mime-headers (cont type charset encoding)
326 (let (parameters disposition description)
328 (mml-parameter-string
329 cont '(name access-type expiration size permission)))
332 (not (equal type "text/plain")))
333 (when (consp charset)
335 "Can't encode a part with several charsets."))
336 (insert "Content-Type: " type)
338 (insert "; " (mail-header-encode-parameter
339 "charset" (symbol-name charset))))
344 (mml-parameter-string
345 cont '(filename creation-date modification-date read-date)))
346 (when (or (setq disposition (cdr (assq 'disposition cont)))
348 (insert "Content-Disposition: " (or disposition "inline"))
352 (unless (eq encoding '7bit)
353 (insert (format "Content-Transfer-Encoding: %s\n" encoding)))
354 (when (setq description (cdr (assq 'description cont)))
355 (insert "Content-Description: "
356 (mail-encode-encoded-word-string description) "\n"))))
358 (defun mml-parameter-string (cont types)
361 (while (setq type (pop types))
362 (when (setq value (cdr (assq type cont)))
363 ;; Strip directory component from the filename parameter.
364 (when (eq type 'filename)
365 (setq value (file-name-nondirectory value)))
366 (setq string (concat string ";\n "
367 (mail-header-encode-parameter
368 (symbol-name type) value)))))
369 (when (not (zerop (length string)))
372 (defvar ange-ftp-path-format)
373 (defvar efs-path-regexp)
374 (defun mml-parse-file-name (path)
375 (if (if (boundp 'efs-path-regexp)
376 (string-match efs-path-regexp path)
377 (if (boundp 'ange-ftp-path-format)
378 (string-match (car ange-ftp-path-format))))
379 (list (match-string 1 path) (match-string 2 path)
380 (substring path (1+ (match-end 2))))
383 (defun mml-quote-region (beg end)
384 "Quote the MML tags in the region."
389 (while (re-search-forward
390 "<#/?!*\\(multipart\\|part\\|external\\)" end t)
391 (goto-char (match-beginning 1))
395 ;;; Transforming MIME to MML
398 (defun mime-to-mml ()
399 "Translate the current buffer (which should be a message) into MML."
400 ;; First decode the head.
402 (message-narrow-to-head)
403 (mail-decode-encoded-word-region (point-min) (point-max)))
404 (let ((handles (mm-dissect-buffer t)))
405 (goto-char (point-min))
406 (search-forward "\n\n" nil t)
407 (delete-region (point) (point-max))
408 (if (stringp (car handles))
409 (mml-insert-mime handles)
410 (mml-insert-mime handles t))
411 (mm-destroy-parts handles)))
413 (defun mml-to-mime ()
414 "Translate the current buffer from MML to MIME."
415 (message-encode-message-body)
417 (message-narrow-to-headers)
418 (mail-encode-encoded-word-buffer)))
420 (defun mml-insert-mime (handle &optional no-markup)
422 ;; Determine type and stuff.
423 (unless (stringp (car handle))
424 (unless (setq textp (equal
426 (car (mm-handle-type handle)) "/"))
429 (set-buffer (setq buffer (generate-new-buffer " *mml*")))
430 (mm-insert-part handle))))
432 (mml-insert-mml-markup handle buffer))
434 ((stringp (car handle))
435 (mapcar 'mml-insert-mime (cdr handle))
436 (insert "<#/multipart>\n"))
438 (mm-insert-part handle)
439 (goto-char (point-max)))
441 (insert "<#/part>\n")))))
443 (defun mml-insert-mml-markup (handle &optional buffer)
444 "Take a MIME handle and insert an MML tag."
445 (if (stringp (car handle))
446 (insert "<#multipart type=" (cadr (split-string (car handle) "/"))
448 (insert "<#part type=" (car (mm-handle-type handle)))
449 (dolist (elem (append (cdr (mm-handle-type handle))
450 (cdr (mm-handle-disposition handle))))
451 (insert " " (symbol-name (car elem)) "=\"" (cdr elem) "\""))
453 (insert " buffer=\"" (buffer-name buffer) "\""))
454 (when (mm-handle-description handle)
455 (insert " description=\"" (mm-handle-description handle) "\""))
456 (equal (split-string (car (mm-handle-type handle)) "/") "text")