refs.c 108.0 KB
Newer Older
D
Daniel Barkalow 已提交
1
#include "cache.h"
2
#include "lockfile.h"
3
#include "refs.h"
4 5
#include "object.h"
#include "tag.h"
6
#include "dir.h"
7
#include "string-list.h"
D
Daniel Barkalow 已提交
8

9 10 11 12 13 14 15 16 17
struct ref_lock {
	char *ref_name;
	char *orig_ref_name;
	struct lock_file *lk;
	unsigned char old_sha1[20];
	int lock_fd;
	int force_write;
};

18
/*
19 20
 * How to handle various characters in refnames:
 * 0: An acceptable character for refs
21 22 23 24
 * 1: End-of-component
 * 2: ., look for a preceding . to reject .. in refs
 * 3: {, look for a preceding @ to reject @{ in refs
 * 4: A bad character: ASCII control characters, "~", "^", ":" or SP
25 26
 */
static unsigned char refname_disposition[256] = {
27 28 29 30
	1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
	4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4,
	4, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 2, 1,
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 0, 0, 0, 4,
31
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
32 33 34
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4, 0, 4, 0,
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
	0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0, 0, 4, 4
35 36
};

37 38 39 40 41
/*
 * Used as a flag to ref_transaction_delete when a loose ref is being
 * pruned.
 */
#define REF_ISPRUNING	0x0100
42 43 44 45 46
/*
 * 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.  It is legal if it is something reasonable to have under
 * ".git/refs/"; We do not like it if:
47 48 49 50
 *
 * - any path component of it begins with ".", or
 * - it has double dots "..", or
 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
51 52
 * - it ends with a "/".
 * - it ends with ".lock"
53 54 55 56 57 58 59 60
 * - it contains a "\" (backslash)
 */
static int check_refname_component(const char *refname, int flags)
{
	const char *cp;
	char last = '\0';

	for (cp = refname; ; cp++) {
61 62 63
		int ch = *cp & 255;
		unsigned char disp = refname_disposition[ch];
		switch (disp) {
64
		case 1:
65
			goto out;
66
		case 2:
67 68 69
			if (last == '.')
				return -1; /* Refname contains "..". */
			break;
70
		case 3:
71 72
			if (last == '@')
				return -1; /* Refname contains "@{". */
73
			break;
74
		case 4:
75 76
			return -1;
		}
77 78
		last = ch;
	}
79
out:
80
	if (cp == refname)
81
		return 0; /* Component has zero length. */
82 83
	if (refname[0] == '.')
		return -1; /* Component starts with '.'. */
84 85
	if (cp - refname >= LOCK_SUFFIX_LEN &&
	    !memcmp(cp - LOCK_SUFFIX_LEN, LOCK_SUFFIX, LOCK_SUFFIX_LEN))
86 87 88 89
		return -1; /* Refname ends with ".lock". */
	return cp - refname;
}

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

F
Felipe Contreras 已提交
94 95 96 97
	if (!strcmp(refname, "@"))
		/* Refname is a single character '@'. */
		return -1;

98 99 100
	while (1) {
		/* We are at the start of a path component. */
		component_len = check_refname_component(refname, flags);
101
		if (component_len <= 0) {
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
			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;
127

128 129 130 131 132 133
/*
 * 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.
 */
134
struct ref_value {
135 136 137 138 139 140
	/*
	 * The name of the object to which this reference resolves
	 * (which may be a tag object).  If REF_ISBROKEN, this is
	 * null.  If REF_ISSYMREF, then this is the name of the object
	 * referred to by the last reference in the symlink chain.
	 */
141
	unsigned char sha1[20];
142 143 144 145

	/*
	 * If REF_KNOWS_PEELED, then this field holds the peeled value
	 * of this reference, or null if the reference is known not to
146 147
	 * be peelable.  See the documentation for peel_ref() for an
	 * exact definition of "peelable".
148
	 */
149 150 151
	unsigned char peeled[20];
};

152 153
struct ref_cache;

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
/*
 * 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().
 */
180
struct ref_dir {
181
	int nr, alloc;
182 183 184 185 186 187 188 189 190

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

191 192 193
	/* A pointer to the ref_cache that contains this ref_dir. */
	struct ref_cache *ref_cache;

194
	struct ref_entry **entries;
195 196
};

197 198
/*
 * Bit values for ref_entry::flag.  REF_ISSYMREF=0x01,
199 200
 * REF_ISPACKED=0x02, REF_ISBROKEN=0x04 and REF_BAD_NAME=0x08 are
 * public values; see refs.h.
201 202 203 204 205 206 207
 */

/*
 * The field ref_entry->u.value.peeled of this value entry contains
 * the correct peeled value for the reference, which might be
 * null_sha1 if the reference is not a tag or if it is broken.
 */
208
#define REF_KNOWS_PEELED 0x10
209 210

/* ref_entry represents a directory of references */
211
#define REF_DIR 0x20
212

213 214 215 216
/*
 * Entry has not yet been read from disk (used only for REF_DIR
 * entries representing loose references)
 */
217
#define REF_INCOMPLETE 0x40
218

219 220
/*
 * A ref_entry represents either a reference or a "subdirectory" of
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
 * 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).
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
 *
 * 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.
 */
258 259
struct ref_entry {
	unsigned char flag; /* ISSYMREF? ISPACKED? */
260
	union {
261 262
		struct ref_value value; /* if not (flags&REF_DIR) */
		struct ref_dir subdir; /* if (flags&REF_DIR) */
263
	} u;
264 265 266 267 268
	/*
	 * 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/"):
	 */
269 270
	char name[FLEX_ARRAY];
};
271

272 273
static void read_loose_refs(const char *dirname, struct ref_dir *dir);

274 275
static struct ref_dir *get_ref_dir(struct ref_entry *entry)
{
276
	struct ref_dir *dir;
277
	assert(entry->flag & REF_DIR);
278 279 280 281 282 283
	dir = &entry->u.subdir;
	if (entry->flag & REF_INCOMPLETE) {
		read_loose_refs(entry->name, dir);
		entry->flag &= ~REF_INCOMPLETE;
	}
	return dir;
284 285
}

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
/*
 * Check if a refname is safe.
 * For refs that start with "refs/" we consider it safe as long they do
 * not try to resolve to outside of refs/.
 *
 * For all other refs we only consider them safe iff they only contain
 * upper case characters and '_' (like "HEAD" AND "MERGE_HEAD", and not like
 * "config").
 */
static int refname_is_safe(const char *refname)
{
	if (starts_with(refname, "refs/")) {
		char *buf;
		int result;

		buf = xmalloc(strlen(refname) + 1);
		/*
		 * Does the refname try to escape refs/?
		 * For example: refs/foo/../bar is safe but refs/foo/../../bar
		 * is not.
		 */
		result = !normalize_path_copy(buf, refname + strlen("refs/"));
		free(buf);
		return result;
	}
	while (*refname) {
		if (!isupper(*refname) && *refname != '_')
			return 0;
		refname++;
	}
	return 1;
}

319 320 321
static struct ref_entry *create_ref_entry(const char *refname,
					  const unsigned char *sha1, int flag,
					  int check_name)
322 323
{
	int len;
324
	struct ref_entry *ref;
325

326
	if (check_name &&
327
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
328
		die("Reference has invalid format: '%s'", refname);
329 330
	if (!check_name && !refname_is_safe(refname))
		die("Reference has invalid name: '%s'", refname);
331 332
	len = strlen(refname) + 1;
	ref = xmalloc(sizeof(struct ref_entry) + len);
333 334
	hashcpy(ref->u.value.sha1, sha1);
	hashclr(ref->u.value.peeled);
335 336 337 338 339
	memcpy(ref->name, refname, len);
	ref->flag = flag;
	return ref;
}

340 341
static void clear_ref_dir(struct ref_dir *dir);

342 343
static void free_ref_entry(struct ref_entry *entry)
{
344 345 346 347 348 349 350
	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);
	}
351 352 353
	free(entry);
}

354 355 356 357 358 359
/*
 * 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)
360
{
361 362
	ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
	dir->entries[dir->nr++] = entry;
363 364 365 366 367 368
	/* 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;
369 370
}

371 372 373
/*
 * Clear and free all entries in dir, recursively.
 */
374
static void clear_ref_dir(struct ref_dir *dir)
375 376
{
	int i;
377 378 379 380 381
	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;
382 383
}

384 385 386 387 388
/*
 * 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.
 */
389
static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
390 391
					  const char *dirname, size_t len,
					  int incomplete)
392 393 394
{
	struct ref_entry *direntry;
	direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
395 396
	memcpy(direntry->name, dirname, len);
	direntry->name[len] = '\0';
397
	direntry->u.subdir.ref_cache = ref_cache;
398
	direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
399 400 401
	return direntry;
}

402
static int ref_entry_cmp(const void *a, const void *b)
403
{
404 405 406 407
	struct ref_entry *one = *(struct ref_entry **)a;
	struct ref_entry *two = *(struct ref_entry **)b;
	return strcmp(one->name, two->name);
}
408

409
static void sort_ref_dir(struct ref_dir *dir);
410

411 412 413 414 415 416 417
struct string_slice {
	size_t len;
	const char *str;
};

static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
{
418 419 420
	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);
421 422
	if (cmp)
		return cmp;
423
	return '\0' - (unsigned char)ent->name[key->len];
424 425
}

426
/*
427 428 429
 * Return the index of the entry with the given refname from the
 * ref_dir (non-recursively), sorting dir if necessary.  Return -1 if
 * no such entry is found.  dir must already be complete.
430
 */
431
static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
432
{
433 434
	struct ref_entry **r;
	struct string_slice key;
435

436
	if (refname == NULL || !dir->nr)
437
		return -1;
438

439
	sort_ref_dir(dir);
440 441 442 443
	key.len = len;
	key.str = refname;
	r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
		    ref_entry_cmp_sslice);
444 445

	if (r == NULL)
446
		return -1;
447

448
	return r - dir->entries;
449 450
}

451 452 453 454 455
/*
 * 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
456
 * directory cannot be found.  dir must already be complete.
457
 */
458
static struct ref_dir *search_for_subdir(struct ref_dir *dir,
459 460
					 const char *subdirname, size_t len,
					 int mkdir)
461
{
462 463 464
	int entry_index = search_ref_dir(dir, subdirname, len);
	struct ref_entry *entry;
	if (entry_index == -1) {
465 466
		if (!mkdir)
			return NULL;
467 468 469 470 471 472
		/*
		 * 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.
		 */
473
		entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
474
		add_entry_to_dir(dir, entry);
475 476
	} else {
		entry = dir->entries[entry_index];
477
	}
478
	return get_ref_dir(entry);
479 480
}

481 482 483 484
/*
 * 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
485 486 487 488
 * 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.
489 490 491 492
 */
static struct ref_dir *find_containing_dir(struct ref_dir *dir,
					   const char *refname, int mkdir)
{
493 494
	const char *slash;
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
495
		size_t dirnamelen = slash - refname + 1;
496
		struct ref_dir *subdir;
497
		subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
498 499
		if (!subdir) {
			dir = NULL;
500
			break;
501
		}
502
		dir = subdir;
503 504 505 506 507 508 509 510 511 512 513 514
	}

	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)
{
515
	int entry_index;
516 517 518 519
	struct ref_entry *entry;
	dir = find_containing_dir(dir, refname, 0);
	if (!dir)
		return NULL;
520 521 522 523 524
	entry_index = search_ref_dir(dir, refname, strlen(refname));
	if (entry_index == -1)
		return NULL;
	entry = dir->entries[entry_index];
	return (entry->flag & REF_DIR) ? NULL : entry;
525 526
}

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
/*
 * Remove the entry with the given name from dir, recursing into
 * subdirectories as necessary.  If refname is the name of a directory
 * (i.e., ends with '/'), then remove the directory and its contents.
 * If the removal was successful, return the number of entries
 * remaining in the directory entry that contained the deleted entry.
 * If the name was not found, return -1.  Please note that this
 * function only deletes the entry from the cache; it does not delete
 * it from the filesystem or ensure that other cache entries (which
 * might be symbolic references to the removed entry) are updated.
 * Nor does it remove any containing dir entries that might be made
 * empty by the removal.  dir must represent the top-level directory
 * and must already be complete.
 */
static int remove_entry(struct ref_dir *dir, const char *refname)
{
	int refname_len = strlen(refname);
	int entry_index;
	struct ref_entry *entry;
	int is_dir = refname[refname_len - 1] == '/';
	if (is_dir) {
		/*
		 * refname represents a reference directory.  Remove
		 * the trailing slash; otherwise we will get the
		 * directory *representing* refname rather than the
		 * one *containing* it.
		 */
		char *dirname = xmemdupz(refname, refname_len - 1);
		dir = find_containing_dir(dir, dirname, 0);
		free(dirname);
	} else {
		dir = find_containing_dir(dir, refname, 0);
	}
	if (!dir)
		return -1;
	entry_index = search_ref_dir(dir, refname, refname_len);
	if (entry_index == -1)
		return -1;
	entry = dir->entries[entry_index];

	memmove(&dir->entries[entry_index],
		&dir->entries[entry_index + 1],
		(dir->nr - entry_index - 1) * sizeof(*dir->entries)
		);
	dir->nr--;
	if (dir->sorted > entry_index)
		dir->sorted--;
	free_ref_entry(entry);
	return dir->nr;
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
}

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

592 593 594 595 596 597 598
/*
 * 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)
{
599
	if (strcmp(ref1->name, ref2->name))
600
		return 0;
601 602 603 604 605 606 607 608 609 610 611 612

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

615
/*
616 617
 * Sort the entries in dir non-recursively (if they are not already
 * sorted) and remove any duplicate entries.
618
 */
619
static void sort_ref_dir(struct ref_dir *dir)
620
{
621
	int i, j;
622
	struct ref_entry *last = NULL;
623

624 625 626 627
	/*
	 * This check also prevents passing a zero-length array to qsort(),
	 * which is a problem on some platforms.
	 */
628
	if (dir->sorted == dir->nr)
629
		return;
630

631
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
632

633 634 635 636 637 638 639
	/* 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;
640
	}
641
	dir->sorted = dir->nr = i;
642
}
643

644 645
/* Include broken references in a do_for_each_ref*() iteration: */
#define DO_FOR_EACH_INCLUDE_BROKEN 0x01
646

647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
/*
 * Return true iff the reference described by entry can be resolved to
 * an object in the database.  Emit a warning if the referred-to
 * object does not exist.
 */
static int ref_resolves_to_object(struct ref_entry *entry)
{
	if (entry->flag & REF_ISBROKEN)
		return 0;
	if (!has_sha1_file(entry->u.value.sha1)) {
		error("%s does not point to a valid object!", entry->name);
		return 0;
	}
	return 1;
}
662

663 664 665 666 667 668 669 670 671
/*
 * current_ref is a performance hack: when iterating over references
 * using the for_each_ref*() functions, current_ref is set to the
 * current reference's entry before calling the callback function.  If
 * the callback function calls peel_ref(), then peel_ref() first
 * checks whether the reference to be peeled is the current reference
 * (it usually is) and if so, returns that reference's peeled version
 * if it is available.  This avoids a refname lookup in a common case.
 */
672
static struct ref_entry *current_ref;
673

674 675 676 677 678 679 680 681 682 683
typedef int each_ref_entry_fn(struct ref_entry *entry, void *cb_data);

struct ref_entry_cb {
	const char *base;
	int trim;
	int flags;
	each_ref_fn *fn;
	void *cb_data;
};

684
/*
685 686
 * Handle one reference in a do_for_each_ref*()-style iteration,
 * calling an each_ref_fn for each entry.
687
 */
688
static int do_one_ref(struct ref_entry *entry, void *cb_data)
689
{
690
	struct ref_entry_cb *data = cb_data;
691
	struct ref_entry *old_current_ref;
692
	int retval;
693

694
	if (!starts_with(entry->name, data->base))
695
		return 0;
696

697
	if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
698
	      !ref_resolves_to_object(entry))
699
		return 0;
700

701 702
	/* Store the old value, in case this is a recursive call: */
	old_current_ref = current_ref;
703
	current_ref = entry;
704 705
	retval = data->fn(entry->name + data->trim, entry->u.value.sha1,
			  entry->flag, data->cb_data);
706
	current_ref = old_current_ref;
707
	return retval;
708
}
709

710
/*
711
 * Call fn for each reference in dir that has index in the range
712 713
 * offset <= index < dir->nr.  Recurse into subdirectories that are in
 * that index range, sorting them before iterating.  This function
714 715
 * does not sort dir itself; it should be sorted beforehand.  fn is
 * called for all references, including broken ones.
716
 */
717 718
static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
				    each_ref_entry_fn fn, void *cb_data)
719 720
{
	int i;
721 722
	assert(dir->sorted == dir->nr);
	for (i = offset; i < dir->nr; i++) {
723 724 725
		struct ref_entry *entry = dir->entries[i];
		int retval;
		if (entry->flag & REF_DIR) {
726 727
			struct ref_dir *subdir = get_ref_dir(entry);
			sort_ref_dir(subdir);
728
			retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
729
		} else {
730
			retval = fn(entry, cb_data);
731
		}
732 733 734 735 736 737
		if (retval)
			return retval;
	}
	return 0;
}

738
/*
739
 * Call fn for each reference in the union of dir1 and dir2, in order
740 741 742
 * 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
743 744
 * sorted as needed.  fn is called for all references, including
 * broken ones.
745
 */
746 747 748
static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
				     struct ref_dir *dir2,
				     each_ref_entry_fn fn, void *cb_data)
749 750 751 752
{
	int retval;
	int i1 = 0, i2 = 0;

753 754
	assert(dir1->sorted == dir1->nr);
	assert(dir2->sorted == dir2->nr);
755 756 757 758
	while (1) {
		struct ref_entry *e1, *e2;
		int cmp;
		if (i1 == dir1->nr) {
759
			return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
760 761
		}
		if (i2 == dir2->nr) {
762
			return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
763 764 765 766 767 768 769
		}
		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. */
770 771 772 773
				struct ref_dir *subdir1 = get_ref_dir(e1);
				struct ref_dir *subdir2 = get_ref_dir(e2);
				sort_ref_dir(subdir1);
				sort_ref_dir(subdir2);
774 775
				retval = do_for_each_entry_in_dirs(
						subdir1, subdir2, fn, cb_data);
776 777 778 779
				i1++;
				i2++;
			} else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
				/* Both are references; ignore the one from dir1. */
780
				retval = fn(e2, cb_data);
781 782 783 784 785 786
				i1++;
				i2++;
			} else {
				die("conflict between reference and directory: %s",
				    e1->name);
			}
787
		} else {
788 789 790
			struct ref_entry *e;
			if (cmp < 0) {
				e = e1;
791
				i1++;
792 793 794 795 796
			} else {
				e = e2;
				i2++;
			}
			if (e->flag & REF_DIR) {
797 798
				struct ref_dir *subdir = get_ref_dir(e);
				sort_ref_dir(subdir);
799 800
				retval = do_for_each_entry_in_dir(
						subdir, 0, fn, cb_data);
801
			} else {
802
				retval = fn(e, cb_data);
803 804 805 806 807 808 809
			}
		}
		if (retval)
			return retval;
	}
}

810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
/*
 * Load all of the refs from the dir into our in-memory cache. The hard work
 * of loading loose refs is done by get_ref_dir(), so we just need to recurse
 * through all of the sub-directories. We do not even need to care about
 * sorting, as traversal order does not matter to us.
 */
static void prime_ref_dir(struct ref_dir *dir)
{
	int i;
	for (i = 0; i < dir->nr; i++) {
		struct ref_entry *entry = dir->entries[i];
		if (entry->flag & REF_DIR)
			prime_ref_dir(get_ref_dir(entry));
	}
}
J
Jeff King 已提交
825

826
static int entry_matches(struct ref_entry *entry, const struct string_list *list)
827
{
828
	return list && string_list_has_string(list, entry->name);
829 830
}

J
Jeff King 已提交
831
struct nonmatching_ref_data {
832
	const struct string_list *skip;
J
Jeff King 已提交
833
	struct ref_entry *found;
834 835
};

J
Jeff King 已提交
836
static int nonmatching_ref_fn(struct ref_entry *entry, void *vdata)
837
{
J
Jeff King 已提交
838 839 840
	struct nonmatching_ref_data *data = vdata;

	if (entry_matches(entry, data->skip))
841
		return 0;
J
Jeff King 已提交
842 843 844 845 846 847 848 849 850

	data->found = entry;
	return 1;
}

static void report_refname_conflict(struct ref_entry *entry,
				    const char *refname)
{
	error("'%s' exists; cannot create '%s'", entry->name, refname);
851 852
}

853 854
/*
 * Return true iff a reference named refname could be created without
855
 * conflicting with the name of an existing reference in dir.  If
856 857
 * skip is non-NULL, ignore potential conflicts with refs in skip
 * (e.g., because they are scheduled for deletion in the same
858
 * operation).
J
Jeff King 已提交
859 860 861 862 863
 *
 * 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".
864 865
 *
 * skip must be sorted.
866
 */
867 868
static int is_refname_available(const char *refname,
				const struct string_list *skip,
869
				struct ref_dir *dir)
870
{
J
Jeff King 已提交
871 872 873 874
	const char *slash;
	size_t len;
	int pos;
	char *dirname;
875

J
Jeff King 已提交
876 877 878 879 880 881
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
		/*
		 * We are still at a leading dir of the refname; we are
		 * looking for a conflict with a leaf entry.
		 *
		 * If we find one, we still must make sure it is
882
		 * not in "skip".
J
Jeff King 已提交
883 884 885 886
		 */
		pos = search_ref_dir(dir, refname, slash - refname);
		if (pos >= 0) {
			struct ref_entry *entry = dir->entries[pos];
887
			if (entry_matches(entry, skip))
J
Jeff King 已提交
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
				return 1;
			report_refname_conflict(entry, refname);
			return 0;
		}


		/*
		 * Otherwise, we can try to continue our search with
		 * the next component; if we come up empty, we know
		 * there is nothing under this whole prefix.
		 */
		pos = search_ref_dir(dir, refname, slash + 1 - refname);
		if (pos < 0)
			return 1;

		dir = get_ref_dir(dir->entries[pos]);
	}

	/*
	 * We are at the leaf of our refname; we want to
	 * make sure there are no directories which match it.
	 */
	len = strlen(refname);
	dirname = xmallocz(len + 1);
	sprintf(dirname, "%s/", refname);
	pos = search_ref_dir(dir, dirname, len + 1);
	free(dirname);

	if (pos >= 0) {
		/*
		 * We found a directory named "refname". It is a
		 * problem iff it contains any ref that is not
920
		 * in "skip".
J
Jeff King 已提交
921 922 923 924 925
		 */
		struct ref_entry *entry = dir->entries[pos];
		struct ref_dir *dir = get_ref_dir(entry);
		struct nonmatching_ref_data data;

926
		data.skip = skip;
J
Jeff King 已提交
927 928 929 930 931
		sort_ref_dir(dir);
		if (!do_for_each_entry_in_dir(dir, 0, nonmatching_ref_fn, &data))
			return 1;

		report_refname_conflict(data.found, refname);
932
		return 0;
933
	}
J
Jeff King 已提交
934 935 936 937 938 939

	/*
	 * There is no point in searching for another leaf
	 * node which matches it; such an entry would be the
	 * ref we are looking for, not a conflict.
	 */
940
	return 1;
941 942
}

943 944
struct packed_ref_cache {
	struct ref_entry *root;
945

946 947 948 949 950 951 952 953
	/*
	 * Count of references to the data structure in this instance,
	 * including the pointer from ref_cache::packed if any.  The
	 * data will not be freed as long as the reference count is
	 * nonzero.
	 */
	unsigned int referrers;

954 955 956
	/*
	 * Iff the packed-refs file associated with this instance is
	 * currently locked for writing, this points at the associated
957 958 959
	 * lock (which is owned by somebody else).  The referrer count
	 * is also incremented when the file is locked and decremented
	 * when it is unlocked.
960 961
	 */
	struct lock_file *lock;
962 963 964

	/* The metadata from when this packed-refs cache was read */
	struct stat_validity validity;
965 966
};

967 968 969 970
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
971 972
static struct ref_cache {
	struct ref_cache *next;
973
	struct ref_entry *loose;
974
	struct packed_ref_cache *packed;
975 976 977 978 979 980 981
	/*
	 * The submodule name, or "" for the main repo.  We allocate
	 * length 1 rather than FLEX_ARRAY so that the main ref_cache
	 * is initialized correctly.
	 */
	char name[1];
} ref_cache, *submodule_ref_caches;
982

983 984 985
/* Lock used for the main packed-refs file: */
static struct lock_file packlock;

986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
/*
 * Increment the reference count of *packed_refs.
 */
static void acquire_packed_ref_cache(struct packed_ref_cache *packed_refs)
{
	packed_refs->referrers++;
}

/*
 * Decrease the reference count of *packed_refs.  If it goes to zero,
 * free *packed_refs and return true; otherwise return false.
 */
static int release_packed_ref_cache(struct packed_ref_cache *packed_refs)
{
	if (!--packed_refs->referrers) {
		free_ref_entry(packed_refs->root);
1002
		stat_validity_clear(&packed_refs->validity);
1003 1004 1005 1006 1007 1008 1009
		free(packed_refs);
		return 1;
	} else {
		return 0;
	}
}

1010
static void clear_packed_ref_cache(struct ref_cache *refs)
1011
{
1012
	if (refs->packed) {
1013 1014 1015
		struct packed_ref_cache *packed_refs = refs->packed;

		if (packed_refs->lock)
1016
			die("internal error: packed-ref cache cleared while locked");
1017
		refs->packed = NULL;
1018
		release_packed_ref_cache(packed_refs);
1019
	}
1020
}
1021

1022 1023
static void clear_loose_ref_cache(struct ref_cache *refs)
{
1024 1025 1026 1027
	if (refs->loose) {
		free_ref_entry(refs->loose);
		refs->loose = NULL;
	}
1028 1029
}

1030
static struct ref_cache *create_ref_cache(const char *submodule)
1031
{
1032
	int len;
1033
	struct ref_cache *refs;
1034 1035 1036
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
1037
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
1038
	memcpy(refs->name, submodule, len);
1039 1040 1041
	return refs;
}

1042
/*
1043
 * Return a pointer to a ref_cache for the specified submodule. For
1044 1045 1046 1047
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
1048
static struct ref_cache *get_ref_cache(const char *submodule)
1049
{
1050 1051 1052 1053 1054 1055
	struct ref_cache *refs;

	if (!submodule || !*submodule)
		return &ref_cache;

	for (refs = submodule_ref_caches; refs; refs = refs->next)
1056 1057 1058
		if (!strcmp(submodule, refs->name))
			return refs;

1059
	refs = create_ref_cache(submodule);
1060 1061
	refs->next = submodule_ref_caches;
	submodule_ref_caches = refs;
1062
	return refs;
1063 1064
}

1065 1066 1067
/* The length of a peeled reference line in packed-refs, including EOL: */
#define PEELED_LINE_LENGTH 42

1068 1069 1070 1071 1072 1073 1074
/*
 * The packed-refs header line that we write out.  Perhaps other
 * traits will be added later.  The trailing space is required.
 */
static const char PACKED_REFS_HEADER[] =
	"# pack-refs with: peeled fully-peeled \n";

1075 1076 1077 1078 1079
/*
 * 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.
 */
1080
static const char *parse_ref_line(struct strbuf *line, unsigned char *sha1)
1081
{
1082 1083
	const char *ref;

1084 1085 1086 1087 1088 1089 1090 1091
	/*
	 * 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)
	 */
1092
	if (line->len <= 42)
1093
		return NULL;
1094 1095

	if (get_sha1_hex(line->buf, sha1) < 0)
1096
		return NULL;
1097
	if (!isspace(line->buf[40]))
1098
		return NULL;
1099 1100 1101

	ref = line->buf + 41;
	if (isspace(*ref))
1102
		return NULL;
1103 1104

	if (line->buf[line->len - 1] != '\n')
1105
		return NULL;
1106
	line->buf[--line->len] = 0;
1107

1108
	return ref;
1109 1110
}

1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
/*
 * Read f, which is a packed-refs file, into dir.
 *
 * A comment line of the form "# pack-refs with: " may contain zero or
 * more traits. We interpret the traits as follows:
 *
 *   No traits:
 *
 *      Probably no references are peeled. But if the file contains a
 *      peeled value for a reference, we will use it.
 *
 *   peeled:
 *
 *      References under "refs/tags/", if they *can* be peeled, *are*
 *      peeled in this file. References outside of "refs/tags/" are
 *      probably not peeled even if they could have been, but if we find
 *      a peeled value for such a reference we will use it.
 *
 *   fully-peeled:
 *
 *      All references in the file that can be peeled are peeled.
 *      Inversely (and this is more important), any references in the
 *      file for which no peeled value is recorded is not peelable. This
 *      trait should typically be written alongside "peeled" for
 *      compatibility with older clients, but we do not require it
 *      (i.e., "peeled" is a no-op if "fully-peeled" is set).
 */
1138
static void read_packed_refs(FILE *f, struct ref_dir *dir)
1139
{
1140
	struct ref_entry *last = NULL;
1141
	struct strbuf line = STRBUF_INIT;
1142
	enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
1143

1144
	while (strbuf_getwholeline(&line, f, '\n') != EOF) {
1145
		unsigned char sha1[20];
1146
		const char *refname;
1147
		const char *traits;
1148

1149
		if (skip_prefix(line.buf, "# pack-refs with:", &traits)) {
1150 1151 1152 1153
			if (strstr(traits, " fully-peeled "))
				peeled = PEELED_FULLY;
			else if (strstr(traits, " peeled "))
				peeled = PEELED_TAGS;
1154 1155 1156 1157
			/* perhaps other traits later as well */
			continue;
		}

1158
		refname = parse_ref_line(&line, sha1);
1159
		if (refname) {
1160 1161 1162 1163 1164 1165 1166
			int flag = REF_ISPACKED;

			if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
				hashclr(sha1);
				flag |= REF_BAD_NAME | REF_ISBROKEN;
			}
			last = create_ref_entry(refname, sha1, flag, 0);
1167
			if (peeled == PEELED_FULLY ||
1168
			    (peeled == PEELED_TAGS && starts_with(refname, "refs/tags/")))
1169
				last->flag |= REF_KNOWS_PEELED;
1170
			add_ref(dir, last);
1171 1172 1173
			continue;
		}
		if (last &&
1174 1175 1176 1177
		    line.buf[0] == '^' &&
		    line.len == PEELED_LINE_LENGTH &&
		    line.buf[PEELED_LINE_LENGTH - 1] == '\n' &&
		    !get_sha1_hex(line.buf + 1, sha1)) {
1178
			hashcpy(last->u.value.peeled, sha1);
1179 1180 1181 1182 1183 1184 1185
			/*
			 * Regardless of what the file header said,
			 * we definitely know the value of *this*
			 * reference:
			 */
			last->flag |= REF_KNOWS_PEELED;
		}
1186
	}
1187 1188

	strbuf_release(&line);
1189 1190
}

1191 1192 1193 1194 1195
/*
 * Get the packed_ref_cache for the specified ref_cache, creating it
 * if necessary.
 */
static struct packed_ref_cache *get_packed_ref_cache(struct ref_cache *refs)
1196
{
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
	const char *packed_refs_file;

	if (*refs->name)
		packed_refs_file = git_path_submodule(refs->name, "packed-refs");
	else
		packed_refs_file = git_path("packed-refs");

	if (refs->packed &&
	    !stat_validity_check(&refs->packed->validity, packed_refs_file))
		clear_packed_ref_cache(refs);

1208
	if (!refs->packed) {
1209
		FILE *f;
1210

1211
		refs->packed = xcalloc(1, sizeof(*refs->packed));
1212
		acquire_packed_ref_cache(refs->packed);
1213
		refs->packed->root = create_dir_entry(refs, "", 0, 0);
1214
		f = fopen(packed_refs_file, "r");
1215
		if (f) {
1216
			stat_validity_update(&refs->packed->validity, fileno(f));
1217
			read_packed_refs(f, get_ref_dir(refs->packed->root));
1218 1219 1220
			fclose(f);
		}
	}
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
	return refs->packed;
}

static struct ref_dir *get_packed_ref_dir(struct packed_ref_cache *packed_ref_cache)
{
	return get_ref_dir(packed_ref_cache->root);
}

static struct ref_dir *get_packed_refs(struct ref_cache *refs)
{
	return get_packed_ref_dir(get_packed_ref_cache(refs));
1232 1233
}

1234 1235
void add_packed_ref(const char *refname, const unsigned char *sha1)
{
1236 1237 1238 1239 1240 1241
	struct packed_ref_cache *packed_ref_cache =
		get_packed_ref_cache(&ref_cache);

	if (!packed_ref_cache->lock)
		die("internal error: packed refs not locked");
	add_ref(get_packed_ref_dir(packed_ref_cache),
1242
		create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1243 1244
}

1245
/*
1246 1247 1248
 * 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.
1249
 */
1250
static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1251
{
1252
	struct ref_cache *refs = dir->ref_cache;
1253
	DIR *d;
1254
	const char *path;
1255
	struct dirent *de;
1256
	int dirnamelen = strlen(dirname);
1257
	struct strbuf refname;
1258

M
Michael Haggerty 已提交
1259
	if (*refs->name)
1260
		path = git_path_submodule(refs->name, "%s", dirname);
1261
	else
1262
		path = git_path("%s", dirname);
1263

1264
	d = opendir(path);
1265 1266 1267
	if (!d)
		return;

1268 1269
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
1270 1271 1272 1273 1274 1275 1276 1277 1278

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

		if (de->d_name[0] == '.')
			continue;
J
Jeff King 已提交
1279
		if (ends_with(de->d_name, ".lock"))
1280
			continue;
1281
		strbuf_addstr(&refname, de->d_name);
1282
		refdir = *refs->name
1283 1284 1285 1286 1287
			? 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)) {
1288
			strbuf_addch(&refname, '/');
1289
			add_entry_to_dir(dir,
1290 1291
					 create_dir_entry(refs, refname.buf,
							  refname.len, 1));
1292
		} else {
M
Michael Haggerty 已提交
1293
			if (*refs->name) {
1294
				hashclr(sha1);
1295
				flag = 0;
1296
				if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
1297
					hashclr(sha1);
1298
					flag |= REF_ISBROKEN;
1299
				}
1300 1301 1302
			} else if (read_ref_full(refname.buf,
						 RESOLVE_REF_READING,
						 sha1, &flag)) {
1303 1304 1305
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
1306 1307 1308 1309 1310
			if (check_refname_format(refname.buf,
						 REFNAME_ALLOW_ONELEVEL)) {
				hashclr(sha1);
				flag |= REF_BAD_NAME | REF_ISBROKEN;
			}
1311
			add_entry_to_dir(dir,
1312
					 create_ref_entry(refname.buf, sha1, flag, 0));
1313
		}
1314
		strbuf_setlen(&refname, dirnamelen);
1315
	}
1316
	strbuf_release(&refname);
1317
	closedir(d);
1318 1319
}

1320
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1321
{
1322
	if (!refs->loose) {
1323 1324 1325 1326 1327
		/*
		 * Mark the top-level directory complete because we
		 * are about to read the only subdirectory that can
		 * hold references:
		 */
1328
		refs->loose = create_dir_entry(refs, "", 0, 0);
1329 1330 1331 1332
		/*
		 * Create an incomplete entry for "refs/":
		 */
		add_entry_to_dir(get_ref_dir(refs->loose),
1333
				 create_dir_entry(refs, "refs/", 5, 1));
1334
	}
1335
	return get_ref_dir(refs->loose);
1336 1337
}

1338 1339
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
1340 1341
#define MAXREFLEN (1024)

1342 1343
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
1344 1345
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
1346
 */
1347
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1348
				      const char *refname, unsigned char *sha1)
1349
{
1350
	struct ref_entry *ref;
1351
	struct ref_dir *dir = get_packed_refs(refs);
1352

1353
	ref = find_ref(dir, refname);
1354 1355 1356
	if (ref == NULL)
		return -1;

S
Sun He 已提交
1357
	hashcpy(sha1, ref->u.value.sha1);
1358
	return 0;
1359 1360
}

1361
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1362
					 const char *refname, unsigned char *sha1,
1363
					 int recursion)
1364
{
1365
	int fd, len;
1366
	char buffer[128], *p;
1367
	char *path;
1368

1369
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1370
		return -1;
1371 1372 1373 1374
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
1375
	if (fd < 0)
1376
		return resolve_gitlink_packed_ref(refs, refname, sha1);
1377 1378 1379 1380 1381 1382 1383 1384 1385 1386

	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? */
1387
	if (!get_sha1_hex(buffer, sha1))
1388 1389 1390 1391 1392 1393 1394 1395 1396
		return 0;

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

1397
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1398 1399
}

1400
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1401 1402
{
	int len = strlen(path), retval;
1403
	char *submodule;
1404
	struct ref_cache *refs;
1405 1406 1407 1408 1409

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
1410 1411 1412 1413
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

1414
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1415 1416
	return retval;
}
1417

1418
/*
1419 1420
 * Return the ref_entry for the given refname from the packed
 * references.  If it does not exist, return NULL.
1421
 */
1422
static struct ref_entry *get_packed_ref(const char *refname)
1423
{
1424
	return find_ref(get_packed_refs(&ref_cache), refname);
1425 1426
}

1427 1428 1429 1430
/*
 * A loose ref file doesn't exist; check for a packed ref.  The
 * options are forwarded from resolve_safe_unsafe().
 */
1431 1432 1433 1434
static int resolve_missing_loose_ref(const char *refname,
				     int resolve_flags,
				     unsigned char *sha1,
				     int *flags)
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
{
	struct ref_entry *entry;

	/*
	 * The loose reference file does not exist; check for a packed
	 * reference.
	 */
	entry = get_packed_ref(refname);
	if (entry) {
		hashcpy(sha1, entry->u.value.sha1);
1445 1446
		if (flags)
			*flags |= REF_ISPACKED;
1447
		return 0;
1448 1449
	}
	/* The reference is not a packed reference, either. */
1450
	if (resolve_flags & RESOLVE_REF_READING) {
1451 1452
		errno = ENOENT;
		return -1;
1453 1454
	} else {
		hashclr(sha1);
1455
		return 0;
1456 1457 1458
	}
}

1459
/* This function needs to return a meaningful errno on failure */
1460
const char *resolve_ref_unsafe(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
1461
{
1462 1463
	int depth = MAXDEPTH;
	ssize_t len;
1464
	char buffer[256];
1465
	static char refname_buffer[256];
1466
	int bad_name = 0;
1467

1468 1469
	if (flags)
		*flags = 0;
1470

1471
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488
		if (flags)
			*flags |= REF_BAD_NAME;

		if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
		    !refname_is_safe(refname)) {
			errno = EINVAL;
			return NULL;
		}
		/*
		 * dwim_ref() uses REF_ISBROKEN to distinguish between
		 * missing refs and refs that were present but invalid,
		 * to complain about the latter to stderr.
		 *
		 * We don't know whether the ref exists, so don't set
		 * REF_ISBROKEN yet.
		 */
		bad_name = 1;
1489
	}
1490
	for (;;) {
1491
		char path[PATH_MAX];
1492 1493 1494
		struct stat st;
		char *buf;
		int fd;
1495

1496 1497
		if (--depth < 0) {
			errno = ELOOP;
1498
			return NULL;
1499
		}
1500

1501
		git_snpath(path, sizeof(path), "%s", refname);
1502

1503 1504 1505 1506 1507 1508 1509 1510 1511 1512
		/*
		 * We might have to loop back here to avoid a race
		 * condition: first we lstat() the file, then we try
		 * to read it as a link or as a file.  But if somebody
		 * changes the type of the file (file <-> directory
		 * <-> symlink) between the lstat() and reading, then
		 * we don't want to report that as an error but rather
		 * try again starting with the lstat().
		 */
	stat_ref:
1513
		if (lstat(path, &st) < 0) {
1514 1515 1516 1517
			if (errno != ENOENT)
				return NULL;
			if (resolve_missing_loose_ref(refname, resolve_flags,
						      sha1, flags))
1518
				return NULL;
1519 1520 1521 1522 1523 1524
			if (bad_name) {
				hashclr(sha1);
				if (flags)
					*flags |= REF_ISBROKEN;
			}
			return refname;
1525
		}
1526

1527 1528 1529
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
1530 1531 1532 1533 1534 1535 1536
			if (len < 0) {
				if (errno == ENOENT || errno == EINVAL)
					/* inconsistent with lstat; retry */
					goto stat_ref;
				else
					return NULL;
			}
M
Michael Haggerty 已提交
1537
			buffer[len] = 0;
1538
			if (starts_with(buffer, "refs/") &&
1539
					!check_refname_format(buffer, 0)) {
1540 1541
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
1542 1543
				if (flags)
					*flags |= REF_ISSYMREF;
1544 1545 1546 1547
				if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
					hashclr(sha1);
					return refname;
				}
1548 1549
				continue;
			}
1550
		}
1551

1552 1553 1554 1555 1556 1557
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

1558 1559 1560 1561 1562
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
1563 1564 1565 1566 1567 1568 1569
		if (fd < 0) {
			if (errno == ENOENT)
				/* inconsistent with lstat; retry */
				goto stat_ref;
			else
				return NULL;
		}
1570
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
1571 1572 1573 1574
		if (len < 0) {
			int save_errno = errno;
			close(fd);
			errno = save_errno;
1575
			return NULL;
1576 1577
		}
		close(fd);
1578 1579 1580
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1581 1582 1583 1584

		/*
		 * Is it a symbolic ref?
		 */
1585
		if (!starts_with(buffer, "ref:")) {
1586 1587 1588 1589 1590 1591
			/*
			 * Please note that FETCH_HEAD has a second
			 * line containing other data.
			 */
			if (get_sha1_hex(buffer, sha1) ||
			    (buffer[40] != '\0' && !isspace(buffer[40]))) {
1592 1593
				if (flags)
					*flags |= REF_ISBROKEN;
1594
				errno = EINVAL;
1595 1596
				return NULL;
			}
1597 1598 1599 1600 1601
			if (bad_name) {
				hashclr(sha1);
				if (flags)
					*flags |= REF_ISBROKEN;
			}
1602 1603
			return refname;
		}
1604 1605
		if (flags)
			*flags |= REF_ISSYMREF;
1606
		buf = buffer + 4;
1607 1608
		while (isspace(*buf))
			buf++;
1609 1610 1611 1612 1613
		refname = strcpy(refname_buffer, buf);
		if (resolve_flags & RESOLVE_REF_NO_RECURSE) {
			hashclr(sha1);
			return refname;
		}
1614
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1615 1616
			if (flags)
				*flags |= REF_ISBROKEN;
1617 1618 1619 1620 1621 1622 1623

			if (!(resolve_flags & RESOLVE_REF_ALLOW_BAD_NAME) ||
			    !refname_is_safe(buf)) {
				errno = EINVAL;
				return NULL;
			}
			bad_name = 1;
1624
		}
1625
	}
1626 1627
}

1628
char *resolve_refdup(const char *ref, int resolve_flags, unsigned char *sha1, int *flags)
1629
{
1630
	const char *ret = resolve_ref_unsafe(ref, resolve_flags, sha1, flags);
1631 1632 1633
	return ret ? xstrdup(ret) : NULL;
}

I
Ilari Liusvaara 已提交
1634 1635 1636 1637 1638 1639 1640
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1641
int read_ref_full(const char *refname, int resolve_flags, unsigned char *sha1, int *flags)
1642
{
1643
	if (resolve_ref_unsafe(refname, resolve_flags, sha1, flags))
1644 1645
		return 0;
	return -1;
1646 1647
}

1648
int read_ref(const char *refname, unsigned char *sha1)
1649
{
1650
	return read_ref_full(refname, RESOLVE_REF_READING, sha1, NULL);
1651 1652
}

1653
int ref_exists(const char *refname)
1654
{
1655
	unsigned char sha1[20];
1656
	return !!resolve_ref_unsafe(refname, RESOLVE_REF_READING, sha1, NULL);
1657 1658
}

1659
static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1660
		       void *data)
I
Ilari Liusvaara 已提交
1661 1662
{
	struct ref_filter *filter = (struct ref_filter *)data;
1663
	if (wildmatch(filter->pattern, refname, 0, NULL))
I
Ilari Liusvaara 已提交
1664
		return 0;
1665
	return filter->fn(refname, sha1, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1666 1667
}

1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679
enum peel_status {
	/* object was peeled successfully: */
	PEEL_PEELED = 0,

	/*
	 * object cannot be peeled because the named object (or an
	 * object referred to by a tag in the peel chain), does not
	 * exist.
	 */
	PEEL_INVALID = -1,

	/* object cannot be peeled because it is not a tag: */
1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690
	PEEL_NON_TAG = -2,

	/* ref_entry contains no peeled value because it is a symref: */
	PEEL_IS_SYMREF = -3,

	/*
	 * ref_entry cannot be peeled because it is broken (i.e., the
	 * symbolic reference cannot even be resolved to an object
	 * name):
	 */
	PEEL_BROKEN = -4
1691 1692
};

1693 1694
/*
 * Peel the named object; i.e., if the object is a tag, resolve the
1695 1696 1697 1698
 * tag recursively until a non-tag is found.  If successful, store the
 * result to sha1 and return PEEL_PEELED.  If the object is not a tag
 * or is not valid, return PEEL_NON_TAG or PEEL_INVALID, respectively,
 * and leave sha1 unchanged.
1699
 */
1700
static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1701 1702 1703 1704 1705
{
	struct object *o = lookup_unknown_object(name);

	if (o->type == OBJ_NONE) {
		int type = sha1_object_info(name, NULL);
1706
		if (type < 0 || !object_as_type(o, type, 0))
1707
			return PEEL_INVALID;
1708 1709 1710
	}

	if (o->type != OBJ_TAG)
1711
		return PEEL_NON_TAG;
1712 1713 1714

	o = deref_tag_noverify(o);
	if (!o)
1715
		return PEEL_INVALID;
1716 1717

	hashcpy(sha1, o->sha1);
1718
	return PEEL_PEELED;
1719 1720
}

1721
/*
1722 1723 1724
 * Peel the entry (if possible) and return its new peel_status.  If
 * repeel is true, re-peel the entry even if there is an old peeled
 * value that is already stored in it.
1725 1726 1727 1728 1729 1730
 *
 * It is OK to call this function with a packed reference entry that
 * might be stale and might even refer to an object that has since
 * been garbage-collected.  In such a case, if the entry has
 * REF_KNOWS_PEELED then leave the status unchanged and return
 * PEEL_PEELED or PEEL_NON_TAG; otherwise, return PEEL_INVALID.
1731
 */
1732
static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1733 1734 1735
{
	enum peel_status status;

1736 1737 1738 1739 1740 1741 1742 1743 1744
	if (entry->flag & REF_KNOWS_PEELED) {
		if (repeel) {
			entry->flag &= ~REF_KNOWS_PEELED;
			hashclr(entry->u.value.peeled);
		} else {
			return is_null_sha1(entry->u.value.peeled) ?
				PEEL_NON_TAG : PEEL_PEELED;
		}
	}
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755
	if (entry->flag & REF_ISBROKEN)
		return PEEL_BROKEN;
	if (entry->flag & REF_ISSYMREF)
		return PEEL_IS_SYMREF;

	status = peel_object(entry->u.value.sha1, entry->u.value.peeled);
	if (status == PEEL_PEELED || status == PEEL_NON_TAG)
		entry->flag |= REF_KNOWS_PEELED;
	return status;
}

1756
int peel_ref(const char *refname, unsigned char *sha1)
1757 1758 1759 1760
{
	int flag;
	unsigned char base[20];

1761
	if (current_ref && (current_ref->name == refname
1762
			    || !strcmp(current_ref->name, refname))) {
1763
		if (peel_entry(current_ref, 0))
1764 1765 1766
			return -1;
		hashcpy(sha1, current_ref->u.value.peeled);
		return 0;
1767 1768
	}

1769
	if (read_ref_full(refname, RESOLVE_REF_READING, base, &flag))
1770 1771
		return -1;

1772 1773 1774 1775 1776 1777 1778 1779 1780
	/*
	 * If the reference is packed, read its ref_entry from the
	 * cache in the hope that we already know its peeled value.
	 * We only try this optimization on packed references because
	 * (a) forcing the filling of the loose reference cache could
	 * be expensive and (b) loose references anyway usually do not
	 * have REF_KNOWS_PEELED.
	 */
	if (flag & REF_ISPACKED) {
1781
		struct ref_entry *r = get_packed_ref(refname);
1782
		if (r) {
1783
			if (peel_entry(r, 0))
1784
				return -1;
1785
			hashcpy(sha1, r->u.value.peeled);
1786
			return 0;
1787 1788 1789
		}
	}

1790
	return peel_object(base, sha1);
1791 1792
}

1793 1794 1795
struct warn_if_dangling_data {
	FILE *fp;
	const char *refname;
1796
	const struct string_list *refnames;
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809
	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;

1810
	resolves_to = resolve_ref_unsafe(refname, 0, junk, NULL);
1811 1812 1813 1814
	if (!resolves_to
	    || (d->refname
		? strcmp(resolves_to, d->refname)
		: !string_list_has_string(d->refnames, resolves_to))) {
1815
		return 0;
1816
	}
1817 1818

	fprintf(d->fp, d->msg_fmt, refname);
J
Junio C Hamano 已提交
1819
	fputc('\n', d->fp);
1820 1821 1822 1823 1824 1825 1826 1827 1828
	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;
1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
	data.refnames = NULL;
	data.msg_fmt = msg_fmt;
	for_each_rawref(warn_if_dangling_symref, &data);
}

void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, const struct string_list *refnames)
{
	struct warn_if_dangling_data data;

	data.fp = fp;
	data.refname = NULL;
	data.refnames = refnames;
1841 1842 1843 1844
	data.msg_fmt = msg_fmt;
	for_each_rawref(warn_if_dangling_symref, &data);
}

1845
/*
1846
 * Call fn for each reference in the specified ref_cache, omitting
1847 1848
 * references not in the containing_dir of base.  fn is called for all
 * references, including broken ones.  If fn ever returns a non-zero
1849 1850 1851
 * value, stop the iteration and return that value; otherwise, return
 * 0.
 */
1852
static int do_for_each_entry(struct ref_cache *refs, const char *base,
1853
			     each_ref_entry_fn fn, void *cb_data)
1854
{
1855 1856 1857
	struct packed_ref_cache *packed_ref_cache;
	struct ref_dir *loose_dir;
	struct ref_dir *packed_dir;
1858 1859
	int retval = 0;

1860 1861 1862 1863 1864 1865 1866 1867 1868
	/*
	 * We must make sure that all loose refs are read before accessing the
	 * packed-refs file; this avoids a race condition in which loose refs
	 * are migrated to the packed-refs file by a simultaneous process, but
	 * our in-memory view is from before the migration. get_packed_ref_cache()
	 * takes care of making sure our view is up to date with what is on
	 * disk.
	 */
	loose_dir = get_loose_refs(refs);
1869 1870 1871
	if (base && *base) {
		loose_dir = find_containing_dir(loose_dir, base, 0);
	}
1872 1873 1874 1875
	if (loose_dir)
		prime_ref_dir(loose_dir);

	packed_ref_cache = get_packed_ref_cache(refs);
1876
	acquire_packed_ref_cache(packed_ref_cache);
1877
	packed_dir = get_packed_ref_dir(packed_ref_cache);
1878 1879 1880 1881 1882 1883 1884
	if (base && *base) {
		packed_dir = find_containing_dir(packed_dir, base, 0);
	}

	if (packed_dir && loose_dir) {
		sort_ref_dir(packed_dir);
		sort_ref_dir(loose_dir);
1885 1886
		retval = do_for_each_entry_in_dirs(
				packed_dir, loose_dir, fn, cb_data);
1887 1888
	} else if (packed_dir) {
		sort_ref_dir(packed_dir);
1889 1890
		retval = do_for_each_entry_in_dir(
				packed_dir, 0, fn, cb_data);
1891 1892
	} else if (loose_dir) {
		sort_ref_dir(loose_dir);
1893 1894
		retval = do_for_each_entry_in_dir(
				loose_dir, 0, fn, cb_data);
1895 1896
	}

1897
	release_packed_ref_cache(packed_ref_cache);
1898
	return retval;
1899 1900
}

1901
/*
1902
 * Call fn for each reference in the specified ref_cache for which the
1903 1904 1905 1906 1907 1908 1909
 * refname begins with base.  If trim is non-zero, then trim that many
 * characters off the beginning of each refname before passing the
 * refname to fn.  flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
 * broken references in the iteration.  If fn ever returns a non-zero
 * value, stop the iteration and return that value; otherwise, return
 * 0.
 */
1910 1911
static int do_for_each_ref(struct ref_cache *refs, const char *base,
			   each_ref_fn fn, int trim, int flags, void *cb_data)
1912 1913 1914 1915 1916 1917 1918 1919
{
	struct ref_entry_cb data;
	data.base = base;
	data.trim = trim;
	data.flags = flags;
	data.fn = fn;
	data.cb_data = cb_data;

1920
	return do_for_each_entry(refs, base, do_one_ref, &data);
1921 1922
}

1923
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1924 1925
{
	unsigned char sha1[20];
1926 1927
	int flag;

1928 1929 1930 1931 1932 1933 1934
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

1935
	if (!read_ref_full("HEAD", RESOLVE_REF_READING, sha1, &flag))
1936
		return fn("HEAD", sha1, flag, cb_data);
1937

1938
	return 0;
1939 1940
}

1941 1942 1943 1944 1945
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

1946 1947 1948 1949 1950
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

1951
int for_each_ref(each_ref_fn fn, void *cb_data)
1952
{
1953
	return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
1954 1955
}

1956 1957
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
1958
	return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
1959 1960
}

1961 1962
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
1963
	return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
1964 1965
}

1966 1967 1968
int for_each_ref_in_submodule(const char *submodule, const char *prefix,
		each_ref_fn fn, void *cb_data)
{
1969
	return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
1970 1971
}

1972
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1973
{
1974
	return for_each_ref_in("refs/tags/", fn, cb_data);
1975 1976
}

1977 1978 1979 1980 1981
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);
}

1982
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1983
{
1984
	return for_each_ref_in("refs/heads/", fn, cb_data);
1985 1986
}

1987 1988 1989 1990 1991
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);
}

1992
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1993
{
1994
	return for_each_ref_in("refs/remotes/", fn, cb_data);
1995 1996
}

1997 1998 1999 2000 2001
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);
}

2002 2003
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
2004
	return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
2005 2006
}

J
Josh Triplett 已提交
2007 2008 2009 2010 2011 2012 2013 2014
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());
2015
	if (!read_ref_full(buf.buf, RESOLVE_REF_READING, sha1, &flag))
J
Josh Triplett 已提交
2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026
		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());
2027
	ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
J
Josh Triplett 已提交
2028 2029 2030 2031
	strbuf_release(&buf);
	return ret;
}

2032 2033
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
2034 2035 2036 2037 2038
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

2039
	if (!prefix && !starts_with(pattern, "refs/"))
I
Ilari Liusvaara 已提交
2040
		strbuf_addstr(&real_pattern, "refs/");
2041 2042
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
2043 2044
	strbuf_addstr(&real_pattern, pattern);

2045
	if (!has_glob_specials(pattern)) {
2046
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061
		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;
}

2062 2063 2064 2065 2066
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);
}

2067 2068
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
2069
	return do_for_each_ref(&ref_cache, "", fn, 0,
2070
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
2071 2072
}

2073
const char *prettify_refname(const char *name)
2074 2075
{
	return name + (
2076 2077 2078
		starts_with(name, "refs/heads/") ? 11 :
		starts_with(name, "refs/tags/") ? 10 :
		starts_with(name, "refs/remotes/") ? 13 :
2079 2080 2081
		0);
}

2082
static const char *ref_rev_parse_rules[] = {
S
Steffen Prohaska 已提交
2083 2084 2085 2086 2087 2088 2089 2090 2091
	"%.*s",
	"refs/%.*s",
	"refs/tags/%.*s",
	"refs/heads/%.*s",
	"refs/remotes/%.*s",
	"refs/remotes/%.*s/HEAD",
	NULL
};

2092
int refname_match(const char *abbrev_name, const char *full_name)
S
Steffen Prohaska 已提交
2093 2094 2095 2096
{
	const char **p;
	const int abbrev_name_len = strlen(abbrev_name);

2097
	for (p = ref_rev_parse_rules; *p; p++) {
S
Steffen Prohaska 已提交
2098 2099 2100 2101 2102 2103 2104 2105
		if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
			return 1;
		}
	}

	return 0;
}

2106 2107 2108 2109 2110 2111 2112 2113 2114 2115
static void unlock_ref(struct ref_lock *lock)
{
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
	free(lock->ref_name);
	free(lock->orig_ref_name);
	free(lock);
}

2116
/* This function should make sure errno is meaningful on error */
J
Junio C Hamano 已提交
2117
static struct ref_lock *verify_lock(struct ref_lock *lock,
2118 2119
	const unsigned char *old_sha1, int mustexist)
{
2120 2121 2122
	if (read_ref_full(lock->ref_name,
			  mustexist ? RESOLVE_REF_READING : 0,
			  lock->old_sha1, NULL)) {
2123
		int save_errno = errno;
2124
		error("Can't verify ref %s", lock->ref_name);
2125
		unlock_ref(lock);
2126
		errno = save_errno;
2127 2128
		return NULL;
	}
2129
	if (hashcmp(lock->old_sha1, old_sha1)) {
2130
		error("Ref %s is at %s but expected %s", lock->ref_name,
2131 2132
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
2133
		errno = EBUSY;
2134 2135 2136 2137 2138
		return NULL;
	}
	return lock;
}

2139
static int remove_empty_directories(const char *file)
2140 2141 2142 2143 2144
{
	/* 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.
	 */
2145
	struct strbuf path;
2146
	int result, save_errno;
2147

2148 2149 2150
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

2151
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
2152
	save_errno = errno;
2153 2154

	strbuf_release(&path);
2155
	errno = save_errno;
2156 2157

	return result;
2158 2159
}

2160 2161 2162 2163 2164 2165 2166 2167
/*
 * *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;
2168
	int ret = interpret_branch_name(*string, *len, &buf);
2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194

	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);
2195 2196
		r = resolve_ref_unsafe(fullref, RESOLVE_REF_READING,
				       this_result, &flag);
2197 2198 2199 2200 2201
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
2202
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
2203
			warning("ignoring dangling symref %s.", fullref);
2204 2205 2206
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
	}
	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++) {
		unsigned char hash[20];
		char path[PATH_MAX];
		const char *ref, *it;

		mksnpath(path, sizeof(path), *p, len, str);
2225 2226
		ref = resolve_ref_unsafe(path, RESOLVE_REF_READING,
					 hash, NULL);
2227 2228
		if (!ref)
			continue;
2229
		if (reflog_exists(path))
2230
			it = path;
2231
		else if (strcmp(ref, path) && reflog_exists(ref))
2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245
			it = ref;
		else
			continue;
		if (!logs_found++) {
			*log = xstrdup(it);
			hashcpy(sha1, hash);
		}
		if (!warn_ambiguous_refs)
			break;
	}
	free(last_branch);
	return logs_found;
}

2246
/*
2247
 * Locks a ref returning the lock on success and NULL on failure.
2248 2249
 * On failure errno is set to something meaningful.
 */
2250 2251
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
2252
					    const struct string_list *skip,
2253
					    int flags, int *type_p)
2254
{
2255
	char *ref_file;
2256
	const char *orig_refname = refname;
2257
	struct ref_lock *lock;
2258
	int last_errno = 0;
2259
	int type, lflags;
2260
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
2261
	int resolve_flags = 0;
2262
	int attempts_remaining = 3;
2263 2264 2265 2266

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

2267 2268
	if (mustexist)
		resolve_flags |= RESOLVE_REF_READING;
2269 2270 2271 2272 2273
	if (flags & REF_DELETING) {
		resolve_flags |= RESOLVE_REF_ALLOW_BAD_NAME;
		if (flags & REF_NODEREF)
			resolve_flags |= RESOLVE_REF_NO_RECURSE;
	}
2274 2275 2276

	refname = resolve_ref_unsafe(refname, resolve_flags,
				     lock->old_sha1, &type);
2277
	if (!refname && errno == EISDIR) {
2278 2279 2280 2281 2282
		/* 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.
		 */
2283
		ref_file = git_path("%s", orig_refname);
2284 2285
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
2286
			error("there are still refs under '%s'", orig_refname);
2287 2288
			goto error_return;
		}
2289 2290
		refname = resolve_ref_unsafe(orig_refname, resolve_flags,
					     lock->old_sha1, &type);
2291
	}
2292 2293
	if (type_p)
	    *type_p = type;
2294
	if (!refname) {
2295
		last_errno = errno;
2296
		error("unable to resolve reference %s: %s",
2297
			orig_refname, strerror(errno));
2298
		goto error_return;
2299
	}
2300 2301 2302 2303 2304
	/*
	 * If the ref did not exist and we are creating it, make sure
	 * there is no existing packed ref whose name begins with our
	 * refname, nor a packed ref whose name is a proper prefix of
	 * our refname.
2305
	 */
2306
	if (is_null_sha1(lock->old_sha1) &&
2307
	     !is_refname_available(refname, skip, get_packed_refs(&ref_cache))) {
2308
		last_errno = ENOTDIR;
2309
		goto error_return;
2310
	}
2311

2312
	lock->lk = xcalloc(1, sizeof(struct lock_file));
2313

2314
	lflags = 0;
2315
	if (flags & REF_NODEREF) {
2316
		refname = orig_refname;
2317
		lflags |= LOCK_NO_DEREF;
2318
	}
2319 2320 2321
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
2322 2323
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
2324

2325 2326 2327 2328 2329 2330 2331 2332 2333
 retry:
	switch (safe_create_leading_directories(ref_file)) {
	case SCLD_OK:
		break; /* success */
	case SCLD_VANISHED:
		if (--attempts_remaining > 0)
			goto retry;
		/* fall through */
	default:
2334 2335 2336 2337
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
2338

2339
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
2340
	if (lock->lock_fd < 0) {
2341
		last_errno = errno;
2342 2343 2344 2345 2346 2347 2348
		if (errno == ENOENT && --attempts_remaining > 0)
			/*
			 * Maybe somebody just deleted one of the
			 * directories leading to ref_file.  Try
			 * again:
			 */
			goto retry;
2349 2350 2351 2352
		else {
			struct strbuf err = STRBUF_INIT;
			unable_to_lock_message(ref_file, errno, &err);
			error("%s", err.buf);
2353
			strbuf_release(&err);
2354 2355
			goto error_return;
		}
2356
	}
2357
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
2358 2359 2360 2361 2362

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
2363 2364
}

2365 2366 2367 2368
/*
 * Write an entry to the packed-refs file for the specified refname.
 * If peeled is non-NULL, write it as the entry's peeled value.
 */
2369
static void write_packed_entry(FILE *fh, char *refname, unsigned char *sha1,
2370
			       unsigned char *peeled)
2371
{
2372 2373 2374
	fprintf_or_die(fh, "%s %s\n", sha1_to_hex(sha1), refname);
	if (peeled)
		fprintf_or_die(fh, "^%s\n", sha1_to_hex(peeled));
2375 2376
}

2377 2378 2379 2380 2381 2382 2383 2384 2385 2386
/*
 * An each_ref_entry_fn that writes the entry to a packed-refs file.
 */
static int write_packed_entry_fn(struct ref_entry *entry, void *cb_data)
{
	enum peel_status peel_status = peel_entry(entry, 0);

	if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
		error("internal error: %s is not a valid packed reference!",
		      entry->name);
2387
	write_packed_entry(cb_data, entry->name, entry->u.value.sha1,
2388 2389 2390 2391 2392
			   peel_status == PEEL_PEELED ?
			   entry->u.value.peeled : NULL);
	return 0;
}

2393
/* This should return a meaningful errno on failure */
2394 2395 2396 2397 2398 2399
int lock_packed_refs(int flags)
{
	struct packed_ref_cache *packed_ref_cache;

	if (hold_lock_file_for_update(&packlock, git_path("packed-refs"), flags) < 0)
		return -1;
2400 2401 2402 2403 2404 2405
	/*
	 * Get the current packed-refs while holding the lock.  If the
	 * packed-refs file has been modified since we last read it,
	 * this will automatically invalidate the cache and re-read
	 * the packed-refs file.
	 */
2406 2407
	packed_ref_cache = get_packed_ref_cache(&ref_cache);
	packed_ref_cache->lock = &packlock;
2408 2409
	/* Increment the reference count to prevent it from being freed: */
	acquire_packed_ref_cache(packed_ref_cache);
2410 2411 2412
	return 0;
}

2413 2414 2415 2416
/*
 * Commit the packed refs changes.
 * On error we must make sure that errno contains a meaningful value.
 */
2417 2418 2419 2420 2421
int commit_packed_refs(void)
{
	struct packed_ref_cache *packed_ref_cache =
		get_packed_ref_cache(&ref_cache);
	int error = 0;
2422
	int save_errno = 0;
2423
	FILE *out;
2424 2425 2426 2427

	if (!packed_ref_cache->lock)
		die("internal error: packed-refs not locked");

2428
	out = fdopen_lock_file(packed_ref_cache->lock, "w");
2429 2430 2431 2432
	if (!out)
		die_errno("unable to fdopen packed-refs descriptor");

	fprintf_or_die(out, "%s", PACKED_REFS_HEADER);
2433
	do_for_each_entry_in_dir(get_packed_ref_dir(packed_ref_cache),
2434 2435
				 0, write_packed_entry_fn, out);

2436 2437
	if (commit_lock_file(packed_ref_cache->lock)) {
		save_errno = errno;
2438
		error = -1;
2439
	}
2440
	packed_ref_cache->lock = NULL;
2441
	release_packed_ref_cache(packed_ref_cache);
2442
	errno = save_errno;
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454
	return error;
}

void rollback_packed_refs(void)
{
	struct packed_ref_cache *packed_ref_cache =
		get_packed_ref_cache(&ref_cache);

	if (!packed_ref_cache->lock)
		die("internal error: packed-refs not locked");
	rollback_lock_file(packed_ref_cache->lock);
	packed_ref_cache->lock = NULL;
2455
	release_packed_ref_cache(packed_ref_cache);
2456 2457 2458
	clear_packed_ref_cache(&ref_cache);
}

2459 2460 2461 2462 2463 2464 2465 2466
struct ref_to_prune {
	struct ref_to_prune *next;
	unsigned char sha1[20];
	char name[FLEX_ARRAY];
};

struct pack_refs_cb_data {
	unsigned int flags;
2467
	struct ref_dir *packed_refs;
2468 2469 2470
	struct ref_to_prune *ref_to_prune;
};

2471 2472 2473 2474 2475 2476 2477
/*
 * An each_ref_entry_fn that is run over loose references only.  If
 * the loose reference can be packed, add an entry in the packed ref
 * cache.  If the reference should be pruned, also add it to
 * ref_to_prune in the pack_refs_cb_data.
 */
static int pack_if_possible_fn(struct ref_entry *entry, void *cb_data)
2478 2479
{
	struct pack_refs_cb_data *cb = cb_data;
2480
	enum peel_status peel_status;
2481
	struct ref_entry *packed_entry;
2482
	int is_tag_ref = starts_with(entry->name, "refs/tags/");
2483

2484 2485
	/* ALWAYS pack tags */
	if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2486 2487
		return 0;

2488 2489 2490 2491
	/* Do not pack symbolic or broken refs: */
	if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
		return 0;

2492
	/* Add a packed ref cache entry equivalent to the loose entry. */
2493
	peel_status = peel_entry(entry, 1);
2494
	if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2495 2496
		die("internal error peeling reference %s (%s)",
		    entry->name, sha1_to_hex(entry->u.value.sha1));
2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507
	packed_entry = find_ref(cb->packed_refs, entry->name);
	if (packed_entry) {
		/* Overwrite existing packed entry with info from loose entry */
		packed_entry->flag = REF_ISPACKED | REF_KNOWS_PEELED;
		hashcpy(packed_entry->u.value.sha1, entry->u.value.sha1);
	} else {
		packed_entry = create_ref_entry(entry->name, entry->u.value.sha1,
						REF_ISPACKED | REF_KNOWS_PEELED, 0);
		add_ref(cb->packed_refs, packed_entry);
	}
	hashcpy(packed_entry->u.value.peeled, entry->u.value.peeled);
2508

2509 2510
	/* Schedule the loose reference for pruning if requested. */
	if ((cb->flags & PACK_REFS_PRUNE)) {
2511
		int namelen = strlen(entry->name) + 1;
2512
		struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2513 2514
		hashcpy(n->sha1, entry->u.value.sha1);
		strcpy(n->name, entry->name);
2515 2516 2517
		n->next = cb->ref_to_prune;
		cb->ref_to_prune = n;
	}
2518 2519 2520
	return 0;
}

2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554
/*
 * Remove empty parents, but spare refs/ and immediate subdirs.
 * Note: munges *name.
 */
static void try_remove_empty_parents(char *name)
{
	char *p, *q;
	int i;
	p = name;
	for (i = 0; i < 2; i++) { /* refs/{heads,tags,...}/ */
		while (*p && *p != '/')
			p++;
		/* tolerate duplicate slashes; see check_refname_format() */
		while (*p == '/')
			p++;
	}
	for (q = p; *q; q++)
		;
	while (1) {
		while (q > p && *q != '/')
			q--;
		while (q > p && *(q-1) == '/')
			q--;
		if (q == p)
			break;
		*q = '\0';
		if (rmdir(git_path("%s", name)))
			break;
	}
}

/* make sure nobody touched the ref, and unlink */
static void prune_ref(struct ref_to_prune *r)
{
2555 2556
	struct ref_transaction *transaction;
	struct strbuf err = STRBUF_INIT;
2557

2558
	if (check_refname_format(r->name, 0))
R
Ronnie Sahlberg 已提交
2559
		return;
2560

2561 2562 2563
	transaction = ref_transaction_begin(&err);
	if (!transaction ||
	    ref_transaction_delete(transaction, r->name, r->sha1,
2564 2565
				   REF_ISPRUNING, 1, NULL, &err) ||
	    ref_transaction_commit(transaction, &err)) {
2566 2567 2568 2569
		ref_transaction_free(transaction);
		error("%s", err.buf);
		strbuf_release(&err);
		return;
2570
	}
2571 2572 2573
	ref_transaction_free(transaction);
	strbuf_release(&err);
	try_remove_empty_parents(r->name);
2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590
}

static void prune_refs(struct ref_to_prune *r)
{
	while (r) {
		prune_ref(r);
		r = r->next;
	}
}

int pack_refs(unsigned int flags)
{
	struct pack_refs_cb_data cbdata;

	memset(&cbdata, 0, sizeof(cbdata));
	cbdata.flags = flags;

2591
	lock_packed_refs(LOCK_DIE_ON_ERROR);
2592
	cbdata.packed_refs = get_packed_refs(&ref_cache);
2593

2594 2595
	do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
				 pack_if_possible_fn, &cbdata);
2596

2597
	if (commit_packed_refs())
2598
		die_errno("unable to overwrite old ref-pack file");
2599

2600 2601 2602 2603
	prune_refs(cbdata.ref_to_prune);
	return 0;
}

2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615
/*
 * If entry is no longer needed in packed-refs, add it to the string
 * list pointed to by cb_data.  Reasons for deleting entries:
 *
 * - Entry is broken.
 * - Entry is overridden by a loose ref.
 * - Entry does not point at a valid object.
 *
 * In the first and third cases, also emit an error message because these
 * are indications of repository corruption.
 */
static int curate_packed_ref_fn(struct ref_entry *entry, void *cb_data)
J
Junio C Hamano 已提交
2616
{
2617
	struct string_list *refs_to_delete = cb_data;
2618

2619 2620 2621
	if (entry->flag & REF_ISBROKEN) {
		/* This shouldn't happen to packed refs. */
		error("%s is broken!", entry->name);
2622
		string_list_append(refs_to_delete, entry->name);
J
Junio C Hamano 已提交
2623
		return 0;
2624 2625 2626 2627 2628
	}
	if (!has_sha1_file(entry->u.value.sha1)) {
		unsigned char sha1[20];
		int flags;

2629
		if (read_ref_full(entry->name, 0, sha1, &flags))
2630 2631
			/* We should at least have found the packed ref. */
			die("Internal error");
2632
		if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {
2633 2634 2635 2636 2637 2638 2639 2640
			/*
			 * This packed reference is overridden by a
			 * loose reference, so it is OK that its value
			 * is no longer valid; for example, it might
			 * refer to an object that has been garbage
			 * collected.  For this purpose we don't even
			 * care whether the loose reference itself is
			 * invalid, broken, symbolic, etc.  Silently
2641
			 * remove the packed reference.
2642
			 */
2643
			string_list_append(refs_to_delete, entry->name);
2644
			return 0;
2645
		}
2646 2647 2648 2649 2650 2651 2652 2653
		/*
		 * There is no overriding loose reference, so the fact
		 * that this reference doesn't refer to a valid object
		 * indicates some kind of repository corruption.
		 * Report the problem, then omit the reference from
		 * the output.
		 */
		error("%s does not point to a valid object!", entry->name);
2654
		string_list_append(refs_to_delete, entry->name);
2655 2656 2657
		return 0;
	}

2658 2659 2660
	return 0;
}

2661
int repack_without_refs(struct string_list *refnames, struct strbuf *err)
J
Junio C Hamano 已提交
2662
{
2663
	struct ref_dir *packed;
2664
	struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
2665 2666
	struct string_list_item *refname, *ref_to_delete;
	int ret, needs_repacking = 0, removed = 0;
2667

2668 2669
	assert(err);

2670
	/* Look for a packed ref */
2671 2672 2673
	for_each_string_list_item(refname, refnames) {
		if (get_packed_ref(refname->string)) {
			needs_repacking = 1;
2674
			break;
2675 2676
		}
	}
2677

2678
	/* Avoid locking if we have nothing to do */
2679
	if (!needs_repacking)
2680
		return 0; /* no refname exists in packed refs */
2681

2682
	if (lock_packed_refs(0)) {
2683 2684
		unable_to_lock_message(git_path("packed-refs"), errno, err);
		return -1;
2685
	}
2686
	packed = get_packed_refs(&ref_cache);
2687

2688
	/* Remove refnames from the cache */
2689 2690
	for_each_string_list_item(refname, refnames)
		if (remove_entry(packed, refname->string) != -1)
2691 2692
			removed = 1;
	if (!removed) {
2693
		/*
2694
		 * All packed entries disappeared while we were
2695 2696
		 * acquiring the lock.
		 */
2697
		rollback_packed_refs();
2698 2699
		return 0;
	}
2700

2701
	/* Remove any other accumulated cruft */
2702 2703 2704 2705 2706 2707
	do_for_each_entry_in_dir(packed, 0, curate_packed_ref_fn, &refs_to_delete);
	for_each_string_list_item(ref_to_delete, &refs_to_delete) {
		if (remove_entry(packed, ref_to_delete->string) == -1)
			die("internal error");
	}

2708
	/* Write what remains */
2709
	ret = commit_packed_refs();
2710
	if (ret)
2711 2712 2713
		strbuf_addf(err, "unable to overwrite old ref-pack file: %s",
			    strerror(errno));
	return ret;
J
Junio C Hamano 已提交
2714 2715
}

2716
static int delete_ref_loose(struct ref_lock *lock, int flag, struct strbuf *err)
2717
{
2718 2719
	assert(err);

2720
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
2721 2722 2723 2724
		/*
		 * loose.  The loose file name is the same as the
		 * lockfile name, minus ".lock":
		 */
2725
		char *loose_filename = get_locked_file_path(lock->lk);
2726
		int res = unlink_or_msg(loose_filename, err);
2727
		free(loose_filename);
2728
		if (res)
2729
			return 1;
J
Junio C Hamano 已提交
2730
	}
2731 2732 2733
	return 0;
}

M
Miklos Vajna 已提交
2734
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
2735
{
2736 2737
	struct ref_transaction *transaction;
	struct strbuf err = STRBUF_INIT;
J
Junio C Hamano 已提交
2738

2739 2740 2741
	transaction = ref_transaction_begin(&err);
	if (!transaction ||
	    ref_transaction_delete(transaction, refname, sha1, delopt,
2742 2743
				   sha1 && !is_null_sha1(sha1), NULL, &err) ||
	    ref_transaction_commit(transaction, &err)) {
2744 2745 2746
		error("%s", err.buf);
		ref_transaction_free(transaction);
		strbuf_release(&err);
J
Junio C Hamano 已提交
2747
		return 1;
2748 2749 2750 2751
	}
	ref_transaction_free(transaction);
	strbuf_release(&err);
	return 0;
2752 2753
}

2754 2755 2756 2757 2758 2759 2760 2761 2762
/*
 * 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"

2763 2764
static int rename_tmp_log(const char *newrefname)
{
2765
	int attempts_remaining = 4;
2766 2767

 retry:
2768 2769 2770 2771 2772 2773 2774 2775
	switch (safe_create_leading_directories(git_path("logs/%s", newrefname))) {
	case SCLD_OK:
		break; /* success */
	case SCLD_VANISHED:
		if (--attempts_remaining > 0)
			goto retry;
		/* fall through */
	default:
2776 2777 2778 2779 2780
		error("unable to create directory for %s", newrefname);
		return -1;
	}

	if (rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
2781
		if ((errno==EISDIR || errno==ENOTDIR) && --attempts_remaining > 0) {
2782 2783 2784 2785 2786 2787 2788 2789 2790 2791
			/*
			 * rename(a, b) when b is an existing
			 * directory ought to result in ISDIR, but
			 * Solaris 5.8 gives ENOTDIR.  Sheesh.
			 */
			if (remove_empty_directories(git_path("logs/%s", newrefname))) {
				error("Directory not empty: logs/%s", newrefname);
				return -1;
			}
			goto retry;
2792 2793 2794 2795 2796 2797 2798
		} else if (errno == ENOENT && --attempts_remaining > 0) {
			/*
			 * Maybe another process just deleted one of
			 * the directories in the path to newrefname.
			 * Try again from the beginning.
			 */
			goto retry;
2799 2800 2801 2802 2803 2804 2805 2806 2807
		} else {
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
				newrefname, strerror(errno));
			return -1;
		}
	}
	return 0;
}

2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819
static int rename_ref_available(const char *oldname, const char *newname)
{
	struct string_list skip = STRING_LIST_INIT_NODUP;
	int ret;

	string_list_insert(&skip, oldname);
	ret = is_refname_available(newname, &skip, get_packed_refs(&ref_cache))
	    && is_refname_available(newname, &skip, get_loose_refs(&ref_cache));
	string_list_clear(&skip, 0);
	return ret;
}

2820 2821 2822
static int write_ref_sha1(struct ref_lock *lock, const unsigned char *sha1,
			  const char *logmsg);

2823
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2824 2825 2826 2827 2828
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
2829
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
2830
	const char *symref = NULL;
2831

2832
	if (log && S_ISLNK(loginfo.st_mode))
2833
		return error("reflog for %s is a symlink", oldrefname);
2834

2835 2836
	symref = resolve_ref_unsafe(oldrefname, RESOLVE_REF_READING,
				    orig_sha1, &flag);
M
Miklos Vajna 已提交
2837
	if (flag & REF_ISSYMREF)
2838
		return error("refname %s is a symbolic ref, renaming it is not supported",
2839
			oldrefname);
M
Miklos Vajna 已提交
2840
	if (!symref)
2841
		return error("refname %s not found", oldrefname);
2842

2843
	if (!rename_ref_available(oldrefname, newrefname))
2844 2845
		return 1;

2846
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2847
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2848
			oldrefname, strerror(errno));
2849

2850 2851
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
2852 2853 2854
		goto rollback;
	}

2855
	if (!read_ref_full(newrefname, RESOLVE_REF_READING, sha1, NULL) &&
2856
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
2857
		if (errno==EISDIR) {
2858 2859
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
2860 2861 2862
				goto rollback;
			}
		} else {
2863
			error("unable to delete existing %s", newrefname);
2864 2865 2866 2867
			goto rollback;
		}
	}

2868
	if (log && rename_tmp_log(newrefname))
2869 2870 2871 2872
		goto rollback;

	logmoved = log;

2873
	lock = lock_ref_sha1_basic(newrefname, NULL, NULL, 0, NULL);
2874
	if (!lock) {
2875
		error("unable to lock %s for update", newrefname);
2876 2877 2878
		goto rollback;
	}
	hashcpy(lock->old_sha1, orig_sha1);
2879
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
2880
		error("unable to write current sha1 into %s", newrefname);
2881 2882 2883 2884 2885 2886
		goto rollback;
	}

	return 0;

 rollback:
2887
	lock = lock_ref_sha1_basic(oldrefname, NULL, NULL, 0, NULL);
2888
	if (!lock) {
2889
		error("unable to lock %s for rollback", oldrefname);
2890 2891 2892 2893 2894 2895
		goto rollbacklog;
	}

	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
	if (write_ref_sha1(lock, orig_sha1, NULL))
2896
		error("unable to write current sha1 into %s", oldrefname);
2897 2898 2899
	log_all_ref_updates = flag;

 rollbacklog:
2900
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
2901
		error("unable to restore logfile %s from %s: %s",
2902
			oldrefname, newrefname, strerror(errno));
2903
	if (!logmoved && log &&
2904
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
2905
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
2906
			oldrefname, strerror(errno));
2907 2908 2909 2910

	return 1;
}

2911
static int close_ref(struct ref_lock *lock)
2912 2913 2914 2915 2916 2917 2918
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

2919
static int commit_ref(struct ref_lock *lock)
2920 2921 2922 2923 2924 2925 2926
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952
/*
 * 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;
}

2953
/* This function must set a meaningful errno on failure */
2954
int log_ref_setup(const char *refname, char *logfile, int bufsize)
2955
{
2956
	int logfd, oflags = O_APPEND | O_WRONLY;
2957

2958
	git_snpath(logfile, bufsize, "logs/%s", refname);
2959
	if (log_all_ref_updates &&
2960 2961 2962
	    (starts_with(refname, "refs/heads/") ||
	     starts_with(refname, "refs/remotes/") ||
	     starts_with(refname, "refs/notes/") ||
2963
	     !strcmp(refname, "HEAD"))) {
2964 2965 2966 2967 2968 2969
		if (safe_create_leading_directories(logfile) < 0) {
			int save_errno = errno;
			error("unable to create directory for %s", logfile);
			errno = save_errno;
			return -1;
		}
2970 2971 2972
		oflags |= O_CREAT;
	}

2973
	logfd = open(logfile, oflags, 0666);
2974
	if (logfd < 0) {
2975
		if (!(oflags & O_CREAT) && (errno == ENOENT || errno == EISDIR))
2976
			return 0;
2977

2978
		if (errno == EISDIR) {
2979
			if (remove_empty_directories(logfile)) {
2980 2981 2982 2983 2984
				int save_errno = errno;
				error("There are still logs under '%s'",
				      logfile);
				errno = save_errno;
				return -1;
2985
			}
2986
			logfd = open(logfile, oflags, 0666);
2987 2988
		}

2989 2990 2991 2992 2993 2994 2995
		if (logfd < 0) {
			int save_errno = errno;
			error("Unable to append to %s: %s", logfile,
			      strerror(errno));
			errno = save_errno;
			return -1;
		}
2996 2997
	}

2998
	adjust_shared_perm(logfile);
2999 3000 3001
	close(logfd);
	return 0;
}
3002

3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028
static int log_ref_write_fd(int fd, const unsigned char *old_sha1,
			    const unsigned char *new_sha1,
			    const char *committer, const char *msg)
{
	int msglen, written;
	unsigned maxlen, len;
	char *logrec;

	msglen = msg ? strlen(msg) : 0;
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
		      committer);
	if (msglen)
		len += copy_msg(logrec + len - 1, msg) - 1;

	written = len <= maxlen ? write_in_full(fd, logrec, len) : -1;
	free(logrec);
	if (written != len)
		return -1;

	return 0;
}

3029
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
3030 3031
			 const unsigned char *new_sha1, const char *msg)
{
3032
	int logfd, result, oflags = O_APPEND | O_WRONLY;
3033
	char log_file[PATH_MAX];
3034 3035 3036 3037

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

3038
	result = log_ref_setup(refname, log_file, sizeof(log_file));
3039 3040 3041 3042 3043 3044
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
3045 3046 3047
	result = log_ref_write_fd(logfd, old_sha1, new_sha1,
				  git_committer_info(0), msg);
	if (result) {
3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059
		int save_errno = errno;
		close(logfd);
		error("Unable to append to %s", log_file);
		errno = save_errno;
		return -1;
	}
	if (close(logfd)) {
		int save_errno = errno;
		error("Unable to append to %s", log_file);
		errno = save_errno;
		return -1;
	}
3060 3061 3062
	return 0;
}

3063
int is_branch(const char *refname)
3064
{
3065
	return !strcmp(refname, "HEAD") || starts_with(refname, "refs/heads/");
3066 3067
}

3068 3069 3070 3071 3072
/*
 * Write sha1 into the ref specified by the lock. Make sure that errno
 * is sane on error.
 */
static int write_ref_sha1(struct ref_lock *lock,
3073 3074 3075
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
3076
	struct object *o;
3077

3078 3079
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
3080
		error("Trying to write ref %s with nonexistent object %s",
3081 3082
			lock->ref_name, sha1_to_hex(sha1));
		unlock_ref(lock);
3083
		errno = EINVAL;
3084 3085 3086 3087 3088 3089
		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);
3090
		errno = EINVAL;
3091 3092
		return -1;
	}
3093
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
3094 3095 3096
	    write_in_full(lock->lock_fd, &term, 1) != 1 ||
	    close_ref(lock) < 0) {
		int save_errno = errno;
3097
		error("Couldn't write %s", lock->lk->filename.buf);
3098
		unlock_ref(lock);
3099
		errno = save_errno;
3100 3101
		return -1;
	}
3102
	clear_loose_ref_cache(&ref_cache);
N
Nicolas Pitre 已提交
3103 3104 3105
	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)) {
3106 3107 3108
		unlock_ref(lock);
		return -1;
	}
3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124
	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;
3125 3126
		head_ref = resolve_ref_unsafe("HEAD", RESOLVE_REF_READING,
					      head_sha1, &head_flag);
3127 3128 3129 3130
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
3131
	if (commit_ref(lock)) {
3132
		error("Couldn't set %s", lock->ref_name);
3133 3134 3135 3136 3137
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
3138
}
3139

3140 3141
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
3142 3143 3144 3145
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
3146
	char *git_HEAD = git_pathdup("%s", ref_target);
3147 3148 3149 3150
	unsigned char old_sha1[20], new_sha1[20];

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

3152 3153 3154
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

3155 3156 3157 3158
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
3159
			goto done;
3160 3161 3162 3163 3164 3165 3166
		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);
3167
		goto error_free_return;
3168 3169 3170 3171 3172
	}
	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);
3173
		goto error_free_return;
3174 3175
	}
	written = write_in_full(fd, ref, len);
3176
	if (close(fd) != 0 || written != len) {
3177
		error("Unable to write to %s", lockpath);
3178
		goto error_unlink_return;
3179 3180 3181
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
3182
		goto error_unlink_return;
3183 3184 3185
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
3186
	error_unlink_return:
3187
		unlink_or_warn(lockpath);
3188 3189 3190
	error_free_return:
		free(git_HEAD);
		return -1;
3191
	}
3192

3193
#ifndef NO_SYMLINK_HEAD
3194
	done:
3195
#endif
3196 3197 3198
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

3199
	free(git_HEAD);
3200 3201 3202
	return 0;
}

3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286
struct read_ref_at_cb {
	const char *refname;
	unsigned long at_time;
	int cnt;
	int reccnt;
	unsigned char *sha1;
	int found_it;

	unsigned char osha1[20];
	unsigned char nsha1[20];
	int tz;
	unsigned long date;
	char **msg;
	unsigned long *cutoff_time;
	int *cutoff_tz;
	int *cutoff_cnt;
};

static int read_ref_at_ent(unsigned char *osha1, unsigned char *nsha1,
		const char *email, unsigned long timestamp, int tz,
		const char *message, void *cb_data)
{
	struct read_ref_at_cb *cb = cb_data;

	cb->reccnt++;
	cb->tz = tz;
	cb->date = timestamp;

	if (timestamp <= cb->at_time || cb->cnt == 0) {
		if (cb->msg)
			*cb->msg = xstrdup(message);
		if (cb->cutoff_time)
			*cb->cutoff_time = timestamp;
		if (cb->cutoff_tz)
			*cb->cutoff_tz = tz;
		if (cb->cutoff_cnt)
			*cb->cutoff_cnt = cb->reccnt - 1;
		/*
		 * we have not yet updated cb->[n|o]sha1 so they still
		 * hold the values for the previous record.
		 */
		if (!is_null_sha1(cb->osha1)) {
			hashcpy(cb->sha1, nsha1);
			if (hashcmp(cb->osha1, nsha1))
				warning("Log for ref %s has gap after %s.",
					cb->refname, show_date(cb->date, cb->tz, DATE_RFC2822));
		}
		else if (cb->date == cb->at_time)
			hashcpy(cb->sha1, nsha1);
		else if (hashcmp(nsha1, cb->sha1))
			warning("Log for ref %s unexpectedly ended on %s.",
				cb->refname, show_date(cb->date, cb->tz,
						   DATE_RFC2822));
		hashcpy(cb->osha1, osha1);
		hashcpy(cb->nsha1, nsha1);
		cb->found_it = 1;
		return 1;
	}
	hashcpy(cb->osha1, osha1);
	hashcpy(cb->nsha1, nsha1);
	if (cb->cnt > 0)
		cb->cnt--;
	return 0;
}

static int read_ref_at_ent_oldest(unsigned char *osha1, unsigned char *nsha1,
				  const char *email, unsigned long timestamp,
				  int tz, const char *message, void *cb_data)
{
	struct read_ref_at_cb *cb = cb_data;

	if (cb->msg)
		*cb->msg = xstrdup(message);
	if (cb->cutoff_time)
		*cb->cutoff_time = timestamp;
	if (cb->cutoff_tz)
		*cb->cutoff_tz = tz;
	if (cb->cutoff_cnt)
		*cb->cutoff_cnt = cb->reccnt;
	hashcpy(cb->sha1, osha1);
	if (is_null_sha1(cb->sha1))
		hashcpy(cb->sha1, nsha1);
	/* We just want the first entry */
	return 1;
3287 3288
}

3289
int read_ref_at(const char *refname, unsigned int flags, unsigned long at_time, int cnt,
3290 3291
		unsigned char *sha1, char **msg,
		unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
3292
{
3293
	struct read_ref_at_cb cb;
3294

3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306
	memset(&cb, 0, sizeof(cb));
	cb.refname = refname;
	cb.at_time = at_time;
	cb.cnt = cnt;
	cb.msg = msg;
	cb.cutoff_time = cutoff_time;
	cb.cutoff_tz = cutoff_tz;
	cb.cutoff_cnt = cutoff_cnt;
	cb.sha1 = sha1;

	for_each_reflog_ent_reverse(refname, read_ref_at_ent, &cb);

3307 3308 3309 3310 3311 3312
	if (!cb.reccnt) {
		if (flags & GET_SHA1_QUIETLY)
			exit(128);
		else
			die("Log for %s is empty.", refname);
	}
3313 3314 3315 3316
	if (cb.found_it)
		return 0;

	for_each_reflog_ent(refname, read_ref_at_ent_oldest, &cb);
3317

3318
	return 1;
3319
}
3320

3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333
int reflog_exists(const char *refname)
{
	struct stat st;

	return !lstat(git_path("logs/%s", refname), &st) &&
		S_ISREG(st.st_mode);
}

int delete_reflog(const char *refname)
{
	return remove_path(git_path("logs/%s", refname));
}

3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361
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);
}

3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373
static char *find_beginning_of_line(char *bob, char *scan)
{
	while (bob < scan && *(--scan) != '\n')
		; /* keep scanning backwards */
	/*
	 * Return either beginning of the buffer, or LF at the end of
	 * the previous line.
	 */
	return scan;
}

int for_each_reflog_ent_reverse(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3374
{
3375
	struct strbuf sb = STRBUF_INIT;
3376 3377 3378
	FILE *logfp;
	long pos;
	int ret = 0, at_tail = 1;
3379

3380
	logfp = fopen(git_path("logs/%s", refname), "r");
3381
	if (!logfp)
3382
		return -1;
3383

3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400
	/* Jump to the end */
	if (fseek(logfp, 0, SEEK_END) < 0)
		return error("cannot seek back reflog for %s: %s",
			     refname, strerror(errno));
	pos = ftell(logfp);
	while (!ret && 0 < pos) {
		int cnt;
		size_t nread;
		char buf[BUFSIZ];
		char *endp, *scanp;

		/* Fill next block from the end */
		cnt = (sizeof(buf) < pos) ? sizeof(buf) : pos;
		if (fseek(logfp, pos - cnt, SEEK_SET))
			return error("cannot seek back reflog for %s: %s",
				     refname, strerror(errno));
		nread = fread(buf, cnt, 1, logfp);
J
John Keeping 已提交
3401
		if (nread != 1)
3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420
			return error("cannot read %d bytes from reflog for %s: %s",
				     cnt, refname, strerror(errno));
		pos -= cnt;

		scanp = endp = buf + cnt;
		if (at_tail && scanp[-1] == '\n')
			/* Looking at the final LF at the end of the file */
			scanp--;
		at_tail = 0;

		while (buf < scanp) {
			/*
			 * terminating LF of the previous line, or the beginning
			 * of the buffer.
			 */
			char *bp;

			bp = find_beginning_of_line(buf, scanp);

3421
			if (*bp == '\n') {
3422
				/*
3423 3424 3425 3426
				 * The newline is the end of the previous line,
				 * so we know we have complete line starting
				 * at (bp + 1). Prefix it onto any prior data
				 * we collected for the line and process it.
3427 3428 3429 3430
				 */
				strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
				scanp = bp;
				endp = bp + 1;
3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445
				ret = show_one_reflog_ent(&sb, fn, cb_data);
				strbuf_reset(&sb);
				if (ret)
					break;
			} else if (!pos) {
				/*
				 * We are at the start of the buffer, and the
				 * start of the file; there is no previous
				 * line, and we have everything for this one.
				 * Process it, and we can end the loop.
				 */
				strbuf_splice(&sb, 0, 0, buf, endp - buf);
				ret = show_one_reflog_ent(&sb, fn, cb_data);
				strbuf_reset(&sb);
				break;
3446
			}
3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461

			if (bp == buf) {
				/*
				 * We are at the start of the buffer, and there
				 * is more file to read backwards. Which means
				 * we are in the middle of a line. Note that we
				 * may get here even if *bp was a newline; that
				 * just means we are at the exact end of the
				 * previous line, rather than some spot in the
				 * middle.
				 *
				 * Save away what we have to be combined with
				 * the data from the next read.
				 */
				strbuf_splice(&sb, 0, 0, buf, endp - buf);
3462
				break;
3463
			}
3464
		}
3465

3466
	}
3467
	if (!ret && sb.len)
3468
		die("BUG: reverse reflog parser had leftover data");
3469

3470
	fclose(logfp);
3471
	strbuf_release(&sb);
3472
	return ret;
3473
}
J
Junio C Hamano 已提交
3474

3475
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
3476
{
3477 3478 3479 3480 3481 3482 3483
	FILE *logfp;
	struct strbuf sb = STRBUF_INIT;
	int ret = 0;

	logfp = fopen(git_path("logs/%s", refname), "r");
	if (!logfp)
		return -1;
3484

3485 3486 3487 3488 3489 3490
	while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
		ret = show_one_reflog_ent(&sb, fn, cb_data);
	fclose(logfp);
	strbuf_release(&sb);
	return ret;
}
3491 3492 3493 3494 3495 3496
/*
 * 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)
3497
{
3498
	DIR *d = opendir(git_path("logs/%s", name->buf));
3499
	int retval = 0;
3500
	struct dirent *de;
3501
	int oldlen = name->len;
3502

3503
	if (!d)
3504
		return name->len ? errno : 0;
3505

3506 3507
	while ((de = readdir(d)) != NULL) {
		struct stat st;
3508

3509 3510
		if (de->d_name[0] == '.')
			continue;
J
Jeff King 已提交
3511
		if (ends_with(de->d_name, ".lock"))
3512
			continue;
3513 3514 3515
		strbuf_addstr(name, de->d_name);
		if (stat(git_path("logs/%s", name->buf), &st) < 0) {
			; /* silently ignore */
3516
		} else {
3517
			if (S_ISDIR(st.st_mode)) {
3518 3519
				strbuf_addch(name, '/');
				retval = do_for_each_reflog(name, fn, cb_data);
3520 3521
			} else {
				unsigned char sha1[20];
3522
				if (read_ref_full(name->buf, 0, sha1, NULL))
3523
					retval = error("bad ref for %s", name->buf);
3524
				else
3525
					retval = fn(name->buf, sha1, 0, cb_data);
3526 3527 3528 3529
			}
			if (retval)
				break;
		}
3530
		strbuf_setlen(name, oldlen);
3531
	}
3532
	closedir(d);
3533 3534 3535 3536 3537
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
3538 3539 3540 3541 3542 3543
	int retval;
	struct strbuf name;
	strbuf_init(&name, PATH_MAX);
	retval = do_for_each_reflog(&name, fn, cb_data);
	strbuf_release(&name);
	return retval;
3544
}
C
Carlos Rica 已提交
3545

3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556
/**
 * Information needed for a single ref update.  Set new_sha1 to the
 * new value or to zero to delete the ref.  To check the old value
 * while locking the ref, set have_old to 1 and set old_sha1 to the
 * value or to zero to ensure the ref does not exist before update.
 */
struct ref_update {
	unsigned char new_sha1[20];
	unsigned char old_sha1[20];
	int flags; /* REF_NODEREF? */
	int have_old; /* 1 if old_sha1 is valid, 0 otherwise */
3557
	struct ref_lock *lock;
3558
	int type;
3559
	char *msg;
3560
	const char refname[FLEX_ARRAY];
3561 3562
};

3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577
/*
 * Transaction states.
 * OPEN:   The transaction is in a valid state and can accept new updates.
 *         An OPEN transaction can be committed.
 * CLOSED: A closed transaction is no longer active and no other operations
 *         than free can be used on it in this state.
 *         A transaction can either become closed by successfully committing
 *         an active transaction or if there is a failure while building
 *         the transaction thus rendering it failed/inactive.
 */
enum ref_transaction_state {
	REF_TRANSACTION_OPEN   = 0,
	REF_TRANSACTION_CLOSED = 1
};

3578 3579 3580 3581 3582 3583 3584 3585 3586
/*
 * Data structure for holding a reference transaction, which can
 * consist of checks and updates to multiple references, carried out
 * as atomically as possible.  This structure is opaque to callers.
 */
struct ref_transaction {
	struct ref_update **updates;
	size_t alloc;
	size_t nr;
3587
	enum ref_transaction_state state;
3588 3589
};

3590
struct ref_transaction *ref_transaction_begin(struct strbuf *err)
3591
{
3592 3593
	assert(err);

3594 3595 3596
	return xcalloc(1, sizeof(struct ref_transaction));
}

3597
void ref_transaction_free(struct ref_transaction *transaction)
3598 3599 3600
{
	int i;

3601 3602 3603
	if (!transaction)
		return;

3604 3605
	for (i = 0; i < transaction->nr; i++) {
		free(transaction->updates[i]->msg);
3606
		free(transaction->updates[i]);
3607
	}
3608 3609 3610 3611 3612 3613 3614
	free(transaction->updates);
	free(transaction);
}

static struct ref_update *add_update(struct ref_transaction *transaction,
				     const char *refname)
{
3615 3616
	size_t len = strlen(refname);
	struct ref_update *update = xcalloc(1, sizeof(*update) + len + 1);
3617

3618
	strcpy((char *)update->refname, refname);
3619 3620 3621 3622 3623
	ALLOC_GROW(transaction->updates, transaction->nr + 1, transaction->alloc);
	transaction->updates[transaction->nr++] = update;
	return update;
}

3624 3625 3626 3627
int ref_transaction_update(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *new_sha1,
			   const unsigned char *old_sha1,
3628
			   int flags, int have_old, const char *msg,
3629
			   struct strbuf *err)
3630
{
3631
	struct ref_update *update;
3632

3633 3634
	assert(err);

3635 3636 3637
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: update called for transaction that is not open");

3638 3639
	if (have_old && !old_sha1)
		die("BUG: have_old is true but old_sha1 is NULL");
3640

3641 3642 3643 3644 3645 3646 3647
	if (!is_null_sha1(new_sha1) &&
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL)) {
		strbuf_addf(err, "refusing to update ref with bad name %s",
			    refname);
		return -1;
	}

3648
	update = add_update(transaction, refname);
3649 3650 3651 3652 3653
	hashcpy(update->new_sha1, new_sha1);
	update->flags = flags;
	update->have_old = have_old;
	if (have_old)
		hashcpy(update->old_sha1, old_sha1);
3654 3655
	if (msg)
		update->msg = xstrdup(msg);
3656
	return 0;
3657 3658
}

3659 3660 3661
int ref_transaction_create(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *new_sha1,
3662
			   int flags, const char *msg,
3663
			   struct strbuf *err)
3664
{
3665 3666
	return ref_transaction_update(transaction, refname, new_sha1,
				      null_sha1, flags, 1, msg, err);
3667 3668
}

3669 3670 3671
int ref_transaction_delete(struct ref_transaction *transaction,
			   const char *refname,
			   const unsigned char *old_sha1,
3672
			   int flags, int have_old, const char *msg,
3673
			   struct strbuf *err)
3674
{
3675 3676
	return ref_transaction_update(transaction, refname, null_sha1,
				      old_sha1, flags, have_old, msg, err);
3677 3678
}

3679 3680 3681 3682
int update_ref(const char *action, const char *refname,
	       const unsigned char *sha1, const unsigned char *oldval,
	       int flags, enum action_on_err onerr)
{
3683 3684 3685 3686 3687 3688
	struct ref_transaction *t;
	struct strbuf err = STRBUF_INIT;

	t = ref_transaction_begin(&err);
	if (!t ||
	    ref_transaction_update(t, refname, sha1, oldval, flags,
3689 3690
				   !!oldval, action, &err) ||
	    ref_transaction_commit(t, &err)) {
3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704
		const char *str = "update_ref failed for ref '%s': %s";

		ref_transaction_free(t);
		switch (onerr) {
		case UPDATE_REFS_MSG_ON_ERR:
			error(str, refname, err.buf);
			break;
		case UPDATE_REFS_DIE_ON_ERR:
			die(str, refname, err.buf);
			break;
		case UPDATE_REFS_QUIET_ON_ERR:
			break;
		}
		strbuf_release(&err);
3705
		return 1;
3706 3707 3708 3709
	}
	strbuf_release(&err);
	ref_transaction_free(t);
	return 0;
3710 3711
}

3712 3713 3714 3715
static int ref_update_compare(const void *r1, const void *r2)
{
	const struct ref_update * const *u1 = r1;
	const struct ref_update * const *u2 = r2;
3716
	return strcmp((*u1)->refname, (*u2)->refname);
3717 3718 3719
}

static int ref_update_reject_duplicates(struct ref_update **updates, int n,
3720
					struct strbuf *err)
3721 3722
{
	int i;
3723 3724 3725

	assert(err);

3726
	for (i = 1; i < n; i++)
3727
		if (!strcmp(updates[i - 1]->refname, updates[i]->refname)) {
3728 3729 3730
			strbuf_addf(err,
				    "Multiple updates for ref '%s' not allowed.",
				    updates[i]->refname);
3731 3732 3733 3734 3735
			return 1;
		}
	return 0;
}

3736
int ref_transaction_commit(struct ref_transaction *transaction,
3737
			   struct strbuf *err)
3738
{
3739
	int ret = 0, i;
3740
	int n = transaction->nr;
3741
	struct ref_update **updates = transaction->updates;
3742 3743
	struct string_list refs_to_delete = STRING_LIST_INIT_NODUP;
	struct string_list_item *ref_to_delete;
3744

3745 3746
	assert(err);

3747 3748 3749 3750 3751
	if (transaction->state != REF_TRANSACTION_OPEN)
		die("BUG: commit called for transaction that is not open");

	if (!n) {
		transaction->state = REF_TRANSACTION_CLOSED;
3752
		return 0;
3753
	}
3754 3755 3756

	/* Copy, sort, and reject duplicate refs */
	qsort(updates, n, sizeof(*updates), ref_update_compare);
3757 3758
	if (ref_update_reject_duplicates(updates, n, err)) {
		ret = TRANSACTION_GENERIC_ERROR;
3759
		goto cleanup;
3760
	}
3761 3762 3763

	/* Acquire all locks while verifying old values */
	for (i = 0; i < n; i++) {
3764
		struct ref_update *update = updates[i];
3765
		int flags = update->flags;
3766

3767 3768
		if (is_null_sha1(update->new_sha1))
			flags |= REF_DELETING;
3769 3770 3771 3772
		update->lock = lock_ref_sha1_basic(update->refname,
						   (update->have_old ?
						    update->old_sha1 :
						    NULL),
3773
						   NULL,
3774
						   flags,
3775
						   &update->type);
3776
		if (!update->lock) {
3777 3778 3779
			ret = (errno == ENOTDIR)
				? TRANSACTION_NAME_CONFLICT
				: TRANSACTION_GENERIC_ERROR;
3780 3781
			strbuf_addf(err, "Cannot lock the ref '%s'.",
				    update->refname);
3782 3783 3784 3785 3786
			goto cleanup;
		}
	}

	/* Perform updates first so live commits remain referenced */
3787 3788 3789 3790
	for (i = 0; i < n; i++) {
		struct ref_update *update = updates[i];

		if (!is_null_sha1(update->new_sha1)) {
3791 3792 3793 3794 3795 3796
			if (!update->lock->force_write &&
			    !hashcmp(update->lock->old_sha1, update->new_sha1)) {
				unlock_ref(update->lock);
				update->lock = NULL;
			} else if (write_ref_sha1(update->lock, update->new_sha1,
						  update->msg)) {
3797
				update->lock = NULL; /* freed by write_ref_sha1 */
3798 3799
				strbuf_addf(err, "Cannot update the ref '%s'.",
					    update->refname);
3800
				ret = TRANSACTION_GENERIC_ERROR;
3801
				goto cleanup;
3802 3803 3804
			} else {
				/* freed by write_ref_sha1(): */
				update->lock = NULL;
3805
			}
3806
		}
3807
	}
3808 3809

	/* Perform deletes now that updates are safely completed */
3810 3811 3812 3813
	for (i = 0; i < n; i++) {
		struct ref_update *update = updates[i];

		if (update->lock) {
3814
			if (delete_ref_loose(update->lock, update->type, err)) {
3815
				ret = TRANSACTION_GENERIC_ERROR;
3816 3817
				goto cleanup;
			}
3818

3819
			if (!(update->flags & REF_ISPRUNING))
3820 3821
				string_list_append(&refs_to_delete,
						   update->lock->ref_name);
3822
		}
3823 3824
	}

3825
	if (repack_without_refs(&refs_to_delete, err)) {
3826
		ret = TRANSACTION_GENERIC_ERROR;
3827 3828
		goto cleanup;
	}
3829 3830
	for_each_string_list_item(ref_to_delete, &refs_to_delete)
		unlink_or_warn(git_path("logs/%s", ref_to_delete->string));
3831 3832 3833
	clear_loose_ref_cache(&ref_cache);

cleanup:
3834 3835
	transaction->state = REF_TRANSACTION_CLOSED;

3836
	for (i = 0; i < n; i++)
3837 3838
		if (updates[i]->lock)
			unlock_ref(updates[i]->lock);
3839
	string_list_clear(&refs_to_delete, 0);
3840 3841 3842
	return ret;
}

3843
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
3844 3845 3846 3847 3848 3849 3850
{
	int i;
	static char **scanf_fmts;
	static int nr_rules;
	char *short_name;

	if (!nr_rules) {
3851 3852 3853 3854 3855 3856
		/*
		 * Pre-generate scanf formats from ref_rev_parse_rules[].
		 * Generate a format suitable for scanf from a
		 * ref_rev_parse_rules rule by interpolating "%s" at the
		 * location of the "%.*s".
		 */
J
Jeff King 已提交
3857
		size_t total_len = 0;
3858
		size_t offset = 0;
J
Jeff King 已提交
3859 3860

		/* the rule list is NULL terminated, count them first */
J
Jeff King 已提交
3861
		for (nr_rules = 0; ref_rev_parse_rules[nr_rules]; nr_rules++)
3862 3863
			/* -2 for strlen("%.*s") - strlen("%s"); +1 for NUL */
			total_len += strlen(ref_rev_parse_rules[nr_rules]) - 2 + 1;
J
Jeff King 已提交
3864 3865 3866

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

3867
		offset = 0;
J
Jeff King 已提交
3868
		for (i = 0; i < nr_rules; i++) {
3869
			assert(offset < total_len);
3870
			scanf_fmts[i] = (char *)&scanf_fmts[nr_rules] + offset;
3871 3872
			offset += snprintf(scanf_fmts[i], total_len - offset,
					   ref_rev_parse_rules[i], 2, "%s") + 1;
J
Jeff King 已提交
3873 3874 3875 3876 3877
		}
	}

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

3880 3881
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
3882 3883 3884 3885

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

3889
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
3890 3891 3892 3893
			continue;

		short_name_len = strlen(short_name);

3894 3895 3896 3897 3898 3899 3900
		/*
		 * 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 已提交
3901 3902 3903 3904
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
3905
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
3906 3907 3908
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

3909 3910 3911 3912
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
3913 3914 3915 3916 3917 3918 3919
			/*
			 * 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);
3920
			if (ref_exists(refname))
J
Jeff King 已提交
3921 3922 3923 3924 3925 3926 3927
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
3928
		if (j == rules_to_fail)
J
Jeff King 已提交
3929 3930 3931 3932
			return short_name;
	}

	free(short_name);
3933
	return xstrdup(refname);
J
Jeff King 已提交
3934
}
3935 3936 3937 3938 3939 3940 3941

static struct string_list *hide_refs;

int parse_hide_refs_config(const char *var, const char *value, const char *section)
{
	if (!strcmp("transfer.hiderefs", var) ||
	    /* NEEDSWORK: use parse_config_key() once both are merged */
3942
	    (starts_with(var, section) && var[strlen(section)] == '.' &&
3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969
	     !strcmp(var + strlen(section), ".hiderefs"))) {
		char *ref;
		int len;

		if (!value)
			return config_error_nonbool(var);
		ref = xstrdup(value);
		len = strlen(ref);
		while (len && ref[len - 1] == '/')
			ref[--len] = '\0';
		if (!hide_refs) {
			hide_refs = xcalloc(1, sizeof(*hide_refs));
			hide_refs->strdup_strings = 1;
		}
		string_list_append(hide_refs, ref);
	}
	return 0;
}

int ref_is_hidden(const char *refname)
{
	struct string_list_item *item;

	if (!hide_refs)
		return 0;
	for_each_string_list_item(item, hide_refs) {
		int len;
3970
		if (!starts_with(refname, item->string))
3971 3972 3973 3974 3975 3976 3977
			continue;
		len = strlen(item->string);
		if (!refname[len] || refname[len] == '/')
			return 1;
	}
	return 0;
}
3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004

struct expire_reflog_cb {
	unsigned int flags;
	reflog_expiry_should_prune_fn *should_prune_fn;
	void *policy_cb;
	FILE *newlog;
	unsigned char last_kept_sha1[20];
};

static int expire_reflog_ent(unsigned char *osha1, unsigned char *nsha1,
			     const char *email, unsigned long timestamp, int tz,
			     const char *message, void *cb_data)
{
	struct expire_reflog_cb *cb = cb_data;
	struct expire_reflog_policy_cb *policy_cb = cb->policy_cb;

	if (cb->flags & EXPIRE_REFLOGS_REWRITE)
		osha1 = cb->last_kept_sha1;

	if ((*cb->should_prune_fn)(osha1, nsha1, email, timestamp, tz,
				   message, policy_cb)) {
		if (!cb->newlog)
			printf("would prune %s", message);
		else if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
			printf("prune %s", message);
	} else {
		if (cb->newlog) {
4005
			fprintf(cb->newlog, "%s %s %s %lu %+05d\t%s",
4006
				sha1_to_hex(osha1), sha1_to_hex(nsha1),
4007
				email, timestamp, tz, message);
4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038
			hashcpy(cb->last_kept_sha1, nsha1);
		}
		if (cb->flags & EXPIRE_REFLOGS_VERBOSE)
			printf("keep %s", message);
	}
	return 0;
}

int reflog_expire(const char *refname, const unsigned char *sha1,
		 unsigned int flags,
		 reflog_expiry_prepare_fn prepare_fn,
		 reflog_expiry_should_prune_fn should_prune_fn,
		 reflog_expiry_cleanup_fn cleanup_fn,
		 void *policy_cb_data)
{
	static struct lock_file reflog_lock;
	struct expire_reflog_cb cb;
	struct ref_lock *lock;
	char *log_file;
	int status = 0;

	memset(&cb, 0, sizeof(cb));
	cb.flags = flags;
	cb.policy_cb = policy_cb_data;
	cb.should_prune_fn = should_prune_fn;

	/*
	 * The reflog file is locked by holding the lock on the
	 * reference itself, plus we might need to update the
	 * reference if --updateref was specified:
	 */
4039
	lock = lock_ref_sha1_basic(refname, sha1, NULL, 0, NULL);
4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103
	if (!lock)
		return error("cannot lock ref '%s'", refname);
	if (!reflog_exists(refname)) {
		unlock_ref(lock);
		return 0;
	}

	log_file = git_pathdup("logs/%s", refname);
	if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
		/*
		 * Even though holding $GIT_DIR/logs/$reflog.lock has
		 * no locking implications, we use the lock_file
		 * machinery here anyway because it does a lot of the
		 * work we need, including cleaning up if the program
		 * exits unexpectedly.
		 */
		if (hold_lock_file_for_update(&reflog_lock, log_file, 0) < 0) {
			struct strbuf err = STRBUF_INIT;
			unable_to_lock_message(log_file, errno, &err);
			error("%s", err.buf);
			strbuf_release(&err);
			goto failure;
		}
		cb.newlog = fdopen_lock_file(&reflog_lock, "w");
		if (!cb.newlog) {
			error("cannot fdopen %s (%s)",
			      reflog_lock.filename.buf, strerror(errno));
			goto failure;
		}
	}

	(*prepare_fn)(refname, sha1, cb.policy_cb);
	for_each_reflog_ent(refname, expire_reflog_ent, &cb);
	(*cleanup_fn)(cb.policy_cb);

	if (!(flags & EXPIRE_REFLOGS_DRY_RUN)) {
		if (close_lock_file(&reflog_lock)) {
			status |= error("couldn't write %s: %s", log_file,
					strerror(errno));
		} else if ((flags & EXPIRE_REFLOGS_UPDATE_REF) &&
			(write_in_full(lock->lock_fd,
				sha1_to_hex(cb.last_kept_sha1), 40) != 40 ||
			 write_str_in_full(lock->lock_fd, "\n") != 1 ||
			 close_ref(lock) < 0)) {
			status |= error("couldn't write %s",
					lock->lk->filename.buf);
			rollback_lock_file(&reflog_lock);
		} else if (commit_lock_file(&reflog_lock)) {
			status |= error("unable to commit reflog '%s' (%s)",
					log_file, strerror(errno));
		} else if ((flags & EXPIRE_REFLOGS_UPDATE_REF) && commit_ref(lock)) {
			status |= error("couldn't set %s", lock->ref_name);
		}
	}
	free(log_file);
	unlock_ref(lock);
	return status;

 failure:
	rollback_lock_file(&reflog_lock);
	free(log_file);
	unlock_ref(lock);
	return -1;
}