1 ;;; tramp-cache.el --- file information caching for Tramp
3 ;; Copyright (C) 2000, 2005-2011 Free Software Foundation, Inc.
5 ;; Author: Daniel Pittman <daniel@inanna.danann.net>
6 ;; Michael Albinus <michael.albinus@gmx.de>
7 ;; Keywords: comm, processes
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; 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/>.
27 ;; An implementation of information caching for remote files.
29 ;; Each connection, identified by a vector [method user host
30 ;; localname] or by a process, has a unique cache. We distinguish 3
31 ;; kind of caches, depending on the key:
33 ;; - localname is NIL. This are reusable properties. Examples:
34 ;; "remote-shell" identifies the POSIX shell to be called on the
35 ;; remote host, or "perl" is the command to be called on the remote
36 ;; host when starting a Perl script. These properties are saved in
37 ;; the file `tramp-persistency-file-name'.
39 ;; - localname is a string. This are temporary properties, which are
40 ;; related to the file localname is referring to. Examples:
41 ;; "file-exists-p" is t or nile, depending on the file existence, or
42 ;; "file-attributes" caches the result of the function
45 ;; - The key is a process. This are temporary properties related to
46 ;; an open connection. Examples: "scripts" keeps shell script
47 ;; definitions already sent to the remote shell, "last-cmd-time" is
48 ;; the time stamp a command has been sent to the remote process.
53 (autoload 'time-stamp-string
"time-stamp")
58 (defvar tramp-cache-data
(make-hash-table :test
'equal
)
59 "Hash table for remote files properties.")
61 (defcustom tramp-persistency-file-name
64 ((and (fboundp 'locate-user-emacs-file
))
65 (expand-file-name (tramp-compat-funcall 'locate-user-emacs-file
"tramp")))
66 ((and (boundp 'user-emacs-directory
)
67 (stringp (symbol-value 'user-emacs-directory
))
68 (file-directory-p (symbol-value 'user-emacs-directory
)))
69 (expand-file-name "tramp" (symbol-value 'user-emacs-directory
)))
70 ((and (not (featurep 'xemacs
)) (file-directory-p "~/.emacs.d/"))
73 ((and (boundp 'user-init-directory
)
74 (stringp (symbol-value 'user-init-directory
))
75 (file-directory-p (symbol-value 'user-init-directory
)))
76 (expand-file-name "tramp" (symbol-value 'user-init-directory
)))
77 ((and (featurep 'xemacs
) (file-directory-p "~/.xemacs/"))
79 ;; For users without `~/.emacs.d/' or `~/.xemacs/'.
81 "File which keeps connection history for Tramp connections."
85 (defvar tramp-cache-data-changed nil
86 "Whether persistent cache data have been changed.")
89 (defun tramp-get-file-property (vec file property default
)
90 "Get the PROPERTY of FILE from the cache context of VEC.
91 Returns DEFAULT if not set."
93 (setq vec
(copy-sequence vec
))
94 (aset vec
3 (tramp-run-real-handler 'directory-file-name
(list file
)))
95 (let* ((hash (or (gethash vec tramp-cache-data
)
96 (puthash vec
(make-hash-table :test
'equal
)
98 (value (when (hash-table-p hash
) (gethash property hash
))))
100 ;; We take the value only if there is any, and
101 ;; `remote-file-name-inhibit-cache' indicates that it is still
102 ;; valid. Otherwise, DEFAULT is set.
104 (or (null remote-file-name-inhibit-cache
)
105 (and (integerp remote-file-name-inhibit-cache
)
107 (tramp-time-diff (current-time) (car value
))
108 remote-file-name-inhibit-cache
))
109 (and (consp remote-file-name-inhibit-cache
)
111 remote-file-name-inhibit-cache
(car value
)))))
112 (setq value
(cdr value
))
113 (setq value default
))
115 (tramp-message vec
8 "%s %s %s" file property value
)
116 (when (>= tramp-verbose
10)
117 (let* ((var (intern (concat "tramp-cache-get-count-" property
)))
118 (val (or (ignore-errors (symbol-value var
)) 0)))
123 (defun tramp-set-file-property (vec file property value
)
124 "Set the PROPERTY of FILE to VALUE, in the cache context of VEC.
127 (setq vec
(copy-sequence vec
))
128 (aset vec
3 (tramp-run-real-handler 'directory-file-name
(list file
)))
129 (let ((hash (or (gethash vec tramp-cache-data
)
130 (puthash vec
(make-hash-table :test
'equal
)
132 ;; We put the timestamp there.
133 (puthash property
(cons (current-time) value
) hash
)
134 (tramp-message vec
8 "%s %s %s" file property value
)
135 (when (>= tramp-verbose
10)
136 (let* ((var (intern (concat "tramp-cache-set-count-" property
)))
137 (val (or (ignore-errors (symbol-value var
)) 0)))
142 (defmacro with-file-property
(vec file property
&rest body
)
143 "Check in Tramp cache for PROPERTY, otherwise execute BODY and set cache.
144 FILE must be a local file name on a connection identified via VEC."
145 `(if (file-name-absolute-p ,file
)
146 (let ((value (tramp-get-file-property ,vec
,file
,property
'undef
)))
147 (when (eq value
'undef
)
148 ;; We cannot pass @body as parameter to
149 ;; `tramp-set-file-property' because it mangles our
151 (setq value
(progn ,@body
))
152 (tramp-set-file-property ,vec
,file
,property value
))
157 (put 'with-file-property
'lisp-indent-function
3)
158 (put 'with-file-property
'edebug-form-spec t
)
159 (tramp-compat-font-lock-add-keywords
160 'emacs-lisp-mode
'("\\<with-file-property\\>"))
163 (defun tramp-flush-file-property (vec file
)
164 "Remove all properties of FILE in the cache context of VEC."
166 (setq vec
(copy-sequence vec
))
167 (aset vec
3 (tramp-run-real-handler 'directory-file-name
(list file
)))
168 (tramp-message vec
8 "%s" file
)
169 (remhash vec tramp-cache-data
))
172 (defun tramp-flush-directory-property (vec directory
)
173 "Remove all properties of DIRECTORY in the cache context of VEC.
174 Remove also properties of all files in subdirectories."
175 (let ((directory (tramp-run-real-handler
176 'directory-file-name
(list directory
))))
177 (tramp-message vec
8 "%s" directory
)
180 (when (and (stringp (tramp-file-name-localname key
))
181 (string-match directory
(tramp-file-name-localname key
)))
182 (remhash key tramp-cache-data
)))
185 ;; Reverting or killing a buffer should also flush file properties.
186 ;; They could have been changed outside Tramp. In eshell, "ls" would
187 ;; not show proper directory contents when a file has been copied or
189 (defun tramp-flush-file-function ()
190 "Flush all Tramp cache properties from `buffer-file-name'."
191 (let ((bfn (if (stringp (buffer-file-name))
194 (when (tramp-tramp-file-p bfn
)
195 (with-parsed-tramp-file-name bfn nil
196 (tramp-flush-file-property v localname
)))))
198 (add-hook 'before-revert-hook
'tramp-flush-file-function
)
199 (add-hook 'eshell-pre-command-hook
'tramp-flush-file-function
)
200 (add-hook 'kill-buffer-hook
'tramp-flush-file-function
)
201 (add-hook 'tramp-cache-unload-hook
203 (remove-hook 'before-revert-hook
204 'tramp-flush-file-function
)
205 (remove-hook 'eshell-pre-command-hook
206 'tramp-flush-file-function
)
207 (remove-hook 'kill-buffer-hook
208 'tramp-flush-file-function
)))
213 (defun tramp-get-connection-property (key property default
)
214 "Get the named PROPERTY for the connection.
215 KEY identifies the connection, it is either a process or a vector.
216 If the value is not set for the connection, returns DEFAULT."
217 ;; Unify key by removing localname from vector. Work with a copy in
218 ;; order to avoid side effects.
220 (setq key
(copy-sequence key
))
222 (let* ((hash (gethash key tramp-cache-data
))
223 (value (if (hash-table-p hash
)
224 (gethash property hash default
)
226 (tramp-message key
7 "%s %s" property value
)
230 (defun tramp-set-connection-property (key property value
)
231 "Set the named PROPERTY of a connection to VALUE.
232 KEY identifies the connection, it is either a process or a vector.
233 PROPERTY is set persistent when KEY is a vector."
234 ;; Unify key by removing localname from vector. Work with a copy in
235 ;; order to avoid side effects.
237 (setq key
(copy-sequence key
))
239 (let ((hash (or (gethash key tramp-cache-data
)
240 (puthash key
(make-hash-table :test
'equal
)
242 (puthash property value hash
)
243 (setq tramp-cache-data-changed t
)
244 (tramp-message key
7 "%s %s" property value
)
248 (defmacro with-connection-property
(key property
&rest body
)
249 "Check in Tramp for property PROPERTY, otherwise executes BODY and set."
250 `(let ((value (tramp-get-connection-property ,key
,property
'undef
)))
251 (when (eq value
'undef
)
252 ;; We cannot pass ,@body as parameter to
253 ;; `tramp-set-connection-property' because it mangles our debug
255 (setq value
(progn ,@body
))
256 (tramp-set-connection-property ,key
,property value
))
260 (put 'with-connection-property
'lisp-indent-function
2)
261 (put 'with-connection-property
'edebug-form-spec t
)
262 (tramp-compat-font-lock-add-keywords
263 'emacs-lisp-mode
'("\\<with-connection-property\\>"))
266 (defun tramp-flush-connection-property (key)
267 "Remove all properties identified by KEY.
268 KEY identifies the connection, it is either a process or a vector."
269 ;; Unify key by removing localname from vector. Work with a copy in
270 ;; order to avoid side effects.
272 (setq key
(copy-sequence key
))
276 (let ((hash (gethash key tramp-cache-data
))
278 (if (hash-table-p hash
)
280 (lambda (x y
) (add-to-list 'properties x
'append
))
281 (gethash key tramp-cache-data
)))
283 (setq tramp-cache-data-changed t
)
284 (remhash key tramp-cache-data
))
287 (defun tramp-cache-print (table)
288 "Print hash table TABLE."
289 (when (hash-table-p table
)
296 (prin1-to-string (prin1-to-string key
))
297 (prin1-to-string key
))
298 (if (hash-table-p value
)
299 (tramp-cache-print value
)
301 (prin1-to-string (prin1-to-string value
))
302 (prin1-to-string value
))))))
303 (setq result
(if result
(concat result
" " tmp
) tmp
))))
308 (defun tramp-list-connections ()
309 "Return a list of all known connection vectors according to `tramp-cache'."
313 (when (and (vectorp key
) (null (aref key
3)))
314 (add-to-list 'result key
)))
318 (defun tramp-dump-connection-properties ()
319 "Write persistent connection properties into file `tramp-persistency-file-name'."
320 ;; We shouldn't fail, otherwise (X)Emacs might not be able to be closed.
322 (when (and (hash-table-p tramp-cache-data
)
323 (not (zerop (hash-table-count tramp-cache-data
)))
324 tramp-cache-data-changed
325 (stringp tramp-persistency-file-name
))
326 (let ((cache (copy-hash-table tramp-cache-data
)))
327 ;; Remove temporary data.
330 (if (and (vectorp key
) (not (tramp-file-name-localname key
)))
332 (remhash "process-name" value
)
333 (remhash "process-buffer" value
)
334 (remhash "first-password-request" value
))
335 (remhash key cache
)))
340 ";; -*- emacs-lisp -*-"
341 ;; `time-stamp-string' might not exist in all (X)Emacs flavors.
346 (time-stamp-string "%02y/%02m/%02d %02H:%02M:%02S")
347 tramp-persistency-file-name
))
349 ";; Tramp connection history. Don't change this file.\n"
350 ";; You can delete it, forcing Tramp to reapply the checks.\n\n"
351 (with-output-to-string
352 (pp (read (format "(%s)" (tramp-cache-print cache
))))))
354 (point-min) (point-max) tramp-persistency-file-name
))))))
356 (unless noninteractive
357 (add-hook 'kill-emacs-hook
'tramp-dump-connection-properties
))
358 (add-hook 'tramp-cache-unload-hook
360 (remove-hook 'kill-emacs-hook
361 'tramp-dump-connection-properties
)))
364 (defun tramp-parse-connection-properties (method)
365 "Return a list of (user host) tuples allowed to access for METHOD.
366 This function is added always in `tramp-get-completion-function'
367 for all methods. Resulting data are derived from connection history."
371 (if (and (vectorp key
)
372 (string-equal method
(tramp-file-name-method key
))
373 (not (tramp-file-name-localname key
)))
374 (push (list (tramp-file-name-user key
)
375 (tramp-file-name-host key
))
380 ;; Read persistent connection history.
381 (when (and (stringp tramp-persistency-file-name
)
382 (zerop (hash-table-count tramp-cache-data
))
383 ;; When "emacs -Q" has been called, both variables are nil.
384 ;; We do not load the persistency file then, in order to
385 ;; have a clean test environment.
386 (or init-file-user site-run-file
))
389 (insert-file-contents tramp-persistency-file-name
)
390 (let ((list (read (current-buffer)))
392 (while (setq element
(pop list
))
393 (setq key
(pop element
))
394 (while (setq item
(pop element
))
395 (tramp-set-connection-property key
(pop item
) (car item
)))))
396 (setq tramp-cache-data-changed nil
))
398 ;; Most likely because the file doesn't exist yet. No message.
399 (clrhash tramp-cache-data
))
401 ;; File is corrupted.
402 (message "Tramp persistency file '%s' is corrupted: %s"
403 tramp-persistency-file-name
(error-message-string err
))
404 (clrhash tramp-cache-data
))))
406 (add-hook 'tramp-unload-hook
408 (unload-feature 'tramp-cache
'force
)))
410 (provide 'tramp-cache
)
412 ;;; tramp-cache.el ends here