1 ;;; mime.el --- MIME library module
3 ;; Copyright (C) 1998,1999,2000 Free Software Foundation, Inc.
5 ;; Author: MORIOKA Tomohiko <tomo@m17n.org>
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 (eval-when-compile (require 'mmgeneric))
36 (autoload 'eword-encode-header "eword-encode"
37 "Encode header fields to network representation, such as MIME encoded-word.")
39 (autoload 'mime-parse-Content-Type "mime-parse"
40 "Parse STRING as field-body of Content-Type field.")
41 (autoload 'mime-read-Content-Type "mime-parse"
42 "Read field-body of Content-Type field from current-buffer,
43 and return parsed it.")
45 (autoload 'mime-parse-Content-Disposition "mime-parse"
46 "Parse STRING as field-body of Content-Disposition field.")
47 (autoload 'mime-read-Content-Disposition "mime-parse"
48 "Read field-body of Content-Disposition field from current-buffer,
49 and return parsed it.")
51 (autoload 'mime-parse-Content-Transfer-Encoding "mime-parse"
52 "Parse STRING as field-body of Content-Transfer-Encoding field.")
53 (autoload 'mime-read-Content-Transfer-Encoding "mime-parse"
54 "Read field-body of Content-Transfer-Encoding field from
55 current-buffer, and return it.")
57 (autoload 'mime-parse-msg-id "mime-parse"
58 "Parse TOKENS as msg-id of Content-Id or Message-Id field.")
60 (autoload 'mime-uri-parse-cid "mime-parse"
61 "Parse STRING as cid URI.")
63 (autoload 'mime-parse-buffer "mime-parse"
64 "Parse BUFFER as a MIME message.")
68 ;;; @ Entity Representation and Implementation
71 (defmacro mime-entity-send (entity message &rest args)
72 `(luna-send ,entity ',(intern (format "mime-%s" (eval message))) ,@args))
74 (defun mime-open-entity (type location)
75 "Open an entity and return it.
76 TYPE is representation-type.
77 LOCATION is location of entity. Specification of it is depended on
79 (require (intern (format "mm%s" type)))
80 (luna-make-entity (mm-expand-class-name type) :location location))
82 (luna-define-generic mime-entity-cooked-p (entity)
83 "Return non-nil if contents of ENTITY has been already code-converted.")
86 ;;; @ Entity as node of message
89 (defun mime-entity-children (entity)
90 (or (mime-entity-children-internal entity)
91 (luna-send entity 'mime-entity-children entity)))
93 (defun mime-entity-node-id (entity)
94 (mime-entity-node-id-internal entity))
96 (defun mime-entity-number (entity)
97 "Return entity-number of ENTITY."
98 (reverse (mime-entity-node-id-internal entity)))
100 (defun mime-find-entity-from-number (entity-number message)
101 "Return entity from ENTITY-NUMBER in MESSAGE."
102 (let ((sn (car entity-number)))
105 (let ((rc (nth sn (mime-entity-children message))))
107 (mime-find-entity-from-number (cdr entity-number) rc)
111 (defun mime-find-entity-from-node-id (entity-node-id message)
112 "Return entity from ENTITY-NODE-ID in MESSAGE."
113 (mime-find-entity-from-number (reverse entity-node-id) message))
115 (defun mime-find-entity-from-content-id (cid message)
116 "Return entity from CID in MESSAGE."
117 (if (equal cid (mime-entity-read-field message "Content-Id"))
119 (let ((children (mime-entity-children message))
122 (null (setq ret (mime-find-entity-from-content-id
123 cid (car children)))))
124 (setq children (cdr children)))
127 (defun mime-entity-parent (entity &optional message)
128 "Return mother entity of ENTITY.
129 If MESSAGE is specified, it is regarded as root entity."
130 (if (equal entity message)
132 (mime-entity-parent-internal entity)))
134 (defun mime-root-entity-p (entity &optional message)
135 "Return t if ENTITY is root-entity (message).
136 If MESSAGE is specified, it is regarded as root entity."
137 (null (mime-entity-parent entity message)))
139 (defun mime-find-root-entity (entity)
140 "Return root entity of ENTITY."
141 (let ((p (mime-entity-parent entity)))
144 (mime-entity-parent p))))
147 ;;; @ Header buffer (obsolete)
150 ;; (luna-define-generic mime-entity-header-buffer (entity))
152 ;; (luna-define-generic mime-goto-header-start-point (entity)
153 ;; "Set buffer and point to header-start-position of ENTITY.")
155 ;; (luna-define-generic mime-entity-header-start-point (entity)
156 ;; "Return header-start-position of ENTITY.")
158 ;; (luna-define-generic mime-entity-header-end-point (entity)
159 ;; "Return header-end-position of ENTITY.")
161 ;; (make-obsolete 'mime-entity-header-buffer "don't use it.")
162 ;; (make-obsolete 'mime-goto-header-start-point "don't use it.")
163 ;; (make-obsolete 'mime-entity-header-start-point "don't use it.")
164 ;; (make-obsolete 'mime-entity-header-end-point "don't use it.")
167 ;;; @ Body buffer (obsolete)
170 ;; (luna-define-generic mime-entity-body-buffer (entity))
172 ;; (luna-define-generic mime-goto-body-start-point (entity)
173 ;; "Set buffer and point to body-start-position of ENTITY.")
175 ;; (luna-define-generic mime-goto-body-end-point (entity)
176 ;; "Set buffer and point to body-end-position of ENTITY.")
178 ;; (luna-define-generic mime-entity-body-start-point (entity)
179 ;; "Return body-start-position of ENTITY.")
181 ;; (luna-define-generic mime-entity-body-end-point (entity)
182 ;; "Return body-end-position of ENTITY.")
184 ;; (defalias 'mime-entity-body-start 'mime-entity-body-start-point)
185 ;; (defalias 'mime-entity-body-end 'mime-entity-body-end-point)
187 ;; (make-obsolete 'mime-entity-body-buffer "don't use it.")
188 ;; (make-obsolete 'mime-goto-body-start-point "don't use it.")
189 ;; (make-obsolete 'mime-goto-body-end-point "don't use it.")
190 ;; (make-obsolete 'mime-entity-body-start-point "don't use it.")
191 ;; (make-obsolete 'mime-entity-body-end-point "don't use it.")
192 ;; (make-obsolete 'mime-entity-body-start "don't use it.")
193 ;; (make-obsolete 'mime-entity-body-end "don't use it.")
196 ;;; @ Entity buffer (obsolete)
199 ;; (luna-define-generic mime-entity-buffer (entity))
200 ;; (make-obsolete 'mime-entity-buffer "don't use it.")
202 ;; (luna-define-generic mime-entity-point-min (entity))
203 ;; (make-obsolete 'mime-entity-point-min "don't use it.")
205 ;; (luna-define-generic mime-entity-point-max (entity))
206 ;; (make-obsolete 'mime-entity-point-max "don't use it.")
212 (luna-define-generic mime-insert-entity (entity)
213 "Insert header and body of ENTITY at point.")
215 (luna-define-generic mime-write-entity (entity filename)
216 "Write header and body of ENTITY into FILENAME.")
222 (luna-define-generic mime-entity-body (entity)
223 "Return network representation of ENTITY body.")
225 (luna-define-generic mime-insert-entity-body (entity)
226 "Insert network representation of ENTITY body at point.")
228 (luna-define-generic mime-write-entity-body (entity filename)
229 "Write body of ENTITY into FILENAME.")
235 (luna-define-generic mime-entity-content (entity)
236 "Return content of ENTITY as byte sequence (string).")
238 (luna-define-generic mime-insert-entity-content (entity)
239 "Insert content of ENTITY at point.")
241 (luna-define-generic mime-write-entity-content (entity filename)
242 "Write content of ENTITY into FILENAME.")
244 (luna-define-generic mime-insert-text-content (entity)
245 "Insert decoded text body of ENTITY.")
251 (luna-define-generic mime-entity-fetch-field (entity field-name)
252 "Return the value of the ENTITY's header field whose type is FIELD-NAME.")
254 ;; (defun mime-fetch-field (field-name &optional entity)
255 ;; "Return the value of the ENTITY's header field whose type is FIELD-NAME."
256 ;; (if (symbolp field-name)
257 ;; (setq field-name (symbol-name field-name))
260 ;; (setq entity mime-message-structure))
261 ;; (mime-entity-fetch-field entity field-name)
263 ;; (make-obsolete 'mime-fetch-field 'mime-entity-fetch-field)
265 (defun mime-entity-content-type (entity)
266 (or (mime-entity-content-type-internal entity)
267 (let ((ret (mime-entity-fetch-field entity "Content-Type")))
269 (mime-entity-set-content-type-internal
270 entity (mime-parse-Content-Type ret))
273 (defun mime-entity-content-disposition (entity)
274 (or (mime-entity-content-disposition-internal entity)
275 (let ((ret (mime-entity-fetch-field entity "Content-Disposition")))
277 (mime-entity-set-content-disposition-internal
278 entity (mime-parse-Content-Disposition ret))
281 (defun mime-entity-encoding (entity &optional default-encoding)
282 (or (mime-entity-encoding-internal entity)
283 (let ((ret (mime-entity-fetch-field entity "Content-Transfer-Encoding")))
284 (mime-entity-set-encoding-internal
286 (or (and ret (mime-parse-Content-Transfer-Encoding ret))
287 default-encoding "7bit"))
290 (defvar mime-field-parser-alist
291 '((Return-Path . std11-parse-route-addr)
293 (Reply-To . std11-parse-addresses)
295 (Sender . std11-parse-mailbox)
296 (From . std11-parse-addresses)
298 (Resent-Reply-To . std11-parse-addresses)
300 (Resent-Sender . std11-parse-mailbox)
301 (Resent-From . std11-parse-addresses)
303 (To . std11-parse-addresses)
304 (Resent-To . std11-parse-addresses)
305 (Cc . std11-parse-addresses)
306 (Resent-Cc . std11-parse-addresses)
307 (Bcc . std11-parse-addresses)
308 (Resent-Bcc . std11-parse-addresses)
310 (Message-Id . mime-parse-msg-id)
311 (Recent-Message-Id . mime-parse-msg-id)
313 (In-Reply-To . std11-parse-msg-ids)
314 (References . std11-parse-msg-ids)
316 (Content-Id . mime-parse-msg-id)
319 (defun mime-entity-read-field (entity field-name)
320 (let ((sym (if (symbolp field-name)
323 (setq field-name (symbol-name field-name)))
324 (intern (capitalize (capitalize field-name))))))
325 (cond ((eq sym 'Content-Type)
326 (mime-entity-content-type entity)
328 ((eq sym 'Content-Disposition)
329 (mime-entity-content-disposition entity)
331 ((eq sym 'Content-Transfer-Encoding)
332 (mime-entity-encoding entity)
335 (let* ((header (mime-entity-parsed-header-internal entity))
336 (field (cdr (assq sym header))))
338 (let ((field-body (mime-entity-fetch-field entity field-name))
342 (cdr (assq sym mime-field-parser-alist)))
346 (eword-lexical-analyze field-body))
347 (mime-decode-field-body field-body sym 'plain)
349 (mime-entity-set-parsed-header-internal
350 entity (put-alist sym field header))
353 ;; (defun mime-read-field (field-name &optional entity)
355 ;; (setq entity mime-message-structure))
356 ;; (mime-entity-read-field entity field-name)
358 ;; (make-obsolete 'mime-read-field 'mime-entity-read-field)
360 (luna-define-generic mime-insert-header (entity &optional invisible-fields
362 "Insert before point a decoded header of ENTITY.")
365 ;;; @ Entity Attributes
368 (luna-define-generic mime-entity-name (entity)
369 "Return name of the ENTITY.")
371 (defun mime-entity-uu-filename (entity)
372 (if (member (mime-entity-encoding entity) mime-uuencode-encoding-name-list)
374 (mime-insert-entity-body entity)
375 (if (re-search-forward "^begin [0-9]+ " nil t)
376 (if (looking-at ".+$")
377 (buffer-substring (match-beginning 0)(match-end 0))
380 (defun mime-entity-filename (entity)
381 "Return filename of ENTITY."
382 (or (mime-entity-uu-filename entity)
383 (mime-content-disposition-filename
384 (mime-entity-content-disposition entity))
385 (cdr (let ((param (mime-content-type-parameters
386 (mime-entity-content-type entity))))
387 (or (assoc "name" param)
388 (assoc "x-name" param))
392 (defsubst mime-entity-media-type (entity)
393 (mime-content-type-primary-type (mime-entity-content-type entity)))
394 (defsubst mime-entity-media-subtype (entity)
395 (mime-content-type-subtype (mime-entity-content-type entity)))
396 (defsubst mime-entity-parameters (entity)
397 (mime-content-type-parameters (mime-entity-content-type entity)))
398 (defsubst mime-entity-type/subtype (entity-info)
399 (mime-type/subtype-string (mime-entity-media-type entity-info)
400 (mime-entity-media-subtype entity-info)))
402 (defun mime-entity-set-content-type (entity content-type)
403 (mime-entity-set-content-type-internal entity content-type))
405 (defun mime-entity-set-encoding (entity encoding)
406 (mime-entity-set-encoding-internal entity encoding))
414 ;;; mime.el ends here