Update variable description.
[elisp/wanderlust.git] / wl / wl-news.el.in
1 ;;; wl-news.el --- Create notification from NEWS(.ja) for Wanderlust.
2
3 ;; Copyright (C) 2002 Yoichi NAKAYAMA <yoichi@eken.phys.nagoya-u.ac.jp>
4 ;; Copyright (C) 2002 Kenichi OKADA <okada@opaopa.org>
5
6 ;; Author: Yoichi NAKAYAMA <yoichi@eken.phys.nagoya-u.ac.jp>
7 ;;      Kenichi OKADA <okada@opaopa.org>
8 ;; Keywords: mail, net news
9
10 ;; This file is part of Wanderlust (Yet Another Message Interface on Emacsen).
11
12 ;; This program is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16 ;;
17 ;; This program is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 ;; GNU General Public License for more details.
21 ;;
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
26 ;;
27
28 ;;; Commentary:
29 ;;
30
31 ;;; Code:
32 ;;
33
34 (require 'elmo)
35 (require 'wl-vars)
36 (require 'wl-util)
37 (require 'wl-address)
38 (require 'wl-folder)
39
40 (defvar wl-news-version-file-name "previous-version")
41 (defvar wl-news-default-previous-version '(2 0 0))
42
43 (defvar wl-news-lang
44   (if (and (boundp 'current-language-environment)
45            (string-equal "Japanese"
46                          (symbol-value 'current-language-environment)))
47       '("ja" "en") '("en" "ja"))
48         "The list of languages to show NEWS. (order sensitive)")
49
50 (defun wl-news-check ()
51   (let* ((updated (not (wl-news-already-current-p))))
52     (if updated
53         (if (and wl-news-lang
54                  (wl-news-check-news
55                   (cdr (wl-news-previous-version-load))
56                   wl-news-lang)
57                  (not (memq 'wl-news wl-hook)))
58             (add-hook 'wl-hook 'wl-news))
59       ;; update wl-news-version-file
60       (wl-news-previous-version-save
61        (product-version (product-find 'wl-version))
62        (cdr (wl-news-previous-version-load))))
63     updated))
64
65 ;;; -*- news-list -*-
66
67
68 ;;; -*- news-list-end -*-
69
70 (defun wl-news-previous-version-load ()
71   (save-excursion
72     (let ((filename (expand-file-name
73                      wl-news-version-file-name
74                      elmo-msgdb-directory))
75           (tmp-buffer (get-buffer-create " *wl-news-version-tmp*"))
76           insert-file-contents-pre-hook
77           insert-file-contents-post-hook
78           ret-val)
79       (if (not (file-readable-p filename))
80           (cons wl-news-default-previous-version
81                 wl-news-default-previous-version)
82         (set-buffer tmp-buffer)
83         (insert-file-contents filename)
84         (setq ret-val
85               (condition-case nil
86                   (read (current-buffer))
87                 (error nil nil)))
88         (kill-buffer tmp-buffer)
89         ret-val))))
90
91 (defun wl-news-previous-version-save (current-version previous-version)
92   (save-excursion
93     (let ((filename (expand-file-name
94                      wl-news-version-file-name
95                      elmo-msgdb-directory))
96           (tmp-buffer (get-buffer-create " *wl-news-version-tmp*")))
97       (set-buffer tmp-buffer)
98       (erase-buffer)
99       (prin1 (cons current-version previous-version) tmp-buffer)
100       (princ "\n" tmp-buffer)
101       (if (file-writable-p filename)
102           (write-region (point-min) (point-max)
103                         filename nil 'no-msg)
104         (message "%s is not writable." filename))
105       (kill-buffer tmp-buffer))))
106
107 (defun wl-news-append-news (lang previous-version &optional no-mime-tag)
108   (require 'wl-mime)
109   (let ((news-list (cdr (assoc lang wl-news-news-alist)))
110         ret)
111     (when news-list
112       (if no-mime-tag
113           (insert "--------------\n")
114         (mime-edit-insert-tag "text" "plain" "" ""))
115       (while (< 0
116                 (product-version-compare
117                  (car (car news-list))
118                  previous-version))
119         (setq ret t)
120         (insert (cdr (car news-list)) "\n\n")
121         (setq news-list (cdr news-list))))
122     ret))
123
124 (defun wl-news-check-news (version news-lang)
125   (let ((lang news-lang)
126         news-list ret)
127     (while (car lang)
128       (setq news-list (cdr (assoc (car lang) wl-news-news-alist)))
129       (while (< 0
130                 (product-version-compare
131                  (car (car news-list)) version))
132         (setq ret t)
133         (setq news-list (cdr news-list)))
134       (setq lang (cdr lang)))
135     ret))
136
137 (defun wl-news-already-current-p ()
138   (>= 0 (product-version-compare
139          (product-version (product-find 'wl-version))
140          (car (wl-news-previous-version-load)))))
141
142 (defun wl-news-send-news (version news-lang folder)
143   (require 'wl-draft)
144   (let ((lang (if (listp wl-news-lang)
145                   wl-news-lang
146                 (list wl-news-lang)))
147         send-buffer
148         wl-fcc wl-bcc ret)
149     (save-window-excursion
150       (set-buffer
151        (setq send-buffer (wl-draft-create-buffer)))
152       (wl-draft-create-contents
153        (list (cons 'From "WL Release 'Bot <wl@lists.airs.net>")
154              (cons 'To (wl-draft-eword-encode-address-list wl-from))
155              (cons 'Subject "Wanderlust NEWS")
156              (cons 'Date (wl-make-date-string))
157              (cons 'User-Agent wl-generate-mailer-string-function)))
158       (wl-draft-insert-mail-header-separator)
159       (wl-draft-prepare-edit)
160       (goto-char (point-max))
161       (insert "\nThis message is automatically generated by Wanderlust.\n\n")
162       ;; insert news
163       (while (car lang)
164         (wl-news-append-news (car lang) version)
165         (setq lang (cdr lang)))
166       ;; encode
167       (let ((mime-header-encode-method-alist
168              '((eword-encode-unstructured-field-body))))
169         (mime-edit-translate-buffer))
170       (wl-draft-get-header-delimiter t)
171       (setq ret
172             (and (elmo-folder-writable-p
173                   (wl-folder-get-elmo-folder folder))
174                  (elmo-folder-append-buffer
175                   (wl-folder-get-elmo-folder folder) t)))
176       (wl-draft-hide send-buffer)
177       (wl-draft-delete send-buffer))
178     ret))
179
180 ;;; wl-news-mode
181
182 (defvar wl-news-buf-name "NEWS")
183 (defvar wl-news-mode-map nil)
184 (defvar wl-news-winconf nil)
185 (defvar wl-news-buffer-oldest-version nil)
186 (make-variable-buffer-local 'wl-news-buffer-oldest-version)
187
188 (unless wl-news-mode-map
189   (setq wl-news-mode-map (make-sparse-keymap))
190   (define-key wl-news-mode-map "q"     'wl-news-exit)
191   (define-key wl-news-mode-map "Q"     'wl-news-force-exit)
192   (define-key wl-news-mode-map "\C-xk" 'wl-news-exit)
193   (define-key wl-news-mode-map "a"     'wl-news-show-all)
194   (define-key wl-news-mode-map "m"     'wl-news-append-to-folder)
195   (define-key wl-news-mode-map "\C-m"  'wl-news-next-line)
196   (define-key wl-news-mode-map " "     'wl-news-next-page))
197
198 (defun wl-news-mode ()
199   "Mode for Wanderlust NEWS(.ja)."
200   (interactive)
201   (kill-all-local-variables)
202   (use-local-map wl-news-mode-map)
203   (setq major-mode 'wl-news-mode)
204   (setq mode-name "NEWS")
205   (setq buffer-read-only t))
206
207 (defun wl-news (&optional arg)
208   (interactive "P")
209   (remove-hook 'wl-hook 'wl-news)
210   (let* ((previous-version (if arg wl-news-default-previous-version
211                              (cdr (wl-news-previous-version-load))))
212          (lang wl-news-lang)
213          window-lines lines)
214     (if (or (get-buffer wl-news-buf-name)
215             (if (wl-news-check-news previous-version wl-news-lang)
216                 (progn
217                   (setq wl-news-winconf (current-window-configuration))
218                   (set-buffer (get-buffer-create wl-news-buf-name))
219                   (wl-news-mode)
220                   (setq wl-news-buffer-oldest-version previous-version)
221                   (buffer-disable-undo (current-buffer))
222                   ;; insert news
223                   (let ((buffer-read-only nil))
224                     (insert "--- Wanderlust NEWS ---  press 'a' to show all NEWS\n")
225                     (insert "                         press 'm' to mail this NEWS to your folder\n")
226                     (insert "                         press 'q' to quit\n")
227                     (insert "                         press 'Q' to force quit\n\n")
228                     (while (car lang)
229                       (wl-news-append-news
230                        (car lang) previous-version t)
231                       (setq lang (cdr lang))))
232                   t)
233               (message "No NEWS.")
234               nil))
235         (progn
236           (switch-to-buffer wl-news-buf-name)
237           (delete-other-windows)
238           (goto-char (point-min))))))
239
240 (defun wl-news-next-line ()
241   (interactive)
242   (scroll-up 1))
243
244 (defun wl-news-next-page ()
245   (interactive)
246   (scroll-up))
247
248 (defun wl-news-show-all ()
249   (interactive)
250   (when (eq major-mode 'wl-news-mode)
251     (kill-buffer (current-buffer))
252     (wl-news t)))
253
254 (defun wl-news-exit ()
255   (interactive)
256   (let* ((oldest-version (cdr (wl-news-previous-version-load)))
257          (current-version (product-version (product-find 'wl-version)))
258          (new-old-version current-version)
259          (buf (get-buffer wl-news-buf-name)))
260     (when buf
261       (if (wl-news-check-news oldest-version wl-news-lang)
262           (if (y-or-n-p "Do you want to see this message again? ")
263               (progn
264                 (message "Please M-x wl-news if you want to see it.")
265                 (setq new-old-version oldest-version))))
266       (wl-news-previous-version-save
267        current-version new-old-version)
268       (kill-buffer (current-buffer))
269       (if wl-news-winconf
270           (set-window-configuration wl-news-winconf))
271       (kill-buffer buf)
272       (if wl-news-winconf
273           (set-window-configuration wl-news-winconf)))))
274
275 (defun wl-news-append-to-folder ()
276   (interactive)
277   (let* ((current-version (product-version (product-find 'wl-version)))
278          (new-old-version current-version)
279          (folder wl-default-folder))
280     (if (or (and (elmo-folder-writable-p
281                   (wl-folder-get-elmo-folder folder))
282                  (y-or-n-p (format
283                             "Do you want to append this message to %s ? "
284                             wl-default-folder)))
285             (setq folder
286                   (wl-summary-read-folder wl-default-folder "to append ")))
287         (or (wl-news-send-news wl-news-buffer-oldest-version wl-news-lang folder)
288             (error
289              (format "Cannot append NEWS mail to %s" folder))))))
290
291 (defun wl-news-force-exit ()
292   (interactive)
293   (let ((buf))
294     (when (setq buf (get-buffer wl-news-buf-name))
295       (wl-news-previous-version-save
296        (product-version (product-find 'wl-version))
297        (cdr (wl-news-previous-version-load)))
298       (kill-buffer buf)
299       (if wl-news-winconf
300           (set-window-configuration wl-news-winconf)))))
301
302
303 (require 'product)
304 (product-provide (provide 'wl-news) (require 'wl-version))
305
306 ;;; wl-news.el ends here