657
|
1 ;;; userlock.el --- handle file access contention between multiple users
|
|
2
|
841
|
3 ;; Copyright (C) 1985, 1986 Free Software Foundation, inc.
|
|
4
|
812
|
5 ;; Maintainer: FSF
|
|
6 ;; Keywords: internal
|
807
|
7
|
36
|
8 ;; This file is part of GNU Emacs.
|
|
9
|
|
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
11 ;; it under the terms of the GNU General Public License as published by
|
807
|
12 ;; the Free Software Foundation; either version 2, or (at your option)
|
36
|
13 ;; any later version.
|
|
14
|
|
15 ;; GNU Emacs is distributed in the hope that it will be useful,
|
|
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
18 ;; GNU General Public License for more details.
|
|
19
|
|
20 ;; You should have received a copy of the GNU General Public License
|
14169
|
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
23 ;; Boston, MA 02111-1307, USA.
|
36
|
24
|
807
|
25 ;;; Commentary:
|
36
|
26
|
807
|
27 ;; This file is autoloaded to handle certain conditions
|
36
|
28 ;; detected by the file-locking code within Emacs.
|
|
29 ;; The two entry points are `ask-user-about-lock' and
|
|
30 ;; `ask-user-about-supersession-threat'.
|
|
31
|
807
|
32 ;;; Code:
|
36
|
33
|
|
34 (put 'file-locked 'error-conditions '(file-locked file-error error))
|
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
35 (put 'file-locked 'error-message "File is locked")
|
36
|
36
|
258
|
37 ;;;###autoload
|
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
38 (defun ask-user-about-lock (file opponent)
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
39 "Ask user what to do when he wants to edit FILE but it is locked by OPPONENT.
|
36
|
40 This function has a choice of three things to do:
|
26281
|
41 do (signal 'file-locked (list FILE OPPONENT))
|
36
|
42 to refrain from editing the file
|
|
43 return t (grab the lock on the file)
|
|
44 return nil (edit the file even though it is locked).
|
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
45 You can redefine this function to choose among those three alternatives
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
46 in any way you like."
|
36
|
47 (discard-input)
|
|
48 (save-window-excursion
|
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
49 (let (answer short-opponent short-file)
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
50 (setq short-file
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
51 (if (> (length file) 22)
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
52 (concat "..." (substring file (- (length file) 22)))
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
53 file))
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
54 (setq short-opponent
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
55 (if (> (length opponent) 25)
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
56 (save-match-data
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
57 (string-match " (pid [0-9]+)" opponent)
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
58 (concat (substring opponent 0 13) "..."
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
59 (match-string 0 opponent)))
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
60 opponent))
|
36
|
61 (while (null answer)
|
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
62 (message "%s locked by %s: (s, q, p, ?)? "
|
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
63 short-file short-opponent)
|
36
|
64 (let ((tem (let ((inhibit-quit t)
|
|
65 (cursor-in-echo-area t))
|
|
66 (prog1 (downcase (read-char))
|
|
67 (setq quit-flag nil)))))
|
|
68 (if (= tem help-char)
|
|
69 (ask-user-about-lock-help)
|
|
70 (setq answer (assoc tem '((?s . t)
|
|
71 (?q . yield)
|
|
72 (?\C-g . yield)
|
|
73 (?p . nil)
|
|
74 (?? . help))))
|
|
75 (cond ((null answer)
|
|
76 (beep)
|
|
77 (message "Please type q, s, or p; or ? for help")
|
|
78 (sit-for 3))
|
|
79 ((eq (cdr answer) 'help)
|
|
80 (ask-user-about-lock-help)
|
|
81 (setq answer nil))
|
|
82 ((eq (cdr answer) 'yield)
|
19676
2f47e06ef5a3
(ask-user-about-lock): Abbreviate file name and locking user's name.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
83 (signal 'file-locked (list file opponent)))))))
|
36
|
84 (cdr answer))))
|
|
85
|
|
86 (defun ask-user-about-lock-help ()
|
|
87 (with-output-to-temp-buffer "*Help*"
|
|
88 (princ "It has been detected that you want to modify a file that someone else has
|
|
89 already started modifying in EMACS.
|
|
90
|
|
91 You can <s>teal the file; The other user becomes the
|
|
92 intruder if (s)he ever unmodifies the file and then changes it again.
|
|
93 You can <p>roceed; you edit at your own (and the other user's) risk.
|
9843
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
94 You can <q>uit; don't modify this file.")
|
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
95 (save-excursion
|
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
96 (set-buffer standard-output)
|
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
97 (help-mode))))
|
36
|
98
|
|
99 (put
|
|
100 'file-supersession 'error-conditions '(file-supersession file-error error))
|
|
101
|
258
|
102 ;;;###autoload
|
36
|
103 (defun ask-user-about-supersession-threat (fn)
|
|
104 "Ask a user who is about to modify an obsolete buffer what to do.
|
|
105 This function has two choices: it can return, in which case the modification
|
|
106 of the buffer will proceed, or it can (signal 'file-supersession (file)),
|
|
107 in which case the proposed buffer modification will not be made.
|
|
108
|
|
109 You can rewrite this to use any criterion you like to choose which one to do.
|
|
110 The buffer in question is current when this function is called."
|
|
111 (discard-input)
|
|
112 (save-window-excursion
|
|
113 (let (answer)
|
|
114 (while (null answer)
|
15571
|
115 (message "%s changed on disk; really edit the buffer? (y, n, r or C-h) "
|
4566
14d8646c61c4
(ask-user-about-supersession-threat): Mention file name when asking question.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
116 (file-name-nondirectory fn))
|
36
|
117 (let ((tem (downcase (let ((cursor-in-echo-area t))
|
47651
0c66d7531f3e
(ask-user-about-supersession-threat): Don't abort when the user hits mouse-2.
Stefan Monnier <monnier@iro.umontreal.ca>
diff
changeset
|
118 (read-char-exclusive)))))
|
36
|
119 (setq answer
|
|
120 (if (= tem help-char)
|
|
121 'help
|
|
122 (cdr (assoc tem '((?n . yield)
|
|
123 (?\C-g . yield)
|
|
124 (?y . proceed)
|
15571
|
125 (?r . revert)
|
36
|
126 (?? . help))))))
|
|
127 (cond ((null answer)
|
|
128 (beep)
|
15571
|
129 (message "Please type y, n or r; or ? for help")
|
36
|
130 (sit-for 3))
|
|
131 ((eq answer 'help)
|
|
132 (ask-user-about-supersession-help)
|
|
133 (setq answer nil))
|
15571
|
134 ((eq answer 'revert)
|
|
135 (revert-buffer nil (not (buffer-modified-p)))
|
|
136 ; ask confirmation iff buffer modified
|
|
137 (signal 'file-supersession
|
|
138 (list "File reverted" fn)))
|
36
|
139 ((eq answer 'yield)
|
|
140 (signal 'file-supersession
|
|
141 (list "File changed on disk" fn))))))
|
|
142 (message
|
|
143 "File on disk now will become a backup file if you save these changes.")
|
|
144 (setq buffer-backed-up nil))))
|
|
145
|
|
146 (defun ask-user-about-supersession-help ()
|
|
147 (with-output-to-temp-buffer "*Help*"
|
|
148 (princ "You want to modify a buffer whose disk file has changed
|
|
149 since you last read it in or saved it with this buffer.
|
|
150
|
|
151 If you say `y' to go ahead and modify this buffer,
|
|
152 you risk ruining the work of whoever rewrote the file.
|
15571
|
153 If you say `r' to revert, the contents of the buffer are refreshed
|
|
154 from the file on disk.
|
36
|
155 If you say `n', the change you started to make will be aborted.
|
|
156
|
|
157 Usually, you should type `n' and then `M-x revert-buffer',
|
9843
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
158 to get the latest version of the file, then make the change again.")
|
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
159 (save-excursion
|
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
160 (set-buffer standard-output)
|
f96b7683e3c5
(ask-user-about-lock-help, ask-user-about-supersession-help): Set help-mode in *Help* buffer.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
161 (help-mode))))
|
36
|
162
|
52401
|
163 ;;; arch-tag: a61c5b60-e1c8-44fd-894a-c617f4dfc639
|
657
|
164 ;;; userlock.el ends here
|