1 ;;; gnus-demon.el --- daemonic Gnus behaviour
2 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
7 ;; This file is part of GNU Emacs.
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)
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.
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.
32 (if (string-match "XEmacs" (emacs-version))
36 (defgroup gnus-demon nil
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
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."
55 :type '(repeat (list function
57 (const :tag "never" nil)
59 (integer :tag "steps" 1))
61 (const :tag "don't care" nil)
62 (const :tag "for a while" t)
63 (integer :tag "steps" 1)))))
65 (defcustom gnus-demon-timestep 60
66 "*Number of seconds in each demon timestep."
70 ;;; Internal variables.
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-is-idle nil)
77 (defvar gnus-demon-last-keys nil)
80 (autoload 'timezone-parse-date "timezone")
81 (autoload 'timezone-make-arpa-date "timezone"))
85 (defun gnus-demon-add-handler (function time idle)
86 "Add the handler FUNCTION to be run at TIME and IDLE."
87 ;; First remove any old handlers that use this function.
88 (gnus-demon-remove-handler function)
89 ;; Then add the new one.
90 (push (list function time idle) gnus-demon-handlers)
93 (defun gnus-demon-remove-handler (function &optional no-init)
94 "Remove the handler FUNCTION from the list of handlers."
95 (setq gnus-demon-handlers
96 (delq (assq function gnus-demon-handlers)
101 (defun gnus-demon-init ()
102 "Initialize the Gnus daemon."
105 (if (null gnus-demon-handlers)
108 (setq gnus-demon-timer
109 (nnheader-run-at-time
110 gnus-demon-timestep gnus-demon-timestep 'gnus-demon))
111 ;; Reset control variables.
112 (setq gnus-demon-handler-state
115 (list (car handler) (gnus-demon-time-to-step (nth 1 handler))
117 gnus-demon-handlers))
118 (setq gnus-demon-idle-time 0)
119 (setq gnus-demon-idle-has-been-called nil)
120 (setq gnus-use-demon t)))
122 (gnus-add-shutdown 'gnus-demon-cancel 'gnus)
124 (defun gnus-demon-cancel ()
125 "Cancel any Gnus daemons."
127 (when gnus-demon-timer
128 (nnheader-cancel-timer gnus-demon-timer))
129 (setq gnus-demon-timer nil
132 (nnheader-cancel-function-timers 'gnus-demon)
135 (defun gnus-demon-is-idle-p ()
136 "Whether Emacs is idle or not."
137 ;; We do this simply by comparing the 100 most recent keystrokes
138 ;; with the ones we had last time. If they are the same, one might
139 ;; guess that Emacs is indeed idle. This only makes sense if one
140 ;; calls this function seldom -- like once a minute, which is what
142 (let ((keys (recent-keys)))
143 (or (equal keys gnus-demon-last-keys)
145 (setq gnus-demon-last-keys keys)
148 (defun gnus-demon-time-to-step (time)
149 "Find out how many seconds to TIME, which is on the form \"17:43\"."
150 (if (not (stringp time))
152 (let* ((date (current-time-string))
153 (dv (timezone-parse-date date))
154 (tdate (timezone-make-arpa-date
155 (string-to-number (aref dv 0))
156 (string-to-number (aref dv 1))
157 (string-to-number (aref dv 2)) time
158 (or (aref dv 4) "UT")))
159 (nseconds (gnus-time-minus
160 (gnus-encode-date tdate) (gnus-encode-date date))))
162 (/ (if (< nseconds 0)
163 (+ nseconds (* 60 60 24))
165 gnus-demon-timestep)))))
168 "The Gnus daemon that takes care of running all Gnus handlers."
169 ;; Increase or reset the time Emacs has been idle.
170 (if (gnus-demon-is-idle-p)
171 (incf gnus-demon-idle-time)
172 (setq gnus-demon-idle-time 0)
173 (setq gnus-demon-idle-has-been-called nil))
174 ;; Then we go through all the handler and call those that are
175 ;; sufficiently ripe.
176 (let ((handlers gnus-demon-handler-state)
179 (setq handler (pop handlers))
181 ((numberp (setq time (nth 1 handler)))
182 ;; These handlers use a regular timeout mechanism. We decrease
183 ;; the timer if it hasn't reached zero yet.
185 (setcar (nthcdr 1 handler) (decf time)))
186 (and (zerop time) ; If the timer now is zero...
187 (or (not (setq idle (nth 2 handler))) ; Don't care about idle.
188 (and (numberp idle) ; Numerical idle...
189 (< idle gnus-demon-idle-time)) ; Idle timed out.
190 gnus-demon-is-idle) ; Or just need to be idle.
191 ;; So we call the handler.
193 (funcall (car handler))
194 ;; And reset the timer.
195 (setcar (nthcdr 1 handler)
196 (gnus-demon-time-to-step
197 (nth 1 (assq (car handler) gnus-demon-handlers)))))))
198 ;; These are only supposed to be called when Emacs is idle.
199 ((null (setq idle (nth 2 handler)))
202 ((not (numberp idle))
203 ;; We want to call this handler each and every time that
205 (funcall (car handler)))
207 ;; We want to call this handler only if Emacs has been idle
208 ;; for a specified number of timesteps.
209 (and (not (memq (car handler) gnus-demon-idle-has-been-called))
210 (< idle gnus-demon-idle-time)
212 (funcall (car handler))
213 ;; Make sure the handler won't be called once more in
215 (push (car handler) gnus-demon-idle-has-been-called))))))))
217 (defun gnus-demon-add-nocem ()
218 "Add daemonic NoCeM handling to Gnus."
219 (gnus-demon-add-handler 'gnus-demon-scan-nocem 60 t))
221 (defun gnus-demon-scan-nocem ()
222 "Scan NoCeM groups for NoCeM messages."
223 (save-window-excursion
224 (gnus-nocem-scan-groups)))
226 (defun gnus-demon-add-disconnection ()
227 "Add daemonic server disconnection to Gnus."
228 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30))
230 (defun gnus-demon-close-connections ()
231 (save-window-excursion
232 (gnus-close-backends)))
234 (defun gnus-demon-add-scanmail ()
235 "Add daemonic scanning of mail from the mail backends."
236 (gnus-demon-add-handler 'gnus-demon-scan-mail 120 60))
238 (defun gnus-demon-scan-mail ()
239 (save-window-excursion
240 (let ((servers gnus-opened-servers)
242 (while (setq server (car (pop servers)))
243 (and (gnus-check-backend-function 'request-scan (car server))
244 (or (gnus-server-opened server)
245 (gnus-open-server server))
246 (gnus-request-scan nil server))))))
248 (defun gnus-demon-add-rescan ()
249 "Add daemonic scanning of new articles from all backends."
250 (gnus-demon-add-handler 'gnus-demon-scan-news 120 60))
252 (defun gnus-demon-scan-news ()
253 (save-window-excursion
256 (set-buffer gnus-group-buffer)
257 (gnus-group-get-new-news)))))
259 (provide 'gnus-demon)
261 ;;; gnus-demon.el ends here