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-message "mime-parse"
  57   "Parse current-buffer as a MIME message.")
  58
  59 (autoload 'mime-parse-buffer "mime-parse"
  60   "Parse BUFFER as a MIME message.")
  61
  62
  63 ;;; @ Entity as node of message
  64 ;;;
  65
  66 (defalias 'mime-entity-children 'mime-entity-children-internal)
  67
  68 (defalias 'mime-entity-node-id 'mime-entity-node-id-internal)
  69
  70 (defsubst mime-entity-number (entity)
  71   (reverse (mime-entity-node-id-internal entity)))
  72
  73 (defun mime-find-entity-from-number (entity-number &optional message)
  74   "Return entity from ENTITY-NUMBER in MESSAGE.
  75 If MESSAGE is not specified, `mime-message-structure' is used."
  76   (or message
  77       (setq message mime-message-structure))
  78   (let ((sn (car entity-number)))
  79     (if (null sn)
  80         message
  81       (let ((rc (nth sn (mime-entity-children message))))
  82         (if rc
  83             (mime-find-entity-from-number (cdr entity-number) rc)
  84           ))
  85       )))
  86
  87 (defsubst mime-find-entity-from-node-id (entity-node-id &optional message)
  88   "Return entity from ENTITY-NODE-ID in MESSAGE.
  89 If MESSAGE is not specified, `mime-message-structure' is used."
  90   (mime-find-entity-from-number (reverse entity-node-id) message))
  91
  92 (defsubst mime-entity-parent (entity &optional message)
  93   "Return mother entity of ENTITY.
  94 If MESSAGE is not specified, `mime-message-structure' in the buffer of
  95 ENTITY is used."
  96   (mime-find-entity-from-node-id
  97    (cdr (mime-entity-node-id entity))
  98    (or message
  99        (save-excursion
 100          (set-buffer (mime-entity-buffer entity))
 101          mime-message-structure))))
 102
 103 (defsubst mime-root-entity-p (entity)
 104   "Return t if ENTITY is root-entity (message)."
 105   (null (mime-entity-node-id entity)))
 106
 107
 108 ;;; @ Entity Buffer
 109 ;;;
 110
 111 (defalias 'mime-entity-buffer    'mime-entity-buffer-internal)
 112 (defalias 'mime-entity-point-min 'mime-entity-header-start-internal)
 113 (defalias 'mime-entity-point-max 'mime-entity-body-end-internal)
 114
 115
 116 ;;; @ Entity Header
 117 ;;;
 118
 119 (defalias 'mime-entity-header-start 'mime-entity-header-start-internal)
 120 (defalias 'mime-entity-header-end   'mime-entity-header-end-internal)
 121
 122 (defalias 'mime-entity-content-type     'mime-entity-content-type-internal)
 123 (defalias 'mime-entity-content-disposition
 124   'mime-entity-content-disposition-internal)
 125 (defalias 'mime-entity-encoding         'mime-entity-encoding-internal)
 126
 127 (defun mime-fetch-field (field-name &optional entity)
 128   (or (symbolp field-name)
 129       (setq field-name (intern (capitalize (capitalize field-name)))))
 130   (or entity
 131       (setq entity mime-message-structure))
 132   (let* ((header (mime-entity-original-header-internal entity))
 133          (field-body (cdr (assq field-name header))))
 134     (or field-body
 135         (progn
 136           (if (save-excursion
 137                 (set-buffer (mime-entity-buffer entity))
 138                 (save-restriction
 139                   (narrow-to-region (mime-entity-header-start entity)
 140                                     (mime-entity-header-end entity))
 141                   (setq field-body
 142                         (std11-fetch-field (symbol-name field-name)))
 143                   ))
 144               (mime-entity-set-original-header-internal
 145                entity (put-alist field-name field-body header))
 146             )
 147           field-body))))
 148
 149 (defun mime-read-field (field-name &optional entity)
 150   (or (symbolp field-name)
 151       (setq field-name (capitalize (capitalize field-name))))
 152   (or entity
 153       (setq entity mime-message-structure))
 154   (cond ((eq field-name 'Content-Type)
 155          (mime-entity-content-type entity)
 156          )
 157         ((eq field-name 'Content-Disposition)
 158          (mime-entity-content-disposition entity)
 159          )
 160         ((eq field-name 'Content-Transfer-Encoding)
 161          (mime-entity-encoding entity)
 162          )
 163         (t
 164          (let* ((header (mime-entity-parsed-header-internal entity))
 165                 (field (cdr (assq field-name header))))
 166            (or field
 167                (let ((field-body (mime-fetch-field field-name entity)))
 168                  (when field-body
 169                    (cond ((memq field-name '(From Resent-From
 170                                              To Resent-To
 171                                              Cc Resent-Cc
 172                                              Bcc Resent-Bcc
 173                                              Reply-To Resent-Reply-To))
 174                           (setq field (std11-parse-addresses
 175                                        (eword-lexical-analyze field-body)))
 176                           )
 177                          ((memq field-name '(Sender Resent-Sender))
 178                           (setq field (std11-parse-address
 179                                        (eword-lexical-analyze field-body)))
 180                           )
 181                          ((memq field-name eword-decode-ignored-field-list)
 182                           (setq field field-body))
 183                          ((memq field-name eword-decode-structured-field-list)
 184                           (setq field (eword-decode-structured-field-body
 185                                        field-body)))
 186                          (t
 187                           (setq field (eword-decode-unstructured-field-body
 188                                        field-body))
 189                           ))
 190                    (mime-entity-set-parsed-header-internal
 191                     entity (put-alist field-name field header))
 192                    field)))))))
 193
 194 (defun eword-visible-field-p (field-name visible-fields invisible-fields)
 195   (or (catch 'found
 196         (while visible-fields
 197           (let ((regexp (car visible-fields)))
 198             (if (string-match regexp field-name)
 199                 (throw 'found t)
 200               ))
 201           (setq visible-fields (cdr visible-fields))
 202           ))
 203       (catch 'found
 204         (while invisible-fields
 205           (let ((regexp (car invisible-fields)))
 206             (if (string-match regexp field-name)
 207                 (throw 'found nil)
 208               ))
 209           (setq invisible-fields (cdr invisible-fields))
 210           )
 211         t)))
 212
 213 (defun mime-insert-decoded-header (entity
 214                                    &optional invisible-fields visible-fields
 215                                    code-conversion)
 216   "Insert before point a decoded header of ENTITY."
 217   (let ((default-charset
 218           (if code-conversion
 219               (if (mime-charset-to-coding-system code-conversion)
 220                   code-conversion
 221                 default-mime-charset))))
 222     (save-restriction
 223       (narrow-to-region (point)(point))
 224       (let ((the-buf (current-buffer))
 225             (src-buf (mime-entity-buffer entity))
 226             (h-end (mime-entity-header-end entity))
 227             beg p end field-name len field)
 228         (save-excursion
 229           (set-buffer src-buf)
 230           (goto-char (mime-entity-header-start entity))
 231           (save-restriction
 232             (narrow-to-region (point) h-end)
 233             (while (re-search-forward std11-field-head-regexp nil t)
 234               (setq beg (match-beginning 0)
 235                     p (match-end 0)
 236                     field-name (buffer-substring beg (1- p))
 237                     len (string-width field-name)
 238                     end (std11-field-end))
 239               (when (eword-visible-field-p field-name
 240                                            visible-fields invisible-fields)
 241                 (setq field (intern (capitalize field-name)))
 242                 (save-excursion
 243                   (set-buffer the-buf)
 244                   (insert field-name)
 245                   (insert ":")
 246                   (cond ((memq field eword-decode-ignored-field-list)
 247                          ;; Don't decode
 248                          (insert-buffer-substring src-buf p end)
 249                          )
 250                         ((memq field eword-decode-structured-field-list)
 251                          ;; Decode as structured field
 252                          (let ((body (save-excursion
 253                                        (set-buffer src-buf)
 254                                        (buffer-substring p end)))
 255                                (default-mime-charset default-charset))
 256                            (insert (eword-decode-and-fold-structured-field
 257                                     body (1+ len)))
 258                            ))
 259                         (t
 260                          ;; Decode as unstructured field
 261                          (let ((body (save-excursion
 262                                        (set-buffer src-buf)
 263                                        (buffer-substring p end)))
 264                                (default-mime-charset default-charset))
 265                            (insert (eword-decode-unstructured-field-body
 266                                     body (1+ len)))
 267                            )))
 268                   (insert "\n")
 269                   )))))))))
 270
 271
 272 ;;; @ Entity Content
 273 ;;;
 274
 275 (defalias 'mime-entity-body-start 'mime-entity-body-start-internal)
 276 (defalias 'mime-entity-body-end   'mime-entity-body-end-internal)
 277
 278 (defun mime-entity-content (entity)
 279   (save-excursion
 280     (set-buffer (mime-entity-buffer entity))
 281     (mime-decode-string (buffer-substring (mime-entity-body-start entity)
 282                                           (mime-entity-body-end entity))
 283                         (mime-entity-encoding entity))))
 284
 285
 286 ;;; @ Another Entity Information
 287 ;;;
 288
 289 (defun mime-entity-uu-filename (entity)
 290   (if (member (mime-entity-encoding entity) mime-uuencode-encoding-name-list)
 291       (save-excursion
 292         (set-buffer (mime-entity-buffer entity))
 293         (goto-char (mime-entity-body-start entity))
 294         (if (re-search-forward "^begin [0-9]+ "
 295                                (mime-entity-body-end entity) t)
 296             (if (looking-at ".+$")
 297                 (buffer-substring (match-beginning 0)(match-end 0))
 298               )))))
 299
 300 (defun mime-entity-filename (entity)
 301   "Return filename of ENTITY."
 302   (or (mime-entity-uu-filename entity)
 303       (mime-content-disposition-filename
 304        (mime-entity-content-disposition entity))
 305       (cdr (let ((param (mime-content-type-parameters
 306                          (mime-entity-content-type entity))))
 307              (or (assoc "name" param)
 308                  (assoc "x-name" param))
 309              ))))
 310
 311
 312 (defsubst mime-entity-media-type (entity)
 313   (mime-content-type-primary-type (mime-entity-content-type entity)))
 314 (defsubst mime-entity-media-subtype (entity)
 315   (mime-content-type-subtype (mime-entity-content-type entity)))
 316 (defsubst mime-entity-parameters (entity)
 317   (mime-content-type-parameters (mime-entity-content-type entity)))
 318 (defsubst mime-entity-type/subtype (entity-info)
 319   (mime-type/subtype-string (mime-entity-media-type entity-info)
 320                             (mime-entity-media-subtype entity-info)))
 321
 322
 323 ;;; @ end
 324 ;;;
 325
 326 (provide 'mime)
 327
 328 ;;; mime.el ends here