1 ;;; wl-message.el --- Message displaying modules for Wanderlust.
3 ;; Copyright (C) 1998,1999,2000 Yuuichi Teranishi <teranisi@gohome.org>
5 ;; Author: Yuuichi Teranishi <teranisi@gohome.org>
6 ;; Keywords: mail, net news
8 ;; This file is part of Wanderlust (Yet Another Message Interface on Emacsen).
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)
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.
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.
33 (require 'wl-highlight)
40 (defalias-maybe 'event-window 'ignore)
41 (defalias-maybe 'posn-window 'ignore)
42 (defalias-maybe 'event-start 'ignore)
43 (defalias-maybe 'mime-open-entity 'ignore))
45 (defconst wl-message-buffer-prefetch-idle-time
46 (if (featurep 'lisp-float-type) (/ (float 1) (float 5)) 1))
47 (defvar wl-message-buffer-prefetch-get-next-function
48 'wl-summary-default-get-next-msg)
50 (defvar wl-message-buffer-prefetch-debug nil)
52 (defvar wl-message-buffer nil) ; message buffer.
54 (defvar wl-message-buffer-cur-summary-buffer nil)
55 (defvar wl-message-buffer-cur-folder nil)
56 (defvar wl-message-buffer-cur-number nil)
57 (defvar wl-message-buffer-cur-flag nil)
58 (defvar wl-message-buffer-cur-summary-buffer nil)
59 (defvar wl-message-buffer-original-buffer nil) ; original buffer.
60 (defvar wl-message-buffer-all-header-flag nil)
62 (make-variable-buffer-local 'wl-message-buffer-cur-folder)
63 (make-variable-buffer-local 'wl-message-buffer-cur-number)
64 (make-variable-buffer-local 'wl-message-buffer-cur-flag)
65 (make-variable-buffer-local 'wl-message-buffer-cur-summary-buffer)
66 (make-variable-buffer-local 'wl-message-buffer-original-buffer)
67 (make-variable-buffer-local 'wl-message-buffer-all-header-flag)
69 (defvar wl-fixed-window-configuration nil)
71 (defvar wl-message-buffer-cache-size 10) ; At least 1.
73 ;;; Message buffer cache.
75 (defvar wl-message-buffer-cache nil
76 "Message cache. (old ... new) order alist.
77 With association ((\"folder\" message \"message-id\") . cache-buffer).")
79 (defmacro wl-message-buffer-cache-buffer-get (entry)
82 (defmacro wl-message-buffer-cache-folder-get (entry)
83 (` (car (car (, entry)))))
85 (defmacro wl-message-buffer-cache-message-get (entry)
86 (` (cdr (car (, entry)))))
88 (defmacro wl-message-buffer-cache-entry-make (key buf)
89 (` (cons (, key) (, buf))))
91 (defmacro wl-message-buffer-cache-hit (key)
92 "Return value assosiated with key."
93 (` (wl-message-buffer-cache-buffer-get
94 (assoc (, key) wl-message-buffer-cache))))
96 (defun wl-message-buffer-cache-sort (entry)
97 "Move ENTRY to the top of `wl-message-buffer-cache'."
98 (setq wl-message-buffer-cache
99 (cons entry (delete entry wl-message-buffer-cache))))
100 ; (let* ((pointer (cons nil wl-message-buffer-cache))
102 ; (while (cdr pointer)
103 ; (if (equal (car (cdr pointer)) entry)
104 ; (setcdr pointer (cdr (cdr pointer)))
105 ; (setq pointer (cdr pointer))))
106 ; (setcdr pointer (list entry))
107 ; (setq wl-message-buffer-cache (cdr top))))
109 (defconst wl-message-buffer-cache-name " *WL:Message*")
110 (defconst wl-original-message-buffer-name " *Original*")
112 (defun wl-original-message-mode ()
113 "A major mode for original message buffer."
114 (setq major-mode 'wl-original-message-mode)
115 (setq buffer-read-only t)
116 (elmo-set-buffer-multibyte nil)
117 (setq mode-name "Wanderlust original message"))
119 (defun wl-original-message-buffer-get (name)
120 "Get original message buffer for NAME.
121 If original message buffer already exists, it is re-used."
122 (let* ((name (concat wl-original-message-buffer-name name))
123 (buffer (get-buffer name)))
124 (unless (and buffer (buffer-live-p buffer))
125 (with-current-buffer (setq buffer (get-buffer-create name))
126 (wl-original-message-mode)))
129 (defun wl-message-buffer-create ()
130 "Create a new message buffer."
131 (let* ((buffer (generate-new-buffer wl-message-buffer-cache-name))
132 (name (buffer-name buffer)))
133 (with-current-buffer buffer
134 (setq wl-message-buffer-original-buffer
135 (wl-original-message-buffer-get name)))
138 (defun wl-message-buffer-cache-add (key)
139 "Add (KEY . buf) to the top of `wl-message-buffer-cache'.
140 Return its cache buffer."
141 (let ((len (length wl-message-buffer-cache))
143 (if (< len wl-message-buffer-cache-size)
144 (setq buf (wl-message-buffer-create))
145 (setq buf (wl-message-buffer-cache-buffer-get
146 (nth (1- len) wl-message-buffer-cache)))
147 (setcdr (nthcdr (- len 2) wl-message-buffer-cache) nil))
148 (setq wl-message-buffer-cache
149 (cons (wl-message-buffer-cache-entry-make key buf)
150 wl-message-buffer-cache))
153 (defun wl-message-buffer-cache-delete (&optional key)
154 "Delete the most recent cache entry"
156 (setq wl-message-buffer-cache
157 (delq (assoc key wl-message-buffer-cache)
158 wl-message-buffer-cache))
159 (let ((buf (wl-message-buffer-cache-buffer-get
160 (car wl-message-buffer-cache))))
161 (setq wl-message-buffer-cache
162 (nconc (cdr wl-message-buffer-cache)
163 (list (wl-message-buffer-cache-entry-make nil buf)))))))
165 (defun wl-message-buffer-cache-clean-up ()
166 "A function to flush all decoded messages in cache list."
168 (if (and (eq major-mode 'wl-summary-mode)
170 (get-buffer-window wl-message-buffer))
171 (delete-window (get-buffer-window wl-message-buffer)))
172 (wl-kill-buffers (regexp-quote wl-message-buffer-cache-name))
173 (setq wl-message-buffer-cache nil))
175 ;;; Message buffer handling from summary buffer.
177 (defun wl-message-buffer-window ()
178 "Get message buffer window if any."
179 (let* ((start-win (selected-window))
183 (setq cur-win (next-window cur-win))
184 (with-current-buffer (window-buffer cur-win)
185 (if (or (eq major-mode 'wl-message-mode)
186 (eq major-mode 'mime-view-mode))
187 (throw 'found cur-win)))
188 (not (eq cur-win start-win)))))))
190 (defun wl-message-select-buffer (buffer)
191 "Select BUFFER as a message buffer."
192 (let ((window (get-buffer-window buffer))
193 (sum (car wl-message-window-size))
194 (mes (cdr wl-message-window-size))
197 (not (eq (save-excursion (set-buffer (window-buffer window))
198 wl-message-buffer-cur-summary-buffer)
200 (delete-window window)
201 (run-hooks 'wl-message-window-deleted-hook)
204 (select-window window)
205 (when wl-fixed-window-configuration
206 (delete-other-windows)
207 (and wl-stay-folder-window
208 (wl-summary-toggle-disp-folder)))
209 ;; There's no buffer window. Search for message window and snatch it.
210 (if (setq window (wl-message-buffer-window))
211 (select-window window)
212 (setq whi (1- (window-height)))
215 (let ((total (+ sum mes)))
216 (setq sum (max window-min-height (/ (* whi sum) total)))
217 (setq mes (max window-min-height (/ (* whi mes) total))))
218 (if (< whi (+ sum mes))
219 (enlarge-window (- (+ sum mes) whi)))))
220 (split-window (get-buffer-window (current-buffer)) sum)
222 (switch-to-buffer buffer)))
224 (defun wl-message-narrow-to-page (&optional arg)
226 If ARG is specified, narrow to ARGth page."
228 (setq arg (if arg (prefix-numeric-value arg) 0))
231 (forward-page -1) ; Beginning of current page.
233 (goto-char (point-min))))
234 (forward-char 1) ; for compatibility with emacs-19.28 and emacs-19.29
237 ((> arg 0) (forward-page arg))
238 ((< arg 0) (forward-page (1- arg))))
241 (narrow-to-region (point)
244 (if (and (eolp) (not (bobp)))
248 (defun wl-message-prev-page (&optional lines)
249 "Scroll down current message by LINES.
250 Returns non-nil if top of message."
252 (let (cur-buf top real-top)
253 (unless (eq major-mode 'mime-view-mode)
254 (when (buffer-live-p wl-message-buffer)
255 (setq cur-buf (current-buffer))
256 (wl-message-select-buffer wl-message-buffer)))
257 (move-to-window-line 0)
258 (if (and wl-break-pages
260 (not (setq real-top (save-restriction (widen) (bobp)))))
262 (wl-message-narrow-to-page -1)
263 (goto-char (point-max))
271 (let ((f (assq (mime-preview-original-major-mode)
272 mime-preview-over-to-previous-method-alist)))
273 (if f (funcall (cdr f))))
275 (select-window (get-buffer-window cur-buf))))
278 (defun wl-message-next-page (&optional lines)
279 "Scroll up current message by LINES.
280 Returns non-nil if bottom of message."
282 (let (cur-buf bottom)
283 (unless (eq major-mode 'mime-view-mode)
284 (when (buffer-live-p wl-message-buffer)
285 (setq cur-buf (current-buffer))
286 (wl-message-select-buffer wl-message-buffer)))
287 (move-to-window-line -1)
290 (and (pos-visible-in-window-p)
292 (if (or (null wl-break-pages)
295 (widen) (forward-line) (eobp))))
297 (wl-message-narrow-to-page 1)
300 (static-if (boundp 'window-pixel-scroll-increment)
301 ;; XEmacs 21.2.20 and later.
302 (let (window-pixel-scroll-increment)
306 (goto-char (point-max))))
309 (let ((f (assq (mime-preview-original-major-mode)
310 mime-preview-over-to-next-method-alist)))
311 (if f (funcall (cdr f))))
313 (select-window (get-buffer-window cur-buf))))
317 (defun wl-message-follow-current-entity (buffer)
318 "Follow to current message."
319 (wl-draft-reply (wl-message-get-original-buffer)
320 nil wl-message-buffer-cur-summary-buffer) ; reply to all
321 (let ((mail-reply-buffer buffer))
322 (wl-draft-yank-from-mail-reply-buffer nil)))
326 (defun wl-message-mode ()
327 "A major mode for message displaying."
329 (setq major-mode 'wl-message-mode)
330 (setq buffer-read-only t)
331 (setq mode-name "Message"))
333 (defun wl-message-exit ()
334 "Move to summary buffer."
336 (let (summary-buf summary-win)
337 (if (setq summary-buf wl-message-buffer-cur-summary-buffer)
338 (if (setq summary-win (get-buffer-window summary-buf))
339 (select-window summary-win)
340 (switch-to-buffer summary-buf)
341 (wl-message-select-buffer wl-message-buffer)
342 (select-window (get-buffer-window summary-buf))))
343 (run-hooks 'wl-message-exit-hook)))
345 (defun wl-message-toggle-disp-summary ()
347 (let ((summary-buf (get-buffer wl-message-buffer-cur-summary-buffer))
350 (buffer-live-p summary-buf))
351 (if (setq summary-win (get-buffer-window summary-buf))
352 (delete-window summary-win)
353 (switch-to-buffer summary-buf)
354 (wl-message-select-buffer wl-message-buffer))
355 (wl-summary-goto-folder-subr wl-message-buffer-cur-folder 'no-sync
358 (let ((sum-buf (current-buffer)))
359 (wl-message-select-buffer wl-message-buffer)
360 (setq wl-message-buffer-cur-summary-buffer sum-buf)))))
362 (defun wl-message-get-original-buffer ()
363 "Get original buffer for current message buffer."
364 wl-message-buffer-original-buffer)
366 (defun wl-message-add-buttons-to-body (start end)
369 (narrow-to-region start end)
370 (let ((case-fold-search t)
371 (alist wl-message-body-button-alist)
374 (setq entry (car alist)
376 (goto-char (point-min))
377 (while (re-search-forward (car entry) (+ (point) (nth 4 entry)) t)
378 (unless (get-text-property (point) 'keymap)
379 (wl-message-add-button
380 (match-beginning (nth 1 entry))
381 (match-end (nth 1 entry))
383 (match-string (nth 3 entry))))))))))
385 (defun wl-message-add-buttons-to-header (start end)
388 (narrow-to-region start end)
389 (let ((case-fold-search t)
390 (alist wl-message-header-button-alist)
393 (setq entry (car alist)
395 (goto-char (point-min))
396 (while (re-search-forward (car entry) nil t)
397 (setq start (match-beginning 0)
398 end (if (re-search-forward "^[^ \t]" nil t)
402 (while (re-search-forward (nth 1 entry) end t)
403 (goto-char (match-end 0))
404 (wl-message-add-button
405 (match-beginning (nth 2 entry))
406 (match-end (nth 2 entry))
407 (nth 3 entry) (match-string (nth 4 entry))))
408 (goto-char end)))))))
410 (defun wl-message-redisplay (folder number flag &optional force-reload)
411 (let* ((default-mime-charset wl-mime-charset)
412 (buffer-read-only nil)
413 (summary-buf (current-buffer))
417 header-end real-fld-num summary-win delim)
418 (setq buffer-read-only nil)
419 (setq cache-used (wl-message-buffer-display
420 folder number flag force-reload))
421 (setq wl-message-buffer (car cache-used))
422 (setq message-buf wl-message-buffer)
423 (wl-message-select-buffer wl-message-buffer)
425 (set-buffer message-buf)
426 (make-local-variable 'truncate-partial-width-windows)
427 (setq truncate-partial-width-windows nil)
428 (setq truncate-lines wl-message-truncate-lines)
429 (setq buffer-read-only nil)
430 (setq wl-message-buffer-cur-summary-buffer summary-buf)
431 (setq wl-message-buffer-cur-folder (elmo-folder-name-internal folder))
432 (setq wl-message-buffer-cur-number number)
433 (setq mode-line-buffer-identification
434 (format "Wanderlust: << %s / %s >>"
435 (if (memq 'modeline wl-use-folder-petname)
436 (wl-folder-get-petname (elmo-folder-name-internal
438 (elmo-folder-name-internal folder)) number))
440 ; (when wl-highlight-body-too
441 ; (wl-highlight-body))
443 (wl-message-narrow-to-page)
444 (error nil)); ignore errors.
445 (setq cache-used (cdr cache-used))
446 (goto-char (point-min))
447 (when (re-search-forward "^$" nil t)
448 (wl-message-add-buttons-to-header (point-min) (point))
449 (wl-message-add-buttons-to-body (point) (point-max)))
450 (goto-char (point-min))
453 (run-hooks 'wl-message-redisplay-hook))
454 ;; go back to summary mode
455 (set-buffer-modified-p nil)
456 (setq buffer-read-only t)
457 (set-buffer summary-buf)
458 (setq summary-win (get-buffer-window summary-buf))
459 (if (window-live-p summary-win)
460 (select-window summary-win)))
463 ;; Use message buffer cache.
464 (defun wl-message-buffer-display (folder number flag
465 &optional force-reload unread)
466 (let* ((msg-id (elmo-message-field folder number 'message-id))
467 (fname (elmo-folder-name-internal folder))
468 (hit (wl-message-buffer-cache-hit (list fname number msg-id)))
471 (when (and hit (not (buffer-live-p hit)))
472 (wl-message-buffer-cache-delete (list fname number msg-id))
476 ;; move hit to the top.
477 (wl-message-buffer-cache-sort
478 (wl-message-buffer-cache-entry-make (list fname number msg-id) hit))
479 ;; buffer cache is used.
481 (with-current-buffer hit
482 (unless (eq wl-message-buffer-cur-flag flag)
484 ;; delete tail and add new to the top.
485 (setq hit (wl-message-buffer-cache-add (list fname number msg-id)))
487 (if (or force-reload read)
493 (wl-message-display-internal folder number flag
494 force-reload unread))
495 (setq wl-message-buffer-cur-flag flag))
497 (wl-message-buffer-cache-delete)
498 (error "Display message %s/%s is quitted" fname number))
500 (wl-message-buffer-cache-delete)
501 (signal (car err) (cdr err))
502 nil))) ;; will not be used
503 (cons hit cache-used)))
505 (defun wl-message-display-internal (folder number flag
506 &optional force-reload unread)
507 (let ((default-mime-charset wl-mime-charset))
508 (setq wl-message-buffer-all-header-flag (eq flag 'all-header))
511 (let (wl-highlight-x-face-function)
512 (prog1 (elmo-mime-display-as-is folder number
514 (wl-message-get-original-buffer)
515 'wl-original-message-mode
518 (wl-message-define-keymap))
519 (let (buffer-read-only)
520 (wl-highlight-message (point-min) (point-max) t))))
521 (elmo-mime-message-display folder number
523 (wl-message-get-original-buffer)
524 'wl-original-message-mode
527 (wl-message-define-keymap)))
528 (run-hooks 'wl-message-display-internal-hook)
529 (setq buffer-read-only t))))
531 (defsubst wl-message-buffer-prefetch-p (folder &optional number)
533 ((eq wl-message-buffer-prefetch-folder-type-list t)
535 ((and number wl-message-buffer-prefetch-folder-type-list)
536 (memq (elmo-folder-type-internal
537 (elmo-message-folder folder number))
538 wl-message-buffer-prefetch-folder-type-list))
539 (wl-message-buffer-prefetch-folder-type-list
540 (let ((list wl-message-buffer-prefetch-folder-type-list)
543 (while (setq type (pop list))
544 (if (elmo-folder-contains-type folder type)
545 (throw 'done t)))))))
547 ((consp wl-message-buffer-prefetch-folder-list)
548 (wl-string-match-member (elmo-folder-name-internal folder)
549 wl-message-buffer-prefetch-folder-list))
550 (t wl-message-buffer-prefetch-folder-list))))
552 (defvar wl-message-buffer-prefetch-timer nil)
554 (defun wl-message-buffer-prefetch-next (folder number &optional
556 (if (wl-message-buffer-prefetch-p folder)
557 (with-current-buffer (or summary (get-buffer wl-summary-buffer-name))
558 (let* ((next (funcall wl-message-buffer-prefetch-get-next-function
560 (when (and next (wl-message-buffer-prefetch-p folder next))
561 (if (not (fboundp 'run-with-idle-timer))
562 (when (sit-for wl-message-buffer-prefetch-idle-time)
563 (wl-message-buffer-prefetch folder next summary charset))
564 (unless wl-message-buffer-prefetch-timer
565 (setq wl-message-buffer-prefetch-timer
567 wl-message-buffer-prefetch-idle-time
569 'wl-message-buffer-prefetch
570 folder next summary charset)))))))))
572 (defun wl-message-buffer-prefetch (folder number summary charset)
573 (when (buffer-live-p summary)
576 (when (string= (elmo-folder-name-internal folder)
577 (wl-summary-buffer-folder-name))
578 (let ((message-id (elmo-message-field folder number 'message-id))
579 (wl-mime-charset charset)
580 (default-mime-charset charset)
581 result time1 time2 sec micro)
582 (if (not (wl-message-buffer-cache-hit (list folder
584 (let* ((size (elmo-message-field folder number 'size)))
585 (when (or (elmo-message-file-p folder number)
588 elmo-message-fetch-threshold
590 elmo-message-fetch-threshold))))
591 ;;(not (elmo-file-cache-exists-p message-id)))))
592 (when wl-message-buffer-prefetch-debug
593 (setq time1 (current-time))
594 (message "Prefetching %d..." number))
595 (setq result (wl-message-buffer-display folder number
597 (when wl-message-buffer-prefetch-debug
598 (setq time2 (current-time))
599 (setq sec (- (nth 1 time2)(nth 1 time1)))
600 (setq micro (- (nth 2 time2)(nth 2 time1)))
601 (setq micro (+ micro (* 1000000 sec)))
602 (message "Prefetching %d...done(%f msec)."
604 (/ micro 1000.0))))))))))
605 (setq wl-message-buffer-prefetch-timer nil))
607 (defvar wl-message-button-map (make-sparse-keymap))
609 (defun wl-message-add-button (from to function &optional data)
610 "Create a button between FROM and TO with callback FUNCTION and DATA."
613 (nconc (list 'wl-message-button-callback function)
615 (list 'wl-message-button-data data))))
616 (let ((ov (make-overlay from to)))
617 (overlay-put ov 'mouse-face 'highlight)
618 (overlay-put ov 'local-map wl-message-button-map)
619 (overlay-put ov 'evaporate t)))
621 (defun wl-message-button-dispatcher (event)
622 "Select the button under point."
624 (mouse-set-point event)
625 (let ((callback (get-text-property (point) 'wl-message-button-callback))
626 (data (get-text-property (point) 'wl-message-button-data)))
628 (funcall callback data)
629 (wl-message-button-dispatcher-internal event))))
631 (defun wl-message-button-refer-article (data)
632 "Read article specified by Message-ID DATA at point."
633 (switch-to-buffer-other-window
634 wl-message-buffer-cur-summary-buffer)
635 (if (wl-summary-jump-to-msg-by-message-id data)
636 (wl-summary-redisplay)))
638 (defun wl-message-uu-substring (buf outbuf &optional first last)
641 (search-forward "\n\n")
643 ep filename case-fold-search)
647 (if (re-search-forward "^begin[ \t]+[0-9]+[ \t]+\\([^ ].*\\)" nil t)
648 (setq filename (buffer-substring (match-beginning 1)(match-end 1)))
650 (re-search-forward "^M.*$" nil t)) ; uuencoded string
653 (goto-char (point-max))
655 (re-search-backward "^end" sp t)
656 (re-search-backward "^M.*$" sp t)) ; uuencoded string
660 (goto-char (point-max))
661 (insert-buffer-substring buf sp ep)
666 (product-provide (provide 'wl-message) (require 'wl-version))
668 ;;; wl-message.el ends here