;;; mime.el --- MIME library module
-;; Copyright (C) 1998 Free Software Foundation, Inc.
+;; Copyright (C) 1998,1999 Free Software Foundation, Inc.
;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
;; Keywords: MIME, multimedia, mail, news
"Read field-body of Content-Type field from current-buffer,
and return parsed it.")
+(autoload 'mime-parse-Content-Disposition "mime-parse"
+ "Parse STRING as field-body of Content-Disposition field.")
+(autoload 'mime-read-Content-Disposition "mime-parse"
+ "Read field-body of Content-Disposition field from current-buffer,
+and return parsed it.")
+
(autoload 'mime-parse-Content-Transfer-Encoding "mime-parse"
"Parse STRING as field-body of Content-Transfer-Encoding field.")
(autoload 'mime-read-Content-Transfer-Encoding "mime-parse"
"Read field-body of Content-Transfer-Encoding field from
current-buffer, and return it.")
-(autoload 'mime-parse-message "mime-parse"
- "Parse current-buffer as a MIME message.")
+(autoload 'mime-parse-msg-id "mime-parse"
+ "Parse TOKENS as msg-id of Content-Id or Message-Id field.")
+
+(autoload 'mime-uri-parse-cid "mime-parse"
+ "Parse STRING as cid URI.")
(autoload 'mime-parse-buffer "mime-parse"
"Parse BUFFER as a MIME message.")
-;;; @ Content-Disposition
+;;; @ Entity Representation and Implementation
;;;
-(autoload 'mime-parse-Content-Disposition "mime-parse"
- "Parse STRING as field-body of Content-Disposition field.")
+(defsubst mime-find-function (service type)
+ (let ((imps (cdr (assq type mime-entity-implementation-alist))))
+ (if imps
+ (cdr (assq service imps))
+ (require (intern (format "mm%s" type)))
+ (cdr (assq service
+ (cdr (assq type mime-entity-implementation-alist))))
+ )))
-(autoload 'mime-read-Content-Disposition "mime-parse"
- "Read field-body of Content-Disposition field from current-buffer,
-and return parsed it.")
+(defsubst mime-entity-function (entity service)
+ (mime-find-function service
+ (mime-entity-representation-type-internal entity)))
+
+(defsubst mime-entity-send (entity message &rest args)
+ "Send MESSAGE to ENTITY with ARGS, and return the result."
+ (apply (mime-find-function
+ message (mime-entity-representation-type-internal entity))
+ entity
+ args))
+
+(defmacro mm-define-generic (name args &optional doc)
+ (if doc
+ `(defun ,(intern (format "mime-%s" name)) ,args
+ ,doc
+ (mime-entity-send ,(car args) ',name
+ ,@(mm-arglist-to-arguments (cdr args)))
+ )
+ `(defun ,(intern (format "mime-%s" name)) ,args
+ (mime-entity-send ,(car args) ',name
+ ,@(mm-arglist-to-arguments (cdr args)))
+ )))
+
+(put 'mm-define-generic 'lisp-indent-function 'defun)
+
+(defun mime-open-entity (type location)
+ "Open an entity and return it.
+TYPE is representation-type.
+LOCATION is location of entity. Specification of it is depended on
+representation-type."
+ (let ((entity (make-mime-entity-internal type location)))
+ (mime-entity-send entity 'initialize-instance)
+ entity))
+
+(mm-define-generic entity-cooked-p (entity)
+ "Return non-nil if contents of ENTITY has been already code-converted.")
+
+
+;;; @ Entity as node of message
+;;;
+
+(defun mime-entity-children (entity)
+ (or (mime-entity-children-internal entity)
+ (mime-entity-send entity 'entity-children)))
+
+(defalias 'mime-entity-node-id 'mime-entity-node-id-internal)
+
+(defun mime-entity-number (entity)
+ "Return entity-number of ENTITY."
+ (reverse (mime-entity-node-id-internal entity)))
+
+(defun mime-find-entity-from-number (entity-number &optional message)
+ "Return entity from ENTITY-NUMBER in MESSAGE.
+If MESSAGE is not specified, `mime-message-structure' is used."
+ (or message
+ (setq message mime-message-structure))
+ (let ((sn (car entity-number)))
+ (if (null sn)
+ message
+ (let ((rc (nth sn (mime-entity-children message))))
+ (if rc
+ (mime-find-entity-from-number (cdr entity-number) rc)
+ ))
+ )))
+
+(defun mime-find-entity-from-node-id (entity-node-id &optional message)
+ "Return entity from ENTITY-NODE-ID in MESSAGE.
+If MESSAGE is not specified, `mime-message-structure' is used."
+ (mime-find-entity-from-number (reverse entity-node-id) message))
+
+(defun mime-find-entity-from-content-id (cid &optional message)
+ "Return entity from CID in MESSAGE.
+If MESSAGE is not specified, `mime-message-structure' is used."
+ (or message
+ (setq message mime-message-structure))
+ (if (equal cid (mime-read-field 'Content-Id message))
+ message
+ (let ((children (mime-entity-children message))
+ ret)
+ (while (and children
+ (null (setq ret (mime-find-entity-from-content-id
+ cid (car children)))))
+ (setq children (cdr children)))
+ ret)))
+
+(defun mime-entity-parent (entity &optional message)
+ "Return mother entity of ENTITY.
+If MESSAGE is specified, it is regarded as root entity."
+ (if (equal entity message)
+ nil
+ (mime-entity-parent-internal entity)))
+
+(defun mime-root-entity-p (entity &optional message)
+ "Return t if ENTITY is root-entity (message).
+If MESSAGE is specified, it is regarded as root entity."
+ (null (mime-entity-parent entity message)))
+
+
+;;; @ Entity Buffer
+;;;
+
+(defun mime-entity-buffer (entity)
+ (or (mime-entity-buffer-internal entity)
+ (mime-entity-send entity 'entity-buffer)))
+
+(mm-define-generic entity-point-min (entity)
+ "Return the start point of ENTITY in the buffer which contains ENTITY.")
+
+(mm-define-generic entity-point-max (entity)
+ "Return the end point of ENTITY in the buffer which contains ENTITY.")
-(defsubst mime-content-disposition-parameter (content-disposition parameter)
- "Return PARAMETER value of CONTENT-DISPOSITION."
- (cdr (assoc parameter (cdr content-disposition))))
+(defun mime-entity-header-start (entity)
+ (or (mime-entity-header-start-internal entity)
+ (mime-entity-send entity 'entity-header-start)))
-(defsubst mime-content-disposition-filename (content-disposition)
- "Return filename of CONTENT-DISPOSITION."
- (mime-content-disposition-parameter content-disposition "filename"))
+(defun mime-entity-header-end (entity)
+ (or (mime-entity-header-end-internal entity)
+ (mime-entity-send entity 'entity-header-end)))
+(defun mime-entity-body-start (entity)
+ (or (mime-entity-body-start-internal entity)
+ (mime-entity-send entity 'entity-body-start)))
-;;; @ MIME entity
+(defun mime-entity-body-end (entity)
+ (or (mime-entity-body-end-internal entity)
+ (mime-entity-send entity 'entity-body-end)))
+
+
+;;; @ Entity Header
;;;
-(defun mime-entity-fetch-field (entity field-name)
+(defun mime-fetch-field (field-name &optional entity)
(or (symbolp field-name)
(setq field-name (intern (capitalize (capitalize field-name)))))
- (let* ((header (mime-entity-original-header entity))
- (field-body (cdr (assq field-name header))))
- (or field-body
- (progn
- (if (save-excursion
- (set-buffer (mime-entity-buffer entity))
- (save-restriction
- (narrow-to-region (mime-entity-header-start entity)
- (mime-entity-header-end entity))
- (setq field-body
- (std11-fetch-field (symbol-name field-name)))
- ))
- (mime-entity-set-original-header
- entity (put-alist field-name field-body header))
- )
- field-body))))
-
-(defun mime-entity-read-field (entity field-name)
+ (or entity
+ (setq entity mime-message-structure))
+ (cond ((eq field-name 'Date)
+ (or (mime-entity-date-internal entity)
+ (mime-entity-set-date-internal
+ entity (mime-entity-send entity 'fetch-field "Date"))
+ ))
+ ((eq field-name 'Message-Id)
+ (or (mime-entity-message-id-internal entity)
+ (mime-entity-set-message-id-internal
+ entity (mime-entity-send entity 'fetch-field "Message-Id"))
+ ))
+ ((eq field-name 'References)
+ (or (mime-entity-references-internal entity)
+ (mime-entity-set-references-internal
+ entity (mime-entity-send entity 'fetch-field "References"))
+ ))
+ (t
+ (let* ((header (mime-entity-original-header-internal entity))
+ (field-body (cdr (assq field-name header))))
+ (or field-body
+ (progn
+ (if (setq field-body
+ (mime-entity-send entity 'fetch-field
+ (symbol-name field-name)))
+ (mime-entity-set-original-header-internal
+ entity (put-alist field-name field-body header))
+ )
+ field-body))
+ ))))
+
+(defun mime-entity-content-type (entity)
+ (or (mime-entity-content-type-internal entity)
+ (let ((ret (mime-fetch-field 'Content-Type entity)))
+ (if ret
+ (mime-entity-set-content-type-internal
+ entity (mime-parse-Content-Type ret))
+ ))))
+
+(defun mime-entity-content-disposition (entity)
+ (or (mime-entity-content-disposition-internal entity)
+ (let ((ret (mime-fetch-field 'Content-Disposition entity)))
+ (if ret
+ (mime-entity-set-content-disposition-internal
+ entity (mime-parse-Content-Disposition ret))
+ ))))
+
+(defun mime-entity-encoding (entity &optional default-encoding)
+ (or (mime-entity-encoding-internal entity)
+ (let ((ret (mime-fetch-field 'Content-Transfer-Encoding entity)))
+ (mime-entity-set-encoding-internal
+ entity
+ (or (and ret (mime-parse-Content-Transfer-Encoding ret))
+ default-encoding "7bit"))
+ )))
+
+(defvar mime-field-parser-alist
+ '((Return-Path . std11-parse-route-addr)
+
+ (Reply-To . std11-parse-addresses)
+
+ (Sender . std11-parse-mailbox)
+ (From . std11-parse-addresses)
+
+ (Resent-Reply-To . std11-parse-addresses)
+
+ (Resent-Sender . std11-parse-mailbox)
+ (Resent-From . std11-parse-addresses)
+
+ (To . std11-parse-addresses)
+ (Resent-To . std11-parse-addresses)
+ (Cc . std11-parse-addresses)
+ (Resent-Cc . std11-parse-addresses)
+ (Bcc . std11-parse-addresses)
+ (Resent-Bcc . std11-parse-addresses)
+
+ (Message-Id . mime-parse-msg-id)
+ (Recent-Message-Id . mime-parse-msg-id)
+
+ (In-Reply-To . std11-parse-msg-ids)
+ (References . std11-parse-msg-ids)
+
+ (Content-Id . mime-parse-msg-id)
+ ))
+
+(defun mime-read-field (field-name &optional entity)
(or (symbolp field-name)
(setq field-name (capitalize (capitalize field-name))))
+ (or entity
+ (setq entity mime-message-structure))
(cond ((eq field-name 'Content-Type)
(mime-entity-content-type entity)
)
(mime-entity-encoding entity)
)
(t
- (let* ((header (mime-entity-parsed-header entity))
+ (let* ((header (mime-entity-parsed-header-internal entity))
(field (cdr (assq field-name header))))
(or field
- (let ((field-body (mime-entity-fetch-field entity field-name)))
+ (let ((field-body (mime-fetch-field field-name entity))
+ parser)
(when field-body
- (cond ((memq field-name '(From Resent-From
- To Resent-To
- Cc Resent-Cc
- Bcc Resent-Bcc
- Reply-To Resent-Reply-To))
- (setq field (std11-parse-addresses
- (eword-lexical-analyze field-body)))
- )
- ((eq field-name '(Sender Resent-Sender))
- (setq field (std11-parse-address
- (eword-lexical-analyze field-body)))
- )
- ((memq field-name eword-decode-ignored-field-list)
- (setq field field-body))
- ((memq field-name eword-decode-structured-field-list)
- (setq field (eword-decode-structured-field-body
- field-body)))
- (t
- (setq field (eword-decode-unstructured-field-body
- field-body))
- ))
- (mime-entity-set-parsed-header
+ (setq parser
+ (cdr (assq field-name mime-field-parser-alist)))
+ (setq field
+ (if parser
+ (funcall parser
+ (eword-lexical-analyze field-body))
+ (mime-decode-field-body
+ field-body field-name 'native)
+ ))
+ (mime-entity-set-parsed-header-internal
entity (put-alist field-name field header))
field)))))))
-(defun mime-entity-content (entity)
- (save-excursion
- (set-buffer (mime-entity-buffer entity))
- (mime-decode-string (buffer-substring (mime-entity-body-start entity)
- (mime-entity-body-end entity))
- (mime-entity-encoding entity))))
+(mm-define-generic insert-header (entity &optional invisible-fields
+ visible-fields)
+ "Insert before point a decoded header of ENTITY.")
+
+(define-obsolete-function-alias
+ 'mime-insert-decoded-header 'mime-insert-header)
+
+
+;;; @ Entity Attributes
+;;;
+
+(defun mime-entity-uu-filename (entity)
+ (if (member (mime-entity-encoding entity) mime-uuencode-encoding-name-list)
+ (save-excursion
+ (set-buffer (mime-entity-buffer entity))
+ (goto-char (mime-entity-body-start entity))
+ (if (re-search-forward "^begin [0-9]+ "
+ (mime-entity-body-end entity) t)
+ (if (looking-at ".+$")
+ (buffer-substring (match-beginning 0)(match-end 0))
+ )))))
+
+(defun mime-entity-filename (entity)
+ "Return filename of ENTITY."
+ (or (mime-entity-uu-filename entity)
+ (mime-content-disposition-filename
+ (mime-entity-content-disposition entity))
+ (cdr (let ((param (mime-content-type-parameters
+ (mime-entity-content-type entity))))
+ (or (assoc "name" param)
+ (assoc "x-name" param))
+ ))))
+
+
+(defsubst mime-entity-media-type (entity)
+ (mime-content-type-primary-type (mime-entity-content-type entity)))
+(defsubst mime-entity-media-subtype (entity)
+ (mime-content-type-subtype (mime-entity-content-type entity)))
+(defsubst mime-entity-parameters (entity)
+ (mime-content-type-parameters (mime-entity-content-type entity)))
+(defsubst mime-entity-type/subtype (entity-info)
+ (mime-type/subtype-string (mime-entity-media-type entity-info)
+ (mime-entity-media-subtype entity-info)))
+
+
+;;; @ Entity Content
+;;;
+
+(mm-define-generic entity-content (entity)
+ "Return content of ENTITY as byte sequence (string).")
+
+(mm-define-generic insert-entity-content (entity)
+ "Insert content of ENTITY at point.")
+
+(mm-define-generic write-entity-content (entity filename)
+ "Write content of ENTITY into FILENAME.")
+
+(mm-define-generic insert-text-content (entity)
+ "Insert decoded text body of ENTITY.")
+
+(mm-define-generic insert-entity (entity)
+ "Insert header and body of ENTITY at point.")
+
+(mm-define-generic write-entity (entity filename)
+ "Write header and body of ENTITY into FILENAME.")
-(defsubst mime-root-entity-p (entity)
- "Return t if ENTITY is root-entity (message)."
- (null (mime-entity-node-id entity)))
+(mm-define-generic write-entity-body (entity filename)
+ "Write body of ENTITY into FILENAME.")
;;; @ end