refs.c 65.8 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
	if (entry->flag & REF_DIR)
263
		clear_ref_dir(get_ref_dir(entry));
264 265 266
	free(entry);
}

267 268 269 270 271 272
/*
 * 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)
273
{
274 275
	ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
	dir->entries[dir->nr++] = entry;
276 277
}

278 279 280
/*
 * Clear and free all entries in dir, recursively.
 */
281
static void clear_ref_dir(struct ref_dir *dir)
282 283
{
	int i;
284 285 286 287 288
	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;
289 290
}

291 292 293 294 295
/*
 * 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.
 */
296
static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
297 298
					  const char *dirname, size_t len,
					  int incomplete)
299 300 301
{
	struct ref_entry *direntry;
	direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
302 303
	memcpy(direntry->name, dirname, len);
	direntry->name[len] = '\0';
304
	direntry->u.subdir.ref_cache = ref_cache;
305
	direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
306 307 308
	return direntry;
}

309
static int ref_entry_cmp(const void *a, const void *b)
310
{
311 312 313 314
	struct ref_entry *one = *(struct ref_entry **)a;
	struct ref_entry *two = *(struct ref_entry **)b;
	return strcmp(one->name, two->name);
}
315

316
static void sort_ref_dir(struct ref_dir *dir);
317

318 319 320 321 322 323 324
struct string_slice {
	size_t len;
	const char *str;
};

static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
{
325 326 327
	const struct string_slice *key = key_;
	const struct ref_entry *ent = *(const struct ref_entry * const *)ent_;
	int cmp = strncmp(key->str, ent->name, key->len);
328 329
	if (cmp)
		return cmp;
330
	return '\0' - (unsigned char)ent->name[key->len];
331 332
}

333 334 335
/*
 * Return the entry with the given refname from the ref_dir
 * (non-recursively), sorting dir if necessary.  Return NULL if no
336
 * such entry is found.  dir must already be complete.
337
 */
338 339
static struct ref_entry *search_ref_dir(struct ref_dir *dir,
					const char *refname, size_t len)
340
{
341 342
	struct ref_entry **r;
	struct string_slice key;
343

344
	if (refname == NULL || !dir->nr)
345 346
		return NULL;

347
	sort_ref_dir(dir);
348 349 350 351
	key.len = len;
	key.str = refname;
	r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
		    ref_entry_cmp_sslice);
352 353 354 355 356 357 358

	if (r == NULL)
		return NULL;

	return *r;
}

359 360 361 362 363
/*
 * 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
364
 * directory cannot be found.  dir must already be complete.
365
 */
366
static struct ref_dir *search_for_subdir(struct ref_dir *dir,
367 368
					 const char *subdirname, size_t len,
					 int mkdir)
369
{
370
	struct ref_entry *entry = search_ref_dir(dir, subdirname, len);
371 372 373
	if (!entry) {
		if (!mkdir)
			return NULL;
374 375 376 377 378 379
		/*
		 * 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.
		 */
380
		entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
381 382
		add_entry_to_dir(dir, entry);
	}
383
	return get_ref_dir(entry);
384 385
}

386 387 388 389
/*
 * 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
390 391 392 393
 * 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.
394 395 396 397
 */
static struct ref_dir *find_containing_dir(struct ref_dir *dir,
					   const char *refname, int mkdir)
{
398 399
	const char *slash;
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
400
		size_t dirnamelen = slash - refname + 1;
401
		struct ref_dir *subdir;
402
		subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
403 404
		if (!subdir) {
			dir = NULL;
405
			break;
406
		}
407
		dir = subdir;
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
	}

	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;
424
	entry = search_ref_dir(dir, refname, strlen(refname));
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
	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;
}

442 443 444 445 446 447 448
/*
 * 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)
{
449
	if (strcmp(ref1->name, ref2->name))
450
		return 0;
451 452 453 454 455 456 457 458 459 460 461 462

	/* 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;
463 464
}

465
/*
466 467
 * Sort the entries in dir non-recursively (if they are not already
 * sorted) and remove any duplicate entries.
468
 */
469
static void sort_ref_dir(struct ref_dir *dir)
470
{
471
	int i, j;
472
	struct ref_entry *last = NULL;
473

474 475 476 477
	/*
	 * This check also prevents passing a zero-length array to qsort(),
	 * which is a problem on some platforms.
	 */
478
	if (dir->sorted == dir->nr)
479
		return;
480

481
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
482

483 484 485 486 487 488 489
	/* 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;
490
	}
491
	dir->sorted = dir->nr = i;
492
}
493

494
#define DO_FOR_EACH_INCLUDE_BROKEN 01
495

496
static struct ref_entry *current_ref;
497

498 499 500
static int do_one_ref(const char *base, each_ref_fn fn, int trim,
		      int flags, void *cb_data, struct ref_entry *entry)
{
501
	int retval;
502 503
	if (prefixcmp(entry->name, base))
		return 0;
504

505 506 507
	if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
		if (entry->flag & REF_ISBROKEN)
			return 0; /* ignore broken refs e.g. dangling symref */
508
		if (!has_sha1_file(entry->u.value.sha1)) {
509 510 511 512 513
			error("%s does not point to a valid object!", entry->name);
			return 0;
		}
	}
	current_ref = entry;
514
	retval = fn(entry->name + trim, entry->u.value.sha1, entry->flag, cb_data);
515 516
	current_ref = NULL;
	return retval;
517
}
518

519
/*
520
 * Call fn for each reference in dir that has index in the range
521 522 523
 * 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.
524
 */
525 526 527
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)
528 529
{
	int i;
530 531
	assert(dir->sorted == dir->nr);
	for (i = offset; i < dir->nr; i++) {
532 533 534
		struct ref_entry *entry = dir->entries[i];
		int retval;
		if (entry->flag & REF_DIR) {
535 536 537
			struct ref_dir *subdir = get_ref_dir(entry);
			sort_ref_dir(subdir);
			retval = do_for_each_ref_in_dir(subdir, 0,
538 539 540 541
							base, fn, trim, flags, cb_data);
		} else {
			retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
		}
542 543 544 545 546 547
		if (retval)
			return retval;
	}
	return 0;
}

548
/*
549
 * Call fn for each reference in the union of dir1 and dir2, in order
550 551 552 553
 * 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.
554
 */
555 556 557 558
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)
559 560 561 562
{
	int retval;
	int i1 = 0, i2 = 0;

563 564
	assert(dir1->sorted == dir1->nr);
	assert(dir2->sorted == dir2->nr);
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
	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. */
582 583 584 585
				struct ref_dir *subdir1 = get_ref_dir(e1);
				struct ref_dir *subdir2 = get_ref_dir(e2);
				sort_ref_dir(subdir1);
				sort_ref_dir(subdir2);
586
				retval = do_for_each_ref_in_dirs(
587
						subdir1, subdir2,
588 589 590 591 592 593 594 595 596 597 598 599
						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);
			}
600
		} else {
601 602 603
			struct ref_entry *e;
			if (cmp < 0) {
				e = e1;
604
				i1++;
605 606 607 608 609
			} else {
				e = e2;
				i2++;
			}
			if (e->flag & REF_DIR) {
610 611
				struct ref_dir *subdir = get_ref_dir(e);
				sort_ref_dir(subdir);
612
				retval = do_for_each_ref_in_dir(
613
						subdir, 0,
614 615 616
						base, fn, trim, flags, cb_data);
			} else {
				retval = do_one_ref(base, fn, trim, flags, cb_data, e);
617 618 619 620 621
			}
		}
		if (retval)
			return retval;
	}
622 623 624 625 626 627
	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);
628 629 630
	return 0;
}

631 632 633 634 635 636 637 638 639
/*
 * 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)
{
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
	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;
661
	}
662
	return 0;
663 664
}

665 666
/*
 * Return true iff a reference named refname could be created without
667 668 669
 * 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
670 671 672
 * operation).
 */
static int is_refname_available(const char *refname, const char *oldrefname,
673
				struct ref_dir *dir)
674
{
675 676 677 678 679
	struct name_conflict_cb data;
	data.refname = refname;
	data.oldrefname = oldrefname;
	data.conflicting_refname = NULL;

680 681 682 683
	sort_ref_dir(dir);
	if (do_for_each_ref_in_dir(dir, 0, "", name_conflict_fn,
				   0, DO_FOR_EACH_INCLUDE_BROKEN,
				   &data)) {
684 685 686
		error("'%s' exists; cannot create '%s'",
		      data.conflicting_refname, refname);
		return 0;
687 688
	}
	return 1;
689 690
}

691 692 693 694
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
695 696
static struct ref_cache {
	struct ref_cache *next;
697 698
	struct ref_entry *loose;
	struct ref_entry *packed;
699 700
	/* The submodule name, or "" for the main repo. */
	char name[FLEX_ARRAY];
701
} *ref_cache;
702

703
static void clear_packed_ref_cache(struct ref_cache *refs)
704
{
705 706 707 708
	if (refs->packed) {
		free_ref_entry(refs->packed);
		refs->packed = NULL;
	}
709
}
710

711 712
static void clear_loose_ref_cache(struct ref_cache *refs)
{
713 714 715 716
	if (refs->loose) {
		free_ref_entry(refs->loose);
		refs->loose = NULL;
	}
717 718
}

719
static struct ref_cache *create_ref_cache(const char *submodule)
720
{
721
	int len;
722
	struct ref_cache *refs;
723 724 725
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
726
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
727
	memcpy(refs->name, submodule, len);
728 729 730
	return refs;
}

731
/*
732
 * Return a pointer to a ref_cache for the specified submodule. For
733 734 735 736
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
737
static struct ref_cache *get_ref_cache(const char *submodule)
738
{
739
	struct ref_cache *refs = ref_cache;
740 741 742 743 744 745
	if (!submodule)
		submodule = "";
	while (refs) {
		if (!strcmp(submodule, refs->name))
			return refs;
		refs = refs->next;
746
	}
747

748 749 750
	refs = create_ref_cache(submodule);
	refs->next = ref_cache;
	ref_cache = refs;
751
	return refs;
752 753
}

754
void invalidate_ref_cache(const char *submodule)
755
{
756 757 758
	struct ref_cache *refs = get_ref_cache(submodule);
	clear_packed_ref_cache(refs);
	clear_loose_ref_cache(refs);
759
}
760

761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
/*
 * 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;
}

794
static void read_packed_refs(FILE *f, struct ref_dir *dir)
795
{
796
	struct ref_entry *last = NULL;
797 798 799 800 801
	char refline[PATH_MAX];
	int flag = REF_ISPACKED;

	while (fgets(refline, sizeof(refline), f)) {
		unsigned char sha1[20];
802
		const char *refname;
803 804 805 806 807 808 809 810 811 812
		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;
		}

813 814
		refname = parse_ref_line(refline, sha1);
		if (refname) {
815
			last = create_ref_entry(refname, sha1, flag, 1);
816
			add_ref(dir, last);
817 818 819 820 821 822 823
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
		    strlen(refline) == 42 &&
		    refline[41] == '\n' &&
		    !get_sha1_hex(refline + 1, sha1))
824
			hashcpy(last->u.value.peeled, sha1);
825 826 827
	}
}

828
static struct ref_dir *get_packed_refs(struct ref_cache *refs)
829
{
830
	if (!refs->packed) {
831 832
		const char *packed_refs_file;
		FILE *f;
833

834
		refs->packed = create_dir_entry(refs, "", 0, 0);
835 836
		if (*refs->name)
			packed_refs_file = git_path_submodule(refs->name, "packed-refs");
837 838 839
		else
			packed_refs_file = git_path("packed-refs");
		f = fopen(packed_refs_file, "r");
840
		if (f) {
841
			read_packed_refs(f, get_ref_dir(refs->packed));
842 843 844
			fclose(f);
		}
	}
845
	return get_ref_dir(refs->packed);
846 847
}

848 849 850 851 852 853
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));
}

854
/*
855 856 857
 * 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.
858
 */
859
static void read_loose_refs(const char *dirname, struct ref_dir *dir)
860
{
861
	struct ref_cache *refs = dir->ref_cache;
862
	DIR *d;
863
	const char *path;
864
	struct dirent *de;
865
	int dirnamelen = strlen(dirname);
866
	struct strbuf refname;
867

M
Michael Haggerty 已提交
868
	if (*refs->name)
869
		path = git_path_submodule(refs->name, "%s", dirname);
870
	else
871
		path = git_path("%s", dirname);
872

873
	d = opendir(path);
874 875 876
	if (!d)
		return;

877 878
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
879 880 881 882 883 884 885 886 887 888 889

	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;
890
		strbuf_addstr(&refname, de->d_name);
891
		refdir = *refs->name
892 893 894 895 896
			? 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)) {
897
			strbuf_addch(&refname, '/');
898
			add_entry_to_dir(dir,
899 900
					 create_dir_entry(refs, refname.buf,
							  refname.len, 1));
901
		} else {
M
Michael Haggerty 已提交
902
			if (*refs->name) {
903
				hashclr(sha1);
904
				flag = 0;
905
				if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
906
					hashclr(sha1);
907
					flag |= REF_ISBROKEN;
908
				}
909
			} else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
910 911 912
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
913 914
			add_entry_to_dir(dir,
					 create_ref_entry(refname.buf, sha1, flag, 1));
915
		}
916
		strbuf_setlen(&refname, dirnamelen);
917
	}
918
	strbuf_release(&refname);
919
	closedir(d);
920 921
}

922
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
923
{
924
	if (!refs->loose) {
925 926 927 928 929
		/*
		 * Mark the top-level directory complete because we
		 * are about to read the only subdirectory that can
		 * hold references:
		 */
930
		refs->loose = create_dir_entry(refs, "", 0, 0);
931 932 933 934
		/*
		 * Create an incomplete entry for "refs/":
		 */
		add_entry_to_dir(get_ref_dir(refs->loose),
935
				 create_dir_entry(refs, "refs/", 5, 1));
936
	}
937
	return get_ref_dir(refs->loose);
938 939
}

940 941
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
942 943
#define MAXREFLEN (1024)

944 945
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
946 947
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
948
 */
949
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
950
				      const char *refname, unsigned char *sha1)
951
{
952
	struct ref_entry *ref;
953
	struct ref_dir *dir = get_packed_refs(refs);
954

955
	ref = find_ref(dir, refname);
956 957 958
	if (ref == NULL)
		return -1;

959
	memcpy(sha1, ref->u.value.sha1, 20);
960
	return 0;
961 962
}

963
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
964
					 const char *refname, unsigned char *sha1,
965
					 int recursion)
966
{
967
	int fd, len;
968
	char buffer[128], *p;
969
	char *path;
970

971
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
972
		return -1;
973 974 975 976
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
977
	if (fd < 0)
978
		return resolve_gitlink_packed_ref(refs, refname, sha1);
979 980 981 982 983 984 985 986 987 988

	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? */
989
	if (!get_sha1_hex(buffer, sha1))
990 991 992 993 994 995 996 997 998
		return 0;

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

999
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1000 1001
}

1002
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1003 1004
{
	int len = strlen(path), retval;
1005
	char *submodule;
1006
	struct ref_cache *refs;
1007 1008 1009 1010 1011

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
1012 1013 1014 1015
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

1016
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1017 1018
	return retval;
}
1019

1020
/*
1021 1022
 * Try to read ref from the packed references.  On success, set sha1
 * and return 0; otherwise, return -1.
1023
 */
1024
static int get_packed_ref(const char *refname, unsigned char *sha1)
1025
{
1026
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1027
	struct ref_entry *entry = find_ref(packed, refname);
1028
	if (entry) {
1029
		hashcpy(sha1, entry->u.value.sha1);
1030
		return 0;
1031 1032 1033 1034
	}
	return -1;
}

J
Junio C Hamano 已提交
1035
const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
1036
{
1037 1038
	int depth = MAXDEPTH;
	ssize_t len;
1039
	char buffer[256];
1040
	static char refname_buffer[256];
1041

1042 1043 1044
	if (flag)
		*flag = 0;

1045
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1046 1047
		return NULL;

1048
	for (;;) {
1049
		char path[PATH_MAX];
1050 1051 1052
		struct stat st;
		char *buf;
		int fd;
1053

1054 1055
		if (--depth < 0)
			return NULL;
1056

1057
		git_snpath(path, sizeof(path), "%s", refname);
1058

1059
		if (lstat(path, &st) < 0) {
1060 1061 1062 1063 1064 1065
			if (errno != ENOENT)
				return NULL;
			/*
			 * The loose reference file does not exist;
			 * check for a packed reference.
			 */
1066
			if (!get_packed_ref(refname, sha1)) {
1067 1068
				if (flag)
					*flag |= REF_ISPACKED;
1069
				return refname;
1070
			}
1071 1072
			/* The reference is not a packed reference, either. */
			if (reading) {
1073
				return NULL;
1074 1075
			} else {
				hashclr(sha1);
1076
				return refname;
1077
			}
1078
		}
1079

1080 1081 1082
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
1083 1084
			if (len < 0)
				return NULL;
M
Michael Haggerty 已提交
1085
			buffer[len] = 0;
1086 1087
			if (!prefixcmp(buffer, "refs/") &&
					!check_refname_format(buffer, 0)) {
1088 1089
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
1090 1091
				if (flag)
					*flag |= REF_ISSYMREF;
1092 1093
				continue;
			}
1094
		}
1095

1096 1097 1098 1099 1100 1101
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

1102 1103 1104 1105 1106 1107 1108
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
		if (fd < 0)
			return NULL;
1109
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
1110
		close(fd);
1111 1112 1113 1114 1115
		if (len < 0)
			return NULL;
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1116 1117 1118 1119

		/*
		 * Is it a symbolic ref?
		 */
1120
		if (prefixcmp(buffer, "ref:"))
1121
			break;
1122 1123
		if (flag)
			*flag |= REF_ISSYMREF;
1124
		buf = buffer + 4;
1125 1126
		while (isspace(*buf))
			buf++;
1127
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1128 1129
			if (flag)
				*flag |= REF_ISBROKEN;
1130 1131
			return NULL;
		}
1132
		refname = strcpy(refname_buffer, buf);
1133
	}
1134 1135
	/* Please note that FETCH_HEAD has a second line containing other data. */
	if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1136 1137
		if (flag)
			*flag |= REF_ISBROKEN;
1138
		return NULL;
1139
	}
1140
	return refname;
1141 1142
}

1143 1144
char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
{
1145
	const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1146 1147 1148
	return ret ? xstrdup(ret) : NULL;
}

I
Ilari Liusvaara 已提交
1149 1150 1151 1152 1153 1154 1155
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1156
int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1157
{
J
Junio C Hamano 已提交
1158
	if (resolve_ref_unsafe(refname, sha1, reading, flags))
1159 1160
		return 0;
	return -1;
1161 1162
}

1163
int read_ref(const char *refname, unsigned char *sha1)
1164
{
1165
	return read_ref_full(refname, sha1, 1, NULL);
1166 1167
}

1168
int ref_exists(const char *refname)
1169
{
1170 1171
	unsigned char sha1[20];
	return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1172 1173
}

1174
static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1175
		       void *data)
I
Ilari Liusvaara 已提交
1176 1177
{
	struct ref_filter *filter = (struct ref_filter *)data;
1178
	if (fnmatch(filter->pattern, refname, 0))
I
Ilari Liusvaara 已提交
1179
		return 0;
1180
	return filter->fn(refname, sha1, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1181 1182
}

1183
int peel_ref(const char *refname, unsigned char *sha1)
1184 1185 1186 1187 1188
{
	int flag;
	unsigned char base[20];
	struct object *o;

1189 1190
	if (current_ref && (current_ref->name == refname
		|| !strcmp(current_ref->name, refname))) {
1191
		if (current_ref->flag & REF_KNOWS_PEELED) {
1192
			hashcpy(sha1, current_ref->u.value.peeled);
1193 1194
			return 0;
		}
1195
		hashcpy(base, current_ref->u.value.sha1);
1196 1197 1198
		goto fallback;
	}

1199
	if (read_ref_full(refname, base, 1, &flag))
1200 1201 1202
		return -1;

	if ((flag & REF_ISPACKED)) {
1203
		struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
1204
		struct ref_entry *r = find_ref(dir, refname);
1205

1206
		if (r != NULL && r->flag & REF_KNOWS_PEELED) {
1207
			hashcpy(sha1, r->u.value.peeled);
1208
			return 0;
1209 1210 1211
		}
	}

1212
fallback:
1213
	o = parse_object(base);
1214
	if (o && o->type == OBJ_TAG) {
1215
		o = deref_tag(o, refname, 0);
1216 1217 1218 1219 1220 1221 1222 1223
		if (o) {
			hashcpy(sha1, o->sha1);
			return 0;
		}
	}
	return -1;
}

1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
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 已提交
1245
	fputc('\n', d->fp);
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
	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);
}

1259 1260
static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
			   int trim, int flags, void *cb_data)
1261
{
1262
	struct ref_cache *refs = get_ref_cache(submodule);
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
	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;
1291 1292
}

1293
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1294 1295
{
	unsigned char sha1[20];
1296 1297
	int flag;

1298 1299 1300 1301 1302 1303 1304
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

1305
	if (!read_ref_full("HEAD", sha1, 1, &flag))
1306
		return fn("HEAD", sha1, flag, cb_data);
1307

1308
	return 0;
1309 1310
}

1311 1312 1313 1314 1315
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

1316 1317 1318 1319 1320
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

1321
int for_each_ref(each_ref_fn fn, void *cb_data)
1322
{
1323
	return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1324 1325
}

1326 1327
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
1328
	return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1329 1330
}

1331 1332
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
1333
	return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1334 1335
}

1336 1337 1338 1339
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);
1340 1341
}

1342
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1343
{
1344
	return for_each_ref_in("refs/tags/", fn, cb_data);
1345 1346
}

1347 1348 1349 1350 1351
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);
}

1352
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1353
{
1354
	return for_each_ref_in("refs/heads/", fn, cb_data);
1355 1356
}

1357 1358 1359 1360 1361
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);
}

1362
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1363
{
1364
	return for_each_ref_in("refs/remotes/", fn, cb_data);
1365 1366
}

1367 1368 1369 1370 1371
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);
}

1372 1373
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
1374
	return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
1375 1376
}

J
Josh Triplett 已提交
1377 1378 1379 1380 1381 1382 1383 1384
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());
1385
	if (!read_ref_full(buf.buf, sha1, 1, &flag))
J
Josh Triplett 已提交
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401
		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;
}

1402 1403
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
1404 1405 1406 1407 1408
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

1409
	if (!prefix && prefixcmp(pattern, "refs/"))
I
Ilari Liusvaara 已提交
1410
		strbuf_addstr(&real_pattern, "refs/");
1411 1412
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
1413 1414
	strbuf_addstr(&real_pattern, pattern);

1415
	if (!has_glob_specials(pattern)) {
1416
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
		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;
}

1432 1433 1434 1435 1436
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);
}

1437 1438
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
1439
	return do_for_each_ref(NULL, "", fn, 0,
1440
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1441 1442
}

1443
const char *prettify_refname(const char *name)
1444 1445 1446 1447 1448 1449 1450 1451
{
	return name + (
		!prefixcmp(name, "refs/heads/") ? 11 :
		!prefixcmp(name, "refs/tags/") ? 10 :
		!prefixcmp(name, "refs/remotes/") ? 13 :
		0);
}

S
Steffen Prohaska 已提交
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
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 已提交
1476
static struct ref_lock *verify_lock(struct ref_lock *lock,
1477 1478
	const unsigned char *old_sha1, int mustexist)
{
1479
	if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1480
		error("Can't verify ref %s", lock->ref_name);
1481 1482 1483
		unlock_ref(lock);
		return NULL;
	}
1484
	if (hashcmp(lock->old_sha1, old_sha1)) {
1485
		error("Ref %s is at %s but expected %s", lock->ref_name,
1486 1487 1488 1489 1490 1491 1492
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
		return NULL;
	}
	return lock;
}

1493
static int remove_empty_directories(const char *file)
1494 1495 1496 1497 1498
{
	/* 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.
	 */
1499 1500
	struct strbuf path;
	int result;
1501

1502 1503 1504
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

1505
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1506 1507 1508 1509

	strbuf_release(&path);

	return result;
1510 1511
}

1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
/*
 * *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);
1547
		r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1548 1549 1550 1551 1552
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
1553
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1554
			warning("ignoring dangling symref %s.", fullref);
1555 1556 1557
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
	}
	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);
1577
		ref = resolve_ref_unsafe(path, hash, 1, NULL);
1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
		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;
}

1600 1601 1602
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
					    int flags, int *type_p)
1603
{
1604
	char *ref_file;
1605
	const char *orig_refname = refname;
1606
	struct ref_lock *lock;
1607
	int last_errno = 0;
1608
	int type, lflags;
1609
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1610
	int missing = 0;
1611 1612 1613 1614

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

J
Junio C Hamano 已提交
1615
	refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1616
	if (!refname && errno == EISDIR) {
1617 1618 1619 1620 1621
		/* 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.
		 */
1622
		ref_file = git_path("%s", orig_refname);
1623 1624
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
1625
			error("there are still refs under '%s'", orig_refname);
1626 1627
			goto error_return;
		}
J
Junio C Hamano 已提交
1628
		refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1629
	}
1630 1631
	if (type_p)
	    *type_p = type;
1632
	if (!refname) {
1633
		last_errno = errno;
1634
		error("unable to resolve reference %s: %s",
1635
			orig_refname, strerror(errno));
1636
		goto error_return;
1637
	}
1638
	missing = is_null_sha1(lock->old_sha1);
1639 1640 1641 1642 1643
	/* 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.
	 */
1644
	if (missing &&
1645
	     !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1646
		last_errno = ENOTDIR;
1647
		goto error_return;
1648
	}
1649

1650
	lock->lk = xcalloc(1, sizeof(struct lock_file));
1651

1652 1653
	lflags = LOCK_DIE_ON_ERROR;
	if (flags & REF_NODEREF) {
1654
		refname = orig_refname;
1655 1656
		lflags |= LOCK_NODEREF;
	}
1657 1658 1659
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
1660
	if (missing)
1661 1662 1663
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
1664

1665 1666 1667 1668 1669
	if (safe_create_leading_directories(ref_file)) {
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
1670

1671
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1672
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1673 1674 1675 1676 1677

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
1678 1679
}

1680
struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
D
Daniel Barkalow 已提交
1681
{
P
Petr Baudis 已提交
1682
	char refpath[PATH_MAX];
1683
	if (check_refname_format(refname, 0))
1684
		return NULL;
1685
	strcpy(refpath, mkpath("refs/%s", refname));
1686
	return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1687 1688
}

1689 1690
struct ref_lock *lock_any_ref_for_update(const char *refname,
					 const unsigned char *old_sha1, int flags)
1691
{
1692
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1693
		return NULL;
1694
	return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
J
Junio C Hamano 已提交
1695 1696
}

1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719
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;
}

1720 1721
static struct lock_file packlock;

J
Junio C Hamano 已提交
1722 1723
static int repack_without_ref(const char *refname)
{
1724
	struct repack_without_ref_sb data;
1725
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1726
	if (find_ref(packed, refname) == NULL)
J
Junio C Hamano 已提交
1727
		return 0;
1728 1729 1730
	data.refname = refname;
	data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
	if (data.fd < 0) {
1731
		unable_to_lock_error(git_path("packed-refs"), errno);
J
Junio C Hamano 已提交
1732
		return error("cannot delete '%s' from packed refs", refname);
1733
	}
1734
	do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
J
Junio C Hamano 已提交
1735 1736 1737
	return commit_lock_file(&packlock);
}

M
Miklos Vajna 已提交
1738
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
1739 1740
{
	struct ref_lock *lock;
M
Miklos Vajna 已提交
1741
	int err, i = 0, ret = 0, flag = 0;
J
Junio C Hamano 已提交
1742

1743
	lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
J
Junio C Hamano 已提交
1744 1745
	if (!lock)
		return 1;
1746
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
J
Junio C Hamano 已提交
1747
		/* loose */
M
Miklos Vajna 已提交
1748 1749 1750 1751 1752 1753 1754
		const char *path;

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

M
Miklos Vajna 已提交
1761 1762
		if (!(delopt & REF_NODEREF))
			lock->lk->filename[i] = '.';
J
Junio C Hamano 已提交
1763 1764 1765 1766 1767 1768 1769
	}
	/* 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);

1770
	unlink_or_warn(git_path("logs/%s", lock->ref_name));
1771
	invalidate_ref_cache(NULL);
J
Junio C Hamano 已提交
1772 1773
	unlock_ref(lock);
	return ret;
1774 1775
}

1776 1777 1778 1779 1780 1781 1782 1783 1784
/*
 * 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"

1785
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1786 1787 1788 1789 1790
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
1791
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
1792
	const char *symref = NULL;
1793
	struct ref_cache *refs = get_ref_cache(NULL);
1794

1795
	if (log && S_ISLNK(loginfo.st_mode))
1796
		return error("reflog for %s is a symlink", oldrefname);
1797

J
Junio C Hamano 已提交
1798
	symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
M
Miklos Vajna 已提交
1799
	if (flag & REF_ISSYMREF)
1800
		return error("refname %s is a symbolic ref, renaming it is not supported",
1801
			oldrefname);
M
Miklos Vajna 已提交
1802
	if (!symref)
1803
		return error("refname %s not found", oldrefname);
1804

1805
	if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1806 1807
		return 1;

1808
	if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1809 1810
		return 1;

1811
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1812
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1813
			oldrefname, strerror(errno));
1814

1815 1816
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
1817 1818 1819
		goto rollback;
	}

1820 1821
	if (!read_ref_full(newrefname, sha1, 1, &flag) &&
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
1822
		if (errno==EISDIR) {
1823 1824
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
1825 1826 1827
				goto rollback;
			}
		} else {
1828
			error("unable to delete existing %s", newrefname);
1829 1830 1831 1832
			goto rollback;
		}
	}

1833 1834
	if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
		error("unable to create directory for %s", newrefname);
1835 1836 1837 1838
		goto rollback;
	}

 retry:
1839
	if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1840 1841 1842 1843 1844 1845
		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.
			 */
1846 1847
			if (remove_empty_directories(git_path("logs/%s", newrefname))) {
				error("Directory not empty: logs/%s", newrefname);
1848 1849 1850 1851
				goto rollback;
			}
			goto retry;
		} else {
1852
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1853
				newrefname, strerror(errno));
1854 1855 1856 1857 1858
			goto rollback;
		}
	}
	logmoved = log;

1859
	lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1860
	if (!lock) {
1861
		error("unable to lock %s for update", newrefname);
1862 1863 1864 1865
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
1866
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1867
		error("unable to write current sha1 into %s", newrefname);
1868 1869 1870 1871 1872 1873
		goto rollback;
	}

	return 0;

 rollback:
1874
	lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1875
	if (!lock) {
1876
		error("unable to lock %s for rollback", oldrefname);
1877 1878 1879 1880 1881 1882 1883
		goto rollbacklog;
	}

	lock->force_write = 1;
	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
	if (write_ref_sha1(lock, orig_sha1, NULL))
1884
		error("unable to write current sha1 into %s", oldrefname);
1885 1886 1887
	log_all_ref_updates = flag;

 rollbacklog:
1888
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1889
		error("unable to restore logfile %s from %s: %s",
1890
			oldrefname, newrefname, strerror(errno));
1891
	if (!logmoved && log &&
1892
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1893
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1894
			oldrefname, strerror(errno));
1895 1896 1897 1898

	return 1;
}

1899
int close_ref(struct ref_lock *lock)
1900 1901 1902 1903 1904 1905 1906
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

1907
int commit_ref(struct ref_lock *lock)
1908 1909 1910 1911 1912 1913 1914
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
1915
void unlock_ref(struct ref_lock *lock)
1916
{
B
Brandon Casey 已提交
1917 1918 1919
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
1920
	free(lock->ref_name);
1921
	free(lock->orig_ref_name);
1922 1923 1924
	free(lock);
}

1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950
/*
 * 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;
}

1951
int log_ref_setup(const char *refname, char *logfile, int bufsize)
1952
{
1953
	int logfd, oflags = O_APPEND | O_WRONLY;
1954

1955
	git_snpath(logfile, bufsize, "logs/%s", refname);
1956
	if (log_all_ref_updates &&
1957 1958 1959 1960
	    (!prefixcmp(refname, "refs/heads/") ||
	     !prefixcmp(refname, "refs/remotes/") ||
	     !prefixcmp(refname, "refs/notes/") ||
	     !strcmp(refname, "HEAD"))) {
1961
		if (safe_create_leading_directories(logfile) < 0)
1962
			return error("unable to create directory for %s",
1963
				     logfile);
1964 1965 1966
		oflags |= O_CREAT;
	}

1967
	logfd = open(logfile, oflags, 0666);
1968
	if (logfd < 0) {
J
Junio C Hamano 已提交
1969
		if (!(oflags & O_CREAT) && errno == ENOENT)
1970
			return 0;
1971 1972

		if ((oflags & O_CREAT) && errno == EISDIR) {
1973
			if (remove_empty_directories(logfile)) {
1974
				return error("There are still logs under '%s'",
1975
					     logfile);
1976
			}
1977
			logfd = open(logfile, oflags, 0666);
1978 1979 1980 1981
		}

		if (logfd < 0)
			return error("Unable to append to %s: %s",
1982
				     logfile, strerror(errno));
1983 1984
	}

1985
	adjust_shared_perm(logfile);
1986 1987 1988
	close(logfd);
	return 0;
}
1989

1990
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
1991 1992 1993 1994 1995
			 const unsigned char *new_sha1, const char *msg)
{
	int logfd, result, written, oflags = O_APPEND | O_WRONLY;
	unsigned maxlen, len;
	int msglen;
1996
	char log_file[PATH_MAX];
1997 1998 1999 2000 2001 2002
	char *logrec;
	const char *committer;

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

2003
	result = log_ref_setup(refname, log_file, sizeof(log_file));
2004 2005 2006 2007 2008 2009
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
2010
	msglen = msg ? strlen(msg) : 0;
2011
	committer = git_committer_info(0);
2012 2013 2014
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
2015 2016
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
2017 2018
		      committer);
	if (msglen)
2019
		len += copy_msg(logrec + len - 1, msg) - 1;
2020
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2021
	free(logrec);
2022
	if (close(logfd) != 0 || written != len)
2023
		return error("Unable to append to %s", log_file);
2024 2025 2026
	return 0;
}

2027 2028 2029 2030 2031
static int is_branch(const char *refname)
{
	return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
}

2032 2033 2034 2035
int write_ref_sha1(struct ref_lock *lock,
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
2036
	struct object *o;
2037 2038

	if (!lock)
D
Daniel Barkalow 已提交
2039
		return -1;
2040
	if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2041 2042
		unlock_ref(lock);
		return 0;
D
Daniel Barkalow 已提交
2043
	}
2044 2045
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
2046
		error("Trying to write ref %s with nonexistent object %s",
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056
			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;
	}
2057 2058
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
	    write_in_full(lock->lock_fd, &term, 1) != 1
2059
		|| close_ref(lock) < 0) {
2060
		error("Couldn't write %s", lock->lk->filename);
2061 2062 2063
		unlock_ref(lock);
		return -1;
	}
2064
	clear_loose_ref_cache(get_ref_cache(NULL));
N
Nicolas Pitre 已提交
2065 2066 2067
	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)) {
2068 2069 2070
		unlock_ref(lock);
		return -1;
	}
2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086
	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;
2087
		head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
2088 2089 2090 2091
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
2092
	if (commit_ref(lock)) {
2093
		error("Couldn't set %s", lock->ref_name);
2094 2095 2096 2097 2098
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
2099
}
2100

2101 2102
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
2103 2104 2105 2106
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
2107
	char *git_HEAD = git_pathdup("%s", ref_target);
2108 2109 2110 2111
	unsigned char old_sha1[20], new_sha1[20];

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

2113 2114 2115
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

2116 2117 2118 2119
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
2120
			goto done;
2121 2122 2123 2124 2125 2126 2127
		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);
2128
		goto error_free_return;
2129 2130 2131 2132 2133
	}
	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);
2134
		goto error_free_return;
2135 2136
	}
	written = write_in_full(fd, ref, len);
2137
	if (close(fd) != 0 || written != len) {
2138
		error("Unable to write to %s", lockpath);
2139
		goto error_unlink_return;
2140 2141 2142
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
2143
		goto error_unlink_return;
2144 2145 2146
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
2147
	error_unlink_return:
2148
		unlink_or_warn(lockpath);
2149 2150 2151
	error_free_return:
		free(git_HEAD);
		return -1;
2152
	}
2153

2154
#ifndef NO_SYMLINK_HEAD
2155
	done:
2156
#endif
2157 2158 2159
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

2160
	free(git_HEAD);
2161 2162 2163
	return 0;
}

2164 2165 2166 2167
static char *ref_msg(const char *line, const char *endp)
{
	const char *ep;
	line += 82;
P
Pierre Habouzit 已提交
2168 2169 2170 2171
	ep = memchr(line, '\n', endp - line);
	if (!ep)
		ep = endp;
	return xmemdupz(line, ep - line);
2172 2173
}

2174 2175 2176
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)
2177
{
2178
	const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2179
	char *tz_c;
J
Junio C Hamano 已提交
2180
	int logfd, tz, reccnt = 0;
2181 2182
	struct stat st;
	unsigned long date;
2183
	unsigned char logged_sha1[20];
2184
	void *log_mapped;
2185
	size_t mapsz;
2186

2187
	logfile = git_path("logs/%s", refname);
2188 2189
	logfd = open(logfile, O_RDONLY, 0);
	if (logfd < 0)
2190
		die_errno("Unable to read log '%s'", logfile);
2191 2192 2193
	fstat(logfd, &st);
	if (!st.st_size)
		die("Log %s is empty.", logfile);
2194 2195
	mapsz = xsize_t(st.st_size);
	log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2196
	logdata = log_mapped;
2197 2198
	close(logfd);

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

2254 2255 2256 2257
	rec = logdata;
	while (rec < logend && *rec != '>' && *rec != '\n')
		rec++;
	if (rec == logend || *rec == '\n')
2258
		die("Log %s is corrupt.", logfile);
2259
	date = strtoul(rec + 1, &tz_c, 10);
2260 2261 2262
	tz = strtoul(tz_c, NULL, 10);
	if (get_sha1_hex(logdata, sha1))
		die("Log %s is corrupt.", logfile);
J
Jeff King 已提交
2263 2264 2265 2266
	if (is_null_sha1(sha1)) {
		if (get_sha1_hex(logdata + 41, sha1))
			die("Log %s is corrupt.", logfile);
	}
2267 2268
	if (msg)
		*msg = ref_msg(logdata, logend);
2269
	munmap(log_mapped, mapsz);
2270 2271 2272 2273 2274 2275 2276 2277

	if (cutoff_time)
		*cutoff_time = date;
	if (cutoff_tz)
		*cutoff_tz = tz;
	if (cutoff_cnt)
		*cutoff_cnt = reccnt;
	return 1;
2278
}
2279

2280
int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2281 2282 2283
{
	const char *logfile;
	FILE *logfp;
2284
	struct strbuf sb = STRBUF_INIT;
2285
	int ret = 0;
2286

2287
	logfile = git_path("logs/%s", refname);
2288 2289
	logfp = fopen(logfile, "r");
	if (!logfp)
2290
		return -1;
2291 2292 2293 2294 2295 2296

	if (ofs) {
		struct stat statbuf;
		if (fstat(fileno(logfp), &statbuf) ||
		    statbuf.st_size < ofs ||
		    fseek(logfp, -ofs, SEEK_END) ||
2297
		    strbuf_getwholeline(&sb, logfp, '\n')) {
2298
			fclose(logfp);
2299
			strbuf_release(&sb);
2300
			return -1;
2301
		}
2302 2303
	}

2304
	while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2305
		unsigned char osha1[20], nsha1[20];
2306 2307
		char *email_end, *message;
		unsigned long timestamp;
2308
		int tz;
2309 2310

		/* old SP new SP name <email> SP time TAB msg LF */
2311 2312 2313 2314
		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, '>')) ||
2315 2316 2317 2318 2319
		    email_end[1] != ' ' ||
		    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
		    !message || message[0] != ' ' ||
		    (message[1] != '+' && message[1] != '-') ||
		    !isdigit(message[2]) || !isdigit(message[3]) ||
2320
		    !isdigit(message[4]) || !isdigit(message[5]))
2321
			continue; /* corrupt? */
2322 2323
		email_end[1] = '\0';
		tz = strtol(message + 1, NULL, 10);
2324 2325 2326 2327
		if (message[6] != '\t')
			message += 6;
		else
			message += 7;
2328 2329
		ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
			 cb_data);
2330
		if (ret)
2331
			break;
2332 2333
	}
	fclose(logfp);
2334
	strbuf_release(&sb);
2335
	return ret;
2336
}
J
Junio C Hamano 已提交
2337

2338
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2339
{
2340
	return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
2341 2342
}

2343 2344 2345 2346 2347 2348
/*
 * 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)
2349
{
2350
	DIR *d = opendir(git_path("logs/%s", name->buf));
2351
	int retval = 0;
2352
	struct dirent *de;
2353
	int oldlen = name->len;
2354

2355
	if (!d)
2356
		return name->len ? errno : 0;
2357

2358 2359
	while ((de = readdir(d)) != NULL) {
		struct stat st;
2360

2361 2362 2363 2364
		if (de->d_name[0] == '.')
			continue;
		if (has_extension(de->d_name, ".lock"))
			continue;
2365 2366 2367
		strbuf_addstr(name, de->d_name);
		if (stat(git_path("logs/%s", name->buf), &st) < 0) {
			; /* silently ignore */
2368
		} else {
2369
			if (S_ISDIR(st.st_mode)) {
2370 2371
				strbuf_addch(name, '/');
				retval = do_for_each_reflog(name, fn, cb_data);
2372 2373
			} else {
				unsigned char sha1[20];
2374 2375
				if (read_ref_full(name->buf, sha1, 0, NULL))
					retval = error("bad ref for %s", name->buf);
2376
				else
2377
					retval = fn(name->buf, sha1, 0, cb_data);
2378 2379 2380 2381
			}
			if (retval)
				break;
		}
2382
		strbuf_setlen(name, oldlen);
2383
	}
2384
	closedir(d);
2385 2386 2387 2388 2389
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
2390 2391 2392 2393 2394 2395
	int retval;
	struct strbuf name;
	strbuf_init(&name, PATH_MAX);
	retval = do_for_each_reflog(&name, fn, cb_data);
	strbuf_release(&name);
	return retval;
2396
}
C
Carlos Rica 已提交
2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423

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;
}
2424

2425
struct ref *find_ref_by_name(const struct ref *list, const char *name)
2426 2427 2428
{
	for ( ; list; list = list->next)
		if (!strcmp(list->name, name))
2429
			return (struct ref *)list;
2430 2431
	return NULL;
}
J
Jeff King 已提交
2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455

/*
 * 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;
}

2456
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484
{
	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)
2485
		return xstrdup(refname);
J
Jeff King 已提交
2486

2487 2488
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
2489 2490 2491 2492

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

2496
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
2497 2498 2499 2500
			continue;

		short_name_len = strlen(short_name);

2501 2502 2503 2504 2505 2506 2507
		/*
		 * 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 已提交
2508 2509 2510 2511
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
2512
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
2513 2514 2515
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

2516 2517 2518 2519
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
2520 2521 2522 2523 2524 2525 2526
			/*
			 * 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);
2527
			if (ref_exists(refname))
J
Jeff King 已提交
2528 2529 2530 2531 2532 2533 2534
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
2535
		if (j == rules_to_fail)
J
Jeff King 已提交
2536 2537 2538 2539
			return short_name;
	}

	free(short_name);
2540
	return xstrdup(refname);
J
Jeff King 已提交
2541
}