cgit.sxemacs.org Git - gnus/blob - lisp/gnus-demon.el

   1 ;;; gnus-demon.el --- daemonic Gnus behaviour
   2 ;; Copyright (C) 1995,96 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-load)
  29 (require 'gnus-int)
  30 (require 'nnheader)
  31 (require 'gnus)
  32 (eval-and-compile
  33   (if (string-match "XEmacs" (emacs-version))
  34       (require 'itimer)
  35     (require 'timer)))
  36
  37 (defgroup gnus-demon nil
  38   "Demonic behaviour."
  39   :group 'gnus)
  40
  41 (defcustom gnus-demon-handlers nil
  42   "Alist of daemonic handlers to be run at intervals.
  43 Each handler is a list on the form
  44
  45 \(FUNCTION TIME IDLE)
  46
  47 FUNCTION is the function to be called.
  48 TIME is the number of `gnus-demon-timestep's between each call.
  49 If nil, never call.  If t, call each `gnus-demon-timestep'.
  50 If IDLE is t, only call if Emacs has been idle for a while.  If IDLE
  51 is a number, only call when Emacs has been idle more than this number
  52 of `gnus-demon-timestep's.  If IDLE is nil, don't care about
  53 idleness.  If IDLE is a number and TIME is nil, then call once each
  54 time Emacs has been idle for IDLE `gnus-demon-timestep's."
  55   :group 'gnus-demon
  56   :type '(repeat (list function
  57                        (choice :tag "Time"
  58                                (const :tag "never" nil)
  59                                (const :tag "one" t)
  60                                (integer :tag "steps" 1))
  61                        (choice :tag "Idle"
  62                                (const :tag "don't care" nil)
  63                                (const :tag "for a while" t)
  64                                (integer :tag "steps" 1)))))
  65
  66 (defcustom gnus-demon-timestep 60
  67   "*Number of seconds in each demon timestep."
  68   :group 'gnus-demon
  69   :type 'integer)
  70
  71 ;;; Internal variables.
  72
  73 (defvar gnus-demon-timer nil)
  74 (defvar gnus-demon-idle-has-been-called nil)
  75 (defvar gnus-demon-idle-time 0)
  76 (defvar gnus-demon-handler-state nil)
  77 (defvar gnus-demon-is-idle nil)
  78 (defvar gnus-demon-last-keys nil)
  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 (< nseconds 0)
 164               (+ nseconds (* 60 60 24))
 165             nseconds)
 166           gnus-demon-timestep)))))
 167
 168 (defun gnus-demon ()
 169   "The Gnus daemon that takes care of running all Gnus handlers."
 170   ;; Increase or reset the time Emacs has been idle.
 171   (if (gnus-demon-is-idle-p)
 172       (incf gnus-demon-idle-time)
 173     (setq gnus-demon-idle-time 0)
 174     (setq gnus-demon-idle-has-been-called nil))
 175   ;; Then we go through all the handler and call those that are
 176   ;; sufficiently ripe.
 177   (let ((handlers gnus-demon-handler-state)
 178         handler time idle)
 179     (while handlers
 180       (setq handler (pop handlers))
 181       (cond
 182        ((numberp (setq time (nth 1 handler)))
 183         ;; These handlers use a regular timeout mechanism.  We decrease
 184         ;; the timer if it hasn't reached zero yet.
 185         (unless (zerop time)
 186           (setcar (nthcdr 1 handler) (decf time)))
 187         (and (zerop time)               ; If the timer now is zero...
 188              (or (not (setq idle (nth 2 handler))) ; Don't care about idle.
 189                  (and (numberp idle)    ; Numerical idle...
 190                       (< idle gnus-demon-idle-time)) ; Idle timed out.
 191                  gnus-demon-is-idle)    ; Or just need to be idle.
 192              ;; So we call the handler.
 193              (progn
 194                (funcall (car handler))
 195                ;; And reset the timer.
 196                (setcar (nthcdr 1 handler)
 197                        (gnus-demon-time-to-step
 198                         (nth 1 (assq (car handler) gnus-demon-handlers)))))))
 199        ;; These are only supposed to be called when Emacs is idle.
 200        ((null (setq idle (nth 2 handler)))
 201         ;; We do nothing.
 202         )
 203        ((not (numberp idle))
 204         ;; We want to call this handler each and every time that
 205         ;; Emacs is idle.
 206         (funcall (car handler)))
 207        (t
 208         ;; We want to call this handler only if Emacs has been idle
 209         ;; for a specified number of timesteps.
 210         (and (not (memq (car handler) gnus-demon-idle-has-been-called))
 211              (< idle gnus-demon-idle-time)
 212              (progn
 213                (funcall (car handler))
 214                ;; Make sure the handler won't be called once more in
 215                ;; this idle-cycle.
 216                (push (car handler) gnus-demon-idle-has-been-called))))))))
 217
 218 (defun gnus-demon-add-nocem ()
 219   "Add daemonic NoCeM handling to Gnus."
 220   (gnus-demon-add-handler 'gnus-demon-scan-nocem 60 t))
 221
 222 (defun gnus-demon-scan-nocem ()
 223   "Scan NoCeM groups for NoCeM messages."
 224   (gnus-nocem-scan-groups))
 225
 226 (defun gnus-demon-add-disconnection ()
 227   "Add daemonic server disconnection to Gnus."
 228   (gnus-demon-add-handler 'gnus-demon-close-connections nil 30))
 229
 230 (defun gnus-demon-close-connections ()
 231   (gnus-close-backends))
 232
 233 (defun gnus-demon-add-scanmail ()
 234   "Add daemonic scanning of mail from the mail backends."
 235   (gnus-demon-add-handler 'gnus-demon-scan-mail 120 60))
 236
 237 (defun gnus-demon-scan-mail ()
 238   (let ((servers gnus-opened-servers)
 239         server)
 240     (while (setq server (car (pop servers)))
 241       (and (gnus-check-backend-function 'request-scan (car server))
 242            (or (gnus-server-opened server)
 243                (gnus-open-server server))
 244            (gnus-request-scan nil server)))))
 245
 246 (defun gnus-demon-add-rescan ()
 247   "Add daemonic scanning of new articles from all backends."
 248   (gnus-demon-add-handler 'gnus-demon-scan-news 120 60))
 249
 250 (defun gnus-demon-scan-news ()
 251   (when (gnus-alive-p)
 252     (save-excursion
 253       (set-buffer gnus-group-buffer)
 254       (gnus-group-get-new-news))))
 255
 256 (provide 'gnus-demon)
 257
 258 ;;; gnus-demon.el ends here