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