gnus-diary.el 13.3 KB
Newer Older
1
;;; gnus-diary.el --- Wrapper around the NNDiary Gnus back end
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1999-2019 Free Software Foundation, Inc.
4 5 6 7 8 9 10 11

;; Author:        Didier Verna <didier@xemacs.org>
;; Maintainer:    Didier Verna <didier@xemacs.org>
;; Created:       Tue Jul 20 10:42:55 1999
;; Keywords:      calendar mail news

;; This file is part of GNU Emacs.

12 13 14 15
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
16

17 18 19 20
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; 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.  If not, see <https://www.gnu.org/licenses/>.
24 25 26 27 28 29 30 31 32


;;; Commentary:

;; Contents management by FCM version 0.1.

;; Description:
;; ===========

33 34
;; gnus-diary is a utility toolkit used on top of the nndiary back end. It is
;; now fully documented in the Gnus manual.
35 36 37 38 39 40 41 42 43 44 45 46 47


;; Bugs / Todo:
;; ===========


;;; Code:

(require 'nndiary)
(require 'message)
(require 'gnus-art)

(defgroup gnus-diary nil
48
  "Utilities on top of the nndiary back end for Gnus."
49 50
  :version "22.1"
  :group 'gnus)
51 52

(defcustom gnus-diary-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n"
53
  "Summary line format for nndiary groups."
54 55 56 57 58
  :type 'string
  :group 'gnus-diary
  :group 'gnus-summary-format)

(defcustom gnus-diary-time-format "%a, %b %e %y, %H:%M"
59
  "Time format to display appointments in nndiary summary buffers.
60 61 62 63 64
Please refer to `format-time-string' for information on possible values."
  :type 'string
  :group 'gnus-diary)

(defcustom gnus-diary-delay-format-function 'gnus-diary-delay-format-english
65
  "Function called to format a diary delay string.
66
It is passed two arguments.  The first one is non-nil if the delay is in
67 68 69 70 71 72 73 74 75 76 77 78 79 80
the past.  The second one is of the form ((NUM . UNIT) ...) where NUM is
an integer and UNIT is one of 'year 'month 'week 'day 'hour or 'minute.
It should return strings like \"In 2 months, 3 weeks\", \"3 hours,
1 minute ago\" and so on.

There are currently two built-in format functions:
`gnus-diary-delay-format-english' (the default)
`gnus-diary-delay-format-french'"
  :type '(choice (const  :tag "english" gnus-diary-delay-format-english)
		 (const  :tag "french"  gnus-diary-delay-format-french)
		 (symbol :tag "other"))
  :group 'gnus-diary)

(defconst gnus-diary-version nndiary-version
81
  "Current Diary back end version.")
82 83 84 85


;; Compatibility functions ==================================================

86 87 88 89
(defun gnus-diary-kill-entire-line ()
  (beginning-of-line)
  (let ((kill-whole-line t))
    (kill-line)))
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148


;; Summary line format ======================================================

(defun gnus-diary-delay-format-french (past delay)
  (if (null delay)
      "maintenant!"
    ;; Keep only a precision of two degrees
    (and (> (length delay) 1) (setcdr (cdr delay) nil))
    (concat (if past "il y a " "dans ")
	    (let ((str "")
		  del)
	      (while (setq del (pop delay))
		(setq str (concat str
				  (int-to-string (car del)) " "
				  (cond ((eq (cdr del) 'year)
					 "an")
					((eq (cdr del) 'month)
					 "mois")
					((eq (cdr del) 'week)
					 "semaine")
					((eq (cdr del) 'day)
					 "jour")
					((eq (cdr del) 'hour)
					 "heure")
					((eq (cdr del) 'minute)
					 "minute"))
				  (unless (or (eq (cdr del) 'month)
					      (= (car del) 1))
				    "s")
				  (if delay ", "))))
	      str))))


(defun gnus-diary-delay-format-english (past delay)
  (if (null delay)
      "now!"
    ;; Keep only a precision of two degrees
    (and (> (length delay) 1) (setcdr (cdr delay) nil))
    (concat (unless past "in ")
	    (let ((str "")
		  del)
	      (while (setq del (pop delay))
		(setq str (concat str
				  (int-to-string (car del)) " "
				  (symbol-name (cdr del))
				  (and (> (car del) 1) "s")
				  (if delay ", "))))
	      str)
	    (and past " ago"))))


(defun gnus-diary-header-schedule (headers)
  ;; Same as `nndiary-schedule', but given a set of headers HEADERS
  (mapcar
   (lambda (elt)
     (let ((head (cdr (assoc (intern (format "X-Diary-%s" (car elt)))
			     headers))))
       (when head
149
	 (nndiary-parse-schedule-value head (cadr elt) (car (cddr elt))))))
150 151 152 153 154
   nndiary-headers))

;; #### NOTE: Gnus sometimes gives me a HEADER not corresponding to any
;; message, with all fields set to nil here. I don't know what it is for, and
;; I just ignore it.
Miles Bader's avatar
Miles Bader committed
155
;;;###autoload
156
(defun gnus-user-format-function-d (header)
Paul Eggert's avatar
Paul Eggert committed
157
  ;; Return an approximate delay string for the next occurrence of this
158 159 160 161 162
  ;; message. The delay is given only in the first non zero unit.
  ;; Code partly stolen from article-make-date-line
  (let* ((extras (mail-header-extra header))
	 (sched (gnus-diary-header-schedule extras))
	 (now (current-time))
163
	 (occur (nndiary-next-occurrence sched now))
164
	 (real-time (time-subtract occur now)))
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    (let* ((sec (encode-time real-time 'integer))
	   (past (< sec 0))
	   delay)
      (and past (setq sec (- sec)))
      (unless (zerop sec)
	;; This is a bit convoluted, but basically we go through the time
	;; units for years, weeks, etc, and divide things to see whether
	;; that results in positive answers.
	(let ((units `((year . ,(round (* 365.25 24 3600)))
		       (month . ,(* 31 24 3600))
		       (week . ,(* 7 24 3600))
		       (day . ,(* 24 3600))
		       (hour . 3600)
		       (minute . 60)))
	      unit num)
	  (while (setq unit (pop units))
	    (unless (zerop (setq num (floor sec (cdr unit))))
	      (setq delay (append delay `((,num . ,(car unit))))))
	    (setq sec (mod sec (cdr unit))))))
      (funcall gnus-diary-delay-format-function past delay))))
185 186 187 188

;; #### NOTE: Gnus sometimes gives me a HEADER not corresponding to any
;; message, with all fields set to nil here. I don't know what it is for, and
;; I just ignore it.
Miles Bader's avatar
Miles Bader committed
189
;;;###autoload
190
(defun gnus-user-format-function-D (header)
Juanma Barranquero's avatar
Juanma Barranquero committed
191
  ;; Returns a formatted time string for the next occurrence of this message.
192 193
  (let* ((extras (mail-header-extra header))
	 (sched (gnus-diary-header-schedule extras))
Paul Eggert's avatar
Paul Eggert committed
194
	 (occur (nndiary-next-occurrence sched (current-time))))
195 196 197 198 199 200 201 202 203 204 205
    (format-time-string gnus-diary-time-format occur)))


;; Article sorting functions ================================================

(defun gnus-article-sort-by-schedule (h1 h2)
  (let* ((now (current-time))
	 (e1 (mail-header-extra h1))
	 (e2 (mail-header-extra h2))
	 (s1 (gnus-diary-header-schedule e1))
	 (s2 (gnus-diary-header-schedule e2))
Paul Eggert's avatar
Paul Eggert committed
206 207
	 (o1 (nndiary-next-occurrence s1 now))
	 (o2 (nndiary-next-occurrence s2 now)))
208 209 210 211 212 213 214 215 216 217
    (if (and (= (car o1) (car o2)) (= (cadr o1) (cadr o2)))
	(< (mail-header-number h1) (mail-header-number h2))
      (time-less-p o1 o2))))


(defun gnus-thread-sort-by-schedule (h1 h2)
  (gnus-article-sort-by-schedule (gnus-thread-header h1)
				 (gnus-thread-header h2)))

(defun gnus-summary-sort-by-schedule (&optional reverse)
218
  "Sort nndiary summary buffers by schedule of appointments.
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
Optional prefix (or REVERSE argument) means sort in reverse order."
  (interactive "P")
  (gnus-summary-sort 'schedule reverse))

(defvar gnus-summary-misc-menu) ;; Avoid byte compiler warning.
(add-hook 'gnus-summary-menu-hook
	  (lambda ()
	    (easy-menu-add-item gnus-summary-misc-menu
				'("Sort")
				["Sort by schedule"
				 gnus-summary-sort-by-schedule
				 (eq (car (gnus-find-method-for-group
					   gnus-newsgroup-name))
				     'nndiary)]
				"Sort by number")))



;; Group parameters autosetting =============================================

(defun gnus-diary-update-group-parameters (group)
  ;; Ensure that nndiary groups have convenient group parameters:
  ;; - a posting style containing X-Diary headers
  ;; - a nice summary line format
  ;; - NNDiary specific sorting by schedule functions
  ;; In general, try not to mess with what the user might have modified.
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270

  ;; Posting style:
  (let ((posting-style (gnus-group-get-parameter group 'posting-style t))
	(headers nndiary-headers)
	header)
    (while headers
      (setq header (format "X-Diary-%s" (caar headers))
	    headers (cdr headers))
      (unless (assoc header posting-style)
	(setq posting-style (append posting-style (list (list header "*"))))))
    (gnus-group-set-parameter group 'posting-style posting-style))
  ;; Summary line format:
  (unless (gnus-group-get-parameter group 'gnus-summary-line-format t)
    (gnus-group-set-parameter group 'gnus-summary-line-format
			      `(,gnus-diary-summary-line-format)))
  ;; Sorting by schedule:
  (unless (gnus-group-get-parameter group 'gnus-article-sort-functions)
    (gnus-group-set-parameter group 'gnus-article-sort-functions
			      '((append gnus-article-sort-functions
					(list
					 'gnus-article-sort-by-schedule)))))
  (unless (gnus-group-get-parameter group 'gnus-thread-sort-functions)
    (gnus-group-set-parameter group 'gnus-thread-sort-functions
			      '((append gnus-thread-sort-functions
					(list
					 'gnus-thread-sort-by-schedule))))))
271 272

;; Called when a group is subscribed. This is needed because groups created
273
;; because of mail splitting are *not* created with the back end function.
274
;; Thus, `nndiary-request-create-group-functions' is inoperative.
275 276 277 278
(defun gnus-diary-maybe-update-group-parameters (group)
  (when (eq (car (gnus-find-method-for-group group)) 'nndiary)
    (gnus-diary-update-group-parameters group)))

279
(add-hook 'nndiary-request-create-group-functions
280
	  'gnus-diary-update-group-parameters)
281
;; Now that we have `gnus-subscribe-newsgroup-functions', this is not needed
282
;; anymore. Maybe I should remove this completely.
283
(add-hook 'nndiary-request-update-info-functions
284
	  'gnus-diary-update-group-parameters)
285
(add-hook 'gnus-subscribe-newsgroup-functions
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
	  'gnus-diary-maybe-update-group-parameters)


;; Diary Message Checking ===================================================

(defvar gnus-diary-header-value-history nil
  ;; History variable for header value prompting
  )

(defun gnus-diary-narrow-to-headers ()
  "Narrow the current buffer to the header part.
Point is left at the beginning of the region.
The buffer is assumed to contain a message, but the format is unknown."
  (cond ((eq major-mode 'message-mode)
	 (message-narrow-to-headers))
	(t
	 (goto-char (point-min))
	 (when (search-forward "\n\n" nil t)
	   (narrow-to-region (point-min) (- (point) 1))
	   (goto-char (point-min))))
	))

(defun gnus-diary-add-header (str)
  "Add a header to the current buffer.
The buffer is assumed to contain a message, but the format is unknown."
  (cond ((eq major-mode 'message-mode)
	 (message-add-header str))
	(t
	 (save-restriction
	   (gnus-diary-narrow-to-headers)
	   (goto-char (point-max))
	   (if (string-match "\n$" str)
	       (insert str)
	     (insert str ?\n))))
	))

(defun gnus-diary-check-message (arg)
  "Ensure that the current message is a valid for NNDiary.
This function checks that all NNDiary required headers are present and
valid, and prompts for values / correction otherwise.

If ARG (or prefix) is non-nil, force prompting for all fields."
  (interactive "P")
  (save-excursion
    (mapcar
     (lambda (head)
       (let ((header (concat "X-Diary-" (car head)))
	     (ask arg)
	     value invalid)
	 ;; First, try to find the header, and checks for validity:
	 (save-restriction
	   (gnus-diary-narrow-to-headers)
	   (when (re-search-forward (concat "^" header ":") nil t)
	     (unless (eq (char-after) ? )
	       (insert " "))
341
	     (setq value (buffer-substring (point) (point-at-eol)))
342 343 344 345 346
	     (and (string-match "[ \t]*\\([^ \t]+\\)[ \t]*" value)
		  (setq value (match-string 1 value)))
	     (condition-case ()
		 (nndiary-parse-schedule-value value
					       (nth 1 head) (nth 2 head))
347
	       (error
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
		(setq invalid t)))
	     ;; #### NOTE: this (along with the `gnus-diary-add-header'
	     ;; function) could be rewritten in a better way, in particular
	     ;; not to blindly remove an already present header and reinsert
	     ;; it somewhere else afterwards.
	     (when (or ask invalid)
	       (gnus-diary-kill-entire-line))
	     ))
	 ;; Now, loop until a valid value is provided:
	 (while (or ask (not value) invalid)
	   (let ((prompt (concat (and invalid
				      (prog1 "(current value invalid) "
					(beep)))
				 header ": ")))
	     (setq value
		   (if (listp (nth 1 head))
364
		       (gnus-completing-read prompt (cons "*" (mapcar 'car (nth 1 head)))
365 366
                                             t value
                                             'gnus-diary-header-value-history)
367
		     (read-string prompt value
368
				  'gnus-diary-header-value-history))))
369 370 371 372 373
	   (setq ask nil)
	   (setq invalid nil)
	   (condition-case ()
	       (nndiary-parse-schedule-value value
					     (nth 1 head) (nth 2 head))
374
	     (error
375 376 377 378 379 380
	      (setq invalid t))))
	 (gnus-diary-add-header (concat header ": " value))
	 ))
     nndiary-headers)
    ))

381
(add-hook 'nndiary-request-accept-article-functions
382 383
	  (lambda () (gnus-diary-check-message nil)))

Miles Bader's avatar
Miles Bader committed
384 385
(define-key message-mode-map "\C-c\C-fd" 'gnus-diary-check-message)
(define-key gnus-article-edit-mode-map "\C-c\C-fd" 'gnus-diary-check-message)
386 387 388 389 390


;; The end ==================================================================

(defun gnus-diary-version ()
391
  "Current Diary back end version."
392 393 394 395 396 397
  (interactive)
  (message "NNDiary version %s" nndiary-version))

(provide 'gnus-diary)

;;; gnus-diary.el ends here