Checkdoc.
[elisp/wanderlust.git] / wl / wl-mime.el
1 ;;; wl-mime.el -- SEMI implementations of MIME processing on Wanderlust.
2
3 ;; Copyright 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 'mmelmo)
36
37 (eval-when-compile
38   (defalias-maybe 'Meadow-version 'ignore))
39
40 (defvar xemacs-betaname)
41 (defvar xemacs-codename)
42 (defvar enable-multibyte-characters)
43 (defvar mule-version)
44
45 ;;; Draft
46
47 (defalias 'wl-draft-editor-mode 'mime-edit-mode)
48
49 (defalias 'wl-draft-decode-message-in-buffer
50   'mime-edit-decode-message-in-buffer)
51
52 (defun wl-draft-yank-current-message-entity ()
53   "Yank currently displayed message entity.
54 By setting following-method as yank-content."
55   (let ((wl-draft-buffer (current-buffer))
56         (mime-view-following-method-alist
57          (list (cons 'mmelmo-original-mode
58                      (function wl-draft-yank-to-draft-buffer))))
59         (mime-preview-following-method-alist
60          (list (cons 'mmelmo-original-mode
61                      (function wl-draft-yank-to-draft-buffer)))))
62     (if (get-buffer (wl-current-message-buffer))
63         (save-excursion
64           (save-restriction
65             (set-buffer (wl-current-message-buffer))
66             (widen)
67             (mime-preview-follow-current-entity))))))
68
69 (defalias 'wl-draft-enclose-digest-region 'mime-edit-enclose-digest-region)
70
71 ;; SEMI 1.13.5 or later.
72 ;; (mime-display-message
73 ;;  MESSAGE &optional
74 ;;  PREVIEW-BUFFER MOTHER DEFAULT-KEYMAP-OR-FUNCTION ORIGINAL-MAJOR-MODE)
75 ;; SEMI 1.13.4 or earlier.
76 ;; (mime-display-message
77 ;;  MESSAGE &optional
78 ;;  PREVIEW-BUFFER MOTHER DEFAULT-KEYMAP-OR-FUNCTION)
79 (static-if (or (and mime-user-interface-product
80                     (eq (nth 0 (aref mime-user-interface-product 1)) 1)
81                     (>= (nth 1 (aref mime-user-interface-product 1)) 14))
82                (and mime-user-interface-product
83                     (eq (nth 0 (aref mime-user-interface-product 1)) 1)
84                     (eq (nth 1 (aref mime-user-interface-product 1)) 13)
85                     (>= (nth 2 (aref mime-user-interface-product 1)) 5)))
86     ;; Has original-major-mode optional argument.
87     (defalias 'wl-mime-display-message 'mime-display-message)
88   (defmacro wl-mime-display-message (message &optional
89                                              preview-buffer mother
90                                              default-keymap-or-function
91                                              original-major-mode)
92     (` (mime-display-message (, message) (, preview-buffer) (, mother)
93                              (, default-keymap-or-function))))
94   ;; User agent field of XEmacs has problem on SEMI 1.13.4 or earlier.
95   (setq mime-edit-user-agent-value
96         (concat
97          (mime-product-name mime-user-interface-product) "/"
98          (mapconcat
99           #'number-to-string
100           (mime-product-version mime-user-interface-product) ".")
101          " (" (mime-product-code-name mime-user-interface-product)
102          ") " (mime-product-name mime-library-product)
103          "/" (mapconcat #'number-to-string
104                         (mime-product-version mime-library-product) ".")
105          " (" (mime-product-code-name mime-library-product) ") "
106          (if (featurep 'xemacs)
107              (concat
108               (if (featurep 'mule) "MULE")
109               " XEmacs"
110               (if (string-match "\\s +\\((\\|\\\"\\)" emacs-version)
111                   (concat "/" (substring emacs-version 0
112                                          (match-beginning 0))
113                           (if (and (boundp 'xemacs-betaname)
114                                    ;; It does not exist in XEmacs
115                                    ;; versions prior to 20.3.
116                                    xemacs-betaname)
117                               (concat " " xemacs-betaname)
118                             "")
119                           " (" xemacs-codename ") ("
120                           system-configuration ")")
121                 " (" emacs-version ")"))
122            (let ((ver (if (string-match "\\.[0-9]+$" emacs-version)
123                           (substring emacs-version 0 (match-beginning 0))
124                         emacs-version)))
125              (if (featurep 'mule)
126                  (if (boundp 'enable-multibyte-characters)
127                      (concat "Emacs/" ver
128                              " (" system-configuration ")"
129                              (if enable-multibyte-characters
130                                  (concat " MULE/" mule-version)
131                                " (with unibyte mode)")
132                              (if (featurep 'meadow)
133                                  (let ((mver (Meadow-version)))
134                                    (if (string-match "^Meadow-" mver)
135                                        (concat " Meadow/"
136                                                (substring mver
137                                                           (match-end 0)))))))
138                    (concat "MULE/" mule-version
139                            " (based on Emacs " ver ")"))
140                (concat "Emacs/" ver " (" system-configuration ")")))))))
141
142 ;; FLIM 1.12.7
143 ;; (mime-read-field FIELD-NAME &optional ENTITY)
144 ;; FLIM 1.13.2 or later
145 ;; (mime-entity-read-field ENTITY FIELD-NAME)
146 (static-if (fboundp 'mime-entity-read-field)
147     (defalias 'wl-mime-entity-read-field 'mime-entity-read-field)
148   (defmacro wl-mime-entity-read-field (entity field-name)
149     (` (mime-read-field (, field-name) (, entity)))))
150
151 (defun wl-draft-preview-message ()
152   ""
153   (interactive)
154   (let ((mime-display-header-hook 'wl-highlight-headers)
155         mime-view-ignored-field-list ; all header.
156         (mime-edit-translate-buffer-hook (append
157                                           (list 'wl-draft-config-exec)
158                                           mime-edit-translate-buffer-hook)))
159     (mime-edit-preview-message)
160     (let ((buffer-read-only nil))
161       (when wl-highlight-body-too
162         (wl-highlight-body))
163       (run-hooks 'wl-draft-preview-message-hook))))
164
165 (defalias 'wl-draft-caesar-region  'mule-caesar-region)
166
167 (defalias 'wl-draft-insert-message 'mime-edit-insert-message)
168
169 (defalias 'wl-draft-insert-mail 'mime-edit-insert-mail)
170
171 ;;; Message
172
173 (defun wl-message-decode-mode (outbuf inbuf)
174   (let ((mime-view-content-header-filter-hook 'wl-highlight-headers)
175         (mime-display-header-hook 'wl-highlight-headers))
176     (mime-view-mode nil nil nil inbuf outbuf)))
177
178 (defun wl-message-decode-with-all-header (outbuf inbuf)
179   (let ((mime-view-ignored-field-regexp "^:$")
180         (mime-view-content-header-filter-hook 'wl-highlight-headers)
181         (mime-display-header-hook 'wl-highlight-headers)
182         mime-view-ignored-field-list)
183     (mime-view-mode nil nil nil inbuf outbuf)))
184
185 (defun wl-message-delete-mime-out-buf ()
186   (let (mime-out-buf mime-out-win)
187     (if (setq mime-out-buf (get-buffer mime-echo-buffer-name))
188         (if (setq mime-out-win (get-buffer-window mime-out-buf))
189             (delete-window mime-out-win)))))
190
191 (defun wl-message-request-partial (folder number)
192   (elmo-set-work-buf
193    (elmo-read-msg-no-cache folder number (current-buffer))
194 ;;;(mime-parse-buffer nil 'mime-buffer-entity)
195    (mime-parse-buffer nil)))
196
197 (defalias 'wl-message-read            'mime-preview-scroll-up-entity)
198 (defalias 'wl-message-next-content    'mime-preview-move-to-next)
199 (defalias 'wl-message-prev-content    'mime-preview-move-to-previous)
200 (defalias 'wl-message-play-content    'mime-preview-play-current-entity)
201 (defalias 'wl-message-extract-content 'mime-preview-extract-current-entity)
202 (defalias 'wl-message-quit            'mime-preview-quit)
203 (defalias 'wl-message-button-dispatcher-internal
204   'mime-button-dispatcher)
205
206 ;;; Summary
207 (defun wl-summary-burst-subr (children target number)
208   ;; returns new number.
209   (let (content-type message-entity granch)
210     (while children
211       (setq content-type (mime-entity-content-type (car children)))
212       (if (eq (cdr (assq 'type content-type)) 'multipart)
213           (setq number (wl-summary-burst-subr
214                         (mime-entity-children (car children))
215                         target
216                         number))
217         (when (and (eq (cdr (assq 'type content-type)) 'message)
218                    (eq (cdr (assq 'subtype content-type)) 'rfc822))
219           (message (format "Bursting...%s" (setq number (+ 1 number))))
220           (setq message-entity
221                 (car (mime-entity-children (car children))))
222           (elmo-append-msg target
223                            (mime-entity-body (car children))
224                            (mime-entity-fetch-field message-entity
225                                                     "Message-ID"))))
226       (setq children (cdr children)))
227     number))
228
229 (defun wl-summary-burst ()
230   ""
231   (interactive)
232   (let ((raw-buf (wl-message-get-original-buffer))
233         children message-entity content-type target)
234     (save-excursion
235       (setq target wl-summary-buffer-folder-name)
236       (while (not (elmo-folder-writable-p target))
237         (setq target
238               (wl-summary-read-folder wl-default-folder "to extract to")))
239       (wl-summary-set-message-buffer-or-redisplay)
240       (save-excursion
241         (set-buffer (get-buffer wl-message-buf-name))
242         (setq message-entity (get-text-property (point-min) 'mime-view-entity)))
243       (set-buffer raw-buf)
244       (setq children (mime-entity-children message-entity))
245       (when children
246         (message "Bursting...")
247         (wl-summary-burst-subr children target 0)
248         (message "Bursting...done"))
249       (if (elmo-folder-plugged-p target)
250           (elmo-commit target)))
251     (wl-summary-sync-update3)))
252
253 ;; internal variable.
254 (defvar wl-mime-save-dir nil "Last saved directory.")
255 ;;; Yet another save method.
256 (defun wl-mime-save-content (entity situation)
257   (let ((filename (read-file-name "Save to file: "
258                                   (expand-file-name
259                                    (or (mime-entity-safe-filename entity)
260                                        ".")
261                                    (or wl-mime-save-dir
262                                        wl-tmp-dir)))))
263     (while (file-directory-p filename)
264       (setq filename (read-file-name "Please set filename (not directory): "
265                                      filename)))
266     (if (file-exists-p filename)
267         (or (yes-or-no-p (format "File %s exists. Save anyway? " filename))
268             (error "Not saved")))
269     (setq wl-mime-save-dir (file-name-directory filename))
270     (mime-write-entity-content entity filename)))
271
272 ;;; Yet another combine method.
273 (defun wl-mime-combine-message/partial-pieces (entity situation)
274   "Internal method for wl to combine message/partial messages automatically."
275   (interactive)
276   (let* ((msgdb (save-excursion
277                   (set-buffer wl-message-buffer-cur-summary-buffer)
278                   wl-summary-buffer-msgdb))
279          (mime-display-header-hook 'wl-highlight-headers)
280          (folder wl-message-buffer-cur-folder)
281          (id (or (cdr (assoc "id" situation)) ""))
282          (mother (current-buffer))
283          subject-id overviews
284          (root-dir (expand-file-name
285                     (concat "m-prts-" (user-login-name))
286                     temporary-file-directory))
287          full-file)
288     (setq root-dir (concat root-dir "/" (replace-as-filename id)))
289     (setq full-file (concat root-dir "/FULL"))
290     (if (or (file-exists-p full-file)
291             (not (y-or-n-p "Merge partials? ")))
292         (with-current-buffer mother
293           (mime-store-message/partial-piece entity situation))
294       (setq subject-id
295             (eword-decode-string
296              (decode-mime-charset-string
297               (wl-mime-entity-read-field entity 'Subject)
298               wl-summary-buffer-mime-charset)))
299       (if (string-match "[0-9\n]+" subject-id)
300           (setq subject-id (substring subject-id 0 (match-beginning 0))))
301       (setq overviews (elmo-msgdb-get-overview msgdb))
302       (catch 'tag
303         (while overviews
304           (when (string-match
305                  (regexp-quote subject-id)
306                  (elmo-msgdb-overview-entity-get-subject (car overviews)))
307             (let* ((message
308                     ;; request message at the cursor in Subject buffer.
309                     (wl-message-request-partial
310                      folder
311                      (elmo-msgdb-overview-entity-get-number (car overviews))))
312                    (situation (mime-entity-situation message))
313                    (the-id (or (cdr (assoc "id" situation)) "")))
314               (when (string= (downcase the-id)
315                              (downcase id))
316                 (with-current-buffer mother
317                   (mime-store-message/partial-piece message situation))
318                 (if (file-exists-p full-file)
319                     (throw 'tag nil)))))
320           (setq overviews (cdr overviews)))
321         (message "Not all partials found.")))))
322
323 (defun wl-mime-header-presentation-method (entity situation)
324   (let ((mmelmo-sort-field-list wl-message-sort-field-list))
325     (mime-insert-header entity
326                         wl-message-ignored-field-list
327                         wl-message-visible-field-list)
328     (wl-highlight-headers)))
329
330 ;;; Setup methods.
331 (defun wl-mime-setup ()
332   (set-alist 'mime-preview-quitting-method-alist
333              'mmelmo-original-mode 'wl-message-exit)
334   (set-alist 'mime-view-over-to-previous-method-alist
335              'mmelmo-original-mode 'wl-message-exit)
336   (set-alist 'mime-view-over-to-next-method-alist
337              'mmelmo-original-mode 'wl-message-exit)
338   (set-alist 'mime-preview-over-to-previous-method-alist
339              'mmelmo-original-mode 'wl-message-exit)
340   (set-alist 'mime-preview-over-to-next-method-alist
341              'mmelmo-original-mode 'wl-message-exit)
342   (add-hook 'wl-summary-redisplay-hook 'wl-message-delete-mime-out-buf)
343   (add-hook 'wl-message-exit-hook 'wl-message-delete-mime-out-buf)
344
345   (ctree-set-calist-strictly
346    'mime-acting-condition
347    '((type . message) (subtype . partial)
348      (method .  wl-mime-combine-message/partial-pieces)
349      (request-partial-message-method . wl-message-request-partial)
350      (major-mode . mmelmo-original-mode)))
351   (ctree-set-calist-strictly
352    'mime-acting-condition
353    '((mode . "extract")
354      (major-mode . mmelmo-original-mode)
355      (method . wl-mime-save-content)))
356   (set-alist 'mime-preview-following-method-alist
357              'mmelmo-original-mode
358              (function wl-message-follow-current-entity))
359   (set-alist 'mime-view-following-method-alist
360              'mmelmo-original-mode
361              (function wl-message-follow-current-entity))
362   (set-alist 'mime-edit-message-inserter-alist
363              'wl-draft-mode (function wl-draft-insert-current-message))
364   (set-alist 'mime-edit-mail-inserter-alist
365              'wl-draft-mode (function wl-draft-insert-get-message))
366   (set-alist 'mime-edit-split-message-sender-alist
367              'wl-draft-mode
368              (cdr (assq 'mail-mode mime-edit-split-message-sender-alist)))
369   (set-alist 'mime-raw-representation-type-alist
370              'mmelmo-original-mode 'binary)
371   ;; Sort and highlight header fields.
372   (or wl-message-ignored-field-list
373       (setq wl-message-ignored-field-list
374             mime-view-ignored-field-list))
375   (or wl-message-visible-field-list
376       (setq wl-message-visible-field-list
377             mime-view-visible-field-list))
378   (set-alist 'mime-header-presentation-method-alist
379              'mmelmo-original-mode
380              (function wl-mime-header-presentation-method))
381   (add-hook 'mmelmo-entity-content-inserted-hook 'wl-highlight-body))
382   
383
384 (require 'product)
385 (product-provide (provide 'wl-mime) (require 'wl-version))
386
387 ;;; wl-mime.el ends here