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

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1998, 2001-2018 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 <https://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:

39
(require 'cl-lib)
40

Richard M. Stallman's avatar
Richard M. Stallman committed
41 42
(defgroup midnight nil
  "Run something every day at midnight."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
43 44
  :group 'calendar
  :version "20.3")
Richard M. Stallman's avatar
Richard M. Stallman committed
45

46 47 48 49 50
(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.")

51 52 53 54 55
;;;###autoload
(define-minor-mode midnight-mode
  "Non-nil means run `midnight-hook' at midnight."
  :global t
  :initialize #'custom-initialize-default
56 57 58 59 60 61
  ;; Disable first, since the ':initialize' function above already
  ;; starts the timer when the mode is turned on for the first time,
  ;; via setting 'midnight-delay', which calls 'midnight-delay-set',
  ;; which starts the timer.
  (when (timerp midnight-timer) (cancel-timer midnight-timer))
  (if midnight-mode (timer-activate midnight-timer)))
62

Richard M. Stallman's avatar
Richard M. Stallman committed
63 64 65
;;; clean-buffer-list stuff

(defcustom clean-buffer-list-delay-general 3
Lute Kamstra's avatar
Lute Kamstra committed
66
  "The number of days before any buffer becomes eligible for autokilling.
Simen Heggestøyl's avatar
Simen Heggestøyl committed
67
The autokilling is done by `clean-buffer-list' when it is in `midnight-hook'.
Richard M. Stallman's avatar
Richard M. Stallman committed
68 69 70
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."
71
  :type 'integer)
Richard M. Stallman's avatar
Richard M. Stallman committed
72 73

(defcustom clean-buffer-list-delay-special 3600
Lute Kamstra's avatar
Lute Kamstra committed
74
  "The number of seconds before some buffers become eligible for autokilling.
Richard M. Stallman's avatar
Richard M. Stallman committed
75 76 77
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."
78
  :type 'integer)
Richard M. Stallman's avatar
Richard M. Stallman committed
79

80
(defcustom clean-buffer-list-kill-regexps '("\\`\\*Man ")
Lute Kamstra's avatar
Lute Kamstra committed
81
  "List of regexps saying which buffers will be killed at midnight.
Richard M. Stallman's avatar
Richard M. Stallman committed
82 83
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
Simen Heggestøyl's avatar
Simen Heggestøyl committed
84
`clean-buffer-list' when it is in `midnight-hook'.
85
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
86 87 88
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
89 90 91 92 93 94 95 96
`clean-buffer-list-kill-never-buffer-names'.

Each element can also be a function instead of a regexp, in which case
it takes a single argument (a buffer name) and should return non-nil
if the buffer should be killed by `clean-buffer-list'."
  :type '(repeat
          (choice (regexp :tag "Regexp matching Buffer Name")
                  (function :tag "Predicate function"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
97 98

(defcustom clean-buffer-list-kill-buffer-names
99
    '("*Help*" "*Apropos*" "*Buffer List*" "*Compile-Log*" "*info*"
100
      "*vc*" "*vc-diff*" "*diff*")
Lute Kamstra's avatar
Lute Kamstra committed
101
  "List of strings saying which buffers will be killed at midnight.
Richard M. Stallman's avatar
Richard M. Stallman committed
102 103
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'
Simen Heggestøyl's avatar
Simen Heggestøyl committed
104
when it is in `midnight-hook'.
105
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
106 107 108 109
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'."
110
  :type '(repeat (string :tag "Buffer Name")))
Richard M. Stallman's avatar
Richard M. Stallman committed
111 112

(defcustom clean-buffer-list-kill-never-buffer-names
113
    '("*scratch*" "*Messages*")
Lute Kamstra's avatar
Lute Kamstra committed
114
  "List of buffer names which will never be killed by `clean-buffer-list'.
Richard M. Stallman's avatar
Richard M. Stallman committed
115 116 117 118
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."
119
  :type '(repeat (string :tag "Buffer Name")))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
120

121
(defcustom clean-buffer-list-kill-never-regexps '("\\` \\*Minibuf-.*\\*\\'")
Lute Kamstra's avatar
Lute Kamstra committed
122
  "List of regexp saying which buffers will never be killed at midnight.
Richard M. Stallman's avatar
Richard M. Stallman committed
123 124 125 126
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
127
two lists will NOT be killed if it also matches anything in this list.
Richard M. Stallman's avatar
Richard M. Stallman committed
128

129 130 131 132 133 134
Each element can also be a function instead of a regexp, in which case
it takes a single argument (a buffer name) and should return non-nil
if the buffer should never be killed by `clean-buffer-list'."
  :type '(repeat
          (choice (regexp :tag "Regexp matching Buffer Name")
                  (function :tag "Predicate function"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
135

136 137
(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
138 139 140
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'."
141
  (or (assoc-default name clean-buffer-list-kill-buffer-names #'string=
Richard M. Stallman's avatar
Richard M. Stallman committed
142
                     clean-buffer-list-delay-special)
143 144 145 146
      (assoc-default name clean-buffer-list-kill-regexps
                     (lambda (re str)
                       (if (functionp re)
                           (funcall re str) (string-match re str)))
Richard M. Stallman's avatar
Richard M. Stallman committed
147 148
                     clean-buffer-list-delay-special)
      (* clean-buffer-list-delay-general 24 60 60)))
Richard M. Stallman's avatar
Richard M. Stallman committed
149

150
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
151
(defun clean-buffer-list ()
152
  "Kill old buffers that have not been displayed recently.
153
The relevant variables are `clean-buffer-list-delay-general',
Richard M. Stallman's avatar
Richard M. Stallman committed
154 155
`clean-buffer-list-delay-special', `clean-buffer-list-kill-buffer-names',
`clean-buffer-list-kill-never-buffer-names',
156 157 158 159
`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
160 161
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
162
  (interactive)
163
  (let ((tm (current-time)) bts (ts (format-time-string "%Y-%m-%d %T"))
164 165 166
        delay cbld bn)
    (dolist (buf (buffer-list))
      (when (buffer-live-p buf)
167 168 169 170 171 172
        (setq bts (with-current-buffer buf buffer-display-time)
              bn (buffer-name buf)
              delay (if bts (round (float-time (time-subtract tm bts))) 0)
              cbld (clean-buffer-list-delay bn))
        (message "[%s] `%s' [%s %d]" ts bn delay cbld)
        (unless (or (cl-find bn clean-buffer-list-kill-never-regexps
173 174 175 176
                             :test (lambda (bn re)
                                     (if (functionp re)
                                         (funcall re bn)
                                       (string-match re bn))))
177
                    (cl-find bn clean-buffer-list-kill-never-buffer-names
178
                             :test #'string-equal)
179 180 181 182 183 184
                    (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
185 186 187 188

;;; midnight hook

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

191
(defcustom midnight-hook '(clean-buffer-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
192 193
  "The hook run `midnight-delay' seconds after midnight every day.
The default value is `clean-buffer-list'."
194
  :type 'hook)
Richard M. Stallman's avatar
Richard M. Stallman committed
195 196 197

(defun midnight-next ()
  "Return the number of seconds till the next midnight."
198
  (pcase-let ((`(,sec ,min ,hrs) (decode-time)))
Richard M. Stallman's avatar
Richard M. Stallman committed
199 200 201 202 203
    (- (* 24 60 60) (* 60 60 hrs) (* 60 min) sec)))

;;;###autoload
(defun midnight-delay-set (symb tm)
  "Modify `midnight-timer' according to `midnight-delay'.
204 205
Sets the first argument SYMB (which must be symbol `midnight-delay')
to its second argument TM."
206 207
  (cl-assert (eq symb 'midnight-delay) t
             "Invalid argument to `midnight-delay-set': `%s'")
Richard M. Stallman's avatar
Richard M. Stallman committed
208 209 210 211
  (set symb tm)
  (when (timerp midnight-timer) (cancel-timer midnight-timer))
  (setq midnight-timer
        (run-at-time (if (numberp tm) (+ (midnight-next) tm) tm)
212
                     midnight-period #'run-hooks 'midnight-hook)))
Richard M. Stallman's avatar
Richard M. Stallman committed
213 214

(defcustom midnight-delay 3600
Lute Kamstra's avatar
Lute Kamstra committed
215
  "The number of seconds after the midnight when the `midnight-timer' is run.
Richard M. Stallman's avatar
Richard M. Stallman committed
216 217 218 219
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'."
220
  :type '(choice integer string)
221
  :set #'midnight-delay-set)
Richard M. Stallman's avatar
Richard M. Stallman committed
222 223 224 225

(provide 'midnight)

;;; midnight.el ends here