mime.el

   1 ;;; mime.el --- MIME library module
   2
   3 ;; Copyright (C) 1998,1999,2000 Free Software Foundation, Inc.
   4
   5 ;; Author: MORIOKA Tomohiko <tomo@m17n.org>
   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 (eval-when-compile (require 'mmgeneric))
  33
  34 (eval-and-compile
  35
  36 (autoload 'eword-encode-header "eword-encode"
  37   "Encode header fields to network representation, such as MIME encoded-word.")
  38
  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.")
  44
  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.")
  50
  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.")
  56
  57 (autoload 'mime-parse-msg-id "mime-parse"
  58   "Parse TOKENS as msg-id of Content-Id or Message-Id field.")
  59
  60 (autoload 'mime-uri-parse-cid "mime-parse"
  61   "Parse STRING as cid URI.")
  62
  63 (autoload 'mime-parse-buffer "mime-parse"
  64   "Parse BUFFER as a MIME message.")
  65
  66 )
  67
  68 ;;; @ Entity Representation and Implementation
  69 ;;;
  70
  71 (defmacro mime-entity-send (entity message &rest args)
  72   `(luna-send ,entity ',(intern (format "mime-%s" (eval message))) ,@args))
  73
  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
  78 representation-type."
  79   (require (intern (format "mm%s" type)))
  80   (luna-make-entity (mm-expand-class-name type) :location location))
  81
  82 (luna-define-generic mime-entity-cooked-p (entity)
  83   "Return non-nil if contents of ENTITY has been already code-converted.")
  84
  85
  86 ;;; @ Entity as node of message
  87 ;;;
  88
  89 (defun mime-entity-children (entity)
  90   (or (mime-entity-children-internal entity)
  91       (luna-send entity 'mime-entity-children entity)))
  92
  93 (defalias 'mime-entity-node-id 'mime-entity-node-id-internal)
  94
  95 (defun mime-entity-number (entity)
  96   "Return entity-number of ENTITY."
  97   (reverse (mime-entity-node-id-internal entity)))
  98
  99 (defun mime-find-entity-from-number (entity-number message)
 100   "Return entity from ENTITY-NUMBER in MESSAGE."
 101   (let ((sn (car entity-number)))
 102     (if (null sn)
 103         message
 104       (let ((rc (nth sn (mime-entity-children message))))
 105         (if rc
 106             (mime-find-entity-from-number (cdr entity-number) rc)
 107           ))
 108       )))
 109
 110 (defun mime-find-entity-from-node-id (entity-node-id message)
 111   "Return entity from ENTITY-NODE-ID in MESSAGE."
 112   (mime-find-entity-from-number (reverse entity-node-id) message))
 113
 114 (defun mime-find-entity-from-content-id (cid message)
 115   "Return entity from CID in MESSAGE."
 116   (if (equal cid (mime-entity-read-field message "Content-Id"))
 117       message
 118     (let ((children (mime-entity-children message))
 119           ret)
 120       (while (and children
 121                   (null (setq ret (mime-find-entity-from-content-id
 122                                    cid (car children)))))
 123         (setq children (cdr children)))
 124       ret)))
 125
 126 (defun mime-entity-parent (entity &optional message)
 127   "Return mother entity of ENTITY.
 128 If MESSAGE is specified, it is regarded as root entity."
 129   (if (equal entity message)
 130       nil
 131     (mime-entity-parent-internal entity)))
 132
 133 (defun mime-root-entity-p (entity &optional message)
 134   "Return t if ENTITY is root-entity (message).
 135 If MESSAGE is specified, it is regarded as root entity."
 136   (null (mime-entity-parent entity message)))
 137
 138
 139 ;;; @ Header buffer (obsolete)
 140 ;;;
 141
 142 (luna-define-generic mime-entity-header-buffer (entity))
 143
 144 (luna-define-generic mime-goto-header-start-point (entity)
 145   "Set buffer and point to header-start-position of ENTITY.")
 146
 147 (luna-define-generic mime-entity-header-start-point (entity)
 148   "Return header-start-position of ENTITY.")
 149
 150 (luna-define-generic mime-entity-header-end-point (entity)
 151   "Return header-end-position of ENTITY.")
 152
 153 (make-obsolete 'mime-entity-header-buffer "don't use it.")
 154 (make-obsolete 'mime-goto-header-start-point "don't use it.")
 155 (make-obsolete 'mime-entity-header-start-point "don't use it.")
 156 (make-obsolete 'mime-entity-header-end-point "don't use it.")
 157
 158
 159 ;;; @ Body buffer (obsolete)
 160 ;;;
 161
 162 (luna-define-generic mime-entity-body-buffer (entity))
 163
 164 (luna-define-generic mime-goto-body-start-point (entity)
 165   "Set buffer and point to body-start-position of ENTITY.")
 166
 167 (luna-define-generic mime-goto-body-end-point (entity)
 168   "Set buffer and point to body-end-position of ENTITY.")
 169
 170 (luna-define-generic mime-entity-body-start-point (entity)
 171   "Return body-start-position of ENTITY.")
 172
 173 (luna-define-generic mime-entity-body-end-point (entity)
 174   "Return body-end-position of ENTITY.")
 175
 176 (defalias 'mime-entity-body-start 'mime-entity-body-start-point)
 177 (defalias 'mime-entity-body-end 'mime-entity-body-end-point)
 178
 179 (make-obsolete 'mime-entity-body-buffer "don't use it.")
 180 (make-obsolete 'mime-goto-body-start-point "don't use it.")
 181 (make-obsolete 'mime-goto-body-end-point "don't use it.")
 182 (make-obsolete 'mime-entity-body-start-point "don't use it.")
 183 (make-obsolete 'mime-entity-body-end-point "don't use it.")
 184 (make-obsolete 'mime-entity-body-start "don't use it.")
 185 (make-obsolete 'mime-entity-body-end "don't use it.")
 186
 187
 188 ;;; @ Entity buffer (obsolete)
 189 ;;;
 190
 191 (luna-define-generic mime-entity-buffer (entity))
 192 (make-obsolete 'mime-entity-buffer "don't use it.")
 193
 194 (luna-define-generic mime-entity-point-min (entity))
 195 (make-obsolete 'mime-entity-point-min "don't use it.")
 196
 197 (luna-define-generic mime-entity-point-max (entity))
 198 (make-obsolete 'mime-entity-point-max "don't use it.")
 199
 200
 201 ;;; @ Entity Header
 202 ;;;
 203
 204 (luna-define-generic mime-entity-fetch-field (entity field-name)
 205   "Return the value of the ENTITY's header field whose type is FIELD-NAME.")
 206
 207 ;; (defun mime-fetch-field (field-name &optional entity)
 208 ;;   "Return the value of the ENTITY's header field whose type is FIELD-NAME."
 209 ;;   (if (symbolp field-name)
 210 ;;       (setq field-name (symbol-name field-name))
 211 ;;     )
 212 ;;   (or entity
 213 ;;       (setq entity mime-message-structure))
 214 ;;   (mime-entity-fetch-field entity field-name)
 215 ;;   )
 216 ;; (make-obsolete 'mime-fetch-field 'mime-entity-fetch-field)
 217
 218 (defun mime-entity-content-type (entity)
 219   (or (mime-entity-content-type-internal entity)
 220       (let ((ret (mime-entity-fetch-field entity "Content-Type")))
 221         (if ret
 222             (mime-entity-set-content-type-internal
 223              entity (mime-parse-Content-Type ret))
 224           ))))
 225
 226 (defun mime-entity-content-disposition (entity)
 227   (or (mime-entity-content-disposition-internal entity)
 228       (let ((ret (mime-entity-fetch-field entity "Content-Disposition")))
 229         (if ret
 230             (mime-entity-set-content-disposition-internal
 231              entity (mime-parse-Content-Disposition ret))
 232           ))))
 233
 234 (defun mime-entity-encoding (entity &optional default-encoding)
 235   (or (mime-entity-encoding-internal entity)
 236       (let ((ret (mime-entity-fetch-field entity "Content-Transfer-Encoding")))
 237         (mime-entity-set-encoding-internal
 238          entity
 239          (or (and ret (mime-parse-Content-Transfer-Encoding ret))
 240              default-encoding "7bit"))
 241         )))
 242
 243 (defvar mime-field-parser-alist
 244   '((Return-Path        . std11-parse-route-addr)
 245
 246     (Reply-To           . std11-parse-addresses)
 247
 248     (Sender             . std11-parse-mailbox)
 249     (From               . std11-parse-addresses)
 250
 251     (Resent-Reply-To    . std11-parse-addresses)
 252
 253     (Resent-Sender      . std11-parse-mailbox)
 254     (Resent-From        . std11-parse-addresses)
 255
 256     (To                 . std11-parse-addresses)
 257     (Resent-To          . std11-parse-addresses)
 258     (Cc                 . std11-parse-addresses)
 259     (Resent-Cc          . std11-parse-addresses)
 260     (Bcc                . std11-parse-addresses)
 261     (Resent-Bcc         . std11-parse-addresses)
 262
 263     (Message-Id         . mime-parse-msg-id)
 264     (Recent-Message-Id  . mime-parse-msg-id)
 265
 266     (In-Reply-To        . std11-parse-msg-ids)
 267     (References         . std11-parse-msg-ids)
 268
 269     (Content-Id         . mime-parse-msg-id)
 270     ))
 271
 272 (defun mime-entity-read-field (entity field-name)
 273   (let ((sym (if (symbolp field-name)
 274                  (prog1
 275                      field-name
 276                    (setq field-name (symbol-name field-name)))
 277                (capitalize (capitalize field-name)))))
 278     (cond ((eq sym 'Content-Type)
 279            (mime-entity-content-type entity)
 280            )
 281           ((eq sym 'Content-Disposition)
 282            (mime-entity-content-disposition entity)
 283            )
 284           ((eq sym 'Content-Transfer-Encoding)
 285            (mime-entity-encoding entity)
 286            )
 287           (t
 288            (let* ((header (mime-entity-parsed-header-internal entity))
 289                   (field (cdr (assq sym header))))
 290              (or field
 291                  (let ((field-body (mime-entity-fetch-field entity field-name))
 292                        parser)
 293                    (when field-body
 294                      (setq parser
 295                            (cdr (assq sym mime-field-parser-alist)))
 296                      (setq field
 297                            (if parser
 298                                (funcall parser
 299                                         (eword-lexical-analyze field-body))
 300                              (mime-decode-field-body field-body sym 'plain)
 301                              ))
 302                      (mime-entity-set-parsed-header-internal
 303                       entity (put-alist sym field header))
 304                      field))))))))
 305
 306 ;; (defun mime-read-field (field-name &optional entity)
 307 ;;   (or entity
 308 ;;       (setq entity mime-message-structure))
 309 ;;   (mime-entity-read-field entity field-name)
 310 ;;   )
 311 ;; (make-obsolete 'mime-read-field 'mime-entity-read-field)
 312
 313 (luna-define-generic mime-insert-header (entity &optional invisible-fields
 314                                                 visible-fields)
 315   "Insert before point a decoded header of ENTITY.")
 316
 317
 318 ;;; @ Entity Attributes
 319 ;;;
 320
 321 (luna-define-generic mime-entity-name (entity)
 322   "Return name of the ENTITY.")
 323
 324 (defun mime-entity-uu-filename (entity)
 325   (if (member (mime-entity-encoding entity) mime-uuencode-encoding-name-list)
 326       (save-excursion
 327         (mime-goto-body-start-point entity)
 328         (if (re-search-forward "^begin [0-9]+ "
 329                                (mime-entity-body-end-point entity) t)
 330             (if (looking-at ".+$")
 331                 (buffer-substring (match-beginning 0)(match-end 0))
 332               )))))
 333
 334 (defun mime-entity-filename (entity)
 335   "Return filename of ENTITY."
 336   (or (mime-entity-uu-filename entity)
 337       (mime-content-disposition-filename
 338        (mime-entity-content-disposition entity))
 339       (cdr (let ((param (mime-content-type-parameters
 340                          (mime-entity-content-type entity))))
 341              (or (assoc "name" param)
 342                  (assoc "x-name" param))
 343              ))))
 344
 345
 346 (defsubst mime-entity-media-type (entity)
 347   (mime-content-type-primary-type (mime-entity-content-type entity)))
 348 (defsubst mime-entity-media-subtype (entity)
 349   (mime-content-type-subtype (mime-entity-content-type entity)))
 350 (defsubst mime-entity-parameters (entity)
 351   (mime-content-type-parameters (mime-entity-content-type entity)))
 352 (defsubst mime-entity-type/subtype (entity-info)
 353   (mime-type/subtype-string (mime-entity-media-type entity-info)
 354                             (mime-entity-media-subtype entity-info)))
 355
 356
 357 ;;; @ Entity Content
 358 ;;;
 359
 360 (luna-define-generic mime-entity-content (entity)
 361   "Return content of ENTITY as byte sequence (string).")
 362
 363 (luna-define-generic mime-insert-entity-content (entity)
 364   "Insert content of ENTITY at point.")
 365
 366 (luna-define-generic mime-write-entity-content (entity filename)
 367   "Write content of ENTITY into FILENAME.")
 368
 369 (luna-define-generic mime-insert-text-content (entity)
 370   "Insert decoded text body of ENTITY.")
 371
 372 (luna-define-generic mime-insert-entity (entity)
 373   "Insert header and body of ENTITY at point.")
 374
 375 (luna-define-generic mime-write-entity (entity filename)
 376   "Write header and body of ENTITY into FILENAME.")
 377
 378 (luna-define-generic mime-write-entity-body (entity filename)
 379   "Write body of ENTITY into FILENAME.")
 380
 381
 382 ;;; @ end
 383 ;;;
 384
 385 (provide 'mime)
 386
 387 ;;; mime.el ends here