midnight.el 9.81 KB
Newer Older
1
;;; midnight.el --- run something every midnight, e.g., kill old buffers
Richard M. Stallman's avatar
Richard M. Stallman committed
2

3
;;; Copyright (C) 1998, 2004, 2005 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

5 6 7 8
;; Author: Sam Steingold <sds@usa.net>
;; Maintainer: Sam Steingold <sds@usa.net>
;; Created: 1998-05-18
;; Keywords: utilities
Richard M. Stallman's avatar
Richard M. Stallman committed
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

;; 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-time-float (num)
Richard M. Stallman's avatar
Richard M. Stallman committed
67 68 69 70 71
  "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))))))

72
(defun midnight-buffer-display-time (&optional buf)
Richard M. Stallman's avatar
Richard M. Stallman committed
73
  "Return the time-stamp of the given buffer, or current buffer, as float."
74
  (with-current-buffer (or buf (current-buffer))
Sam Steingold's avatar
Sam Steingold committed
75
    (when buffer-display-time (float-time buffer-display-time))))
Richard M. Stallman's avatar
Richard M. Stallman committed
76 77 78 79 80 81 82 83 84 85

;;; 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
86
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
87 88 89 90 91 92 93

(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
94
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
95

96
(defcustom clean-buffer-list-kill-regexps nil
Richard M. Stallman's avatar
Richard M. Stallman committed
97 98 99 100
  "*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'.
101
If a member of the list is a cons, its `car' is the regexp and its `cdr' is
Richard M. Stallman's avatar
Richard M. Stallman committed
102 103 104 105
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'."
106
  :type '(repeat (regexp :tag "Regexp matching Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
107
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
108 109

(defcustom clean-buffer-list-kill-buffer-names
110
    '("*Help*" "*Apropos*" "*Man " "*Buffer List*" "*Compile-Log*" "*info*"
111
      "*vc*" "*vc-diff*" "*diff*")
Richard M. Stallman's avatar
Richard M. Stallman committed
112 113 114 115
  "*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'.
116
If a member of the list is a cons, its `car' is the name and its `cdr' is
Richard M. Stallman's avatar
Richard M. Stallman committed
117 118 119 120
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'."
121
  :type '(repeat (string :tag "Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
122
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
123 124 125 126 127 128 129 130

(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."
131
  :type '(repeat (string :tag "Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
132 133
  :group 'midnight)

Richard M. Stallman's avatar
Richard M. Stallman committed
134

135
(defcustom clean-buffer-list-kill-never-regexps '("^ \\*Minibuf-.*\\*$")
Richard M. Stallman's avatar
Richard M. Stallman committed
136 137 138 139 140 141
  "*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."
142
  :type '(repeat (regexp :tag "Regexp matching Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
143
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
144 145 146

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

151 152
(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
153 154 155
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'."
156
  (or (assoc-default name clean-buffer-list-kill-buffer-names 'string=
Richard M. Stallman's avatar
Richard M. Stallman committed
157
                     clean-buffer-list-delay-special)
158
      (assoc-default name clean-buffer-list-kill-regexps 'string-match
Richard M. Stallman's avatar
Richard M. Stallman committed
159 160
                     clean-buffer-list-delay-special)
      (* clean-buffer-list-delay-general 24 60 60)))
Richard M. Stallman's avatar
Richard M. Stallman committed
161

162
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
163
(defun clean-buffer-list ()
164
  "Kill old buffers that have not been displayed recently.
165
The relevant variables are `clean-buffer-list-delay-general',
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167
`clean-buffer-list-delay-special', `clean-buffer-list-kill-buffer-names',
`clean-buffer-list-kill-never-buffer-names',
168 169 170 171
`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
172 173
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
174
  (interactive)
Sam Steingold's avatar
Sam Steingold committed
175
  (let ((tm (float-time)) bts (ts (format-time-string "%Y-%m-%d %T"))
176
        (bufs (buffer-list)) buf delay cbld bn)
177
    (while (setq buf (pop bufs))
178
      (setq bts (midnight-buffer-display-time buf) bn (buffer-name buf)
179 180
            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
181
      (unless (or (midnight-find bn clean-buffer-list-kill-never-regexps
Richard M. Stallman's avatar
Richard M. Stallman committed
182 183 184
                                 'string-match)
                  (midnight-find bn clean-buffer-list-kill-never-buffer-names
                                 'string-equal)
185
                  (get-buffer-process buf)
186 187
                  (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
188 189 190 191 192 193
        (message "[%s] killing `%s'" ts bn)
        (kill-buffer buf)))))

;;; midnight hook

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

196
(defcustom midnight-hook '(clean-buffer-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
197 198 199
  "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
200
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214

(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'.
215 216 217
Sets the first argument SYMB (which must be symbol `midnight-delay')
to its second argument TM."
  (assert (eq symb 'midnight-delay) t
218
          "Invalid argument to `midnight-delay-set': `%s'")
Richard M. Stallman's avatar
Richard M. Stallman committed
219 220 221 222
  (set symb tm)
  (when (timerp midnight-timer) (cancel-timer midnight-timer))
  (setq midnight-timer
        (run-at-time (if (numberp tm) (+ (midnight-next) tm) tm)
223
                     midnight-period 'run-hooks 'midnight-hook)))
Richard M. Stallman's avatar
Richard M. Stallman committed
224 225 226 227 228 229 230 231 232

(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
233
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
234 235 236

(provide 'midnight)

Miles Bader's avatar
Miles Bader committed
237
;;; arch-tag: a5979be9-2890-46a3-ba84-791f0a4a6e80
Richard M. Stallman's avatar
Richard M. Stallman committed
238
;;; midnight.el ends here