refs.c 66.2 KB
Newer Older
D
Daniel Barkalow 已提交
1
#include "cache.h"
2
#include "refs.h"
3 4
#include "object.h"
#include "tag.h"
5
#include "dir.h"
D
Daniel Barkalow 已提交
6

7 8 9 10 11 12 13 14 15 16 17
/*
 * Make sure "ref" is something reasonable to have under ".git/refs/";
 * We do not like it if:
 *
 * - any path component of it begins with ".", or
 * - it has double dots "..", or
 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
 * - it ends with a "/".
 * - it ends with ".lock"
 * - it contains a "\" (backslash)
 */
18

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
/* Return true iff ch is not allowed in reference names. */
static inline int bad_ref_char(int ch)
{
	if (((unsigned) ch) <= ' ' || ch == 0x7f ||
	    ch == '~' || ch == '^' || ch == ':' || ch == '\\')
		return 1;
	/* 2.13 Pattern Matching Notation */
	if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
		return 1;
	return 0;
}

/*
 * Try to read one refname component from the front of refname.  Return
 * the length of the component found, or -1 if the component is not
 * legal.
 */
static int check_refname_component(const char *refname, int flags)
{
	const char *cp;
	char last = '\0';

	for (cp = refname; ; cp++) {
		char ch = *cp;
		if (ch == '\0' || ch == '/')
			break;
		if (bad_ref_char(ch))
			return -1; /* Illegal character in refname. */
		if (last == '.' && ch == '.')
			return -1; /* Refname contains "..". */
		if (last == '@' && ch == '{')
			return -1; /* Refname contains "@{". */
		last = ch;
	}
	if (cp == refname)
54
		return 0; /* Component has zero length. */
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
	if (refname[0] == '.') {
		if (!(flags & REFNAME_DOT_COMPONENT))
			return -1; /* Component starts with '.'. */
		/*
		 * Even if leading dots are allowed, don't allow "."
		 * as a component (".." is prevented by a rule above).
		 */
		if (refname[1] == '\0')
			return -1; /* Component equals ".". */
	}
	if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5))
		return -1; /* Refname ends with ".lock". */
	return cp - refname;
}

int check_refname_format(const char *refname, int flags)
{
	int component_len, component_count = 0;

	while (1) {
		/* We are at the start of a path component. */
		component_len = check_refname_component(refname, flags);
77
		if (component_len <= 0) {
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
			if ((flags & REFNAME_REFSPEC_PATTERN) &&
					refname[0] == '*' &&
					(refname[1] == '\0' || refname[1] == '/')) {
				/* Accept one wildcard as a full refname component. */
				flags &= ~REFNAME_REFSPEC_PATTERN;
				component_len = 1;
			} else {
				return -1;
			}
		}
		component_count++;
		if (refname[component_len] == '\0')
			break;
		/* Skip to next component. */
		refname += component_len + 1;
	}

	if (refname[component_len - 1] == '.')
		return -1; /* Refname ends with '.'. */
	if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
		return -1; /* Refname has only one component. */
	return 0;
}

struct ref_entry;
103

104 105 106 107 108 109
/*
 * Information used (along with the information in ref_entry) to
 * describe a single cached reference.  This data structure only
 * occurs embedded in a union in struct ref_entry, and only when
 * (ref_entry->flag & REF_DIR) is zero.
 */
110 111 112 113 114
struct ref_value {
	unsigned char sha1[20];
	unsigned char peeled[20];
};

115 116
struct ref_cache;

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
/*
 * Information used (along with the information in ref_entry) to
 * describe a level in the hierarchy of references.  This data
 * structure only occurs embedded in a union in struct ref_entry, and
 * only when (ref_entry.flag & REF_DIR) is set.  In that case,
 * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
 * in the directory have already been read:
 *
 *     (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
 *         or packed references, already read.
 *
 *     (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
 *         references that hasn't been read yet (nor has any of its
 *         subdirectories).
 *
 * Entries within a directory are stored within a growable array of
 * pointers to ref_entries (entries, nr, alloc).  Entries 0 <= i <
 * sorted are sorted by their component name in strcmp() order and the
 * remaining entries are unsorted.
 *
 * Loose references are read lazily, one directory at a time.  When a
 * directory of loose references is read, then all of the references
 * in that directory are stored, and REF_INCOMPLETE stubs are created
 * for any subdirectories, but the subdirectories themselves are not
 * read.  The reading is triggered by get_ref_dir().
 */
143
struct ref_dir {
144
	int nr, alloc;
145 146 147 148 149 150 151 152 153

	/*
	 * Entries with index 0 <= i < sorted are sorted by name.  New
	 * entries are appended to the list unsorted, and are sorted
	 * only when required; thus we avoid the need to sort the list
	 * after the addition of every reference.
	 */
	int sorted;

154 155 156
	/* A pointer to the ref_cache that contains this ref_dir. */
	struct ref_cache *ref_cache;

157
	struct ref_entry **entries;
158 159
};

160 161
/* ISSYMREF=0x01, ISPACKED=0x02, and ISBROKEN=0x04 are public interfaces */
#define REF_KNOWS_PEELED 0x08
162 163

/* ref_entry represents a directory of references */
164
#define REF_DIR 0x10
165

166 167 168 169 170 171
/*
 * Entry has not yet been read from disk (used only for REF_DIR
 * entries representing loose references)
 */
#define REF_INCOMPLETE 0x20

172 173
/*
 * A ref_entry represents either a reference or a "subdirectory" of
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
 * references.
 *
 * Each directory in the reference namespace is represented by a
 * ref_entry with (flags & REF_DIR) set and containing a subdir member
 * that holds the entries in that directory that have been read so
 * far.  If (flags & REF_INCOMPLETE) is set, then the directory and
 * its subdirectories haven't been read yet.  REF_INCOMPLETE is only
 * used for loose reference directories.
 *
 * References are represented by a ref_entry with (flags & REF_DIR)
 * unset and a value member that describes the reference's value.  The
 * flag member is at the ref_entry level, but it is also needed to
 * interpret the contents of the value field (in other words, a
 * ref_value object is not very much use without the enclosing
 * ref_entry).
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
 *
 * Reference names cannot end with slash and directories' names are
 * always stored with a trailing slash (except for the top-level
 * directory, which is always denoted by "").  This has two nice
 * consequences: (1) when the entries in each subdir are sorted
 * lexicographically by name (as they usually are), the references in
 * a whole tree can be generated in lexicographic order by traversing
 * the tree in left-to-right, depth-first order; (2) the names of
 * references and subdirectories cannot conflict, and therefore the
 * presence of an empty subdirectory does not block the creation of a
 * similarly-named reference.  (The fact that reference names with the
 * same leading components can conflict *with each other* is a
 * separate issue that is regulated by is_refname_available().)
 *
 * Please note that the name field contains the fully-qualified
 * reference (or subdirectory) name.  Space could be saved by only
 * storing the relative names.  But that would require the full names
 * to be generated on the fly when iterating in do_for_each_ref(), and
 * would break callback functions, who have always been able to assume
 * that the name strings that they are passed will not be freed during
 * the iteration.
 */
211 212
struct ref_entry {
	unsigned char flag; /* ISSYMREF? ISPACKED? */
213
	union {
214 215
		struct ref_value value; /* if not (flags&REF_DIR) */
		struct ref_dir subdir; /* if (flags&REF_DIR) */
216
	} u;
217 218 219 220 221
	/*
	 * The full name of the reference (e.g., "refs/heads/master")
	 * or the full name of the directory with a trailing slash
	 * (e.g., "refs/heads/"):
	 */
222 223
	char name[FLEX_ARRAY];
};
224

225 226
static void read_loose_refs(const char *dirname, struct ref_dir *dir);

227 228
static struct ref_dir *get_ref_dir(struct ref_entry *entry)
{
229
	struct ref_dir *dir;
230
	assert(entry->flag & REF_DIR);
231 232 233 234 235 236
	dir = &entry->u.subdir;
	if (entry->flag & REF_INCOMPLETE) {
		read_loose_refs(entry->name, dir);
		entry->flag &= ~REF_INCOMPLETE;
	}
	return dir;
237 238
}

239 240 241
static struct ref_entry *create_ref_entry(const char *refname,
					  const unsigned char *sha1, int flag,
					  int check_name)
242 243
{
	int len;
244
	struct ref_entry *ref;
245

246
	if (check_name &&
247 248
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
		die("Reference has invalid format: '%s'", refname);
249 250
	len = strlen(refname) + 1;
	ref = xmalloc(sizeof(struct ref_entry) + len);
251 252
	hashcpy(ref->u.value.sha1, sha1);
	hashclr(ref->u.value.peeled);
253 254 255 256 257
	memcpy(ref->name, refname, len);
	ref->flag = flag;
	return ref;
}

258 259
static void clear_ref_dir(struct ref_dir *dir);

260 261
static void free_ref_entry(struct ref_entry *entry)
{
262 263 264 265 266 267 268
	if (entry->flag & REF_DIR) {
		/*
		 * Do not use get_ref_dir() here, as that might
		 * trigger the reading of loose refs.
		 */
		clear_ref_dir(&entry->u.subdir);
	}
269 270 271
	free(entry);
}

272 273 274 275 276 277
/*
 * Add a ref_entry to the end of dir (unsorted).  Entry is always
 * stored directly in dir; no recursion into subdirectories is
 * done.
 */
static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
278
{
279 280
	ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
	dir->entries[dir->nr++] = entry;
281 282 283 284 285 286
	/* optimize for the case that entries are added in order */
	if (dir->nr == 1 ||
	    (dir->nr == dir->sorted + 1 &&
	     strcmp(dir->entries[dir->nr - 2]->name,
		    dir->entries[dir->nr - 1]->name) < 0))
		dir->sorted = dir->nr;
287 288
}

289 290 291
/*
 * Clear and free all entries in dir, recursively.
 */
292
static void clear_ref_dir(struct ref_dir *dir)
293 294
{
	int i;
295 296 297 298 299
	for (i = 0; i < dir->nr; i++)
		free_ref_entry(dir->entries[i]);
	free(dir->entries);
	dir->sorted = dir->nr = dir->alloc = 0;
	dir->entries = NULL;
300 301
}

302 303 304 305 306
/*
 * Create a struct ref_entry object for the specified dirname.
 * dirname is the name of the directory with a trailing slash (e.g.,
 * "refs/heads/") or "" for the top-level directory.
 */
307
static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
308 309
					  const char *dirname, size_t len,
					  int incomplete)
310 311 312
{
	struct ref_entry *direntry;
	direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
313 314
	memcpy(direntry->name, dirname, len);
	direntry->name[len] = '\0';
315
	direntry->u.subdir.ref_cache = ref_cache;
316
	direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
317 318 319
	return direntry;
}

320
static int ref_entry_cmp(const void *a, const void *b)
321
{
322 323 324 325
	struct ref_entry *one = *(struct ref_entry **)a;
	struct ref_entry *two = *(struct ref_entry **)b;
	return strcmp(one->name, two->name);
}
326

327
static void sort_ref_dir(struct ref_dir *dir);
328

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
struct string_slice {
	size_t len;
	const char *str;
};

static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
{
	struct string_slice *key = (struct string_slice *)key_;
	struct ref_entry *ent = *(struct ref_entry **)ent_;
	int entlen = strlen(ent->name);
	int cmplen = key->len < entlen ? key->len : entlen;
	int cmp = memcmp(key->str, ent->name, cmplen);
	if (cmp)
		return cmp;
	return key->len - entlen;
}

346 347 348
/*
 * Return the entry with the given refname from the ref_dir
 * (non-recursively), sorting dir if necessary.  Return NULL if no
349
 * such entry is found.  dir must already be complete.
350
 */
351 352
static struct ref_entry *search_ref_dir(struct ref_dir *dir,
					const char *refname, size_t len)
353
{
354 355
	struct ref_entry **r;
	struct string_slice key;
356

357
	if (refname == NULL || !dir->nr)
358 359
		return NULL;

360
	sort_ref_dir(dir);
361 362 363 364
	key.len = len;
	key.str = refname;
	r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
		    ref_entry_cmp_sslice);
365 366 367 368 369 370 371

	if (r == NULL)
		return NULL;

	return *r;
}

372 373 374 375 376
/*
 * Search for a directory entry directly within dir (without
 * recursing).  Sort dir if necessary.  subdirname must be a directory
 * name (i.e., end in '/').  If mkdir is set, then create the
 * directory if it is missing; otherwise, return NULL if the desired
377
 * directory cannot be found.  dir must already be complete.
378
 */
379
static struct ref_dir *search_for_subdir(struct ref_dir *dir,
380 381
					 const char *subdirname, size_t len,
					 int mkdir)
382
{
383
	struct ref_entry *entry = search_ref_dir(dir, subdirname, len);
384 385 386
	if (!entry) {
		if (!mkdir)
			return NULL;
387 388 389 390 391 392
		/*
		 * Since dir is complete, the absence of a subdir
		 * means that the subdir really doesn't exist;
		 * therefore, create an empty record for it but mark
		 * the record complete.
		 */
393
		entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
394 395
		add_entry_to_dir(dir, entry);
	}
396
	return get_ref_dir(entry);
397 398
}

399 400 401 402
/*
 * If refname is a reference name, find the ref_dir within the dir
 * tree that should hold refname.  If refname is a directory name
 * (i.e., ends in '/'), then return that ref_dir itself.  dir must
403 404 405 406
 * represent the top-level directory and must already be complete.
 * Sort ref_dirs and recurse into subdirectories as necessary.  If
 * mkdir is set, then create any missing directories; otherwise,
 * return NULL if the desired directory cannot be found.
407 408 409 410
 */
static struct ref_dir *find_containing_dir(struct ref_dir *dir,
					   const char *refname, int mkdir)
{
411 412
	const char *slash;
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
413
		size_t dirnamelen = slash - refname + 1;
414
		struct ref_dir *subdir;
415
		subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
416 417
		if (!subdir) {
			dir = NULL;
418
			break;
419
		}
420
		dir = subdir;
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
	}

	return dir;
}

/*
 * Find the value entry with the given name in dir, sorting ref_dirs
 * and recursing into subdirectories as necessary.  If the name is not
 * found or it corresponds to a directory entry, return NULL.
 */
static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
{
	struct ref_entry *entry;
	dir = find_containing_dir(dir, refname, 0);
	if (!dir)
		return NULL;
437
	entry = search_ref_dir(dir, refname, strlen(refname));
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
	return (entry && !(entry->flag & REF_DIR)) ? entry : NULL;
}

/*
 * Add a ref_entry to the ref_dir (unsorted), recursing into
 * subdirectories as necessary.  dir must represent the top-level
 * directory.  Return 0 on success.
 */
static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
{
	dir = find_containing_dir(dir, ref->name, 1);
	if (!dir)
		return -1;
	add_entry_to_dir(dir, ref);
	return 0;
}

455 456 457 458 459 460 461
/*
 * Emit a warning and return true iff ref1 and ref2 have the same name
 * and the same sha1.  Die if they have the same name but different
 * sha1s.
 */
static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
{
462
	if (strcmp(ref1->name, ref2->name))
463
		return 0;
464 465 466 467 468 469 470 471 472 473 474 475

	/* Duplicate name; make sure that they don't conflict: */

	if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
		/* This is impossible by construction */
		die("Reference directory conflict: %s", ref1->name);

	if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
		die("Duplicated ref, and SHA1s don't match: %s", ref1->name);

	warning("Duplicated ref: %s", ref1->name);
	return 1;
476 477
}

478
/*
479 480
 * Sort the entries in dir non-recursively (if they are not already
 * sorted) and remove any duplicate entries.
481
 */
482
static void sort_ref_dir(struct ref_dir *dir)
483
{
484
	int i, j;
485
	struct ref_entry *last = NULL;
486

487 488 489 490
	/*
	 * This check also prevents passing a zero-length array to qsort(),
	 * which is a problem on some platforms.
	 */
491
	if (dir->sorted == dir->nr)
492
		return;
493

494
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
495

496 497 498 499 500 501 502
	/* Remove any duplicates: */
	for (i = 0, j = 0; j < dir->nr; j++) {
		struct ref_entry *entry = dir->entries[j];
		if (last && is_dup_ref(last, entry))
			free_ref_entry(entry);
		else
			last = dir->entries[i++] = entry;
503
	}
504
	dir->sorted = dir->nr = i;
505
}
506

507
#define DO_FOR_EACH_INCLUDE_BROKEN 01
508

509
static struct ref_entry *current_ref;
510

511 512 513
static int do_one_ref(const char *base, each_ref_fn fn, int trim,
		      int flags, void *cb_data, struct ref_entry *entry)
{
514
	int retval;
515 516
	if (prefixcmp(entry->name, base))
		return 0;
517

518 519 520
	if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
		if (entry->flag & REF_ISBROKEN)
			return 0; /* ignore broken refs e.g. dangling symref */
521
		if (!has_sha1_file(entry->u.value.sha1)) {
522 523 524 525 526
			error("%s does not point to a valid object!", entry->name);
			return 0;
		}
	}
	current_ref = entry;
527
	retval = fn(entry->name + trim, entry->u.value.sha1, entry->flag, cb_data);
528 529
	current_ref = NULL;
	return retval;
530
}
531

532
/*
533
 * Call fn for each reference in dir that has index in the range
534 535 536
 * offset <= index < dir->nr.  Recurse into subdirectories that are in
 * that index range, sorting them before iterating.  This function
 * does not sort dir itself; it should be sorted beforehand.
537
 */
538 539 540
static int do_for_each_ref_in_dir(struct ref_dir *dir, int offset,
				  const char *base,
				  each_ref_fn fn, int trim, int flags, void *cb_data)
541 542
{
	int i;
543 544
	assert(dir->sorted == dir->nr);
	for (i = offset; i < dir->nr; i++) {
545 546 547
		struct ref_entry *entry = dir->entries[i];
		int retval;
		if (entry->flag & REF_DIR) {
548 549 550
			struct ref_dir *subdir = get_ref_dir(entry);
			sort_ref_dir(subdir);
			retval = do_for_each_ref_in_dir(subdir, 0,
551 552 553 554
							base, fn, trim, flags, cb_data);
		} else {
			retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
		}
555 556 557 558 559 560
		if (retval)
			return retval;
	}
	return 0;
}

561
/*
562
 * Call fn for each reference in the union of dir1 and dir2, in order
563 564 565 566
 * by refname.  Recurse into subdirectories.  If a value entry appears
 * in both dir1 and dir2, then only process the version that is in
 * dir2.  The input dirs must already be sorted, but subdirs will be
 * sorted as needed.
567
 */
568 569 570 571
static int do_for_each_ref_in_dirs(struct ref_dir *dir1,
				   struct ref_dir *dir2,
				   const char *base, each_ref_fn fn, int trim,
				   int flags, void *cb_data)
572 573 574 575
{
	int retval;
	int i1 = 0, i2 = 0;

576 577
	assert(dir1->sorted == dir1->nr);
	assert(dir2->sorted == dir2->nr);
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
	while (1) {
		struct ref_entry *e1, *e2;
		int cmp;
		if (i1 == dir1->nr) {
			return do_for_each_ref_in_dir(dir2, i2,
						      base, fn, trim, flags, cb_data);
		}
		if (i2 == dir2->nr) {
			return do_for_each_ref_in_dir(dir1, i1,
						      base, fn, trim, flags, cb_data);
		}
		e1 = dir1->entries[i1];
		e2 = dir2->entries[i2];
		cmp = strcmp(e1->name, e2->name);
		if (cmp == 0) {
			if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
				/* Both are directories; descend them in parallel. */
595 596 597 598
				struct ref_dir *subdir1 = get_ref_dir(e1);
				struct ref_dir *subdir2 = get_ref_dir(e2);
				sort_ref_dir(subdir1);
				sort_ref_dir(subdir2);
599
				retval = do_for_each_ref_in_dirs(
600
						subdir1, subdir2,
601 602 603 604 605 606 607 608 609 610 611 612
						base, fn, trim, flags, cb_data);
				i1++;
				i2++;
			} else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
				/* Both are references; ignore the one from dir1. */
				retval = do_one_ref(base, fn, trim, flags, cb_data, e2);
				i1++;
				i2++;
			} else {
				die("conflict between reference and directory: %s",
				    e1->name);
			}
613
		} else {
614 615 616
			struct ref_entry *e;
			if (cmp < 0) {
				e = e1;
617
				i1++;
618 619 620 621 622
			} else {
				e = e2;
				i2++;
			}
			if (e->flag & REF_DIR) {
623 624
				struct ref_dir *subdir = get_ref_dir(e);
				sort_ref_dir(subdir);
625
				retval = do_for_each_ref_in_dir(
626
						subdir, 0,
627 628 629
						base, fn, trim, flags, cb_data);
			} else {
				retval = do_one_ref(base, fn, trim, flags, cb_data, e);
630 631 632 633 634
			}
		}
		if (retval)
			return retval;
	}
635 636 637 638 639 640
	if (i1 < dir1->nr)
		return do_for_each_ref_in_dir(dir1, i1,
					      base, fn, trim, flags, cb_data);
	if (i2 < dir2->nr)
		return do_for_each_ref_in_dir(dir2, i2,
					      base, fn, trim, flags, cb_data);
641 642 643
	return 0;
}

644 645 646 647 648 649 650 651 652
/*
 * Return true iff refname1 and refname2 conflict with each other.
 * Two reference names conflict if one of them exactly matches the
 * leading components of the other; e.g., "foo/bar" conflicts with
 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
 * "foo/barbados".
 */
static int names_conflict(const char *refname1, const char *refname2)
{
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
	for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
		;
	return (*refname1 == '\0' && *refname2 == '/')
		|| (*refname1 == '/' && *refname2 == '\0');
}

struct name_conflict_cb {
	const char *refname;
	const char *oldrefname;
	const char *conflicting_refname;
};

static int name_conflict_fn(const char *existingrefname, const unsigned char *sha1,
			    int flags, void *cb_data)
{
	struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
	if (data->oldrefname && !strcmp(data->oldrefname, existingrefname))
		return 0;
	if (names_conflict(data->refname, existingrefname)) {
		data->conflicting_refname = existingrefname;
		return 1;
674
	}
675
	return 0;
676 677
}

678 679
/*
 * Return true iff a reference named refname could be created without
680 681 682
 * conflicting with the name of an existing reference in array.  If
 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
 * (e.g., because oldrefname is scheduled for deletion in the same
683 684 685
 * operation).
 */
static int is_refname_available(const char *refname, const char *oldrefname,
686
				struct ref_dir *dir)
687
{
688 689 690 691 692
	struct name_conflict_cb data;
	data.refname = refname;
	data.oldrefname = oldrefname;
	data.conflicting_refname = NULL;

693 694 695 696
	sort_ref_dir(dir);
	if (do_for_each_ref_in_dir(dir, 0, "", name_conflict_fn,
				   0, DO_FOR_EACH_INCLUDE_BROKEN,
				   &data)) {
697 698 699
		error("'%s' exists; cannot create '%s'",
		      data.conflicting_refname, refname);
		return 0;
700 701
	}
	return 1;
702 703
}

704 705 706 707
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
708 709
static struct ref_cache {
	struct ref_cache *next;
710 711
	struct ref_entry *loose;
	struct ref_entry *packed;
712 713
	/* The submodule name, or "" for the main repo. */
	char name[FLEX_ARRAY];
714
} *ref_cache;
715

716
static void clear_packed_ref_cache(struct ref_cache *refs)
717
{
718 719 720 721
	if (refs->packed) {
		free_ref_entry(refs->packed);
		refs->packed = NULL;
	}
722
}
723

724 725
static void clear_loose_ref_cache(struct ref_cache *refs)
{
726 727 728 729
	if (refs->loose) {
		free_ref_entry(refs->loose);
		refs->loose = NULL;
	}
730 731
}

732
static struct ref_cache *create_ref_cache(const char *submodule)
733
{
734
	int len;
735
	struct ref_cache *refs;
736 737 738
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
739
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
740
	memcpy(refs->name, submodule, len);
741 742 743
	return refs;
}

744
/*
745
 * Return a pointer to a ref_cache for the specified submodule. For
746 747 748 749
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
750
static struct ref_cache *get_ref_cache(const char *submodule)
751
{
752
	struct ref_cache *refs = ref_cache;
753 754 755 756 757 758
	if (!submodule)
		submodule = "";
	while (refs) {
		if (!strcmp(submodule, refs->name))
			return refs;
		refs = refs->next;
759
	}
760

761 762 763
	refs = create_ref_cache(submodule);
	refs->next = ref_cache;
	ref_cache = refs;
764
	return refs;
765 766
}

767
void invalidate_ref_cache(const char *submodule)
768
{
769 770 771
	struct ref_cache *refs = get_ref_cache(submodule);
	clear_packed_ref_cache(refs);
	clear_loose_ref_cache(refs);
772
}
773

774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
/*
 * Parse one line from a packed-refs file.  Write the SHA1 to sha1.
 * Return a pointer to the refname within the line (null-terminated),
 * or NULL if there was a problem.
 */
static const char *parse_ref_line(char *line, unsigned char *sha1)
{
	/*
	 * 42: the answer to everything.
	 *
	 * In this case, it happens to be the answer to
	 *  40 (length of sha1 hex representation)
	 *  +1 (space in between hex and name)
	 *  +1 (newline at the end of the line)
	 */
	int len = strlen(line) - 42;

	if (len <= 0)
		return NULL;
	if (get_sha1_hex(line, sha1) < 0)
		return NULL;
	if (!isspace(line[40]))
		return NULL;
	line += 41;
	if (isspace(*line))
		return NULL;
	if (line[len] != '\n')
		return NULL;
	line[len] = 0;

	return line;
}

807
static void read_packed_refs(FILE *f, struct ref_dir *dir)
808
{
809
	struct ref_entry *last = NULL;
810 811 812 813 814
	char refline[PATH_MAX];
	int flag = REF_ISPACKED;

	while (fgets(refline, sizeof(refline), f)) {
		unsigned char sha1[20];
815
		const char *refname;
816 817 818 819 820 821 822 823 824 825
		static const char header[] = "# pack-refs with:";

		if (!strncmp(refline, header, sizeof(header)-1)) {
			const char *traits = refline + sizeof(header) - 1;
			if (strstr(traits, " peeled "))
				flag |= REF_KNOWS_PEELED;
			/* perhaps other traits later as well */
			continue;
		}

826 827
		refname = parse_ref_line(refline, sha1);
		if (refname) {
828
			last = create_ref_entry(refname, sha1, flag, 1);
829
			add_ref(dir, last);
830 831 832 833 834 835 836
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
		    strlen(refline) == 42 &&
		    refline[41] == '\n' &&
		    !get_sha1_hex(refline + 1, sha1))
837
			hashcpy(last->u.value.peeled, sha1);
838 839 840
	}
}

841
static struct ref_dir *get_packed_refs(struct ref_cache *refs)
842
{
843
	if (!refs->packed) {
844 845
		const char *packed_refs_file;
		FILE *f;
846

847
		refs->packed = create_dir_entry(refs, "", 0, 0);
848 849
		if (*refs->name)
			packed_refs_file = git_path_submodule(refs->name, "packed-refs");
850 851 852
		else
			packed_refs_file = git_path("packed-refs");
		f = fopen(packed_refs_file, "r");
853
		if (f) {
854
			read_packed_refs(f, get_ref_dir(refs->packed));
855 856 857
			fclose(f);
		}
	}
858
	return get_ref_dir(refs->packed);
859 860
}

861 862 863 864 865 866
void add_packed_ref(const char *refname, const unsigned char *sha1)
{
	add_ref(get_packed_refs(get_ref_cache(NULL)),
			create_ref_entry(refname, sha1, REF_ISPACKED, 1));
}

867
/*
868 869 870
 * Read the loose references from the namespace dirname into dir
 * (without recursing).  dirname must end with '/'.  dir must be the
 * directory entry corresponding to dirname.
871
 */
872
static void read_loose_refs(const char *dirname, struct ref_dir *dir)
873
{
874
	struct ref_cache *refs = dir->ref_cache;
875
	DIR *d;
876
	const char *path;
877
	struct dirent *de;
878
	int dirnamelen = strlen(dirname);
879
	struct strbuf refname;
880

M
Michael Haggerty 已提交
881
	if (*refs->name)
882
		path = git_path_submodule(refs->name, "%s", dirname);
883
	else
884
		path = git_path("%s", dirname);
885

886
	d = opendir(path);
887 888 889
	if (!d)
		return;

890 891
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
892 893 894 895 896 897 898 899 900 901 902

	while ((de = readdir(d)) != NULL) {
		unsigned char sha1[20];
		struct stat st;
		int flag;
		const char *refdir;

		if (de->d_name[0] == '.')
			continue;
		if (has_extension(de->d_name, ".lock"))
			continue;
903
		strbuf_addstr(&refname, de->d_name);
904
		refdir = *refs->name
905 906 907 908 909
			? git_path_submodule(refs->name, "%s", refname.buf)
			: git_path("%s", refname.buf);
		if (stat(refdir, &st) < 0) {
			; /* silently ignore */
		} else if (S_ISDIR(st.st_mode)) {
910
			strbuf_addch(&refname, '/');
911
			add_entry_to_dir(dir,
912 913
					 create_dir_entry(refs, refname.buf,
							  refname.len, 1));
914
		} else {
M
Michael Haggerty 已提交
915
			if (*refs->name) {
916
				hashclr(sha1);
917
				flag = 0;
918
				if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
919
					hashclr(sha1);
920
					flag |= REF_ISBROKEN;
921
				}
922
			} else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
923 924 925
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
926 927
			add_entry_to_dir(dir,
					 create_ref_entry(refname.buf, sha1, flag, 1));
928
		}
929
		strbuf_setlen(&refname, dirnamelen);
930
	}
931
	strbuf_release(&refname);
932
	closedir(d);
933 934
}

935
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
936
{
937
	if (!refs->loose) {
938 939 940 941 942
		/*
		 * Mark the top-level directory complete because we
		 * are about to read the only subdirectory that can
		 * hold references:
		 */
943
		refs->loose = create_dir_entry(refs, "", 0, 0);
944 945 946 947
		/*
		 * Create an incomplete entry for "refs/":
		 */
		add_entry_to_dir(get_ref_dir(refs->loose),
948
				 create_dir_entry(refs, "refs/", 5, 1));
949
	}
950
	return get_ref_dir(refs->loose);
951 952
}

953 954
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
955 956
#define MAXREFLEN (1024)

957 958
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
959 960
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
961
 */
962
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
963
				      const char *refname, unsigned char *sha1)
964
{
965
	struct ref_entry *ref;
966
	struct ref_dir *dir = get_packed_refs(refs);
967

968
	ref = find_ref(dir, refname);
969 970 971
	if (ref == NULL)
		return -1;

972
	memcpy(sha1, ref->u.value.sha1, 20);
973
	return 0;
974 975
}

976
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
977
					 const char *refname, unsigned char *sha1,
978
					 int recursion)
979
{
980
	int fd, len;
981
	char buffer[128], *p;
982
	char *path;
983

984
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
985
		return -1;
986 987 988 989
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
990
	if (fd < 0)
991
		return resolve_gitlink_packed_ref(refs, refname, sha1);
992 993 994 995 996 997 998 999 1000 1001

	len = read(fd, buffer, sizeof(buffer)-1);
	close(fd);
	if (len < 0)
		return -1;
	while (len && isspace(buffer[len-1]))
		len--;
	buffer[len] = 0;

	/* Was it a detached head or an old-fashioned symlink? */
1002
	if (!get_sha1_hex(buffer, sha1))
1003 1004 1005 1006 1007 1008 1009 1010 1011
		return 0;

	/* Symref? */
	if (strncmp(buffer, "ref:", 4))
		return -1;
	p = buffer + 4;
	while (isspace(*p))
		p++;

1012
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1013 1014
}

1015
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1016 1017
{
	int len = strlen(path), retval;
1018
	char *submodule;
1019
	struct ref_cache *refs;
1020 1021 1022 1023 1024

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
1025 1026 1027 1028
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

1029
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1030 1031
	return retval;
}
1032

1033
/*
1034 1035
 * Try to read ref from the packed references.  On success, set sha1
 * and return 0; otherwise, return -1.
1036
 */
1037
static int get_packed_ref(const char *refname, unsigned char *sha1)
1038
{
1039
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1040
	struct ref_entry *entry = find_ref(packed, refname);
1041
	if (entry) {
1042
		hashcpy(sha1, entry->u.value.sha1);
1043
		return 0;
1044 1045 1046 1047
	}
	return -1;
}

J
Junio C Hamano 已提交
1048
const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
1049
{
1050 1051
	int depth = MAXDEPTH;
	ssize_t len;
1052
	char buffer[256];
1053
	static char refname_buffer[256];
1054

1055 1056 1057
	if (flag)
		*flag = 0;

1058
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1059 1060
		return NULL;

1061
	for (;;) {
1062
		char path[PATH_MAX];
1063 1064 1065
		struct stat st;
		char *buf;
		int fd;
1066

1067 1068
		if (--depth < 0)
			return NULL;
1069

1070
		git_snpath(path, sizeof(path), "%s", refname);
1071

1072
		if (lstat(path, &st) < 0) {
1073 1074 1075 1076 1077 1078
			if (errno != ENOENT)
				return NULL;
			/*
			 * The loose reference file does not exist;
			 * check for a packed reference.
			 */
1079
			if (!get_packed_ref(refname, sha1)) {
1080 1081
				if (flag)
					*flag |= REF_ISPACKED;
1082
				return refname;
1083
			}
1084 1085
			/* The reference is not a packed reference, either. */
			if (reading) {
1086
				return NULL;
1087 1088
			} else {
				hashclr(sha1);
1089
				return refname;
1090
			}
1091
		}
1092

1093 1094 1095
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
1096 1097
			if (len < 0)
				return NULL;
M
Michael Haggerty 已提交
1098
			buffer[len] = 0;
1099 1100
			if (!prefixcmp(buffer, "refs/") &&
					!check_refname_format(buffer, 0)) {
1101 1102
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
1103 1104
				if (flag)
					*flag |= REF_ISSYMREF;
1105 1106
				continue;
			}
1107
		}
1108

1109 1110 1111 1112 1113 1114
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

1115 1116 1117 1118 1119 1120 1121
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
		if (fd < 0)
			return NULL;
1122
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
1123
		close(fd);
1124 1125 1126 1127 1128
		if (len < 0)
			return NULL;
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1129 1130 1131 1132

		/*
		 * Is it a symbolic ref?
		 */
1133
		if (prefixcmp(buffer, "ref:"))
1134
			break;
1135 1136
		if (flag)
			*flag |= REF_ISSYMREF;
1137
		buf = buffer + 4;
1138 1139
		while (isspace(*buf))
			buf++;
1140
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1141 1142
			if (flag)
				*flag |= REF_ISBROKEN;
1143 1144
			return NULL;
		}
1145
		refname = strcpy(refname_buffer, buf);
1146
	}
1147 1148
	/* Please note that FETCH_HEAD has a second line containing other data. */
	if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1149 1150
		if (flag)
			*flag |= REF_ISBROKEN;
1151
		return NULL;
1152
	}
1153
	return refname;
1154 1155
}

1156 1157
char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
{
1158
	const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1159 1160 1161
	return ret ? xstrdup(ret) : NULL;
}

I
Ilari Liusvaara 已提交
1162 1163 1164 1165 1166 1167 1168
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1169
int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1170
{
J
Junio C Hamano 已提交
1171
	if (resolve_ref_unsafe(refname, sha1, reading, flags))
1172 1173
		return 0;
	return -1;
1174 1175
}

1176
int read_ref(const char *refname, unsigned char *sha1)
1177
{
1178
	return read_ref_full(refname, sha1, 1, NULL);
1179 1180
}

1181
int ref_exists(const char *refname)
1182
{
1183 1184
	unsigned char sha1[20];
	return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1185 1186
}

1187
static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1188
		       void *data)
I
Ilari Liusvaara 已提交
1189 1190
{
	struct ref_filter *filter = (struct ref_filter *)data;
1191
	if (fnmatch(filter->pattern, refname, 0))
I
Ilari Liusvaara 已提交
1192
		return 0;
1193
	return filter->fn(refname, sha1, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1194 1195
}

1196
int peel_ref(const char *refname, unsigned char *sha1)
1197 1198 1199 1200 1201
{
	int flag;
	unsigned char base[20];
	struct object *o;

1202 1203
	if (current_ref && (current_ref->name == refname
		|| !strcmp(current_ref->name, refname))) {
1204
		if (current_ref->flag & REF_KNOWS_PEELED) {
1205
			hashcpy(sha1, current_ref->u.value.peeled);
1206 1207
			return 0;
		}
1208
		hashcpy(base, current_ref->u.value.sha1);
1209 1210 1211
		goto fallback;
	}

1212
	if (read_ref_full(refname, base, 1, &flag))
1213 1214 1215
		return -1;

	if ((flag & REF_ISPACKED)) {
1216
		struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
1217
		struct ref_entry *r = find_ref(dir, refname);
1218

1219
		if (r != NULL && r->flag & REF_KNOWS_PEELED) {
1220
			hashcpy(sha1, r->u.value.peeled);
1221
			return 0;
1222 1223 1224
		}
	}

1225
fallback:
1226
	o = parse_object(base);
1227
	if (o && o->type == OBJ_TAG) {
1228
		o = deref_tag(o, refname, 0);
1229 1230 1231 1232 1233 1234 1235 1236
		if (o) {
			hashcpy(sha1, o->sha1);
			return 0;
		}
	}
	return -1;
}

1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
struct warn_if_dangling_data {
	FILE *fp;
	const char *refname;
	const char *msg_fmt;
};

static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
				   int flags, void *cb_data)
{
	struct warn_if_dangling_data *d = cb_data;
	const char *resolves_to;
	unsigned char junk[20];

	if (!(flags & REF_ISSYMREF))
		return 0;

	resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
	if (!resolves_to || strcmp(resolves_to, d->refname))
		return 0;

	fprintf(d->fp, d->msg_fmt, refname);
J
Junio C Hamano 已提交
1258
	fputc('\n', d->fp);
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
	return 0;
}

void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
{
	struct warn_if_dangling_data data;

	data.fp = fp;
	data.refname = refname;
	data.msg_fmt = msg_fmt;
	for_each_rawref(warn_if_dangling_symref, &data);
}

1272 1273
static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
			   int trim, int flags, void *cb_data)
1274
{
1275
	struct ref_cache *refs = get_ref_cache(submodule);
1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303
	struct ref_dir *packed_dir = get_packed_refs(refs);
	struct ref_dir *loose_dir = get_loose_refs(refs);
	int retval = 0;

	if (base && *base) {
		packed_dir = find_containing_dir(packed_dir, base, 0);
		loose_dir = find_containing_dir(loose_dir, base, 0);
	}

	if (packed_dir && loose_dir) {
		sort_ref_dir(packed_dir);
		sort_ref_dir(loose_dir);
		retval = do_for_each_ref_in_dirs(
				packed_dir, loose_dir,
				base, fn, trim, flags, cb_data);
	} else if (packed_dir) {
		sort_ref_dir(packed_dir);
		retval = do_for_each_ref_in_dir(
				packed_dir, 0,
				base, fn, trim, flags, cb_data);
	} else if (loose_dir) {
		sort_ref_dir(loose_dir);
		retval = do_for_each_ref_in_dir(
				loose_dir, 0,
				base, fn, trim, flags, cb_data);
	}

	return retval;
1304 1305
}

1306
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1307 1308
{
	unsigned char sha1[20];
1309 1310
	int flag;

1311 1312 1313 1314 1315 1316 1317
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

1318
	if (!read_ref_full("HEAD", sha1, 1, &flag))
1319
		return fn("HEAD", sha1, flag, cb_data);
1320

1321
	return 0;
1322 1323
}

1324 1325 1326 1327 1328
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

1329 1330 1331 1332 1333
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

1334
int for_each_ref(each_ref_fn fn, void *cb_data)
1335
{
1336
	return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1337 1338
}

1339 1340
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
1341
	return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1342 1343
}

1344 1345
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
1346
	return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1347 1348
}

1349 1350 1351 1352
int for_each_ref_in_submodule(const char *submodule, const char *prefix,
		each_ref_fn fn, void *cb_data)
{
	return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
1353 1354
}

1355
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1356
{
1357
	return for_each_ref_in("refs/tags/", fn, cb_data);
1358 1359
}

1360 1361 1362 1363 1364
int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
}

1365
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1366
{
1367
	return for_each_ref_in("refs/heads/", fn, cb_data);
1368 1369
}

1370 1371 1372 1373 1374
int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
}

1375
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1376
{
1377
	return for_each_ref_in("refs/remotes/", fn, cb_data);
1378 1379
}

1380 1381 1382 1383 1384
int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
}

1385 1386
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
1387
	return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
1388 1389
}

J
Josh Triplett 已提交
1390 1391 1392 1393 1394 1395 1396 1397
int head_ref_namespaced(each_ref_fn fn, void *cb_data)
{
	struct strbuf buf = STRBUF_INIT;
	int ret = 0;
	unsigned char sha1[20];
	int flag;

	strbuf_addf(&buf, "%sHEAD", get_git_namespace());
1398
	if (!read_ref_full(buf.buf, sha1, 1, &flag))
J
Josh Triplett 已提交
1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414
		ret = fn(buf.buf, sha1, flag, cb_data);
	strbuf_release(&buf);

	return ret;
}

int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
{
	struct strbuf buf = STRBUF_INIT;
	int ret;
	strbuf_addf(&buf, "%srefs/", get_git_namespace());
	ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
	strbuf_release(&buf);
	return ret;
}

1415 1416
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
1417 1418 1419 1420 1421
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

1422
	if (!prefix && prefixcmp(pattern, "refs/"))
I
Ilari Liusvaara 已提交
1423
		strbuf_addstr(&real_pattern, "refs/");
1424 1425
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
1426 1427
	strbuf_addstr(&real_pattern, pattern);

1428
	if (!has_glob_specials(pattern)) {
1429
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
		if (real_pattern.buf[real_pattern.len - 1] != '/')
			strbuf_addch(&real_pattern, '/');
		/* No need to check for '*', there is none. */
		strbuf_addch(&real_pattern, '*');
	}

	filter.pattern = real_pattern.buf;
	filter.fn = fn;
	filter.cb_data = cb_data;
	ret = for_each_ref(filter_refs, &filter);

	strbuf_release(&real_pattern);
	return ret;
}

1445 1446 1447 1448 1449
int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
{
	return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
}

1450 1451
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
1452
	return do_for_each_ref(NULL, "", fn, 0,
1453
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1454 1455
}

1456
const char *prettify_refname(const char *name)
1457 1458 1459 1460 1461 1462 1463 1464
{
	return name + (
		!prefixcmp(name, "refs/heads/") ? 11 :
		!prefixcmp(name, "refs/tags/") ? 10 :
		!prefixcmp(name, "refs/remotes/") ? 13 :
		0);
}

S
Steffen Prohaska 已提交
1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
const char *ref_rev_parse_rules[] = {
	"%.*s",
	"refs/%.*s",
	"refs/tags/%.*s",
	"refs/heads/%.*s",
	"refs/remotes/%.*s",
	"refs/remotes/%.*s/HEAD",
	NULL
};

int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
{
	const char **p;
	const int abbrev_name_len = strlen(abbrev_name);

	for (p = rules; *p; p++) {
		if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
			return 1;
		}
	}

	return 0;
}

J
Junio C Hamano 已提交
1489
static struct ref_lock *verify_lock(struct ref_lock *lock,
1490 1491
	const unsigned char *old_sha1, int mustexist)
{
1492
	if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1493
		error("Can't verify ref %s", lock->ref_name);
1494 1495 1496
		unlock_ref(lock);
		return NULL;
	}
1497
	if (hashcmp(lock->old_sha1, old_sha1)) {
1498
		error("Ref %s is at %s but expected %s", lock->ref_name,
1499 1500 1501 1502 1503 1504 1505
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
		return NULL;
	}
	return lock;
}

1506
static int remove_empty_directories(const char *file)
1507 1508 1509 1510 1511
{
	/* we want to create a file but there is a directory there;
	 * if that is an empty directory (or a directory that contains
	 * only empty directories), remove them.
	 */
1512 1513
	struct strbuf path;
	int result;
1514

1515 1516 1517
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

1518
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1519 1520 1521 1522

	strbuf_release(&path);

	return result;
1523 1524
}

1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559
/*
 * *string and *len will only be substituted, and *string returned (for
 * later free()ing) if the string passed in is a magic short-hand form
 * to name a branch.
 */
static char *substitute_branch_name(const char **string, int *len)
{
	struct strbuf buf = STRBUF_INIT;
	int ret = interpret_branch_name(*string, &buf);

	if (ret == *len) {
		size_t size;
		*string = strbuf_detach(&buf, &size);
		*len = size;
		return (char *)*string;
	}

	return NULL;
}

int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
{
	char *last_branch = substitute_branch_name(&str, &len);
	const char **p, *r;
	int refs_found = 0;

	*ref = NULL;
	for (p = ref_rev_parse_rules; *p; p++) {
		char fullref[PATH_MAX];
		unsigned char sha1_from_ref[20];
		unsigned char *this_result;
		int flag;

		this_result = refs_found ? sha1_from_ref : sha1;
		mksnpath(fullref, sizeof(fullref), *p, len, str);
1560
		r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1561 1562 1563 1564 1565
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
1566
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1567
			warning("ignoring dangling symref %s.", fullref);
1568 1569 1570
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589
	}
	free(last_branch);
	return refs_found;
}

int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
{
	char *last_branch = substitute_branch_name(&str, &len);
	const char **p;
	int logs_found = 0;

	*log = NULL;
	for (p = ref_rev_parse_rules; *p; p++) {
		struct stat st;
		unsigned char hash[20];
		char path[PATH_MAX];
		const char *ref, *it;

		mksnpath(path, sizeof(path), *p, len, str);
1590
		ref = resolve_ref_unsafe(path, hash, 1, NULL);
1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
		if (!ref)
			continue;
		if (!stat(git_path("logs/%s", path), &st) &&
		    S_ISREG(st.st_mode))
			it = path;
		else if (strcmp(ref, path) &&
			 !stat(git_path("logs/%s", ref), &st) &&
			 S_ISREG(st.st_mode))
			it = ref;
		else
			continue;
		if (!logs_found++) {
			*log = xstrdup(it);
			hashcpy(sha1, hash);
		}
		if (!warn_ambiguous_refs)
			break;
	}
	free(last_branch);
	return logs_found;
}

1613 1614 1615
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
					    int flags, int *type_p)
1616
{
1617
	char *ref_file;
1618
	const char *orig_refname = refname;
1619
	struct ref_lock *lock;
1620
	int last_errno = 0;
1621
	int type, lflags;
1622
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1623
	int missing = 0;
1624 1625 1626 1627

	lock = xcalloc(1, sizeof(struct ref_lock));
	lock->lock_fd = -1;

J
Junio C Hamano 已提交
1628
	refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1629
	if (!refname && errno == EISDIR) {
1630 1631 1632 1633 1634
		/* we are trying to lock foo but we used to
		 * have foo/bar which now does not exist;
		 * it is normal for the empty directory 'foo'
		 * to remain.
		 */
1635
		ref_file = git_path("%s", orig_refname);
1636 1637
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
1638
			error("there are still refs under '%s'", orig_refname);
1639 1640
			goto error_return;
		}
J
Junio C Hamano 已提交
1641
		refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1642
	}
1643 1644
	if (type_p)
	    *type_p = type;
1645
	if (!refname) {
1646
		last_errno = errno;
1647
		error("unable to resolve reference %s: %s",
1648
			orig_refname, strerror(errno));
1649
		goto error_return;
1650
	}
1651
	missing = is_null_sha1(lock->old_sha1);
1652 1653 1654 1655 1656
	/* When the ref did not exist and we are creating it,
	 * make sure there is no existing ref that is packed
	 * whose name begins with our refname, nor a ref whose
	 * name is a proper prefix of our refname.
	 */
1657
	if (missing &&
1658
	     !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1659
		last_errno = ENOTDIR;
1660
		goto error_return;
1661
	}
1662

1663
	lock->lk = xcalloc(1, sizeof(struct lock_file));
1664

1665 1666
	lflags = LOCK_DIE_ON_ERROR;
	if (flags & REF_NODEREF) {
1667
		refname = orig_refname;
1668 1669
		lflags |= LOCK_NODEREF;
	}
1670 1671 1672
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
1673
	if (missing)
1674 1675 1676
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
1677

1678 1679 1680 1681 1682
	if (safe_create_leading_directories(ref_file)) {
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
1683

1684
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1685
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1686 1687 1688 1689 1690

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
1691 1692
}

1693
struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
D
Daniel Barkalow 已提交
1694
{
P
Petr Baudis 已提交
1695
	char refpath[PATH_MAX];
1696
	if (check_refname_format(refname, 0))
1697
		return NULL;
1698
	strcpy(refpath, mkpath("refs/%s", refname));
1699
	return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1700 1701
}

1702 1703
struct ref_lock *lock_any_ref_for_update(const char *refname,
					 const unsigned char *old_sha1, int flags)
1704
{
1705
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1706
		return NULL;
1707
	return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
J
Junio C Hamano 已提交
1708 1709
}

1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
struct repack_without_ref_sb {
	const char *refname;
	int fd;
};

static int repack_without_ref_fn(const char *refname, const unsigned char *sha1,
				 int flags, void *cb_data)
{
	struct repack_without_ref_sb *data = cb_data;
	char line[PATH_MAX + 100];
	int len;

	if (!strcmp(data->refname, refname))
		return 0;
	len = snprintf(line, sizeof(line), "%s %s\n",
		       sha1_to_hex(sha1), refname);
	/* this should not happen but just being defensive */
	if (len > sizeof(line))
		die("too long a refname '%s'", refname);
	write_or_die(data->fd, line, len);
	return 0;
}

1733 1734
static struct lock_file packlock;

J
Junio C Hamano 已提交
1735 1736
static int repack_without_ref(const char *refname)
{
1737
	struct repack_without_ref_sb data;
1738
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1739
	if (find_ref(packed, refname) == NULL)
J
Junio C Hamano 已提交
1740
		return 0;
1741 1742 1743
	data.refname = refname;
	data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
	if (data.fd < 0) {
1744
		unable_to_lock_error(git_path("packed-refs"), errno);
J
Junio C Hamano 已提交
1745
		return error("cannot delete '%s' from packed refs", refname);
1746
	}
1747
	do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
J
Junio C Hamano 已提交
1748 1749 1750
	return commit_lock_file(&packlock);
}

M
Miklos Vajna 已提交
1751
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
1752 1753
{
	struct ref_lock *lock;
M
Miklos Vajna 已提交
1754
	int err, i = 0, ret = 0, flag = 0;
J
Junio C Hamano 已提交
1755

1756
	lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
J
Junio C Hamano 已提交
1757 1758
	if (!lock)
		return 1;
1759
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
J
Junio C Hamano 已提交
1760
		/* loose */
M
Miklos Vajna 已提交
1761 1762 1763 1764 1765 1766 1767
		const char *path;

		if (!(delopt & REF_NODEREF)) {
			i = strlen(lock->lk->filename) - 5; /* .lock */
			lock->lk->filename[i] = 0;
			path = lock->lk->filename;
		} else {
1768
			path = git_path("%s", refname);
M
Miklos Vajna 已提交
1769
		}
1770 1771
		err = unlink_or_warn(path);
		if (err && errno != ENOENT)
J
Junio C Hamano 已提交
1772
			ret = 1;
1773

M
Miklos Vajna 已提交
1774 1775
		if (!(delopt & REF_NODEREF))
			lock->lk->filename[i] = '.';
J
Junio C Hamano 已提交
1776 1777 1778 1779 1780 1781 1782
	}
	/* removing the loose one could have resurrected an earlier
	 * packed one.  Also, if it was not loose we need to repack
	 * without it.
	 */
	ret |= repack_without_ref(refname);

1783
	unlink_or_warn(git_path("logs/%s", lock->ref_name));
1784
	invalidate_ref_cache(NULL);
J
Junio C Hamano 已提交
1785 1786
	unlock_ref(lock);
	return ret;
1787 1788
}

1789 1790 1791 1792 1793 1794 1795 1796 1797
/*
 * People using contrib's git-new-workdir have .git/logs/refs ->
 * /some/other/path/.git/logs/refs, and that may live on another device.
 *
 * IOW, to avoid cross device rename errors, the temporary renamed log must
 * live into logs/refs.
 */
#define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"

1798
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1799 1800 1801 1802 1803
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
1804
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
1805
	const char *symref = NULL;
1806
	struct ref_cache *refs = get_ref_cache(NULL);
1807

1808
	if (log && S_ISLNK(loginfo.st_mode))
1809
		return error("reflog for %s is a symlink", oldrefname);
1810

J
Junio C Hamano 已提交
1811
	symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
M
Miklos Vajna 已提交
1812
	if (flag & REF_ISSYMREF)
1813
		return error("refname %s is a symbolic ref, renaming it is not supported",
1814
			oldrefname);
M
Miklos Vajna 已提交
1815
	if (!symref)
1816
		return error("refname %s not found", oldrefname);
1817

1818
	if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1819 1820
		return 1;

1821
	if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1822 1823
		return 1;

1824
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1825
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1826
			oldrefname, strerror(errno));
1827

1828 1829
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
1830 1831 1832
		goto rollback;
	}

1833 1834
	if (!read_ref_full(newrefname, sha1, 1, &flag) &&
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
1835
		if (errno==EISDIR) {
1836 1837
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
1838 1839 1840
				goto rollback;
			}
		} else {
1841
			error("unable to delete existing %s", newrefname);
1842 1843 1844 1845
			goto rollback;
		}
	}

1846 1847
	if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
		error("unable to create directory for %s", newrefname);
1848 1849 1850 1851
		goto rollback;
	}

 retry:
1852
	if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1853 1854 1855 1856 1857 1858
		if (errno==EISDIR || errno==ENOTDIR) {
			/*
			 * rename(a, b) when b is an existing
			 * directory ought to result in ISDIR, but
			 * Solaris 5.8 gives ENOTDIR.  Sheesh.
			 */
1859 1860
			if (remove_empty_directories(git_path("logs/%s", newrefname))) {
				error("Directory not empty: logs/%s", newrefname);
1861 1862 1863 1864
				goto rollback;
			}
			goto retry;
		} else {
1865
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1866
				newrefname, strerror(errno));
1867 1868 1869 1870 1871
			goto rollback;
		}
	}
	logmoved = log;

1872
	lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1873
	if (!lock) {
1874
		error("unable to lock %s for update", newrefname);
1875 1876 1877 1878
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
1879
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1880
		error("unable to write current sha1 into %s", newrefname);
1881 1882 1883 1884 1885 1886
		goto rollback;
	}

	return 0;

 rollback:
1887
	lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1888
	if (!lock) {
1889
		error("unable to lock %s for rollback", oldrefname);
1890 1891 1892 1893 1894 1895 1896
		goto rollbacklog;
	}

	lock->force_write = 1;
	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
	if (write_ref_sha1(lock, orig_sha1, NULL))
1897
		error("unable to write current sha1 into %s", oldrefname);
1898 1899 1900
	log_all_ref_updates = flag;

 rollbacklog:
1901
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1902
		error("unable to restore logfile %s from %s: %s",
1903
			oldrefname, newrefname, strerror(errno));
1904
	if (!logmoved && log &&
1905
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1906
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1907
			oldrefname, strerror(errno));
1908 1909 1910 1911

	return 1;
}

1912
int close_ref(struct ref_lock *lock)
1913 1914 1915 1916 1917 1918 1919
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

1920
int commit_ref(struct ref_lock *lock)
1921 1922 1923 1924 1925 1926 1927
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
1928
void unlock_ref(struct ref_lock *lock)
1929
{
B
Brandon Casey 已提交
1930 1931 1932
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
1933
	free(lock->ref_name);
1934
	free(lock->orig_ref_name);
1935 1936 1937
	free(lock);
}

1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963
/*
 * copy the reflog message msg to buf, which has been allocated sufficiently
 * large, while cleaning up the whitespaces.  Especially, convert LF to space,
 * because reflog file is one line per entry.
 */
static int copy_msg(char *buf, const char *msg)
{
	char *cp = buf;
	char c;
	int wasspace = 1;

	*cp++ = '\t';
	while ((c = *msg++)) {
		if (wasspace && isspace(c))
			continue;
		wasspace = isspace(c);
		if (wasspace)
			c = ' ';
		*cp++ = c;
	}
	while (buf < cp && isspace(cp[-1]))
		cp--;
	*cp++ = '\n';
	return cp - buf;
}

1964
int log_ref_setup(const char *refname, char *logfile, int bufsize)
1965
{
1966
	int logfd, oflags = O_APPEND | O_WRONLY;
1967

1968
	git_snpath(logfile, bufsize, "logs/%s", refname);
1969
	if (log_all_ref_updates &&
1970 1971 1972 1973
	    (!prefixcmp(refname, "refs/heads/") ||
	     !prefixcmp(refname, "refs/remotes/") ||
	     !prefixcmp(refname, "refs/notes/") ||
	     !strcmp(refname, "HEAD"))) {
1974
		if (safe_create_leading_directories(logfile) < 0)
1975
			return error("unable to create directory for %s",
1976
				     logfile);
1977 1978 1979
		oflags |= O_CREAT;
	}

1980
	logfd = open(logfile, oflags, 0666);
1981
	if (logfd < 0) {
J
Junio C Hamano 已提交
1982
		if (!(oflags & O_CREAT) && errno == ENOENT)
1983
			return 0;
1984 1985

		if ((oflags & O_CREAT) && errno == EISDIR) {
1986
			if (remove_empty_directories(logfile)) {
1987
				return error("There are still logs under '%s'",
1988
					     logfile);
1989
			}
1990
			logfd = open(logfile, oflags, 0666);
1991 1992 1993 1994
		}

		if (logfd < 0)
			return error("Unable to append to %s: %s",
1995
				     logfile, strerror(errno));
1996 1997
	}

1998
	adjust_shared_perm(logfile);
1999 2000 2001
	close(logfd);
	return 0;
}
2002

2003
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
2004 2005 2006 2007 2008
			 const unsigned char *new_sha1, const char *msg)
{
	int logfd, result, written, oflags = O_APPEND | O_WRONLY;
	unsigned maxlen, len;
	int msglen;
2009
	char log_file[PATH_MAX];
2010 2011 2012 2013 2014 2015
	char *logrec;
	const char *committer;

	if (log_all_ref_updates < 0)
		log_all_ref_updates = !is_bare_repository();

2016
	result = log_ref_setup(refname, log_file, sizeof(log_file));
2017 2018 2019 2020 2021 2022
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
2023
	msglen = msg ? strlen(msg) : 0;
2024
	committer = git_committer_info(0);
2025 2026 2027
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
2028 2029
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
2030 2031
		      committer);
	if (msglen)
2032
		len += copy_msg(logrec + len - 1, msg) - 1;
2033
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2034
	free(logrec);
2035
	if (close(logfd) != 0 || written != len)
2036
		return error("Unable to append to %s", log_file);
2037 2038 2039
	return 0;
}

2040 2041 2042 2043 2044
static int is_branch(const char *refname)
{
	return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
}

2045 2046 2047 2048
int write_ref_sha1(struct ref_lock *lock,
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
2049
	struct object *o;
2050 2051

	if (!lock)
D
Daniel Barkalow 已提交
2052
		return -1;
2053
	if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2054 2055
		unlock_ref(lock);
		return 0;
D
Daniel Barkalow 已提交
2056
	}
2057 2058
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
2059
		error("Trying to write ref %s with nonexistent object %s",
2060 2061 2062 2063 2064 2065 2066 2067 2068 2069
			lock->ref_name, sha1_to_hex(sha1));
		unlock_ref(lock);
		return -1;
	}
	if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
		error("Trying to write non-commit object %s to branch %s",
			sha1_to_hex(sha1), lock->ref_name);
		unlock_ref(lock);
		return -1;
	}
2070 2071
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
	    write_in_full(lock->lock_fd, &term, 1) != 1
2072
		|| close_ref(lock) < 0) {
2073
		error("Couldn't write %s", lock->lk->filename);
2074 2075 2076
		unlock_ref(lock);
		return -1;
	}
2077
	clear_loose_ref_cache(get_ref_cache(NULL));
N
Nicolas Pitre 已提交
2078 2079 2080
	if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
	    (strcmp(lock->ref_name, lock->orig_ref_name) &&
	     log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
2081 2082 2083
		unlock_ref(lock);
		return -1;
	}
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099
	if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
		/*
		 * Special hack: If a branch is updated directly and HEAD
		 * points to it (may happen on the remote side of a push
		 * for example) then logically the HEAD reflog should be
		 * updated too.
		 * A generic solution implies reverse symref information,
		 * but finding all symrefs pointing to the given branch
		 * would be rather costly for this rare event (the direct
		 * update of a branch) to be worth it.  So let's cheat and
		 * check with HEAD only which should cover 99% of all usage
		 * scenarios (even 100% of the default ones).
		 */
		unsigned char head_sha1[20];
		int head_flag;
		const char *head_ref;
2100
		head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
2101 2102 2103 2104
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
2105
	if (commit_ref(lock)) {
2106
		error("Couldn't set %s", lock->ref_name);
2107 2108 2109 2110 2111
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
2112
}
2113

2114 2115
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
2116 2117 2118 2119
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
2120
	char *git_HEAD = git_pathdup("%s", ref_target);
2121 2122 2123 2124
	unsigned char old_sha1[20], new_sha1[20];

	if (logmsg && read_ref(ref_target, old_sha1))
		hashclr(old_sha1);
2125

2126 2127 2128
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

2129 2130 2131 2132
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
2133
			goto done;
2134 2135 2136 2137 2138 2139 2140
		fprintf(stderr, "no symlink - falling back to symbolic ref\n");
	}
#endif

	len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
	if (sizeof(ref) <= len) {
		error("refname too long: %s", refs_heads_master);
2141
		goto error_free_return;
2142 2143 2144 2145 2146
	}
	lockpath = mkpath("%s.lock", git_HEAD);
	fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
	if (fd < 0) {
		error("Unable to open %s for writing", lockpath);
2147
		goto error_free_return;
2148 2149
	}
	written = write_in_full(fd, ref, len);
2150
	if (close(fd) != 0 || written != len) {
2151
		error("Unable to write to %s", lockpath);
2152
		goto error_unlink_return;
2153 2154 2155
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
2156
		goto error_unlink_return;
2157 2158 2159
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
2160
	error_unlink_return:
2161
		unlink_or_warn(lockpath);
2162 2163 2164
	error_free_return:
		free(git_HEAD);
		return -1;
2165
	}
2166

2167
#ifndef NO_SYMLINK_HEAD
2168
	done:
2169
#endif
2170 2171 2172
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

2173
	free(git_HEAD);
2174 2175 2176
	return 0;
}

2177 2178 2179 2180
static char *ref_msg(const char *line, const char *endp)
{
	const char *ep;
	line += 82;
P
Pierre Habouzit 已提交
2181 2182 2183 2184
	ep = memchr(line, '\n', endp - line);
	if (!ep)
		ep = endp;
	return xmemdupz(line, ep - line);
2185 2186
}

2187 2188 2189
int read_ref_at(const char *refname, unsigned long at_time, int cnt,
		unsigned char *sha1, char **msg,
		unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
2190
{
2191
	const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2192
	char *tz_c;
J
Junio C Hamano 已提交
2193
	int logfd, tz, reccnt = 0;
2194 2195
	struct stat st;
	unsigned long date;
2196
	unsigned char logged_sha1[20];
2197
	void *log_mapped;
2198
	size_t mapsz;
2199

2200
	logfile = git_path("logs/%s", refname);
2201 2202
	logfd = open(logfile, O_RDONLY, 0);
	if (logfd < 0)
2203
		die_errno("Unable to read log '%s'", logfile);
2204 2205 2206
	fstat(logfd, &st);
	if (!st.st_size)
		die("Log %s is empty.", logfile);
2207 2208
	mapsz = xsize_t(st.st_size);
	log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2209
	logdata = log_mapped;
2210 2211
	close(logfd);

2212
	lastrec = NULL;
2213 2214
	rec = logend = logdata + st.st_size;
	while (logdata < rec) {
J
Junio C Hamano 已提交
2215
		reccnt++;
2216 2217
		if (logdata < rec && *(rec-1) == '\n')
			rec--;
2218 2219
		lastgt = NULL;
		while (logdata < rec && *(rec-1) != '\n') {
2220
			rec--;
2221 2222 2223 2224
			if (*rec == '>')
				lastgt = rec;
		}
		if (!lastgt)
2225
			die("Log %s is corrupt.", logfile);
2226
		date = strtoul(lastgt + 1, &tz_c, 10);
2227
		if (date <= at_time || cnt == 0) {
2228
			tz = strtoul(tz_c, NULL, 10);
2229 2230 2231 2232 2233 2234 2235
			if (msg)
				*msg = ref_msg(rec, logend);
			if (cutoff_time)
				*cutoff_time = date;
			if (cutoff_tz)
				*cutoff_tz = tz;
			if (cutoff_cnt)
2236
				*cutoff_cnt = reccnt - 1;
2237 2238 2239 2240 2241
			if (lastrec) {
				if (get_sha1_hex(lastrec, logged_sha1))
					die("Log %s is corrupt.", logfile);
				if (get_sha1_hex(rec + 41, sha1))
					die("Log %s is corrupt.", logfile);
2242
				if (hashcmp(logged_sha1, sha1)) {
2243
					warning("Log %s has gap after %s.",
2244
						logfile, show_date(date, tz, DATE_RFC2822));
2245
				}
J
Junio C Hamano 已提交
2246 2247
			}
			else if (date == at_time) {
2248 2249
				if (get_sha1_hex(rec + 41, sha1))
					die("Log %s is corrupt.", logfile);
J
Junio C Hamano 已提交
2250 2251
			}
			else {
2252 2253
				if (get_sha1_hex(rec + 41, logged_sha1))
					die("Log %s is corrupt.", logfile);
2254
				if (hashcmp(logged_sha1, sha1)) {
2255
					warning("Log %s unexpectedly ended on %s.",
2256
						logfile, show_date(date, tz, DATE_RFC2822));
2257 2258
				}
			}
2259
			munmap(log_mapped, mapsz);
2260 2261
			return 0;
		}
2262
		lastrec = rec;
2263 2264
		if (cnt > 0)
			cnt--;
2265 2266
	}

2267 2268 2269 2270
	rec = logdata;
	while (rec < logend && *rec != '>' && *rec != '\n')
		rec++;
	if (rec == logend || *rec == '\n')
2271
		die("Log %s is corrupt.", logfile);
2272
	date = strtoul(rec + 1, &tz_c, 10);
2273 2274 2275
	tz = strtoul(tz_c, NULL, 10);
	if (get_sha1_hex(logdata, sha1))
		die("Log %s is corrupt.", logfile);
J
Jeff King 已提交
2276 2277 2278 2279
	if (is_null_sha1(sha1)) {
		if (get_sha1_hex(logdata + 41, sha1))
			die("Log %s is corrupt.", logfile);
	}
2280 2281
	if (msg)
		*msg = ref_msg(logdata, logend);
2282
	munmap(log_mapped, mapsz);
2283 2284 2285 2286 2287 2288 2289 2290

	if (cutoff_time)
		*cutoff_time = date;
	if (cutoff_tz)
		*cutoff_tz = tz;
	if (cutoff_cnt)
		*cutoff_cnt = reccnt;
	return 1;
2291
}
2292

2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320
static int show_one_reflog_ent(struct strbuf *sb, each_reflog_ent_fn fn, void *cb_data)
{
	unsigned char osha1[20], nsha1[20];
	char *email_end, *message;
	unsigned long timestamp;
	int tz;

	/* old SP new SP name <email> SP time TAB msg LF */
	if (sb->len < 83 || sb->buf[sb->len - 1] != '\n' ||
	    get_sha1_hex(sb->buf, osha1) || sb->buf[40] != ' ' ||
	    get_sha1_hex(sb->buf + 41, nsha1) || sb->buf[81] != ' ' ||
	    !(email_end = strchr(sb->buf + 82, '>')) ||
	    email_end[1] != ' ' ||
	    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
	    !message || message[0] != ' ' ||
	    (message[1] != '+' && message[1] != '-') ||
	    !isdigit(message[2]) || !isdigit(message[3]) ||
	    !isdigit(message[4]) || !isdigit(message[5]))
		return 0; /* corrupt? */
	email_end[1] = '\0';
	tz = strtol(message + 1, NULL, 10);
	if (message[6] != '\t')
		message += 6;
	else
		message += 7;
	return fn(osha1, nsha1, sb->buf + 82, timestamp, tz, message, cb_data);
}

2321
int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2322 2323
{
	FILE *logfp;
2324
	struct strbuf sb = STRBUF_INIT;
2325
	int ret = 0;
2326

2327
	logfp = fopen(git_path("logs/%s", refname), "r");
2328
	if (!logfp)
2329
		return -1;
2330 2331 2332 2333 2334 2335

	if (ofs) {
		struct stat statbuf;
		if (fstat(fileno(logfp), &statbuf) ||
		    statbuf.st_size < ofs ||
		    fseek(logfp, -ofs, SEEK_END) ||
2336
		    strbuf_getwholeline(&sb, logfp, '\n')) {
2337
			fclose(logfp);
2338
			strbuf_release(&sb);
2339
			return -1;
2340
		}
2341 2342
	}

2343 2344
	while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
		ret = show_one_reflog_ent(&sb, fn, cb_data);
2345
	fclose(logfp);
2346
	strbuf_release(&sb);
2347
	return ret;
2348
}
J
Junio C Hamano 已提交
2349

2350
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2351
{
2352
	return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
2353 2354
}

2355 2356 2357 2358 2359 2360
/*
 * Call fn for each reflog in the namespace indicated by name.  name
 * must be empty or end with '/'.  Name will be used as a scratch
 * space, but its contents will be restored before return.
 */
static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
2361
{
2362
	DIR *d = opendir(git_path("logs/%s", name->buf));
2363
	int retval = 0;
2364
	struct dirent *de;
2365
	int oldlen = name->len;
2366

2367
	if (!d)
2368
		return name->len ? errno : 0;
2369

2370 2371
	while ((de = readdir(d)) != NULL) {
		struct stat st;
2372

2373 2374 2375 2376
		if (de->d_name[0] == '.')
			continue;
		if (has_extension(de->d_name, ".lock"))
			continue;
2377 2378 2379
		strbuf_addstr(name, de->d_name);
		if (stat(git_path("logs/%s", name->buf), &st) < 0) {
			; /* silently ignore */
2380
		} else {
2381
			if (S_ISDIR(st.st_mode)) {
2382 2383
				strbuf_addch(name, '/');
				retval = do_for_each_reflog(name, fn, cb_data);
2384 2385
			} else {
				unsigned char sha1[20];
2386 2387
				if (read_ref_full(name->buf, sha1, 0, NULL))
					retval = error("bad ref for %s", name->buf);
2388
				else
2389
					retval = fn(name->buf, sha1, 0, cb_data);
2390 2391 2392 2393
			}
			if (retval)
				break;
		}
2394
		strbuf_setlen(name, oldlen);
2395
	}
2396
	closedir(d);
2397 2398 2399 2400 2401
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
2402 2403 2404 2405 2406 2407
	int retval;
	struct strbuf name;
	strbuf_init(&name, PATH_MAX);
	retval = do_for_each_reflog(&name, fn, cb_data);
	strbuf_release(&name);
	return retval;
2408
}
C
Carlos Rica 已提交
2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435

int update_ref(const char *action, const char *refname,
		const unsigned char *sha1, const unsigned char *oldval,
		int flags, enum action_on_err onerr)
{
	static struct ref_lock *lock;
	lock = lock_any_ref_for_update(refname, oldval, flags);
	if (!lock) {
		const char *str = "Cannot lock the ref '%s'.";
		switch (onerr) {
		case MSG_ON_ERR: error(str, refname); break;
		case DIE_ON_ERR: die(str, refname); break;
		case QUIET_ON_ERR: break;
		}
		return 1;
	}
	if (write_ref_sha1(lock, sha1, action) < 0) {
		const char *str = "Cannot update the ref '%s'.";
		switch (onerr) {
		case MSG_ON_ERR: error(str, refname); break;
		case DIE_ON_ERR: die(str, refname); break;
		case QUIET_ON_ERR: break;
		}
		return 1;
	}
	return 0;
}
2436

2437
struct ref *find_ref_by_name(const struct ref *list, const char *name)
2438 2439 2440
{
	for ( ; list; list = list->next)
		if (!strcmp(list->name, name))
2441
			return (struct ref *)list;
2442 2443
	return NULL;
}
J
Jeff King 已提交
2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467

/*
 * generate a format suitable for scanf from a ref_rev_parse_rules
 * rule, that is replace the "%.*s" spec with a "%s" spec
 */
static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
{
	char *spec;

	spec = strstr(rule, "%.*s");
	if (!spec || strstr(spec + 4, "%.*s"))
		die("invalid rule in ref_rev_parse_rules: %s", rule);

	/* copy all until spec */
	strncpy(scanf_fmt, rule, spec - rule);
	scanf_fmt[spec - rule] = '\0';
	/* copy new spec */
	strcat(scanf_fmt, "%s");
	/* copy remaining rule */
	strcat(scanf_fmt, spec + 4);

	return;
}

2468
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496
{
	int i;
	static char **scanf_fmts;
	static int nr_rules;
	char *short_name;

	/* pre generate scanf formats from ref_rev_parse_rules[] */
	if (!nr_rules) {
		size_t total_len = 0;

		/* the rule list is NULL terminated, count them first */
		for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
			/* no +1 because strlen("%s") < strlen("%.*s") */
			total_len += strlen(ref_rev_parse_rules[nr_rules]);

		scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);

		total_len = 0;
		for (i = 0; i < nr_rules; i++) {
			scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
					+ total_len;
			gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
			total_len += strlen(ref_rev_parse_rules[i]);
		}
	}

	/* bail out if there are no rules */
	if (!nr_rules)
2497
		return xstrdup(refname);
J
Jeff King 已提交
2498

2499 2500
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
2501 2502 2503 2504

	/* skip first rule, it will always match */
	for (i = nr_rules - 1; i > 0 ; --i) {
		int j;
2505
		int rules_to_fail = i;
J
Jeff King 已提交
2506 2507
		int short_name_len;

2508
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
2509 2510 2511 2512
			continue;

		short_name_len = strlen(short_name);

2513 2514 2515 2516 2517 2518 2519
		/*
		 * in strict mode, all (except the matched one) rules
		 * must fail to resolve to a valid non-ambiguous ref
		 */
		if (strict)
			rules_to_fail = nr_rules;

J
Jeff King 已提交
2520 2521 2522 2523
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
2524
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
2525 2526 2527
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

2528 2529 2530 2531
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
2532 2533 2534 2535 2536 2537 2538
			/*
			 * the short name is ambiguous, if it resolves
			 * (with this previous rule) to a valid ref
			 * read_ref() returns 0 on success
			 */
			mksnpath(refname, sizeof(refname),
				 rule, short_name_len, short_name);
2539
			if (ref_exists(refname))
J
Jeff King 已提交
2540 2541 2542 2543 2544 2545 2546
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
2547
		if (j == rules_to_fail)
J
Jeff King 已提交
2548 2549 2550 2551
			return short_name;
	}

	free(short_name);
2552
	return xstrdup(refname);
J
Jeff King 已提交
2553
}