* wl-util.el (wl-simple-display-progress): New function.
[elisp/wanderlust.git] / wl / wl-message.el
1 ;;; wl-message.el --- Message displaying modules for 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 (eval-when-compile (require 'cl))
32
33 (require 'wl-vars)
34 (require 'wl-highlight)
35 (require 'elmo)
36 (require 'elmo-mime)
37 (require 'timer)
38
39 (eval-when-compile
40   (require 'wl-mime)
41   (require 'mime-view)
42   (defalias-maybe 'event-window 'ignore)
43   (defalias-maybe 'posn-window 'ignore)
44   (defalias-maybe 'event-start 'ignore)
45   (defalias-maybe 'mime-open-entity 'ignore)
46   (defalias-maybe 'itimer-function 'ignore)
47   (defalias-maybe 'delete-itimer 'ignore)
48   (defvar-maybe itimer-list))
49
50 (defvar wl-message-buffer-prefetch-get-next-function
51   'wl-summary-default-get-next-msg)
52
53 (defvar wl-message-buffer-prefetch-debug nil)
54
55 (defvar wl-message-buffer nil) ; message buffer.
56
57 (defvar wl-message-buffer-cur-folder nil)
58 (defvar wl-message-buffer-cur-number nil)
59 (defvar wl-message-buffer-cur-display-type nil)
60 (defvar wl-message-buffer-cur-summary-buffer nil)
61 (defvar wl-message-buffer-require-all-header nil)
62 (defvar wl-message-buffer-original-buffer nil) ; original buffer.
63 (defvar wl-message-buffer-mode-line-formatter nil)
64 (defvar wl-message-buffer-flag-indicator nil)
65 (defvar wl-message-buffer-mime-entity nil)
66
67 (make-variable-buffer-local 'wl-message-buffer-cur-folder)
68 (make-variable-buffer-local 'wl-message-buffer-cur-number)
69 (make-variable-buffer-local 'wl-message-buffer-cur-display-type)
70 (make-variable-buffer-local 'wl-message-buffer-cur-summary-buffer)
71 (make-variable-buffer-local 'wl-message-buffer-require-all-header)
72 (make-variable-buffer-local 'wl-message-buffer-original-buffer)
73 (make-variable-buffer-local 'wl-message-buffer-mode-line-formatter)
74 (make-variable-buffer-local 'wl-message-buffer-flag-indicator)
75 (make-variable-buffer-local 'wl-message-buffer-mime-entity)
76
77 (defvar wl-fixed-window-configuration nil)
78
79 (defvar wl-message-buffer-cache-size 10) ; At least 1.
80
81 ;;; Message buffer cache.
82
83 (defvar wl-message-buffer-cache nil
84   "Message cache.  (old ... new) order alist.
85 With association ((\"folder\" message \"message-id\") . cache-buffer).")
86
87 (defmacro wl-message-buffer-cache-buffer-get (entry)
88   (` (cdr (, entry))))
89
90 (defmacro wl-message-buffer-cache-folder-get (entry)
91   (` (car (car (, entry)))))
92
93 (defmacro wl-message-buffer-cache-message-get (entry)
94   (` (cdr (car (, entry)))))
95
96 (defmacro wl-message-buffer-cache-entry-make (key buf)
97   (` (cons (, key) (, buf))))
98
99 (defmacro wl-message-buffer-cache-hit (key)
100   "Return value assosiated with key."
101   (` (wl-message-buffer-cache-buffer-get
102       (assoc (, key) wl-message-buffer-cache))))
103
104 (defun wl-message-buffer-cache-sort (entry)
105   "Move ENTRY to the top of `wl-message-buffer-cache'."
106   (setq wl-message-buffer-cache
107         (cons entry (delete entry wl-message-buffer-cache))))
108 ;  (let* ((pointer (cons nil wl-message-buffer-cache))
109 ;        (top pointer))
110 ;    (while (cdr pointer)
111 ;      (if (equal (car (cdr pointer)) entry)
112 ;         (setcdr pointer (cdr (cdr pointer)))
113 ;       (setq pointer (cdr pointer))))
114 ;    (setcdr pointer (list entry))
115 ;    (setq wl-message-buffer-cache (cdr top))))
116
117 (defconst wl-original-message-buffer-name " *Original*")
118
119 (defun wl-original-message-mode ()
120   "A major mode for original message buffer."
121   (setq major-mode 'wl-original-message-mode)
122   (setq buffer-read-only t)
123   (set-buffer-multibyte nil)
124   (setq mode-name "Wanderlust original message"))
125
126 (defun wl-original-message-buffer-get (name)
127   "Get original message buffer for NAME.
128 If original message buffer already exists, it is re-used."
129   (let* ((name (concat wl-original-message-buffer-name name))
130          (buffer (get-buffer name)))
131     (unless (and buffer (buffer-live-p buffer))
132       (with-current-buffer (setq buffer (get-buffer-create name))
133         (wl-original-message-mode)))
134     buffer))
135
136 (defun wl-message-buffer-create ()
137   "Create a new message buffer."
138   (let* ((buffer (generate-new-buffer wl-message-buffer-name))
139          (name (buffer-name buffer)))
140     (with-current-buffer buffer
141       (setq wl-message-buffer-original-buffer
142             (wl-original-message-buffer-get name))
143       (when wl-message-use-header-narrowing
144         (wl-message-header-narrowing-setup))
145       (run-hooks 'wl-message-buffer-created-hook))
146     buffer))
147
148 (defun wl-message-buffer-cache-add (key)
149   "Add (KEY . buf) to the top of `wl-message-buffer-cache'.
150 Return its cache buffer."
151   (let ((len (length wl-message-buffer-cache))
152         (buf nil))
153     (if (< len wl-message-buffer-cache-size)
154         (setq buf (wl-message-buffer-create))
155       (let ((entry (nth (1- len) wl-message-buffer-cache)))
156         (if (buffer-live-p
157              (setq buf (wl-message-buffer-cache-buffer-get entry)))
158             (setcdr (nthcdr (- len 2) wl-message-buffer-cache) nil)
159           (setq wl-message-buffer-cache (delq entry wl-message-buffer-cache))
160           (setq buf (wl-message-buffer-create)))))
161     (setq wl-message-buffer-cache
162           (cons (wl-message-buffer-cache-entry-make key buf)
163                 wl-message-buffer-cache))
164     buf))
165
166 (defun wl-message-buffer-cache-delete (&optional key)
167   "Delete the most recent cache entry"
168   (if key
169       (setq wl-message-buffer-cache
170             (delq (assoc key wl-message-buffer-cache)
171                   wl-message-buffer-cache))
172     (let ((buf (wl-message-buffer-cache-buffer-get
173                 (car wl-message-buffer-cache))))
174       (setq wl-message-buffer-cache
175             (nconc (cdr wl-message-buffer-cache)
176                    (list (wl-message-buffer-cache-entry-make nil buf)))))))
177
178 (defun wl-message-buffer-cache-clean-up ()
179   "A function to flush all decoded messages in cache list."
180   (interactive)
181   (if (and (eq major-mode 'wl-summary-mode)
182            wl-message-buffer
183            (get-buffer-window wl-message-buffer))
184       (delete-window (get-buffer-window wl-message-buffer)))
185   (wl-kill-buffers (regexp-quote wl-message-buffer-name))
186   (setq wl-message-buffer-cache nil))
187
188 ;;; Message buffer handling from summary buffer.
189
190 (defun wl-message-buffer-window ()
191   "Get message buffer window if any."
192   (let* ((start-win (selected-window))
193          (cur-win start-win))
194     (catch 'found
195       (while (progn
196                (setq cur-win (next-window cur-win))
197                (with-current-buffer (window-buffer cur-win)
198                  (if (or (eq major-mode 'wl-message-mode)
199                          (eq major-mode 'mime-view-mode))
200                      (throw 'found cur-win)))
201                (not (eq cur-win start-win)))))))
202
203 (defun wl-message-select-buffer (buffer)
204   "Select BUFFER as a message buffer."
205   (let ((window (get-buffer-window buffer))
206         (sum (car wl-message-window-size))
207         (mes (cdr wl-message-window-size))
208         whi)
209     (when (and window
210                (not (eq (save-excursion (set-buffer (window-buffer window))
211                                         wl-message-buffer-cur-summary-buffer)
212                         (current-buffer))))
213       (delete-window window)
214       (run-hooks 'wl-message-window-deleted-hook)
215       (setq window nil))
216     (if window
217         (select-window window)
218       (when wl-fixed-window-configuration
219         (delete-other-windows)
220         (and wl-stay-folder-window
221              (wl-summary-toggle-disp-folder)))
222       ;; There's no buffer window. Search for message window and snatch it.
223       (if (setq window (wl-message-buffer-window))
224           (select-window window)
225         (setq whi (1- (window-height)))
226         (if mes
227             (progn
228               (let ((total (+ sum mes)))
229                 (setq sum (max window-min-height (/ (* whi sum) total)))
230                 (setq mes (max window-min-height (/ (* whi mes) total))))
231               (if (< whi (+ sum mes))
232                   (enlarge-window (- (+ sum mes) whi)))))
233         (split-window (get-buffer-window (current-buffer)) sum)
234         (other-window 1)))
235     (switch-to-buffer buffer)))
236
237 (defun wl-message-narrow-to-page (&optional arg)
238   "Narrow to page.
239 If ARG is specified, narrow to ARGth page."
240   (interactive "P")
241   (setq arg (if arg (prefix-numeric-value arg) 0))
242   (save-excursion
243     (condition-case ()
244         (forward-page -1)               ; Beginning of current page.
245       (beginning-of-buffer
246        (goto-char (point-min))))
247     (forward-char 1)  ; for compatibility with emacs-19.28 and emacs-19.29
248     (widen)
249     (cond
250      ((> arg 0) (forward-page arg))
251      ((< arg 0) (forward-page (1- arg))))
252     (forward-page)
253     (if wl-break-pages
254         (narrow-to-region (point)
255                           (progn
256                             (forward-page -1)
257                             (if (and (eolp) (not (bobp)))
258                                 (forward-line))
259                             (point))))))
260
261 (defun wl-message-prev-page (&optional lines)
262   "Scroll down current message by LINES.
263 Returns non-nil if top of message."
264   (interactive)
265   (let (top real-top)
266     (save-selected-window
267       (unless (eq major-mode 'mime-view-mode)
268         (when (buffer-live-p wl-message-buffer)
269           (wl-message-select-buffer wl-message-buffer)))
270       (move-to-window-line 0)
271       (if (and wl-break-pages
272                (bobp)
273                (not (setq real-top (save-restriction (widen) (bobp)))))
274           (progn
275             (wl-message-narrow-to-page -1)
276             (goto-char (point-max))
277             (recenter))
278         (if (not (bobp))
279             (condition-case nil
280                 (scroll-down (or lines wl-message-scroll-amount))
281               (error))
282           (setq top t)))
283       (if real-top
284           (let ((f (assq (mime-preview-original-major-mode)
285                          mime-preview-over-to-previous-method-alist)))
286             (if f (funcall (cdr f))))))
287     top))
288
289 (defun wl-message-next-page (&optional lines)
290   "Scroll up current message by LINES.
291 Returns non-nil if bottom of message."
292   (interactive)
293   (let (bottom)
294     (save-selected-window
295       (unless (eq major-mode 'mime-view-mode)
296         (when (buffer-live-p wl-message-buffer)
297           (wl-message-select-buffer wl-message-buffer)))
298       (move-to-window-line -1)
299       (if (save-excursion
300             (end-of-line)
301             (and (pos-visible-in-window-p)
302                  (eobp)))
303           (if (or (null wl-break-pages)
304                   (save-excursion
305                     (save-restriction
306                       (widen) (forward-line) (eobp))))
307               (setq bottom t)
308             (wl-message-narrow-to-page 1)
309             (setq bottom nil))
310         (condition-case ()
311             (static-if (boundp 'window-pixel-scroll-increment)
312                 ;; XEmacs 21.2.20 and later.
313                 (let (window-pixel-scroll-increment)
314                   (scroll-up (or lines wl-message-scroll-amount)))
315               (scroll-up (or lines wl-message-scroll-amount)))
316           (end-of-buffer
317            (goto-char (point-max))))
318         (setq bottom nil))
319       (if (eobp)
320           (let ((f (assq (mime-preview-original-major-mode)
321                          mime-preview-over-to-next-method-alist)))
322             (if f (funcall (cdr f))))))
323     bottom))
324
325
326 (defun wl-message-follow-current-entity (buffer)
327   "Follow to current message."
328   (wl-draft-reply (wl-message-get-original-buffer)
329                   nil wl-message-buffer-cur-summary-buffer) ; reply to all
330   (let ((mail-reply-buffer buffer))
331     (wl-draft-yank-from-mail-reply-buffer nil)))
332
333 ;;
334
335 (defun wl-message-mode ()
336   "A major mode for message displaying."
337   (interactive)
338   (setq major-mode 'wl-message-mode)
339   (setq buffer-read-only t)
340   (setq mode-name "Message"))
341
342 (defun wl-message-exit ()
343   "Move to summary buffer or mother buffer."
344   (interactive)
345   (let (summary-buf summary-win mother-buffer)
346     (cond ((setq summary-buf wl-message-buffer-cur-summary-buffer)
347            (if (setq summary-win (get-buffer-window summary-buf))
348                (select-window summary-win)
349              (switch-to-buffer summary-buf)
350              (wl-message-select-buffer wl-message-buffer)
351              (select-window (get-buffer-window summary-buf))))
352           ((setq mother-buffer mime-mother-buffer)
353            (kill-buffer (current-buffer))
354            (switch-to-buffer mother-buffer)))
355     (run-hooks 'wl-message-exit-hook)))
356
357 (defun wl-message-toggle-disp-summary ()
358   (interactive)
359   (let ((summary-buf (get-buffer wl-message-buffer-cur-summary-buffer))
360         summary-win)
361     (if (and summary-buf
362              (buffer-live-p summary-buf))
363         (if (setq summary-win (get-buffer-window summary-buf))
364             (delete-window summary-win)
365           (switch-to-buffer summary-buf)
366           (wl-message-select-buffer wl-message-buffer))
367       (wl-summary-goto-folder-subr wl-message-buffer-cur-folder 'no-sync
368                                    nil nil t)
369                                         ; no summary-buf
370       (let ((sum-buf (current-buffer)))
371         (wl-message-select-buffer wl-message-buffer)
372         (setq wl-message-buffer-cur-summary-buffer sum-buf)))))
373
374 (defun wl-message-get-original-buffer ()
375   "Get original buffer for current message buffer."
376   (if (buffer-live-p wl-message-buffer-original-buffer)
377       wl-message-buffer-original-buffer
378     (wl-original-message-buffer-get (buffer-name (current-buffer)))))
379
380 (defun wl-message-add-buttons-to-body (start end)
381   (save-excursion
382     (save-restriction
383       (narrow-to-region start end)
384       (let ((case-fold-search t)
385             (alist wl-message-body-button-alist)
386             entry)
387         (while alist
388           (setq entry (car alist)
389                 alist (cdr alist))
390           (goto-char (point-min))
391           (while (re-search-forward (car entry) (+ (point) (nth 4 entry)) t)
392             (unless (get-text-property (point) 'keymap)
393               (wl-message-add-button
394                (match-beginning (nth 1 entry))
395                (match-end (nth 1 entry))
396                (nth 2 entry)
397                (match-string (nth 3 entry))))))))))
398
399 (defun wl-message-add-buttons-to-header (start end)
400   (save-excursion
401     (save-restriction
402       (narrow-to-region start end)
403       (let ((case-fold-search t)
404             (alist wl-message-header-button-alist)
405             entry)
406         (while alist
407           (setq entry (car alist)
408                 alist (cdr alist))
409           (goto-char (point-min))
410           (while (re-search-forward (car entry) nil t)
411             (setq start (match-beginning 0)
412                   end (if (re-search-forward "^[^ \t]" nil t)
413                           (match-beginning 0)
414                         (point-max)))
415             (goto-char start)
416             (while (re-search-forward (nth 1 entry) end t)
417               (wl-message-add-button
418                (match-beginning (nth 2 entry))
419                (match-end (nth 2 entry))
420                (nth 3 entry) (match-string (nth 4 entry))))
421             (goto-char end)))))))
422
423 ;; display-type object definition.
424 (defun wl-message-make-display-type (mime header)
425   (let (symbol)
426     (prog1
427         (setq symbol (intern (format "%s-%s-header" mime header)))
428       (put symbol
429            'wl-message-display-type
430            (list :mime mime :header header)))))
431
432 (defun wl-message-display-type-property (display-type prop)
433   (plist-get (get display-type 'wl-message-display-type) prop))
434
435 (defun wl-message-mime-analysis-p (display-type &optional header-or-body)
436   (let ((mode (wl-message-display-type-property display-type :mime)))
437     (case header-or-body
438       (header
439        (memq mode '(mime header-only)))
440       (t
441        (eq mode 'mime)))))
442
443 (defun wl-message-display-all-header-p (display-type)
444   (eq (wl-message-display-type-property display-type :header) 'all))
445
446 (defun wl-message-display-no-merge-p (display-type)
447   (eq (wl-message-display-type-property display-type :mime) 'no-merge))
448
449 (defun wl-message-buffer-display-type (&optional message-buffer)
450   (if message-buffer
451       (with-current-buffer message-buffer
452         wl-message-buffer-cur-display-type)
453     wl-message-buffer-cur-display-type))
454
455 (defun wl-message-flag-indicator (flags)
456   (let ((flags (elmo-get-global-flags flags)))
457     (if (null flags)
458         ""
459       (concat
460        " ("
461        (mapconcat
462         (lambda (flag)
463           (let ((indicator (capitalize (symbol-name flag)))
464                 face)
465             (when (and (assq flag wl-summary-flag-alist)
466                        (facep
467                         (setq face (intern
468                                     (format "wl-highlight-summary-%s-flag-face"
469                                             flag)))))
470               (put-text-property 0 (length indicator) 'face face indicator))
471             indicator))
472         (sort flags
473               (lambda (l r)
474                 (> (length (memq (assq l wl-summary-flag-alist)
475                                  wl-summary-flag-alist))
476                    (length (memq (assq r wl-summary-flag-alist)
477                                  wl-summary-flag-alist)))))
478         ", ")
479        ")"))))
480
481 (defun wl-message-redisplay (folder number display-type &optional force-reload)
482   (let* ((default-mime-charset wl-mime-charset)
483          (buffer-read-only nil)
484          (summary-buf (current-buffer))
485          message-buf entity summary-win flags)
486     (setq buffer-read-only nil)
487     (setq wl-message-buffer (wl-message-buffer-display
488                              folder number display-type force-reload))
489     (setq message-buf wl-message-buffer)
490     (wl-message-select-buffer wl-message-buffer)
491
492     (set-buffer message-buf)
493     (wl-deactivate-region)
494     (make-local-variable 'truncate-partial-width-windows)
495     (setq truncate-partial-width-windows nil)
496     (setq truncate-lines wl-message-truncate-lines)
497     (setq buffer-read-only nil)
498     (setq wl-message-buffer-cur-summary-buffer summary-buf)
499     (setq wl-message-buffer-cur-folder (elmo-folder-name-internal folder))
500     (setq wl-message-buffer-cur-number number)
501     (setq wl-message-buffer-flag-indicator
502           (wl-message-flag-indicator (elmo-message-flags folder number)))
503     (wl-line-formatter-setup
504      wl-message-buffer-mode-line-formatter
505      wl-message-mode-line-format
506      wl-message-mode-line-format-spec-alist)
507     (setq mode-line-buffer-identification
508           (funcall wl-message-buffer-mode-line-formatter))
509     ;; highlight body
510 ;    (when wl-highlight-body-too
511 ;      (wl-highlight-body))
512     (ignore-errors (wl-message-narrow-to-page))
513     (goto-char (point-min))
514     (when (re-search-forward "^$" nil t)
515       (wl-message-add-buttons-to-header (point-min) (point))
516       (wl-message-add-buttons-to-body (point) (point-max)))
517     (when (and wl-message-use-header-narrowing
518                (not (wl-message-display-all-header-p display-type)))
519       (wl-message-header-narrowing))
520     (goto-char (point-min))
521     (ignore-errors (run-hooks 'wl-message-redisplay-hook))
522     ;; go back to summary mode
523     (set-buffer-modified-p nil)
524     (setq buffer-read-only t)
525     (set-buffer summary-buf)
526     (setq summary-win (get-buffer-window summary-buf))
527     (if (window-live-p summary-win)
528         (select-window summary-win))))
529
530 ;; Use message buffer cache.
531 (defun wl-message-buffer-display (folder number display-type
532                                          &optional force-reload unread)
533   (let* ((msg-id (ignore-errors
534                    (elmo-message-field folder number 'message-id)))
535          (fname (elmo-folder-name-internal folder))
536          (hit (wl-message-buffer-cache-hit (list fname number msg-id)))
537          (redisplay nil)
538          entity)
539     (when (and hit (not (buffer-live-p hit)))
540       (wl-message-buffer-cache-delete (list fname number msg-id))
541       (setq hit nil))
542     (if hit
543         (progn
544           ;; move hit to the top.
545           (wl-message-buffer-cache-sort
546            (wl-message-buffer-cache-entry-make (list fname number msg-id) hit))
547           (with-current-buffer hit
548             ;; Rewind to the top page
549             (widen)
550             (goto-char (point-min))
551             (ignore-errors (wl-message-narrow-to-page))
552             (setq entity wl-message-buffer-mime-entity)
553             (unless (eq wl-message-buffer-cur-display-type display-type)
554               (setq redisplay t))))
555       ;; delete tail and add new to the top.
556       (setq hit (wl-message-buffer-cache-add (list fname number msg-id)))
557       (setq redisplay t))
558     (when (or force-reload redisplay)
559       (condition-case err
560           (with-current-buffer hit
561             (when (or force-reload
562                       (null entity)
563                       (not (elmo-mime-entity-display-p
564                             entity
565                             (if (wl-message-mime-analysis-p display-type)
566                                 'mime
567                               'as-is)))
568                       (if (wl-message-display-no-merge-p display-type)
569                           (elmo-mime-entity-reassembled-p entity)
570                         (elmo-mime-entity-fragment-p entity)))
571               (setq entity (elmo-message-mime-entity
572                             folder
573                             number
574                             (wl-message-get-original-buffer)
575                             (and wl-message-auto-reassemble-message/partial
576                                  (not (wl-message-display-no-merge-p
577                                        display-type)))
578                             force-reload
579                             unread
580                             (not (wl-message-mime-analysis-p display-type)))))
581             (unless entity
582               (error "Cannot display message %s/%s" fname number))
583             (wl-message-display-internal entity display-type))
584         (quit
585          (wl-message-buffer-cache-delete)
586          (error "Display message %s/%s is quitted" fname number))
587         (error
588          (wl-message-buffer-cache-delete)
589          (signal (car err) (cdr err))
590          nil))) ;; will not be used
591     hit))
592
593 (defun wl-message-display-internal (entity display-type)
594   (let ((default-mime-charset wl-mime-charset)
595         (elmo-mime-charset wl-mime-charset)
596         (wl-message-buffer-require-all-header
597          (wl-message-display-all-header-p display-type)))
598     (if (wl-message-mime-analysis-p display-type)
599         (elmo-mime-entity-display entity
600                                   (current-buffer)
601                                   'wl-original-message-mode
602                                   (wl-message-define-keymap))
603       (let* ((elmo-mime-display-header-analysis
604               (wl-message-mime-analysis-p display-type 'header))
605              (wl-highlight-x-face-function
606               (and elmo-mime-display-header-analysis
607                    wl-highlight-x-face-function)))
608         (elmo-mime-entity-display-as-is entity
609                                         (current-buffer)
610                                         'wl-original-message-mode
611                                         (wl-message-define-keymap))
612         (let (buffer-read-only)
613           (wl-highlight-message (point-min) (point-max) t))))
614     (setq wl-message-buffer-cur-display-type display-type
615           wl-message-buffer-mime-entity entity)
616     (run-hooks 'wl-message-display-internal-hook)
617     (setq buffer-read-only t)))
618
619 (defun wl-message-buffer-prefetch-p (folder &optional number)
620   (and (or (not number)
621            (elmo-message-file-p folder number)
622            (let ((size (elmo-message-field folder number 'size)))
623              (not (and (integerp size)
624                        wl-message-buffer-prefetch-threshold
625                        (>= size wl-message-buffer-prefetch-threshold)))))
626        (or (not number)
627            (elmo-folder-plugged-p folder)
628            (elmo-file-cache-exists-p
629                  (elmo-message-field folder number 'message-id)))
630        (or (cond
631             ((eq wl-message-buffer-prefetch-folder-type-list t)
632              t)
633             ((and number wl-message-buffer-prefetch-folder-type-list)
634              (memq (elmo-folder-type-internal
635                     (elmo-message-folder folder number))
636                    wl-message-buffer-prefetch-folder-type-list))
637             (wl-message-buffer-prefetch-folder-type-list
638              (let ((list wl-message-buffer-prefetch-folder-type-list)
639                    type)
640                (catch 'done
641                  (while (setq type (pop list))
642                    (if (elmo-folder-contains-type folder type)
643                        (throw 'done t)))))))
644            (cond
645             ((consp wl-message-buffer-prefetch-folder-list)
646              (wl-string-match-member (elmo-folder-name-internal folder)
647                                      wl-message-buffer-prefetch-folder-list))
648             (t wl-message-buffer-prefetch-folder-list)))))
649
650 (defsubst wl-message-buffer-prefetch-clear-timer ()
651 ;;;     cannot use for the bug of fsf-compat package (1.09).
652 ;;;     (cancel-function-timers 'wl-message-buffer-prefetch-subr)
653   (if (fboundp 'run-with-idle-timer)
654       (if (featurep 'xemacs)
655           (let ((p itimer-list))
656             (while (car p)
657               (if (eq 'wl-message-buffer-prefetch-subr
658                       (itimer-function (car p)))
659                   (delete-itimer (car p)))
660               (setq p (cdr p))))
661         ;; FSF Emacs is correct
662         (cancel-function-timers 'wl-message-buffer-prefetch-subr))))
663
664 (defsubst wl-message-buffer-prefetch-set-timer (folder number count
665                                                        summary charset)
666   (if (not (fboundp 'run-with-idle-timer))
667       (when (sit-for wl-message-buffer-prefetch-idle-time)
668         (wl-message-buffer-prefetch-subr
669          folder number count summary charset))
670     (run-with-idle-timer
671      wl-message-buffer-prefetch-idle-time
672      nil
673      'wl-message-buffer-prefetch-subr
674      folder number count summary charset)))
675
676 (defvar wl-message-buffer-prefetch-move-spec-alist nil)
677
678 (defun wl-message-buffer-prefetch-get-next (folder number summary)
679   (if (buffer-live-p summary)
680       (with-current-buffer summary
681         (let ((wl-summary-move-spec-alist
682                (or wl-message-buffer-prefetch-move-spec-alist
683                    wl-summary-move-spec-alist))
684               (next number))
685           (while (and (setq next (funcall
686                                   wl-message-buffer-prefetch-get-next-function
687                                   next))
688                       (not (wl-message-buffer-prefetch-p folder next))))
689           next))))
690
691 (defun wl-message-buffer-prefetch (folder number count
692                                           &optional summary charset)
693   (let* ((summary (or summary (get-buffer wl-summary-buffer-name)))
694          (num number))
695     (when (and (> count 0)
696                (wl-message-buffer-prefetch-p folder))
697       (unless (wl-message-buffer-prefetch-p folder number)
698         (setq num
699               (wl-message-buffer-prefetch-get-next folder number summary)))
700       (when num
701         (wl-message-buffer-prefetch-clear-timer)
702         (wl-message-buffer-prefetch-set-timer
703          folder num count summary charset)))))
704
705 (defun wl-message-buffer-prefetch-next (folder number count
706                                                &optional summary charset)
707   (let* ((summary (or summary (get-buffer wl-summary-buffer-name)))
708          next)
709     (when (and (> count 0)
710                (wl-message-buffer-prefetch-p folder))
711       (setq next (wl-message-buffer-prefetch-get-next folder number summary))
712       (when next
713         (wl-message-buffer-prefetch-clear-timer)
714         (wl-message-buffer-prefetch-set-timer
715          folder next count summary charset)))))
716
717 (defun wl-message-buffer-prefetch-subr (folder number count summary charset)
718   (if (buffer-live-p summary)
719       (with-current-buffer summary
720         (if (and number
721                  (numberp count)
722                  (>= (setq count (- count 1)) 0)
723                  (string= (elmo-folder-name-internal folder)
724                           (wl-summary-buffer-folder-name)))
725             (let* ((wl-mime-charset      charset)
726                    (default-mime-charset charset)
727                    (message-id (elmo-message-field folder number 'message-id))
728                    (key (list (elmo-folder-name-internal folder)
729                               number message-id))
730                    (hit (wl-message-buffer-cache-hit key))
731                    (display-type (wl-message-make-display-type
732                                   wl-summary-buffer-display-mime-mode
733                                   wl-summary-buffer-display-header-mode))
734                    time1 time2 sec micro)
735               (when wl-message-buffer-prefetch-debug
736                 (message "%d: count %d, hit %s" number count (buffer-name hit)))
737               (if (and hit (buffer-live-p hit))
738                   (progn
739                     (wl-message-buffer-cache-sort
740                      (wl-message-buffer-cache-entry-make key hit))
741                     (wl-message-buffer-prefetch-subr
742                      folder
743                      (wl-message-buffer-prefetch-get-next
744                       folder number summary)
745                      count summary charset))
746                 ;; prefetching
747                 (when wl-message-buffer-prefetch-debug
748                   (setq time1 (current-time))
749                   (message "Prefetching %d..." number))
750                 (wl-message-buffer-display folder number
751                                            display-type nil 'unread)
752                 (when (elmo-message-use-cache-p folder number)
753                   (elmo-message-set-cached folder number t))
754                 (when wl-message-buffer-prefetch-debug
755                   (setq time2 (current-time))
756                   (setq sec  (- (nth 1 time2)(nth 1 time1)))
757                   (setq micro (- (nth 2 time2)(nth 2 time1)))
758                   (setq micro (+ micro (* 1000000 sec)))
759                   (message "Prefetching %d...done(%f msec)."
760                            number
761                            (/ micro 1000.0))
762                   (sit-for 0))
763                 ;; set next prefetch
764                 (wl-message-buffer-prefetch-set-timer
765                  folder
766                  (wl-message-buffer-prefetch-get-next
767                   folder number summary)
768                  count summary charset)
769                 (sit-for 0)
770                 ;; success prefetch
771                 )))
772         ;; finish prefetch
773         (when wl-message-buffer-prefetch-debug
774           (message "Buffer Cached Messages: %s"
775                    (mapconcat
776                     '(lambda (cache)
777                        (if (numberp (nth 1 (car cache)))
778                            (if (string=
779                                 (nth 0 (car cache))
780                                 (elmo-folder-name-internal folder))
781                                (format "%d"
782                                        (nth 1 (car cache)))
783                              (format "*%d" (nth 1 (car cache))))
784                          "-"))
785                     wl-message-buffer-cache " "))) )))
786
787 (defvar wl-message-button-map (make-sparse-keymap))
788
789 (defun wl-message-add-button (from to function &optional data)
790   "Create a button between FROM and TO with callback FUNCTION and DATA."
791   (add-text-properties
792    from to
793    (nconc (list 'wl-message-button-callback function)
794           (if data
795               (list 'wl-message-button-data data))))
796   (let ((ov (make-overlay from to)))
797     (overlay-put ov 'mouse-face 'highlight)
798     (overlay-put ov 'local-map wl-message-button-map)
799     (overlay-put ov 'evaporate t)))
800
801 (defun wl-message-button-dispatcher (event)
802   "Select the button under point."
803   (interactive "@e")
804   (mouse-set-point event)
805   (let ((callback (get-text-property (point) 'wl-message-button-callback))
806         (data (get-text-property (point) 'wl-message-button-data)))
807     (if callback
808         (funcall callback data)
809       (wl-message-button-dispatcher-internal event))))
810
811 (defun wl-message-button-refer-article (data)
812   "Read article specified by Message-ID DATA at point."
813   (switch-to-buffer-other-window
814    wl-message-buffer-cur-summary-buffer)
815   (if (wl-summary-jump-to-msg-by-message-id data)
816       (wl-summary-redisplay)))
817
818 (defun wl-message-uu-substring (buf outbuf &optional first last)
819   (save-excursion
820     (set-buffer buf)
821     (search-forward "\n\n")
822     (let ((sp (point))
823           ep filename case-fold-search)
824       (catch 'done
825         (if first
826             (progn
827               (if (re-search-forward "^begin[ \t]+[0-9]+[ \t]+\\([^ ].*\\)" nil t)
828                   (setq filename (buffer-substring (match-beginning 1)(match-end 1)))
829                 (throw 'done nil)))
830           (re-search-forward "^M.*$" nil t)) ; uuencoded string
831         (beginning-of-line)
832         (setq sp (point))
833         (goto-char (point-max))
834         (if last
835             (re-search-backward "^end" sp t)
836           (re-search-backward "^M.*$" sp t)) ; uuencoded string
837         (forward-line 1)
838         (setq ep (point))
839         (set-buffer outbuf)
840         (goto-char (point-max))
841         (insert-buffer-substring buf sp ep)
842         (set-buffer buf)
843         filename))))
844
845 ;;; Header narrowing courtesy of Hideyuki Shirai.
846 (defun wl-message-header-narrowing ()
847   "Narrowing headers."
848   (unless (eq this-command 'wl-summary-redisplay-all-header)
849     (save-excursion
850       (save-restriction
851         (goto-char (point-min))
852         (if (re-search-forward "^$" nil t)
853             (beginning-of-line)
854           (goto-char (point-max)))
855         (narrow-to-region (point-min) (point))
856         (let ((fields wl-message-header-narrowing-fields))
857           (while fields
858             (wl-message-header-narrowing-1 (concat "^" (car fields) ":"))
859             (setq fields (cdr fields))))))))
860
861 (defvar wl-message-header-narrowing-map (make-sparse-keymap))
862 (define-key wl-message-header-narrowing-map [mouse-2]
863   'wl-message-header-narrowing-again-at-mouse)
864
865 (defvar wl-message-header-narrowing-widen-map (make-sparse-keymap))
866 (define-key wl-message-header-narrowing-widen-map [mouse-2]
867   'wl-message-header-narrowing-widen-at-mouse)
868
869 (defun wl-message-header-narrowing-again-at-mouse (event)
870   (interactive "e")
871   (save-window-excursion
872     (save-excursion
873       (mouse-set-point event)
874       (wl-message-header-narrowing))))
875
876 (defun wl-message-header-narrowing-1 (hregexp)
877   (let ((case-fold-search t)
878         ov start end)
879     (goto-char (point-min))
880     (while (re-search-forward hregexp nil t)
881       (setq start (match-beginning 0))
882       (forward-line 1)
883       (setq end (progn (while (looking-at "^[ \t]") (forward-line))
884                        (forward-line -1)
885                        (line-end-position)))
886       (if (<= (count-lines start end) wl-message-header-narrowing-lines)
887           (forward-line 1)
888         (goto-char start)
889         (forward-line (1- wl-message-header-narrowing-lines))
890         (end-of-line)
891         (setq start (point))
892         (unless (eq (get-char-property start 'invisible)
893                     'wl-message-header-narrowing)
894           (setq ov (or
895                     (let ((ovs (overlays-at start))
896                           ov)
897                       (while (and ovs (not (overlayp ov)))
898                         (if (overlay-get (car ovs)
899                                          'wl-message-header-narrowing)
900                             (setq ov (car ovs)))
901                         (setq ovs (cdr ovs)))
902                       ov)
903                     (make-overlay start end)))
904           (overlay-put ov 'wl-message-header-narrowing t)
905           (overlay-put ov 'evaporate t)
906           (overlay-put ov 'invisible 'wl-message-header-narrowing)
907           (overlay-put ov 'after-string
908                        wl-message-header-narrowing-string))))))
909
910 (defun wl-message-header-narrowing-widen-at-mouse (event)
911   (interactive "e")
912   (save-selected-window
913     (select-window (posn-window (event-start event)))
914     (let* ((win (selected-window))
915            (wpos (window-start win))
916            (pos (mouse-set-point event))
917            (ovs (overlays-in (1- pos) (1+ pos)))        ;; Uum...
918            ov)
919       (while (and ovs (not (overlayp ov)))
920         (when (overlay-get (car ovs) 'wl-message-header-narrowing)
921           (setq ov (car ovs)))
922         (setq ovs (cdr ovs)))
923       (when (overlayp ov)
924         (overlay-put ov 'face 'wl-message-header-narrowing-face)
925         (overlay-put ov 'local-map wl-message-header-narrowing-map)
926         (overlay-put ov 'invisible nil)
927         (overlay-put ov 'after-string nil))
928       (set-window-start win wpos))))
929
930 (defun wl-message-header-narrowing-setup ()
931   (when (boundp 'line-move-ignore-invisible)
932     (set (make-local-variable 'line-move-ignore-invisible) t))
933   (set-text-properties 0 (length wl-message-header-narrowing-string)
934                        `(face
935                          wl-message-header-narrowing-face
936                          keymap
937                          ,wl-message-header-narrowing-widen-map)
938                        wl-message-header-narrowing-string))
939
940 (defun wl-message-header-narrowing-toggle ()
941   "Toggle header narrowing."
942   (interactive)
943   (when wl-message-use-header-narrowing
944     (save-excursion
945       (goto-char (point-min))
946       (if (re-search-forward "^$" nil t)
947           (beginning-of-line)
948         (goto-char (point-max)))
949       (let ((ovs (overlays-in (point-min) (point)))
950             ov hn-ovs)
951         (while (setq ov (car ovs))
952           (when (overlay-get ov 'wl-message-header-narrowing)
953             (setq hn-ovs (cons ov hn-ovs)))
954           (setq ovs (cdr ovs)))
955         (if hn-ovs
956             (while hn-ovs
957               (delete-overlay (car hn-ovs))
958               (setq hn-ovs (cdr hn-ovs)))
959           (wl-message-header-narrowing))))))
960
961 (require 'product)
962 (product-provide (provide 'wl-message) (require 'wl-version))
963
964 ;;; wl-message.el ends here