midnight.el 9.66 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

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1998, 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2006, 2007, 2008 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5

6 7 8 9
;; 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
10 11 12

;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
17 18 19 20 21 22 23

;; 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
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
25 26 27 28 29 30 31 32 33 34 35 36 37

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

38 39
;;; Code:

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

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

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

50 51 52 53 54
(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.")

55
(defcustom midnight-mode nil
56 57 58 59 60 61
  "*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
62
  :initialize 'custom-initialize-default
63 64 65 66 67
  :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
68 69
;;; time conversion

70
(defun midnight-time-float (num)
Richard M. Stallman's avatar
Richard M. Stallman committed
71 72 73 74 75
  "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))))))

76 77 78
(defun midnight-buffer-display-time (&optional buffer)
  "Return the time-stamp of BUFFER, or current buffer, as float."
  (with-current-buffer (or buffer (current-buffer))
Sam Steingold's avatar
Sam Steingold committed
79
    (when buffer-display-time (float-time buffer-display-time))))
Richard M. Stallman's avatar
Richard M. Stallman committed
80 81 82 83 84 85 86 87 88 89

;;; 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
90
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
91 92 93 94 95 96 97

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

100
(defcustom clean-buffer-list-kill-regexps nil
Richard M. Stallman's avatar
Richard M. Stallman committed
101 102 103 104
  "*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'.
105
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
106 107 108 109
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'."
110
  :type '(repeat (regexp :tag "Regexp matching Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
111
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
112 113

(defcustom clean-buffer-list-kill-buffer-names
114
    '("*Help*" "*Apropos*" "*Man " "*Buffer List*" "*Compile-Log*" "*info*"
115
      "*vc*" "*vc-diff*" "*diff*")
Richard M. Stallman's avatar
Richard M. Stallman committed
116 117 118 119
  "*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'.
120
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
121 122 123 124
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'."
125
  :type '(repeat (string :tag "Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
126
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
127 128

(defcustom clean-buffer-list-kill-never-buffer-names
129
    '("*scratch*" "*Messages*" "*server*")
Richard M. Stallman's avatar
Richard M. Stallman committed
130 131 132 133 134
  "*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."
135
  :type '(repeat (string :tag "Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
136 137
  :group 'midnight)

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

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

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

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

;;; midnight hook

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

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

(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)))

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

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

(provide 'midnight)

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