;;; tramp-cache.el --- file information caching for Tramp
-;; Copyright (C) 2000, 2005, 2006, 2007 by Free Software Foundation, Inc.
+;; Copyright (C) 2000, 2005, 2006, 2007, 2008,
+;; 2009 Free Software Foundation, Inc.
;; Author: Daniel Pittman <daniel@inanna.danann.net>
;; Michael Albinus <michael.albinus@gmx.de>
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, see
-;; <http://www.gnu.org/licenses/>.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
(autoload 'tramp-file-name-user "tramp")
(autoload 'tramp-file-name-host "tramp")
(autoload 'tramp-file-name-localname "tramp")
+ (autoload 'tramp-run-real-handler "tramp")
+ (autoload 'tramp-time-less-p "tramp")
(autoload 'time-stamp-string "time-stamp"))
;;; -- Cache --
(defvar tramp-cache-data (make-hash-table :test 'equal)
"Hash table for remote files properties.")
+(defvar tramp-cache-inhibit-cache nil
+ "Inhibit cache read access, when `t'.
+`nil' means to accept cache entries unconditionally. If the
+value is a timestamp (as returned by `current-time'), cache
+entries are not used when they have been written before this
+time.")
+
(defcustom tramp-persistency-file-name
(cond
;; GNU Emacs.
:group 'tramp
:type 'file)
+(defvar tramp-cache-data-changed nil
+ "Whether persistent cache data have been changed.")
+
(defun tramp-get-file-property (vec file property default)
"Get the PROPERTY of FILE from the cache context of VEC.
Returns DEFAULT if not set."
;; Unify localname.
(setq vec (copy-sequence vec))
- (aset vec 3 (directory-file-name file))
+ (aset vec 3 (tramp-run-real-handler 'directory-file-name (list file)))
(let* ((hash (or (gethash vec tramp-cache-data)
(puthash vec (make-hash-table :test 'equal)
tramp-cache-data)))
- (value (if (hash-table-p hash)
- (gethash property hash default)
- default)))
+ (value (when (hash-table-p hash) (gethash property hash))))
+ (if
+ ;; We take the value only if there is any, and
+ ;; `tramp-cache-inhibit-cache' indicates that it is still
+ ;; valid. Otherwise, DEFAULT is set.
+ (and (consp value)
+ (or (null tramp-cache-inhibit-cache)
+ (and (consp tramp-cache-inhibit-cache)
+ (tramp-time-less-p
+ tramp-cache-inhibit-cache (car value)))))
+ (setq value (cdr value))
+ (setq value default))
+
+ (if (consp tramp-cache-inhibit-cache)
+ (tramp-message vec 1 "%s %s %s" file property value))
(tramp-message vec 8 "%s %s %s" file property value)
value))
Returns VALUE."
;; Unify localname.
(setq vec (copy-sequence vec))
- (aset vec 3 (directory-file-name file))
+ (aset vec 3 (tramp-run-real-handler 'directory-file-name (list file)))
(let ((hash (or (gethash vec tramp-cache-data)
(puthash vec (make-hash-table :test 'equal)
tramp-cache-data))))
- (puthash property value hash)
+ ;; We put the timestamp there.
+ (puthash property (cons (current-time) value) hash)
(tramp-message vec 8 "%s %s %s" file property value)
value))
"Remove all properties of FILE in the cache context of VEC."
;; Unify localname.
(setq vec (copy-sequence vec))
- (aset vec 3 (directory-file-name file))
+ (aset vec 3 (tramp-run-real-handler 'directory-file-name (list file)))
(tramp-message vec 8 "%s" file)
(remhash vec tramp-cache-data))
(defun tramp-flush-directory-property (vec directory)
"Remove all properties of DIRECTORY in the cache context of VEC.
Remove also properties of all files in subdirectories."
- (let ((directory (directory-file-name directory)))
+ (let ((directory (tramp-run-real-handler
+ 'directory-file-name (list directory))))
(tramp-message vec 8 "%s" directory)
(maphash
'(lambda (key value)
- (when (and (stringp key)
+ (when (and (stringp (tramp-file-name-localname key))
(string-match directory (tramp-file-name-localname key)))
(remhash key tramp-cache-data)))
tramp-cache-data)))
-(defun tramp-cache-print (table)
- "Prints hash table TABLE."
- (when (hash-table-p table)
- (let (result tmp)
- (maphash
- '(lambda (key value)
- (setq tmp (format
- "(%s %s)"
- (if (processp key)
- (prin1-to-string (prin1-to-string key))
- (prin1-to-string key))
- (if (hash-table-p value)
- (tramp-cache-print value)
- (if (bufferp value)
- (prin1-to-string (prin1-to-string value))
- (prin1-to-string value))))
- result (if result (concat result " " tmp) tmp)))
- table)
- result)))
-
;; Reverting or killing a buffer should also flush file properties.
-;; They could have been changed outside Tramp.
+;; They could have been changed outside Tramp. In eshell, "ls" would
+;; not show proper directory contents when a file has been copied or
+;; deleted before.
(defun tramp-flush-file-function ()
- "Flush all Tramp cache properties from buffer-file-name."
- (let ((bfn (buffer-file-name)))
- (when (and (stringp bfn) (tramp-tramp-file-p bfn))
+ "Flush all Tramp cache properties from `buffer-file-name'."
+ (let ((bfn (if (stringp (buffer-file-name))
+ (buffer-file-name)
+ default-directory)))
+ (when (tramp-tramp-file-p bfn)
(let* ((v (tramp-dissect-file-name bfn))
(localname (tramp-file-name-localname v)))
(tramp-flush-file-property v localname)))))
(add-hook 'before-revert-hook 'tramp-flush-file-function)
+(add-hook 'eshell-pre-command-hook 'tramp-flush-file-function)
(add-hook 'kill-buffer-hook 'tramp-flush-file-function)
(add-hook 'tramp-cache-unload-hook
'(lambda ()
(remove-hook 'before-revert-hook
'tramp-flush-file-function)
+ (remove-hook 'eshell-pre-command-hook
+ 'tramp-flush-file-function)
(remove-hook 'kill-buffer-hook
'tramp-flush-file-function)))
(aset key 3 nil))
(let* ((hash (gethash key tramp-cache-data))
(value (if (hash-table-p hash)
- (gethash property hash default)
- default)))
+ (gethash property hash default)
+ default)))
(tramp-message key 7 "%s %s" property value)
value))
(puthash key (make-hash-table :test 'equal)
tramp-cache-data))))
(puthash property value hash)
+ (setq tramp-cache-data-changed t)
;; This function is called also during initialization of
;; tramp-cache.el. `tramp-message´ is not defined yet at this
;; time, so we ignore the corresponding error.
(error nil))
value))
-(defun tramp-flush-connection-property (key event)
+(defun tramp-flush-connection-property (key)
"Remove all properties identified by KEY.
-KEY identifies the connection, it is either a process or a
-vector. EVENT is not used, it is just applied because this
-function is intended to run also as process sentinel."
+KEY identifies the connection, it is either a process or a vector."
;; Unify key by removing localname from vector. Work with a copy in
;; order to avoid side effects.
(when (vectorp key)
(setq key (copy-sequence key))
(aset key 3 nil))
-; (tramp-message key 7 "%s" event)
+ (tramp-message
+ key 7 "%s %s" key
+ (let ((hash (gethash key tramp-cache-data))
+ properties)
+ (if (hash-table-p hash)
+ (maphash
+ (lambda (x y) (add-to-list 'properties x 'append))
+ (gethash key tramp-cache-data)))
+ properties))
+ (setq tramp-cache-data-changed t)
(remhash key tramp-cache-data))
+(defun tramp-cache-print (table)
+ "Print hash table TABLE."
+ (when (hash-table-p table)
+ (let (result)
+ (maphash
+ '(lambda (key value)
+ (let ((tmp (format
+ "(%s %s)"
+ (if (processp key)
+ (prin1-to-string (prin1-to-string key))
+ (prin1-to-string key))
+ (if (hash-table-p value)
+ (tramp-cache-print value)
+ (if (bufferp value)
+ (prin1-to-string (prin1-to-string value))
+ (prin1-to-string value))))))
+ (setq result (if result (concat result " " tmp) tmp))))
+ table)
+ result)))
+
+(defun tramp-list-connections ()
+ "Return a list of all known connection vectors according to `tramp-cache'."
+ (let (result)
+ (maphash
+ '(lambda (key value)
+ (when (and (vectorp key) (null (aref key 3)))
+ (add-to-list 'result key)))
+ tramp-cache-data)
+ result))
+
(defun tramp-dump-connection-properties ()
-"Writes persistent connection properties into file
-`tramp-persistency-file-name'."
+ "Write persistent connection properties into file `tramp-persistency-file-name'."
;; We shouldn't fail, otherwise (X)Emacs might not be able to be closed.
(condition-case nil
(when (and (hash-table-p tramp-cache-data)
(not (zerop (hash-table-count tramp-cache-data)))
+ tramp-cache-data-changed
(stringp tramp-persistency-file-name))
(let ((cache (copy-hash-table tramp-cache-data)))
;; Remove temporary data.
(defun tramp-parse-connection-properties (method)
"Return a list of (user host) tuples allowed to access for METHOD.
This function is added always in `tramp-get-completion-function'
-for all methods. Resulting data are derived from connection
-history."
+for all methods. Resulting data are derived from connection history."
(let (res)
(maphash
'(lambda (key value)
tramp-cache-data)
res))
-;; Read persistent connection history. Applied with
-;; `load-in-progress', because it shall be evaluated only once.
-(when load-in-progress
+;; Read persistent connection history.
+(when (and (stringp tramp-persistency-file-name)
+ (zerop (hash-table-count tramp-cache-data)))
(condition-case err
(with-temp-buffer
(insert-file-contents tramp-persistency-file-name)
(while (setq element (pop list))
(setq key (pop element))
(while (setq item (pop element))
- (tramp-set-connection-property key (pop item) (car item))))))
+ (tramp-set-connection-property key (pop item) (car item)))))
+ (setq tramp-cache-data-changed nil))
(file-error
;; Most likely because the file doesn't exist yet. No message.
(clrhash tramp-cache-data))
(error
;; File is corrupted.
- (message "%s" (error-message-string err))
+ (message "Tramp persistency file '%s' is corrupted: %s"
+ tramp-persistency-file-name (error-message-string err))
(clrhash tramp-cache-data))))
(provide 'tramp-cache)
HCoop / bpt / emacs.git / blobdiff