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    (with-current-buffer (mime-entity-body-buffer entity)
 155      (save-restriction
 156        (narrow-to-region (mime-buffer-entity-body-start-internal entity)
 157                          (mime-buffer-entity-body-end-internal entity))
 158        (list (mime-parse-message
 159               (mime-entity-representation-type-internal entity) nil
 160               entity (cons 0 (mime-entity-node-id-internal entity))))
 161        ))))
 162
 163 (defun mime-parse-message (representation-type &optional default-ctl
 164                                                parent node-id)
 165   (let ((header-start (point-min))
 166         header-end
 167         body-start
 168         (body-end (point-max))
 169         content-type)
 170     (goto-char header-start)
 171     (if (re-search-forward "^$" nil t)
 172         (setq header-end (match-end 0)
 173               body-start (if (= header-end body-end)
 174                              body-end
 175                            (1+ header-end)))
 176       (setq header-end (point-min)
 177             body-start (point-min)))
 178     (save-restriction
 179       (narrow-to-region header-start header-end)
 180       (setq content-type (or (let ((str (std11-fetch-field "Content-Type")))
 181                                (if str
 182                                    (mime-parse-Content-Type str)
 183                                  ))
 184                              default-ctl))
 185       )
 186     (luna-make-entity representation-type
 187                       :location (current-buffer)
 188                       :content-type content-type
 189                       :parent parent
 190                       :node-id node-id
 191                       :buffer (current-buffer)
 192                       :header-start header-start
 193                       :header-end header-end
 194                       :body-start body-start
 195                       :body-end body-end)
 196     ))
 197
 198 (luna-define-method mime-entity-children ((entity mime-buffer-entity))
 199   (let* ((content-type (mime-entity-content-type entity))
 200          (primary-type (mime-content-type-primary-type content-type)))
 201     (cond ((eq primary-type 'multipart)
 202            (mime-parse-multipart entity)
 203            )
 204           ((and (eq primary-type 'message)
 205                 (memq (mime-content-type-subtype content-type)
 206                       '(rfc822 news external-body)
 207                       ))
 208            (mime-parse-encapsulated entity)
 209            ))
 210     ))
 211
 212
 213 (defun mime-visible-field-p (field-name visible-fields invisible-fields)
 214   (or (catch 'found
 215         (while visible-fields
 216           (let ((regexp (car visible-fields)))
 217             (if (string-match regexp field-name)
 218                 (throw 'found t)
 219               ))
 220           (setq visible-fields (cdr visible-fields))
 221           ))
 222       (catch 'found
 223         (while invisible-fields
 224           (let ((regexp (car invisible-fields)))
 225             (if (string-match regexp field-name)
 226                 (throw 'found nil)
 227               ))
 228           (setq invisible-fields (cdr invisible-fields))
 229           )
 230         t)))
 231
 232 (defun mime-insert-header-from-buffer (buffer start end
 233                                               &optional invisible-fields
 234                                               visible-fields)
 235   (let ((the-buf (current-buffer))
 236         (mode-obj (mime-find-field-presentation-method 'wide))
 237         field-decoder
 238         f-b p f-e field-name len field field-body)
 239     (save-excursion
 240       (set-buffer buffer)
 241       (save-restriction
 242         (narrow-to-region start end)
 243         (goto-char start)
 244         (while (re-search-forward std11-field-head-regexp nil t)
 245           (setq f-b (match-beginning 0)
 246                 p (match-end 0)
 247                 field-name (buffer-substring f-b p)
 248                 len (string-width field-name)
 249                 f-e (std11-field-end))
 250           (when (mime-visible-field-p field-name
 251                                       visible-fields invisible-fields)
 252             (setq field (intern
 253                          (capitalize (buffer-substring f-b (1- p))))
 254                   field-body (buffer-substring p f-e)
 255                   field-decoder (inline (mime-find-field-decoder-internal
 256                                          field mode-obj)))
 257             (with-current-buffer the-buf
 258               (insert field-name)
 259               (insert (if field-decoder
 260                           (funcall field-decoder field-body len)
 261                         ;; Don't decode
 262                         field-body))
 263               (insert "\n")
 264               )))))))
 265
 266 (luna-define-method mime-insert-header ((entity mime-buffer-entity)
 267                                         &optional invisible-fields
 268                                         visible-fields)
 269   (mime-insert-header-from-buffer
 270    (mime-buffer-entity-buffer-internal entity)
 271    (mime-buffer-entity-header-start-internal entity)
 272    (mime-buffer-entity-header-end-internal entity)
 273    invisible-fields visible-fields)
 274   )
 275
 276 (luna-define-method mime-entity-content ((entity mime-buffer-entity))
 277   (save-excursion
 278     (set-buffer (mime-buffer-entity-buffer-internal entity))
 279     (mime-decode-string
 280      (buffer-substring (mime-buffer-entity-body-start-internal entity)
 281                        (mime-buffer-entity-body-end-internal entity))
 282      (mime-entity-encoding entity))))
 283
 284 (luna-define-method mime-insert-text-content ((entity mime-buffer-entity))
 285   (insert
 286    (decode-mime-charset-string (mime-entity-content entity)
 287                                (or (mime-content-type-parameter
 288                                     (mime-entity-content-type entity)
 289                                     "charset")
 290                                    default-mime-charset)
 291                                'CRLF)
 292    ))
 293
 294 ;;; redefine to speed up
 295
 296 (mm-define-method entity-point-min ((entity buffer))
 297   (mime-buffer-entity-header-start-internal entity))
 298
 299 (mm-define-method entity-point-max ((entity buffer))
 300   (mime-buffer-entity-body-end-internal entity))
 301
 302 (luna-define-method mime-entity-fetch-field ((entity mime-buffer-entity)
 303                                              field-name)
 304   (save-excursion
 305     (set-buffer (mime-buffer-entity-buffer-internal entity))
 306     (save-restriction
 307       (narrow-to-region (mime-buffer-entity-header-start-internal entity)
 308                         (mime-buffer-entity-header-end-internal entity))
 309       (std11-fetch-field field-name)
 310       )))
 311
 312 (mm-define-method insert-entity-content ((entity buffer))
 313   (insert (with-current-buffer (mime-buffer-entity-buffer-internal entity)
 314             (mime-decode-string
 315              (buffer-substring (mime-buffer-entity-body-start-internal entity)
 316                                (mime-buffer-entity-body-end-internal entity))
 317              (mime-entity-encoding entity)))))
 318
 319 (mm-define-method write-entity-content ((entity buffer) filename)
 320   (save-excursion
 321     (set-buffer (mime-buffer-entity-buffer-internal entity))
 322     (mime-write-decoded-region (mime-buffer-entity-body-start-internal entity)
 323                                (mime-buffer-entity-body-end-internal entity)
 324                                filename
 325                                (or (mime-entity-encoding entity) "7bit"))
 326     ))
 327
 328 (mm-define-method insert-entity ((entity buffer))
 329   (insert-buffer-substring (mime-buffer-entity-buffer-internal entity)
 330                            (mime-buffer-entity-header-start-internal entity)
 331                            (mime-buffer-entity-body-end-internal entity))
 332   )
 333
 334 (mm-define-method write-entity ((entity buffer) filename)
 335   (save-excursion
 336     (set-buffer (mime-buffer-entity-buffer-internal entity))
 337     (write-region-as-raw-text-CRLF
 338      (mime-buffer-entity-header-start-internal entity)
 339      (mime-buffer-entity-body-end-internal entity)
 340      filename)
 341     ))
 342
 343 (mm-define-method write-entity-body ((entity buffer) filename)
 344   (save-excursion
 345     (set-buffer (mime-buffer-entity-buffer-internal entity))
 346     (write-region-as-binary (mime-buffer-entity-body-start-internal entity)
 347                             (mime-buffer-entity-body-end-internal entity)
 348                             filename)
 349     ))
 350
 351
 352 ;;; @ buffer
 353 ;;;
 354
 355 (luna-define-method mime-entity-header-buffer ((entity mime-buffer-entity))
 356   (mime-buffer-entity-buffer-internal entity)
 357   )
 358
 359 (luna-define-method mime-entity-body-buffer ((entity mime-buffer-entity))
 360   (mime-buffer-entity-buffer-internal entity)
 361   )
 362
 363 (luna-define-method mime-entity-buffer ((entity mime-buffer-entity))
 364   (mime-buffer-entity-buffer-internal entity)
 365   )
 366
 367 (luna-define-method mime-entity-body-start-point ((entity mime-buffer-entity))
 368   (mime-buffer-entity-body-start-internal entity)
 369   )
 370
 371 (luna-define-method mime-entity-body-end-point ((entity mime-buffer-entity))
 372   (mime-buffer-entity-body-end-internal entity)
 373   )
 374
 375 (luna-define-method mime-entity-point-min ((entity mime-buffer-entity))
 376   (mime-buffer-entity-header-start-internal entity)
 377   )
 378
 379 (luna-define-method mime-entity-point-max ((entity mime-buffer-entity))
 380   (mime-buffer-entity-body-end-internal entity)
 381   )
 382
 383 (luna-define-method mime-goto-header-start-point ((entity mime-buffer-entity))
 384   (set-buffer (mime-buffer-entity-buffer-internal entity))
 385   (goto-char (mime-buffer-entity-header-start-internal entity))
 386   )
 387
 388 (luna-define-method mime-goto-body-start-point ((entity mime-buffer-entity))
 389   (set-buffer (mime-buffer-entity-buffer-internal entity))
 390   (goto-char (mime-buffer-entity-body-start-internal entity))
 391   )
 392
 393 (luna-define-method mime-goto-body-end-point ((entity mime-buffer-entity))
 394   (set-buffer (mime-buffer-entity-buffer-internal entity))
 395   (goto-char (mime-buffer-entity-body-end-internal entity))
 396   )
 397
 398
 399 ;;; @ utility
 400 ;;;
 401
 402 ;;;###autoload
 403 (defun mime-parse-buffer (&optional buffer representation-type)
 404   "Parse BUFFER as a MIME message.
 405 If buffer is omitted, it parses current-buffer."
 406   (save-excursion
 407     (if buffer (set-buffer buffer))
 408     (setq mime-message-structure
 409           (mime-parse-message (or representation-type 'buffer) nil))
 410     ))
 411
 412
 413 ;;; @ end
 414 ;;;
 415
 416 (provide 'mmbuffer)
 417
 418 ;;; mmbuffer.el ends here