1 ;;; gnus-diary.el --- Wrapper around the NNDiary Gnus backend
3 ;; Copyright (c) 2001, 2002, 2003 Free Software Foundation, Inc.
4 ;; Copyright (C) 1999, 2000, 2001 Didier Verna.
6 ;; Author: Didier Verna <didier@xemacs.org>
7 ;; Maintainer: Didier Verna <didier@xemacs.org>
8 ;; Created: Tue Jul 20 10:42:55 1999
9 ;; Keywords: calendar mail news
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published
15 ;; by the Free Software Foundation; either version 2 of the License,
16 ;; or (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful, but
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 ;; General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program; if not, write to the Free Software
25 ;; Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
30 ;; Contents management by FCM version 0.1.
35 ;; Gnus-Diary is a wrapper around the NNDiary Gnus backend. It is here to
36 ;; make your nndiary-user life easier in different ways. So, you don't have
37 ;; to use it if you don't want to. But, really, you should.
39 ;; Gnus-Diary offers the following features on top of the NNDiary backend:
41 ;; - A nice summary line format:
42 ;; Displaying diary messages in standard summary line format (usually
43 ;; something like "<From Joe>: <Subject>") is pretty useless. Most of the
44 ;; time, you're the one who wrote the message, and you mostly want to see
45 ;; the event's date. Gnus-Diary offers you a nice summary line format
46 ;; which will do this. By default, a summary line will appear like this:
48 ;; <Event Date>: <Subject> <Remaining time>
50 ;; for example, here's how Joe's birthday is displayed in my
51 ;; "nndiary:birhdays" summary buffer (the message is expirable, but will
52 ;; never be deleted, as it specifies a regular event):
54 ;; E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week)
56 ;; - More article sorting functions:
57 ;; Gnus-Diary adds a new sorting function called
58 ;; `gnus-summary-sort-by-schedule'. This function lets you organize your
59 ;; diary summary buffers from the closest event to the farthest one.
61 ;; - Automatic generation of diary group parameters:
62 ;; When you create a new diary group, or visit one, Gnus-Diary checks your
63 ;; group parameters, and if needed, sets the summary line format to the
64 ;; diary-specific value, adds the diary-specific sorting functions, and
65 ;; also adds the different `X-Diary-*' headers to the group's
66 ;; posting-style. It is then easier to send a diary message, because if
67 ;; you use `C-u a' or `C-u m' on a diary group to prepare a message, these
68 ;; headers will be inserted automatically (but not filled with proper
71 ;; - An interactive mail-to-diary convertion function:
72 ;; The function `gnus-diary-check-message' ensures that the current message
73 ;; contains all the required diary headers, and prompts you for values /
74 ;; correction if needed. This function is hooked in the nndiary backend so
75 ;; that moving an article to an nndiary group will trigger it
76 ;; automatically. It is also bound to `C-c D c' in message-mode and
77 ;; article-edit-mode in order to ease the process of converting a usual
78 ;; mail to a diary one. This function takes a prefix argument which will
79 ;; force prompting of all diary headers, regardless of their
80 ;; presence/validity. That way, you can very easily reschedule a diary
81 ;; message for instance.
87 ;; 0/ Don't use any `gnus-user-format-function-[d|D]'. Gnus-Diary provides
88 ;; both of these (sorry if you used them before).
89 ;; 1/ Add '(require 'gnus-diary) to your gnusrc file.
90 ;; 2/ Customize your gnus-diary options to suit your needs.
104 (defgroup gnus-diary nil
105 "Utilities on top of the nndiary backend for Gnus.")
107 (defcustom gnus-diary-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n"
108 "*Summary line format for nndiary groups."
111 :group 'gnus-summary-format)
113 (defcustom gnus-diary-time-format "%a, %b %e %y, %H:%M"
114 "*Time format to display appointements in nndiary summary buffers.
115 Please refer to `format-time-string' for information on possible values."
119 (defcustom gnus-diary-delay-format-function 'gnus-diary-delay-format-english
120 "*Function called to format a diary delay string.
121 It is passed two arguments. The first one is non nil if the delay is in
122 the past. The second one is of the form ((NUM . UNIT) ...) where NUM is
123 an integer and UNIT is one of 'year 'month 'week 'day 'hour or 'minute.
124 It should return strings like \"In 2 months, 3 weeks\", \"3 hours,
125 1 minute ago\" and so on.
127 There are currently two built-in format functions:
128 `gnus-diary-delay-format-english' (the default)
129 `gnus-diary-delay-format-french'"
130 :type '(choice (const :tag "english" gnus-diary-delay-format-english)
131 (const :tag "french" gnus-diary-delay-format-french)
132 (symbol :tag "other"))
135 (defconst gnus-diary-version nndiary-version
136 "Current Diary backend version.")
139 ;; Compatibility functions ==================================================
142 (if (fboundp 'kill-entire-line)
143 (defalias 'gnus-diary-kill-entire-line 'kill-entire-line)
144 (defun gnus-diary-kill-entire-line ()
146 (let ((kill-whole-line t))
150 ;; Summary line format ======================================================
152 (defun gnus-diary-delay-format-french (past delay)
155 ;; Keep only a precision of two degrees
156 (and (> (length delay) 1) (setcdr (cdr delay) nil))
157 (concat (if past "il y a " "dans ")
160 (while (setq del (pop delay))
161 (setq str (concat str
162 (int-to-string (car del)) " "
163 (cond ((eq (cdr del) 'year)
165 ((eq (cdr del) 'month)
167 ((eq (cdr del) 'week)
171 ((eq (cdr del) 'hour)
173 ((eq (cdr del) 'minute)
175 (unless (or (eq (cdr del) 'month)
182 (defun gnus-diary-delay-format-english (past delay)
185 ;; Keep only a precision of two degrees
186 (and (> (length delay) 1) (setcdr (cdr delay) nil))
187 (concat (unless past "in ")
190 (while (setq del (pop delay))
191 (setq str (concat str
192 (int-to-string (car del)) " "
193 (symbol-name (cdr del))
194 (and (> (car del) 1) "s")
200 (defun gnus-diary-header-schedule (headers)
201 ;; Same as `nndiary-schedule', but given a set of headers HEADERS
204 (let ((head (cdr (assoc (intern (format "X-Diary-%s" (car elt)))
207 (nndiary-parse-schedule-value head (cadr elt) (caddr elt)))))
210 ;; #### NOTE: Gnus sometimes gives me a HEADER not corresponding to any
211 ;; message, with all fields set to nil here. I don't know what it is for, and
213 (defun gnus-user-format-function-d (header)
214 ;; Returns an aproximative delay string for the next occurence of this
215 ;; message. The delay is given only in the first non zero unit.
216 ;; Code partly stolen from article-make-date-line
217 (let* ((extras (mail-header-extra header))
218 (sched (gnus-diary-header-schedule extras))
219 (occur (nndiary-next-occurence sched (current-time)))
221 (real-time (subtract-time occur now)))
224 (let* ((sec (+ (* (float (car real-time)) 65536) (cadr real-time)))
227 (and past (setq sec (- sec)))
229 ;; This is a bit convoluted, but basically we go through the time
230 ;; units for years, weeks, etc, and divide things to see whether
231 ;; that results in positive answers.
232 (let ((units `((year . ,(* 365.25 24 3600))
233 (month . ,(* 31 24 3600))
234 (week . ,(* 7 24 3600))
239 (while (setq unit (pop units))
240 (unless (zerop (setq num (ffloor (/ sec (cdr unit)))))
241 (setq delay (append delay `((,(floor num) . ,(car unit))))))
242 (setq sec (- sec (* num (cdr unit)))))))
243 (funcall gnus-diary-delay-format-function past delay)))
246 ;; #### NOTE: Gnus sometimes gives me a HEADER not corresponding to any
247 ;; message, with all fields set to nil here. I don't know what it is for, and
249 (defun gnus-user-format-function-D (header)
250 ;; Returns a formatted time string for the next occurence of this message.
251 (let* ((extras (mail-header-extra header))
252 (sched (gnus-diary-header-schedule extras))
253 (occur (nndiary-next-occurence sched (current-time))))
254 (format-time-string gnus-diary-time-format occur)))
257 ;; Article sorting functions ================================================
259 (defun gnus-article-sort-by-schedule (h1 h2)
260 (let* ((now (current-time))
261 (e1 (mail-header-extra h1))
262 (e2 (mail-header-extra h2))
263 (s1 (gnus-diary-header-schedule e1))
264 (s2 (gnus-diary-header-schedule e2))
265 (o1 (nndiary-next-occurence s1 now))
266 (o2 (nndiary-next-occurence s2 now)))
267 (if (and (= (car o1) (car o2)) (= (cadr o1) (cadr o2)))
268 (< (mail-header-number h1) (mail-header-number h2))
269 (time-less-p o1 o2))))
272 (defun gnus-thread-sort-by-schedule (h1 h2)
273 (gnus-article-sort-by-schedule (gnus-thread-header h1)
274 (gnus-thread-header h2)))
276 (defun gnus-summary-sort-by-schedule (&optional reverse)
277 "Sort nndiary summary buffers by schedule of appointements.
278 Optional prefix (or REVERSE argument) means sort in reverse order."
280 (gnus-summary-sort 'schedule reverse))
282 (defvar gnus-summary-misc-menu) ;; Avoid byte compiler warning.
283 ;; The function `easy-menu-add-item' is not available under Emacs
284 ;; versions prior to 20.3. Could anyone try to emulate it?
285 (if (eval-when-compile
287 (or (fboundp 'easy-menu-add-item)
289 (defalias 'easy-menu-add-item 'ignore)
291 (add-hook 'gnus-summary-menu-hook
293 (easy-menu-add-item gnus-summary-misc-menu
296 gnus-summary-sort-by-schedule
297 (eq (car (gnus-find-method-for-group
298 gnus-newsgroup-name))
305 ;; Group parameters autosetting =============================================
307 (defun gnus-diary-update-group-parameters (group)
308 ;; Ensure that nndiary groups have convenient group parameters:
309 ;; - a posting style containing X-Diary headers
310 ;; - a nice summary line format
311 ;; - NNDiary specific sorting by schedule functions
312 ;; In general, try not to mess with what the user might have modified.
313 (let ((posting-style (gnus-group-get-parameter group 'posting-style t)))
315 (mapcar (lambda (elt)
316 (let ((header (format "X-Diary-%s" (car elt))))
317 (unless (assoc header posting-style)
318 (setq posting-style (append posting-style
322 (gnus-group-set-parameter group 'posting-style posting-style)
323 ;; Summary line format:
324 (unless (gnus-group-get-parameter group 'gnus-summary-line-format t)
325 (gnus-group-set-parameter group 'gnus-summary-line-format
326 `(,gnus-diary-summary-line-format)))
327 ;; Sorting by schedule:
328 (unless (gnus-group-get-parameter group 'gnus-article-sort-functions)
329 (gnus-group-set-parameter group 'gnus-article-sort-functions
330 '((append gnus-article-sort-functions
332 'gnus-article-sort-by-schedule)))))
333 (unless (gnus-group-get-parameter group 'gnus-thread-sort-functions)
334 (gnus-group-set-parameter group 'gnus-thread-sort-functions
335 '((append gnus-thread-sort-functions
337 'gnus-thread-sort-by-schedule)))))
340 ;; Called when a group is subscribed. This is needed because groups created
341 ;; because of mail splitting are *not* created with the backend function.
342 ;; Thus, `nndiary-request-create-group-hooks' is inoperative.
343 (defun gnus-diary-maybe-update-group-parameters (group)
344 (when (eq (car (gnus-find-method-for-group group)) 'nndiary)
345 (gnus-diary-update-group-parameters group)))
347 (add-hook 'nndiary-request-create-group-hooks
348 'gnus-diary-update-group-parameters)
349 ;; Now that we have `gnus-subscribe-newsgroup-hooks', this is not needed
350 ;; anymore. Maybe I should remove this completely.
351 (add-hook 'nndiary-request-update-info-hooks
352 'gnus-diary-update-group-parameters)
353 (add-hook 'gnus-subscribe-newsgroup-hooks
354 'gnus-diary-maybe-update-group-parameters)
357 ;; Diary Message Checking ===================================================
359 (defvar gnus-diary-header-value-history nil
360 ;; History variable for header value prompting
363 (defun gnus-diary-narrow-to-headers ()
364 "Narrow the current buffer to the header part.
365 Point is left at the beginning of the region.
366 The buffer is assumed to contain a message, but the format is unknown."
367 (cond ((eq major-mode 'message-mode)
368 (message-narrow-to-headers))
370 (goto-char (point-min))
371 (when (search-forward "\n\n" nil t)
372 (narrow-to-region (point-min) (- (point) 1))
373 (goto-char (point-min))))
376 (defun gnus-diary-add-header (str)
377 "Add a header to the current buffer.
378 The buffer is assumed to contain a message, but the format is unknown."
379 (cond ((eq major-mode 'message-mode)
380 (message-add-header str))
383 (gnus-diary-narrow-to-headers)
384 (goto-char (point-max))
385 (if (string-match "\n$" str)
390 (defun gnus-diary-check-message (arg)
391 "Ensure that the current message is a valid for NNDiary.
392 This function checks that all NNDiary required headers are present and
393 valid, and prompts for values / correction otherwise.
395 If ARG (or prefix) is non-nil, force prompting for all fields."
400 (let ((header (concat "X-Diary-" (car head)))
403 ;; First, try to find the header, and checks for validity:
405 (gnus-diary-narrow-to-headers)
406 (when (re-search-forward (concat "^" header ":") nil t)
407 (unless (eq (char-after) ? )
409 (setq value (buffer-substring (point) (point-at-eol)))
410 (and (string-match "[ \t]*\\([^ \t]+\\)[ \t]*" value)
411 (setq value (match-string 1 value)))
413 (nndiary-parse-schedule-value value
414 (nth 1 head) (nth 2 head))
417 ;; #### NOTE: this (along with the `gnus-diary-add-header'
418 ;; function) could be rewritten in a better way, in particular
419 ;; not to blindly remove an already present header and reinsert
420 ;; it somewhere else afterwards.
421 (when (or ask invalid)
422 (gnus-diary-kill-entire-line))
424 ;; Now, loop until a valid value is provided:
425 (while (or ask (not value) invalid)
426 (let ((prompt (concat (and invalid
427 (prog1 "(current value invalid) "
431 (if (listp (nth 1 head))
432 (completing-read prompt (cons '("*" nil) (nth 1 head))
434 gnus-diary-header-value-history)
435 (read-string prompt value
436 gnus-diary-header-value-history))))
440 (nndiary-parse-schedule-value value
441 (nth 1 head) (nth 2 head))
444 (gnus-diary-add-header (concat header ": " value))
449 (add-hook 'nndiary-request-accept-article-hooks
450 (lambda () (gnus-diary-check-message nil)))
452 (define-key message-mode-map "\C-cDc" 'gnus-diary-check-message)
453 (define-key gnus-article-edit-mode-map "\C-cDc" 'gnus-diary-check-message)
456 ;; The end ==================================================================
458 (defun gnus-diary-version ()
459 "Current Diary backend version."
461 (message "NNDiary version %s" nndiary-version))
463 (define-key message-mode-map "\C-cDv" 'gnus-diary-version)
464 (define-key gnus-article-edit-mode-map "\C-cDv" 'gnus-diary-version)
467 (provide 'gnus-diary)
469 ;;; gnus-diary.el ends here