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)
35 (require 'elmo-mime) ; XXX should modify for tm.
43 (defalias-maybe 'event-window 'ignore)
44 (defalias-maybe 'posn-window 'ignore)
45 (defalias-maybe 'event-start 'ignore)
46 (defalias-maybe 'mime-open-entity 'ignore))
48 (defconst wl-message-buffer-prefetch-idle-time
49 (if (featurep 'lisp-float-type) (/ (float 1) (float 5)) 1))
50 (defvar wl-message-buffer-prefetch-get-next-function
51 'wl-summary-default-get-next-msg)
53 (defvar wl-message-buffer-prefetch-folder-type-list t)
55 (defvar wl-message-buffer-prefetch-debug t)
57 (defvar wl-message-buffer nil) ; message buffer.
59 (defvar wl-message-buffer-cur-summary-buffer nil)
60 (defvar wl-message-buffer-cur-folder nil)
61 (defvar wl-message-buffer-cur-number nil)
62 (defvar wl-message-buffer-cur-flag nil)
63 (defvar wl-message-buffer-cur-summary-buffer nil)
64 (defvar wl-message-buffer-original-buffer nil) ; original buffer.
66 (make-variable-buffer-local 'wl-message-buffer-cur-folder)
67 (make-variable-buffer-local 'wl-message-buffer-cur-number)
68 (make-variable-buffer-local 'wl-message-buffer-cur-flag)
69 (make-variable-buffer-local 'wl-message-buffer-cur-summary-buffer)
70 (make-variable-buffer-local 'wl-message-buffer-original-buffer)
72 (defvar wl-fixed-window-configuration nil)
74 (defvar wl-message-buffer-cache-size 10) ; At least 1.
76 ;;; Message buffer cache.
78 (defvar wl-message-buffer-cache nil
79 "Message cache. (old ... new) order alist.
80 With association ((\"folder\" message \"message-id\") . cache-buffer).")
82 (defmacro wl-message-buffer-cache-buffer-get (entry)
85 (defmacro wl-message-buffer-cache-folder-get (entry)
86 (` (car (car (, entry)))))
88 (defmacro wl-message-buffer-cache-message-get (entry)
89 (` (cdr (car (, entry)))))
91 (defmacro wl-message-buffer-cache-entry-make (key buf)
92 (` (cons (, key) (, buf))))
94 (defmacro wl-message-buffer-cache-hit (key)
95 "Return value assosiated with key."
96 (` (wl-message-buffer-cache-buffer-get
97 (assoc (, key) wl-message-buffer-cache))))
99 (defun wl-message-buffer-cache-sort (entry)
100 "Move ENTRY to the top of `wl-message-buffer-cache'."
101 (setq wl-message-buffer-cache
102 (cons entry (delete entry wl-message-buffer-cache))))
103 ; (let* ((pointer (cons nil wl-message-buffer-cache))
105 ; (while (cdr pointer)
106 ; (if (equal (car (cdr pointer)) entry)
107 ; (setcdr pointer (cdr (cdr pointer)))
108 ; (setq pointer (cdr pointer))))
109 ; (setcdr pointer (list entry))
110 ; (setq wl-message-buffer-cache (cdr top))))
112 (defconst wl-message-buffer-cache-name " *WL:Message*")
113 (defconst wl-original-message-buffer-name " *Original*")
115 (defun wl-original-message-mode ()
116 "A major mode for original message buffer."
117 (setq major-mode 'wl-original-message-mode)
118 (setq buffer-read-only t)
119 (elmo-set-buffer-multibyte nil)
120 (setq mode-name "Wanderlust original message"))
122 (defun wl-original-message-buffer-get (name)
123 "Get original message buffer for NAME.
124 If original message buffer already exists, it is re-used."
125 (let* ((name (concat wl-original-message-buffer-name name))
126 (buffer (get-buffer name)))
127 (unless (and buffer (buffer-live-p buffer))
128 (with-current-buffer (setq buffer (get-buffer-create name))
129 (wl-original-message-mode)))
132 (defun wl-message-buffer-create ()
133 "Create a new message buffer."
134 (let* ((buffer (generate-new-buffer wl-message-buffer-cache-name))
135 (name (buffer-name buffer)))
136 (with-current-buffer buffer
137 (setq wl-message-buffer-original-buffer
138 (wl-original-message-buffer-get name)))
141 (defun wl-message-buffer-cache-add (key)
142 "Add (KEY . buf) to the top of `wl-message-buffer-cache'.
143 Return its cache buffer."
144 (let ((len (length wl-message-buffer-cache))
146 (if (< len wl-message-buffer-cache-size)
147 (setq buf (wl-message-buffer-create))
148 (setq buf (wl-message-buffer-cache-buffer-get
149 (nth (1- len) wl-message-buffer-cache)))
150 (setcdr (nthcdr (- len 2) wl-message-buffer-cache) nil))
151 (setq wl-message-buffer-cache
152 (cons (wl-message-buffer-cache-entry-make key buf)
153 wl-message-buffer-cache))
156 (defun wl-message-buffer-cache-delete (&optional key)
157 "Delete the most recent cache entry"
159 (setq wl-message-buffer-cache
160 (delq (assoc key wl-message-buffer-cache)
161 wl-message-buffer-cache))
162 (let ((buf (wl-message-buffer-cache-buffer-get
163 (car wl-message-buffer-cache))))
164 (setq wl-message-buffer-cache
165 (nconc (cdr wl-message-buffer-cache)
166 (list (wl-message-buffer-cache-entry-make nil buf)))))))
168 (defun wl-message-buffer-cache-clean-up ()
169 "A function to flush all decoded messages in cache list."
171 (if (and (eq major-mode 'wl-summary-mode)
173 (get-buffer-window wl-message-buffer))
174 (delete-window (get-buffer-window wl-message-buffer)))
175 (wl-kill-buffers (regexp-quote wl-message-buffer-cache-name))
176 (setq wl-message-buffer-cache nil))
178 ;;; Message buffer handling from summary buffer.
180 (defun wl-message-buffer-window ()
181 "Get message buffer window if any."
182 (let* ((start-win (selected-window))
186 (setq cur-win (next-window cur-win))
187 (with-current-buffer (window-buffer cur-win)
188 (if (or (eq major-mode 'wl-message-mode)
189 (eq major-mode 'mime-view-mode))
190 (throw 'found cur-win)))
191 (not (eq cur-win start-win)))))))
193 (defun wl-message-select-buffer (buffer)
194 "Select BUFFER as a message buffer."
195 (let ((window (get-buffer-window buffer))
196 (sum (car wl-message-window-size))
197 (mes (cdr wl-message-window-size))
200 (not (eq (save-excursion (set-buffer (window-buffer window))
201 wl-message-buffer-cur-summary-buffer)
203 (delete-window window)
204 (run-hooks 'wl-message-window-deleted-hook)
207 (select-window window)
208 (when wl-fixed-window-configuration
209 (delete-other-windows)
210 (and wl-stay-folder-window
211 (wl-summary-toggle-disp-folder)))
212 ;; There's no buffer window. Search for message window and snatch it.
213 (if (setq window (wl-message-buffer-window))
214 (select-window window)
215 (setq whi (1- (window-height)))
218 (let ((total (+ sum mes)))
219 (setq sum (max window-min-height (/ (* whi sum) total)))
220 (setq mes (max window-min-height (/ (* whi mes) total))))
221 (if (< whi (+ sum mes))
222 (enlarge-window (- (+ sum mes) whi)))))
223 (split-window (get-buffer-window (current-buffer)) sum)
225 (switch-to-buffer buffer)))
227 (defun wl-message-narrow-to-page (&optional arg)
229 If ARG is specified, narrow to ARGth page."
231 (setq arg (if arg (prefix-numeric-value arg) 0))
234 (forward-page -1) ; Beginning of current page.
236 (goto-char (point-min))))
237 (forward-char 1) ; for compatibility with emacs-19.28 and emacs-19.29
240 ((> arg 0) (forward-page arg))
241 ((< arg 0) (forward-page (1- arg))))
244 (narrow-to-region (point)
247 (if (and (eolp) (not (bobp)))
251 (defun wl-message-prev-page (&optional lines)
252 "Scroll down current message by LINES.
253 Returns non-nil if top of message."
255 (if (buffer-live-p wl-message-buffer)
256 (let ((cur-buf (current-buffer))
258 (wl-message-select-buffer wl-message-buffer)
259 (move-to-window-line 0)
260 (if (and wl-break-pages
262 (not (save-restriction (widen) (bobp))))
264 (wl-message-narrow-to-page -1)
265 (goto-char (point-max))
272 (select-window (get-buffer-window cur-buf))
275 (defun wl-message-next-page (&optional lines)
276 "Scroll up current message by LINES.
277 Returns non-nil if bottom of message."
279 (if (buffer-live-p wl-message-buffer)
280 (let ((cur-buf (current-buffer))
282 (wl-message-select-buffer wl-message-buffer)
283 (move-to-window-line -1)
286 (and (pos-visible-in-window-p)
288 (if (or (null wl-break-pages)
291 (widen) (forward-line) (eobp))))
293 (wl-message-narrow-to-page 1)
296 (static-if (boundp 'window-pixel-scroll-increment)
297 ;; XEmacs 21.2.20 and later.
298 (let (window-pixel-scroll-increment)
302 (goto-char (point-max))))
304 (select-window (get-buffer-window cur-buf))
308 (defun wl-message-follow-current-entity (buffer)
309 "Follow to current message."
310 (wl-draft-reply (wl-message-get-original-buffer)
311 nil wl-message-buffer-cur-summary-buffer) ; reply to all
312 (let ((mail-reply-buffer buffer))
313 (wl-draft-yank-from-mail-reply-buffer nil)))
317 (defun wl-message-mode ()
318 "A major mode for message displaying."
320 (setq major-mode 'wl-message-mode)
321 (setq buffer-read-only t)
322 (setq mode-name "Message"))
324 (defun wl-message-exit ()
325 "Move to summary buffer."
327 (let (summary-buf summary-win)
328 (if (setq summary-buf wl-message-buffer-cur-summary-buffer)
329 (if (setq summary-win (get-buffer-window summary-buf))
330 (select-window summary-win)
331 (switch-to-buffer summary-buf)
332 (wl-message-select-buffer wl-message-buffer)
333 (select-window (get-buffer-window summary-buf))))
334 (run-hooks 'wl-message-exit-hook)))
336 (defun wl-message-toggle-disp-summary ()
338 (let ((summary-buf (get-buffer wl-message-buffer-cur-summary-buffer))
341 (buffer-live-p summary-buf))
342 (if (setq summary-win (get-buffer-window summary-buf))
343 (delete-window summary-win)
344 (switch-to-buffer summary-buf)
345 (wl-message-select-buffer wl-message-buffer))
346 (wl-summary-goto-folder-subr wl-message-buffer-cur-folder 'no-sync
349 (let ((sum-buf (current-buffer)))
350 (wl-message-select-buffer wl-message-buffer)
351 (setq wl-message-buffer-cur-summary-buffer sum-buf)))))
353 (defun wl-message-get-original-buffer ()
354 "Get original buffer for current message buffer."
355 wl-message-buffer-original-buffer)
357 (defun wl-message-redisplay (folder number flag &optional force-reload)
358 (let* ((default-mime-charset wl-mime-charset)
359 (buffer-read-only nil)
360 (summary-buf (current-buffer))
364 header-end real-fld-num summary-win)
365 (setq buffer-read-only nil)
366 (setq cache-used (wl-message-buffer-display
367 folder number flag force-reload))
368 (setq wl-message-buffer (car cache-used))
369 (setq message-buf wl-message-buffer)
370 (wl-message-select-buffer wl-message-buffer)
372 (set-buffer message-buf)
373 (setq buffer-read-only nil)
374 (setq wl-message-buffer-cur-summary-buffer summary-buf)
375 (setq wl-message-buffer-cur-folder (elmo-folder-name-internal folder))
376 (setq wl-message-buffer-cur-number number)
377 (wl-message-overload-functions)
378 (setq mode-line-buffer-identification
379 (format "Wanderlust: << %s / %s >>"
380 (if (memq 'modeline wl-use-folder-petname)
381 (wl-folder-get-petname (elmo-folder-name-internal
383 (elmo-folder-name-internal folder)) number))
385 ; (when wl-highlight-body-too
386 ; (wl-highlight-body))
388 (wl-message-narrow-to-page)
389 (error nil)); ignore errors.
390 (setq cache-used (cdr cache-used))
391 (goto-char (point-min))
394 (run-hooks 'wl-message-redisplay-hook))
395 ;; go back to summary mode
396 (set-buffer-modified-p nil)
397 (setq buffer-read-only t)
398 (set-buffer summary-buf)
399 (setq summary-win (get-buffer-window summary-buf))
400 (if (window-live-p summary-win)
401 (select-window summary-win)))
404 ;; Use message buffer cache.
405 (defun wl-message-buffer-display (folder number flag
406 &optional force-reload unread)
407 (let* ((msg-id (elmo-message-field folder number 'message-id))
408 (fname (elmo-folder-name-internal folder))
409 (hit (wl-message-buffer-cache-hit (list fname number msg-id)))
412 (when (and hit (not (buffer-live-p hit)))
413 (wl-message-buffer-cache-delete (list fname number msg-id))
417 ;; move hit to the top.
418 (wl-message-buffer-cache-sort
419 (wl-message-buffer-cache-entry-make (list fname number msg-id) hit))
420 ;; buffer cache is used.
422 (with-current-buffer hit
423 (unless (eq wl-message-buffer-cur-flag flag)
425 ;; delete tail and add new to the top.
426 (setq hit (wl-message-buffer-cache-add (list fname number msg-id)))
428 (if (or force-reload read)
434 (wl-message-display-internal folder number flag
435 force-reload unread))
436 (setq wl-message-buffer-cur-flag flag))
438 (wl-message-buffer-cache-delete)
439 (error "Display message %s/%s is quitted" fname number))
441 (wl-message-buffer-cache-delete)
442 (signal (car err) (cdr err))
443 nil))) ;; will not be used
444 (cons hit cache-used)))
446 (defun wl-message-display-internal (folder number flag
447 &optional force-reload unread)
448 (let ((elmo-message-ignored-field-list
449 (if (eq flag 'all-header)
451 wl-message-ignored-field-list))
452 (elmo-message-visible-field-list wl-message-visible-field-list)
453 (elmo-message-sorted-field-list wl-message-sort-field-list)
454 (elmo-message-fetch-threshold wl-fetch-confirm-threshold))
457 (let (wl-highlight-x-face-function)
458 (elmo-mime-display-as-is folder number
460 (wl-message-get-original-buffer)
461 'wl-original-message-mode
464 (elmo-mime-message-display folder number
466 (wl-message-get-original-buffer)
467 'wl-original-message-mode
470 (setq buffer-read-only t))))
472 (defsubst wl-message-buffer-prefetch-p (folder &optional number)
474 ((eq wl-message-buffer-prefetch-folder-type-list t)
476 ((and number wl-message-buffer-prefetch-folder-type-list)
477 (memq (elmo-folder-type-internal
478 (elmo-message-folder folder number))
479 wl-message-buffer-prefetch-folder-type-list))
480 (wl-message-buffer-prefetch-folder-type-list
481 (let ((list wl-message-buffer-prefetch-folder-type-list)
484 (while (setq type (pop list))
485 (if (elmo-folder-contains-type folder type)
487 ((consp wl-message-buffer-prefetch-folder-type-list)
488 (wl-string-match-member (elmo-folder-name-internal folder)
489 wl-message-buffer-prefetch-folder-type-list))
490 (t wl-message-buffer-prefetch-folder-type-list)))
493 (defvar wl-message-buffer-prefetch-timer nil)
495 (defun wl-message-buffer-prefetch-next (folder number &optional
497 (if (wl-message-buffer-prefetch-p folder)
498 (with-current-buffer (or summary (get-buffer wl-summary-buffer-name))
499 (let* ((next (funcall wl-message-buffer-prefetch-get-next-function
501 (when (and next (wl-message-buffer-prefetch-p folder next))
502 (if (not (fboundp 'run-with-idle-timer))
503 (when (sit-for wl-message-buffer-prefetch-idle-time)
504 (wl-message-buffer-prefetch folder next summary charset))
505 (unless wl-message-buffer-prefetch-timer
506 (setq wl-message-buffer-prefetch-timer
508 wl-message-buffer-prefetch-idle-time
510 'wl-message-buffer-prefetch
511 folder next summary charset)))))))))
513 (defun wl-message-buffer-prefetch (folder number summary charset)
514 (when (buffer-live-p summary)
517 (when (string= (elmo-folder-name-internal folder)
518 (wl-summary-buffer-folder-name))
519 (let ((message-id (elmo-message-field folder number 'message-id))
520 (wl-mime-charset charset)
521 (default-mime-charset charset)
522 result time1 time2 sec micro)
523 (if (not (wl-message-buffer-cache-hit (list folder
525 (let* ((size (elmo-message-field folder number 'size)))
526 (when (or (elmo-message-file-p folder number)
529 elmo-message-fetch-threshold
531 elmo-message-fetch-threshold))))
532 ;;(not (elmo-file-cache-exists-p message-id)))))
533 (when wl-message-buffer-prefetch-debug
534 (setq time1 (current-time))
535 (message "Prefetching %d..." number))
536 (setq result (wl-message-buffer-display folder number
538 (when wl-message-buffer-prefetch-debug
539 (setq time2 (current-time))
540 (setq sec (- (nth 1 time2)(nth 1 time1)))
541 (setq micro (- (nth 2 time2)(nth 2 time1)))
542 (setq micro (+ micro (* 1000000 sec)))
543 (message "Prefetching %d...done(%f msec)."
545 (/ micro 1000.0))))))))))
546 (setq wl-message-buffer-prefetch-timer nil))
548 (defvar wl-message-button-map (make-sparse-keymap))
550 (defun wl-message-add-button (from to function &optional data)
551 "Create a button between FROM and TO with callback FUNCTION and DATA."
554 (nconc (list 'wl-message-button-callback function)
556 (list 'wl-message-button-data data))))
557 (let ((ov (make-overlay from to)))
558 (overlay-put ov 'mouse-face 'highlight)
559 (overlay-put ov 'local-map wl-message-button-map)
560 (overlay-put ov 'evaporate t)))
562 (defun wl-message-button-dispatcher (event)
563 "Select the button under point."
565 (mouse-set-point event)
566 (let ((callback (get-text-property (point) 'wl-message-button-callback))
567 (data (get-text-property (point) 'wl-message-button-data)))
569 (funcall callback data)
570 (wl-message-button-dispatcher-internal event))))
572 (defun wl-message-button-refer-article (data)
573 "Read article specified by Message-ID DATA at point."
574 (switch-to-buffer-other-window
575 wl-message-buffer-cur-summary-buffer)
576 (if (wl-summary-jump-to-msg-by-message-id data)
577 (wl-summary-redisplay)))
579 (defun wl-message-refer-article-or-url (e)
580 "Read article specified by message-id around point.
581 If failed, attempt to execute button-dispatcher."
583 (let ((window (get-buffer-window (current-buffer)))
584 mouse-window point beg end msg-id)
588 (setq mouse-window (get-buffer-window (current-buffer)))
590 (setq beg (save-excursion (beginning-of-line) (point)))
591 (setq end (save-excursion (end-of-line) (point)))
592 (search-forward ">" end t) ;Move point to end of "<....>".
593 (if (and (re-search-backward "\\(<[^<> \t\n]+@[^<> \t\n]+>\\)"
595 (not (string-match "mailto:"
596 (setq msg-id (wl-match-buffer 1)))))
599 (switch-to-buffer-other-window
600 wl-message-buffer-cur-summary-buffer)
601 (if (wl-summary-jump-to-msg-by-message-id msg-id)
602 (wl-summary-redisplay)))
603 (wl-message-button-dispatcher-internal e)))
604 (if (eq mouse-window (get-buffer-window (current-buffer)))
605 (select-window window)))))
607 (defun wl-message-uu-substring (buf outbuf &optional first last)
610 (search-forward "\n\n")
612 ep filename case-fold-search)
616 (if (re-search-forward "^begin[ \t]+[0-9]+[ \t]+\\([^ ].*\\)" nil t)
617 (setq filename (buffer-substring (match-beginning 1)(match-end 1)))
619 (re-search-forward "^M.*$" nil t)) ; uuencoded string
622 (goto-char (point-max))
624 (re-search-backward "^end" sp t)
625 (re-search-backward "^M.*$" sp t)) ; uuencoded string
629 (goto-char (point-max))
630 (insert-buffer-substring buf sp ep)
635 (product-provide (provide 'wl-message) (require 'wl-version))
637 ;;; wl-message.el ends here