mmbuffer.el

   1 ;;; mmbuffer.el --- MIME entity module for binary buffer
   2
   3 ;; Copyright (C) 1998,1999 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 'mime)
  28
  29 (eval-and-compile
  30   (luna-define-class mime-buffer-entity (mime-entity)
  31                      (buffer
  32                       header-start
  33                       header-end
  34                       body-start
  35                       body-end))
  36
  37   (luna-define-internal-accessors 'mime-buffer-entity)
  38   )
  39
  40 (mm-define-method initialize-instance ((entity buffer))
  41   (mime-buffer-entity-set-buffer-internal
  42    entity (mime-entity-location-internal entity))
  43   (save-excursion
  44     (set-buffer (mime-buffer-entity-buffer-internal entity))
  45     (setq mime-message-structure entity)
  46     (let ((header-start (point-min))
  47           header-end
  48           body-start
  49           (body-end (point-max)))
  50       (goto-char header-start)
  51       (if (re-search-forward "^$" nil t)
  52           (setq header-end (match-end 0)
  53                 body-start (if (= header-end body-end)
  54                                body-end
  55                              (1+ header-end)))
  56         (setq header-end (point-min)
  57               body-start (point-min)))
  58       (save-restriction
  59         (narrow-to-region header-start header-end)
  60         (mime-entity-set-content-type-internal
  61          entity
  62          (let ((str (std11-fetch-field "Content-Type")))
  63            (if str
  64                (mime-parse-Content-Type str)
  65              )))
  66         )
  67       (mime-buffer-entity-set-header-start-internal entity header-start)
  68       (mime-buffer-entity-set-header-end-internal entity header-end)
  69       (mime-buffer-entity-set-body-start-internal entity body-start)
  70       (mime-buffer-entity-set-body-end-internal entity body-end)
  71       )))
  72
  73 (luna-define-method mime-entity-name ((entity mime-buffer-entity))
  74   (buffer-name (mime-buffer-entity-buffer-internal entity))
  75   )
  76
  77
  78 ;;; @ message parser
  79 ;;;
  80
  81 (defun mime-parse-multipart (entity)
  82   (goto-char (point-min))
  83   (let* ((representation-type
  84           (mime-entity-representation-type-internal entity))
  85          (content-type (mime-entity-content-type-internal entity))
  86          (dash-boundary
  87           (concat "--" (mime-content-type-parameter content-type "boundary")))
  88          (delimiter       (concat "\n" (regexp-quote dash-boundary)))
  89          (close-delimiter (concat delimiter "--[ \t]*$"))
  90          (rsep (concat delimiter "[ \t]*\n"))
  91          (dc-ctl
  92           (if (eq (mime-content-type-subtype content-type) 'digest)
  93               (make-mime-content-type 'message 'rfc822)
  94             (make-mime-content-type 'text 'plain)
  95             ))
  96          (header-end (mime-buffer-entity-header-end-internal entity))
  97          (body-end (mime-buffer-entity-body-end-internal entity)))
  98     (save-restriction
  99       (goto-char body-end)
 100       (narrow-to-region header-end
 101                         (if (re-search-backward close-delimiter nil t)
 102                             (match-beginning 0)
 103                           body-end))
 104       (goto-char header-end)
 105       (if (re-search-forward rsep nil t)
 106           (let ((cb (match-end 0))
 107                 ce ncb ret children
 108                 (node-id (mime-entity-node-id-internal entity))
 109                 (i 0))
 110             (while (re-search-forward rsep nil t)
 111               (setq ce (match-beginning 0))
 112               (setq ncb (match-end 0))
 113               (save-restriction
 114                 (narrow-to-region cb ce)
 115                 (setq ret (mime-parse-message representation-type dc-ctl
 116                                               entity (cons i node-id)))
 117                 )
 118               (setq children (cons ret children))
 119               (goto-char (setq cb ncb))
 120               (setq i (1+ i))
 121               )
 122             (setq ce (point-max))
 123             (save-restriction
 124               (narrow-to-region cb ce)
 125               (setq ret (mime-parse-message representation-type dc-ctl
 126                                             entity (cons i node-id)))
 127               )
 128             (setq children (cons ret children))
 129             (mime-entity-set-children-internal entity (nreverse children))
 130             )
 131         (mime-entity-set-content-type-internal
 132          entity (make-mime-content-type 'message 'x-broken))
 133         nil)
 134       )))
 135
 136 (defun mime-parse-encapsulated (entity)
 137   (mime-entity-set-children-internal
 138    entity
 139    (save-restriction
 140      (narrow-to-region (mime-buffer-entity-body-start-internal entity)
 141                        (mime-buffer-entity-body-end-internal entity))
 142      (list (mime-parse-message
 143             (mime-entity-representation-type-internal entity) nil
 144             entity (cons 0 (mime-entity-node-id-internal entity))))
 145      )))
 146
 147 (defun mime-parse-message (representation-type &optional default-ctl
 148                                                parent node-id)
 149   (let ((header-start (point-min))
 150         header-end
 151         body-start
 152         (body-end (point-max))
 153         content-type)
 154     (goto-char header-start)
 155     (if (re-search-forward "^$" nil t)
 156         (setq header-end (match-end 0)
 157               body-start (if (= header-end body-end)
 158                              body-end
 159                            (1+ header-end)))
 160       (setq header-end (point-min)
 161             body-start (point-min)))
 162     (save-restriction
 163       (narrow-to-region header-start header-end)
 164       (setq content-type (or (let ((str (std11-fetch-field "Content-Type")))
 165                                (if str
 166                                    (mime-parse-Content-Type str)
 167                                  ))
 168                              default-ctl))
 169       )
 170     (luna-make-entity representation-type
 171                       :location (current-buffer)
 172                       :content-type content-type
 173                       :parent parent
 174                       :node-id node-id
 175                       :buffer (current-buffer)
 176                       :header-start header-start
 177                       :header-end header-end
 178                       :body-start body-start
 179                       :body-end body-end)
 180     ))
 181
 182 (luna-define-method mime-entity-children ((entity mime-buffer-entity))
 183   (let* ((content-type (mime-entity-content-type entity))
 184          (primary-type (mime-content-type-primary-type content-type)))
 185     (cond ((eq primary-type 'multipart)
 186            (mime-parse-multipart entity)
 187            )
 188           ((and (eq primary-type 'message)
 189                 (memq (mime-content-type-subtype content-type)
 190                       '(rfc822 news external-body)
 191                       ))
 192            (mime-parse-encapsulated entity)
 193            ))
 194     ))
 195
 196
 197 (luna-define-method mime-goto-header-start-point ((entity mime-buffer-entity))
 198   (set-buffer (mime-buffer-entity-buffer-internal entity))
 199   (goto-char (mime-buffer-entity-header-start-internal entity))
 200   )
 201
 202 (defun mime-visible-field-p (field-name visible-fields invisible-fields)
 203   (or (catch 'found
 204         (while visible-fields
 205           (let ((regexp (car visible-fields)))
 206             (if (string-match regexp field-name)
 207                 (throw 'found t)
 208               ))
 209           (setq visible-fields (cdr visible-fields))
 210           ))
 211       (catch 'found
 212         (while invisible-fields
 213           (let ((regexp (car invisible-fields)))
 214             (if (string-match regexp field-name)
 215                 (throw 'found nil)
 216               ))
 217           (setq invisible-fields (cdr invisible-fields))
 218           )
 219         t)))
 220
 221 (defun mime-insert-header-from-buffer (buffer start end
 222                                               &optional invisible-fields
 223                                               visible-fields)
 224   (let ((the-buf (current-buffer))
 225         (mode-obj (mime-find-field-presentation-method 'wide))
 226         field-decoder
 227         f-b p f-e field-name len field field-body)
 228     (save-excursion
 229       (set-buffer buffer)
 230       (save-restriction
 231         (narrow-to-region start end)
 232         (goto-char start)
 233         (while (re-search-forward std11-field-head-regexp nil t)
 234           (setq f-b (match-beginning 0)
 235                 p (match-end 0)
 236                 field-name (buffer-substring f-b p)
 237                 len (string-width field-name)
 238                 f-e (std11-field-end))
 239           (when (mime-visible-field-p field-name
 240                                       visible-fields invisible-fields)
 241             (setq field (intern
 242                          (capitalize (buffer-substring f-b (1- p))))
 243                   field-body (buffer-substring p f-e)
 244                   field-decoder (inline (mime-find-field-decoder-internal
 245                                          field mode-obj)))
 246             (with-current-buffer the-buf
 247               (insert field-name)
 248               (insert (if field-decoder
 249                           (funcall field-decoder field-body len)
 250                         ;; Don't decode
 251                         field-body))
 252               (insert "\n")
 253               )))))))
 254
 255 (luna-define-method mime-insert-header ((entity mime-buffer-entity)
 256                                         &optional invisible-fields
 257                                         visible-fields)
 258   (mime-insert-header-from-buffer
 259    (mime-buffer-entity-buffer-internal entity)
 260    (mime-buffer-entity-header-start-internal entity)
 261    (mime-buffer-entity-header-end-internal entity)
 262    invisible-fields visible-fields)
 263   )
 264
 265 (luna-define-method mime-entity-content ((entity mime-buffer-entity))
 266   (save-excursion
 267     (set-buffer (mime-buffer-entity-buffer-internal entity))
 268     (mime-decode-string
 269      (buffer-substring (mime-buffer-entity-body-start-internal entity)
 270                        (mime-buffer-entity-body-end-internal entity))
 271      (mime-entity-encoding entity))))
 272
 273 (luna-define-method mime-insert-text-content ((entity mime-buffer-entity))
 274   (insert
 275    (decode-mime-charset-string (mime-entity-content entity)
 276                                (or (mime-content-type-parameter
 277                                     (mime-entity-content-type entity)
 278                                     "charset")
 279                                    default-mime-charset)
 280                                'CRLF)
 281    ))
 282
 283 ;;; redefine to speed up
 284
 285 (mm-define-method entity-point-min ((entity buffer))
 286   (mime-buffer-entity-header-start-internal entity))
 287
 288 (mm-define-method entity-point-max ((entity buffer))
 289   (mime-buffer-entity-body-end-internal entity))
 290
 291 (luna-define-method mime-entity-fetch-field ((entity mime-buffer-entity)
 292                                              field-name)
 293   (save-excursion
 294     (set-buffer (mime-buffer-entity-buffer-internal entity))
 295     (save-restriction
 296       (narrow-to-region (mime-buffer-entity-header-start-internal entity)
 297                         (mime-buffer-entity-header-end-internal entity))
 298       (std11-fetch-field field-name)
 299       )))
 300
 301 (mm-define-method insert-entity-content ((entity buffer))
 302   (insert (with-current-buffer (mime-buffer-entity-buffer-internal entity)
 303             (mime-decode-string
 304              (buffer-substring (mime-buffer-entity-body-start-internal entity)
 305                                (mime-buffer-entity-body-end-internal entity))
 306              (mime-entity-encoding entity)))))
 307
 308 (mm-define-method write-entity-content ((entity buffer) filename)
 309   (save-excursion
 310     (set-buffer (mime-buffer-entity-buffer-internal entity))
 311     (mime-write-decoded-region (mime-buffer-entity-body-start-internal entity)
 312                                (mime-buffer-entity-body-end-internal entity)
 313                                filename
 314                                (or (mime-entity-encoding entity) "7bit"))
 315     ))
 316
 317 (mm-define-method insert-entity ((entity buffer))
 318   (insert-buffer-substring (mime-buffer-entity-buffer-internal entity)
 319                            (mime-buffer-entity-header-start-internal entity)
 320                            (mime-buffer-entity-body-end-internal entity))
 321   )
 322
 323 (mm-define-method write-entity ((entity buffer) filename)
 324   (save-excursion
 325     (set-buffer (mime-buffer-entity-buffer-internal entity))
 326     (write-region-as-raw-text-CRLF
 327      (mime-buffer-entity-header-start-internal entity)
 328      (mime-buffer-entity-body-end-internal entity)
 329      filename)
 330     ))
 331
 332 (mm-define-method write-entity-body ((entity buffer) filename)
 333   (save-excursion
 334     (set-buffer (mime-buffer-entity-buffer-internal entity))
 335     (write-region-as-binary (mime-buffer-entity-body-start-internal entity)
 336                             (mime-buffer-entity-body-end-internal entity)
 337                             filename)
 338     ))
 339
 340
 341 ;;; @ buffer
 342 ;;;
 343
 344 (luna-define-method mime-entity-header-buffer ((entity mime-buffer-entity))
 345   (mime-buffer-entity-buffer-internal entity)
 346   )
 347
 348 (luna-define-method mime-entity-body-buffer ((entity mime-buffer-entity))
 349   (mime-buffer-entity-buffer-internal entity)
 350   )
 351
 352 (luna-define-method mime-entity-buffer ((entity mime-buffer-entity))
 353   (mime-buffer-entity-buffer-internal entity)
 354   )
 355
 356 (luna-define-method mime-entity-point-min ((entity mime-buffer-entity))
 357   (mime-buffer-entity-header-start-internal entity)
 358   )
 359
 360 (luna-define-method mime-entity-point-max ((entity mime-buffer-entity))
 361   (mime-buffer-entity-body-end-internal entity)
 362   )
 363
 364
 365 ;;; @ utility
 366 ;;;
 367
 368 ;;;###autoload
 369 (defun mime-parse-buffer (&optional buffer representation-type)
 370   "Parse BUFFER as a MIME message.
 371 If buffer is omitted, it parses current-buffer."
 372   (save-excursion
 373     (if buffer (set-buffer buffer))
 374     (setq mime-message-structure
 375           (mime-parse-message (or representation-type 'buffer) nil))
 376     ))
 377
 378
 379 ;;; @ end
 380 ;;;
 381
 382 (provide 'mmbuffer)
 383
 384 ;;; mmbuffer.el ends here