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

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

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

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

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

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

F
Felipe Contreras 已提交
75 76 77 78
	if (!strcmp(refname, "@"))
		/* Refname is a single character '@'. */
		return -1;

79 80 81
	while (1) {
		/* We are at the start of a path component. */
		component_len = check_refname_component(refname, flags);
82
		if (component_len <= 0) {
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
			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;
108

109 110 111 112 113 114
/*
 * 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.
 */
115
struct ref_value {
116 117 118 119 120 121
	/*
	 * 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.
	 */
122
	unsigned char sha1[20];
123 124 125 126

	/*
	 * If REF_KNOWS_PEELED, then this field holds the peeled value
	 * of this reference, or null if the reference is known not to
127 128
	 * be peelable.  See the documentation for peel_ref() for an
	 * exact definition of "peelable".
129
	 */
130 131 132
	unsigned char peeled[20];
};

133 134
struct ref_cache;

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
/*
 * 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().
 */
161
struct ref_dir {
162
	int nr, alloc;
163 164 165 166 167 168 169 170 171

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

172 173 174
	/* A pointer to the ref_cache that contains this ref_dir. */
	struct ref_cache *ref_cache;

175
	struct ref_entry **entries;
176 177
};

178 179 180 181 182 183 184 185 186 187 188
/*
 * Bit values for ref_entry::flag.  REF_ISSYMREF=0x01,
 * REF_ISPACKED=0x02, and REF_ISBROKEN=0x04 are public values; see
 * refs.h.
 */

/*
 * 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.
 */
189
#define REF_KNOWS_PEELED 0x08
190 191

/* ref_entry represents a directory of references */
192
#define REF_DIR 0x10
193

194 195 196 197 198 199
/*
 * Entry has not yet been read from disk (used only for REF_DIR
 * entries representing loose references)
 */
#define REF_INCOMPLETE 0x20

200 201
/*
 * A ref_entry represents either a reference or a "subdirectory" of
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
 * 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).
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
 *
 * 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.
 */
239 240
struct ref_entry {
	unsigned char flag; /* ISSYMREF? ISPACKED? */
241
	union {
242 243
		struct ref_value value; /* if not (flags&REF_DIR) */
		struct ref_dir subdir; /* if (flags&REF_DIR) */
244
	} u;
245 246 247 248 249
	/*
	 * 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/"):
	 */
250 251
	char name[FLEX_ARRAY];
};
252

253 254
static void read_loose_refs(const char *dirname, struct ref_dir *dir);

255 256
static struct ref_dir *get_ref_dir(struct ref_entry *entry)
{
257
	struct ref_dir *dir;
258
	assert(entry->flag & REF_DIR);
259 260 261 262 263 264
	dir = &entry->u.subdir;
	if (entry->flag & REF_INCOMPLETE) {
		read_loose_refs(entry->name, dir);
		entry->flag &= ~REF_INCOMPLETE;
	}
	return dir;
265 266
}

267 268 269
static struct ref_entry *create_ref_entry(const char *refname,
					  const unsigned char *sha1, int flag,
					  int check_name)
270 271
{
	int len;
272
	struct ref_entry *ref;
273

274
	if (check_name &&
275 276
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
		die("Reference has invalid format: '%s'", refname);
277 278
	len = strlen(refname) + 1;
	ref = xmalloc(sizeof(struct ref_entry) + len);
279 280
	hashcpy(ref->u.value.sha1, sha1);
	hashclr(ref->u.value.peeled);
281 282 283 284 285
	memcpy(ref->name, refname, len);
	ref->flag = flag;
	return ref;
}

286 287
static void clear_ref_dir(struct ref_dir *dir);

288 289
static void free_ref_entry(struct ref_entry *entry)
{
290 291 292 293 294 295 296
	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);
	}
297 298 299
	free(entry);
}

300 301 302 303 304 305
/*
 * 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)
306
{
307 308
	ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
	dir->entries[dir->nr++] = entry;
309 310 311 312 313 314
	/* 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;
315 316
}

317 318 319
/*
 * Clear and free all entries in dir, recursively.
 */
320
static void clear_ref_dir(struct ref_dir *dir)
321 322
{
	int i;
323 324 325 326 327
	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;
328 329
}

330 331 332 333 334
/*
 * 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.
 */
335
static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
336 337
					  const char *dirname, size_t len,
					  int incomplete)
338 339 340
{
	struct ref_entry *direntry;
	direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
341 342
	memcpy(direntry->name, dirname, len);
	direntry->name[len] = '\0';
343
	direntry->u.subdir.ref_cache = ref_cache;
344
	direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
345 346 347
	return direntry;
}

348
static int ref_entry_cmp(const void *a, const void *b)
349
{
350 351 352 353
	struct ref_entry *one = *(struct ref_entry **)a;
	struct ref_entry *two = *(struct ref_entry **)b;
	return strcmp(one->name, two->name);
}
354

355
static void sort_ref_dir(struct ref_dir *dir);
356

357 358 359 360 361 362 363
struct string_slice {
	size_t len;
	const char *str;
};

static int ref_entry_cmp_sslice(const void *key_, const void *ent_)
{
364 365 366
	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);
367 368
	if (cmp)
		return cmp;
369
	return '\0' - (unsigned char)ent->name[key->len];
370 371
}

372
/*
373 374 375
 * 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.
376
 */
377
static int search_ref_dir(struct ref_dir *dir, const char *refname, size_t len)
378
{
379 380
	struct ref_entry **r;
	struct string_slice key;
381

382
	if (refname == NULL || !dir->nr)
383
		return -1;
384

385
	sort_ref_dir(dir);
386 387 388 389
	key.len = len;
	key.str = refname;
	r = bsearch(&key, dir->entries, dir->nr, sizeof(*dir->entries),
		    ref_entry_cmp_sslice);
390 391

	if (r == NULL)
392
		return -1;
393

394
	return r - dir->entries;
395 396
}

397 398 399 400 401
/*
 * 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
402
 * directory cannot be found.  dir must already be complete.
403
 */
404
static struct ref_dir *search_for_subdir(struct ref_dir *dir,
405 406
					 const char *subdirname, size_t len,
					 int mkdir)
407
{
408 409 410
	int entry_index = search_ref_dir(dir, subdirname, len);
	struct ref_entry *entry;
	if (entry_index == -1) {
411 412
		if (!mkdir)
			return NULL;
413 414 415 416 417 418
		/*
		 * 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.
		 */
419
		entry = create_dir_entry(dir->ref_cache, subdirname, len, 0);
420
		add_entry_to_dir(dir, entry);
421 422
	} else {
		entry = dir->entries[entry_index];
423
	}
424
	return get_ref_dir(entry);
425 426
}

427 428 429 430
/*
 * 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
431 432 433 434
 * 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.
435 436 437 438
 */
static struct ref_dir *find_containing_dir(struct ref_dir *dir,
					   const char *refname, int mkdir)
{
439 440
	const char *slash;
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
441
		size_t dirnamelen = slash - refname + 1;
442
		struct ref_dir *subdir;
443
		subdir = search_for_subdir(dir, refname, dirnamelen, mkdir);
444 445
		if (!subdir) {
			dir = NULL;
446
			break;
447
		}
448
		dir = subdir;
449 450 451 452 453 454 455 456 457 458 459 460
	}

	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)
{
461
	int entry_index;
462 463 464 465
	struct ref_entry *entry;
	dir = find_containing_dir(dir, refname, 0);
	if (!dir)
		return NULL;
466 467 468 469 470
	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;
471 472
}

473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
/*
 * 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;
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
}

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

538 539 540 541 542 543 544
/*
 * 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)
{
545
	if (strcmp(ref1->name, ref2->name))
546
		return 0;
547 548 549 550 551 552 553 554 555 556 557 558

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

561
/*
562 563
 * Sort the entries in dir non-recursively (if they are not already
 * sorted) and remove any duplicate entries.
564
 */
565
static void sort_ref_dir(struct ref_dir *dir)
566
{
567
	int i, j;
568
	struct ref_entry *last = NULL;
569

570 571 572 573
	/*
	 * This check also prevents passing a zero-length array to qsort(),
	 * which is a problem on some platforms.
	 */
574
	if (dir->sorted == dir->nr)
575
		return;
576

577
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
578

579 580 581 582 583 584 585
	/* 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;
586
	}
587
	dir->sorted = dir->nr = i;
588
}
589

590 591
/* Include broken references in a do_for_each_ref*() iteration: */
#define DO_FOR_EACH_INCLUDE_BROKEN 0x01
592

593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
/*
 * 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;
}
608

609 610 611 612 613 614 615 616 617
/*
 * 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.
 */
618
static struct ref_entry *current_ref;
619

620 621 622 623 624 625 626 627 628 629
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;
};

630
/*
631 632
 * Handle one reference in a do_for_each_ref*()-style iteration,
 * calling an each_ref_fn for each entry.
633
 */
634
static int do_one_ref(struct ref_entry *entry, void *cb_data)
635
{
636
	struct ref_entry_cb *data = cb_data;
637
	int retval;
638
	if (prefixcmp(entry->name, data->base))
639
		return 0;
640

641
	if (!(data->flags & DO_FOR_EACH_INCLUDE_BROKEN) &&
642
	      !ref_resolves_to_object(entry))
643
		return 0;
644

645
	current_ref = entry;
646 647
	retval = data->fn(entry->name + data->trim, entry->u.value.sha1,
			  entry->flag, data->cb_data);
648 649
	current_ref = NULL;
	return retval;
650
}
651

652
/*
653
 * Call fn for each reference in dir that has index in the range
654 655
 * offset <= index < dir->nr.  Recurse into subdirectories that are in
 * that index range, sorting them before iterating.  This function
656 657
 * does not sort dir itself; it should be sorted beforehand.  fn is
 * called for all references, including broken ones.
658
 */
659 660
static int do_for_each_entry_in_dir(struct ref_dir *dir, int offset,
				    each_ref_entry_fn fn, void *cb_data)
661 662
{
	int i;
663 664
	assert(dir->sorted == dir->nr);
	for (i = offset; i < dir->nr; i++) {
665 666 667
		struct ref_entry *entry = dir->entries[i];
		int retval;
		if (entry->flag & REF_DIR) {
668 669
			struct ref_dir *subdir = get_ref_dir(entry);
			sort_ref_dir(subdir);
670
			retval = do_for_each_entry_in_dir(subdir, 0, fn, cb_data);
671
		} else {
672
			retval = fn(entry, cb_data);
673
		}
674 675 676 677 678 679
		if (retval)
			return retval;
	}
	return 0;
}

680
/*
681
 * Call fn for each reference in the union of dir1 and dir2, in order
682 683 684
 * 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
685 686
 * sorted as needed.  fn is called for all references, including
 * broken ones.
687
 */
688 689 690
static int do_for_each_entry_in_dirs(struct ref_dir *dir1,
				     struct ref_dir *dir2,
				     each_ref_entry_fn fn, void *cb_data)
691 692 693 694
{
	int retval;
	int i1 = 0, i2 = 0;

695 696
	assert(dir1->sorted == dir1->nr);
	assert(dir2->sorted == dir2->nr);
697 698 699 700
	while (1) {
		struct ref_entry *e1, *e2;
		int cmp;
		if (i1 == dir1->nr) {
701
			return do_for_each_entry_in_dir(dir2, i2, fn, cb_data);
702 703
		}
		if (i2 == dir2->nr) {
704
			return do_for_each_entry_in_dir(dir1, i1, fn, cb_data);
705 706 707 708 709 710 711
		}
		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. */
712 713 714 715
				struct ref_dir *subdir1 = get_ref_dir(e1);
				struct ref_dir *subdir2 = get_ref_dir(e2);
				sort_ref_dir(subdir1);
				sort_ref_dir(subdir2);
716 717
				retval = do_for_each_entry_in_dirs(
						subdir1, subdir2, fn, cb_data);
718 719 720 721
				i1++;
				i2++;
			} else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
				/* Both are references; ignore the one from dir1. */
722
				retval = fn(e2, cb_data);
723 724 725 726 727 728
				i1++;
				i2++;
			} else {
				die("conflict between reference and directory: %s",
				    e1->name);
			}
729
		} else {
730 731 732
			struct ref_entry *e;
			if (cmp < 0) {
				e = e1;
733
				i1++;
734 735 736 737 738
			} else {
				e = e2;
				i2++;
			}
			if (e->flag & REF_DIR) {
739 740
				struct ref_dir *subdir = get_ref_dir(e);
				sort_ref_dir(subdir);
741 742
				retval = do_for_each_entry_in_dir(
						subdir, 0, fn, cb_data);
743
			} else {
744
				retval = fn(e, cb_data);
745 746 747 748 749 750 751
			}
		}
		if (retval)
			return retval;
	}
}

752 753 754 755 756 757 758 759 760
/*
 * Return true iff refname1 and refname2 conflict with each other.
 * Two reference names conflict if one of them exactly matches the
 * leading components of the other; e.g., "foo/bar" conflicts with
 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
 * "foo/barbados".
 */
static int names_conflict(const char *refname1, const char *refname2)
{
761 762 763 764 765 766 767 768 769 770 771 772
	for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
		;
	return (*refname1 == '\0' && *refname2 == '/')
		|| (*refname1 == '/' && *refname2 == '\0');
}

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

773
static int name_conflict_fn(struct ref_entry *entry, void *cb_data)
774 775
{
	struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
776
	if (data->oldrefname && !strcmp(data->oldrefname, entry->name))
777
		return 0;
778 779
	if (names_conflict(data->refname, entry->name)) {
		data->conflicting_refname = entry->name;
780
		return 1;
781
	}
782
	return 0;
783 784
}

785 786
/*
 * Return true iff a reference named refname could be created without
787
 * conflicting with the name of an existing reference in dir.  If
788 789
 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
 * (e.g., because oldrefname is scheduled for deletion in the same
790 791 792
 * operation).
 */
static int is_refname_available(const char *refname, const char *oldrefname,
793
				struct ref_dir *dir)
794
{
795 796 797 798 799
	struct name_conflict_cb data;
	data.refname = refname;
	data.oldrefname = oldrefname;
	data.conflicting_refname = NULL;

800
	sort_ref_dir(dir);
801
	if (do_for_each_entry_in_dir(dir, 0, name_conflict_fn, &data)) {
802 803 804
		error("'%s' exists; cannot create '%s'",
		      data.conflicting_refname, refname);
		return 0;
805 806
	}
	return 1;
807 808
}

809 810 811 812
struct packed_ref_cache {
	struct ref_entry *root;
};

813 814 815 816
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
817 818
static struct ref_cache {
	struct ref_cache *next;
819
	struct ref_entry *loose;
820
	struct packed_ref_cache *packed;
821 822 823 824 825 826 827
	/*
	 * 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;
828

829
static void clear_packed_ref_cache(struct ref_cache *refs)
830
{
831
	if (refs->packed) {
832 833
		free_ref_entry(refs->packed->root);
		free(refs->packed);
834 835
		refs->packed = NULL;
	}
836
}
837

838 839
static void clear_loose_ref_cache(struct ref_cache *refs)
{
840 841 842 843
	if (refs->loose) {
		free_ref_entry(refs->loose);
		refs->loose = NULL;
	}
844 845
}

846
static struct ref_cache *create_ref_cache(const char *submodule)
847
{
848
	int len;
849
	struct ref_cache *refs;
850 851 852
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
853
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
854
	memcpy(refs->name, submodule, len);
855 856 857
	return refs;
}

858
/*
859
 * Return a pointer to a ref_cache for the specified submodule. For
860 861 862 863
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
864
static struct ref_cache *get_ref_cache(const char *submodule)
865
{
866 867 868 869 870 871
	struct ref_cache *refs;

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

	for (refs = submodule_ref_caches; refs; refs = refs->next)
872 873 874
		if (!strcmp(submodule, refs->name))
			return refs;

875
	refs = create_ref_cache(submodule);
876 877
	refs->next = submodule_ref_caches;
	submodule_ref_caches = refs;
878
	return refs;
879 880
}

881
void invalidate_ref_cache(const char *submodule)
882
{
883 884 885
	struct ref_cache *refs = get_ref_cache(submodule);
	clear_packed_ref_cache(refs);
	clear_loose_ref_cache(refs);
886
}
887

888 889 890
/* The length of a peeled reference line in packed-refs, including EOL: */
#define PEELED_LINE_LENGTH 42

891 892 893 894 895 896 897
/*
 * 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";

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
/*
 * Parse one line from a packed-refs file.  Write the SHA1 to sha1.
 * Return a pointer to the refname within the line (null-terminated),
 * or NULL if there was a problem.
 */
static const char *parse_ref_line(char *line, unsigned char *sha1)
{
	/*
	 * 42: the answer to everything.
	 *
	 * In this case, it happens to be the answer to
	 *  40 (length of sha1 hex representation)
	 *  +1 (space in between hex and name)
	 *  +1 (newline at the end of the line)
	 */
	int len = strlen(line) - 42;

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

	return line;
}

931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
/*
 * 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).
 */
958
static void read_packed_refs(FILE *f, struct ref_dir *dir)
959
{
960
	struct ref_entry *last = NULL;
961
	char refline[PATH_MAX];
962
	enum { PEELED_NONE, PEELED_TAGS, PEELED_FULLY } peeled = PEELED_NONE;
963 964 965

	while (fgets(refline, sizeof(refline), f)) {
		unsigned char sha1[20];
966
		const char *refname;
967 968 969 970
		static const char header[] = "# pack-refs with:";

		if (!strncmp(refline, header, sizeof(header)-1)) {
			const char *traits = refline + sizeof(header) - 1;
971 972 973 974
			if (strstr(traits, " fully-peeled "))
				peeled = PEELED_FULLY;
			else if (strstr(traits, " peeled "))
				peeled = PEELED_TAGS;
975 976 977 978
			/* perhaps other traits later as well */
			continue;
		}

979 980
		refname = parse_ref_line(refline, sha1);
		if (refname) {
981 982 983 984
			last = create_ref_entry(refname, sha1, REF_ISPACKED, 1);
			if (peeled == PEELED_FULLY ||
			    (peeled == PEELED_TAGS && !prefixcmp(refname, "refs/tags/")))
				last->flag |= REF_KNOWS_PEELED;
985
			add_ref(dir, last);
986 987 988 989
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
990 991
		    strlen(refline) == PEELED_LINE_LENGTH &&
		    refline[PEELED_LINE_LENGTH - 1] == '\n' &&
992
		    !get_sha1_hex(refline + 1, sha1)) {
993
			hashcpy(last->u.value.peeled, sha1);
994 995 996 997 998 999 1000
			/*
			 * Regardless of what the file header said,
			 * we definitely know the value of *this*
			 * reference:
			 */
			last->flag |= REF_KNOWS_PEELED;
		}
1001 1002 1003
	}
}

1004 1005 1006 1007 1008
/*
 * 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)
1009
{
1010
	if (!refs->packed) {
1011 1012
		const char *packed_refs_file;
		FILE *f;
1013

1014 1015
		refs->packed = xcalloc(1, sizeof(*refs->packed));
		refs->packed->root = create_dir_entry(refs, "", 0, 0);
1016 1017
		if (*refs->name)
			packed_refs_file = git_path_submodule(refs->name, "packed-refs");
1018 1019 1020
		else
			packed_refs_file = git_path("packed-refs");
		f = fopen(packed_refs_file, "r");
1021
		if (f) {
1022
			read_packed_refs(f, get_ref_dir(refs->packed->root));
1023 1024 1025
			fclose(f);
		}
	}
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
	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));
1037 1038
}

1039 1040
void add_packed_ref(const char *refname, const unsigned char *sha1)
{
1041 1042
	add_ref(get_packed_refs(&ref_cache),
		create_ref_entry(refname, sha1, REF_ISPACKED, 1));
1043 1044
}

1045
/*
1046 1047 1048
 * 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.
1049
 */
1050
static void read_loose_refs(const char *dirname, struct ref_dir *dir)
1051
{
1052
	struct ref_cache *refs = dir->ref_cache;
1053
	DIR *d;
1054
	const char *path;
1055
	struct dirent *de;
1056
	int dirnamelen = strlen(dirname);
1057
	struct strbuf refname;
1058

M
Michael Haggerty 已提交
1059
	if (*refs->name)
1060
		path = git_path_submodule(refs->name, "%s", dirname);
1061
	else
1062
		path = git_path("%s", dirname);
1063

1064
	d = opendir(path);
1065 1066 1067
	if (!d)
		return;

1068 1069
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080

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

		if (de->d_name[0] == '.')
			continue;
		if (has_extension(de->d_name, ".lock"))
			continue;
1081
		strbuf_addstr(&refname, de->d_name);
1082
		refdir = *refs->name
1083 1084 1085 1086 1087
			? 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)) {
1088
			strbuf_addch(&refname, '/');
1089
			add_entry_to_dir(dir,
1090 1091
					 create_dir_entry(refs, refname.buf,
							  refname.len, 1));
1092
		} else {
M
Michael Haggerty 已提交
1093
			if (*refs->name) {
1094
				hashclr(sha1);
1095
				flag = 0;
1096
				if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
1097
					hashclr(sha1);
1098
					flag |= REF_ISBROKEN;
1099
				}
1100
			} else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
1101 1102 1103
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
1104 1105
			add_entry_to_dir(dir,
					 create_ref_entry(refname.buf, sha1, flag, 1));
1106
		}
1107
		strbuf_setlen(&refname, dirnamelen);
1108
	}
1109
	strbuf_release(&refname);
1110
	closedir(d);
1111 1112
}

1113
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
1114
{
1115
	if (!refs->loose) {
1116 1117 1118 1119 1120
		/*
		 * Mark the top-level directory complete because we
		 * are about to read the only subdirectory that can
		 * hold references:
		 */
1121
		refs->loose = create_dir_entry(refs, "", 0, 0);
1122 1123 1124 1125
		/*
		 * Create an incomplete entry for "refs/":
		 */
		add_entry_to_dir(get_ref_dir(refs->loose),
1126
				 create_dir_entry(refs, "refs/", 5, 1));
1127
	}
1128
	return get_ref_dir(refs->loose);
1129 1130
}

1131 1132
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
1133 1134
#define MAXREFLEN (1024)

1135 1136
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
1137 1138
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
1139
 */
1140
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
1141
				      const char *refname, unsigned char *sha1)
1142
{
1143
	struct ref_entry *ref;
1144
	struct ref_dir *dir = get_packed_refs(refs);
1145

1146
	ref = find_ref(dir, refname);
1147 1148 1149
	if (ref == NULL)
		return -1;

1150
	memcpy(sha1, ref->u.value.sha1, 20);
1151
	return 0;
1152 1153
}

1154
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
1155
					 const char *refname, unsigned char *sha1,
1156
					 int recursion)
1157
{
1158
	int fd, len;
1159
	char buffer[128], *p;
1160
	char *path;
1161

1162
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
1163
		return -1;
1164 1165 1166 1167
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
1168
	if (fd < 0)
1169
		return resolve_gitlink_packed_ref(refs, refname, sha1);
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179

	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? */
1180
	if (!get_sha1_hex(buffer, sha1))
1181 1182 1183 1184 1185 1186 1187 1188 1189
		return 0;

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

1190
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
1191 1192
}

1193
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
1194 1195
{
	int len = strlen(path), retval;
1196
	char *submodule;
1197
	struct ref_cache *refs;
1198 1199 1200 1201 1202

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
1203 1204 1205 1206
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

1207
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1208 1209
	return retval;
}
1210

1211
/*
1212 1213
 * Return the ref_entry for the given refname from the packed
 * references.  If it does not exist, return NULL.
1214
 */
1215
static struct ref_entry *get_packed_ref(const char *refname)
1216
{
1217
	return find_ref(get_packed_refs(&ref_cache), refname);
1218 1219
}

J
Junio C Hamano 已提交
1220
const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
1221
{
1222 1223
	int depth = MAXDEPTH;
	ssize_t len;
1224
	char buffer[256];
1225
	static char refname_buffer[256];
1226

1227 1228 1229
	if (flag)
		*flag = 0;

1230
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1231 1232
		return NULL;

1233
	for (;;) {
1234
		char path[PATH_MAX];
1235 1236 1237
		struct stat st;
		char *buf;
		int fd;
1238

1239 1240
		if (--depth < 0)
			return NULL;
1241

1242
		git_snpath(path, sizeof(path), "%s", refname);
1243

1244
		if (lstat(path, &st) < 0) {
1245 1246
			struct ref_entry *entry;

1247 1248 1249 1250 1251 1252
			if (errno != ENOENT)
				return NULL;
			/*
			 * The loose reference file does not exist;
			 * check for a packed reference.
			 */
1253 1254 1255
			entry = get_packed_ref(refname);
			if (entry) {
				hashcpy(sha1, entry->u.value.sha1);
1256 1257
				if (flag)
					*flag |= REF_ISPACKED;
1258
				return refname;
1259
			}
1260 1261
			/* The reference is not a packed reference, either. */
			if (reading) {
1262
				return NULL;
1263 1264
			} else {
				hashclr(sha1);
1265
				return refname;
1266
			}
1267
		}
1268

1269 1270 1271
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
1272 1273
			if (len < 0)
				return NULL;
M
Michael Haggerty 已提交
1274
			buffer[len] = 0;
1275 1276
			if (!prefixcmp(buffer, "refs/") &&
					!check_refname_format(buffer, 0)) {
1277 1278
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
1279 1280
				if (flag)
					*flag |= REF_ISSYMREF;
1281 1282
				continue;
			}
1283
		}
1284

1285 1286 1287 1288 1289 1290
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

1291 1292 1293 1294 1295 1296 1297
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
		if (fd < 0)
			return NULL;
1298
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
1299
		close(fd);
1300 1301 1302 1303 1304
		if (len < 0)
			return NULL;
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1305 1306 1307 1308

		/*
		 * Is it a symbolic ref?
		 */
1309
		if (prefixcmp(buffer, "ref:"))
1310
			break;
1311 1312
		if (flag)
			*flag |= REF_ISSYMREF;
1313
		buf = buffer + 4;
1314 1315
		while (isspace(*buf))
			buf++;
1316
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1317 1318
			if (flag)
				*flag |= REF_ISBROKEN;
1319 1320
			return NULL;
		}
1321
		refname = strcpy(refname_buffer, buf);
1322
	}
1323 1324
	/* Please note that FETCH_HEAD has a second line containing other data. */
	if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1325 1326
		if (flag)
			*flag |= REF_ISBROKEN;
1327
		return NULL;
1328
	}
1329
	return refname;
1330 1331
}

1332 1333
char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
{
1334
	const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1335 1336 1337
	return ret ? xstrdup(ret) : NULL;
}

I
Ilari Liusvaara 已提交
1338 1339 1340 1341 1342 1343 1344
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1345
int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1346
{
J
Junio C Hamano 已提交
1347
	if (resolve_ref_unsafe(refname, sha1, reading, flags))
1348 1349
		return 0;
	return -1;
1350 1351
}

1352
int read_ref(const char *refname, unsigned char *sha1)
1353
{
1354
	return read_ref_full(refname, sha1, 1, NULL);
1355 1356
}

1357
int ref_exists(const char *refname)
1358
{
1359 1360
	unsigned char sha1[20];
	return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1361 1362
}

1363
static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1364
		       void *data)
I
Ilari Liusvaara 已提交
1365 1366
{
	struct ref_filter *filter = (struct ref_filter *)data;
1367
	if (fnmatch(filter->pattern, refname, 0))
I
Ilari Liusvaara 已提交
1368
		return 0;
1369
	return filter->fn(refname, sha1, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1370 1371
}

1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
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: */
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
	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
1395 1396
};

1397 1398
/*
 * Peel the named object; i.e., if the object is a tag, resolve the
1399 1400 1401 1402
 * 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.
1403
 */
1404
static enum peel_status peel_object(const unsigned char *name, unsigned char *sha1)
1405 1406 1407 1408 1409 1410
{
	struct object *o = lookup_unknown_object(name);

	if (o->type == OBJ_NONE) {
		int type = sha1_object_info(name, NULL);
		if (type < 0)
1411
			return PEEL_INVALID;
1412 1413 1414 1415
		o->type = type;
	}

	if (o->type != OBJ_TAG)
1416
		return PEEL_NON_TAG;
1417 1418 1419

	o = deref_tag_noverify(o);
	if (!o)
1420
		return PEEL_INVALID;
1421 1422

	hashcpy(sha1, o->sha1);
1423
	return PEEL_PEELED;
1424 1425
}

1426
/*
1427 1428 1429
 * 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.
1430 1431 1432 1433 1434 1435
 *
 * 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.
1436
 */
1437
static enum peel_status peel_entry(struct ref_entry *entry, int repeel)
1438 1439 1440
{
	enum peel_status status;

1441 1442 1443 1444 1445 1446 1447 1448 1449
	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;
		}
	}
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
	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;
}

1461
int peel_ref(const char *refname, unsigned char *sha1)
1462 1463 1464 1465
{
	int flag;
	unsigned char base[20];

1466
	if (current_ref && (current_ref->name == refname
1467
			    || !strcmp(current_ref->name, refname))) {
1468
		if (peel_entry(current_ref, 0))
1469 1470 1471
			return -1;
		hashcpy(sha1, current_ref->u.value.peeled);
		return 0;
1472 1473
	}

1474
	if (read_ref_full(refname, base, 1, &flag))
1475 1476
		return -1;

1477 1478 1479 1480 1481 1482 1483 1484 1485
	/*
	 * 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) {
1486
		struct ref_entry *r = get_packed_ref(refname);
1487
		if (r) {
1488
			if (peel_entry(r, 0))
1489
				return -1;
1490
			hashcpy(sha1, r->u.value.peeled);
1491
			return 0;
1492 1493 1494
		}
	}

1495
	return peel_object(base, sha1);
1496 1497
}

1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518
struct warn_if_dangling_data {
	FILE *fp;
	const char *refname;
	const char *msg_fmt;
};

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

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

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

	fprintf(d->fp, d->msg_fmt, refname);
J
Junio C Hamano 已提交
1519
	fputc('\n', d->fp);
1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532
	return 0;
}

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

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

1533
/*
1534
 * Call fn for each reference in the specified ref_cache, omitting
1535 1536
 * references not in the containing_dir of base.  fn is called for all
 * references, including broken ones.  If fn ever returns a non-zero
1537 1538 1539
 * value, stop the iteration and return that value; otherwise, return
 * 0.
 */
1540
static int do_for_each_entry(struct ref_cache *refs, const char *base,
1541
			     each_ref_entry_fn fn, void *cb_data)
1542
{
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554
	struct ref_dir *packed_dir = get_packed_refs(refs);
	struct ref_dir *loose_dir = get_loose_refs(refs);
	int retval = 0;

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

	if (packed_dir && loose_dir) {
		sort_ref_dir(packed_dir);
		sort_ref_dir(loose_dir);
1555 1556
		retval = do_for_each_entry_in_dirs(
				packed_dir, loose_dir, fn, cb_data);
1557 1558
	} else if (packed_dir) {
		sort_ref_dir(packed_dir);
1559 1560
		retval = do_for_each_entry_in_dir(
				packed_dir, 0, fn, cb_data);
1561 1562
	} else if (loose_dir) {
		sort_ref_dir(loose_dir);
1563 1564
		retval = do_for_each_entry_in_dir(
				loose_dir, 0, fn, cb_data);
1565 1566 1567
	}

	return retval;
1568 1569
}

1570
/*
1571
 * Call fn for each reference in the specified ref_cache for which the
1572 1573 1574 1575 1576 1577 1578
 * 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.
 */
1579 1580
static int do_for_each_ref(struct ref_cache *refs, const char *base,
			   each_ref_fn fn, int trim, int flags, void *cb_data)
1581 1582 1583 1584 1585 1586 1587 1588
{
	struct ref_entry_cb data;
	data.base = base;
	data.trim = trim;
	data.flags = flags;
	data.fn = fn;
	data.cb_data = cb_data;

1589
	return do_for_each_entry(refs, base, do_one_ref, &data);
1590 1591
}

1592
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1593 1594
{
	unsigned char sha1[20];
1595 1596
	int flag;

1597 1598 1599 1600 1601 1602 1603
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

1604
	if (!read_ref_full("HEAD", sha1, 1, &flag))
1605
		return fn("HEAD", sha1, flag, cb_data);
1606

1607
	return 0;
1608 1609
}

1610 1611 1612 1613 1614
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

1615 1616 1617 1618 1619
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

1620
int for_each_ref(each_ref_fn fn, void *cb_data)
1621
{
1622
	return do_for_each_ref(&ref_cache, "", fn, 0, 0, cb_data);
1623 1624
}

1625 1626
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
1627
	return do_for_each_ref(get_ref_cache(submodule), "", fn, 0, 0, cb_data);
1628 1629
}

1630 1631
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
1632
	return do_for_each_ref(&ref_cache, prefix, fn, strlen(prefix), 0, cb_data);
1633 1634
}

1635 1636 1637
int for_each_ref_in_submodule(const char *submodule, const char *prefix,
		each_ref_fn fn, void *cb_data)
{
1638
	return do_for_each_ref(get_ref_cache(submodule), prefix, fn, strlen(prefix), 0, cb_data);
1639 1640
}

1641
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1642
{
1643
	return for_each_ref_in("refs/tags/", fn, cb_data);
1644 1645
}

1646 1647 1648 1649 1650
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);
}

1651
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1652
{
1653
	return for_each_ref_in("refs/heads/", fn, cb_data);
1654 1655
}

1656 1657 1658 1659 1660
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);
}

1661
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1662
{
1663
	return for_each_ref_in("refs/remotes/", fn, cb_data);
1664 1665
}

1666 1667 1668 1669 1670
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);
}

1671 1672
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
1673
	return do_for_each_ref(&ref_cache, "refs/replace/", fn, 13, 0, cb_data);
1674 1675
}

J
Josh Triplett 已提交
1676 1677 1678 1679 1680 1681 1682 1683
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());
1684
	if (!read_ref_full(buf.buf, sha1, 1, &flag))
J
Josh Triplett 已提交
1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
		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());
1696
	ret = do_for_each_ref(&ref_cache, buf.buf, fn, 0, 0, cb_data);
J
Josh Triplett 已提交
1697 1698 1699 1700
	strbuf_release(&buf);
	return ret;
}

1701 1702
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
1703 1704 1705 1706 1707
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

1708
	if (!prefix && prefixcmp(pattern, "refs/"))
I
Ilari Liusvaara 已提交
1709
		strbuf_addstr(&real_pattern, "refs/");
1710 1711
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
1712 1713
	strbuf_addstr(&real_pattern, pattern);

1714
	if (!has_glob_specials(pattern)) {
1715
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
		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;
}

1731 1732 1733 1734 1735
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);
}

1736 1737
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
1738
	return do_for_each_ref(&ref_cache, "", fn, 0,
1739
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1740 1741
}

1742
const char *prettify_refname(const char *name)
1743 1744 1745 1746 1747 1748 1749 1750
{
	return name + (
		!prefixcmp(name, "refs/heads/") ? 11 :
		!prefixcmp(name, "refs/tags/") ? 10 :
		!prefixcmp(name, "refs/remotes/") ? 13 :
		0);
}

S
Steffen Prohaska 已提交
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
const char *ref_rev_parse_rules[] = {
	"%.*s",
	"refs/%.*s",
	"refs/tags/%.*s",
	"refs/heads/%.*s",
	"refs/remotes/%.*s",
	"refs/remotes/%.*s/HEAD",
	NULL
};

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

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

	return 0;
}

J
Junio C Hamano 已提交
1775
static struct ref_lock *verify_lock(struct ref_lock *lock,
1776 1777
	const unsigned char *old_sha1, int mustexist)
{
1778
	if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1779
		error("Can't verify ref %s", lock->ref_name);
1780 1781 1782
		unlock_ref(lock);
		return NULL;
	}
1783
	if (hashcmp(lock->old_sha1, old_sha1)) {
1784
		error("Ref %s is at %s but expected %s", lock->ref_name,
1785 1786 1787 1788 1789 1790 1791
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
		return NULL;
	}
	return lock;
}

1792
static int remove_empty_directories(const char *file)
1793 1794 1795 1796 1797
{
	/* 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.
	 */
1798 1799
	struct strbuf path;
	int result;
1800

1801 1802 1803
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

1804
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1805 1806 1807 1808

	strbuf_release(&path);

	return result;
1809 1810
}

1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
/*
 * *string and *len will only be substituted, and *string returned (for
 * later free()ing) if the string passed in is a magic short-hand form
 * to name a branch.
 */
static char *substitute_branch_name(const char **string, int *len)
{
	struct strbuf buf = STRBUF_INIT;
	int ret = interpret_branch_name(*string, &buf);

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

	return NULL;
}

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

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

		this_result = refs_found ? sha1_from_ref : sha1;
		mksnpath(fullref, sizeof(fullref), *p, len, str);
1846
		r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1847 1848 1849 1850 1851
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
1852
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1853
			warning("ignoring dangling symref %s.", fullref);
1854 1855 1856
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875
	}
	free(last_branch);
	return refs_found;
}

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

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

		mksnpath(path, sizeof(path), *p, len, str);
1876
		ref = resolve_ref_unsafe(path, hash, 1, NULL);
1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898
		if (!ref)
			continue;
		if (!stat(git_path("logs/%s", path), &st) &&
		    S_ISREG(st.st_mode))
			it = path;
		else if (strcmp(ref, path) &&
			 !stat(git_path("logs/%s", ref), &st) &&
			 S_ISREG(st.st_mode))
			it = ref;
		else
			continue;
		if (!logs_found++) {
			*log = xstrdup(it);
			hashcpy(sha1, hash);
		}
		if (!warn_ambiguous_refs)
			break;
	}
	free(last_branch);
	return logs_found;
}

1899 1900 1901
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
					    int flags, int *type_p)
1902
{
1903
	char *ref_file;
1904
	const char *orig_refname = refname;
1905
	struct ref_lock *lock;
1906
	int last_errno = 0;
1907
	int type, lflags;
1908
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1909
	int missing = 0;
1910 1911 1912 1913

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

J
Junio C Hamano 已提交
1914
	refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1915
	if (!refname && errno == EISDIR) {
1916 1917 1918 1919 1920
		/* 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.
		 */
1921
		ref_file = git_path("%s", orig_refname);
1922 1923
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
1924
			error("there are still refs under '%s'", orig_refname);
1925 1926
			goto error_return;
		}
J
Junio C Hamano 已提交
1927
		refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1928
	}
1929 1930
	if (type_p)
	    *type_p = type;
1931
	if (!refname) {
1932
		last_errno = errno;
1933
		error("unable to resolve reference %s: %s",
1934
			orig_refname, strerror(errno));
1935
		goto error_return;
1936
	}
1937
	missing = is_null_sha1(lock->old_sha1);
1938 1939 1940 1941 1942
	/* When the ref did not exist and we are creating it,
	 * make sure there is no existing ref that is packed
	 * whose name begins with our refname, nor a ref whose
	 * name is a proper prefix of our refname.
	 */
1943
	if (missing &&
1944
	     !is_refname_available(refname, NULL, get_packed_refs(&ref_cache))) {
1945
		last_errno = ENOTDIR;
1946
		goto error_return;
1947
	}
1948

1949
	lock->lk = xcalloc(1, sizeof(struct lock_file));
1950

1951 1952
	lflags = LOCK_DIE_ON_ERROR;
	if (flags & REF_NODEREF) {
1953
		refname = orig_refname;
1954 1955
		lflags |= LOCK_NODEREF;
	}
1956 1957 1958
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
1959
	if (missing)
1960 1961 1962
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
1963

1964 1965 1966 1967 1968
	if (safe_create_leading_directories(ref_file)) {
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
1969

1970
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1971
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1972 1973 1974 1975 1976

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
1977 1978
}

1979
struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
D
Daniel Barkalow 已提交
1980
{
P
Petr Baudis 已提交
1981
	char refpath[PATH_MAX];
1982
	if (check_refname_format(refname, 0))
1983
		return NULL;
1984
	strcpy(refpath, mkpath("refs/%s", refname));
1985
	return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1986 1987
}

1988 1989
struct ref_lock *lock_any_ref_for_update(const char *refname,
					 const unsigned char *old_sha1, int flags)
1990
{
1991
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1992
		return NULL;
1993
	return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
J
Junio C Hamano 已提交
1994 1995
}

1996 1997 1998 1999 2000 2001
/*
 * 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.
 */
static void write_packed_entry(int fd, char *refname, unsigned char *sha1,
			       unsigned char *peeled)
2002 2003 2004 2005 2006 2007 2008 2009 2010
{
	char line[PATH_MAX + 100];
	int len;

	len = snprintf(line, sizeof(line), "%s %s\n",
		       sha1_to_hex(sha1), refname);
	/* this should not happen but just being defensive */
	if (len > sizeof(line))
		die("too long a refname '%s'", refname);
2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
	write_or_die(fd, line, len);

	if (peeled) {
		if (snprintf(line, sizeof(line), "^%s\n",
			     sha1_to_hex(peeled)) != PEELED_LINE_LENGTH)
			die("internal error");
		write_or_die(fd, line, PEELED_LINE_LENGTH);
	}
}

2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037
/*
 * 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)
{
	int *fd = 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);
	write_packed_entry(*fd, entry->name, entry->u.value.sha1,
			   peel_status == PEEL_PEELED ?
			   entry->u.value.peeled : NULL);
	return 0;
}

2038 2039 2040 2041 2042 2043 2044 2045
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;
2046
	struct ref_dir *packed_refs;
2047 2048 2049
	struct ref_to_prune *ref_to_prune;
};

2050 2051 2052 2053 2054 2055 2056
/*
 * 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)
2057 2058
{
	struct pack_refs_cb_data *cb = cb_data;
2059
	enum peel_status peel_status;
2060
	struct ref_entry *packed_entry;
2061
	int is_tag_ref = !prefixcmp(entry->name, "refs/tags/");
2062

2063 2064
	/* ALWAYS pack tags */
	if (!(cb->flags & PACK_REFS_ALL) && !is_tag_ref)
2065 2066
		return 0;

2067 2068 2069 2070
	/* Do not pack symbolic or broken refs: */
	if ((entry->flag & REF_ISSYMREF) || !ref_resolves_to_object(entry))
		return 0;

2071
	/* Add a packed ref cache entry equivalent to the loose entry. */
2072
	peel_status = peel_entry(entry, 1);
2073
	if (peel_status != PEEL_PEELED && peel_status != PEEL_NON_TAG)
2074 2075
		die("internal error peeling reference %s (%s)",
		    entry->name, sha1_to_hex(entry->u.value.sha1));
2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086
	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);
2087

2088 2089
	/* Schedule the loose reference for pruning if requested. */
	if ((cb->flags & PACK_REFS_PRUNE)) {
2090
		int namelen = strlen(entry->name) + 1;
2091
		struct ref_to_prune *n = xcalloc(1, sizeof(*n) + namelen);
2092 2093
		hashcpy(n->sha1, entry->u.value.sha1);
		strcpy(n->name, entry->name);
2094 2095 2096
		n->next = cb->ref_to_prune;
		cb->ref_to_prune = n;
	}
2097 2098 2099
	return 0;
}

2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150
/*
 * 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)
{
	struct ref_lock *lock = lock_ref_sha1(r->name + 5, r->sha1);

	if (lock) {
		unlink_or_warn(git_path("%s", r->name));
		unlock_ref(lock);
		try_remove_empty_parents(r->name);
	}
}

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

2151 2152
static struct lock_file packlock;

2153 2154 2155
int pack_refs(unsigned int flags)
{
	struct pack_refs_cb_data cbdata;
2156
	int fd;
2157 2158 2159 2160

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

2161 2162 2163 2164 2165 2166
	fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"),
				       LOCK_DIE_ON_ERROR);
	cbdata.packed_refs = get_packed_refs(&ref_cache);

	do_for_each_entry_in_dir(get_loose_refs(&ref_cache), 0,
				 pack_if_possible_fn, &cbdata);
2167

2168 2169
	write_or_die(fd, PACKED_REFS_HEADER, strlen(PACKED_REFS_HEADER));
	do_for_each_entry_in_dir(cbdata.packed_refs, 0, write_packed_entry_fn, &fd);
2170

2171
	if (commit_lock_file(&packlock) < 0)
2172 2173 2174 2175 2176
		die_errno("unable to overwrite old ref-pack file");
	prune_refs(cbdata.ref_to_prune);
	return 0;
}

2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188
/*
 * 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 已提交
2189
{
2190
	struct string_list *refs_to_delete = cb_data;
2191

2192 2193 2194
	if (entry->flag & REF_ISBROKEN) {
		/* This shouldn't happen to packed refs. */
		error("%s is broken!", entry->name);
2195
		string_list_append(refs_to_delete, entry->name);
J
Junio C Hamano 已提交
2196
		return 0;
2197 2198 2199 2200 2201 2202 2203 2204
	}
	if (!has_sha1_file(entry->u.value.sha1)) {
		unsigned char sha1[20];
		int flags;

		if (read_ref_full(entry->name, sha1, 0, &flags))
			/* We should at least have found the packed ref. */
			die("Internal error");
2205
		if ((flags & REF_ISSYMREF) || !(flags & REF_ISPACKED)) {
2206 2207 2208 2209 2210 2211 2212 2213
			/*
			 * 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
2214
			 * remove the packed reference.
2215
			 */
2216
			string_list_append(refs_to_delete, entry->name);
2217
			return 0;
2218
		}
2219 2220 2221 2222 2223 2224 2225 2226
		/*
		 * 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);
2227
		string_list_append(refs_to_delete, entry->name);
2228 2229 2230
		return 0;
	}

2231 2232 2233
	return 0;
}

J
Junio C Hamano 已提交
2234 2235
static int repack_without_ref(const char *refname)
{
2236
	int fd;
2237
	struct ref_dir *packed;
2238 2239
	struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
	struct string_list_item *ref_to_delete;
2240 2241 2242 2243

	if (!get_packed_ref(refname))
		return 0; /* refname does not exist in packed refs */

2244 2245
	fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
	if (fd < 0) {
2246
		unable_to_lock_error(git_path("packed-refs"), errno);
J
Junio C Hamano 已提交
2247
		return error("cannot delete '%s' from packed refs", refname);
2248
	}
2249 2250
	clear_packed_ref_cache(&ref_cache);
	packed = get_packed_refs(&ref_cache);
2251 2252

	/* Remove refname from the cache: */
2253 2254 2255 2256 2257 2258 2259 2260
	if (remove_entry(packed, refname) == -1) {
		/*
		 * The packed entry disappeared while we were
		 * acquiring the lock.
		 */
		rollback_lock_file(&packlock);
		return 0;
	}
2261 2262 2263 2264 2265 2266 2267 2268 2269

	/* Remove any other accumulated cruft: */
	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");
	}

	/* Write what remains: */
2270
	write_or_die(fd, PACKED_REFS_HEADER, strlen(PACKED_REFS_HEADER));
2271
	do_for_each_entry_in_dir(packed, 0, write_packed_entry_fn, &fd);
J
Junio C Hamano 已提交
2272 2273 2274
	return commit_lock_file(&packlock);
}

M
Miklos Vajna 已提交
2275
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
2276 2277
{
	struct ref_lock *lock;
M
Miklos Vajna 已提交
2278
	int err, i = 0, ret = 0, flag = 0;
J
Junio C Hamano 已提交
2279

2280
	lock = lock_ref_sha1_basic(refname, sha1, delopt, &flag);
J
Junio C Hamano 已提交
2281 2282
	if (!lock)
		return 1;
2283
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
J
Junio C Hamano 已提交
2284
		/* loose */
2285 2286 2287
		i = strlen(lock->lk->filename) - 5; /* .lock */
		lock->lk->filename[i] = 0;
		err = unlink_or_warn(lock->lk->filename);
2288
		if (err && errno != ENOENT)
J
Junio C Hamano 已提交
2289
			ret = 1;
2290

2291
		lock->lk->filename[i] = '.';
J
Junio C Hamano 已提交
2292 2293 2294 2295 2296
	}
	/* removing the loose one could have resurrected an earlier
	 * packed one.  Also, if it was not loose we need to repack
	 * without it.
	 */
2297
	ret |= repack_without_ref(lock->ref_name);
J
Junio C Hamano 已提交
2298

2299
	unlink_or_warn(git_path("logs/%s", lock->ref_name));
2300
	clear_loose_ref_cache(&ref_cache);
J
Junio C Hamano 已提交
2301 2302
	unlock_ref(lock);
	return ret;
2303 2304
}

2305 2306 2307 2308 2309 2310 2311 2312 2313
/*
 * 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"

2314
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
2315 2316 2317 2318 2319
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
2320
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
2321
	const char *symref = NULL;
2322

2323
	if (log && S_ISLNK(loginfo.st_mode))
2324
		return error("reflog for %s is a symlink", oldrefname);
2325

J
Junio C Hamano 已提交
2326
	symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
M
Miklos Vajna 已提交
2327
	if (flag & REF_ISSYMREF)
2328
		return error("refname %s is a symbolic ref, renaming it is not supported",
2329
			oldrefname);
M
Miklos Vajna 已提交
2330
	if (!symref)
2331
		return error("refname %s not found", oldrefname);
2332

2333
	if (!is_refname_available(newrefname, oldrefname, get_packed_refs(&ref_cache)))
2334 2335
		return 1;

2336
	if (!is_refname_available(newrefname, oldrefname, get_loose_refs(&ref_cache)))
2337 2338
		return 1;

2339
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
2340
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
2341
			oldrefname, strerror(errno));
2342

2343 2344
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
2345 2346 2347
		goto rollback;
	}

2348 2349
	if (!read_ref_full(newrefname, sha1, 1, &flag) &&
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
2350
		if (errno==EISDIR) {
2351 2352
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
2353 2354 2355
				goto rollback;
			}
		} else {
2356
			error("unable to delete existing %s", newrefname);
2357 2358 2359 2360
			goto rollback;
		}
	}

2361 2362
	if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
		error("unable to create directory for %s", newrefname);
2363 2364 2365 2366
		goto rollback;
	}

 retry:
2367
	if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
2368 2369 2370 2371 2372 2373
		if (errno==EISDIR || errno==ENOTDIR) {
			/*
			 * rename(a, b) when b is an existing
			 * directory ought to result in ISDIR, but
			 * Solaris 5.8 gives ENOTDIR.  Sheesh.
			 */
2374 2375
			if (remove_empty_directories(git_path("logs/%s", newrefname))) {
				error("Directory not empty: logs/%s", newrefname);
2376 2377 2378 2379
				goto rollback;
			}
			goto retry;
		} else {
2380
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
2381
				newrefname, strerror(errno));
2382 2383 2384 2385 2386
			goto rollback;
		}
	}
	logmoved = log;

2387
	lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
2388
	if (!lock) {
2389
		error("unable to lock %s for update", newrefname);
2390 2391 2392 2393
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
2394
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
2395
		error("unable to write current sha1 into %s", newrefname);
2396 2397 2398 2399 2400 2401
		goto rollback;
	}

	return 0;

 rollback:
2402
	lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
2403
	if (!lock) {
2404
		error("unable to lock %s for rollback", oldrefname);
2405 2406 2407 2408 2409 2410 2411
		goto rollbacklog;
	}

	lock->force_write = 1;
	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
	if (write_ref_sha1(lock, orig_sha1, NULL))
2412
		error("unable to write current sha1 into %s", oldrefname);
2413 2414 2415
	log_all_ref_updates = flag;

 rollbacklog:
2416
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
2417
		error("unable to restore logfile %s from %s: %s",
2418
			oldrefname, newrefname, strerror(errno));
2419
	if (!logmoved && log &&
2420
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
2421
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
2422
			oldrefname, strerror(errno));
2423 2424 2425 2426

	return 1;
}

2427
int close_ref(struct ref_lock *lock)
2428 2429 2430 2431 2432 2433 2434
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

2435
int commit_ref(struct ref_lock *lock)
2436 2437 2438 2439 2440 2441 2442
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
2443
void unlock_ref(struct ref_lock *lock)
2444
{
B
Brandon Casey 已提交
2445 2446 2447
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
2448
	free(lock->ref_name);
2449
	free(lock->orig_ref_name);
2450 2451 2452
	free(lock);
}

2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478
/*
 * 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;
}

2479
int log_ref_setup(const char *refname, char *logfile, int bufsize)
2480
{
2481
	int logfd, oflags = O_APPEND | O_WRONLY;
2482

2483
	git_snpath(logfile, bufsize, "logs/%s", refname);
2484
	if (log_all_ref_updates &&
2485 2486 2487 2488
	    (!prefixcmp(refname, "refs/heads/") ||
	     !prefixcmp(refname, "refs/remotes/") ||
	     !prefixcmp(refname, "refs/notes/") ||
	     !strcmp(refname, "HEAD"))) {
2489
		if (safe_create_leading_directories(logfile) < 0)
2490
			return error("unable to create directory for %s",
2491
				     logfile);
2492 2493 2494
		oflags |= O_CREAT;
	}

2495
	logfd = open(logfile, oflags, 0666);
2496
	if (logfd < 0) {
J
Junio C Hamano 已提交
2497
		if (!(oflags & O_CREAT) && errno == ENOENT)
2498
			return 0;
2499 2500

		if ((oflags & O_CREAT) && errno == EISDIR) {
2501
			if (remove_empty_directories(logfile)) {
2502
				return error("There are still logs under '%s'",
2503
					     logfile);
2504
			}
2505
			logfd = open(logfile, oflags, 0666);
2506 2507 2508 2509
		}

		if (logfd < 0)
			return error("Unable to append to %s: %s",
2510
				     logfile, strerror(errno));
2511 2512
	}

2513
	adjust_shared_perm(logfile);
2514 2515 2516
	close(logfd);
	return 0;
}
2517

2518
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
2519 2520 2521 2522 2523
			 const unsigned char *new_sha1, const char *msg)
{
	int logfd, result, written, oflags = O_APPEND | O_WRONLY;
	unsigned maxlen, len;
	int msglen;
2524
	char log_file[PATH_MAX];
2525 2526 2527 2528 2529 2530
	char *logrec;
	const char *committer;

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

2531
	result = log_ref_setup(refname, log_file, sizeof(log_file));
2532 2533 2534 2535 2536 2537
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
2538
	msglen = msg ? strlen(msg) : 0;
2539
	committer = git_committer_info(0);
2540 2541 2542
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
2543 2544
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
2545 2546
		      committer);
	if (msglen)
2547
		len += copy_msg(logrec + len - 1, msg) - 1;
2548
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2549
	free(logrec);
2550
	if (close(logfd) != 0 || written != len)
2551
		return error("Unable to append to %s", log_file);
2552 2553 2554
	return 0;
}

2555 2556 2557 2558 2559
static int is_branch(const char *refname)
{
	return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
}

2560 2561 2562 2563
int write_ref_sha1(struct ref_lock *lock,
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
2564
	struct object *o;
2565 2566

	if (!lock)
D
Daniel Barkalow 已提交
2567
		return -1;
2568
	if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2569 2570
		unlock_ref(lock);
		return 0;
D
Daniel Barkalow 已提交
2571
	}
2572 2573
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
2574
		error("Trying to write ref %s with nonexistent object %s",
2575 2576 2577 2578 2579 2580 2581 2582 2583 2584
			lock->ref_name, sha1_to_hex(sha1));
		unlock_ref(lock);
		return -1;
	}
	if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
		error("Trying to write non-commit object %s to branch %s",
			sha1_to_hex(sha1), lock->ref_name);
		unlock_ref(lock);
		return -1;
	}
2585 2586
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
	    write_in_full(lock->lock_fd, &term, 1) != 1
2587
		|| close_ref(lock) < 0) {
2588
		error("Couldn't write %s", lock->lk->filename);
2589 2590 2591
		unlock_ref(lock);
		return -1;
	}
2592
	clear_loose_ref_cache(&ref_cache);
N
Nicolas Pitre 已提交
2593 2594 2595
	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)) {
2596 2597 2598
		unlock_ref(lock);
		return -1;
	}
2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614
	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;
2615
		head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
2616 2617 2618 2619
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
2620
	if (commit_ref(lock)) {
2621
		error("Couldn't set %s", lock->ref_name);
2622 2623 2624 2625 2626
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
2627
}
2628

2629 2630
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
2631 2632 2633 2634
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
2635
	char *git_HEAD = git_pathdup("%s", ref_target);
2636 2637 2638 2639
	unsigned char old_sha1[20], new_sha1[20];

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

2641 2642 2643
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

2644 2645 2646 2647
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
2648
			goto done;
2649 2650 2651 2652 2653 2654 2655
		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);
2656
		goto error_free_return;
2657 2658 2659 2660 2661
	}
	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);
2662
		goto error_free_return;
2663 2664
	}
	written = write_in_full(fd, ref, len);
2665
	if (close(fd) != 0 || written != len) {
2666
		error("Unable to write to %s", lockpath);
2667
		goto error_unlink_return;
2668 2669 2670
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
2671
		goto error_unlink_return;
2672 2673 2674
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
2675
	error_unlink_return:
2676
		unlink_or_warn(lockpath);
2677 2678 2679
	error_free_return:
		free(git_HEAD);
		return -1;
2680
	}
2681

2682
#ifndef NO_SYMLINK_HEAD
2683
	done:
2684
#endif
2685 2686 2687
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

2688
	free(git_HEAD);
2689 2690 2691
	return 0;
}

2692 2693 2694 2695
static char *ref_msg(const char *line, const char *endp)
{
	const char *ep;
	line += 82;
P
Pierre Habouzit 已提交
2696 2697 2698 2699
	ep = memchr(line, '\n', endp - line);
	if (!ep)
		ep = endp;
	return xmemdupz(line, ep - line);
2700 2701
}

2702 2703 2704
int read_ref_at(const char *refname, unsigned long at_time, int cnt,
		unsigned char *sha1, char **msg,
		unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
2705
{
2706
	const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2707
	char *tz_c;
J
Junio C Hamano 已提交
2708
	int logfd, tz, reccnt = 0;
2709 2710
	struct stat st;
	unsigned long date;
2711
	unsigned char logged_sha1[20];
2712
	void *log_mapped;
2713
	size_t mapsz;
2714

2715
	logfile = git_path("logs/%s", refname);
2716 2717
	logfd = open(logfile, O_RDONLY, 0);
	if (logfd < 0)
2718
		die_errno("Unable to read log '%s'", logfile);
2719 2720 2721
	fstat(logfd, &st);
	if (!st.st_size)
		die("Log %s is empty.", logfile);
2722 2723
	mapsz = xsize_t(st.st_size);
	log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2724
	logdata = log_mapped;
2725 2726
	close(logfd);

2727
	lastrec = NULL;
2728 2729
	rec = logend = logdata + st.st_size;
	while (logdata < rec) {
J
Junio C Hamano 已提交
2730
		reccnt++;
2731 2732
		if (logdata < rec && *(rec-1) == '\n')
			rec--;
2733 2734
		lastgt = NULL;
		while (logdata < rec && *(rec-1) != '\n') {
2735
			rec--;
2736 2737 2738 2739
			if (*rec == '>')
				lastgt = rec;
		}
		if (!lastgt)
2740
			die("Log %s is corrupt.", logfile);
2741
		date = strtoul(lastgt + 1, &tz_c, 10);
2742
		if (date <= at_time || cnt == 0) {
2743
			tz = strtoul(tz_c, NULL, 10);
2744 2745 2746 2747 2748 2749 2750
			if (msg)
				*msg = ref_msg(rec, logend);
			if (cutoff_time)
				*cutoff_time = date;
			if (cutoff_tz)
				*cutoff_tz = tz;
			if (cutoff_cnt)
2751
				*cutoff_cnt = reccnt - 1;
2752 2753 2754 2755 2756
			if (lastrec) {
				if (get_sha1_hex(lastrec, logged_sha1))
					die("Log %s is corrupt.", logfile);
				if (get_sha1_hex(rec + 41, sha1))
					die("Log %s is corrupt.", logfile);
2757
				if (hashcmp(logged_sha1, sha1)) {
2758
					warning("Log %s has gap after %s.",
2759
						logfile, show_date(date, tz, DATE_RFC2822));
2760
				}
J
Junio C Hamano 已提交
2761 2762
			}
			else if (date == at_time) {
2763 2764
				if (get_sha1_hex(rec + 41, sha1))
					die("Log %s is corrupt.", logfile);
J
Junio C Hamano 已提交
2765 2766
			}
			else {
2767 2768
				if (get_sha1_hex(rec + 41, logged_sha1))
					die("Log %s is corrupt.", logfile);
2769
				if (hashcmp(logged_sha1, sha1)) {
2770
					warning("Log %s unexpectedly ended on %s.",
2771
						logfile, show_date(date, tz, DATE_RFC2822));
2772 2773
				}
			}
2774
			munmap(log_mapped, mapsz);
2775 2776
			return 0;
		}
2777
		lastrec = rec;
2778 2779
		if (cnt > 0)
			cnt--;
2780 2781
	}

2782 2783 2784 2785
	rec = logdata;
	while (rec < logend && *rec != '>' && *rec != '\n')
		rec++;
	if (rec == logend || *rec == '\n')
2786
		die("Log %s is corrupt.", logfile);
2787
	date = strtoul(rec + 1, &tz_c, 10);
2788 2789 2790
	tz = strtoul(tz_c, NULL, 10);
	if (get_sha1_hex(logdata, sha1))
		die("Log %s is corrupt.", logfile);
J
Jeff King 已提交
2791 2792 2793 2794
	if (is_null_sha1(sha1)) {
		if (get_sha1_hex(logdata + 41, sha1))
			die("Log %s is corrupt.", logfile);
	}
2795 2796
	if (msg)
		*msg = ref_msg(logdata, logend);
2797
	munmap(log_mapped, mapsz);
2798 2799 2800 2801 2802 2803 2804 2805

	if (cutoff_time)
		*cutoff_time = date;
	if (cutoff_tz)
		*cutoff_tz = tz;
	if (cutoff_cnt)
		*cutoff_cnt = reccnt;
	return 1;
2806
}
2807

2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835
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);
}

2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847
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)
2848
{
2849
	struct strbuf sb = STRBUF_INIT;
2850 2851 2852
	FILE *logfp;
	long pos;
	int ret = 0, at_tail = 1;
2853

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

2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
	/* 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 已提交
2875
		if (nread != 1)
2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912
			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);

			if (*bp != '\n') {
				strbuf_splice(&sb, 0, 0, buf, endp - buf);
				if (pos)
					break; /* need to fill another block */
				scanp = buf - 1; /* leave loop */
			} else {
				/*
				 * (bp + 1) thru endp is the beginning of the
				 * current line we have in sb
				 */
				strbuf_splice(&sb, 0, 0, bp + 1, endp - (bp + 1));
				scanp = bp;
				endp = bp + 1;
			}
			ret = show_one_reflog_ent(&sb, fn, cb_data);
			strbuf_reset(&sb);
			if (ret)
				break;
2913
		}
2914

2915
	}
2916
	if (!ret && sb.len)
2917
		ret = show_one_reflog_ent(&sb, fn, cb_data);
2918

2919
	fclose(logfp);
2920
	strbuf_release(&sb);
2921
	return ret;
2922
}
J
Junio C Hamano 已提交
2923

2924
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2925
{
2926 2927 2928 2929 2930 2931 2932
	FILE *logfp;
	struct strbuf sb = STRBUF_INIT;
	int ret = 0;

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

2934 2935 2936 2937 2938 2939
	while (!ret && !strbuf_getwholeline(&sb, logfp, '\n'))
		ret = show_one_reflog_ent(&sb, fn, cb_data);
	fclose(logfp);
	strbuf_release(&sb);
	return ret;
}
2940 2941 2942 2943 2944 2945
/*
 * 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)
2946
{
2947
	DIR *d = opendir(git_path("logs/%s", name->buf));
2948
	int retval = 0;
2949
	struct dirent *de;
2950
	int oldlen = name->len;
2951

2952
	if (!d)
2953
		return name->len ? errno : 0;
2954

2955 2956
	while ((de = readdir(d)) != NULL) {
		struct stat st;
2957

2958 2959 2960 2961
		if (de->d_name[0] == '.')
			continue;
		if (has_extension(de->d_name, ".lock"))
			continue;
2962 2963 2964
		strbuf_addstr(name, de->d_name);
		if (stat(git_path("logs/%s", name->buf), &st) < 0) {
			; /* silently ignore */
2965
		} else {
2966
			if (S_ISDIR(st.st_mode)) {
2967 2968
				strbuf_addch(name, '/');
				retval = do_for_each_reflog(name, fn, cb_data);
2969 2970
			} else {
				unsigned char sha1[20];
2971 2972
				if (read_ref_full(name->buf, sha1, 0, NULL))
					retval = error("bad ref for %s", name->buf);
2973
				else
2974
					retval = fn(name->buf, sha1, 0, cb_data);
2975 2976 2977 2978
			}
			if (retval)
				break;
		}
2979
		strbuf_setlen(name, oldlen);
2980
	}
2981
	closedir(d);
2982 2983 2984 2985 2986
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
2987 2988 2989 2990 2991 2992
	int retval;
	struct strbuf name;
	strbuf_init(&name, PATH_MAX);
	retval = do_for_each_reflog(&name, fn, cb_data);
	strbuf_release(&name);
	return retval;
2993
}
C
Carlos Rica 已提交
2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020

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

3022
struct ref *find_ref_by_name(const struct ref *list, const char *name)
3023 3024 3025
{
	for ( ; list; list = list->next)
		if (!strcmp(list->name, name))
3026
			return (struct ref *)list;
3027 3028
	return NULL;
}
J
Jeff King 已提交
3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052

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

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

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

	return;
}

3053
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081
{
	int i;
	static char **scanf_fmts;
	static int nr_rules;
	char *short_name;

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

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

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

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

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

3084 3085
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
3086 3087 3088 3089

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

3093
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
3094 3095 3096 3097
			continue;

		short_name_len = strlen(short_name);

3098 3099 3100 3101 3102 3103 3104
		/*
		 * 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 已提交
3105 3106 3107 3108
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
3109
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
3110 3111 3112
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

3113 3114 3115 3116
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
3117 3118 3119 3120 3121 3122 3123
			/*
			 * 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);
3124
			if (ref_exists(refname))
J
Jeff King 已提交
3125 3126 3127 3128 3129 3130 3131
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
3132
		if (j == rules_to_fail)
J
Jeff King 已提交
3133 3134 3135 3136
			return short_name;
	}

	free(short_name);
3137
	return xstrdup(refname);
J
Jeff King 已提交
3138
}
3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181

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 */
	    (!prefixcmp(var, section) && var[strlen(section)] == '.' &&
	     !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;
		if (prefixcmp(refname, item->string))
			continue;
		len = strlen(item->string);
		if (!refname[len] || refname[len] == '/')
			return 1;
	}
	return 0;
}