Mercurial > emacs
comparison lisp/gnus/gnus-demon.el @ 17493:e6935c08cf0b
Initial revision
author | Lars Magne Ingebrigtsen <larsi@gnus.org> |
---|---|
date | Wed, 16 Apr 1997 22:13:18 +0000 |
parents | |
children | 8d840c4548c0 |
comparison
equal
deleted
inserted
replaced
17492:59dc7e0fc186 | 17493:e6935c08cf0b |
---|---|
1 ;;; gnus-demon.el --- daemonic Gnus behaviour | |
2 ;; Copyright (C) 1995,96,97 Free Software Foundation, Inc. | |
3 | |
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no> | |
5 ;; Keywords: news | |
6 | |
7 ;; This file is part of GNU Emacs. | |
8 | |
9 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
10 ;; it under the terms of the GNU General Public License as published by | |
11 ;; the Free Software Foundation; either version 2, or (at your option) | |
12 ;; any later version. | |
13 | |
14 ;; GNU Emacs is distributed in the hope that it will be useful, | |
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 ;; GNU General Public License for more details. | |
18 | |
19 ;; You should have received a copy of the GNU General Public License | |
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
22 ;; Boston, MA 02111-1307, USA. | |
23 | |
24 ;;; Commentary: | |
25 | |
26 ;;; Code: | |
27 | |
28 (require 'gnus) | |
29 (require 'gnus-int) | |
30 (require 'nnheader) | |
31 (eval-and-compile | |
32 (if (string-match "XEmacs" (emacs-version)) | |
33 (require 'itimer) | |
34 (require 'timer))) | |
35 | |
36 (defgroup gnus-demon nil | |
37 "Demonic behaviour." | |
38 :group 'gnus) | |
39 | |
40 (defcustom gnus-demon-handlers nil | |
41 "Alist of daemonic handlers to be run at intervals. | |
42 Each handler is a list on the form | |
43 | |
44 \(FUNCTION TIME IDLE) | |
45 | |
46 FUNCTION is the function to be called. | |
47 TIME is the number of `gnus-demon-timestep's between each call. | |
48 If nil, never call. If t, call each `gnus-demon-timestep'. | |
49 If IDLE is t, only call if Emacs has been idle for a while. If IDLE | |
50 is a number, only call when Emacs has been idle more than this number | |
51 of `gnus-demon-timestep's. If IDLE is nil, don't care about | |
52 idleness. If IDLE is a number and TIME is nil, then call once each | |
53 time Emacs has been idle for IDLE `gnus-demon-timestep's." | |
54 :group 'gnus-demon | |
55 :type '(repeat (list function | |
56 (choice :tag "Time" | |
57 (const :tag "never" nil) | |
58 (const :tag "one" t) | |
59 (integer :tag "steps" 1)) | |
60 (choice :tag "Idle" | |
61 (const :tag "don't care" nil) | |
62 (const :tag "for a while" t) | |
63 (integer :tag "steps" 1))))) | |
64 | |
65 (defcustom gnus-demon-timestep 60 | |
66 "*Number of seconds in each demon timestep." | |
67 :group 'gnus-demon | |
68 :type 'integer) | |
69 | |
70 ;;; Internal variables. | |
71 | |
72 (defvar gnus-demon-timer nil) | |
73 (defvar gnus-demon-idle-has-been-called nil) | |
74 (defvar gnus-demon-idle-time 0) | |
75 (defvar gnus-demon-handler-state nil) | |
76 (defvar gnus-demon-last-keys nil) | |
77 (defvar gnus-inhibit-demon nil | |
78 "*If non-nil, no daemonic function will be run.") | |
79 | |
80 (eval-and-compile | |
81 (autoload 'timezone-parse-date "timezone") | |
82 (autoload 'timezone-make-arpa-date "timezone")) | |
83 | |
84 ;;; Functions. | |
85 | |
86 (defun gnus-demon-add-handler (function time idle) | |
87 "Add the handler FUNCTION to be run at TIME and IDLE." | |
88 ;; First remove any old handlers that use this function. | |
89 (gnus-demon-remove-handler function) | |
90 ;; Then add the new one. | |
91 (push (list function time idle) gnus-demon-handlers) | |
92 (gnus-demon-init)) | |
93 | |
94 (defun gnus-demon-remove-handler (function &optional no-init) | |
95 "Remove the handler FUNCTION from the list of handlers." | |
96 (setq gnus-demon-handlers | |
97 (delq (assq function gnus-demon-handlers) | |
98 gnus-demon-handlers)) | |
99 (unless no-init | |
100 (gnus-demon-init))) | |
101 | |
102 (defun gnus-demon-init () | |
103 "Initialize the Gnus daemon." | |
104 (interactive) | |
105 (gnus-demon-cancel) | |
106 (if (null gnus-demon-handlers) | |
107 () ; Nothing to do. | |
108 ;; Set up timer. | |
109 (setq gnus-demon-timer | |
110 (nnheader-run-at-time | |
111 gnus-demon-timestep gnus-demon-timestep 'gnus-demon)) | |
112 ;; Reset control variables. | |
113 (setq gnus-demon-handler-state | |
114 (mapcar | |
115 (lambda (handler) | |
116 (list (car handler) (gnus-demon-time-to-step (nth 1 handler)) | |
117 (nth 2 handler))) | |
118 gnus-demon-handlers)) | |
119 (setq gnus-demon-idle-time 0) | |
120 (setq gnus-demon-idle-has-been-called nil) | |
121 (setq gnus-use-demon t))) | |
122 | |
123 (gnus-add-shutdown 'gnus-demon-cancel 'gnus) | |
124 | |
125 (defun gnus-demon-cancel () | |
126 "Cancel any Gnus daemons." | |
127 (interactive) | |
128 (when gnus-demon-timer | |
129 (nnheader-cancel-timer gnus-demon-timer)) | |
130 (setq gnus-demon-timer nil | |
131 gnus-use-demon nil) | |
132 (condition-case () | |
133 (nnheader-cancel-function-timers 'gnus-demon) | |
134 (error t))) | |
135 | |
136 (defun gnus-demon-is-idle-p () | |
137 "Whether Emacs is idle or not." | |
138 ;; We do this simply by comparing the 100 most recent keystrokes | |
139 ;; with the ones we had last time. If they are the same, one might | |
140 ;; guess that Emacs is indeed idle. This only makes sense if one | |
141 ;; calls this function seldom -- like once a minute, which is what | |
142 ;; we do here. | |
143 (let ((keys (recent-keys))) | |
144 (or (equal keys gnus-demon-last-keys) | |
145 (progn | |
146 (setq gnus-demon-last-keys keys) | |
147 nil)))) | |
148 | |
149 (defun gnus-demon-time-to-step (time) | |
150 "Find out how many seconds to TIME, which is on the form \"17:43\"." | |
151 (if (not (stringp time)) | |
152 time | |
153 (let* ((date (current-time-string)) | |
154 (dv (timezone-parse-date date)) | |
155 (tdate (timezone-make-arpa-date | |
156 (string-to-number (aref dv 0)) | |
157 (string-to-number (aref dv 1)) | |
158 (string-to-number (aref dv 2)) time | |
159 (or (aref dv 4) "UT"))) | |
160 (nseconds (gnus-time-minus | |
161 (gnus-encode-date tdate) (gnus-encode-date date)))) | |
162 (round | |
163 (/ (+ (if (< (car nseconds) 0) | |
164 86400 0) | |
165 (* 65536 (car nseconds)) | |
166 (nth 1 nseconds)) | |
167 gnus-demon-timestep))))) | |
168 | |
169 (defun gnus-demon () | |
170 "The Gnus daemon that takes care of running all Gnus handlers." | |
171 ;; Increase or reset the time Emacs has been idle. | |
172 (if (gnus-demon-is-idle-p) | |
173 (incf gnus-demon-idle-time) | |
174 (setq gnus-demon-idle-time 0) | |
175 (setq gnus-demon-idle-has-been-called nil)) | |
176 ;; Disable all daemonic stuff if we're in the minibuffer | |
177 (when (and (not (window-minibuffer-p (selected-window))) | |
178 (not gnus-inhibit-demon)) | |
179 ;; Then we go through all the handler and call those that are | |
180 ;; sufficiently ripe. | |
181 (let ((handlers gnus-demon-handler-state) | |
182 (gnus-inhibit-demon t) | |
183 handler time idle) | |
184 (while handlers | |
185 (setq handler (pop handlers)) | |
186 (cond | |
187 ((numberp (setq time (nth 1 handler))) | |
188 ;; These handlers use a regular timeout mechanism. We decrease | |
189 ;; the timer if it hasn't reached zero yet. | |
190 (unless (zerop time) | |
191 (setcar (nthcdr 1 handler) (decf time))) | |
192 (and (zerop time) ; If the timer now is zero... | |
193 ;; Test for appropriate idleness | |
194 (progn | |
195 (setq idle (nth 2 handler)) | |
196 (cond | |
197 ((null idle) t) ; Don't care about idle. | |
198 ((numberp idle) ; Numerical idle... | |
199 (< idle gnus-demon-idle-time)) ; Idle timed out. | |
200 (t (< 0 gnus-demon-idle-time)))) ; Or just need to be idle. | |
201 ;; So we call the handler. | |
202 (progn | |
203 (funcall (car handler)) | |
204 ;; And reset the timer. | |
205 (setcar (nthcdr 1 handler) | |
206 (gnus-demon-time-to-step | |
207 (nth 1 (assq (car handler) gnus-demon-handlers))))))) | |
208 ;; These are only supposed to be called when Emacs is idle. | |
209 ((null (setq idle (nth 2 handler))) | |
210 ;; We do nothing. | |
211 ) | |
212 ((not (numberp idle)) | |
213 ;; We want to call this handler each and every time that | |
214 ;; Emacs is idle. | |
215 (funcall (car handler))) | |
216 (t | |
217 ;; We want to call this handler only if Emacs has been idle | |
218 ;; for a specified number of timesteps. | |
219 (and (not (memq (car handler) gnus-demon-idle-has-been-called)) | |
220 (< idle gnus-demon-idle-time) | |
221 (progn | |
222 (funcall (car handler)) | |
223 ;; Make sure the handler won't be called once more in | |
224 ;; this idle-cycle. | |
225 (push (car handler) gnus-demon-idle-has-been-called))))))))) | |
226 | |
227 (defun gnus-demon-add-nocem () | |
228 "Add daemonic NoCeM handling to Gnus." | |
229 (gnus-demon-add-handler 'gnus-demon-scan-nocem 60 t)) | |
230 | |
231 (defun gnus-demon-scan-nocem () | |
232 "Scan NoCeM groups for NoCeM messages." | |
233 (save-window-excursion | |
234 (gnus-nocem-scan-groups))) | |
235 | |
236 (defun gnus-demon-add-disconnection () | |
237 "Add daemonic server disconnection to Gnus." | |
238 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30)) | |
239 | |
240 (defun gnus-demon-close-connections () | |
241 (save-window-excursion | |
242 (gnus-close-backends))) | |
243 | |
244 (defun gnus-demon-add-scanmail () | |
245 "Add daemonic scanning of mail from the mail backends." | |
246 (gnus-demon-add-handler 'gnus-demon-scan-mail 120 60)) | |
247 | |
248 (defun gnus-demon-scan-mail () | |
249 (save-window-excursion | |
250 (let ((servers gnus-opened-servers) | |
251 server) | |
252 (while (setq server (car (pop servers))) | |
253 (and (gnus-check-backend-function 'request-scan (car server)) | |
254 (or (gnus-server-opened server) | |
255 (gnus-open-server server)) | |
256 (gnus-request-scan nil server)))))) | |
257 | |
258 (defun gnus-demon-add-rescan () | |
259 "Add daemonic scanning of new articles from all backends." | |
260 (gnus-demon-add-handler 'gnus-demon-scan-news 120 60)) | |
261 | |
262 (defun gnus-demon-scan-news () | |
263 (save-window-excursion | |
264 (when (gnus-alive-p) | |
265 (save-excursion | |
266 (set-buffer gnus-group-buffer) | |
267 (gnus-group-get-new-news))))) | |
268 | |
269 (defun gnus-demon-add-scan-timestamps () | |
270 "Add daemonic updating of timestamps in empty newgroups." | |
271 (gnus-demon-add-handler 'gnus-demon-scan-timestamps nil 30)) | |
272 | |
273 (defun gnus-demon-scan-timestamps () | |
274 "Set the timestamp on all newsgroups with no unread and no ticked articles." | |
275 (when (gnus-alive-p) | |
276 (let ((cur-time (current-time)) | |
277 (newsrc (cdr gnus-newsrc-alist)) | |
278 info group unread has-ticked) | |
279 (while (setq info (pop newsrc)) | |
280 (setq group (gnus-info-group info) | |
281 unread (gnus-group-unread group) | |
282 has-ticked (cdr (assq 'tick (gnus-info-marks info)))) | |
283 (when (and (numberp unread) | |
284 (= unread 0) | |
285 (not has-ticked)) | |
286 (gnus-group-set-parameter group 'timestamp cur-time)))))) | |
287 | |
288 (provide 'gnus-demon) | |
289 | |
290 ;;; gnus-demon.el ends here |