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 (defun mime-entity-node-id (entity)
  94   (mime-entity-node-id-internal entity))
  95
  96 (defun mime-entity-number (entity)
  97   "Return entity-number of ENTITY."
  98   (reverse (mime-entity-node-id-internal entity)))
  99
 100 (defun mime-find-entity-from-number (entity-number message)
 101   "Return entity from ENTITY-NUMBER in MESSAGE."
 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 message)
 112   "Return entity from ENTITY-NODE-ID in MESSAGE."
 113   (mime-find-entity-from-number (reverse entity-node-id) message))
 114
 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"))
 118       message
 119     (let ((children (mime-entity-children message))
 120           ret)
 121       (while (and children
 122                   (null (setq ret (mime-find-entity-from-content-id
 123                                    cid (car children)))))
 124         (setq children (cdr children)))
 125       ret)))
 126
 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)
 131       nil
 132     (mime-entity-parent-internal entity)))
 133
 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)))
 138
 139
 140 ;;; @ Header buffer (obsolete)
 141 ;;;
 142
 143 (luna-define-generic mime-entity-header-buffer (entity))
 144
 145 (luna-define-generic mime-goto-header-start-point (entity)
 146   "Set buffer and point to header-start-position of ENTITY.")
 147
 148 (luna-define-generic mime-entity-header-start-point (entity)
 149   "Return header-start-position of ENTITY.")
 150
 151 (luna-define-generic mime-entity-header-end-point (entity)
 152   "Return header-end-position of ENTITY.")
 153
 154 (make-obsolete 'mime-entity-header-buffer "don't use it.")
 155 (make-obsolete 'mime-goto-header-start-point "don't use it.")
 156 (make-obsolete 'mime-entity-header-start-point "don't use it.")
 157 (make-obsolete 'mime-entity-header-end-point "don't use it.")
 158
 159
 160 ;;; @ Body buffer (obsolete)
 161 ;;;
 162
 163 (luna-define-generic mime-entity-body-buffer (entity))
 164
 165 (luna-define-generic mime-goto-body-start-point (entity)
 166   "Set buffer and point to body-start-position of ENTITY.")
 167
 168 (luna-define-generic mime-goto-body-end-point (entity)
 169   "Set buffer and point to body-end-position of ENTITY.")
 170
 171 (luna-define-generic mime-entity-body-start-point (entity)
 172   "Return body-start-position of ENTITY.")
 173
 174 (luna-define-generic mime-entity-body-end-point (entity)
 175   "Return body-end-position of ENTITY.")
 176
 177 (defalias 'mime-entity-body-start 'mime-entity-body-start-point)
 178 (defalias 'mime-entity-body-end 'mime-entity-body-end-point)
 179
 180 (make-obsolete 'mime-entity-body-buffer "don't use it.")
 181 (make-obsolete 'mime-goto-body-start-point "don't use it.")
 182 (make-obsolete 'mime-goto-body-end-point "don't use it.")
 183 (make-obsolete 'mime-entity-body-start-point "don't use it.")
 184 (make-obsolete 'mime-entity-body-end-point "don't use it.")
 185 (make-obsolete 'mime-entity-body-start "don't use it.")
 186 (make-obsolete 'mime-entity-body-end "don't use it.")
 187
 188
 189 ;;; @ Entity buffer (obsolete)
 190 ;;;
 191
 192 (luna-define-generic mime-entity-buffer (entity))
 193 (make-obsolete 'mime-entity-buffer "don't use it.")
 194
 195 (luna-define-generic mime-entity-point-min (entity))
 196 (make-obsolete 'mime-entity-point-min "don't use it.")
 197
 198 (luna-define-generic mime-entity-point-max (entity))
 199 (make-obsolete 'mime-entity-point-max "don't use it.")
 200
 201
 202 ;;; @ Entity Header
 203 ;;;
 204
 205 (luna-define-generic mime-entity-fetch-field (entity field-name)
 206   "Return the value of the ENTITY's header field whose type is FIELD-NAME.")
 207
 208 ;; (defun mime-fetch-field (field-name &optional entity)
 209 ;;   "Return the value of the ENTITY's header field whose type is FIELD-NAME."
 210 ;;   (if (symbolp field-name)
 211 ;;       (setq field-name (symbol-name field-name))
 212 ;;     )
 213 ;;   (or entity
 214 ;;       (setq entity mime-message-structure))
 215 ;;   (mime-entity-fetch-field entity field-name)
 216 ;;   )
 217 ;; (make-obsolete 'mime-fetch-field 'mime-entity-fetch-field)
 218
 219 (defun mime-entity-content-type (entity)
 220   (or (mime-entity-content-type-internal entity)
 221       (let ((ret (mime-entity-fetch-field entity "Content-Type")))
 222         (if ret
 223             (mime-entity-set-content-type-internal
 224              entity (mime-parse-Content-Type ret))
 225           ))))
 226
 227 (defun mime-entity-content-disposition (entity)
 228   (or (mime-entity-content-disposition-internal entity)
 229       (let ((ret (mime-entity-fetch-field entity "Content-Disposition")))
 230         (if ret
 231             (mime-entity-set-content-disposition-internal
 232              entity (mime-parse-Content-Disposition ret))
 233           ))))
 234
 235 (defun mime-entity-encoding (entity &optional default-encoding)
 236   (or (mime-entity-encoding-internal entity)
 237       (let ((ret (mime-entity-fetch-field entity "Content-Transfer-Encoding")))
 238         (mime-entity-set-encoding-internal
 239          entity
 240          (or (and ret (mime-parse-Content-Transfer-Encoding ret))
 241              default-encoding "7bit"))
 242         )))
 243
 244 (defvar mime-field-parser-alist
 245   '((Return-Path        . std11-parse-route-addr)
 246
 247     (Reply-To           . std11-parse-addresses)
 248
 249     (Sender             . std11-parse-mailbox)
 250     (From               . std11-parse-addresses)
 251
 252     (Resent-Reply-To    . std11-parse-addresses)
 253
 254     (Resent-Sender      . std11-parse-mailbox)
 255     (Resent-From        . std11-parse-addresses)
 256
 257     (To                 . std11-parse-addresses)
 258     (Resent-To          . std11-parse-addresses)
 259     (Cc                 . std11-parse-addresses)
 260     (Resent-Cc          . std11-parse-addresses)
 261     (Bcc                . std11-parse-addresses)
 262     (Resent-Bcc         . std11-parse-addresses)
 263
 264     (Message-Id         . mime-parse-msg-id)
 265     (Recent-Message-Id  . mime-parse-msg-id)
 266
 267     (In-Reply-To        . std11-parse-msg-ids)
 268     (References         . std11-parse-msg-ids)
 269
 270     (Content-Id         . mime-parse-msg-id)
 271     ))
 272
 273 (defun mime-entity-read-field (entity field-name)
 274   (let ((sym (if (symbolp field-name)
 275                  (prog1
 276                      field-name
 277                    (setq field-name (symbol-name field-name)))
 278                (capitalize (capitalize field-name)))))
 279     (cond ((eq sym 'Content-Type)
 280            (mime-entity-content-type entity)
 281            )
 282           ((eq sym 'Content-Disposition)
 283            (mime-entity-content-disposition entity)
 284            )
 285           ((eq sym 'Content-Transfer-Encoding)
 286            (mime-entity-encoding entity)
 287            )
 288           (t
 289            (let* ((header (mime-entity-parsed-header-internal entity))
 290                   (field (cdr (assq sym header))))
 291              (or field
 292                  (let ((field-body (mime-entity-fetch-field entity field-name))
 293                        parser)
 294                    (when field-body
 295                      (setq parser
 296                            (cdr (assq sym mime-field-parser-alist)))
 297                      (setq field
 298                            (if parser
 299                                (funcall parser
 300                                         (eword-lexical-analyze field-body))
 301                              (mime-decode-field-body field-body sym 'plain)
 302                              ))
 303                      (mime-entity-set-parsed-header-internal
 304                       entity (put-alist sym field header))
 305                      field))))))))
 306
 307 ;; (defun mime-read-field (field-name &optional entity)
 308 ;;   (or entity
 309 ;;       (setq entity mime-message-structure))
 310 ;;   (mime-entity-read-field entity field-name)
 311 ;;   )
 312 ;; (make-obsolete 'mime-read-field 'mime-entity-read-field)
 313
 314 (luna-define-generic mime-insert-header (entity &optional invisible-fields
 315                                                 visible-fields)
 316   "Insert before point a decoded header of ENTITY.")
 317
 318
 319 ;;; @ Entity Attributes
 320 ;;;
 321
 322 (luna-define-generic mime-entity-name (entity)
 323   "Return name of the ENTITY.")
 324
 325 (defun mime-entity-uu-filename (entity)
 326   (if (member (mime-entity-encoding entity) mime-uuencode-encoding-name-list)
 327       (save-excursion
 328         (mime-goto-body-start-point entity)
 329         (if (re-search-forward "^begin [0-9]+ "
 330                                (mime-entity-body-end-point entity) t)
 331             (if (looking-at ".+$")
 332                 (buffer-substring (match-beginning 0)(match-end 0))
 333               )))))
 334
 335 (defun mime-entity-filename (entity)
 336   "Return filename of ENTITY."
 337   (or (mime-entity-uu-filename entity)
 338       (mime-content-disposition-filename
 339        (mime-entity-content-disposition entity))
 340       (cdr (let ((param (mime-content-type-parameters
 341                          (mime-entity-content-type entity))))
 342              (or (assoc "name" param)
 343                  (assoc "x-name" param))
 344              ))))
 345
 346
 347 (defsubst mime-entity-media-type (entity)
 348   (mime-content-type-primary-type (mime-entity-content-type entity)))
 349 (defsubst mime-entity-media-subtype (entity)
 350   (mime-content-type-subtype (mime-entity-content-type entity)))
 351 (defsubst mime-entity-parameters (entity)
 352   (mime-content-type-parameters (mime-entity-content-type entity)))
 353 (defsubst mime-entity-type/subtype (entity-info)
 354   (mime-type/subtype-string (mime-entity-media-type entity-info)
 355                             (mime-entity-media-subtype entity-info)))
 356
 357
 358 ;;; @ Entity Content
 359 ;;;
 360
 361 (luna-define-generic mime-entity-content (entity)
 362   "Return content of ENTITY as byte sequence (string).")
 363
 364 (luna-define-generic mime-insert-entity-content (entity)
 365   "Insert content of ENTITY at point.")
 366
 367 (luna-define-generic mime-write-entity-content (entity filename)
 368   "Write content of ENTITY into FILENAME.")
 369
 370 (luna-define-generic mime-insert-text-content (entity)
 371   "Insert decoded text body of ENTITY.")
 372
 373 (luna-define-generic mime-insert-entity (entity)
 374   "Insert header and body of ENTITY at point.")
 375
 376 (luna-define-generic mime-write-entity (entity filename)
 377   "Write header and body of ENTITY into FILENAME.")
 378
 379 (luna-define-generic mime-write-entity-body (entity filename)
 380   "Write body of ENTITY into FILENAME.")
 381
 382
 383 ;;; @ end
 384 ;;;
 385
 386 (provide 'mime)
 387
 388 ;;; mime.el ends here