vc-hooks.el 37.7 KB
Newer Older
1
;;; vc-hooks.el --- resident support for version-control
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4 5

;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 7 8
;; Modified by:
;;   Per Cederqvist <ceder@lysator.liu.se>
;;   Andre Spiegel <spiegel@berlin.informatik.uni-stuttgart.de>
Eric S. Raymond's avatar
Eric S. Raymond committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

;; This file is part of GNU Emacs.

;; 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 2, 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
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; 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, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

;;; Commentary:

28 29 30
;; This is the always-loaded portion of VC.
;; It takes care VC-related activities that are done when you visit a file,
;; so that vc.el itself is loaded only when you use a VC command.
Eric S. Raymond's avatar
Eric S. Raymond committed
31 32 33 34
;; See the commentary of vc.el.

;;; Code:

35 36 37 38 39 40
;; Customization Variables (the rest is in vc.el)

(defvar vc-default-back-end nil
  "*Back-end actually used by this interface; may be SCCS or RCS.
The value is only computed when needed to avoid an expensive search.")

41 42 43 44
(defvar vc-handle-cvs t
  "*If non-nil, use VC for files managed with CVS.
If it is nil, don't use VC for those files.")

45 46 47 48 49 50
(defvar vc-path
  (if (file-directory-p "/usr/sccs")
      '("/usr/sccs")
    nil)
  "*List of extra directories to search for version control commands.")

Eric S. Raymond's avatar
Eric S. Raymond committed
51 52
(defvar vc-master-templates
  '(("%sRCS/%s,v" . RCS) ("%s%s,v" . RCS) ("%sRCS/%s" . RCS)
Richard M. Stallman's avatar
Richard M. Stallman committed
53 54
    ("%sSCCS/s.%s" . SCCS) ("%ss.%s". SCCS)
    vc-find-cvs-master)
Eric S. Raymond's avatar
Eric S. Raymond committed
55 56 57 58 59
  "*Where to look for version-control master files.
The first pair corresponding to a given back end is used as a template
when creating new masters.")

(defvar vc-make-backup-files nil
60
  "*If non-nil, backups of registered files are made as with other files.
61
If nil (the default), files covered by version control don't get backups.")
Eric S. Raymond's avatar
Eric S. Raymond committed
62

63 64
(defvar vc-display-status t
  "*If non-nil, display revision number and lock status in modeline.
65 66
Otherwise, not displayed.")

67 68 69 70 71 72 73 74
(defvar vc-consult-headers t
  "*Identify work files by searching for version headers.")

(defvar vc-keep-workfiles t
  "*If non-nil, don't delete working files after registering changes.
If the back-end is CVS, workfiles are always kept, regardless of the
value of this flag.")

75 76 77 78 79 80 81 82 83 84
(defvar vc-mistrust-permissions nil
  "*Don't assume that permissions and ownership track version-control status.")

(defun vc-mistrust-permissions (file)
  ;; Access function to the above.
  (or (eq vc-mistrust-permissions 't)
      (and vc-mistrust-permissions
	   (funcall vc-mistrust-permissions 
		    (vc-backend-subdirectory-name file)))))

Eric S. Raymond's avatar
Eric S. Raymond committed
85
;; Tell Emacs about this new kind of minor mode
Eric S. Raymond's avatar
Eric S. Raymond committed
86 87
(if (not (assoc 'vc-mode minor-mode-alist))
    (setq minor-mode-alist (cons '(vc-mode vc-mode)
Eric S. Raymond's avatar
Eric S. Raymond committed
88 89
				 minor-mode-alist)))

Eric S. Raymond's avatar
Eric S. Raymond committed
90
(make-variable-buffer-local 'vc-mode)
91
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
92 93

;; We need a notion of per-file properties because the version
94 95 96 97
;; control state of a file is expensive to derive --- we compute
;; them when the file is initially found, keep them up to date 
;; during any subsequent VC operations, and forget them when
;; the buffer is killed.
Eric S. Raymond's avatar
Eric S. Raymond committed
98

99 100 101
(defmacro vc-error-occurred (&rest body)
  (list 'condition-case nil (cons 'progn (append body '(nil))) '(error t)))

Eric S. Raymond's avatar
Eric S. Raymond committed
102 103 104
(defvar vc-file-prop-obarray [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]
  "Obarray for per-file properties.")

105 106 107
(defvar vc-buffer-backend t)
(make-variable-buffer-local 'vc-buffer-backend)

Eric S. Raymond's avatar
Eric S. Raymond committed
108 109 110 111 112 113 114 115
(defun vc-file-setprop (file property value)
  ;; set per-file property
  (put (intern file vc-file-prop-obarray) property value))

(defun vc-file-getprop (file property)
  ;; get per-file property
  (get (intern file vc-file-prop-obarray) property))

116 117 118
(defun vc-file-clearprops (file)
  ;; clear all properties of a given file
  (setplist (intern file vc-file-prop-obarray) nil))
119

120 121
;;; Functions that determine property values, by examining the 
;;; working file, the master file, or log program output
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174

(defun vc-match-substring (bn)
  (buffer-substring (match-beginning bn) (match-end bn)))

(defun vc-lock-file (file)
  ;; Generate lock file name corresponding to FILE
  (let ((master (vc-name file)))
    (and
     master
     (string-match "\\(.*/\\)s\\.\\(.*\\)" master)
     (concat
      (substring master (match-beginning 1) (match-end 1))
      "p."
      (substring master (match-beginning 2) (match-end 2))))))

(defun vc-parse-buffer (patterns &optional file properties)
  ;; Use PATTERNS to parse information out of the current buffer.
  ;; Each element of PATTERNS is a list of 2 to 3 elements. The first element
  ;; is the pattern to be matched, and the second (an integer) is the 
  ;; number of the subexpression that should be returned. If there's
  ;; a third element (also the number of a subexpression), that 
  ;; subexpression is assumed to be a date field and we want the most
  ;; recent entry matching the template.
  ;; If FILE and PROPERTIES are given, the latter must be a list of
  ;; properties of the same length as PATTERNS; each property is assigned 
  ;; the corresponding value.
  (mapcar (function (lambda (p)
	    (goto-char (point-min))
	    (cond 
	     ((eq (length p) 2)  ;; search for first entry
	      (let ((value nil))
		(if (re-search-forward (car p) nil t)
		    (setq value (vc-match-substring (elt p 1))))
		(if file
		    (progn (vc-file-setprop file (car properties) value)
			   (setq properties (cdr properties))))
		value))
	     ((eq (length p) 3)  ;; search for latest entry
	      (let ((latest-date "") (latest-val))
		(while (re-search-forward (car p) nil t)
		  (let ((date (vc-match-substring (elt p 2))))
		    (if (string< latest-date date)
			(progn
			  (setq latest-date date)
			  (setq latest-val
				(vc-match-substring (elt p 1)))))))
		(if file
		    (progn (vc-file-setprop file (car properties) latest-val)
			   (setq properties (cdr properties))))
		latest-val)))))
	  patterns)
  )

175 176 177 178 179 180 181
(defun vc-insert-file (file &optional limit blocksize)
  ;; Insert the contents of FILE into the current buffer.
  ;; Optional argument LIMIT is a regexp. If present,
  ;; the file is inserted in chunks of size BLOCKSIZE
  ;; (default 8 kByte), until the first occurence of
  ;; LIMIT is found. The function returns nil if FILE 
  ;; doesn't exist.
182
  (erase-buffer)
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
  (cond ((file-exists-p file)
	 (cond (limit
		(if (not blocksize) (setq blocksize 8192))
		(let (found s)
		  (while (not found)
		    (setq s (buffer-size))
		    (goto-char (1+ s))
		    (setq found 
			  (or (zerop (car (cdr 
			      (insert-file-contents file nil s 
			       (+ s blocksize)))))
			      (progn (beginning-of-line)
				     (re-search-forward limit nil t)))))))
	       (t (insert-file-contents file)))
	 (set-buffer-modified-p nil)
	 (auto-save-mode nil)
	 t)
	(t nil)))

(defun vc-parse-locks (file locks)
  ;; Parse RCS or SCCS locks.
  ;; The result is a list of the form ((VERSION USER) (VERSION USER) ...),
  ;; which is returned and stored into the property `vc-master-locks'.
  (if (not locks) 
      (vc-file-setprop file 'vc-master-locks 'none)
    (let ((found t) (index 0) master-locks version user)
      (cond ((eq (vc-backend file) 'SCCS)
	     (while (string-match "^\\([0-9.]+\\) [0-9.]+ \\([^ ]+\\) .*\n?"
				   locks index)
	       (setq version (substring locks 
					(match-beginning 1) (match-end 1)))
	       (setq user (substring locks 
				     (match-beginning 2) (match-end 2)))
	       (setq master-locks (append master-locks 
					  (list (cons version user))))
	       (setq index (match-end 0))))
	    ((eq (vc-backend file) 'RCS)
	     (while (string-match "[ \t\n]*\\([^:]+\\):\\([0-9.]+\\)"
				  locks index)
	       (setq version (substring locks 
					(match-beginning 2) (match-end 2)))
	       (setq user (substring locks 
				     (match-beginning 1) (match-end 1)))
	       (setq master-locks (append master-locks 
					  (list (cons version user))))
228 229 230 231
	       (setq index (match-end 0)))
	     (if (string-match ";[ \t\n]+strict;" locks index)
		 (vc-file-setprop file 'vc-checkout-model 'manual)
	       (vc-file-setprop file 'vc-checkout-model 'implicit))))
232 233
      (vc-file-setprop file 'vc-master-locks (or master-locks 'none)))))

234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
(defun vc-simple-command (okstatus command file &rest args)
  ;; Simple version of vc-do-command, for use in vc-hooks only.
  ;; Don't switch to the *vc-info* buffer before running the
  ;; command, because that would change its default directory
  (save-excursion (set-buffer (get-buffer-create "*vc-info*"))
		  (erase-buffer))
  (let ((exec-path (append vc-path exec-path)) exec-status
	;; Add vc-path to PATH for the execution of this command.
	(process-environment
	 (cons (concat "PATH=" (getenv "PATH")
		       path-separator 
		       (mapconcat 'identity vc-path path-separator))
	       process-environment)))
    (setq exec-status 
	  (apply 'call-process command nil "*vc-info*" nil 
		 (append args (list file))))
    (cond ((> exec-status okstatus)
	   (switch-to-buffer (get-file-buffer file))
	   (shrink-window-if-larger-than-buffer
	    (display-buffer "*vc-info*"))
	   (error "Couldn't find version control information")))
    exec-status))

257 258
(defun vc-fetch-master-properties (file)
  ;; Fetch those properties of FILE that are stored in the master file.
259 260 261 262
  ;; For an RCS file, we don't get vc-latest-version vc-your-latest-version
  ;; here because that is slow.
  ;; That gets done if/when the functions vc-latest-version
  ;; and vc-your-latest-version get called.
263 264 265 266 267
  (save-excursion
    (cond
     ((eq (vc-backend file) 'SCCS)
      (set-buffer (get-buffer-create "*vc-info*"))
      (if (vc-insert-file (vc-lock-file file))
268
	  (vc-parse-locks file (buffer-string))
269 270 271 272 273 274 275 276 277 278 279
	(vc-file-setprop file 'vc-master-locks 'none))
      (vc-insert-file (vc-name file) "^\001e")
      (vc-parse-buffer 
       (list '("^\001d D \\([^ ]+\\)" 1)
	     (list (concat "^\001d D \\([^ ]+\\) .* " 
			   (regexp-quote (user-login-name)) " ") 1))
       file
       '(vc-latest-version vc-your-latest-version)))

     ((eq (vc-backend file) 'RCS)
      (set-buffer (get-buffer-create "*vc-info*"))
280
      (vc-insert-file (vc-name file) "^[0-9]")
281 282 283
      (vc-parse-buffer 
       (list '("^head[ \t\n]+\\([^;]+\\);" 1)
	     '("^branch[ \t\n]+\\([^;]+\\);" 1)
284
	     '("^locks[ \t\n]*\\([^;]*;\\([ \t\n]*strict;\\)?\\)" 1))
285 286 287
       file
       '(vc-head-version
	 vc-default-branch
288
	 vc-master-locks))
289 290 291
      ;; determine vc-master-workfile-version: it is either the head
      ;; of the trunk, the head of the default branch, or the 
      ;; "default branch" itself, if that is a full revision number.
292 293 294 295
      (let ((default-branch (vc-file-getprop file 'vc-default-branch)))
	(cond 
	 ;; no default branch
	 ((or (not default-branch) (string= "" default-branch))
296
	  (vc-file-setprop file 'vc-master-workfile-version 
297 298 299 300
			   (vc-file-getprop file 'vc-head-version)))
	 ;; default branch is actually a revision
	 ((string-match "^[0-9]+\\.[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*$" 
			default-branch)
301 302
	  (vc-file-setprop file 'vc-master-workfile-version default-branch))
	 ;; else, search for the head of the default branch
303
	 (t (vc-insert-file (vc-name file) "^desc")
304
	    (vc-parse-buffer (list (list 
305 306 307
	       (concat "^\\(" 
		       (regexp-quote default-branch)
		       "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2))
308
			 file '(vc-master-workfile-version)))))
309 310 311 312
      ;; translate the locks
      (vc-parse-locks file (vc-file-getprop file 'vc-master-locks)))

     ((eq (vc-backend file) 'CVS)
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
      (save-excursion
	(vc-simple-command 0 "cvs" file "status")
	(set-buffer (get-buffer "*vc-info*"))
	(vc-parse-buffer     
	 ;; CVS 1.3 says "RCS Version:", other releases "RCS Revision:",
	 ;; and CVS 1.4a1 says "Repository revision:".
	 '(("\\(RCS Version\\|RCS Revision\\|Repository revision\\):[\t ]+\\([0-9.]+\\)" 2)
	   ("^File: [^ \t]+[ \t]+Status: \\(.*\\)" 1))
	 file
	 '(vc-latest-version vc-cvs-status))
	;; Translate those status values that we understand into symbols.
	;; Any other value is converted to nil.
	(let ((status (vc-file-getprop file 'vc-cvs-status)))
	 (cond 
	  ((string-match "Up-to-date" status)
	   (vc-file-setprop file 'vc-cvs-status 'up-to-date)
	   (vc-file-setprop file 'vc-checkout-time 
			    (nth 5 (file-attributes file))))
	  ((vc-file-setprop file 'vc-cvs-status
332 333 334 335 336 337
	    (cond 
	     ((string-match "Locally Modified"    status) 'locally-modified)
	     ((string-match "Needs Merge"         status) 'needs-merge)
	     ((string-match "Needs Checkout"      status) 'needs-checkout)
	     ((string-match "Unresolved Conflict" status) 'unresolved-conflict)
	     ((string-match "Locally Added"       status) 'locally-added)
338
	     ))))))))
339 340
    (if (get-buffer "*vc-info*")
	(kill-buffer (get-buffer "*vc-info*")))))
341 342 343 344 345 346 347 348 349 350 351 352 353 354

;;; Functions that determine property values, by examining the 
;;; working file, the master file, or log program output

(defun vc-consult-rcs-headers (file)
  ;; Search for RCS headers in FILE, and set properties
  ;; accordingly.  This function can be disabled by setting
  ;; vc-consult-headers to nil.  
  ;; Returns: nil            if no headers were found 
  ;;                         (or if the feature is disabled,
  ;;                         or if there is currently no buffer 
  ;;                         visiting FILE)
  ;;          'rev           if a workfile revision was found
  ;;          'rev-and-lock  if revision and lock info was found 
355
  (cond
356
   ((or (not vc-consult-headers) 
357
	(not (get-file-buffer file))) nil)
358 359
   ((let (status version locking-user)
     (save-excursion
360 361 362 363 364
      (set-buffer (get-file-buffer file))
      (goto-char (point-min))
      (cond  
       ;; search for $Id or $Header
       ;; -------------------------
365 366 367
       ((or (and (search-forward "$Id: " nil t)
		 (looking-at "[^ ]+ \\([0-9.]+\\) "))
	    (and (progn (goto-char (point-min))
368
			(search-forward "$Header: " nil t))
369
		 (looking-at "[^ ]+ \\([0-9.]+\\) ")))
370
	(goto-char (match-end 0))
371
	;; if found, store the revision number ...
372 373 374 375 376 377 378 379
	(setq version (buffer-substring (match-beginning 1) (match-end 1)))
	;; ... and check for the locking state
	(cond 
	 ((looking-at
	   (concat "[0-9]+[/-][01][0-9][/-][0-3][0-9] "             ; date
	    "[0-2][0-9]:[0-5][0-9]+:[0-6][0-9]+\\([+-][0-9:]+\\)? " ; time
	           "[^ ]+ [^ ]+ "))                       ; author & state
	  (goto-char (match-end 0)) ; [0-6] in regexp handles leap seconds
380
	  (cond 
381 382 383 384 385 386 387 388 389 390 391 392 393 394
	   ;; unlocked revision
	   ((looking-at "\\$")
	    (setq locking-user 'none)
	    (setq status 'rev-and-lock))
	   ;; revision is locked by some user
	   ((looking-at "\\([^ ]+\\) \\$")
	    (setq locking-user
		  (buffer-substring (match-beginning 1) (match-end 1)))
	    (setq status 'rev-and-lock))
	   ;; everything else: false
	   (nil)))
	 ;; unexpected information in
	 ;; keyword string --> quit
	 (nil)))
395 396 397 398 399 400
       ;; search for $Revision
       ;; --------------------
       ((re-search-forward (concat "\\$" 
				   "Revision: \\([0-9.]+\\) \\$")
			   nil t)
	;; if found, store the revision number ...
401 402 403 404 405 406
	(setq version (buffer-substring (match-beginning 1) (match-end 1)))
	;; and see if there's any lock information
	(goto-char (point-min))
	(if (re-search-forward (concat "\\$" "Locker:") nil t)
	    (cond ((looking-at " \\([^ ]+\\) \\$")
		   (setq locking-user (buffer-substring (match-beginning 1)
407
							(match-end 1)))
408 409 410 411 412 413 414 415
		   (setq status 'rev-and-lock))
		  ((looking-at " *\\$") 
		   (setq locking-user 'none)
		   (setq status 'rev-and-lock))
		  (t 
		   (setq locking-user 'none)
		   (setq status 'rev-and-lock)))
	  (setq status 'rev)))
416 417
       ;; else: nothing found
       ;; -------------------
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
       (t nil)))
     (if status (vc-file-setprop file 'vc-workfile-version version))
     (and (eq status 'rev-and-lock)
	  (eq (vc-backend file) 'RCS)
	  (vc-file-setprop file 'vc-locking-user locking-user)
	  ;; If the file has headers, we don't want to query the master file,
	  ;; because that would eliminate all the performance gain the headers
	  ;; brought us.  We therefore use a heuristic for the checkout model 
	  ;; now:  If we trust the file permissions, and the file is not 
          ;; locked, then if the file is read-only the checkout model is 
	  ;; `manual', otherwise `implicit'.
	  (not (vc-mistrust-permissions file))
	  (not (vc-locking-user file))
	  (if (string-match ".r-..-..-." (nth 8 (file-attributes file)))
	      (vc-file-setprop file 'vc-checkout-model 'manual)
433 434
	    (vc-file-setprop file 'vc-checkout-model 'implicit)))
     status))))
435

436 437 438 439 440 441 442 443 444
;;; Access functions to file properties
;;; (Properties should be _set_ using vc-file-setprop, but
;;; _retrieved_ only through these functions, which decide
;;; if the property is already known or not. A property should
;;; only be retrieved by vc-file-getprop if there is no 
;;; access function.)

;;; properties indicating the backend 
;;; being used for FILE
445 446 447 448 449 450 451 452 453

(defun vc-backend-subdirectory-name (&optional file)
  ;; Where the master and lock files for the current directory are kept
  (symbol-name
   (or
    (and file (vc-backend file))
    vc-default-back-end
    (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))))

454 455 456 457 458 459 460 461
(defun vc-name (file)
  "Return the master name of a file, nil if it is not registered."
  (or (vc-file-getprop file 'vc-name)
      (let ((name-and-type (vc-registered file)))
	(if name-and-type
	    (progn
	      (vc-file-setprop file 'vc-backend (cdr name-and-type))
	      (vc-file-setprop file 'vc-name (car name-and-type)))))))
462

463 464 465 466 467 468 469 470 471
(defun vc-backend (file)
  "Return the version-control type of a file, nil if it is not registered."
  (and file
       (or (vc-file-getprop file 'vc-backend)
	   (let ((name-and-type (vc-registered file)))
	     (if name-and-type
		 (progn
		   (vc-file-setprop file 'vc-name (car name-and-type))
		   (vc-file-setprop file 'vc-backend (cdr name-and-type))))))))
472

473 474
(defun vc-checkout-model (file)
  ;; Return `manual' if the user has to type C-x C-q to check out FILE.
475 476 477 478 479 480 481 482 483 484 485 486 487 488
  ;; Return `implicit' if the file can be modified without locking it first.
  (or
   (vc-file-getprop file 'vc-checkout-model)
   (cond 
    ((eq (vc-backend file) 'SCCS)
     (vc-file-setprop file 'vc-checkout-model 'manual))
    ((eq (vc-backend file) 'RCS) 
     (vc-consult-rcs-headers file)
     (or (vc-file-getprop file 'vc-checkout-model)
	 (progn (vc-fetch-master-properties file)
		(vc-file-getprop file 'vc-checkout-model))))
    ((eq (vc-backend file) 'CVS)
     (vc-file-setprop file 'vc-checkout-model
		      (if (getenv "CVSREAD") 'manual 'implicit))))))
489

490
;;; properties indicating the locking state
491 492 493 494 495

(defun vc-cvs-status (file)
  ;; Return the cvs status of FILE
  ;; (Status field in output of "cvs status")
  (cond ((vc-file-getprop file 'vc-cvs-status))
496
	(t (vc-fetch-master-properties file)
497 498
	   (vc-file-getprop file 'vc-cvs-status))))

499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
(defun vc-master-locks (file)
  ;; Return the lock entries in the master of FILE.
  ;; Return 'none if there are no such entries, and a list
  ;; of the form ((VERSION USER) (VERSION USER) ...) otherwise.
  (cond ((vc-file-getprop file 'vc-master-locks))
	(t (vc-fetch-master-properties file)
	   (vc-file-getprop file 'vc-master-locks))))

(defun vc-master-locking-user (file)
  ;; Return the master file's idea of who is locking 
  ;; the current workfile version of FILE.  
  ;; Return 'none if it is not locked.
  (let ((master-locks (vc-master-locks file)) lock)
    (if (eq master-locks 'none) 'none
      ;; search for a lock on the current workfile version
      (setq lock (assoc (vc-workfile-version file) master-locks))
      (cond (lock (cdr lock))
	    ('none)))))

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
(defun vc-lock-from-permissions (file)
  ;; If the permissions can be trusted for this file, determine the
  ;; locking state from them.  Returns (user-login-name), `none', or nil.
   ;;   This implementation assumes that any file which is under version
  ;; control and has -rw-r--r-- is locked by its owner.  This is true
  ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
  ;; We have to be careful not to exclude files with execute bits on;
  ;; scripts can be under version control too.  Also, we must ignore the
  ;; group-read and other-read bits, since paranoid users turn them off.
  ;;   This hack wins because calls to the somewhat expensive 
  ;; `vc-fetch-master-properties' function only have to be made if 
  ;; (a) the file is locked by someone other than the current user, 
  ;; or (b) some untoward manipulation behind vc's back has changed 
  ;; the owner or the `group' or `other' write bits.
  (let ((attributes (file-attributes file)))
    (if (not (vc-mistrust-permissions file))
	(cond ((string-match ".r-..-..-." (nth 8 attributes))
	       (vc-file-setprop file 'vc-locking-user 'none))
	      ((and (= (nth 2 attributes) (user-uid))
		    (string-match ".rw..-..-." (nth 8 attributes)))
	       (vc-file-setprop file 'vc-locking-user (user-login-name)))
	      (nil)))))

(defun vc-file-owner (file)
  ;; The expression below should return the username of the owner
  ;; of the file.  It doesn't.  It returns the username if it is
  ;; you, or otherwise the UID of the owner of the file.  The
  ;; return value from this function is only used by
  ;; vc-dired-reformat-line, and it does the proper thing if a UID
  ;; is returned.
  ;; The *proper* way to fix this would be to implement a built-in
  ;; function in Emacs, say, (username UID), that returns the
  ;; username of a given UID.
  ;; The result of this hack is that vc-directory will print the
  ;; name of the owner of the file for any files that are
  ;; modified.
  (let ((uid (nth 2 (file-attributes file))))
    (if (= uid (user-uid)) (user-login-name) uid)))

(defun vc-rcs-lock-from-diff (file)
  ;; Diff the file against the master version.  If differences are found,
  ;; mark the file locked.  This is only meaningful for RCS with non-strict
  ;; locking.
  (if (zerop (vc-simple-command 1 "rcsdiff" file
	       "--brief"  ; Some diffs don't understand "--brief", but
	                  ; for non-strict locking under VC we require it.
	       (concat "-r" (vc-workfile-version file))))
      (vc-file-setprop file 'vc-locking-user 'none)
    (vc-file-setprop file 'vc-locking-user (vc-file-owner file))))

568
(defun vc-locking-user (file)
569
  ;; Return the name of the person currently holding a lock on FILE.
570 571
  ;; Return nil if there is no such person.  (Sometimes, not the name
  ;; of the locking user but his uid will be returned.)
572
  ;;   Under CVS, a file is considered locked if it has been modified since
573
  ;; it was checked out.
574 575
  ;;   The property is cached.  It is only looked up if it is currently nil.
  ;; Note that, for a file that is not locked, the actual property value
576
  ;; is `none', to distinguish it from an unknown locking state.  That value
577 578 579 580 581 582 583 584 585
  ;; is converted to nil by this function, and returned to the caller.
  (let ((locking-user (vc-file-getprop file 'vc-locking-user)))
    (if locking-user
	;; if we already know the property, return it
	(if (eq locking-user 'none) nil locking-user)

      ;; otherwise, infer the property...
      (cond
       ((eq (vc-backend file) 'CVS)
586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
	(or (and (eq (vc-checkout-model file) 'manual)
		 (vc-lock-from-permissions file))
	    (if (or (eq (vc-cvs-status file) 'up-to-date)
		    (eq (vc-cvs-status file) 'needs-checkout))
		(vc-file-setprop file 'vc-locking-user 'none)
	      (vc-file-setprop file 'vc-locking-user (vc-file-owner file)))))

       ((eq (vc-backend file) 'RCS)
	(let (p-lock)

	  ;; Check for RCS headers first
	  (or (eq (vc-consult-rcs-headers file) 'rev-and-lock)

	      ;; If there are no headers, try to learn it 
	      ;; from the permissions.
	      (and (setq p-lock (vc-lock-from-permissions file))
		   (if (eq p-lock 'none)

		       ;; If the permissions say "not locked", we know
		       ;; that the checkout model must be `manual'.
		       (vc-file-setprop file 'vc-checkout-model 'manual)

		     ;; If the permissions say "locked", we can only trust
		     ;; this *if* the checkout model is `manual'.
		     (eq (vc-checkout-model file) 'manual)))

	      ;; Otherwise, use lock information from the master file.
	      (vc-file-setprop file 'vc-locking-user
			       (vc-master-locking-user file)))

	  ;; Finally, if the file is not explicitly locked
	  ;; it might still be locked implicitly.
	  (and (eq (vc-file-getprop file 'vc-locking-user) 'none)
	       (eq (vc-checkout-model file) 'implicit)
	       (vc-rcs-lock-from-diff file))))

      ((eq (vc-backend file) 'SCCS)
       (or (vc-lock-from-permissions file)
	   (vc-file-setprop file 'vc-locking-user 
			    (vc-master-locking-user file))))))
  
      ;; convert a possible 'none value
      (setq locking-user (vc-file-getprop file 'vc-locking-user))
      (if (eq locking-user 'none) nil locking-user)))
630 631

;;; properties to store current and recent version numbers
632 633 634

(defun vc-latest-version (file)
  ;; Return version level of the latest version of FILE
635
  (cond ((vc-file-getprop file 'vc-latest-version))
636
	(t (vc-fetch-properties file)
637
	   (vc-file-getprop file 'vc-latest-version))))
638 639 640

(defun vc-your-latest-version (file)
  ;; Return version level of the latest version of FILE checked in by you
641
  (cond ((vc-file-getprop file 'vc-your-latest-version))
642
	(t (vc-fetch-properties file)
643
	   (vc-file-getprop file 'vc-your-latest-version))))
644

645 646
(defun vc-master-workfile-version (file)
  ;; Return the master file's idea of what is the current workfile version.
647
  ;; This property is defined for RCS only.
648
  (cond ((vc-file-getprop file 'vc-master-workfile-version))
649
	(t (vc-fetch-master-properties file)
650
	   (vc-file-getprop file 'vc-master-workfile-version))))
651

652 653 654
(defun vc-fetch-properties (file)
  ;; Fetch vc-latest-version and vc-your-latest-version
  ;; if that wasn't already done.
655 656
  (cond
   ((eq (vc-backend file) 'RCS)
657 658 659 660 661 662 663 664 665 666
    (save-excursion
      (set-buffer (get-buffer-create "*vc-info*"))
      (vc-insert-file (vc-name file) "^desc")
      (vc-parse-buffer 
       (list '("^\\([0-9]+\\.[0-9.]+\\)\ndate[ \t]+\\([0-9.]+\\);" 1 2)
	     (list (concat "^\\([0-9]+\\.[0-9.]+\\)\n"
			   "date[ \t]+\\([0-9.]+\\);[ \t]+"
			   "author[ \t]+"
			   (regexp-quote (user-login-name)) ";") 1 2))
       file
667 668 669
       '(vc-latest-version vc-your-latest-version))
      (if (get-buffer "*vc-info*")
	  (kill-buffer (get-buffer "*vc-info*")))))
670
   (t (vc-fetch-master-properties file))
671 672
   ))

673 674 675 676
(defun vc-workfile-version (file)
  ;; Return version level of the current workfile FILE
  ;; This is attempted by first looking at the RCS keywords.
  ;; If there are no keywords in the working file, 
677
  ;; vc-master-workfile-version is taken.
678 679 680 681 682 683 684 685
  ;; Note that this property is cached, that is, it is only 
  ;; looked up if it is nil.
  ;; For SCCS, this property is equivalent to vc-latest-version.
  (cond ((vc-file-getprop file 'vc-workfile-version))
	((eq (vc-backend file) 'SCCS) (vc-latest-version file))
	((eq (vc-backend file) 'RCS)
	 (if (vc-consult-rcs-headers file)
	     (vc-file-getprop file 'vc-workfile-version)
686
	   (let ((rev (cond ((vc-master-workfile-version file))
687 688 689 690 691 692
			    ((vc-latest-version file)))))
	     (vc-file-setprop file 'vc-workfile-version rev)
	     rev)))
	((eq (vc-backend file) 'CVS)
	 (if (vc-consult-rcs-headers file)   ;; CVS
	     (vc-file-getprop file 'vc-workfile-version)
693 694 695
	   (catch 'found
	     (vc-find-cvs-master (file-name-directory file)
				 (file-name-nondirectory file)))
696
	   (vc-file-getprop file 'vc-workfile-version)))))
697

Eric S. Raymond's avatar
Eric S. Raymond committed
698 699 700
;;; actual version-control code starts here

(defun vc-registered (file)
701 702
  (let (handler handlers)
    (if (boundp 'file-name-handler-alist)
703
	(setq handler (find-file-name-handler file 'vc-registered)))
704 705 706 707 708 709 710 711
    (if handler
	(funcall handler 'vc-registered file)
      ;; Search for a master corresponding to the given file
      (let ((dirname (or (file-name-directory file) ""))
	    (basename (file-name-nondirectory file)))
	(catch 'found
	  (mapcar
	   (function (lambda (s)
Richard M. Stallman's avatar
Richard M. Stallman committed
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
	      (if (atom s)
		  (funcall s dirname basename)
		(let ((trial (format (car s) dirname basename)))
		  (if (and (file-exists-p trial)
			   ;; Make sure the file we found with name
			   ;; TRIAL is not the source file itself.
			   ;; That can happen with RCS-style names
			   ;; if the file name is truncated
			   ;; (e.g. to 14 chars).  See if either
			   ;; directory or attributes differ.
			   (or (not (string= dirname
					     (file-name-directory trial)))
			       (not (equal
				     (file-attributes file)
				     (file-attributes trial)))))
		      (throw 'found (cons trial (cdr s))))))))
728 729
	   vc-master-templates)
	  nil)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
730

Richard M. Stallman's avatar
Richard M. Stallman committed
731 732 733 734 735
(defun vc-find-cvs-master (dirname basename)
  ;; Check if DIRNAME/BASENAME is handled by CVS.
  ;; If it is, do a (throw 'found (cons MASTER 'CVS)).
  ;; Note: If the file is ``cvs add''ed but not yet ``cvs commit''ed 
  ;; the MASTER will not actually exist yet.  The other parts of VC
736
  ;; checks for this condition.  This function returns nil if 
Richard M. Stallman's avatar
Richard M. Stallman committed
737
  ;; DIRNAME/BASENAME is not handled by CVS.
738 739
  (if (and vc-handle-cvs
	   (file-directory-p (concat dirname "CVS/"))
740 741
	   (file-readable-p (concat dirname "CVS/Entries"))
	   (file-readable-p (concat dirname "CVS/Repository")))
742
      (let (buffer (fold case-fold-search))
Richard M. Stallman's avatar
Richard M. Stallman committed
743 744
	(unwind-protect
	    (save-excursion
745 746
	      (setq buffer (set-buffer (get-buffer-create "*vc-info*")))
	      (vc-insert-file (concat dirname "CVS/Entries"))
Richard M. Stallman's avatar
Richard M. Stallman committed
747
	      (goto-char (point-min))
748 749 750
	      ;; make sure the file name is searched 
	      ;; case-sensitively
	      (setq case-fold-search nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
751 752 753 754
	      (cond
	       ((re-search-forward
		 (concat "^/" (regexp-quote basename) "/\\([^/]*\\)/")
		 nil t)
755
		(setq case-fold-search fold)  ;; restore the old value
Richard M. Stallman's avatar
Richard M. Stallman committed
756 757 758
		;; We found it.  Store away version number, now
		;; that we are anyhow so close to finding it.
		(vc-file-setprop (concat dirname basename) 
759
				 'vc-workfile-version
Richard M. Stallman's avatar
Richard M. Stallman committed
760 761
				 (buffer-substring (match-beginning 1)
						   (match-end 1)))
762
		(vc-insert-file (concat dirname "CVS/Repository"))
Richard M. Stallman's avatar
Richard M. Stallman committed
763 764 765 766 767 768
		(let ((master
		       (concat (file-name-as-directory 
				(buffer-substring (point-min)
						  (1- (point-max))))
			       basename
			       ",v")))
769 770 771
		  (throw 'found (cons master 'CVS))))
	       (t (setq case-fold-search fold)  ;; restore the old value
		  nil)))
772
	  (kill-buffer buffer)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
773

774 775 776
(defun vc-buffer-backend ()
  "Return the version-control type of the visited file, or nil if none."
  (if (eq vc-buffer-backend t)
777
      (setq vc-buffer-backend (vc-backend (buffer-file-name)))
778 779
    vc-buffer-backend))

780
(defun vc-toggle-read-only (&optional verbose)
781 782 783
  "Change read-only status of current buffer, perhaps via version control.
If the buffer is visiting a file registered with version control,
then check the file in or out.  Otherwise, just change the read-only flag
784
of the buffer.  With prefix argument, ask for version number."
785
  (interactive "P")
786
  (if (vc-backend (buffer-file-name))
787
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
788
    (toggle-read-only)))
789
(define-key global-map "\C-x\C-q" 'vc-toggle-read-only)
Eric S. Raymond's avatar
Eric S. Raymond committed
790

791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
(defun vc-after-save ()
  ;; Function to be called by basic-save-buffer (in files.el).
  ;; If the file in the current buffer is under version control,
  ;; not locked, and the checkout model for it is `implicit',
  ;; mark it "locked" and redisplay the mode line.
  (let ((file (buffer-file-name)))
    (and (vc-file-getprop file 'vc-backend)
	 ;; ...check the property directly, not through the function of the
	 ;; same name.  Otherwise Emacs would check for a master file
	 ;; each time a non-version-controlled buffer is saved.
	 ;; The property is computed when the file is visited, so if it
	 ;; is `nil' now, it is certain that the file is NOT 
	 ;; version-controlled.
	 (not (vc-locking-user file))
	 (eq (vc-checkout-model file) 'implicit)
	 (vc-file-setprop file 'vc-locking-user (user-login-name))
	 (vc-mode-line file))))
808

Eric S. Raymond's avatar
Eric S. Raymond committed
809
(defun vc-mode-line (file &optional label)
Eric S. Raymond's avatar
Eric S. Raymond committed
810
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
811
The value is set in the current buffer, which should be the buffer
812 813
visiting FILE.  Second optional arg LABEL is put in place of version
control system name."
814
  (interactive (list buffer-file-name nil))
815
  (let ((vc-type (vc-backend file)))
816
    (setq vc-mode
817 818 819 820 821
	  (and vc-type
	       (concat " " (or label (symbol-name vc-type)) 
		       (and vc-display-status (vc-status file)))))
    (and vc-type 
	 (equal file (buffer-file-name))
822 823 824 825 826 827
	 (vc-locking-user file)
	 ;; If the file is locked by some other user, make
	 ;; the buffer read-only.  Like this, even root
	 ;; cannot modify a file without locking it first.
	 (not (string= (user-login-name) (vc-locking-user file)))
	 (setq buffer-read-only t))
828 829 830
    (force-mode-line-update)
    ;;(set-buffer-modified-p (buffer-modified-p)) ;;use this if Emacs 18
    vc-type))
Eric S. Raymond's avatar
Eric S. Raymond committed
831

832
(defun vc-status (file)
833
  ;; Return string for placement in modeline by `vc-mode-line'.
834
  ;; Format:
835
  ;;
836 837 838 839
  ;;   "-REV"        if the revision is not locked
  ;;   ":REV"        if the revision is locked by the user
  ;;   ":LOCKER:REV" if the revision is locked by somebody else
  ;;   " @@"         for a CVS file that is added, but not yet committed
Richard M. Stallman's avatar
Richard M. Stallman committed
840
  ;;
841 842
  ;; In the CVS case, a "locked" working file is a 
  ;; working file that is modified with respect to the master.
843 844
  ;; The file is "locked" from the moment when the user saves
  ;; the modified buffer.
845 846 847 848 849 850 851
  ;; 
  ;; This function assumes that the file is registered.

  (let ((locker (vc-locking-user file))
	(rev (vc-workfile-version file)))
    (cond ((string= "0" rev)
	   " @@")
852 853 854 855 856
	  ((not locker)
	   (concat "-" rev))
	  ((if (stringp locker)
	       (string= locker (user-login-name))
	     (= locker (user-uid)))
857 858 859
	   (concat ":" rev))
	  (t 
	   (concat ":" locker ":" rev)))))
860

Eric S. Raymond's avatar
Eric S. Raymond committed
861 862
;;; install a call to the above as a find-file hook
(defun vc-find-file-hook ()
863 864
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
865 866 867 868
  (cond 
   (buffer-file-name
    (vc-file-clearprops buffer-file-name)
    (cond
869
     ((vc-backend buffer-file-name)
870 871 872 873 874
      (vc-mode-line buffer-file-name)
      (cond ((not vc-make-backup-files)
	     ;; Use this variable, not make-backup-files,
	     ;; because this is for things that depend on the file name.
	     (make-local-variable 'backup-inhibited)
875 876 877 878 879 880 881
	     (setq backup-inhibited t))))
     ((let* ((link (file-symlink-p buffer-file-name))
	     (link-type (and link (vc-backend link))))
	(if link-type
	    (message
	     "Warning: symbolic link to %s-controlled source file"
	     link-type))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
882

883
(add-hook 'find-file-hooks 'vc-find-file-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
884 885 886 887 888

;;; more hooks, this time for file-not-found
(defun vc-file-not-found-hook ()
  "When file is not found, try to check it out from RCS or SCCS.
Returns t if checkout was successful, nil otherwise."
889
  (if (vc-backend buffer-file-name)
890
      (save-excursion
Eric S. Raymond's avatar
Eric S. Raymond committed
891
	(require 'vc)
892
	(setq default-directory (file-name-directory (buffer-file-name)))
Eric S. Raymond's avatar
Eric S. Raymond committed
893 894
	(not (vc-error-occurred (vc-checkout buffer-file-name))))))

895
(add-hook 'find-file-not-found-hooks 'vc-file-not-found-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
896

897 898 899 900 901 902 903 904 905
;; Discard info about a file when we kill its buffer.
(defun vc-kill-buffer-hook ()
  (if (stringp (buffer-file-name))
      (progn
	(vc-file-clearprops (buffer-file-name))
	(kill-local-variable 'vc-buffer-backend))))

;;;(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)

Eric S. Raymond's avatar
Eric S. Raymond committed
906
;;; Now arrange for bindings and autoloading of the main package.
Eric S. Raymond's avatar
Eric S. Raymond committed
907 908
;;; Bindings for this have to go in the global map, as we'll often
;;; want to call them from random buffers.
Eric S. Raymond's avatar
Eric S. Raymond committed
909 910 911 912 913 914 915 916

(setq vc-prefix-map (lookup-key global-map "\C-xv"))
(if (not (keymapp vc-prefix-map))
    (progn
      (setq vc-prefix-map (make-sparse-keymap))
      (define-key global-map "\C-xv" vc-prefix-map)
      (define-key vc-prefix-map "a" 'vc-update-change-log)
      (define-key vc-prefix-map "c" 'vc-cancel-version)
917
      (define-key vc-prefix-map "d" 'vc-directory)
Eric S. Raymond's avatar
Eric S. Raymond committed
918 919 920 921 922 923 924
      (define-key vc-prefix-map "h" 'vc-insert-headers)
      (define-key vc-prefix-map "i" 'vc-register)
      (define-key vc-prefix-map "l" 'vc-print-log)
      (define-key vc-prefix-map "r" 'vc-retrieve-snapshot)
      (define-key vc-prefix-map "s" 'vc-create-snapshot)
      (define-key vc-prefix-map "u" 'vc-revert-buffer)
      (define-key vc-prefix-map "v" 'vc-next-action)
925
      (define-key vc-prefix-map "=" 'vc-diff)
926 927
      (define-key vc-prefix-map "~" 'vc-version-other-window)))

928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955
(if (not (boundp 'vc-menu-map))
    ;; Don't do the menu bindings if menu-bar.el wasn't loaded to defvar
    ;; vc-menu-map.
    ()
  ;;(define-key vc-menu-map [show-files]
  ;;  '("Show Files under VC" . (vc-directory t)))
  (define-key vc-menu-map [vc-directory] '("Show Locked Files" . vc-directory))
  (define-key vc-menu-map [separator1] '("----"))
  (define-key vc-menu-map [vc-rename-file] '("Rename File" . vc-rename-file))
  (define-key vc-menu-map [vc-version-other-window]
    '("Show Other Version" . vc-version-other-window))
  (define-key vc-menu-map [vc-diff] '("Compare with Last Version" . vc-diff))
  (define-key vc-menu-map [vc-update-change-log]
    '("Update ChangeLog" . vc-update-change-log))
  (define-key vc-menu-map [vc-print-log] '("Show History" . vc-print-log))
  (define-key vc-menu-map [separator2] '("----"))
  (define-key vc-menu-map [undo] '("Undo Last Check-In" . vc-cancel-version))
  (define-key vc-menu-map [vc-revert-buffer]
    '("Revert to Last Version" . vc-revert-buffer))
  (define-key vc-menu-map [vc-insert-header]
    '("Insert Header" . vc-insert-headers))
  (define-key vc-menu-map [vc-menu-check-in] '("Check In" . vc-next-action))
  (define-key vc-menu-map [vc-check-out] '("Check Out" . vc-toggle-read-only))
  (define-key vc-menu-map [vc-register] '("Register" . vc-register))
  (put 'vc-rename-file 'menu-enable 'vc-mode)
  (put 'vc-version-other-window 'menu-enable 'vc-mode)
  (put 'vc-diff 'menu-enable 'vc-mode)
  (put 'vc-update-change-log 'menu-enable
956
       '(eq (vc-buffer-backend) 'RCS))
957 958 959 960 961 962
  (put 'vc-print-log 'menu-enable 'vc-mode)
  (put 'vc-cancel-version 'menu-enable 'vc-mode)
  (put 'vc-revert-buffer 'menu-enable 'vc-mode)
  (put 'vc-insert-headers 'menu-enable 'vc-mode)
  (put 'vc-next-action 'menu-enable '(and vc-mode (not buffer-read-only)))
  (put 'vc-toggle-read-only 'menu-enable '(and vc-mode buffer-read-only))
963
  (put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode)))
964
  )
Eric S. Raymond's avatar
Eric S. Raymond committed
965 966 967 968

(provide 'vc-hooks)

;;; vc-hooks.el ends here