mime.el

   1 ;;; mime.el --- MIME library module
   2
   3 ;; Copyright (C) 1998 Free Software Foundation, Inc.
   4
   5 ;; Author: MORIOKA Tomohiko <morioka@jaist.ac.jp>
   6 ;; Keywords: MIME, multimedia, mail, news
   7
   8 ;; This file is part of FLIM (Faithful Library about Internet Message).
   9
  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.
  14
  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.
  19
  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.
  24
  25 ;;; Code:
  26
  27 (require 'alist)
  28 (require 'std11)
  29 (require 'mime-def)
  30 (require 'eword-decode)
  31
  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.")
  36
  37
  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.")
  43
  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.")
  49
  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.")
  55
  56 (autoload 'mime-parse-buffer "mime-parse"
  57   "Parse BUFFER as a MIME message.")
  58
  59
  60 ;;; @ Entity Representation and Implementation
  61 ;;;
  62
  63 (defsubst mime-find-function (service type)
  64   (let ((imps (cdr (assq type mime-entity-implementation-alist))))
  65     (if imps
  66         (cdr (assq service imps))
  67       (require (intern (format "mm%s" type)))
  68       (cdr (assq service
  69                  (cdr (assq type mime-entity-implementation-alist))))
  70       )))
  71
  72 (defsubst mime-entity-function (entity service)
  73   (mime-find-function service
  74                       (mime-entity-representation-type-internal entity)))
  75
  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))
  80          entity
  81          args))
  82
  83 (defmacro mm-define-generic (name args &optional doc)
  84   (if doc
  85       `(defun ,(intern (format "mime-%s" name)) ,args
  86          ,doc
  87          (mime-entity-send ,(car args) ',name
  88                            ,@(mm-arglist-to-arguments (cdr args)))
  89          )
  90     `(defun ,(intern (format "mime-%s" name)) ,args
  91        (mime-entity-send ,(car args) ',name
  92                          ,@(mm-arglist-to-arguments (cdr args)))
  93        )))
  94
  95 (put 'mm-define-generic 'lisp-indent-function 'defun)
  96
  97 (defun mime-open-entity (type location)
  98   "Open an entity and return it.
  99 TYPE is representation-type.
 100 LOCATION is location of entity.  Specification of it is depended on
 101 representation-type."
 102   (let ((entity (make-mime-entity-internal type location)))
 103     (mime-entity-send entity 'initialize-instance)
 104     entity))
 105
 106 (mm-define-generic entity-cooked-p (entity)
 107   "Return non-nil if contents of ENTITY has been already code-converted.")
 108
 109
 110 ;;; @ Entity as node of message
 111 ;;;
 112
 113 (defun mime-entity-children (entity)
 114   (or (mime-entity-children-internal entity)
 115       (mime-entity-send entity 'entity-children)))
 116
 117 (defalias 'mime-entity-node-id 'mime-entity-node-id-internal)
 118
 119 (defun mime-entity-number (entity)
 120   "Return entity-number of ENTITY."
 121   (reverse (mime-entity-node-id-internal entity)))
 122
 123 (defun mime-find-entity-from-number (entity-number &optional message)
 124   "Return entity from ENTITY-NUMBER in MESSAGE.
 125 If MESSAGE is not specified, `mime-message-structure' is used."
 126   (or message
 127       (setq message mime-message-structure))
 128   (let ((sn (car entity-number)))
 129     (if (null sn)
 130         message
 131       (let ((rc (nth sn (mime-entity-children message))))
 132         (if rc
 133             (mime-find-entity-from-number (cdr entity-number) rc)
 134           ))
 135       )))
 136
 137 (defun mime-find-entity-from-node-id (entity-node-id &optional message)
 138   "Return entity from ENTITY-NODE-ID in MESSAGE.
 139 If MESSAGE is not specified, `mime-message-structure' is used."
 140   (mime-find-entity-from-number (reverse entity-node-id) message))
 141
 142 (defun mime-entity-parent (entity &optional message)
 143   "Return mother entity of ENTITY.
 144 If MESSAGE is specified, it is regarded as root entity."
 145   (if (equal entity message)
 146       nil
 147     (mime-entity-parent-internal entity)))
 148
 149 (defun mime-root-entity-p (entity &optional message)
 150   "Return t if ENTITY is root-entity (message).
 151 If MESSAGE is specified, it is regarded as root entity."
 152   (null (mime-entity-parent entity message)))
 153
 154
 155 ;;; @ Entity Buffer
 156 ;;;
 157
 158 (defun mime-entity-buffer (entity)
 159   (or (mime-entity-buffer-internal entity)
 160       (mime-entity-send entity 'entity-buffer)))
 161
 162 (mm-define-generic entity-point-min (entity)
 163   "Return the start point of ENTITY in the buffer which contains ENTITY.")
 164
 165 (mm-define-generic entity-point-max (entity)
 166   "Return the end point of ENTITY in the buffer which contains ENTITY.")
 167
 168 (defun mime-entity-header-start (entity)
 169   (or (mime-entity-header-start-internal entity)
 170       (mime-entity-send entity 'entity-header-start)))
 171
 172 (defun mime-entity-header-end (entity)
 173   (or (mime-entity-header-end-internal entity)
 174       (mime-entity-send entity 'entity-header-end)))
 175
 176 (defun mime-entity-body-start (entity)
 177   (or (mime-entity-body-start-internal entity)
 178       (mime-entity-send entity 'entity-body-start)))
 179
 180 (defun mime-entity-body-end (entity)
 181   (or (mime-entity-body-end-internal entity)
 182       (mime-entity-send entity 'entity-body-end)))
 183
 184
 185 ;;; @ Entity Header
 186 ;;;
 187
 188 (defun mime-fetch-field (field-name &optional entity)
 189   (or (symbolp field-name)
 190       (setq field-name (intern (capitalize (capitalize field-name)))))
 191   (or entity
 192       (setq entity mime-message-structure))
 193   (cond ((eq field-name 'Date)
 194          (or (mime-entity-date-internal entity)
 195              (mime-entity-set-date-internal
 196               entity (mime-entity-send entity 'fetch-field "Date"))
 197              ))
 198         ((eq field-name 'Message-Id)
 199          (or (mime-entity-message-id-internal entity)
 200              (mime-entity-set-message-id-internal
 201               entity (mime-entity-send entity 'fetch-field "Message-Id"))
 202              ))
 203         ((eq field-name 'References)
 204          (or (mime-entity-references-internal entity)
 205              (mime-entity-set-references-internal
 206               entity (mime-entity-send entity 'fetch-field "References"))
 207              ))
 208         (t
 209          (let* ((header (mime-entity-original-header-internal entity))
 210                 (field-body (cdr (assq field-name header))))
 211            (or field-body
 212                (progn
 213                  (if (setq field-body
 214                            (mime-entity-send entity 'fetch-field
 215                                              (symbol-name field-name)))
 216                      (mime-entity-set-original-header-internal
 217                       entity (put-alist field-name field-body header))
 218                    )
 219                  field-body))
 220            ))))
 221
 222 (defun mime-entity-content-type (entity)
 223   (or (mime-entity-content-type-internal entity)
 224       (let ((ret (mime-fetch-field 'Content-Type entity)))
 225         (if ret
 226             (mime-entity-set-content-type-internal
 227              entity (mime-parse-Content-Type ret))
 228           ))))
 229
 230 (defun mime-entity-content-disposition (entity)
 231   (or (mime-entity-content-disposition-internal entity)
 232       (let ((ret (mime-fetch-field 'Content-Disposition entity)))
 233         (if ret
 234             (mime-entity-set-content-disposition-internal
 235              entity (mime-parse-Content-Disposition ret))
 236           ))))
 237
 238 (defun mime-entity-encoding (entity &optional default-encoding)
 239   (or (mime-entity-encoding-internal entity)
 240       (let ((ret (mime-fetch-field 'Content-Transfer-Encoding entity)))
 241         (mime-entity-set-encoding-internal
 242          entity
 243          (or (and ret (mime-parse-Content-Transfer-Encoding ret))
 244              default-encoding "7bit"))
 245         )))
 246
 247 (defun mime-read-field (field-name &optional entity)
 248   (or (symbolp field-name)
 249       (setq field-name (capitalize (capitalize field-name))))
 250   (or entity
 251       (setq entity mime-message-structure))
 252   (cond ((eq field-name 'Content-Type)
 253          (mime-entity-content-type entity)
 254          )
 255         ((eq field-name 'Content-Disposition)
 256          (mime-entity-content-disposition entity)
 257          )
 258         ((eq field-name 'Content-Transfer-Encoding)
 259          (mime-entity-encoding entity)
 260          )
 261         (t
 262          (let* ((header (mime-entity-parsed-header-internal entity))
 263                 (field (cdr (assq field-name header))))
 264            (or field
 265                (let ((field-body (mime-fetch-field field-name entity)))
 266                  (when field-body
 267                    (cond ((memq field-name '(From Resent-From
 268                                              To Resent-To
 269                                              Cc Resent-Cc
 270                                              Bcc Resent-Bcc
 271                                              Reply-To Resent-Reply-To))
 272                           (setq field (std11-parse-addresses
 273                                        (eword-lexical-analyze field-body)))
 274                           )
 275                          ((memq field-name '(Sender Resent-Sender))
 276                           (setq field (std11-parse-address
 277                                        (eword-lexical-analyze field-body)))
 278                           )
 279                          ((memq field-name eword-decode-ignored-field-list)
 280                           (setq field field-body))
 281                          ((memq field-name eword-decode-structured-field-list)
 282                           (setq field (eword-decode-structured-field-body
 283                                        field-body)))
 284                          (t
 285                           (setq field (eword-decode-unstructured-field-body
 286                                        field-body))
 287                           ))
 288                    (mime-entity-set-parsed-header-internal
 289                     entity (put-alist field-name field header))
 290                    field)))))))
 291
 292 (mm-define-generic insert-header (entity &optional invisible-fields
 293                                          visible-fields)
 294   "Insert before point a decoded header of ENTITY.")
 295
 296 (define-obsolete-function-alias
 297   'mime-insert-decoded-header 'mime-insert-header)
 298
 299
 300 ;;; @ Entity Attributes
 301 ;;;
 302
 303 (defun mime-entity-uu-filename (entity)
 304   (if (member (mime-entity-encoding entity) mime-uuencode-encoding-name-list)
 305       (save-excursion
 306         (set-buffer (mime-entity-buffer entity))
 307         (goto-char (mime-entity-body-start entity))
 308         (if (re-search-forward "^begin [0-9]+ "
 309                                (mime-entity-body-end entity) t)
 310             (if (looking-at ".+$")
 311                 (buffer-substring (match-beginning 0)(match-end 0))
 312               )))))
 313
 314 (defun mime-entity-filename (entity)
 315   "Return filename of ENTITY."
 316   (or (mime-entity-uu-filename entity)
 317       (mime-content-disposition-filename
 318        (mime-entity-content-disposition entity))
 319       (cdr (let ((param (mime-content-type-parameters
 320                          (mime-entity-content-type entity))))
 321              (or (assoc "name" param)
 322                  (assoc "x-name" param))
 323              ))))
 324
 325
 326 (defsubst mime-entity-media-type (entity)
 327   (mime-content-type-primary-type (mime-entity-content-type entity)))
 328 (defsubst mime-entity-media-subtype (entity)
 329   (mime-content-type-subtype (mime-entity-content-type entity)))
 330 (defsubst mime-entity-parameters (entity)
 331   (mime-content-type-parameters (mime-entity-content-type entity)))
 332 (defsubst mime-entity-type/subtype (entity-info)
 333   (mime-type/subtype-string (mime-entity-media-type entity-info)
 334                             (mime-entity-media-subtype entity-info)))
 335
 336
 337 ;;; @ Entity Content
 338 ;;;
 339
 340 (mm-define-generic entity-content (entity)
 341   "Return content of ENTITY as byte sequence (string).")
 342
 343 (mm-define-generic insert-text-content (entity)
 344   "Insert decoded text body of ENTITY.")
 345
 346 (mm-define-generic write-entity-content (entity filename)
 347   "Write content of ENTITY into FILENAME.")
 348
 349 (mm-define-generic write-entity (entity filename)
 350   "Write header and body of ENTITY into FILENAME.")
 351
 352 (mm-define-generic write-entity-body (entity filename)
 353   "Write body of ENTITY into FILENAME.")
 354
 355
 356 ;;; @ end
 357 ;;;
 358
 359 (provide 'mime)
 360
 361 ;;; mime.el ends here