midnight.el 9.58 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, 2001-2011 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

Sam Steingold's avatar
Sam Steingold committed
5 6
;; Author: Sam Steingold <sds@gnu.org>
;; Maintainer: Sam Steingold <sds@gnu.org>
7 8
;; Created: 1998-05-18
;; Keywords: utilities
Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; 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
16 17 18 19 20 21 22

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

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

37 38
;;; Code:

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

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

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

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

54
(defcustom midnight-mode nil
Lute Kamstra's avatar
Lute Kamstra committed
55
  "Non-nil means run `midnight-hook' at midnight.
56 57 58 59 60
Setting this variable outside customize has no effect;
call `cancel-timer' or `timer-activate' on `midnight-timer' instead."
  :type 'boolean
  :group 'midnight
  :require 'midnight
61
  :initialize 'custom-initialize-default
62 63 64 65 66
  :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
67 68
;;; time conversion

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

75 76 77
(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
78
    (when buffer-display-time (float-time buffer-display-time))))
Richard M. Stallman's avatar
Richard M. Stallman committed
79 80 81 82

;;; clean-buffer-list stuff

(defcustom clean-buffer-list-delay-general 3
Lute Kamstra's avatar
Lute Kamstra committed
83
  "The number of days before any buffer becomes eligible for autokilling.
Richard M. Stallman's avatar
Richard M. Stallman committed
84 85 86 87 88
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
89
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91

(defcustom clean-buffer-list-delay-special 3600
Lute Kamstra's avatar
Lute Kamstra committed
92
  "The number of seconds before some buffers become eligible for autokilling.
Richard M. Stallman's avatar
Richard M. Stallman committed
93 94 95 96
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
97
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
98

99
(defcustom clean-buffer-list-kill-regexps nil
Lute Kamstra's avatar
Lute Kamstra committed
100
  "List of regexps saying which buffers will be killed at midnight.
Richard M. Stallman's avatar
Richard M. Stallman committed
101 102 103
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'.
104
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
105 106 107 108
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'."
109
  :type '(repeat (regexp :tag "Regexp matching Buffer Name"))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
110
  :group 'midnight)
Richard M. Stallman's avatar
Richard M. Stallman committed
111 112

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

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

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

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

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

164
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
165
(defun clean-buffer-list ()
166
  "Kill old buffers that have not been displayed recently.
167
The relevant variables are `clean-buffer-list-delay-general',
Richard M. Stallman's avatar
Richard M. Stallman committed
168 169
`clean-buffer-list-delay-special', `clean-buffer-list-kill-buffer-names',
`clean-buffer-list-kill-never-buffer-names',
170 171 172 173
`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
174 175
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
176
  (interactive)
Sam Steingold's avatar
Sam Steingold committed
177
  (let ((tm (float-time)) bts (ts (format-time-string "%Y-%m-%d %T"))
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
        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
193 194 195 196

;;; midnight hook

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

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

(defun midnight-next ()
  "Return the number of seconds till the next midnight."
Sam Steingold's avatar
Sam Steingold committed
207
  (multiple-value-bind (sec min hrs)
Deepak Goel's avatar
Deepak Goel committed
208
      (values-list (decode-time))
Richard M. Stallman's avatar
Richard M. Stallman committed
209 210 211 212 213
    (- (* 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

(defcustom midnight-delay 3600
Lute Kamstra's avatar
Lute Kamstra committed
225
  "The number of seconds after the midnight when the `midnight-timer' is run.
Richard M. Stallman's avatar
Richard M. Stallman committed
226 227 228 229 230 231
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 236

(provide 'midnight)

;;; midnight.el ends here