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-func
51 'wl-summary-default-get-next-msg)
53 (defvar wl-message-buffer-prefetch-folder-type-list t)
55 (defvar wl-message-buffer-prefetch-debug
57 (defvar wl-message-buffer-prefetch-threshold
60 (defvar wl-message-buffer nil) ; message buffer.
62 (defvar wl-message-buffer-cur-summary-buffer nil)
63 (defvar wl-message-buffer-cur-folder nil)
64 (defvar wl-message-buffer-cur-number nil)
65 (defvar wl-message-buffer-cur-flag nil)
66 (defvar wl-message-buffer-cur-summary-buffer nil)
67 (defvar wl-message-buffer-original-buffer nil) ; original buffer.
69 (make-variable-buffer-local 'wl-message-buffer-cur-folder)
70 (make-variable-buffer-local 'wl-message-buffer-cur-number)
71 (make-variable-buffer-local 'wl-message-buffer-cur-flag)
72 (make-variable-buffer-local 'wl-message-buffer-cur-summary-buffer)
73 (make-variable-buffer-local 'wl-message-buffer-original-buffer)
75 (defvar wl-fixed-window-configuration nil)
77 (defvar wl-message-buffer-cache-size 10) ; At least 1.
79 ;;; Message buffer cache.
81 (defvar wl-message-buffer-cache nil
82 "Message cache. (old ... new) order alist.
83 With association ((\"folder\" message \"message-id\") . cache-buffer).")
85 (defmacro wl-message-buffer-cache-buffer-get (entry)
88 (defmacro wl-message-buffer-cache-folder-get (entry)
89 (` (car (car (, entry)))))
91 (defmacro wl-message-buffer-cache-message-get (entry)
92 (` (cdr (car (, entry)))))
94 (defmacro wl-message-buffer-cache-entry-make (key buf)
95 (` (cons (, key) (, buf))))
97 (defmacro wl-message-buffer-cache-hit (key)
98 "Return value assosiated with key."
99 (` (wl-message-buffer-cache-buffer-get
100 (assoc (, key) wl-message-buffer-cache))))
102 (defun wl-message-buffer-cache-sort (entry)
103 "Move ENTRY to the top of `wl-message-buffer-cache'."
104 (setq wl-message-buffer-cache
105 (cons entry (delete entry wl-message-buffer-cache))))
106 ; (let* ((pointer (cons nil wl-message-buffer-cache))
108 ; (while (cdr pointer)
109 ; (if (equal (car (cdr pointer)) entry)
110 ; (setcdr pointer (cdr (cdr pointer)))
111 ; (setq pointer (cdr pointer))))
112 ; (setcdr pointer (list entry))
113 ; (setq wl-message-buffer-cache (cdr top))))
115 (defconst wl-message-buffer-cache-name " *WL:Message*")
116 (defconst wl-original-message-buffer-name " *Original*")
118 (defun wl-original-message-mode ()
119 "A major mode for original message buffer."
120 (setq major-mode 'wl-original-message-mode)
121 (setq buffer-read-only t)
122 (elmo-set-buffer-multibyte nil)
123 (setq mode-name "Wanderlust original message"))
125 (defun wl-original-message-buffer-get (name)
126 "Get original message buffer for NAME.
127 If original message buffer already exists, it is re-used."
128 (let* ((name (concat wl-original-message-buffer-name name))
129 (buffer (get-buffer name)))
130 (unless (and buffer (buffer-live-p buffer))
131 (with-current-buffer (setq buffer (get-buffer-create name))
132 (wl-original-message-mode)))
135 (defun wl-message-buffer-create ()
136 "Create a new message buffer."
137 (let* ((buffer (generate-new-buffer wl-message-buffer-cache-name))
138 (name (buffer-name buffer)))
139 (with-current-buffer buffer
140 (setq wl-message-buffer-original-buffer
141 (wl-original-message-buffer-get name)))
144 (defun wl-message-buffer-cache-add (key)
145 "Add (KEY . buf) to the top of `wl-message-buffer-cache'.
146 Return its cache buffer."
147 (let ((len (length wl-message-buffer-cache))
149 (if (< len wl-message-buffer-cache-size)
150 (setq buf (wl-message-buffer-create))
151 (setq buf (wl-message-buffer-cache-buffer-get
152 (nth (1- len) wl-message-buffer-cache)))
153 (setcdr (nthcdr (- len 2) wl-message-buffer-cache) nil))
154 (setq wl-message-buffer-cache
155 (cons (wl-message-buffer-cache-entry-make key buf)
156 wl-message-buffer-cache))
159 (defun wl-message-buffer-cache-delete (&optional key)
160 "Delete the most recent cache entry"
162 (setq wl-message-buffer-cache
163 (delq (assoc key wl-message-buffer-cache)
164 wl-message-buffer-cache))
165 (let ((buf (wl-message-buffer-cache-buffer-get
166 (car wl-message-buffer-cache))))
167 (setq wl-message-buffer-cache
168 (nconc (cdr wl-message-buffer-cache)
169 (list (wl-message-buffer-cache-entry-make nil buf)))))))
171 (defun wl-message-buffer-cache-clean-up ()
172 "A function to flush all decoded messages in cache list."
174 (if (and (eq major-mode 'wl-summary-mode)
176 (get-buffer-window wl-message-buffer))
177 (delete-window (get-buffer-window wl-message-buffer)))
178 (wl-kill-buffers (regexp-quote wl-message-buffer-cache-name))
179 (setq wl-message-buffer-cache nil))
181 ;;; Message buffer handling from summary buffer.
183 (defun wl-message-buffer-window ()
184 "Get message buffer window if any."
185 (let* ((start-win (selected-window))
189 (setq cur-win (next-window cur-win))
190 (with-current-buffer (window-buffer cur-win)
191 (if (or (eq major-mode 'wl-message-mode)
192 (eq major-mode 'mime-view-mode))
193 (throw 'found cur-win)))
194 (not (eq cur-win start-win)))))))
196 (defun wl-message-select-buffer (buffer)
197 "Select BUFFER as a message buffer."
198 (let ((window (get-buffer-window buffer))
199 (sum (car wl-message-window-size))
200 (mes (cdr wl-message-window-size))
203 (not (eq (save-excursion (set-buffer (window-buffer window))
204 wl-message-buffer-cur-summary-buffer)
206 (delete-window window)
207 (run-hooks 'wl-message-window-deleted-hook)
210 (select-window window)
211 (when wl-fixed-window-configuration
212 (delete-other-windows)
213 (and wl-stay-folder-window
214 (wl-summary-toggle-disp-folder)))
215 ;; There's no buffer window. Search for message window and snatch it.
216 (if (setq window (wl-message-buffer-window))
217 (select-window window)
218 (setq whi (1- (window-height)))
221 (let ((total (+ sum mes)))
222 (setq sum (max window-min-height (/ (* whi sum) total)))
223 (setq mes (max window-min-height (/ (* whi mes) total))))
224 (if (< whi (+ sum mes))
225 (enlarge-window (- (+ sum mes) whi)))))
226 (split-window (get-buffer-window (current-buffer)) sum)
228 (switch-to-buffer buffer)))
230 (defun wl-message-narrow-to-page (&optional arg)
232 If ARG is specified, narrow to ARGth page."
234 (setq arg (if arg (prefix-numeric-value arg) 0))
237 (forward-page -1) ; Beginning of current page.
239 (goto-char (point-min))))
240 (forward-char 1) ; for compatibility with emacs-19.28 and emacs-19.29
243 ((> arg 0) (forward-page arg))
244 ((< arg 0) (forward-page (1- arg))))
247 (narrow-to-region (point)
250 (if (and (eolp) (not (bobp)))
254 (defun wl-message-prev-page (&optional lines)
255 "Scroll down current message by LINES.
256 Returns non-nil if top of message."
258 (if (buffer-live-p wl-message-buffer)
259 (let ((cur-buf (current-buffer))
261 (wl-message-select-buffer wl-message-buffer)
262 (move-to-window-line 0)
263 (if (and wl-break-pages
265 (not (save-restriction (widen) (bobp))))
267 (wl-message-narrow-to-page -1)
268 (goto-char (point-max))
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 (if (buffer-live-p wl-message-buffer)
283 (let ((cur-buf (current-buffer))
285 (wl-message-select-buffer wl-message-buffer)
286 (move-to-window-line -1)
289 (and (pos-visible-in-window-p)
291 (if (or (null wl-break-pages)
294 (widen) (forward-line) (eobp))))
296 (wl-message-narrow-to-page 1)
299 (static-if (boundp 'window-pixel-scroll-increment)
300 ;; XEmacs 21.2.20 and later.
301 (let (window-pixel-scroll-increment)
305 (goto-char (point-max))))
307 (select-window (get-buffer-window cur-buf))
311 (defun wl-message-follow-current-entity (buffer)
312 "Follow to current message."
313 (wl-draft-reply (wl-message-get-original-buffer)
314 nil wl-message-buffer-cur-summary-buffer) ; reply to all
315 (let ((mail-reply-buffer buffer))
316 (wl-draft-yank-from-mail-reply-buffer nil)))
320 (defun wl-message-mode ()
321 "A major mode for message displaying."
323 (setq major-mode 'wl-message-mode)
324 (setq buffer-read-only t)
325 (setq mode-name "Message"))
327 (defun wl-message-exit ()
328 "Move to summary buffer."
330 (let (summary-buf summary-win)
331 (if (setq summary-buf wl-message-buffer-cur-summary-buffer)
332 (if (setq summary-win (get-buffer-window summary-buf))
333 (select-window summary-win)
334 (switch-to-buffer summary-buf)
335 (wl-message-select-buffer wl-message-buffer)
336 (select-window (get-buffer-window summary-buf))))
337 (run-hooks 'wl-message-exit-hook)))
339 (defun wl-message-toggle-disp-summary ()
341 (let ((summary-buf (get-buffer wl-message-buffer-cur-summary-buffer))
344 (buffer-live-p summary-buf))
345 (if (setq summary-win (get-buffer-window summary-buf))
346 (delete-window summary-win)
347 (switch-to-buffer summary-buf)
348 (wl-message-select-buffer wl-message-buffer))
349 (wl-summary-goto-folder-subr wl-message-buffer-cur-folder 'no-sync
352 (let ((sum-buf (current-buffer)))
353 (wl-message-select-buffer wl-message-buffer)
354 (setq wl-message-buffer-cur-summary-buffer sum-buf)))))
356 (defun wl-message-get-original-buffer ()
357 "Get original buffer for current message buffer."
358 wl-message-buffer-original-buffer)
360 (defun wl-message-redisplay (folder number flag &optional force-reload)
361 (let* ((default-mime-charset wl-mime-charset)
362 (buffer-read-only nil)
363 (summary-buf (current-buffer))
367 header-end real-fld-num summary-win)
368 (setq buffer-read-only nil)
369 (setq cache-used (wl-message-buffer-display
370 folder number flag force-reload))
371 (setq wl-message-buffer (car cache-used))
372 (setq message-buf wl-message-buffer)
373 (wl-message-select-buffer wl-message-buffer)
375 (set-buffer message-buf)
376 (setq buffer-read-only nil)
377 (setq wl-message-buffer-cur-summary-buffer summary-buf)
378 (setq wl-message-buffer-cur-folder (elmo-folder-name-internal folder))
379 (setq wl-message-buffer-cur-number number)
380 (wl-message-overload-functions)
381 (setq mode-line-buffer-identification
382 (format "Wanderlust: << %s / %s >>"
383 (if (memq 'modeline wl-use-folder-petname)
384 (wl-folder-get-petname (elmo-folder-name-internal
386 (elmo-folder-name-internal folder)) number))
388 ; (when wl-highlight-body-too
389 ; (wl-highlight-body))
391 (wl-message-narrow-to-page)
392 (error nil)); ignore errors.
393 (setq cache-used (cdr cache-used))
394 (goto-char (point-min))
397 (run-hooks 'wl-message-redisplay-hook))
398 ;; go back to summary mode
399 (set-buffer-modified-p nil)
400 (setq buffer-read-only t)
401 (set-buffer summary-buf)
402 (setq summary-win (get-buffer-window summary-buf))
403 (if (window-live-p summary-win)
404 (select-window summary-win)))
407 ;; Use message buffer cache.
408 (defun wl-message-buffer-display (folder number flag
409 &optional force-reload unread)
410 (let* ((msg-id (elmo-message-field folder number 'message-id))
411 (fname (elmo-folder-name-internal folder))
412 (hit (wl-message-buffer-cache-hit (list fname number msg-id)))
415 (when (and hit (not (buffer-live-p hit)))
416 (wl-message-buffer-cache-delete (list fname number msg-id))
420 ;; move hit to the top.
421 (wl-message-buffer-cache-sort
422 (wl-message-buffer-cache-entry-make (list fname number msg-id) hit))
423 ;; buffer cache is used.
425 (with-current-buffer hit
426 (unless (eq wl-message-buffer-cur-flag flag)
428 ;; delete tail and add new to the top.
429 (setq hit (wl-message-buffer-cache-add (list fname number msg-id)))
431 (if (or force-reload read)
437 (wl-message-display-internal folder number flag
438 force-reload unread))
439 (setq wl-message-buffer-cur-flag flag))
441 (wl-message-buffer-cache-delete)
442 (error "Display message %s/%s is quitted" fname number))
444 (wl-message-buffer-cache-delete)
445 (signal (car err) (cdr err))
446 nil))) ;; will not be used
447 (cons hit cache-used)))
449 (defun wl-message-display-internal (folder number flag
450 &optional force-reload unread)
451 (let ((elmo-message-ignored-field-list
452 (if (eq flag 'all-header)
454 wl-message-ignored-field-list))
455 (elmo-message-visible-field-list wl-message-visible-field-list)
456 (elmo-message-sorted-field-list wl-message-sort-field-list)
457 (elmo-fetch-threshold wl-fetch-confirm-threshold))
460 (let (wl-highlight-x-face-func)
461 (elmo-mime-display-as-is folder number
463 (wl-message-get-original-buffer)
464 'wl-original-message-mode
467 (elmo-mime-message-display folder number
469 (wl-message-get-original-buffer)
470 'wl-original-message-mode
473 (setq buffer-read-only t))))
475 (defsubst wl-message-buffer-prefetch-p (folder &optional number)
477 ((eq wl-message-buffer-prefetch-folder-type-list t)
479 ((and number wl-message-buffer-prefetch-folder-type-list)
480 (memq (elmo-folder-type-internal
481 (elmo-message-folder folder number))
482 wl-message-buffer-prefetch-folder-type-list))
483 (wl-message-buffer-prefetch-folder-type-list
484 (let ((list wl-message-buffer-prefetch-folder-type-list)
487 (while (setq type (pop list))
488 (if (elmo-folder-contains-type folder type)
490 ((consp wl-message-buffer-prefetch-folder-type-list)
491 (wl-string-match-member (elmo-folder-name-internal folder)
492 wl-message-buffer-prefetch-folder-type-list))
493 (t wl-message-buffer-prefetch-folder-type-list)))
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-func
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))
506 wl-message-buffer-prefetch-idle-time
508 'wl-message-buffer-prefetch folder next summary charset)
511 (defun wl-message-buffer-prefetch (folder number summary charset)
512 (when (buffer-live-p summary)
515 (when (string= (elmo-folder-name-internal folder)
516 (wl-summary-buffer-folder-name))
517 (let ((message-id (elmo-message-field folder number 'message-id))
518 (wl-mime-charset charset)
519 (default-mime-charset charset)
520 result time1 time2 sec micro)
521 (if (not (wl-message-buffer-cache-hit (list folder
523 (let* ((size (elmo-message-field folder number 'size)))
524 (when (or (elmo-message-file-p folder number)
527 wl-message-buffer-prefetch-threshold
529 wl-message-buffer-prefetch-threshold))))
530 ;;(not (elmo-file-cache-exists-p message-id)))))
531 (when wl-message-buffer-prefetch-debug
532 (setq time1 (current-time))
533 (message "Prefetching %d..." number))
534 (setq result (wl-message-buffer-display folder number
536 (when wl-message-buffer-prefetch-debug
537 (setq time2 (current-time))
538 (setq sec (- (nth 1 time2)(nth 1 time1)))
539 (setq micro (- (nth 2 time2)(nth 2 time1)))
540 (setq micro (+ micro (* 1000000 sec)))
541 (message "Prefetching %d...done(%f msec)."
543 (/ micro 1000.0)))))))))))
545 (defvar wl-message-button-map (make-sparse-keymap))
547 (defun wl-message-add-button (from to function &optional data)
548 "Create a button between FROM and TO with callback FUNCTION and DATA."
551 (nconc (list 'wl-message-button-callback function)
553 (list 'wl-message-button-data data))))
554 (let ((ov (make-overlay from to)))
555 (overlay-put ov 'mouse-face 'highlight)
556 (overlay-put ov 'local-map wl-message-button-map)
557 (overlay-put ov 'evaporate t)))
559 (defun wl-message-button-dispatcher (event)
560 "Select the button under point."
562 (mouse-set-point event)
563 (let ((callback (get-text-property (point) 'wl-message-button-callback))
564 (data (get-text-property (point) 'wl-message-button-data)))
566 (funcall callback data)
567 (wl-message-button-dispatcher-internal event))))
569 (defun wl-message-button-refer-article (data)
570 "Read article specified by Message-ID DATA at point."
571 (switch-to-buffer-other-window
572 wl-message-buffer-cur-summary-buffer)
573 (if (wl-summary-jump-to-msg-by-message-id data)
574 (wl-summary-redisplay)))
576 (defun wl-message-refer-article-or-url (e)
577 "Read article specified by message-id around point.
578 If failed, attempt to execute button-dispatcher."
580 (let ((window (get-buffer-window (current-buffer)))
581 mouse-window point beg end msg-id)
585 (setq mouse-window (get-buffer-window (current-buffer)))
587 (setq beg (save-excursion (beginning-of-line) (point)))
588 (setq end (save-excursion (end-of-line) (point)))
589 (search-forward ">" end t) ;Move point to end of "<....>".
590 (if (and (re-search-backward "\\(<[^<> \t\n]+@[^<> \t\n]+>\\)"
592 (not (string-match "mailto:"
593 (setq msg-id (wl-match-buffer 1)))))
596 (switch-to-buffer-other-window
597 wl-message-buffer-cur-summary-buffer)
598 (if (wl-summary-jump-to-msg-by-message-id msg-id)
599 (wl-summary-redisplay)))
600 (wl-message-button-dispatcher-internal e)))
601 (if (eq mouse-window (get-buffer-window (current-buffer)))
602 (select-window window)))))
604 (defun wl-message-uu-substring (buf outbuf &optional first last)
607 (search-forward "\n\n")
609 ep filename case-fold-search)
613 (if (re-search-forward "^begin[ \t]+[0-9]+[ \t]+\\([^ ].*\\)" nil t)
614 (setq filename (buffer-substring (match-beginning 1)(match-end 1)))
616 (re-search-forward "^M.*$" nil t)) ; uuencoded string
619 (goto-char (point-max))
621 (re-search-backward "^end" sp t)
622 (re-search-backward "^M.*$" sp t)) ; uuencoded string
626 (goto-char (point-max))
627 (insert-buffer-substring buf sp ep)
632 (product-provide (provide 'wl-message) (require 'wl-version))
634 ;;; wl-message.el ends here