elmo/elmo-mime.el

   1 ;;; elmo-mime.el --- MIME module for ELMO.
   2
   3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
   4
   5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
   6 ;; Keywords: mail, net news
   7
   8 ;; This file is part of ELMO (Elisp Library for Message Orchestration).
   9
  10 ;; This program is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14 ;;
  15 ;; This program is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU 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
  26 ;;; Commentary:
  27 ;;
  28
  29 ;;; Code:
  30 ;;
  31 (require 'elmo-vars)
  32 (require 'mmbuffer)
  33 (require 'mmimap)
  34 (require 'mime-view)
  35
  36 (eval-when-compile
  37   (require 'luna)
  38   (require 'elmo)             ; elmo-folder-do-each-message-entity
  39   (require 'cl))
  40
  41 ;; MIME-Entity
  42 (eval-and-compile
  43   (luna-define-class elmo-mime-entity))
  44
  45 (luna-define-generic elmo-mime-entity-display-p (entity mime-mode)
  46   "Return non-nil if ENTITY is able to display with MIME-MODE.
  47
  48 MIME-MODE is a symbol which is one of the following:
  49   `mime'  (Can display each MIME part)
  50   `as-is' (Can display raw message)")
  51
  52 (luna-define-generic elmo-mime-entity-reassembled-p (entity)
  53   "Return non-nil if ENTITY is reassembled message/partial pieces.")
  54
  55 (luna-define-generic elmo-mime-entity-display (entity preview-buffer
  56                                                       &optional
  57                                                       original-major-mode
  58                                                       keymap)
  59   "Display MIME message ENTITY.
  60 PREVIEW-BUFFER is a view buffer.
  61 Optional argument ORIGINAL-MAJOR-MODE is major-mode of representation
  62 buffer of ENTITY.  If it is nil, current `major-mode' is used.
  63 If optional argument KEYMAP is specified,
  64 use for keymap of representation buffer.")
  65
  66 (luna-define-generic elmo-mime-entity-display-as-is (entity
  67                                                      preview-buffer
  68                                                      &optional
  69                                                      original-major-mode
  70                                                      keymap)
  71   "Display MIME message ENTITY as is.
  72 PREVIEW-BUFFER is a view buffer.
  73 Optional argument ORIGINAL-MAJOR-MODE is major-mode of representation
  74 buffer of ENTITY.  If it is nil, current `major-mode' is used.
  75 If optional argument KEYMAP is specified,
  76 use for keymap of representation buffer.")
  77
  78 (luna-define-method elmo-mime-entity-display ((entity elmo-mime-entity)
  79                                               preview-buffer
  80                                               &optional
  81                                               original-major-mode
  82                                               keymap)
  83   (let ((elmo-message-displaying t))
  84     (mime-display-message entity
  85                           preview-buffer
  86                           nil
  87                           keymap
  88                           original-major-mode)))
  89
  90 (defun elmo-mime-entity-fragment-p (entity)
  91   (and (not (elmo-mime-entity-reassembled-p entity))
  92        (eq (mime-entity-media-type entity) 'message)
  93        (eq (mime-entity-media-subtype entity) 'partial)))
  94
  95 (eval-and-compile
  96   (luna-define-class mime-elmo-buffer-entity (mime-buffer-entity
  97                                               elmo-mime-entity)
  98                      (reassembled))
  99   (luna-define-internal-accessors 'mime-elmo-buffer-entity)
 100   (luna-define-class mime-elmo-imap-entity (mime-imap-entity
 101                                             elmo-mime-entity)))
 102
 103 ;; Provide backend
 104 (provide 'mmelmo-imap)
 105 (provide 'mmelmo-buffer)
 106
 107 (defvar elmo-message-ignored-field-list mime-view-ignored-field-list)
 108 (defvar elmo-message-visible-field-list mime-view-visible-field-list)
 109 (defvar elmo-message-sorted-field-list nil)
 110 (defvar elmo-mime-display-header-analysis t)
 111
 112 (defcustom elmo-mime-header-max-column 'fill-column
 113   "*Header max column number. Default is `fill-colmn'.
 114 If a symbol of variable is specified, use its value in message buffer.
 115 If a symbol of function is specified, the function is called and its return
 116 value is used."
 117   :type '(choice (integer :tag "Column Number")
 118                  (variable :tag "Variable")
 119                  (function :tag "Function"))
 120   :group 'elmo)
 121
 122 (luna-define-method initialize-instance :after ((entity mime-elmo-buffer-entity)
 123                                                 &rest init-args)
 124   entity)
 125
 126 (luna-define-method initialize-instance :around ((entity mime-elmo-imap-entity)
 127                                                  &rest init-args)
 128   (luna-call-next-method))
 129
 130 ;;; Insert sorted header.
 131 (defsubst elmo-mime-insert-header-from-buffer (buffer
 132                                                start end
 133                                                &optional invisible-fields
 134                                                visible-fields
 135                                                sort-fields)
 136   (let ((the-buf (current-buffer))
 137         (max-column (cond ((functionp elmo-mime-header-max-column)
 138                            (funcall elmo-mime-header-max-column))
 139                           ((and (symbolp elmo-mime-header-max-column)
 140                                 (boundp elmo-mime-header-max-column))
 141                            (symbol-value elmo-mime-header-max-column))
 142                           (t
 143                            elmo-mime-header-max-column)))
 144         vf-alist)
 145     (save-excursion
 146       (set-buffer buffer)
 147       (save-restriction
 148         (narrow-to-region start end)
 149         (goto-char start)
 150         (while (re-search-forward std11-field-head-regexp nil t)
 151           (let* ((field-start (match-beginning 0))
 152                  (name-end (match-end 0))
 153                  (field-name (buffer-substring field-start name-end)))
 154             (when (mime-visible-field-p field-name
 155                                         visible-fields invisible-fields)
 156               (let* ((field (intern
 157                              (capitalize
 158                               (buffer-substring field-start (1- name-end)))))
 159                      (field-body (buffer-substring name-end (std11-field-end)))
 160                      (field-decoder
 161                       (and elmo-mime-display-header-analysis
 162                            (inline (mime-find-field-decoder field 'wide)))))
 163                 (setq vf-alist (cons (list field-name field-body field-decoder)
 164                                      vf-alist)))))))
 165       (and vf-alist
 166            (setq vf-alist
 167                  (sort vf-alist
 168                        (lambda (s d)
 169                          (let ((sf (car s))
 170                                (df (car d)))
 171                            (catch 'done
 172                              (dolist (re sort-fields)
 173                                (when (string-match re sf)
 174                                  (throw 'done t))
 175                                (when (string-match re df)
 176                                  (throw 'done nil)))
 177                              t))))))
 178       (set-buffer the-buf)
 179       (while vf-alist
 180         (let* ((vf (car vf-alist))
 181                (field-name (nth 0 vf))
 182                (field-body (nth 1 vf))
 183                (field-decoder (nth 2 vf)))
 184           (insert field-name)
 185           (insert (or (and field-decoder
 186                            (ignore-errors
 187                             (funcall field-decoder field-body
 188                                      (string-width field-name)
 189                                      max-column)))
 190                       ;; Don't decode
 191                       field-body))
 192           (insert "\n"))
 193         (setq vf-alist (cdr vf-alist)))
 194       (run-hooks 'mmelmo-header-inserted-hook))))
 195
 196 (luna-define-generic elmo-mime-insert-sorted-header (entity
 197                                                      &optional invisible-fields
 198                                                      visible-fields
 199                                                      sorted-fields)
 200   "Insert sorted header fields of the ENTITY.")
 201
 202 (luna-define-method elmo-mime-insert-sorted-header ((entity
 203                                                      mime-elmo-buffer-entity)
 204                                                     &optional invisible-fields
 205                                                     visible-fields
 206                                                     sorted-fields)
 207   (elmo-mime-insert-header-from-buffer
 208    (mime-buffer-entity-buffer-internal entity)
 209    (mime-buffer-entity-header-start-internal entity)
 210    (mime-buffer-entity-header-end-internal entity)
 211    invisible-fields visible-fields sorted-fields))
 212
 213 (luna-define-method elmo-mime-insert-sorted-header ((entity
 214                                                      mime-elmo-imap-entity)
 215                                                     &optional invisible-fields
 216                                                     visible-fields
 217                                                     sorted-fields)
 218   (let ((the-buf (current-buffer))
 219         buf p-min p-max)
 220     (with-temp-buffer
 221       (insert (mime-imap-entity-header-string entity))
 222       (setq buf (current-buffer)
 223             p-min (point-min)
 224             p-max (point-max))
 225       (set-buffer the-buf)
 226       (elmo-mime-insert-header-from-buffer buf p-min p-max
 227                                            invisible-fields
 228                                            visible-fields
 229                                            sorted-fields))))
 230
 231 (luna-define-method mime-insert-text-content :around
 232   ((entity mime-elmo-buffer-entity))
 233   (luna-call-next-method)
 234   (run-hooks 'elmo-message-text-content-inserted-hook))
 235
 236 (luna-define-method mime-insert-text-content :around
 237   ((entity mime-elmo-imap-entity))
 238   (luna-call-next-method)
 239   (run-hooks 'elmo-message-text-content-inserted-hook))
 240
 241 (defun elmo-mime-insert-header (entity situation)
 242   (elmo-mime-insert-sorted-header
 243    entity
 244    elmo-message-ignored-field-list
 245    elmo-message-visible-field-list
 246    elmo-message-sorted-field-list)
 247   (run-hooks 'elmo-message-header-inserted-hook))
 248
 249 ;; mime-elmo-buffer-entity
 250 (luna-define-method elmo-mime-entity-display-p
 251   ((entity mime-elmo-buffer-entity) mime-mode)
 252   ;; always return t.
 253   t)
 254
 255 (luna-define-method elmo-mime-entity-reassembled-p ((entity
 256                                                      mime-elmo-buffer-entity))
 257   (mime-elmo-buffer-entity-reassembled-internal entity))
 258
 259 (luna-define-method elmo-mime-entity-display-as-is ((entity
 260                                                      mime-elmo-buffer-entity)
 261                                                      preview-buffer
 262                                                      &optional
 263                                                      original-major-mode
 264                                                      keymap)
 265   (elmo-mime-display-as-is-internal entity
 266                                     preview-buffer
 267                                     nil
 268                                     keymap
 269                                     original-major-mode))
 270
 271 ;; mime-elmo-imap-entity
 272 (luna-define-method elmo-mime-entity-display-p
 273   ((entity mime-elmo-imap-entity) mime-mode)
 274   (not (eq mime-mode 'as-is)))
 275
 276 (luna-define-method elmo-mime-entity-display-as-is ((entity
 277                                                      mime-elmo-imap-entity)
 278                                                      preview-buffer
 279                                                      &optional
 280                                                      original-major-mode
 281                                                      keymap)
 282   (error "Does not support this method"))
 283
 284
 285 (defun elmo-message-mime-entity (folder number rawbuf reassemble
 286                                         &optional
 287                                         ignore-cache unread entire)
 288   "Return the mime-entity structure of the message in the FOLDER with NUMBER.
 289 RAWBUF is the output buffer for original message.
 290 If REASSEMBLE is non-nil and MIME media type of the message is message/partial,
 291 the mime-entity is reassembled partial message.
 292 If optional argument IGNORE-CACHE is non-nil, existing cache is ignored.
 293 If second optional argument UNREAD is non-nil,
 294 keep status of the message as unread.
 295 If third optional argument ENTIRE is non-nil, fetch entire message at once."
 296   (let (id message entity content-type)
 297     (or (and reassemble
 298              (setq entity (elmo-message-entity folder number))
 299              (setq id (if (setq content-type (elmo-message-entity-field
 300                                               entity 'content-type))
 301                           (and (string-match "message/partial" content-type)
 302                                (mime-content-type-parameter
 303                                 (mime-parse-Content-Type content-type) "id"))
 304                         (and (setq message (elmo-message-mime-entity-internal
 305                                             folder number rawbuf
 306                                             ignore-cache unread entire))
 307                              (eq (mime-entity-media-type message) 'message)
 308                              (eq (mime-entity-media-subtype message) 'partial)
 309                              (mime-content-type-parameter
 310                               (mime-entity-content-type message) "id"))))
 311              (elmo-message-reassembled-mime-entity
 312               folder id rawbuf
 313               (elmo-message-entity-field entity 'subject)
 314               ignore-cache
 315               unread))
 316         message
 317         (elmo-message-mime-entity-internal
 318          folder number rawbuf ignore-cache unread entire))))
 319
 320
 321 (defun elmo-message-mime-entity-internal (folder number rawbuf
 322                                                  &optional
 323                                                  ignore-cache unread entire)
 324   (let ((strategy (elmo-find-fetch-strategy folder number
 325                                             ignore-cache
 326                                             entire)))
 327     (cond ((null strategy) nil)
 328           ((eq (elmo-fetch-strategy-entireness strategy) 'section)
 329            (mime-open-entity
 330             'elmo-imap
 331             (luna-make-entity 'mime-elmo-imap-location
 332                               :folder folder
 333                               :number number
 334                               :rawbuf rawbuf
 335                               :strategy strategy)))
 336           (t
 337            (with-current-buffer rawbuf
 338              (let (buffer-read-only)
 339                (erase-buffer)
 340                (elmo-message-fetch folder number strategy unread)))
 341            (mime-open-entity 'elmo-buffer rawbuf)))))
 342
 343
 344 (defconst elmo-mime-inherit-field-list-from-enclosed
 345   '("^Content-.*:" "^Message-Id:" "^Subject:"
 346     "^Encrypted.*:" "^MIME-Version:"))
 347
 348 (defsubst elmo-mime-make-reassembled-mime-entity (buffer)
 349   (let ((entity (mime-open-entity 'elmo-buffer buffer)))
 350     (mime-elmo-buffer-entity-set-reassembled-internal entity t)
 351     entity))
 352
 353 (defun elmo-message-reassembled-mime-entity (folder id rawbuf subject
 354                                                     &optional
 355                                                     ignore-cache
 356                                                     unread)
 357   (let ((cache (elmo-file-cache-get (concat "<" id ">")))
 358         pieces)
 359     (if (and (not ignore-cache)
 360              (eq (elmo-file-cache-status cache) 'entire))
 361         ;; use cache
 362         (with-current-buffer rawbuf
 363           (let (buffer-read-only)
 364             (erase-buffer)
 365             (elmo-file-cache-load (elmo-file-cache-path cache) nil))
 366           (elmo-mime-make-reassembled-mime-entity rawbuf))
 367       ;; reassemble fragment of the entity
 368       (when (setq pieces (elmo-mime-collect-message/partial-pieces
 369                           folder id
 370                           (regexp-quote
 371                            (if (string-match "[0-9\n]+" subject)
 372                                (substring subject 0 (match-beginning 0))
 373                              subject))
 374                           ignore-cache unread))
 375         (with-current-buffer rawbuf
 376           (let (buffer-read-only
 377                 (outer-header (car pieces))
 378                 (pieces (sort (cdr pieces) (lambda (l r) (< (car l) (car r)))))
 379                 contents entity)
 380             (erase-buffer)
 381             (while pieces
 382               (insert (cdr (car pieces)))
 383               (setq pieces (cdr pieces)))
 384             (let ((case-fold-search t))
 385               (save-restriction
 386                 (std11-narrow-to-header)
 387                 (goto-char (point-min))
 388                 (while (re-search-forward std11-field-head-regexp nil t)
 389                   (let ((field-start (match-beginning 0)))
 390                     (unless (mime-visible-field-p
 391                              (buffer-substring field-start (match-end 0))
 392                              elmo-mime-inherit-field-list-from-enclosed
 393                              '(".*"))
 394                       (delete-region field-start (1+ (std11-field-end))))))))
 395             (goto-char (point-min))
 396             (insert outer-header)
 397             ;; save cache
 398             (elmo-file-cache-save (elmo-file-cache-path cache) nil)
 399             (elmo-mime-make-reassembled-mime-entity rawbuf)))))))
 400
 401 (defun elmo-mime-collect-message/partial-pieces (folder id subject-regexp
 402                                                         &optional
 403                                                         ignore-cache
 404                                                         unread)
 405   (catch 'complete
 406     (with-temp-buffer
 407       (set-buffer-multibyte nil)
 408       (let (total header pieces)
 409         (elmo-folder-do-each-message-entity (entity folder)
 410           (when (string-match
 411                  subject-regexp
 412                  (elmo-message-entity-field entity 'subject))
 413             (erase-buffer)
 414             (let* ((message (elmo-message-mime-entity-internal
 415                              folder
 416                              (elmo-message-entity-number entity)
 417                              (current-buffer)
 418                              ignore-cache
 419                              unread))
 420                    (ct (mime-entity-content-type message))
 421                    (the-id (or (mime-content-type-parameter ct "id") ""))
 422                    number)
 423               (when (string= (downcase the-id)
 424                              (downcase id))
 425                 (setq number (string-to-number
 426                               (mime-content-type-parameter ct "number")))
 427                 (setq pieces (cons (cons number (mime-entity-body message))
 428                                    pieces))
 429                 (when (= number 1)
 430                   (let ((case-fold-search t))
 431                     (save-restriction
 432                       (std11-narrow-to-header)
 433                       (goto-char (point-min))
 434                       (while (re-search-forward std11-field-head-regexp nil t)
 435                         (let ((field-start (match-beginning 0)))
 436                           (when (mime-visible-field-p
 437                                  (buffer-substring field-start (match-end 0))
 438                                  nil
 439                                  elmo-mime-inherit-field-list-from-enclosed)
 440                             (setq header (concat
 441                                           header
 442                                           (buffer-substring
 443                                            field-start (std11-field-end))
 444                                           "\n"))))))))
 445                 (unless total
 446                   (setq total (ignore-errors
 447                                 (string-to-number
 448                                  (mime-content-type-parameter ct "total")))))
 449                 (when (and total
 450                            (> total 0)
 451                            (>= (length pieces) total))
 452                   (throw 'complete (cons header pieces)))))))))
 453     ;; return value
 454     nil))
 455
 456
 457 ;; Replacement of mime-display-message.
 458 (defun elmo-mime-display-as-is-internal (message
 459                                          &optional preview-buffer
 460                                          mother default-keymap-or-function
 461                                          original-major-mode keymap)
 462   (mime-maybe-hide-echo-buffer)
 463   (let ((win-conf (current-window-configuration)))
 464     (or preview-buffer
 465         (setq preview-buffer
 466               (concat "*Preview-" (mime-entity-name message) "*")))
 467     (or original-major-mode
 468         (setq original-major-mode major-mode))
 469     (let ((inhibit-read-only t))
 470       (set-buffer (get-buffer-create preview-buffer))
 471       (widen)
 472       (erase-buffer)
 473       (if mother
 474           (setq mime-mother-buffer mother))
 475       (setq mime-preview-original-window-configuration win-conf)
 476       (setq major-mode 'mime-view-mode)
 477       (setq mode-name "MIME-View")
 478
 479       ;; Humm...
 480       (set-buffer-multibyte nil)
 481       (insert (mime-entity-body message))
 482       (set-buffer-multibyte t)
 483       (decode-coding-region (point-min) (point-max)
 484                             elmo-mime-display-as-is-coding-system)
 485       (goto-char (point-min))
 486       (insert "\n")
 487       (goto-char (point-min))
 488
 489       (let ((method (cdr (assq original-major-mode
 490                                mime-header-presentation-method-alist))))
 491         (if (functionp method)
 492             (funcall method message nil)))
 493
 494       ;; set original major mode for mime-preview-quit
 495       (put-text-property (point-min) (point-max)
 496                          'mime-view-situation
 497                          `((major-mode . ,original-major-mode)))
 498       (put-text-property (point-min) (point-max)
 499                          'elmo-as-is-entity message)
 500       (use-local-map
 501        (or keymap
 502            (if default-keymap-or-function
 503                (mime-view-define-keymap default-keymap-or-function)
 504              mime-view-mode-default-map)))
 505       (goto-char (point-min))
 506       (search-forward "\n\n" nil t)
 507       (run-hooks 'mime-view-mode-hook)
 508       (set-buffer-modified-p nil)
 509       (setq buffer-read-only t)
 510       preview-buffer)))
 511
 512 (require 'product)
 513 (product-provide (provide 'elmo-mime) (require 'elmo-version))
 514
 515 ;; elmo-mime.el ends here