1;;; tramp-vc.el --- Version control integration for TRAMP.el 2 3;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 4;; 2005, 2006, 2007 Free Software Foundation, Inc. 5 6;; Author: Daniel Pittman <daniel@danann.net> 7;; Keywords: comm, processes 8 9;; This file is part of GNU Emacs. 10 11;; GNU Emacs is free software; you can redistribute it and/or modify 12;; it under the terms of the GNU General Public License as published by 13;; the Free Software Foundation; either version 2, or (at your option) 14;; any later version. 15 16;; GNU Emacs is distributed in the hope that it will be useful, 17;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19;; GNU General Public License for more details. 20 21;; You should have received a copy of the GNU General Public License 22;; along with GNU Emacs; see the file COPYING. If not, write to the 23;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 24;; Boston, MA 02110-1301, USA. 25 26;;; Commentary: 27 28;; See the main module, 'tramp.el' for discussion of the purpose of TRAMP. 29;; This module provides integration between remote files accessed by TRAMP and 30;; the Emacs version control system. 31 32;;; Code: 33 34(eval-when-compile 35 (require 'cl)) 36(require 'vc) 37;; Old VC defines vc-rcs-release in vc.el, new VC requires extra module. 38(unless (boundp 'vc-rcs-release) 39 (require 'vc-rcs)) 40(require 'tramp) 41 42;; Avoid byte-compiler warnings if the byte-compiler supports this. 43;; Currently, XEmacs supports this. 44(eval-when-compile 45 (when (fboundp 'byte-compiler-options) 46 (let (unused-vars) ; Pacify Emacs byte-compiler 47 (defalias 'warnings 'identity) ; Pacify Emacs byte-compiler 48 (byte-compiler-options (warnings (- unused-vars)))))) 49 50;; -- vc -- 51 52;; This used to blow away the file-name-handler-alist and reinstall 53;; TRAMP into it. This was intended to let VC work remotely. It didn't, 54;; at least not in my XEmacs 21.2 install. 55;; 56;; In any case, tramp-run-real-handler now deals correctly with disabling 57;; the things that should be, making this a no-op. 58;; 59;; I have removed it from the tramp-file-name-handler-alist because the 60;; shortened version does nothing. This is for reference only now. 61;; 62;; Daniel Pittman <daniel@danann.net> 63;; 64;; (defun tramp-handle-vc-registered (file) 65;; "Like `vc-registered' for tramp files." 66;; (tramp-run-real-handler 'vc-registered (list file))) 67 68;; `vc-do-command' 69;; This function does not deal well with remote files, so we define 70;; our own version and make a backup of the original function and 71;; call our version for tramp files and the original version for 72;; normal files. 73 74;; The following function is pretty much copied from vc.el, but 75;; the part that actually executes a command is changed. 76;; CCC: this probably works for Emacs 21, too. 77(defun tramp-vc-do-command (buffer okstatus command file last &rest flags) 78 "Like `vc-do-command' but invoked for tramp files. 79See `vc-do-command' for more information." 80 (save-match-data 81 (and file (setq file (expand-file-name file))) 82 (if (not buffer) (setq buffer "*vc*")) 83 (if vc-command-messages 84 (message "Running `%s' on `%s'..." command file)) 85 (let ((obuf (current-buffer)) (camefrom (current-buffer)) 86 (squeezed nil) 87 (olddir default-directory) 88 vc-file status) 89 (let* ((v (tramp-dissect-file-name (expand-file-name file))) 90 (multi-method (tramp-file-name-multi-method v)) 91 (method (tramp-file-name-method v)) 92 (user (tramp-file-name-user v)) 93 (host (tramp-file-name-host v)) 94 (localname (tramp-file-name-localname v))) 95 (set-buffer (get-buffer-create buffer)) 96 (set (make-local-variable 'vc-parent-buffer) camefrom) 97 (set (make-local-variable 'vc-parent-buffer-name) 98 (concat " from " (buffer-name camefrom))) 99 (setq default-directory olddir) 100 101 (erase-buffer) 102 103 (mapcar 104 (function 105 (lambda (s) (and s (setq squeezed (append squeezed (list s)))))) 106 flags) 107 (if (and (eq last 'MASTER) file 108 (setq vc-file (vc-name file))) 109 (setq squeezed 110 (append squeezed 111 (list (tramp-file-name-localname 112 (tramp-dissect-file-name vc-file)))))) 113 (if (and file (eq last 'WORKFILE)) 114 (progn 115 (let* ((pwd (expand-file-name default-directory)) 116 (preflen (length pwd))) 117 (if (string= (substring file 0 preflen) pwd) 118 (setq file (substring file preflen)))) 119 (setq squeezed (append squeezed (list file))))) 120 ;; Unless we (save-window-excursion) the layout of windows in 121 ;; the current frame changes. This is painful, at best. 122 ;; 123 ;; As a point of note, (save-excursion) is still here only because 124 ;; it preserves (point) in the current buffer. (save-window-excursion) 125 ;; does not, at least under XEmacs 21.2. 126 ;; 127 ;; I trust that the FSF support this as well. I can't find useful 128 ;; documentation to check :( 129 ;; 130 ;; Daniel Pittman <daniel@danann.net> 131 (save-excursion 132 (save-window-excursion 133 ;; Actually execute remote command 134 ;; `shell-command' cannot be used; it isn't magic in XEmacs. 135 (tramp-handle-shell-command 136 (mapconcat 'tramp-shell-quote-argument 137 (cons command squeezed) " ") t) 138 ;;(tramp-wait-for-output) 139 ;; Get status from command 140 (tramp-send-command multi-method method user host "echo $?") 141 (tramp-wait-for-output) 142 ;; Make sure to get status from last line of output. 143 (goto-char (point-max)) (forward-line -1) 144 (setq status (read (current-buffer))) 145 (message "Command %s returned status %d." command status))) 146 (goto-char (point-max)) 147 (set-buffer-modified-p nil) 148 (forward-line -1) 149 (if (or (not (integerp status)) 150 (and (integerp okstatus) (< okstatus status))) 151 (progn 152 (pop-to-buffer buffer) 153 (goto-char (point-min)) 154 (shrink-window-if-larger-than-buffer) 155 (error "Running `%s'...FAILED (%s)" command 156 (if (integerp status) 157 (format "status %d" status) 158 status)) 159 ) 160 (if vc-command-messages 161 (message "Running %s...OK" command)) 162 ) 163 (set-buffer obuf) 164 status)) 165 )) 166 167;; Following code snarfed from Emacs 21 vc.el and slightly tweaked. 168(defun tramp-vc-do-command-new (buffer okstatus command file &rest flags) 169 "Like `vc-do-command' but for TRAMP files. 170This function is for the new VC which comes with Emacs 21. 171Since TRAMP doesn't do async commands yet, this function doesn't, either." 172 (and file (setq file (expand-file-name file))) 173 (if vc-command-messages 174 (message "Running %s on %s..." command file)) 175 (save-current-buffer 176 (unless (eq buffer t) 177 ; Pacify byte-compiler 178 (funcall (symbol-function 'vc-setup-buffer) buffer)) 179 (let ((squeezed nil) 180 (inhibit-read-only t) 181 (status 0)) 182 (let* ((v (when file (tramp-dissect-file-name file))) 183 (multi-method (when file (tramp-file-name-multi-method v))) 184 (method (when file (tramp-file-name-method v))) 185 (user (when file (tramp-file-name-user v))) 186 (host (when file (tramp-file-name-host v))) 187 (localname (when file (tramp-file-name-localname v)))) 188 (setq squeezed (delq nil (copy-sequence flags))) 189 (when file 190 (setq squeezed (append squeezed (list (file-relative-name 191 file default-directory))))) 192 (let ((w32-quote-process-args t)) 193 (when (eq okstatus 'async) 194 (message "Tramp doesn't do async commands, running synchronously.")) 195 ;; `shell-command' cannot be used; it isn't magic in XEmacs. 196 (setq status (tramp-handle-shell-command 197 (mapconcat 'tramp-shell-quote-argument 198 (cons command squeezed) " ") t)) 199 (when (or (not (integerp status)) 200 (and (integerp okstatus) (< okstatus status))) 201 (pop-to-buffer (current-buffer)) 202 (goto-char (point-min)) 203 (shrink-window-if-larger-than-buffer) 204 (error "Running %s...FAILED (%s)" command 205 (if (integerp status) (format "status %d" status) status)))) 206 (if vc-command-messages 207 (message "Running %s...OK" command)) 208 ; Pacify byte-compiler 209 (funcall (symbol-function 'vc-exec-after) 210 `(run-hook-with-args 211 'vc-post-command-functions ',command ',localname ',flags)) 212 status)))) 213 214 215;; The context for a VC command is the current buffer. 216;; That makes a test on the buffers file more reliable than a test on the 217;; arguments. 218;; This is needed to handle remote VC correctly - else we test against the 219;; local VC system and get things wrong... 220;; Daniel Pittman <daniel@danann.net> 221;;-(if (fboundp 'vc-call-backend) 222;;- () ;; This is the new VC for which we don't have an appropriate advice yet 223;;-) 224(unless (fboundp 'process-file) 225 (if (fboundp 'vc-call-backend) 226 (defadvice vc-do-command 227 (around tramp-advice-vc-do-command 228 (buffer okstatus command file &rest flags) 229 activate) 230 "Invoke tramp-vc-do-command for tramp files." 231 (let ((file (symbol-value 'file))) ;pacify byte-compiler 232 (if (or (and (stringp file) (tramp-tramp-file-p file)) 233 (and (buffer-file-name) (tramp-tramp-file-p (buffer-file-name)))) 234 (setq ad-return-value 235 (apply 'tramp-vc-do-command-new buffer okstatus command 236 file ;(or file (buffer-file-name)) 237 flags)) 238 ad-do-it))) 239 (defadvice vc-do-command 240 (around tramp-advice-vc-do-command 241 (buffer okstatus command file last &rest flags) 242 activate) 243 "Invoke tramp-vc-do-command for tramp files." 244 (let ((file (symbol-value 'file))) ;pacify byte-compiler 245 (if (or (and (stringp file) (tramp-tramp-file-p file)) 246 (and (buffer-file-name) (tramp-tramp-file-p (buffer-file-name)))) 247 (setq ad-return-value 248 (apply 'tramp-vc-do-command buffer okstatus command 249 (or file (buffer-file-name)) last flags)) 250 ad-do-it)))) 251 252 (add-hook 'tramp-unload-hook 253 '(lambda () (ad-unadvise 'vc-do-command)))) 254 255 256;; XEmacs uses this to do some of its work. Like vc-do-command, we 257;; need to enhance it to make VC work via TRAMP-mode. 258;; 259;; Like the previous function, this is a cut-and-paste job from the VC 260;; file. It's based on the vc-do-command code. 261;; CCC: this isn't used in Emacs 21, so do as before. 262(defun tramp-vc-simple-command (okstatus command file &rest args) 263 ;; Simple version of vc-do-command, for use in vc-hooks only. 264 ;; Don't switch to the *vc-info* buffer before running the 265 ;; command, because that would change its default directory 266 (save-match-data 267 (let* ((v (tramp-dissect-file-name (expand-file-name file))) 268 (multi-method (tramp-file-name-multi-method v)) 269 (method (tramp-file-name-method v)) 270 (user (tramp-file-name-user v)) 271 (host (tramp-file-name-host v)) 272 (localname (tramp-file-name-localname v))) 273 (save-excursion (set-buffer (get-buffer-create "*vc-info*")) 274 (erase-buffer)) 275 (let ((exec-path (append vc-path exec-path)) exec-status 276 ;; Add vc-path to PATH for the execution of this command. 277 (process-environment 278 (cons (concat "PATH=" (getenv "PATH") 279 path-separator 280 (mapconcat 'identity vc-path path-separator)) 281 process-environment))) 282 ;; Call the actual process. See tramp-vc-do-command for discussion of 283 ;; why this does both (save-window-excursion) and (save-excursion). 284 ;; 285 ;; As a note, I don't think that the process-environment stuff above 286 ;; has any effect on the remote system. This is a hard one though as 287 ;; there is no real reason to expect local and remote paths to be 288 ;; identical... 289 ;; 290 ;; Daniel Pittman <daniel@danann.net> 291 (save-excursion 292 (save-window-excursion 293 ;; Actually execute remote command 294 ;; `shell-command' cannot be used; it isn't magic in XEmacs. 295 (tramp-handle-shell-command 296 (mapconcat 'tramp-shell-quote-argument 297 (append (list command) args (list localname)) " ") 298 (get-buffer-create"*vc-info*")) 299 ;(tramp-wait-for-output) 300 ;; Get status from command 301 (tramp-send-command multi-method method user host "echo $?") 302 (tramp-wait-for-output) 303 (setq exec-status (read (current-buffer))) 304 (message "Command %s returned status %d." command exec-status))) 305 306 ;; Maybe okstatus can be `async' here. But then, maybe the 307 ;; async thing is new in Emacs 21, but this function is only 308 ;; used in Emacs 20. 309 (cond ((> exec-status okstatus) 310 (switch-to-buffer (get-file-buffer file)) 311 (shrink-window-if-larger-than-buffer 312 (display-buffer "*vc-info*")) 313 (error "Couldn't find version control information"))) 314 exec-status)))) 315 316;; This function does not exist any more in Emacs-21's VC 317(defadvice vc-simple-command 318 (around tramp-advice-vc-simple-command 319 (okstatus command file &rest args) 320 activate) 321 "Invoke tramp-vc-simple-command for tramp files." 322 (let ((file (symbol-value 'file))) ;pacify byte-compiler 323 (if (or (and (stringp file) (tramp-tramp-file-p file)) 324 (and (buffer-file-name) (tramp-tramp-file-p (buffer-file-name)))) 325 (setq ad-return-value 326 (apply 'tramp-vc-simple-command okstatus command 327 (or file (buffer-file-name)) args)) 328 ad-do-it))) 329 330(add-hook 'tramp-unload-hook 331 '(lambda () (ad-unadvise 'vc-simple-command))) 332 333 334;; `vc-workfile-unchanged-p' 335;; This function does not deal well with remote files, so we do the 336;; same as for `vc-do-command'. 337 338;; `vc-workfile-unchanged-p' checks the modification time, we cannot 339;; do that for remote files, so here's a version which relies on diff. 340;; CCC: this one probably works for Emacs 21, too. 341(defun tramp-vc-workfile-unchanged-p 342 (filename &optional want-differences-if-changed) 343 (if (fboundp 'vc-backend-diff) 344 ;; Old VC. Call `vc-backend-diff'. 345 (let ((status (funcall (symbol-function 'vc-backend-diff) 346 filename nil nil 347 (not want-differences-if-changed)))) 348 (zerop status)) 349 ;; New VC. Call `vc-default-workfile-unchanged-p'. 350 (funcall (symbol-function 'vc-default-workfile-unchanged-p) 351 (vc-backend filename) filename))) 352 353(defadvice vc-workfile-unchanged-p 354 (around tramp-advice-vc-workfile-unchanged-p 355 (filename &optional want-differences-if-changed) 356 activate) 357 "Invoke tramp-vc-workfile-unchanged-p for tramp files." 358 (if (and (stringp filename) 359 (tramp-tramp-file-p filename) 360 (not 361 (let ((v (tramp-dissect-file-name filename))) 362 ;; The following check is probably to test whether 363 ;; file-attributes returns correct last modification 364 ;; times. This check needs to be changed. 365 (tramp-get-remote-perl (tramp-file-name-multi-method v) 366 (tramp-file-name-method v) 367 (tramp-file-name-user v) 368 (tramp-file-name-host v))))) 369 (setq ad-return-value 370 (tramp-vc-workfile-unchanged-p filename want-differences-if-changed)) 371 ad-do-it)) 372 373(add-hook 'tramp-unload-hook 374 '(lambda () (ad-unadvise 'vc-workfile-unchanged-p))) 375 376 377;; Redefine a function from vc.el -- allow tramp files. 378;; `save-match-data' seems not to be required -- it isn't in 379;; the original version, either. 380;; CCC: this might need some work -- how does the Emacs 21 version 381;; work, anyway? Does it work over ange-ftp? Hm. 382(if (not (fboundp 'vc-backend-checkout)) 383 () ;; our replacement won't work and is unnecessary anyway 384(defun vc-checkout (filename &optional writable rev) 385 "Retrieve a copy of the latest version of the given file." 386 ;; If ftp is on this system and the name matches the ange-ftp format 387 ;; for a remote file, the user is trying something that won't work. 388 (funcall (symbol-function 'vc-backend-checkout) filename writable rev) 389 (vc-resynch-buffer filename t t)) 390) 391 392 393;; Do we need to advise the vc-user-login-name function anyway? 394;; This will return the correct login name for the owner of a 395;; file. It does not deal with the default remote user name... 396;; 397;; That is, when vc calls (vc-user-login-name), we return the 398;; local login name, something that may be different to the remote 399;; default. 400;; 401;; The remote VC operations will occur as the user that we logged 402;; in with however - not always the same as the local user. 403;; 404;; In the end, I did advise the function. This is because, well, 405;; the thing didn't work right otherwise ;) 406;; 407;; Daniel Pittman <daniel@danann.net> 408 409(defun tramp-handle-vc-user-login-name (&optional uid) 410 "Return the default user name on the remote machine. 411Whenever VC calls this function, `file' is bound to the file name 412in question. If no uid is provided or the uid is equal to the uid 413owning the file, then we return the user name given in the file name. 414 415This should only be called when `file' is bound to the 416filename we are thinking about..." 417 ;; Pacify byte-compiler; this symbol is bound in the calling 418 ;; function. CCC: Maybe it would be better to move the 419 ;; boundness-checking into this function? 420 (let* ((file (symbol-value 'file)) 421 (remote-uid 422 ;; With Emacs 22, `file-attributes' has got an optional parameter 423 ;; ID-FORMAT. Handle this case backwards compatible. 424 (if (and (functionp 'subr-arity) 425 (= 2 (cdr (funcall (symbol-function 'subr-arity) 426 (symbol-function 'file-attributes))))) 427 (nth 2 (file-attributes file 'integer)) 428 (nth 2 (file-attributes file))))) 429 (if (and uid (/= uid remote-uid)) 430 (error "tramp-handle-vc-user-login-name cannot map a uid to a name") 431 (let* ((v (tramp-dissect-file-name (expand-file-name file))) 432 (u (tramp-file-name-user v))) 433 (cond ((stringp u) u) 434 ((vectorp u) (elt u (1- (length u)))) 435 ((null u) (user-login-name)) 436 (t (error "tramp-handle-vc-user-login-name cannot cope!"))))))) 437 438 439;; The following defadvice is no longer necessary after changes in VC 440;; on 2006-01-25, Andre. 441 442(unless (fboundp 'process-file) 443 (defadvice vc-user-login-name 444 (around tramp-vc-user-login-name activate) 445 "Support for files on remote machines accessed by TRAMP." 446 ;; We rely on the fact that `file' is bound when this is called. 447 ;; This appears to be the case everywhere in vc.el and vc-hooks.el 448 ;; as of Emacs 20.5. 449 ;; 450 ;; With Emacs 22, the definition of `vc-user-login-name' has been 451 ;; changed. It doesn't need to be adviced any longer. 452 (let ((file (when (boundp 'file) 453 (symbol-value 'file)))) ;pacify byte-compiler 454 (or (and (stringp file) 455 (tramp-tramp-file-p file) ; tramp file 456 (setq ad-return-value 457 (save-match-data 458 (tramp-handle-vc-user-login-name uid)))) ; get the owner name 459 ad-do-it))) ; else call the original 460 461 (add-hook 'tramp-unload-hook 462 '(lambda () (ad-unadvise 'vc-user-login-name)))) 463 464 465;; Determine the name of the user owning a file. 466(defun tramp-file-owner (filename) 467 "Return who owns FILE (user name, as a string)." 468 (let ((v (tramp-dissect-file-name 469 (expand-file-name filename)))) 470 (if (not (file-exists-p filename)) 471 nil ; file cannot be opened 472 ;; file exists, find out stuff 473 (save-excursion 474 (tramp-send-command 475 (tramp-file-name-multi-method v) (tramp-file-name-method v) 476 (tramp-file-name-user v) (tramp-file-name-host v) 477 (format "%s -Lld %s" 478 (tramp-get-ls-command (tramp-file-name-multi-method v) 479 (tramp-file-name-method v) 480 (tramp-file-name-user v) 481 (tramp-file-name-host v)) 482 (tramp-shell-quote-argument (tramp-file-name-localname v)))) 483 (tramp-wait-for-output) 484 ;; parse `ls -l' output ... 485 ;; ... file mode flags 486 (read (current-buffer)) 487 ;; ... number links 488 (read (current-buffer)) 489 ;; ... uid (as a string) 490 (symbol-name (read (current-buffer))))))) 491 492;; Wire ourselves into the VC infrastructure... 493;; This function does not exist any more in Emacs-21's VC 494;; CCC: it appears that no substitute is needed for Emacs 21. 495(defadvice vc-file-owner 496 (around tramp-vc-file-owner activate) 497 "Support for files on remote machines accessed by TRAMP." 498 (let ((filename (ad-get-arg 0))) 499 (or (and (tramp-file-name-p filename) ; tramp file 500 (setq ad-return-value 501 (save-match-data 502 (tramp-file-owner filename)))) ; get the owner name 503 ad-do-it))) ; else call the original 504 505(add-hook 'tramp-unload-hook 506 '(lambda () (ad-unadvise 'vc-file-owner))) 507 508 509;; We need to make the version control software backend version 510;; information local to the current buffer. This is because each TRAMP 511;; buffer can (theoretically) have a different VC version and I am 512;; *way* too lazy to try and push the correct value into each new 513;; buffer. 514;; 515;; Remote VC costs will just have to be paid, at least for the moment. 516;; Well, at least, they will right until I feel guilty about doing a 517;; botch job here and fix it. :/ 518;; 519;; Daniel Pittman <daniel@danann.net> 520;; CCC: this is probably still needed for Emacs 21. 521(defun tramp-vc-setup-for-remote () 522 "Make the backend release variables buffer local. 523This makes remote VC work correctly at the cost of some processing time." 524 (when (and (buffer-file-name) 525 (tramp-tramp-file-p (buffer-file-name))) 526 (make-local-variable 'vc-rcs-release) 527 (setq vc-rcs-release nil))) 528 529(add-hook 'find-file-hooks 'tramp-vc-setup-for-remote t) 530(add-hook 'tramp-unload-hook 531 '(lambda () 532 (remove-hook 'find-file-hooks 'tramp-vc-setup-for-remote))) 533 534;; No need to load this again if anyone asks. 535(provide 'tramp-vc) 536 537;;; arch-tag: 27cc42ce-da19-468d-ad5c-a2690558db60 538;;; tramp-vc.el ends here 539