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