1 ;;; mime.el --- MIME library module
3 ;; Copyright (C) 1998 Free Software Foundation, Inc.
5 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
6 ;; Keywords: MIME, multimedia, mail, news
8 ;; This file is part of FLIM (Faithful Library about Internet Message).
10 ;; This program is free software; you can redistribute it and/or
11 ;; modify it under the terms of the GNU General Public License as
12 ;; published by the Free Software Foundation; either version 2, or (at
13 ;; your option) any later version.
15 ;; This program is distributed in the hope that it will be useful, but
16 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ;; General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
30 (require 'eword-decode)
32 (autoload 'eword-encode-field "eword-encode"
33 "Encode header field STRING, and return the result.")
34 (autoload 'eword-encode-header "eword-encode"
35 "Encode header fields to network representation, such as MIME encoded-word.")
38 (autoload 'mime-parse-Content-Type "mime-parse"
39 "Parse STRING as field-body of Content-Type field.")
40 (autoload 'mime-read-Content-Type "mime-parse"
41 "Read field-body of Content-Type field from current-buffer,
42 and return parsed it.")
44 (autoload 'mime-parse-Content-Disposition "mime-parse"
45 "Parse STRING as field-body of Content-Disposition field.")
46 (autoload 'mime-read-Content-Disposition "mime-parse"
47 "Read field-body of Content-Disposition field from current-buffer,
48 and return parsed it.")
50 (autoload 'mime-parse-Content-Transfer-Encoding "mime-parse"
51 "Parse STRING as field-body of Content-Transfer-Encoding field.")
52 (autoload 'mime-read-Content-Transfer-Encoding "mime-parse"
53 "Read field-body of Content-Transfer-Encoding field from
54 current-buffer, and return it.")
56 (autoload 'mime-parse-buffer "mime-parse"
57 "Parse BUFFER as a MIME message.")
60 ;;; @ Entity Representation and Implementation
63 (defsubst mime-find-function (service type)
64 (let ((imps (cdr (assq type mime-entity-implementation-alist))))
66 (cdr (assq service imps))
67 (require (intern (format "mm%s" type)))
69 (cdr (assq type mime-entity-implementation-alist))))
72 (defsubst mime-entity-function (entity service)
73 (mime-find-function service
74 (mime-entity-representation-type-internal entity)))
76 (defsubst mime-entity-send (entity message &rest args)
77 "Send MESSAGE to ENTITY with ARGS, and return the result."
78 (apply (mime-find-function
79 message (mime-entity-representation-type-internal entity))
83 (defsubst mm-arglist-to-arguments (arglist)
86 (let ((arg (car arglist)))
87 (or (memq arg '(&optional &rest))
88 (setq dest (cons arg dest)))
90 (setq arglist (cdr arglist)))
93 (defmacro mm-define-generic (name args &optional doc)
95 `(defun ,(intern (format "mime-%s" name)) ,args
97 (mime-entity-send ,(car args) ',name
98 ,@(mm-arglist-to-arguments (cdr args)))
100 `(defun ,(intern (format "mime-%s" name)) ,args
101 (mime-entity-send ,(car args) ',name
102 ,@(mm-arglist-to-arguments (cdr args)))
105 (put 'mm-define-generic 'lisp-indent-function 'defun)
107 (defun mime-open-entity (type location)
108 "Open an entity and return it.
109 TYPE is representation-type.
110 LOCATION is location of entity. Specification of it is depended on
111 representation-type."
112 (let ((entity (make-mime-entity-internal type location)))
113 (mime-entity-send entity 'initialize-instance)
116 (mm-define-generic entity-cooked-p (entity)
117 "Return non-nil if contents of ENTITY has been already code-converted.")
120 ;;; @ Entity as node of message
123 (defun mime-entity-children (entity)
124 (or (mime-entity-children-internal entity)
125 (mime-entity-send entity 'entity-children)))
127 (defalias 'mime-entity-node-id 'mime-entity-node-id-internal)
129 (defun mime-entity-number (entity)
130 "Return entity-number of ENTITY."
131 (reverse (mime-entity-node-id-internal entity)))
133 (defun mime-find-entity-from-number (entity-number &optional message)
134 "Return entity from ENTITY-NUMBER in MESSAGE.
135 If MESSAGE is not specified, `mime-message-structure' is used."
137 (setq message mime-message-structure))
138 (let ((sn (car entity-number)))
141 (let ((rc (nth sn (mime-entity-children message))))
143 (mime-find-entity-from-number (cdr entity-number) rc)
147 (defun mime-find-entity-from-node-id (entity-node-id &optional message)
148 "Return entity from ENTITY-NODE-ID in MESSAGE.
149 If MESSAGE is not specified, `mime-message-structure' is used."
150 (mime-find-entity-from-number (reverse entity-node-id) message))
152 (defun mime-entity-parent (entity &optional message)
153 "Return mother entity of ENTITY.
154 If MESSAGE is specified, it is regarded as root entity."
155 (if (equal entity message)
157 (mime-entity-parent-internal entity)))
159 (defun mime-root-entity-p (entity &optional message)
160 "Return t if ENTITY is root-entity (message).
161 If MESSAGE is specified, it is regarded as root entity."
162 (null (mime-entity-parent entity message)))
168 (defun mime-entity-buffer (entity)
169 (or (mime-entity-buffer-internal entity)
170 (mime-entity-send entity 'entity-buffer)))
172 (mm-define-generic entity-point-min (entity)
173 "Return the start point of ENTITY in the buffer which contains ENTITY.")
175 (mm-define-generic entity-point-max (entity)
176 "Return the end point of ENTITY in the buffer which contains ENTITY.")
178 (defun mime-entity-header-start (entity)
179 (or (mime-entity-header-start-internal entity)
180 (mime-entity-send entity 'entity-header-start)))
182 (defun mime-entity-header-end (entity)
183 (or (mime-entity-header-end-internal entity)
184 (mime-entity-send entity 'entity-header-end)))
186 (defun mime-entity-body-start (entity)
187 (or (mime-entity-body-start-internal entity)
188 (mime-entity-send entity 'entity-body-start)))
190 (defun mime-entity-body-end (entity)
191 (or (mime-entity-body-end-internal entity)
192 (mime-entity-send entity 'entity-body-end)))
198 (defun mime-fetch-field (field-name &optional entity)
199 (or (symbolp field-name)
200 (setq field-name (intern (capitalize (capitalize field-name)))))
202 (setq entity mime-message-structure))
203 (let* ((header (mime-entity-original-header-internal entity))
204 (field-body (cdr (assq field-name header))))
208 (mime-entity-send entity 'fetch-field
209 (symbol-name field-name)))
210 (mime-entity-set-original-header-internal
211 entity (put-alist field-name field-body header))
215 (defalias 'mime-entity-content-type 'mime-entity-content-type-internal)
217 (defun mime-entity-content-disposition (entity)
218 (or (mime-entity-content-disposition-internal entity)
219 (let ((ret (mime-fetch-field 'Content-Disposition entity)))
221 (let ((disposition (mime-parse-Content-Disposition ret)))
223 (mime-entity-set-content-disposition-internal
227 (defun mime-entity-encoding (entity &optional default-encoding)
228 (or (mime-entity-encoding-internal entity)
230 (or (let ((ret (mime-fetch-field
231 'Content-Transfer-Encoding entity)))
232 (and ret (mime-parse-Content-Transfer-Encoding ret)))
233 default-encoding "7bit")))
234 (mime-entity-set-encoding-internal entity encoding)
237 (defun mime-read-field (field-name &optional entity)
238 (or (symbolp field-name)
239 (setq field-name (capitalize (capitalize field-name))))
241 (setq entity mime-message-structure))
242 (cond ((eq field-name 'Content-Type)
243 (mime-entity-content-type entity)
245 ((eq field-name 'Content-Disposition)
246 (mime-entity-content-disposition entity)
248 ((eq field-name 'Content-Transfer-Encoding)
249 (mime-entity-encoding entity)
252 (let* ((header (mime-entity-parsed-header-internal entity))
253 (field (cdr (assq field-name header))))
255 (let ((field-body (mime-fetch-field field-name entity)))
257 (cond ((memq field-name '(From Resent-From
261 Reply-To Resent-Reply-To))
262 (setq field (std11-parse-addresses
263 (eword-lexical-analyze field-body)))
265 ((memq field-name '(Sender Resent-Sender))
266 (setq field (std11-parse-address
267 (eword-lexical-analyze field-body)))
269 ((memq field-name eword-decode-ignored-field-list)
270 (setq field field-body))
271 ((memq field-name eword-decode-structured-field-list)
272 (setq field (eword-decode-structured-field-body
275 (setq field (eword-decode-unstructured-field-body
278 (mime-entity-set-parsed-header-internal
279 entity (put-alist field-name field header))
282 (mm-define-generic insert-decoded-header (entity &optional invisible-fields
284 "Insert before point a decoded header of ENTITY.")
287 ;;; @ Entity Attributes
290 (defun mime-entity-uu-filename (entity)
291 (if (member (mime-entity-encoding entity) mime-uuencode-encoding-name-list)
293 (set-buffer (mime-entity-buffer entity))
294 (goto-char (mime-entity-body-start entity))
295 (if (re-search-forward "^begin [0-9]+ "
296 (mime-entity-body-end entity) t)
297 (if (looking-at ".+$")
298 (buffer-substring (match-beginning 0)(match-end 0))
301 (defun mime-entity-filename (entity)
302 "Return filename of ENTITY."
303 (or (mime-entity-uu-filename entity)
304 (mime-content-disposition-filename
305 (mime-entity-content-disposition entity))
306 (cdr (let ((param (mime-content-type-parameters
307 (mime-entity-content-type entity))))
308 (or (assoc "name" param)
309 (assoc "x-name" param))
313 (defsubst mime-entity-media-type (entity)
314 (mime-content-type-primary-type (mime-entity-content-type entity)))
315 (defsubst mime-entity-media-subtype (entity)
316 (mime-content-type-subtype (mime-entity-content-type entity)))
317 (defsubst mime-entity-parameters (entity)
318 (mime-content-type-parameters (mime-entity-content-type entity)))
319 (defsubst mime-entity-type/subtype (entity-info)
320 (mime-type/subtype-string (mime-entity-media-type entity-info)
321 (mime-entity-media-subtype entity-info)))
327 (mm-define-generic entity-content (entity)
328 "Return content of ENTITY as byte sequence (string).")
330 (mm-define-generic write-entity-content (entity filename)
331 "Write content of ENTITY into FILENAME.")
333 (mm-define-generic write-entity (entity filename)
334 "Write header and body of ENTITY into FILENAME.")
336 (mm-define-generic write-entity-body (entity filename)
337 "Write body of ENTITY into FILENAME.")
345 ;;; mime.el ends here