mmbuffer.el

   1 ;;; mmbuffer.el --- MIME entity module for binary buffer
   2
   3 ;; Copyright (C) 1998,1999 Free Software Foundation, Inc.
   4 ;; Copyright (C) 1999 Electrotechnical Laboratory, JAPAN.
   5 ;; Licensed to the Free Software Foundation.
   6
   7 ;; Author: MORIOKA Tomohiko <tomo@m17n.org>
   8 ;; Keywords: MIME, multimedia, mail, news
   9
  10 ;; This file is part of FLIM (Faithful Library about Internet Message).
  11
  12 ;; This program is free software; you can redistribute it and/or
  13 ;; modify it under the terms of the GNU General Public License as
  14 ;; published by the Free Software Foundation; either version 2, or (at
  15 ;; your option) any later version.
  16
  17 ;; This program is distributed in the hope that it will be useful, but
  18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20 ;; General Public License for more details.
  21
  22 ;; You should have received a copy of the GNU General Public License
  23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  25 ;; Boston, MA 02111-1307, USA.
  26
  27 ;;; Code:
  28
  29 (require 'mime)
  30
  31 (eval-and-compile
  32   (luna-define-class mime-buffer-entity (mime-entity)
  33                      (buffer
  34                       header-start
  35                       header-end
  36                       body-start
  37                       body-end))
  38
  39   (luna-define-internal-accessors 'mime-buffer-entity)
  40   )
  41
  42 (luna-define-method initialize-instance :after ((entity mime-buffer-entity)
  43                                                 &rest init-args)
  44   (or (mime-buffer-entity-buffer-internal entity)
  45       (mime-buffer-entity-set-buffer-internal
  46        entity (mime-entity-location-internal entity)))
  47   (save-excursion
  48     (set-buffer (mime-buffer-entity-buffer-internal entity))
  49     (if (mime-root-entity-p entity)
  50         (setq mime-message-structure entity))
  51     (let ((header-start
  52            (or (mime-buffer-entity-header-start-internal entity)
  53                (mime-buffer-entity-set-header-start-internal
  54                 entity (point-min))))
  55           (header-end (mime-buffer-entity-header-end-internal entity))
  56           (body-start (mime-buffer-entity-body-start-internal entity))
  57           (body-end
  58            (or (mime-buffer-entity-body-end-internal entity)
  59                (mime-buffer-entity-set-body-end-internal entity (point-max)))))
  60       (goto-char header-start)
  61       (unless (and header-end body-start)
  62         (if (re-search-forward "^$" body-end t)
  63             (setq header-end (match-end 0)
  64                   body-start (if (= header-end body-end)
  65                                  body-end
  66                                (1+ header-end)))
  67           (setq header-end (point-min)
  68                 body-start (point-min)))
  69         (mime-buffer-entity-set-header-end-internal entity header-end)
  70         (mime-buffer-entity-set-body-start-internal entity body-start)
  71         )
  72       (or (mime-entity-content-type-internal entity)
  73           (save-restriction
  74             (narrow-to-region header-start header-end)
  75             (mime-entity-set-content-type-internal
  76              entity
  77              (let ((str (std11-fetch-field "Content-Type")))
  78                (if str
  79                    (mime-parse-Content-Type str)
  80                  )))
  81             ))
  82       ))
  83   entity)
  84
  85 (luna-define-method mime-entity-name ((entity mime-buffer-entity))
  86   (buffer-name (mime-buffer-entity-buffer-internal entity))
  87   )
  88
  89
  90 ;;; @ message parser
  91 ;;;
  92
  93 (defun mime-parse-multipart (entity)
  94   (with-current-buffer (mime-entity-body-buffer entity)
  95     (let* ((representation-type
  96             (mime-entity-representation-type-internal entity))
  97            (content-type (mime-entity-content-type-internal entity))
  98            (dash-boundary
  99             (concat "--"
 100                     (mime-content-type-parameter content-type "boundary")))
 101            (delimiter       (concat "\n" (regexp-quote dash-boundary)))
 102            (close-delimiter (concat delimiter "--[ \t]*$"))
 103            (rsep (concat delimiter "[ \t]*\n"))
 104            (dc-ctl
 105             (if (eq (mime-content-type-subtype content-type) 'digest)
 106                 (make-mime-content-type 'message 'rfc822)
 107               (make-mime-content-type 'text 'plain)
 108               ))
 109            (body-start (mime-entity-body-start-point entity))
 110            (body-end (mime-entity-body-end-point entity)))
 111       (save-restriction
 112         (goto-char body-end)
 113         (narrow-to-region body-start
 114                           (if (re-search-backward close-delimiter nil t)
 115                               (match-beginning 0)
 116                             body-end))
 117         (goto-char body-start)
 118         (if (re-search-forward
 119              (concat "^" (regexp-quote dash-boundary) "[ \t]*\n")
 120              nil t)
 121             (let ((cb (match-end 0))
 122                   ce ncb ret children
 123                   (node-id (mime-entity-node-id-internal entity))
 124                   (i 0))
 125               (while (re-search-forward rsep nil t)
 126                 (setq ce (match-beginning 0))
 127                 (setq ncb (match-end 0))
 128                 (save-restriction
 129                   (narrow-to-region cb ce)
 130                   (setq ret (mime-parse-message representation-type dc-ctl
 131                                                 entity (cons i node-id)))
 132                   )
 133                 (setq children (cons ret children))
 134                 (goto-char (setq cb ncb))
 135                 (setq i (1+ i))
 136                 )
 137               (setq ce (point-max))
 138               (save-restriction
 139                 (narrow-to-region cb ce)
 140                 (setq ret (mime-parse-message representation-type dc-ctl
 141                                               entity (cons i node-id)))
 142                 )
 143               (setq children (cons ret children))
 144               (mime-entity-set-children-internal entity (nreverse children))
 145               )
 146           (mime-entity-set-content-type-internal
 147            entity (make-mime-content-type 'message 'x-broken))
 148           nil)
 149         ))))
 150
 151 (defun mime-parse-encapsulated (entity)
 152   (mime-entity-set-children-internal
 153    entity
 154    (save-restriction
 155      (narrow-to-region (mime-buffer-entity-body-start-internal entity)
 156                        (mime-buffer-entity-body-end-internal entity))
 157      (list (mime-parse-message
 158             (mime-entity-representation-type-internal entity) nil
 159             entity (cons 0 (mime-entity-node-id-internal entity))))
 160      )))
 161
 162 (defun mime-parse-message (representation-type &optional default-ctl
 163                                                parent node-id)
 164   (let ((header-start (point-min))
 165         header-end
 166         body-start
 167         (body-end (point-max))
 168         content-type)
 169     (goto-char header-start)
 170     (if (re-search-forward "^$" nil t)
 171         (setq header-end (match-end 0)
 172               body-start (if (= header-end body-end)
 173                              body-end
 174                            (1+ header-end)))
 175       (setq header-end (point-min)
 176             body-start (point-min)))
 177     (save-restriction
 178       (narrow-to-region header-start header-end)
 179       (setq content-type (or (let ((str (std11-fetch-field "Content-Type")))
 180                                (if str
 181                                    (mime-parse-Content-Type str)
 182                                  ))
 183                              default-ctl))
 184       )
 185     (luna-make-entity representation-type
 186                       :location (current-buffer)
 187                       :content-type content-type
 188                       :parent parent
 189                       :node-id node-id
 190                       :buffer (current-buffer)
 191                       :header-start header-start
 192                       :header-end header-end
 193                       :body-start body-start
 194                       :body-end body-end)
 195     ))
 196
 197 (luna-define-method mime-entity-children ((entity mime-buffer-entity))
 198   (let* ((content-type (mime-entity-content-type entity))
 199          (primary-type (mime-content-type-primary-type content-type)))
 200     (cond ((eq primary-type 'multipart)
 201            (mime-parse-multipart entity)
 202            )
 203           ((and (eq primary-type 'message)
 204                 (memq (mime-content-type-subtype content-type)
 205                       '(rfc822 news external-body)
 206                       ))
 207            (mime-parse-encapsulated entity)
 208            ))
 209     ))
 210
 211
 212 (defun mime-visible-field-p (field-name visible-fields invisible-fields)
 213   (or (catch 'found
 214         (while visible-fields
 215           (let ((regexp (car visible-fields)))
 216             (if (string-match regexp field-name)
 217                 (throw 'found t)
 218               ))
 219           (setq visible-fields (cdr visible-fields))
 220           ))
 221       (catch 'found
 222         (while invisible-fields
 223           (let ((regexp (car invisible-fields)))
 224             (if (string-match regexp field-name)
 225                 (throw 'found nil)
 226               ))
 227           (setq invisible-fields (cdr invisible-fields))
 228           )
 229         t)))
 230
 231 (defun mime-insert-header-from-buffer (buffer start end
 232                                               &optional invisible-fields
 233                                               visible-fields)
 234   (let ((the-buf (current-buffer))
 235         (mode-obj (mime-find-field-presentation-method 'wide))
 236         field-decoder
 237         f-b p f-e field-name len field field-body)
 238     (save-excursion
 239       (set-buffer buffer)
 240       (save-restriction
 241         (narrow-to-region start end)
 242         (goto-char start)
 243         (while (re-search-forward std11-field-head-regexp nil t)
 244           (setq f-b (match-beginning 0)
 245                 p (match-end 0)
 246                 field-name (buffer-substring f-b p)
 247                 len (string-width field-name)
 248                 f-e (std11-field-end))
 249           (when (mime-visible-field-p field-name
 250                                       visible-fields invisible-fields)
 251             (setq field (intern
 252                          (capitalize (buffer-substring f-b (1- p))))
 253                   field-body (buffer-substring p f-e)
 254                   field-decoder (inline (mime-find-field-decoder-internal
 255                                          field mode-obj)))
 256             (with-current-buffer the-buf
 257               (insert field-name)
 258               (insert (if field-decoder
 259                           (funcall field-decoder field-body len)
 260                         ;; Don't decode
 261                         field-body))
 262               (insert "\n")
 263               )))))))
 264
 265 (luna-define-method mime-insert-header ((entity mime-buffer-entity)
 266                                         &optional invisible-fields
 267                                         visible-fields)
 268   (mime-insert-header-from-buffer
 269    (mime-buffer-entity-buffer-internal entity)
 270    (mime-buffer-entity-header-start-internal entity)
 271    (mime-buffer-entity-header-end-internal entity)
 272    invisible-fields visible-fields)
 273   )
 274
 275 (luna-define-method mime-entity-content ((entity mime-buffer-entity))
 276   (save-excursion
 277     (set-buffer (mime-buffer-entity-buffer-internal entity))
 278     (mime-decode-string
 279      (buffer-substring (mime-buffer-entity-body-start-internal entity)
 280                        (mime-buffer-entity-body-end-internal entity))
 281      (mime-entity-encoding entity))))
 282
 283 (luna-define-method mime-insert-text-content ((entity mime-buffer-entity))
 284   (insert
 285    (decode-mime-charset-string (mime-entity-content entity)
 286                                (or (mime-content-type-parameter
 287                                     (mime-entity-content-type entity)
 288                                     "charset")
 289                                    default-mime-charset)
 290                                'CRLF)
 291    ))
 292
 293 ;;; redefine to speed up
 294
 295 (mm-define-method entity-point-min ((entity buffer))
 296   (mime-buffer-entity-header-start-internal entity))
 297
 298 (mm-define-method entity-point-max ((entity buffer))
 299   (mime-buffer-entity-body-end-internal entity))
 300
 301 (luna-define-method mime-entity-fetch-field ((entity mime-buffer-entity)
 302                                              field-name)
 303   (save-excursion
 304     (set-buffer (mime-buffer-entity-buffer-internal entity))
 305     (save-restriction
 306       (narrow-to-region (mime-buffer-entity-header-start-internal entity)
 307                         (mime-buffer-entity-header-end-internal entity))
 308       (std11-fetch-field field-name)
 309       )))
 310
 311 (mm-define-method insert-entity-content ((entity buffer))
 312   (insert (with-current-buffer (mime-buffer-entity-buffer-internal entity)
 313             (mime-decode-string
 314              (buffer-substring (mime-buffer-entity-body-start-internal entity)
 315                                (mime-buffer-entity-body-end-internal entity))
 316              (mime-entity-encoding entity)))))
 317
 318 (mm-define-method write-entity-content ((entity buffer) filename)
 319   (save-excursion
 320     (set-buffer (mime-buffer-entity-buffer-internal entity))
 321     (mime-write-decoded-region (mime-buffer-entity-body-start-internal entity)
 322                                (mime-buffer-entity-body-end-internal entity)
 323                                filename
 324                                (or (mime-entity-encoding entity) "7bit"))
 325     ))
 326
 327 (mm-define-method insert-entity ((entity buffer))
 328   (insert-buffer-substring (mime-buffer-entity-buffer-internal entity)
 329                            (mime-buffer-entity-header-start-internal entity)
 330                            (mime-buffer-entity-body-end-internal entity))
 331   )
 332
 333 (mm-define-method write-entity ((entity buffer) filename)
 334   (save-excursion
 335     (set-buffer (mime-buffer-entity-buffer-internal entity))
 336     (write-region-as-raw-text-CRLF
 337      (mime-buffer-entity-header-start-internal entity)
 338      (mime-buffer-entity-body-end-internal entity)
 339      filename)
 340     ))
 341
 342 (mm-define-method write-entity-body ((entity buffer) filename)
 343   (save-excursion
 344     (set-buffer (mime-buffer-entity-buffer-internal entity))
 345     (write-region-as-binary (mime-buffer-entity-body-start-internal entity)
 346                             (mime-buffer-entity-body-end-internal entity)
 347                             filename)
 348     ))
 349
 350
 351 ;;; @ buffer
 352 ;;;
 353
 354 (luna-define-method mime-entity-header-buffer ((entity mime-buffer-entity))
 355   (mime-buffer-entity-buffer-internal entity)
 356   )
 357
 358 (luna-define-method mime-entity-body-buffer ((entity mime-buffer-entity))
 359   (mime-buffer-entity-buffer-internal entity)
 360   )
 361
 362 (luna-define-method mime-entity-buffer ((entity mime-buffer-entity))
 363   (mime-buffer-entity-buffer-internal entity)
 364   )
 365
 366 (luna-define-method mime-entity-body-start-point ((entity mime-buffer-entity))
 367   (mime-buffer-entity-body-start-internal entity)
 368   )
 369
 370 (luna-define-method mime-entity-body-end-point ((entity mime-buffer-entity))
 371   (mime-buffer-entity-body-end-internal entity)
 372   )
 373
 374 (luna-define-method mime-entity-point-min ((entity mime-buffer-entity))
 375   (mime-buffer-entity-header-start-internal entity)
 376   )
 377
 378 (luna-define-method mime-entity-point-max ((entity mime-buffer-entity))
 379   (mime-buffer-entity-body-end-internal entity)
 380   )
 381
 382 (luna-define-method mime-goto-header-start-point ((entity mime-buffer-entity))
 383   (set-buffer (mime-buffer-entity-buffer-internal entity))
 384   (goto-char (mime-buffer-entity-header-start-internal entity))
 385   )
 386
 387 (luna-define-method mime-goto-body-start-point ((entity mime-buffer-entity))
 388   (set-buffer (mime-buffer-entity-buffer-internal entity))
 389   (goto-char (mime-buffer-entity-body-start-internal entity))
 390   )
 391
 392 (luna-define-method mime-goto-body-end-point ((entity mime-buffer-entity))
 393   (set-buffer (mime-buffer-entity-buffer-internal entity))
 394   (goto-char (mime-buffer-entity-body-end-internal entity))
 395   )
 396
 397
 398 ;;; @ utility
 399 ;;;
 400
 401 ;;;###autoload
 402 (defun mime-parse-buffer (&optional buffer representation-type)
 403   "Parse BUFFER as a MIME message.
 404 If buffer is omitted, it parses current-buffer."
 405   (save-excursion
 406     (if buffer (set-buffer buffer))
 407     (setq mime-message-structure
 408           (mime-parse-message (or representation-type 'buffer) nil))
 409     ))
 410
 411
 412 ;;; @ end
 413 ;;;
 414
 415 (provide 'mmbuffer)
 416
 417 ;;; mmbuffer.el ends here