diff options
Diffstat (limited to 'lisp/shadowfile.el')
| -rw-r--r-- | lisp/shadowfile.el | 659 |
1 files changed, 333 insertions, 326 deletions
diff --git a/lisp/shadowfile.el b/lisp/shadowfile.el index 53718ab082a..c1c31fe9c69 100644 --- a/lisp/shadowfile.el +++ b/lisp/shadowfile.el @@ -1,6 +1,6 @@ -;;; shadowfile.el --- automatic file copying +;;; shadowfile.el --- automatic file copying -*- lexical-binding: t; -*- -;; Copyright (C) 1993-1994, 2001-2017 Free Software Foundation, Inc. +;; Copyright (C) 1993-1994, 2001-2022 Free Software Foundation, Inc. ;; Author: Boris Goldowsky <boris@gnu.org> ;; Keywords: comm files @@ -25,37 +25,38 @@ ;; This package helps you to keep identical copies of files in more than one ;; place - possibly on different machines. When you save a file, it checks ;; whether it is on the list of files with "shadows", and if so, it tries to -;; copy it when you exit Emacs (or use the shadow-copy-files command). +;; copy it when you exit Emacs (or use the `shadow-copy-files' command). ;; Installation & Use: -;; Add clusters (if necessary) and file groups with shadow-define-cluster, -;; shadow-define-literal-group, and shadow-define-regexp-group (see the +;; Add clusters (if necessary) and file groups with `shadow-define-cluster', +;; `shadow-define-literal-group', and `shadow-define-regexp-group' (see the ;; documentation for these functions for information on how and when to use ;; them). After doing this once, everything should be automatic. -;; The lists of clusters and shadows are saved in a ~/.emacs.d/shadows -;; (`shadow-info-file') file, so that they can be remembered from one -;; Emacs session to another, even (as much as possible) if the Emacs -;; session terminates abnormally. The files needing to be copied are -;; stored in `shadow-todo-file'; if a file cannot be copied for any -;; reason, it will stay on the list to be tried again next time. The -;; `shadow-info-file' file should itself have shadows on all your accounts -;; so that the information in it is consistent everywhere, but -;; `shadow-todo-file' is local information and should have no shadows. +;; The lists of clusters and shadows are saved in `shadow-info-file', +;; so that they can be remembered from one Emacs session to another, +;; even (as much as possible) if the Emacs session terminates +;; abnormally. The files needing to be copied are stored in +;; `shadow-todo-file'; if a file cannot be copied for any reason, it +;; will stay on the list to be tried again next time. The +;; `shadow-info-file' file should itself have shadows on all your +;; accounts so that the information in it is consistent everywhere, +;; but `shadow-todo-file' is local information and should have no +;; shadows. ;; If you do not want to copy a particular file, you can answer "no" and -;; be asked again next time you hit C-x 4 s or exit Emacs. If you do not -;; want to be asked again, use shadow-cancel, and you will not be asked +;; be asked again next time you hit "C-x 4 s" or exit Emacs. If you do not +;; want to be asked again, use "M-x shadow-cancel", and you will not be asked ;; until you change the file and save it again. If you do not want to ;; shadow that file ever again, you can edit it out of the shadows -;; buffer. Anytime you edit the shadows buffer, you must type M-x -;; shadow-read-files to load in the new information, or your changes will +;; buffer. Anytime you edit the shadows buffer, you must type "M-x +;; shadow-read-files" to load in the new information, or your changes will ;; be overwritten! ;; Bugs & Warnings: ;; -;; - It is bad to have two emacses both running shadowfile at the same +;; - It is bad to have two Emacsen both running shadowfile at the same ;; time. It tries to detect this condition, but is not always successful. ;; ;; - You have to be careful not to edit a file in two locations @@ -64,19 +65,16 @@ ;; ;; - It ought to check modification times of both files to make sure ;; it is doing the right thing. This will have to wait until -;; file-newer-than-file-p works between machines. +;; `file-newer-than-file-p' works between machines. ;; ;; - It will not make directories for you, it just fails to copy files ;; that belong in non-existent directories. -;; -;; Please report any bugs to me (boris@gnu.org). Also let me know -;; if you have suggestions or would like to be informed of updates. ;;; Code: (require 'cl-lib) -(require 'ange-ftp) +(require 'tramp) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; Variables @@ -92,50 +90,45 @@ "If t, always copy shadow files without asking. If nil (the default), always ask. If not nil and not t, ask only if there is no buffer currently visiting the file." - :type '(choice (const t) (const nil) (other :tag "Ask if no buffer" maybe)) - :group 'shadow) + :type '(choice (const t) (const nil) (other :tag "Ask if no buffer" maybe))) (defcustom shadow-inhibit-message nil "If non-nil, do not display a message when a file needs copying." - :type 'boolean - :group 'shadow) + :type 'boolean) (defcustom shadow-inhibit-overload nil "If non-nil, shadowfile won't redefine \\[save-buffers-kill-emacs]. Normally it overloads the function `save-buffers-kill-emacs' to check for files that have been changed and need to be copied to other systems." - :type 'boolean - :group 'shadow) + :type 'boolean) -;; FIXME in a sense, this changed in 24.4 (addition of locate-user-emacs-file), -;; but due to the weird way this variable is initialized to nil, it didn't -;; literally change. Same for shadow-todo-file. -(defcustom shadow-info-file nil +(defcustom shadow-info-file (locate-user-emacs-file "shadows" ".shadows") "File to keep shadow information in. The `shadow-info-file' should be shadowed to all your accounts to ensure consistency. Default: ~/.emacs.d/shadows" - :type '(choice (const nil) file) - :group 'shadow) + :type 'file + :version "26.2") -(defcustom shadow-todo-file nil +(defcustom shadow-todo-file + (locate-user-emacs-file "shadow_todo" ".shadow_todo") "File to store the list of uncopied shadows in. This means that if a remote system is down, or for any reason you cannot or decide not to copy your shadow files at the end of one Emacs session, it will remember and ask you again in your next Emacs session. This file must NOT be shadowed to any other system, it is host-specific. Default: ~/.emacs.d/shadow_todo" - :type '(choice (const nil) file) - :group 'shadow) + :type 'file + :version "26.2") -;;; The following two variables should in most cases initialize themselves -;;; correctly. They are provided as variables in case the defaults are wrong -;;; on your machine (and for efficiency). +;; The following two variables should in most cases initialize themselves +;; correctly. They are provided as variables in case the defaults are wrong +;; on your machine (and for efficiency). -(defvar shadow-system-name (system-name) - "The complete hostname of this machine.") +(defvar shadow-system-name (concat "/" (system-name) ":") + "The identification for local files on this machine.") -(defvar shadow-homedir nil +(defvar shadow-homedir "~/" "Your home directory on this machine.") ;;; @@ -162,36 +155,25 @@ created by `shadow-define-regexp-group'.") (defvar shadow-files-to-copy nil) ; List of files that need to ; be copied to remote hosts. -(defvar shadow-hashtable nil) ; for speed +(defvar shadow-hashtable (make-hash-table :test #'equal)) ; for speed (defvar shadow-info-buffer nil) ; buf visiting shadow-info-file (defvar shadow-todo-buffer nil) ; buf visiting shadow-todo-file +(defvar shadow-debug nil + "Use for debug messages.") + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; Syntactic sugar; General list and string manipulation ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(defun shadow-union (a b) - "Add members of list A to list B if not equal to items already in B." - (if (null a) - b - (if (member (car a) b) - (shadow-union (cdr a) b) - (shadow-union (cdr a) (cons (car a) b))))) - -(defun shadow-find (func list) - "If FUNC applied to some element of LIST is non-nil, return first such element." - (while (and list (not (funcall func (car list)))) - (setq list (cdr list))) - (car list)) - (defun shadow-regexp-superquote (string) - "Like `regexp-quote', but includes the ^ and $. + "Like `regexp-quote', but includes the \\` and \\'. This makes sure regexp matches nothing but STRING." - (concat "^" (regexp-quote string) "$")) + (concat "\\`" (regexp-quote string) "\\'")) (defun shadow-suffix (prefix string) - "If PREFIX begins STRING, return the rest. + "If PREFIX begins with STRING, return the rest. Return value is non-nil if PREFIX and STRING are `string=' up to the length of PREFIX." (let ((lp (length prefix)) @@ -204,70 +186,75 @@ PREFIX." ;;; Clusters and sites ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;;; I use the term `site' to refer to a string which may be the name of a -;;; cluster or a literal hostname. All user-level commands should accept -;;; either. +;; I use the term `site' to refer to a string which may be the +;; cluster identification "/name:", a remote identification +;; "/method:user@host:", or "/system-name:" (the value of +;; `shadow-system-name') for the location of local files. All +;; user-level commands should accept either. -(defun shadow-make-cluster (name primary regexp) - "Create a shadow cluster. -It is called NAME, uses the PRIMARY hostname and REGEXP matching all -hosts in the cluster. The variable `shadow-clusters' associates the -names of clusters to these structures. This function is for program -use: to create clusters interactively, use `shadow-define-cluster' -instead." - (list name primary regexp)) - -(defmacro shadow-cluster-name (cluster) - "Return the name of the CLUSTER." - (list 'elt cluster 0)) - -(defmacro shadow-cluster-primary (cluster) - "Return the primary hostname of a CLUSTER." - (list 'elt cluster 1)) - -(defmacro shadow-cluster-regexp (cluster) - "Return the regexp matching hosts in a CLUSTER." - (list 'elt cluster 2)) +(cl-defstruct (shadow-cluster (:type list) :named) name primary regexp) (defun shadow-set-cluster (name primary regexp) "Put cluster NAME on the list of clusters. Replace old definition, if any. PRIMARY and REGEXP are the information defining the cluster. For interactive use, call `shadow-define-cluster' instead." - (let ((rest (cl-remove-if (lambda (x) (equal name (car x))) + (let ((rest (cl-remove-if (lambda (x) (equal name (shadow-cluster-name x))) shadow-clusters))) (setq shadow-clusters - (cons (shadow-make-cluster name primary regexp) + (cons (make-shadow-cluster :name name :primary primary :regexp regexp) rest)))) -(defmacro shadow-get-cluster (name) +(defun shadow-get-cluster (name) "Return cluster named NAME, or nil." - (list 'assoc name 'shadow-clusters)) + (seq-find + (lambda (x) (string-equal (shadow-cluster-name x) name)) + shadow-clusters)) + +;;; SITES + +;; This simplifies it a little bit. "system-name" is also accepted. +;; But we don't want to make the help echo too long. +(defconst shadow-site-help "\ +A cluster identification \"/name:\", a remote identification +\"/method:user@host:\", or \"/system-name:\" (the value of +`shadow-system-name')" + "The help string describing a valid site.") + +(defun shadow-site-name (site) + "Return name if SITE has the form \"/name:\", otherwise SITE." + (if (string-match "\\`/\\([-.[:word:]]+\\):\\'" site) + (match-string 1 site) site)) + +(defun shadow-name-site (name) + "Return \"/name:\" if NAME has word syntax, otherwise NAME." + (if (string-match "\\`[-.[:word:]]+\\'" name) + (format "/%s:"name) name)) (defun shadow-site-primary (site) - "If SITE is a cluster, return primary host, otherwise return SITE." - (let ((c (shadow-get-cluster site))) - (if c - (shadow-cluster-primary c) + "If SITE is a cluster, return primary identification, otherwise return SITE." + (let ((cluster (shadow-get-cluster (shadow-site-name site)))) + (if cluster + (shadow-cluster-primary cluster) site))) -;;; SITES - (defun shadow-site-cluster (site) - "Given a SITE (hostname or cluster name), return cluster it is in, or nil." - (or (assoc site shadow-clusters) - (shadow-find - (function (lambda (x) - (string-match (shadow-cluster-regexp x) - site))) + "Given a SITE, return cluster it is in, or nil." + (or (shadow-get-cluster (shadow-site-name site)) + (seq-find + (lambda (x) + (string-match (shadow-cluster-regexp x) (shadow-name-site site))) shadow-clusters))) (defun shadow-read-site () - "Read a cluster name or hostname from the minibuffer." - (let ((ans (completing-read "Host or cluster name [RET when done]: " - shadow-clusters))) - (if (equal "" ans) - nil + "Read a site name from the minibuffer." + (let ((ans (completing-read + (propertize "Site name: " 'help-echo shadow-site-help) + shadow-clusters))) + (when (or (shadow-get-cluster (shadow-site-name ans)) + (string-equal ans shadow-system-name) + (string-equal ans (shadow-site-name shadow-system-name)) + (setq ans (file-remote-p ans))) ans))) (defun shadow-site-match (site1 site2) @@ -281,63 +268,92 @@ be matched against the primary of SITE2." (string-match (shadow-cluster-regexp cluster1) primary2) (string-equal site1 primary2))))) -(defun shadow-get-user (site) - "Return the default username for a SITE." - (ange-ftp-get-user (shadow-site-primary site))) - ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; Filename manipulation ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(defun shadow-parse-fullname (fullname) - "Parse FULLNAME into (site user path) list. -Leave it alone if it already is one. Return nil if the argument is -not a full ange-ftp pathname." - (if (listp fullname) - fullname - (ange-ftp-ftp-name fullname))) - (defun shadow-parse-name (name) - "Parse any NAME into (site user name) list. -Argument can be a simple name, full ange-ftp name, or already a hup list." - (or (shadow-parse-fullname name) - (list shadow-system-name - (user-login-name) - name))) - -(defsubst shadow-make-fullname (host user name) - "Make an ange-ftp style fullname out of HOST, USER (optional), and NAME. -This is probably not as general as it ought to be." - (concat "/" - (if user (concat user "@")) - host ":" - name)) + "Parse any NAME into a `tramp-file-name' structure. +Argument can be a simple name, remote file name, or already a +`tramp-file-name' structure." + (cond + ((null name) nil) + ((tramp-file-name-p name) name) + ((file-remote-p name) (tramp-dissect-file-name name)) + ((shadow-local-file name) + (make-tramp-file-name + :host (shadow-site-name shadow-system-name) + :localname (shadow-local-file name))) + ;; Cluster name. + ((string-match "^/\\([^:/]+\\):\\([^:]*\\)$" name) + (let ((name (match-string 1 name)) + (file (match-string 2 name))) + (when (shadow-get-cluster name) + (make-tramp-file-name :host name :localname file)))))) + +(defsubst shadow-make-fullname (hup &optional host name) + "Make a Tramp style fullname out of HUP, a `tramp-file-name' structure. +Replace HOST, and NAME when non-nil. HOST can also be a remote file name." + (when-let ((hup (copy-tramp-file-name hup))) + (when host + (if (file-remote-p host) + (setq name (or name (and hup (tramp-file-name-localname hup))) + hup (tramp-dissect-file-name (file-remote-p host))) + (setf (tramp-file-name-host hup) host))) + (when name (setf (tramp-file-name-localname hup) name)) + (if (null (tramp-file-name-method hup)) + (format + "/%s:%s" (tramp-file-name-host hup) (tramp-file-name-localname hup)) + (tramp-make-tramp-file-name hup)))) (defun shadow-replace-name-component (fullname newname) "Return FULLNAME with the name component changed to NEWNAME." - (let ((hup (shadow-parse-fullname fullname))) - (shadow-make-fullname (nth 0 hup) (nth 1 hup) newname))) + (concat (file-remote-p fullname) newname)) (defun shadow-local-file (file) - "If FILE is at this site, remove /user@host part. -If refers to a different system or a different user on this system, -return nil." - (let ((hup (shadow-parse-fullname file))) - (cond ((null hup) file) - ((and (shadow-site-match (nth 0 hup) shadow-system-name) - (string-equal (nth 1 hup) (user-login-name))) - (nth 2 hup)) - (t nil)))) + "If FILE is not remote, return it. +If it refers to a different system, return nil." + (cond + ((null file) nil) + ;; `tramp-file-name' structure. + ((and (tramp-file-name-p file) (null (tramp-file-name-method file))) + (tramp-file-name-localname file)) + ((tramp-file-name-p file) nil) + ;; Local host name. + ((string-match + (format "^%s\\([^:]*\\)$" (regexp-quote shadow-system-name)) file) + (match-string 1 file)) + ;; Cluster name. + ((and (string-match "^/\\([^:/]+\\):\\([^:]*\\)$" file) + (shadow-get-cluster (match-string 1 file))) + (let ((file (match-string 2 file)) + (primary + (shadow-cluster-primary + (shadow-get-cluster (match-string 1 file))))) + (when (string-equal primary shadow-system-name) (setq primary nil)) + (shadow-local-file (concat primary file)))) + ;; Local name. + ((null (file-remote-p file)) file))) (defun shadow-expand-cluster-in-file-name (file) "If hostname part of FILE is a cluster, expand it to cluster's primary hostname. Will return the name bare if it is a local file." - (let ((hup (shadow-parse-name file))) - (cond ((null hup) file) - ((shadow-local-file hup)) - ((shadow-make-fullname (shadow-site-primary (nth 0 hup)) - (nth 1 hup) - (nth 2 hup)))))) + (when (stringp file) + (cond + ;; Local file. + ((shadow-local-file file)) + ;; Cluster name. + ((string-match "^\\(/[^:/]+:\\)[^:]*$" file) + (let ((primary + (save-match-data + (shadow-cluster-primary + (shadow-get-cluster + (shadow-site-name (match-string 1 file))))))) + (if (not primary) + file + (setq file (replace-match primary nil nil file 1)) + (or (shadow-local-file file) file)))) + (t file)))) (defun shadow-expand-file-name (file &optional default) "Expand file name and get FILE's true name." @@ -345,53 +361,59 @@ Will return the name bare if it is a local file." (defun shadow-contract-file-name (file) "Simplify FILE. -Do so by replacing (when possible) home directory with ~, and hostname -with cluster name that includes it. Filename should be absolute and -true." - (let* ((hup (shadow-parse-name file)) - (homedir (if (shadow-local-file hup) - shadow-homedir - (file-name-as-directory - (nth 2 (shadow-parse-fullname - (expand-file-name - (shadow-make-fullname - (nth 0 hup) (nth 1 hup) "~"))))))) - (suffix (shadow-suffix homedir (nth 2 hup))) - (cluster (shadow-site-cluster (nth 0 hup)))) - (shadow-make-fullname - (if cluster - (shadow-cluster-name cluster) - (nth 0 hup)) - (nth 1 hup) - (if suffix - (concat "~/" suffix) - (nth 2 hup))))) +Do so by replacing (when possible) home directory with ~/, and +hostname with cluster name that includes it. Filename should be +absolute and true." + (when-let ((hup (shadow-parse-name file))) + (let* ((homedir (if (shadow-local-file hup) + shadow-homedir + (file-name-as-directory + (file-local-name + (expand-file-name + (shadow-make-fullname hup nil shadow-homedir)))))) + (suffix (shadow-suffix homedir (tramp-file-name-localname hup))) + (cluster (shadow-site-cluster (shadow-make-fullname hup nil "")))) + (when cluster + (setf (tramp-file-name-method hup) nil + (tramp-file-name-host hup) (shadow-cluster-name cluster))) + (shadow-make-fullname + hup nil + (if suffix + (concat shadow-homedir suffix) + (tramp-file-name-localname hup)))))) (defun shadow-same-site (pattern file) "True if the site of PATTERN and of FILE are on the same site. -If usernames are supplied, they must also match exactly. PATTERN and FILE may -be lists of host, user, name, or ange-ftp file names. FILE may also be just a -local filename." - (let ((pattern-sup (shadow-parse-fullname pattern)) +PATTERN and FILE may be Tramp vectors, or remote file names. +FILE may also be just a local filename." + (let ((pattern-sup (shadow-parse-name pattern)) (file-sup (shadow-parse-name file))) (and - (shadow-site-match (nth 0 pattern-sup) (nth 0 file-sup)) - (or (null (nth 1 pattern-sup)) - (string-equal (nth 1 pattern-sup) (nth 1 file-sup)))))) + (shadow-site-match + (tramp-file-name-host pattern-sup) (tramp-file-name-host file-sup)) + (or (null (tramp-file-name-user pattern-sup)) + (string-equal + (tramp-file-name-user pattern-sup) + (tramp-file-name-user file-sup)))))) (defun shadow-file-match (pattern file &optional regexp) "Return t if PATTERN matches FILE. If REGEXP is supplied and non-nil, the file part of the pattern is a regular -expression, otherwise it must match exactly. The sites and usernames must -match---see `shadow-same-site'. The pattern must be in full ange-ftp format, +expression, otherwise it must match exactly. The sites must +match---see `shadow-same-site'. The pattern must be in full Tramp format, but the file can be any valid filename. This function does not do any filename expansion or contraction, you must do that yourself first." - (let* ((pattern-sup (shadow-parse-fullname pattern)) + (let* ((pattern-sup (shadow-parse-name pattern)) (file-sup (shadow-parse-name file))) (and (shadow-same-site pattern-sup file-sup) (if regexp - (string-match (nth 2 pattern-sup) (nth 2 file-sup)) - (string-equal (nth 2 pattern-sup) (nth 2 file-sup)))))) + (string-match + (tramp-file-name-localname pattern-sup) + (tramp-file-name-localname file-sup)) + (string-equal + (tramp-file-name-localname pattern-sup) + (tramp-file-name-localname file-sup))) + t))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; User-level Commands @@ -405,30 +427,34 @@ one of them is sufficient to update the file on all of them. Clusters are defined by a name, the network address of a primary host (the one we copy files to), and a regular expression that matches the hostnames of all the sites in the cluster." - (interactive (list (completing-read "Cluster name: " shadow-clusters () ()))) + (interactive (list (completing-read "Cluster name: " shadow-clusters))) (let* ((old (shadow-get-cluster name)) - (primary (read-string "Primary host: " - (if old (shadow-cluster-primary old) - name))) - (regexp (let (try-regexp) - (while (not - (string-match - (setq try-regexp + (primary (let (try-primary) + (while (not + (or + (string-equal + (setq try-primary (read-string - "Regexp matching all host names: " - (if old (shadow-cluster-regexp old) - (shadow-regexp-superquote primary)))) - primary)) - (message "Regexp doesn't include the primary host!") - (sit-for 2)) - try-regexp)) -; (username (read-no-blanks-input -; (format "Username (default %s): " -; (shadow-get-user primary)) -; (if old (or (shadow-cluster-username old) "") -; (user-login-name)))) - ) -; (if (string-equal "" username) (setq username nil)) + "Primary host: " + (if old (shadow-cluster-primary old) + name))) + shadow-system-name) + (file-remote-p try-primary))) + (message "Not a valid primary!") + (sit-for 2)) + try-primary)) + (regexp (let (try-regexp) + (while (not + (string-match + (setq try-regexp + (read-string + "Regexp matching all host names: " + (if old (shadow-cluster-regexp old) + (shadow-regexp-superquote primary)))) + primary)) + (message "Regexp doesn't include the primary host!") + (sit-for 2)) + try-regexp))) (shadow-set-cluster name primary regexp))) ;;;###autoload @@ -438,22 +464,17 @@ It may have different filenames on each site. When this file is edited, the new version will be copied to each of the other locations. Sites can be specific hostnames, or names of clusters (see `shadow-define-cluster')." (interactive) - (let* ((hup (shadow-parse-fullname - (shadow-contract-file-name (buffer-file-name)))) - (name (nth 2 hup)) - user site group) - (while (setq site (shadow-read-site)) - (setq user (read-string (format "Username (default %s): " - (shadow-get-user site))) - name (read-string "Filename: " name)) - (setq group (cons (shadow-make-fullname site - (if (string-equal "" user) - (shadow-get-user site) - user) - name) - group))) - (setq shadow-literal-groups (cons group shadow-literal-groups))) - (shadow-write-info-file)) + (when-let ((hup (shadow-parse-name + (shadow-contract-file-name (buffer-file-name))))) + (let* ((name (tramp-file-name-localname hup)) + site group) + (while (setq site (shadow-read-site)) + (setq name (read-string "Filename: " name) + hup (shadow-parse-name (shadow-contract-file-name name)) + group (cons (shadow-make-fullname hup site) group))) + (when group + (setq shadow-literal-groups (cons group shadow-literal-groups)))) + (shadow-write-info-file))) ;;;###autoload (defun shadow-define-regexp-group () @@ -468,19 +489,12 @@ function). Each site can be either a hostname or the name of a cluster (see "Filename regexp: " (if (buffer-file-name) (shadow-regexp-superquote - (nth 2 - (shadow-parse-name - (shadow-contract-file-name - (buffer-file-name)))))))) - site sites usernames) + (file-local-name (buffer-file-name)))))) + site sites) (while (setq site (shadow-read-site)) - (setq sites (cons site sites)) - (setq usernames - (cons (read-string (format "Username for %s: " site) - (shadow-get-user site)) - usernames))) + (setq sites (cons site sites))) (setq shadow-regexp-groups - (cons (shadow-make-group regexp sites usernames) + (cons (shadow-make-group regexp sites) shadow-regexp-groups)) (shadow-write-info-file))) @@ -506,10 +520,9 @@ call it manually." (if (called-interactively-p 'interactive) (message "No files need to be shadowed.")) (save-excursion - (map-y-or-n-p (function - (lambda (pair) - (or arg shadow-noquery - (format "Copy shadow file %s? " (cdr pair))))) + (map-y-or-n-p (lambda (pair) + (or arg shadow-noquery + (format "Copy shadow file %s? " (cdr pair)))) (function shadow-copy-file) shadow-files-to-copy '("shadow" "shadows" "copy")) @@ -522,11 +535,11 @@ them again, unless you make more changes to the files. To cancel a shadow permanently, remove the group from `shadow-literal-groups' or `shadow-regexp-groups'." (interactive) - (map-y-or-n-p (function (lambda (pair) - (format "Cancel copying %s to %s? " - (car pair) (cdr pair)))) - (function (lambda (pair) - (shadow-remove-from-todo pair))) + (map-y-or-n-p (lambda (pair) + (format "Cancel copying %s to %s? " + (car pair) (cdr pair))) + (lambda (pair) + (shadow-remove-from-todo pair)) shadow-files-to-copy '("shadow" "shadows" "cancel copy")) (message "There are %d shadows to be updated." @@ -537,14 +550,14 @@ permanently, remove the group from `shadow-literal-groups' or ;;; Internal functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(defun shadow-make-group (regexp sites usernames) +(defun shadow-make-group (regexp sites) "Make a description of a file group--- -actually a list of regexp ange-ftp file names---from REGEXP (name of file to -be shadowed), list of SITES, and corresponding list of USERNAMES for each -site." +actually a list of regexp Tramp file names---from REGEXP (name of file to +be shadowed), and list of SITES." (if sites - (cons (shadow-make-fullname (car sites) (car usernames) regexp) - (shadow-make-group regexp (cdr sites) (cdr usernames))) + (cons (shadow-make-fullname + (shadow-parse-name (shadow-site-primary (car sites))) nil regexp) + (shadow-make-group regexp (cdr sites))) nil)) (defun shadow-copy-file (s) @@ -577,20 +590,25 @@ site." Filename should have clusters expanded, but otherwise can have any format. Return value is a list of dotted pairs like (from . to), where from and to are absolute file names." - (or (symbol-value (intern-soft file shadow-hashtable)) + (or (gethash file shadow-hashtable) (let* ((absolute-file (shadow-expand-file-name (or (shadow-local-file file) file) shadow-homedir)) (canonical-file (shadow-contract-file-name absolute-file)) (shadows - (mapcar (function (lambda (shadow) - (cons absolute-file shadow))) + (mapcar (lambda (shadow) + (cons absolute-file shadow)) (append (shadow-shadows-of-1 canonical-file shadow-literal-groups nil) (shadow-shadows-of-1 canonical-file shadow-regexp-groups t))))) - (set (intern file shadow-hashtable) shadows)))) + (when shadow-debug + (message + "shadow-shadows-of: %s %s %s %s %s" + file (shadow-local-file file) shadow-homedir + absolute-file canonical-file)) + (puthash file shadows shadow-hashtable)))) (defun shadow-shadows-of-1 (file groups regexp) "Return list of FILE's shadows in GROUPS. @@ -601,23 +619,37 @@ Consider them as regular expressions if third arg REGEXP is true." (car groups)))) (append (cond ((equal nonmatching (car groups)) nil) (regexp - (let ((realname (nth 2 (shadow-parse-fullname file)))) + (let ((realname + (tramp-file-name-localname + (shadow-parse-name file)))) + (when shadow-debug + (message + "shadow-shadows-of-1: %s %s %s" + file (shadow-parse-name file) realname)) (mapcar - (function - (lambda (x) - (shadow-replace-name-component x realname))) + (lambda (x) + (shadow-replace-name-component x realname)) nonmatching))) (t nonmatching)) (shadow-shadows-of-1 file (cdr groups) regexp))))) (defun shadow-add-to-todo () "If current buffer has shadows, add them to the list needing to be copied." + (when shadow-debug + (message + "shadow-add-to-todo: %s %s" + (buffer-file-name (current-buffer)) + (shadow-expand-file-name (buffer-file-name (current-buffer))))) (let ((shadows (shadow-shadows-of (shadow-expand-file-name (buffer-file-name (current-buffer)))))) + (when shadow-debug + (message + "shadow-add-to-todo: %s %s\n%s" + shadows shadow-files-to-copy (with-output-to-string (backtrace)))) (when shadows (setq shadow-files-to-copy - (shadow-union shadows shadow-files-to-copy)) + (nreverse (cl-union shadows shadow-files-to-copy :test #'equal))) (when (not shadow-inhibit-message) (message "%s" (substitute-command-keys "Use \\[shadow-copy-files] to update shadows.")) @@ -628,6 +660,10 @@ Consider them as regular expressions if third arg REGEXP is true." (defun shadow-remove-from-todo (pair) "Remove PAIR from `shadow-files-to-copy'. PAIR must be `eq' to one of the elements of that list." + (when shadow-debug + (message + "shadow-remove-from-todo: %s %s\n%s" + pair shadow-files-to-copy (with-output-to-string (backtrace)))) (setq shadow-files-to-copy (cl-remove-if (lambda (s) (eq s pair)) shadow-files-to-copy))) @@ -636,9 +672,8 @@ PAIR must be `eq' to one of the elements of that list." Thus restores shadowfile's state from your last Emacs session. Return t unless files were locked; then return nil." (interactive) - (if (and (fboundp 'file-locked-p) - (or (stringp (file-locked-p shadow-info-file)) - (stringp (file-locked-p shadow-todo-file)))) + (if (or (stringp (file-locked-p shadow-info-file)) + (stringp (file-locked-p shadow-todo-file))) (progn (message "Shadowfile is running in another Emacs; can't have two.") (beep) @@ -647,7 +682,7 @@ Return t unless files were locked; then return nil." (save-current-buffer (when shadow-info-file (set-buffer (setq shadow-info-buffer - (find-file-noselect shadow-info-file))) + (find-file-noselect shadow-info-file 'nowarn))) (when (and (not (buffer-modified-p)) (file-newer-than-file-p (make-auto-save-file-name) shadow-info-file)) @@ -658,7 +693,7 @@ Return t unless files were locked; then return nil." (eval-buffer)) (when shadow-todo-file (set-buffer (setq shadow-todo-buffer - (find-file-noselect shadow-todo-file))) + (find-file-noselect shadow-todo-file 'nowarn))) (when (and (not (buffer-modified-p)) (file-newer-than-file-p (make-auto-save-file-name) shadow-todo-file)) @@ -680,6 +715,7 @@ defined, the old hashtable info is invalid." (if (not shadow-info-buffer) (setq shadow-info-buffer (find-file-noselect shadow-info-file))) (set-buffer shadow-info-buffer) + (setq buffer-read-only nil) (delete-region (point-min) (point-max)) (shadow-insert-var 'shadow-clusters) (shadow-insert-var 'shadow-literal-groups) @@ -692,11 +728,14 @@ With non-nil argument also saves the buffer." (if (not shadow-todo-buffer) (setq shadow-todo-buffer (find-file-noselect shadow-todo-file))) (set-buffer shadow-todo-buffer) + (setq buffer-read-only nil) (delete-region (point-min) (point-max)) (shadow-insert-var 'shadow-files-to-copy) (if save (shadow-save-todo-file)))) (defun shadow-save-todo-file () + (when shadow-debug + (message "shadow-save-todo-file:\n%s" (with-output-to-string (backtrace)))) (if (and shadow-todo-buffer (buffer-modified-p shadow-todo-buffer)) (with-current-buffer shadow-todo-buffer (condition-case nil ; have to continue even in case of @@ -706,7 +745,7 @@ With non-nil argument also saves the buffer." (sit-for 1)))))) (defun shadow-invalidate-hashtable () - (setq shadow-hashtable (make-vector 37 0))) + (clrhash shadow-hashtable)) (defun shadow-insert-var (variable) "Build a `setq' to restore VARIABLE. @@ -715,17 +754,17 @@ will restore VARIABLE to its current setting. VARIABLE must be the name of a variable whose value is a list." (let ((standard-output (current-buffer))) (insert (format "(setq %s" variable)) - (cond ((consp (eval variable)) + (cond ((consp (symbol-value variable)) (insert "\n '(") - (prin1 (car (eval variable))) - (let ((rest (cdr (eval variable)))) + (prin1 (car (symbol-value variable))) + (let ((rest (cdr (symbol-value variable)))) (while rest (insert "\n ") (prin1 (car rest)) (setq rest (cdr rest))) (insert "))\n\n"))) (t (insert " ") - (prin1 (eval variable)) + (prin1 (symbol-value variable)) (insert ")\n\n"))))) (defun shadow-save-buffers-kill-emacs (&optional arg) @@ -734,6 +773,11 @@ With prefix arg, silently save all file-visiting buffers, then kill. Extended by shadowfile to automatically save `shadow-todo-file' and look for files that have been changed and need to be copied to other systems." + (interactive "P") + (shadow--save-buffers-kill-emacs arg) + (save-buffers-kill-emacs arg)) + +(defun shadow--save-buffers-kill-emacs (&optional arg &rest _) ;; This function is necessary because we need to get control and save ;; the todo file /after/ saving other files, but /before/ the warning ;; message about unsaved buffers (because it can get modified by the @@ -741,46 +785,10 @@ look for files that have been changed and need to be copied to other systems." ;; because it is not called at the correct time, and also because it is ;; called when the terminal is disconnected and we cannot ask whether ;; to copy files. - (interactive "P") (shadow-save-todo-file) (save-some-buffers arg t) (shadow-copy-files) - (shadow-save-todo-file) - (and (or (not (memq t (mapcar (function - (lambda (buf) (and (buffer-file-name buf) - (buffer-modified-p buf)))) - (buffer-list)))) - (yes-or-no-p "Modified buffers exist; exit anyway? ")) - (or (not (fboundp 'process-list)) - ;; process-list is not defined on MSDOS. - (let ((processes (process-list)) - active) - (while processes - (and (memq (process-status (car processes)) '(run stop open listen)) - (process-query-on-exit-flag (car processes)) - (setq active t)) - (setq processes (cdr processes))) - (or (not active) - (yes-or-no-p "Active processes exist; kill them and exit anyway? ")))) - (kill-emacs))) - -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;;; Lucid Emacs compatibility -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - -;; This is on hold until someone tells me about a working version of -;; map-ynp for Lucid Emacs. - -;(when (string-match "Lucid" emacs-version) -; (require 'symlink-fix) -; (require 'ange-ftp) -; (require 'map-ynp) -; (if (not (fboundp 'file-truename)) -; (fset 'shadow-expand-file-name -; (symbol-function 'symlink-expand-file-name))) -; (if (not (fboundp 'ange-ftp-ftp-name)) -; (fset 'ange-ftp-ftp-name -; (symbol-function 'ange-ftp-ftp-name)))) + (shadow-save-todo-file)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;; Hook us up @@ -790,39 +798,38 @@ look for files that have been changed and need to be copied to other systems." (defun shadow-initialize () "Set up file shadowing." (interactive) - (if (null shadow-homedir) - (setq shadow-homedir - (file-name-as-directory (shadow-expand-file-name "~")))) - (if (null shadow-info-file) - (setq shadow-info-file - ;; FIXME: Move defaults to their defcustom. - (shadow-expand-file-name - (locate-user-emacs-file "shadows" ".shadows")))) - (if (null shadow-todo-file) - (setq shadow-todo-file - (shadow-expand-file-name - (locate-user-emacs-file "shadow_todo" ".shadow_todo")))) + (setq shadow-homedir + (file-name-as-directory (shadow-expand-file-name shadow-homedir)) + shadow-info-file (shadow-expand-file-name shadow-info-file) + shadow-todo-file (shadow-expand-file-name shadow-todo-file)) (if (not (shadow-read-files)) (progn (message "Shadowfile information files not found - aborting") (beep) (sit-for 3)) - (when (and (not shadow-inhibit-overload) - (not (fboundp 'shadow-orig-save-buffers-kill-emacs))) - (defalias 'shadow-orig-save-buffers-kill-emacs - (symbol-function 'save-buffers-kill-emacs)) - (defalias 'save-buffers-kill-emacs 'shadow-save-buffers-kill-emacs)) - (add-hook 'write-file-functions 'shadow-add-to-todo) - (define-key ctl-x-4-map "s" 'shadow-copy-files))) + (unless shadow-inhibit-overload + (advice-add 'save-buffers-kill-emacs :before + #'shadow--save-buffers-kill-emacs)) + (add-hook 'write-file-functions #'shadow-add-to-todo) + (define-key ctl-x-4-map "s" #'shadow-copy-files))) (defun shadowfile-unload-function () - (substitute-key-definition 'shadow-copy-files nil ctl-x-4-map) - (when (fboundp 'shadow-orig-save-buffers-kill-emacs) - (fset 'save-buffers-kill-emacs - (symbol-function 'shadow-orig-save-buffers-kill-emacs))) + (substitute-key-definition #'shadow-copy-files nil ctl-x-4-map) + (advice-remove 'save-buffers-kill-emacs #'shadow--save-buffers-kill-emacs) ;; continue standard unloading nil) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;; Obsolete +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(defun shadow-union (a b) + "Add members of list A to list B if not equal to items already in B." + (declare (obsolete cl-union "28.1")) + (nreverse (cl-union a b :test #'equal))) + +(define-obsolete-function-alias 'shadow-find #'seq-find "28.1") + (provide 'shadowfile) ;;; shadowfile.el ends here |