wl/wl-mime.el

   1 ;;; wl-mime.el --- SEMI implementations of MIME processing on Wanderlust.
   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 Wanderlust (Yet Another Message Interface on Emacsen).
   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
  32 (require 'mime-view)
  33 (require 'mime-edit)
  34 (require 'mime-play)
  35 (require 'elmo)
  36
  37 ;;; Draft
  38
  39 (defalias 'wl-draft-editor-mode 'mime-edit-mode)
  40
  41 (defalias 'wl-draft-decode-message-in-buffer
  42   'mime-edit-decode-message-in-buffer)
  43
  44 (defun wl-draft-yank-current-message-entity ()
  45   "Yank currently displayed message entity.
  46 By setting following-method as yank-content.
  47
  48 If region is active, yank region contents instead. \(this feature is available
  49 if and only if `transient-mark-mode' \(GNU Emacs\) or `zmacs-regions' \(XEmacs\)
  50 has Non-nil value\)"
  51   (let ((wl-draft-buffer (current-buffer))
  52         (mime-view-following-method-alist
  53          (list (cons 'wl-original-message-mode
  54                      (function wl-draft-yank-to-draft-buffer))))
  55         (mime-preview-following-method-alist
  56          (list (cons 'wl-original-message-mode
  57                      (function wl-draft-yank-to-draft-buffer)))))
  58     (if (get-buffer (wl-current-message-buffer))
  59         (save-excursion
  60           (set-buffer (wl-current-message-buffer))
  61           (save-restriction
  62             (widen)
  63             (if (wl-region-exists-p)
  64                 (wl-mime-preview-follow-current-region)
  65               (mime-preview-follow-current-entity)))))))
  66
  67 ;; modified mime-preview-follow-current-entity from mime-view.el
  68 (defun wl-mime-preview-follow-current-region ()
  69   "Write follow message to current region.
  70 It calls following-method selected from variable
  71 `mime-preview-following-method-alist'."
  72   (interactive)
  73   (let ((r-beg (region-beginning))
  74         (r-end (region-end))
  75         (entity (get-text-property (point-min)
  76                                    'mime-view-entity)))
  77     (let* ((mode (mime-preview-original-major-mode 'recursive))
  78            (new-name
  79             (format "%s-active-region" (buffer-name)))
  80            new-buf
  81            (the-buf (current-buffer))
  82            fields)
  83       (save-excursion
  84         (set-buffer (setq new-buf (get-buffer-create new-name)))
  85         (erase-buffer)
  86         (insert ?\n)
  87         (insert-buffer-substring the-buf r-beg r-end)
  88         (goto-char (point-min))
  89         (let ((current-entity
  90                (if (and (eq (mime-entity-media-type entity) 'message)
  91                         (eq (mime-entity-media-subtype entity) 'rfc822))
  92                    (car (mime-entity-children entity))
  93                  entity)))
  94           (while (and current-entity
  95                       (if (and (eq (mime-entity-media-type
  96                                     current-entity) 'message)
  97                                (eq (mime-entity-media-subtype
  98                                     current-entity) 'rfc822))
  99                           nil
 100                         (mime-insert-header current-entity fields)
 101                         t))
 102             (setq fields (std11-collect-field-names)
 103                   current-entity (mime-entity-parent current-entity))
 104             ))
 105         (let ((rest mime-view-following-required-fields-list)
 106               field-name ret)
 107           (while rest
 108             (setq field-name (car rest))
 109             (or (std11-field-body field-name)
 110                 (progn
 111                   (save-excursion
 112                     (set-buffer the-buf)
 113                     (let ((entity (when mime-mother-buffer
 114                                     (set-buffer mime-mother-buffer)
 115                                     (get-text-property (point)
 116                                                        'mime-view-entity))))
 117                       (while (and entity
 118                                   (null (setq ret (mime-entity-fetch-field
 119                                                    entity field-name))))
 120                         (setq entity (mime-entity-parent entity)))))
 121                   (if ret
 122                       (insert (concat field-name ": " ret "\n"))
 123                     )))
 124             (setq rest (cdr rest))
 125             ))
 126         )
 127       (let ((f (cdr (assq mode mime-preview-following-method-alist))))
 128         (if (functionp f)
 129             (funcall f new-buf)
 130           (message
 131            "Sorry, following method for %s is not implemented yet."
 132            mode)
 133           ))
 134       )))
 135
 136 (defalias 'wl-draft-enclose-digest-region 'mime-edit-enclose-digest-region)
 137
 138 (defun wl-draft-preview-message ()
 139   "Preview editing message."
 140   (interactive)
 141   (let* (recipients-message
 142          (current-point (point))
 143          (config-exec-flag wl-draft-config-exec-flag)
 144          (parent-folder wl-draft-parent-folder)
 145          (mime-display-header-hook 'wl-highlight-headers)
 146          (mime-header-encode-method-alist
 147           (append
 148            '((wl-draft-eword-encode-address-list
 149               .  (To Cc Bcc Resent-To Resent-Cc Resent-Bcc From)))
 150            (if (boundp 'mime-header-encode-method-alist)
 151                (symbol-value 'mime-header-encode-method-alist))))
 152          mime-view-ignored-field-list   ; all header.
 153          (mime-edit-translate-buffer-hook
 154           (append
 155            (list
 156             (function
 157              (lambda ()
 158                (let ((wl-draft-config-exec-flag config-exec-flag)
 159                      (wl-draft-parent-folder parent-folder))
 160                  (goto-char current-point)
 161                  (run-hooks 'wl-draft-send-hook)
 162                  (setq recipients-message
 163                        (condition-case err
 164                            (concat "Recipients: "
 165                                    (mapconcat
 166                                     'identity
 167                                     (wl-draft-deduce-address-list
 168                                      (current-buffer)
 169                                      (point-min)
 170                                      (save-excursion
 171                                        (goto-char (point-min))
 172                                        (re-search-forward
 173                                         (concat
 174                                          "^"
 175                                          (regexp-quote mail-header-separator)
 176                                          "$")
 177                                         nil t)
 178                                        (point)))
 179                                     ", "))
 180                          (error
 181                           (kill-buffer (current-buffer))
 182                           (signal (car err) (cdr err)))))))))
 183            mime-edit-translate-buffer-hook)))
 184     (mime-edit-preview-message)
 185     (let ((buffer-read-only nil))
 186       (when wl-highlight-body-too
 187         (wl-highlight-body))
 188       (run-hooks 'wl-draft-preview-message-hook))
 189     (message "%s" recipients-message)))
 190
 191 (defalias 'wl-draft-caesar-region  'mule-caesar-region)
 192
 193 (defalias 'wl-draft-insert-message 'mime-edit-insert-message)
 194
 195 (defalias 'wl-draft-insert-mail 'mime-edit-insert-mail)
 196
 197 ;;; Message
 198
 199 (defun wl-message-decode-mode (outbuf inbuf)
 200   (let ((mime-view-content-header-filter-hook 'wl-highlight-headers)
 201         (mime-display-header-hook 'wl-highlight-headers))
 202     (mime-view-mode nil nil nil inbuf outbuf)))
 203
 204 (defun wl-message-decode-with-all-header (outbuf inbuf)
 205   (let ((mime-view-ignored-field-regexp "^:$")
 206         (mime-view-content-header-filter-hook 'wl-highlight-headers)
 207         (mime-display-header-hook 'wl-highlight-headers)
 208         mime-view-ignored-field-list)
 209     (mime-view-mode nil nil nil inbuf outbuf)))
 210
 211 (defun wl-message-delete-mime-out-buf ()
 212   (let (mime-out-buf mime-out-win)
 213     (if (setq mime-out-buf (get-buffer mime-echo-buffer-name))
 214         (if (setq mime-out-win (get-buffer-window mime-out-buf))
 215             (delete-window mime-out-win)))))
 216
 217 (defun wl-message-request-partial (folder number)
 218   (elmo-set-work-buf
 219    (elmo-message-fetch (wl-folder-get-elmo-folder folder)
 220                        number
 221                        (elmo-make-fetch-strategy 'entire)
 222                        nil
 223                        (current-buffer)
 224                        'unread)
 225    (mime-parse-buffer nil)))
 226
 227 (defalias 'wl-message-read              'mime-preview-scroll-up-entity)
 228 (defalias 'wl-message-next-content      'mime-preview-move-to-next)
 229 (defalias 'wl-message-prev-content      'mime-preview-move-to-previous)
 230 (defalias 'wl-message-play-content      'mime-preview-play-current-entity)
 231 (defalias 'wl-message-extract-content   'mime-preview-extract-current-entity)
 232 (defalias 'wl-message-quit              'mime-preview-quit)
 233 (defalias 'wl-message-button-dispatcher-internal
 234   'mime-button-dispatcher)
 235
 236 (defsubst wl-mime-node-id-to-string (node-id)
 237   (if (consp node-id)
 238       (mapconcat (function (lambda (num) (format "%s" (1+ num))))
 239                  (reverse node-id)
 240                  ".")
 241     "0"))
 242
 243 (defun wl-message-delete-current-part ()
 244   "Delete a part under the cursor from the multipart message."
 245   (interactive)
 246   (save-restriction
 247     (widen)
 248     (let* ((entity (get-text-property (point) 'mime-view-entity))
 249            (node-id (mime-entity-node-id entity))
 250            (header-start (mime-buffer-entity-header-start-internal entity))
 251            (body-end (mime-buffer-entity-body-end-internal entity))
 252            (folder (wl-folder-get-elmo-folder wl-message-buffer-cur-folder))
 253            (number wl-message-buffer-cur-number)
 254            (msgid (elmo-message-field folder number 'message-id))
 255            (orig-buf wl-message-buffer-original-buffer))
 256       (if (eq (luna-class-name entity) 'mime-elmo-imap-entity)
 257           (error "Please fetch the entire message (by typing 'C-u .') and try again"))
 258       (with-current-buffer orig-buf
 259         (unless (string-equal
 260                  (buffer-string)
 261                  (elmo-message-fetch folder number
 262                                      (elmo-make-fetch-strategy 'entire)))
 263           (error "Buffer content differs from actual message")))
 264       (when (and (elmo-folder-writable-p folder)
 265                  (buffer-live-p orig-buf)
 266                  node-id
 267                  (yes-or-no-p
 268                   (format "Do you really want to delete part %s? "
 269                           (wl-mime-node-id-to-string node-id))))
 270         (with-temp-buffer
 271           (insert-buffer orig-buf)
 272           (delete-region header-start body-end)
 273           (goto-char header-start)
 274           (insert "Content-Type: text/plain; charset=US-ASCII\n\n")
 275           (insert "** This part has been removed by Wanderlust **\n\n")
 276           (elmo-folder-append-buffer folder t))
 277
 278         (elmo-folder-append-messages
 279          (wl-folder-get-elmo-folder wl-trash-folder)
 280          folder (list number) nil)
 281         (elmo-folder-delete-messages folder (list number))
 282
 283         (when (file-exists-p (elmo-cache-get-path msgid))
 284           (delete-file (elmo-cache-get-path msgid)))
 285
 286         (mime-preview-quit)
 287         (wl-summary-toggle-disp-msg 'off)
 288         (wl-summary-sync nil "update")))))
 289
 290 ;;; Summary
 291 (defun wl-summary-burst-subr (message-entity target number)
 292   ;; returns new number.
 293   (let (content-type entity)
 294     (setq content-type (mime-entity-content-type message-entity))
 295     (cond ((eq (cdr (assq 'type content-type)) 'multipart)
 296            (dolist (entity (mime-entity-children message-entity))
 297              (setq number (wl-summary-burst-subr
 298                            entity
 299                            target
 300                            number))))
 301           ((and (eq (cdr (assq 'type content-type)) 'message)
 302                 (eq (cdr (assq 'subtype content-type)) 'rfc822))
 303            (message "Bursting...%s" (setq number (+ 1 number)))
 304            (setq entity
 305                  (car (mime-entity-children message-entity)))
 306            (with-temp-buffer
 307              (insert (mime-entity-body message-entity))
 308              (elmo-folder-append-buffer
 309               target
 310               (mime-entity-fetch-field entity "Message-ID")))))
 311     number))
 312
 313 (defun wl-summary-burst (&optional arg)
 314   "De-capsulate embedded messages in MIME format.
 315 With ARG, ask destination folder."
 316   (interactive "P")
 317   (let ((raw-buf (wl-summary-get-original-buffer))
 318         (view-buf wl-message-buffer)
 319         children message-entity content-type target)
 320     (save-excursion
 321       (setq target wl-summary-buffer-elmo-folder)
 322       (when (or arg (not (elmo-folder-writable-p target)))
 323         (let ((fld (wl-summary-read-folder wl-default-folder "to extract to")))
 324           (setq target (wl-folder-get-elmo-folder fld))))
 325       (wl-summary-set-message-buffer-or-redisplay)
 326       (with-current-buffer view-buf
 327         (setq message-entity (get-text-property (point-min) 'mime-view-entity)))
 328       (when message-entity
 329         (message "Bursting...")
 330         (with-current-buffer raw-buf
 331           (wl-summary-burst-subr message-entity target 0))
 332         (message "Bursting...done"))
 333       (if (elmo-folder-plugged-p target)
 334           (elmo-folder-check target)))
 335     (wl-summary-sync-update)))
 336
 337 ;; internal variable.
 338 (defvar wl-mime-save-directory nil "Last saved directory.")
 339 ;;; Yet another save method.
 340 (defun wl-mime-save-content (entity situation)
 341   (let ((filename (read-file-name "Save to file: "
 342                                   (expand-file-name
 343                                    (or (mime-entity-safe-filename entity)
 344                                        ".")
 345                                    (or wl-mime-save-directory
 346                                        wl-temporary-file-directory)))))
 347     (while (file-directory-p filename)
 348       (setq filename (read-file-name "Please set filename (not directory): "
 349                                      filename)))
 350     (if (and (file-exists-p filename)
 351              (not (yes-or-no-p (format "File %s exists. Save anyway? "
 352                                        filename))))
 353         (message "Not saved")
 354       (setq wl-mime-save-directory (file-name-directory filename))
 355       (mime-write-entity-content entity filename))))
 356
 357 ;;; Yet another combine method.
 358 (defun wl-mime-combine-message/partial-pieces (entity situation)
 359   "Internal method for wl to combine message/partial messages automatically."
 360   (interactive)
 361   (let* ((msgdb (save-excursion
 362                   (set-buffer wl-message-buffer-cur-summary-buffer)
 363                   (wl-summary-buffer-msgdb)))
 364          (mime-display-header-hook 'wl-highlight-headers)
 365          (folder wl-message-buffer-cur-folder)
 366          (id (or (cdr (assoc "id" situation)) ""))
 367          (mother (current-buffer))
 368          (summary-buf wl-message-buffer-cur-summary-buffer)
 369          subject-id overviews
 370          (root-dir (expand-file-name
 371                     (concat "m-prts-" (user-login-name))
 372                     temporary-file-directory))
 373          full-file point)
 374     (setq root-dir (concat root-dir "/" (replace-as-filename id)))
 375     (setq full-file (concat root-dir "/FULL"))
 376     (if (or (file-exists-p full-file)
 377             (not (y-or-n-p "Merge partials? ")))
 378         (with-current-buffer mother
 379           (mime-store-message/partial-piece entity situation)
 380           (setq wl-message-buffer-cur-summary-buffer summary-buf)
 381           (make-variable-buffer-local 'mime-preview-over-to-next-method-alist)
 382           (setq mime-preview-over-to-next-method-alist
 383                 (cons (cons 'mime-show-message-mode 'wl-message-exit)
 384                       mime-preview-over-to-next-method-alist))
 385           (make-variable-buffer-local 'mime-preview-over-to-previous-method-alist)
 386           (setq mime-preview-over-to-previous-method-alist
 387                 (cons (cons 'mime-show-message-mode 'wl-message-exit)
 388                       mime-preview-over-to-previous-method-alist)))
 389       (setq subject-id
 390             (eword-decode-string
 391              (decode-mime-charset-string
 392               (mime-entity-read-field entity 'Subject)
 393               wl-summary-buffer-mime-charset)))
 394       (if (string-match "[0-9\n]+" subject-id)
 395           (setq subject-id (substring subject-id 0 (match-beginning 0))))
 396       (setq overviews (elmo-msgdb-get-overview msgdb))
 397       (catch 'tag
 398         (while overviews
 399           (when (string-match
 400                  (regexp-quote subject-id)
 401                  (elmo-msgdb-overview-entity-get-subject (car overviews)))
 402             (let* ((message
 403                     ;; request message at the cursor in Subject buffer.
 404                     (wl-message-request-partial
 405                      folder
 406                      (elmo-msgdb-overview-entity-get-number
 407                       (car overviews))))
 408                    (situation (mime-entity-situation message))
 409                    (the-id (or (cdr (assoc "id" situation)) "")))
 410               (when (string= (downcase the-id)
 411                              (downcase id))
 412                 (with-current-buffer mother
 413                   (mime-store-message/partial-piece message situation))
 414                 (if (file-exists-p full-file)
 415                     (throw 'tag nil)))))
 416           (setq overviews (cdr overviews)))
 417         (message "Not all partials found.")))))
 418
 419 (defun wl-mime-display-text/plain (entity situation)
 420   (let ((beg (point)))
 421     (mime-display-text/plain entity situation)
 422     (wl-highlight-message beg (point-max) t t)))
 423
 424 (defun wl-mime-display-header (entity situation)
 425   (let ((elmo-message-ignored-field-list
 426          (if wl-message-buffer-all-header-flag
 427              nil
 428            wl-message-ignored-field-list))
 429         (elmo-message-visible-field-list wl-message-visible-field-list)
 430         (elmo-message-sorted-field-list wl-message-sort-field-list))
 431     (elmo-mime-insert-header entity situation)
 432     (wl-highlight-headers)))
 433
 434 (defun wl-mime-decrypt-application/pgp-encrypted (entity situation)
 435   (let ((summary-buffer wl-message-buffer-cur-summary-buffer)
 436         (original-buffer wl-message-buffer-original-buffer))
 437     (mime-decrypt-application/pgp-encrypted entity situation)
 438     (setq wl-message-buffer-cur-summary-buffer summary-buffer)
 439     (setq wl-message-buffer-original-buffer original-buffer)))
 440
 441
 442 ;;; Setup methods.
 443 (defun wl-mime-setup ()
 444   (set-alist 'mime-preview-quitting-method-alist
 445              'wl-original-message-mode 'wl-message-exit)
 446   (set-alist 'mime-view-over-to-previous-method-alist
 447              'wl-original-message-mode 'wl-message-exit)
 448   (set-alist 'mime-view-over-to-next-method-alist
 449              'wl-original-message-mode 'wl-message-exit)
 450   (set-alist 'mime-preview-over-to-previous-method-alist
 451              'wl-original-message-mode 'wl-message-exit)
 452   (set-alist 'mime-preview-over-to-next-method-alist
 453              'wl-original-message-mode 'wl-message-exit)
 454   (add-hook 'wl-summary-redisplay-hook 'wl-message-delete-mime-out-buf)
 455   (add-hook 'wl-message-exit-hook 'wl-message-delete-mime-out-buf)
 456
 457   (ctree-set-calist-strictly
 458    'mime-preview-condition
 459    '((type . text) (subtype . plain)
 460      (body . visible)
 461      (body-presentation-method . wl-mime-display-text/plain)
 462      (major-mode . wl-original-message-mode)))
 463
 464   (ctree-set-calist-strictly
 465    'mime-acting-condition
 466    '((type . message) (subtype . partial)
 467      (method .  wl-mime-combine-message/partial-pieces)
 468      (request-partial-message-method . wl-message-request-partial)
 469      (major-mode . wl-original-message-mode)))
 470
 471   (ctree-set-calist-strictly
 472    'mime-acting-condition
 473    '((type . application) (subtype . pgp-encrypted)
 474      (method . wl-mime-decrypt-application/pgp-encrypted)
 475      (major-mode . wl-original-message-mode)))
 476
 477   (ctree-set-calist-strictly
 478    'mime-acting-condition
 479    '((mode . "extract")
 480      (major-mode . wl-original-message-mode)
 481      (method . wl-mime-save-content)))
 482   (set-alist 'mime-preview-following-method-alist
 483              'wl-original-message-mode
 484              (function wl-message-follow-current-entity))
 485   (set-alist 'mime-view-following-method-alist
 486              'wl-original-message-mode
 487              (function wl-message-follow-current-entity))
 488   (set-alist 'mime-edit-message-inserter-alist
 489              'wl-draft-mode (function wl-draft-insert-current-message))
 490   (set-alist 'mime-edit-mail-inserter-alist
 491              'wl-draft-mode (function wl-draft-insert-get-message))
 492   (set-alist 'mime-edit-split-message-sender-alist
 493              'wl-draft-mode
 494              (cdr (assq 'mail-mode mime-edit-split-message-sender-alist)))
 495   (set-alist 'mime-raw-representation-type-alist
 496              'wl-original-message-mode 'binary)
 497   ;; Sort and highlight header fields.
 498   (or wl-message-ignored-field-list
 499       (setq wl-message-ignored-field-list
 500             mime-view-ignored-field-list))
 501   (or wl-message-visible-field-list
 502       (setq wl-message-visible-field-list
 503             mime-view-visible-field-list))
 504   (set-alist 'mime-header-presentation-method-alist
 505              'wl-original-message-mode
 506              'wl-mime-display-header)
 507   ;; To avoid overriding wl-draft-mode-map.
 508   (when (boundp 'mime-setup-signature-key-alist)
 509     (unless (assq 'wl-draft-mode mime-setup-signature-key-alist)
 510       (setq mime-setup-signature-key-alist
 511             (cons '(wl-draft-mode . "\C-c\C-w")
 512                   mime-setup-signature-key-alist)))))
 513
 514 (require 'product)
 515 (product-provide (provide 'wl-mime) (require 'wl-version))
 516
 517 ;;; wl-mime.el ends here