1 ;;; mm-encode.el --- Functions for encoding MIME things
2 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004
3 ;; Free Software Foundation, Inc.
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; MORIOKA Tomohiko <morioka@jaist.ac.jp>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
28 (eval-when-compile (require 'cl))
30 (require 'gnus-mailcap)
32 (autoload 'mm-body-7-or-8 "mm-bodies")
33 (autoload 'mm-long-lines-p "mm-bodies"))
35 (defcustom mm-content-transfer-encoding-defaults
36 '(("text/x-patch" 8bit)
37 ("text/.*" qp-or-base64)
38 ("message/rfc822" 8bit)
39 ("application/emacs-lisp" 8bit)
40 ("application/x-emacs-lisp" 8bit)
41 ("application/x-patch" 8bit)
43 "Alist of regexps that match MIME types and their encodings.
44 If the encoding is `qp-or-base64', then either quoted-printable
45 or base64 will be used, depending on what is more efficient.
47 Note: It affects body encoding only when a part is a raw forwarded
48 message (which will be made by `gnus-summary-mail-forward' with the
49 arg 2 for example) or is neither the text/* type nor the message/*
50 type. Even though in those cases, you can use the `encoding' MML tag
51 to specify encoding of non-ASCII MIME parts."
52 :type '(repeat (list (regexp :tag "MIME type")
53 (choice :tag "encoding"
57 (const quoted-printable)
61 (defvar mm-use-ultra-safe-encoding nil
62 "If non-nil, use encodings aimed at Procrustean bed survival.
64 This means that textual parts are encoded as quoted-printable if they
65 contain lines longer than 76 characters or starting with \"From \" in
66 the body. Non-7bit encodings (8bit, binary) are generally disallowed.
67 This is to reduce the probability that a broken MTA or MDA changes the
70 This variable should never be set directly, but bound before a call to
71 `mml-generate-mime' or similar functions.")
73 (defun mm-insert-rfc822-headers (charset encoding)
74 "Insert text/plain headers with CHARSET and ENCODING."
75 (insert "MIME-Version: 1.0\n")
76 (insert "Content-Type: text/plain; charset="
77 (mail-quote-string (downcase (symbol-name charset))) "\n")
78 (insert "Content-Transfer-Encoding: "
79 (downcase (symbol-name encoding)) "\n"))
81 (defun mm-insert-multipart-headers ()
82 "Insert multipart/mixed headers."
83 (let ((boundary "=-=-="))
84 (insert "MIME-Version: 1.0\n")
85 (insert "Content-Type: multipart/mixed; boundary=\"" boundary "\"\n")
88 (defun mm-default-file-encoding (file)
89 "Return a default encoding for FILE."
90 (if (not (string-match "\\.[^.]+$" file))
91 "application/octet-stream"
92 (mailcap-extension-to-mime (match-string 0 file))))
94 (defun mm-safer-encoding (encoding)
95 "Return an encoding similar to ENCODING but safer than it."
97 ((eq encoding '7bit) '7bit) ;; 7bit is considered safe.
98 ((memq encoding '(8bit quoted-printable)) 'quoted-printable)
99 ;; The remaining encodings are binary and base64 (and perhaps some
100 ;; non-standard ones), which are both turned into base64.
103 (defun mm-encode-content-transfer-encoding (encoding &optional type)
104 "Encode the current buffer with ENCODING for MIME type TYPE.
105 ENCODING can be: nil (do nothing); one of `quoted-printable', `base64';
106 `7bit', `8bit' or `binary' (all do nothing); a function to do the encoding."
108 ((eq encoding 'quoted-printable)
109 ;; This used to try to make a multibyte buffer unibyte. That's
110 ;; completely wrong, since you'd get QP-encoded emacs-mule. If
111 ;; this gets run on multibyte text it's an error that needs
112 ;; fixing, and the encoding function will signal an error.
113 ;; Likewise base64 below.
114 (quoted-printable-encode-region (point-min) (point-max) t))
115 ((eq encoding 'base64)
116 (when (equal type "text/plain")
117 (goto-char (point-min))
118 (while (search-forward "\n" nil t)
119 (replace-match "\r\n" t t)))
120 (base64-encode-region (point-min) (point-max)))
121 ((memq encoding '(7bit 8bit binary))
127 ;; Fixme: Ignoring errors here looks bogus.
128 ((functionp encoding)
129 (ignore-errors (funcall encoding (point-min) (point-max))))
131 (error "Unknown encoding %s" encoding))))
133 (defun mm-encode-buffer (type)
134 "Encode the buffer which contains data of MIME type TYPE.
135 TYPE is a string or a list of the components.
136 The encoding used is returned."
137 (let* ((mime-type (if (stringp type) type (car type)))
139 (or (and (listp type)
140 (cadr (assq 'encoding type)))
141 (mm-content-transfer-encoding mime-type)))
142 (bits (mm-body-7-or-8)))
143 ;; We force buffers that are 7bit to be unencoded, no matter
144 ;; what the preferred encoding is.
145 ;; Only if the buffers don't contain lone lines.
146 (when (and (eq bits '7bit) (not (mm-long-lines-p 76)))
147 (setq encoding bits))
148 (mm-encode-content-transfer-encoding encoding mime-type)
151 (defun mm-insert-headers (type encoding &optional file)
152 "Insert headers for TYPE."
153 (insert "Content-Type: " type)
155 (insert ";\n\tname=\"" (file-name-nondirectory file) "\""))
157 (insert (format "Content-Transfer-Encoding: %s\n" encoding))
158 (insert "Content-Disposition: inline")
160 (insert ";\n\tfilename=\"" (file-name-nondirectory file) "\""))
164 (defun mm-content-transfer-encoding (type)
165 "Return a CTE suitable for TYPE to encode the current buffer."
166 (let ((rules mm-content-transfer-encoding-defaults))
169 (when (string-match (caar rules) type)
172 (if (eq (cadr (car rules)) 'qp-or-base64)
174 (cadr (car rules)))))
175 (if mm-use-ultra-safe-encoding
176 (mm-safer-encoding encoding)
180 (defun mm-qp-or-base64 ()
181 "Return the type with which to encode the buffer.
182 This is either `base64' or `quoted-printable'."
183 (if (equal mm-use-ultra-safe-encoding '(sign . "pgp"))
184 ;; perhaps not always accurate?
187 (let ((limit (min (point-max) (+ 2000 (point-min))))
189 (goto-char (point-min))
190 (skip-chars-forward "\x20-\x7f\r\n\t" limit)
191 (while (< (point) limit)
194 (skip-chars-forward "\x20-\x7f\r\n\t" limit))
195 (if (or (< (* 6 n8bit) (- limit (point-min)))
196 ;; Don't base64, say, a short line with a single
197 ;; non-ASCII char when splitting parts by charset.
204 ;;; mm-encode.el ends here