midnight.el 10 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
;;; midnight.el --- run something every midnight, e.g., kill old buffers.

;;; Copyright (C) 1998 Free Software Foundation, Inc.

;;; Author: Sam Steingold <sds@usa.net>
;;; Maintainer: Sam Steingold <sds@usa.net>
;;; Created: 1998-05-18
;;; Keywords: utilities

;; This file is part of GNU Emacs.

;; 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 2, or (at your option)
;; any later version.

;; 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.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Commentary:

;; To use the file, put (require 'midnight) into your .emacs.  Then, at
;; midnight, Emacs will run the normal hook `midnight-hook'.  You can
;; put whatever you like there, say, `calendar'; by default there is
;; only one function there - `clean-buffer-list'. It will kill the
;; buffers matching `clean-buffer-list-kill-buffer-names' and
;; `clean-buffer-list-kill-regexps' and the buffers which where last
;; displayed more than `clean-buffer-list-delay-general' days ago,
;; keeping `clean-buffer-list-kill-never-buffer-names' and
;; `clean-buffer-list-kill-never-regexps'.

39 40
;;; Code:

Richard M. Stallman's avatar
Richard M. Stallman committed
41
(eval-when-compile
42 43 44
 (require 'cl))

(require 'timer)
Richard M. Stallman's avatar
Richard M. Stallman committed
45 46 47

(defgroup midnight nil
  "Run something every day at midnight."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
48 49
  :group 'calendar
  :version "20.3")
Richard M. Stallman's avatar
Richard M. Stallman committed
50

51
(defcustom midnight-mode nil
52 53 54 55 56 57
  "*Non-nil means run `midnight-hook' at midnight.
Setting this variable outside customize has no effect;
call `cancel-timer' or `timer-activate' on `midnight-timer' instead."
  :type 'boolean
  :group 'midnight
  :require 'midnight
58
  :initialize 'custom-initialize-default
59 60 61 62 63
  :set (lambda (symb val)
         (set symb val) (require 'midnight)
         (if val (timer-activate midnight-timer)
             (cancel-timer midnight-timer))))

Richard M. Stallman's avatar
Richard M. Stallman committed
64 65
;;; time conversion

66
(defun midnight-float-time (&optional tm)
Richard M. Stallman's avatar
Richard M. Stallman committed
67 68 69 70
  "Convert `current-time' to a float number of seconds."
  (multiple-value-bind (s0 s1 s2) (or tm (current-time))
    (+ (* (float (ash 1 16)) s0) (float s1) (* 0.0000001 s2))))

71
(defun midnight-time-float (num)
Richard M. Stallman's avatar
Richard M. Stallman committed
72 73 74 75 76
  "Convert the float number of seconds since epoch to the list of 3 integers."
  (let* ((div (ash 1 16)) (1st (floor num div)))
    (list 1st (floor (- num (* (float div) 1st)))
          (round (* 10000000 (mod num 1))))))

77
(defun midnight-buffer-display-time (&optional buf)
Richard M. Stallman's avatar
Richard M. Stallman committed
78 79 80
  "Return the time-stamp of the given buffer, or current buffer, as float."
  (save-excursion
    (set-buffer (or buf (current-buffer)))
81
    (when buffer-display-time (midnight-float-time buffer-display-time))))
Richard M. Stallman's avatar
Richard M. Stallman committed
82 83 84 85 86 87 88 89 90 91

;;; clean-buffer-list stuff

(defcustom clean-buffer-list-delay-general 3
  "*The number of days before any buffer becomes eligible for autokilling.
The autokilling is done by `clean-buffer-list' when is it in `midnight-hook'.
Currently displayed and/or modified (unsaved) buffers, as well as buffers
matching `clean-buffer-list-kill-never-buffer-names' and
`clean-buffer-list-kill-never-regexps' are excluded."
  :type 'integer
Dan Nicolaescu's avatar
Dan Nicolaescu committed
92
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
93 94 95 96 97 98 99

(defcustom clean-buffer-list-delay-special 3600
  "*The number of seconds before some buffers become eligible for autokilling.
Buffers matched by `clean-buffer-list-kill-regexps' and
`clean-buffer-list-kill-buffer-names' are killed if they were last
displayed more than this many seconds ago."
  :type 'integer
Dan Nicolaescu's avatar
Dan Nicolaescu committed
100
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
101

102
(defcustom clean-buffer-list-kill-regexps nil
Richard M. Stallman's avatar
Richard M. Stallman committed
103 104 105 106 107 108 109 110 111
  "*List of regexps saying which buffers will be killed at midnight.
If buffer name matches a regexp in the list and the buffer was not displayed
in the last `clean-buffer-list-delay-special' seconds, it is killed by
`clean-buffer-list' when is it in `midnight-hook'.
If a member of the list is a cons, it's `car' is the regexp and its `cdr' is
the number of seconds to use instead of `clean-buffer-list-delay-special'.
See also `clean-buffer-list-kill-buffer-names',
`clean-buffer-list-kill-never-regexps' and
`clean-buffer-list-kill-never-buffer-names'."
112
  :type '(repeat (regexp :tag "Regexp matching Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
113
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
114 115

(defcustom clean-buffer-list-kill-buffer-names
116
    '("*Help*" "*Apropos*" "*Man " "*Buffer List*" "*Compile-Log*" "*info*"
117
      "*vc*" "*vc-diff*" "*diff*")
Richard M. Stallman's avatar
Richard M. Stallman committed
118 119 120 121 122 123 124 125 126
  "*List of strings saying which buffers will be killed at midnight.
Buffers with names in this list, which were not displayed in the last
`clean-buffer-list-delay-special' seconds, are killed by `clean-buffer-list'
when is it in `midnight-hook'.
If a member of the list is a cons, it's `car' is the name and its `cdr' is
the number of seconds to use instead of `clean-buffer-list-delay-special'.
See also `clean-buffer-list-kill-regexps',
`clean-buffer-list-kill-never-regexps' and
`clean-buffer-list-kill-never-buffer-names'."
127
  :type '(repeat (string :tag "Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
128
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
129 130 131 132 133 134 135 136

(defcustom clean-buffer-list-kill-never-buffer-names
    '("*scratch*" "*Messages*")
  "*List of buffer names which will never be killed by `clean-buffer-list'.
See also `clean-buffer-list-kill-never-regexps'.
Note that this does override `clean-buffer-list-kill-regexps' and
`clean-buffer-list-kill-buffer-names' so a buffer matching any of these
two lists will NOT be killed if it is also present in this list."
137
  :type '(repeat (string :tag "Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
138 139
  :group 'midnight)

Richard M. Stallman's avatar
Richard M. Stallman committed
140 141 142 143 144 145 146 147

(defcustom clean-buffer-list-kill-never-regexps '("^ \*Minibuf-.*\*$")
  "*List of regexp saying which buffers will never be killed at midnight.
See also `clean-buffer-list-kill-never-buffer-names'.
Killing is done by `clean-buffer-list'.
Note that this does override `clean-buffer-list-kill-regexps' and
`clean-buffer-list-kill-buffer-names' so a buffer matching any of these
two lists will NOT be killed if it also matches anything in this list."
148
  :type '(repeat (regexp :tag "Regexp matching Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
149
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
150 151 152

(defun midnight-find (el ls test &optional key)
  "A stopgap solution to the absence of `find' in ELisp."
153 154 155
  (dolist (rr ls)
    (when (funcall test el (if key (funcall key rr) rr))
      (return rr))))
Richard M. Stallman's avatar
Richard M. Stallman committed
156

157 158
(defun clean-buffer-list-delay (name)
  "Return the delay, in seconds, before killing a buffer named NAME.
Richard M. Stallman's avatar
Richard M. Stallman committed
159 160 161
Uses `clean-buffer-list-kill-buffer-names', `clean-buffer-list-kill-regexps'
`clean-buffer-list-delay-general' and `clean-buffer-list-delay-special'.
Autokilling is done by `clean-buffer-list'."
162
  (or (assoc-default name clean-buffer-list-kill-buffer-names 'string=
Richard M. Stallman's avatar
Richard M. Stallman committed
163
                     clean-buffer-list-delay-special)
164
      (assoc-default name clean-buffer-list-kill-regexps 'string-match
Richard M. Stallman's avatar
Richard M. Stallman committed
165 166
                     clean-buffer-list-delay-special)
      (* clean-buffer-list-delay-general 24 60 60)))
Richard M. Stallman's avatar
Richard M. Stallman committed
167

168
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
169
(defun clean-buffer-list ()
170
  "Kill old buffers that have not been displayed recently.
171
The relevant variables are `clean-buffer-list-delay-general',
Richard M. Stallman's avatar
Richard M. Stallman committed
172 173
`clean-buffer-list-delay-special', `clean-buffer-list-kill-buffer-names',
`clean-buffer-list-kill-never-buffer-names',
174 175 176 177
`clean-buffer-list-kill-regexps' and
`clean-buffer-list-kill-never-regexps'.
While processing buffers, this procedure displays messages containing
the current date/time, buffer name, how many seconds ago it was
178 179
displayed (can be nil if the buffer was never displayed) and its
lifetime, i.e., its \"age\" when it will be purged."
Richard M. Stallman's avatar
Richard M. Stallman committed
180
  (interactive)
181 182
  (let ((tm (midnight-float-time)) bts (ts (format-time-string "%Y-%m-%d %T"))
        (bufs (buffer-list)) buf delay cbld bn)
183
    (while (setq buf (pop bufs))
184
      (setq bts (midnight-buffer-display-time buf) bn (buffer-name buf)
185 186
            delay (if bts (- tm bts) 0) cbld (clean-buffer-list-delay bn))
      (message "[%s] `%s' [%s %d]" ts bn (if bts (round delay)) cbld)
Richard M. Stallman's avatar
Richard M. Stallman committed
187
      (unless (or (midnight-find bn clean-buffer-list-kill-never-regexps
Richard M. Stallman's avatar
Richard M. Stallman committed
188 189 190
                                 'string-match)
                  (midnight-find bn clean-buffer-list-kill-never-buffer-names
                                 'string-equal)
191
                  (get-buffer-process buf)
192 193
                  (and (buffer-file-name buf) (buffer-modified-p buf))
                  (get-buffer-window buf 'visible) (< delay cbld))
Richard M. Stallman's avatar
Richard M. Stallman committed
194 195 196 197 198 199
        (message "[%s] killing `%s'" ts bn)
        (kill-buffer buf)))))

;;; midnight hook

(defvar midnight-period (* 24 60 60)
200
  "The number of seconds in a day--the delta for `midnight-timer'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
201

202
(defcustom midnight-hook '(clean-buffer-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
203 204 205
  "The hook run `midnight-delay' seconds after midnight every day.
The default value is `clean-buffer-list'."
  :type 'hook
Dan Nicolaescu's avatar
Dan Nicolaescu committed
206
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
207 208 209 210 211 212 213 214 215 216 217 218 219 220

(defun midnight-next ()
  "Return the number of seconds till the next midnight."
  (multiple-value-bind (sec min hrs) (decode-time)
    (- (* 24 60 60) (* 60 60 hrs) (* 60 min) sec)))

(defvar midnight-timer nil
  "Timer running the `midnight-hook' `midnight-delay' seconds after midnight.
Use `cancel-timer' to stop it and `midnight-delay-set' to change
the time when it is run.")

;;;###autoload
(defun midnight-delay-set (symb tm)
  "Modify `midnight-timer' according to `midnight-delay'.
221 222 223 224
Sets the first argument SYMB (which must be symbol `midnight-delay')
to its second argument TM."
  (assert (eq symb 'midnight-delay) t
          "Illegal argument to `midnight-delay-set': `%s'" symb)
Richard M. Stallman's avatar
Richard M. Stallman committed
225 226 227 228
  (set symb tm)
  (when (timerp midnight-timer) (cancel-timer midnight-timer))
  (setq midnight-timer
        (run-at-time (if (numberp tm) (+ (midnight-next) tm) tm)
229
                     midnight-period 'run-hooks 'midnight-hook)))
Richard M. Stallman's avatar
Richard M. Stallman committed
230 231 232 233 234 235 236 237 238

(defcustom midnight-delay 3600
  "*The number of seconds after the midnight when the `midnight-timer' is run.
You should set this variable before loading midnight.el, or
set it by calling `midnight-delay-set', or use `custom'.
If you wish, you can use a string instead, it will be passed as the
first argument to `run-at-time'."
  :type 'sexp
  :set 'midnight-delay-set
Dan Nicolaescu's avatar
Dan Nicolaescu committed
239
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
240 241 242 243

(provide 'midnight)

;;; midnight.el ends here