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

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

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

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

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

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

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

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

struct ref_entry;
103

104 105 106 107 108
struct ref_value {
	unsigned char sha1[20];
	unsigned char peeled[20];
};

109
struct ref_dir {
110
	int nr, alloc;
111 112 113 114 115 116 117 118 119

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

120
	struct ref_entry **entries;
121 122
};

123 124 125
/* ISSYMREF=0x01, ISPACKED=0x02, and ISBROKEN=0x04 are public interfaces */
#define REF_KNOWS_PEELED 0x08
#define REF_DIR 0x10
126

127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
/*
 * A ref_entry represents either a reference or a "subdirectory" of
 * 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.  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).
 *
 * 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.
 */
160 161
struct ref_entry {
	unsigned char flag; /* ISSYMREF? ISPACKED? */
162
	union {
163 164
		struct ref_value value; /* if not (flags&REF_DIR) */
		struct ref_dir subdir; /* if (flags&REF_DIR) */
165
	} u;
166 167 168 169 170
	/*
	 * 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/"):
	 */
171 172
	char name[FLEX_ARRAY];
};
173

174 175 176
static struct ref_entry *create_ref_entry(const char *refname,
					  const unsigned char *sha1, int flag,
					  int check_name)
177 178
{
	int len;
179
	struct ref_entry *ref;
180

181
	if (check_name &&
182 183
	    check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
		die("Reference has invalid format: '%s'", refname);
184 185
	len = strlen(refname) + 1;
	ref = xmalloc(sizeof(struct ref_entry) + len);
186 187
	hashcpy(ref->u.value.sha1, sha1);
	hashclr(ref->u.value.peeled);
188 189 190 191 192
	memcpy(ref->name, refname, len);
	ref->flag = flag;
	return ref;
}

193 194
static void clear_ref_dir(struct ref_dir *dir);

195 196
static void free_ref_entry(struct ref_entry *entry)
{
197 198
	if (entry->flag & REF_DIR)
		clear_ref_dir(&entry->u.subdir);
199 200 201
	free(entry);
}

202 203 204 205 206 207
/*
 * 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)
208
{
209 210
	ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
	dir->entries[dir->nr++] = entry;
211 212
}

213 214 215
/*
 * Clear and free all entries in dir, recursively.
 */
216
static void clear_ref_dir(struct ref_dir *dir)
217 218
{
	int i;
219 220 221 222 223
	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;
224 225
}

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
/*
 * 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.
 */
static struct ref_entry *create_dir_entry(const char *dirname)
{
	struct ref_entry *direntry;
	int len = strlen(dirname);
	direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
	memcpy(direntry->name, dirname, len + 1);
	direntry->flag = REF_DIR;
	return direntry;
}

241
static int ref_entry_cmp(const void *a, const void *b)
242
{
243 244 245 246
	struct ref_entry *one = *(struct ref_entry **)a;
	struct ref_entry *two = *(struct ref_entry **)b;
	return strcmp(one->name, two->name);
}
247

248
static void sort_ref_dir(struct ref_dir *dir);
249

250 251 252 253 254
/*
 * Return the entry with the given refname from the ref_dir
 * (non-recursively), sorting dir if necessary.  Return NULL if no
 * such entry is found.
 */
255
static struct ref_entry *search_ref_dir(struct ref_dir *dir, const char *refname)
256 257 258 259
{
	struct ref_entry *e, **r;
	int len;

260
	if (refname == NULL || !dir->nr)
261 262
		return NULL;

263
	sort_ref_dir(dir);
264

265 266 267 268
	len = strlen(refname) + 1;
	e = xmalloc(sizeof(struct ref_entry) + len);
	memcpy(e->name, refname, len);

269
	r = bsearch(&e, dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
270 271 272 273 274 275 276 277 278

	free(e);

	if (r == NULL)
		return NULL;

	return *r;
}

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
/*
 * 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
 * directory cannot be found.
 */
static struct ref_entry *search_for_subdir(struct ref_dir *dir,
					   const char *subdirname, int mkdir)
{
	struct ref_entry *entry = search_ref_dir(dir, subdirname);
	if (!entry) {
		if (!mkdir)
			return NULL;
		entry = create_dir_entry(subdirname);
		add_entry_to_dir(dir, entry);
	}
	assert(entry->flag & REF_DIR);
	return entry;
}

300 301 302 303 304 305 306 307 308 309 310 311
/*
 * 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
 * represent the top-level directory.  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.
 */
static struct ref_dir *find_containing_dir(struct ref_dir *dir,
					   const char *refname, int mkdir)
{
312 313 314 315 316 317 318 319 320
	struct strbuf dirname;
	const char *slash;
	strbuf_init(&dirname, PATH_MAX);
	for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
		struct ref_entry *entry;
		strbuf_add(&dirname,
			   refname + dirname.len,
			   (slash + 1) - (refname + dirname.len));
		entry = search_for_subdir(dir, dirname.buf, mkdir);
321 322
		if (!entry)
			break;
323 324 325
		dir = &entry->u.subdir;
	}

326
	strbuf_release(&dirname);
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
	return dir;
}

/*
 * Find the value entry with the given name in dir, sorting ref_dirs
 * and recursing into subdirectories as necessary.  If the name is not
 * found or it corresponds to a directory entry, return NULL.
 */
static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
{
	struct ref_entry *entry;
	dir = find_containing_dir(dir, refname, 0);
	if (!dir)
		return NULL;
	entry = search_ref_dir(dir, refname);
	return (entry && !(entry->flag & REF_DIR)) ? entry : NULL;
}

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

359 360 361 362 363 364 365
/*
 * 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)
{
366
	if (strcmp(ref1->name, ref2->name))
367
		return 0;
368 369 370 371 372 373 374 375 376 377 378 379

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

382
/*
383 384
 * Sort the entries in dir non-recursively (if they are not already
 * sorted) and remove any duplicate entries.
385
 */
386
static void sort_ref_dir(struct ref_dir *dir)
387
{
388
	int i, j;
389
	struct ref_entry *last = NULL;
390

391 392 393 394
	/*
	 * This check also prevents passing a zero-length array to qsort(),
	 * which is a problem on some platforms.
	 */
395
	if (dir->sorted == dir->nr)
396
		return;
397

398
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
399

400 401 402 403 404 405 406
	/* 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;
407
	}
408
	dir->sorted = dir->nr = i;
409
}
410

411
#define DO_FOR_EACH_INCLUDE_BROKEN 01
412

413
static struct ref_entry *current_ref;
414

415 416 417
static int do_one_ref(const char *base, each_ref_fn fn, int trim,
		      int flags, void *cb_data, struct ref_entry *entry)
{
418
	int retval;
419 420
	if (prefixcmp(entry->name, base))
		return 0;
421

422 423 424
	if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
		if (entry->flag & REF_ISBROKEN)
			return 0; /* ignore broken refs e.g. dangling symref */
425
		if (!has_sha1_file(entry->u.value.sha1)) {
426 427 428 429 430
			error("%s does not point to a valid object!", entry->name);
			return 0;
		}
	}
	current_ref = entry;
431
	retval = fn(entry->name + trim, entry->u.value.sha1, entry->flag, cb_data);
432 433
	current_ref = NULL;
	return retval;
434
}
435

436
/*
437
 * Call fn for each reference in dir that has index in the range
438 439 440
 * offset <= index < dir->nr.  Recurse into subdirectories that are in
 * that index range, sorting them before iterating.  This function
 * does not sort dir itself; it should be sorted beforehand.
441
 */
442 443 444
static int do_for_each_ref_in_dir(struct ref_dir *dir, int offset,
				  const char *base,
				  each_ref_fn fn, int trim, int flags, void *cb_data)
445 446
{
	int i;
447 448
	assert(dir->sorted == dir->nr);
	for (i = offset; i < dir->nr; i++) {
449 450 451 452 453 454 455 456 457
		struct ref_entry *entry = dir->entries[i];
		int retval;
		if (entry->flag & REF_DIR) {
			sort_ref_dir(&entry->u.subdir);
			retval = do_for_each_ref_in_dir(&entry->u.subdir, 0,
							base, fn, trim, flags, cb_data);
		} else {
			retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
		}
458 459 460 461 462 463
		if (retval)
			return retval;
	}
	return 0;
}

464
/*
465
 * Call fn for each reference in the union of dir1 and dir2, in order
466 467 468 469
 * by refname.  Recurse into subdirectories.  If a value entry appears
 * in both dir1 and dir2, then only process the version that is in
 * dir2.  The input dirs must already be sorted, but subdirs will be
 * sorted as needed.
470
 */
471 472 473 474
static int do_for_each_ref_in_dirs(struct ref_dir *dir1,
				   struct ref_dir *dir2,
				   const char *base, each_ref_fn fn, int trim,
				   int flags, void *cb_data)
475 476 477 478
{
	int retval;
	int i1 = 0, i2 = 0;

479 480
	assert(dir1->sorted == dir1->nr);
	assert(dir2->sorted == dir2->nr);
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
	while (1) {
		struct ref_entry *e1, *e2;
		int cmp;
		if (i1 == dir1->nr) {
			return do_for_each_ref_in_dir(dir2, i2,
						      base, fn, trim, flags, cb_data);
		}
		if (i2 == dir2->nr) {
			return do_for_each_ref_in_dir(dir1, i1,
						      base, fn, trim, flags, cb_data);
		}
		e1 = dir1->entries[i1];
		e2 = dir2->entries[i2];
		cmp = strcmp(e1->name, e2->name);
		if (cmp == 0) {
			if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
				/* Both are directories; descend them in parallel. */
				sort_ref_dir(&e1->u.subdir);
				sort_ref_dir(&e2->u.subdir);
				retval = do_for_each_ref_in_dirs(
						&e1->u.subdir, &e2->u.subdir,
						base, fn, trim, flags, cb_data);
				i1++;
				i2++;
			} else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
				/* Both are references; ignore the one from dir1. */
				retval = do_one_ref(base, fn, trim, flags, cb_data, e2);
				i1++;
				i2++;
			} else {
				die("conflict between reference and directory: %s",
				    e1->name);
			}
514
		} else {
515 516 517
			struct ref_entry *e;
			if (cmp < 0) {
				e = e1;
518
				i1++;
519 520 521 522 523 524 525 526 527 528 529
			} else {
				e = e2;
				i2++;
			}
			if (e->flag & REF_DIR) {
				sort_ref_dir(&e->u.subdir);
				retval = do_for_each_ref_in_dir(
						&e->u.subdir, 0,
						base, fn, trim, flags, cb_data);
			} else {
				retval = do_one_ref(base, fn, trim, flags, cb_data, e);
530 531 532 533 534
			}
		}
		if (retval)
			return retval;
	}
535 536 537 538 539 540
	if (i1 < dir1->nr)
		return do_for_each_ref_in_dir(dir1, i1,
					      base, fn, trim, flags, cb_data);
	if (i2 < dir2->nr)
		return do_for_each_ref_in_dir(dir2, i2,
					      base, fn, trim, flags, cb_data);
541 542 543
	return 0;
}

544 545 546 547 548 549 550 551 552
/*
 * 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)
{
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
	for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
		;
	return (*refname1 == '\0' && *refname2 == '/')
		|| (*refname1 == '/' && *refname2 == '\0');
}

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

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

578 579
/*
 * Return true iff a reference named refname could be created without
580 581 582
 * conflicting with the name of an existing reference in array.  If
 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
 * (e.g., because oldrefname is scheduled for deletion in the same
583 584 585
 * operation).
 */
static int is_refname_available(const char *refname, const char *oldrefname,
586
				struct ref_dir *dir)
587
{
588 589 590 591 592
	struct name_conflict_cb data;
	data.refname = refname;
	data.oldrefname = oldrefname;
	data.conflicting_refname = NULL;

593 594 595 596
	sort_ref_dir(dir);
	if (do_for_each_ref_in_dir(dir, 0, "", name_conflict_fn,
				   0, DO_FOR_EACH_INCLUDE_BROKEN,
				   &data)) {
597 598 599
		error("'%s' exists; cannot create '%s'",
		      data.conflicting_refname, refname);
		return 0;
600 601
	}
	return 1;
602 603
}

604 605 606 607
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
608 609
static struct ref_cache {
	struct ref_cache *next;
610 611
	char did_loose;
	char did_packed;
612 613
	struct ref_dir loose;
	struct ref_dir packed;
614 615
	/* The submodule name, or "" for the main repo. */
	char name[FLEX_ARRAY];
616
} *ref_cache;
617

618
static void clear_packed_ref_cache(struct ref_cache *refs)
619
{
620
	if (refs->did_packed)
621
		clear_ref_dir(&refs->packed);
622
	refs->did_packed = 0;
623
}
624

625 626 627
static void clear_loose_ref_cache(struct ref_cache *refs)
{
	if (refs->did_loose)
628
		clear_ref_dir(&refs->loose);
629 630 631
	refs->did_loose = 0;
}

632
static struct ref_cache *create_ref_cache(const char *submodule)
633
{
634
	int len;
635
	struct ref_cache *refs;
636 637 638
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
639
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
640
	memcpy(refs->name, submodule, len);
641 642 643
	return refs;
}

644
/*
645
 * Return a pointer to a ref_cache for the specified submodule. For
646 647 648 649
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
650
static struct ref_cache *get_ref_cache(const char *submodule)
651
{
652
	struct ref_cache *refs = ref_cache;
653 654 655 656 657 658
	if (!submodule)
		submodule = "";
	while (refs) {
		if (!strcmp(submodule, refs->name))
			return refs;
		refs = refs->next;
659
	}
660

661 662 663
	refs = create_ref_cache(submodule);
	refs->next = ref_cache;
	ref_cache = refs;
664
	return refs;
665 666
}

667
void invalidate_ref_cache(const char *submodule)
668
{
669 670 671
	struct ref_cache *refs = get_ref_cache(submodule);
	clear_packed_ref_cache(refs);
	clear_loose_ref_cache(refs);
672
}
673

674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
/*
 * 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;
}

707
static void read_packed_refs(FILE *f, struct ref_dir *dir)
708
{
709
	struct ref_entry *last = NULL;
710 711 712 713 714
	char refline[PATH_MAX];
	int flag = REF_ISPACKED;

	while (fgets(refline, sizeof(refline), f)) {
		unsigned char sha1[20];
715
		const char *refname;
716 717 718 719 720 721 722 723 724 725
		static const char header[] = "# pack-refs with:";

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

726 727
		refname = parse_ref_line(refline, sha1);
		if (refname) {
728
			last = create_ref_entry(refname, sha1, flag, 1);
729
			add_ref(dir, last);
730 731 732 733 734 735 736
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
		    strlen(refline) == 42 &&
		    refline[41] == '\n' &&
		    !get_sha1_hex(refline + 1, sha1))
737
			hashcpy(last->u.value.peeled, sha1);
738 739 740
	}
}

741
static struct ref_dir *get_packed_refs(struct ref_cache *refs)
742
{
743 744 745
	if (!refs->did_packed) {
		const char *packed_refs_file;
		FILE *f;
746

747 748
		if (*refs->name)
			packed_refs_file = git_path_submodule(refs->name, "packed-refs");
749 750 751
		else
			packed_refs_file = git_path("packed-refs");
		f = fopen(packed_refs_file, "r");
752
		if (f) {
753
			read_packed_refs(f, &refs->packed);
754 755
			fclose(f);
		}
756
		refs->did_packed = 1;
757
	}
758
	return &refs->packed;
759 760
}

761 762 763 764 765 766
void add_packed_ref(const char *refname, const unsigned char *sha1)
{
	add_ref(get_packed_refs(get_ref_cache(NULL)),
			create_ref_entry(refname, sha1, REF_ISPACKED, 1));
}

767 768
/*
 * Read the loose references for refs from the namespace dirname.
769 770
 * dirname must end with '/'.  dir must be the directory entry
 * corresponding to dirname.
771
 */
772
static void get_ref_dir(struct ref_cache *refs, const char *dirname,
773
			struct ref_dir *dir)
774
{
775
	DIR *d;
776
	const char *path;
777
	struct dirent *de;
778
	int dirnamelen = strlen(dirname);
779
	struct strbuf refname;
780

M
Michael Haggerty 已提交
781
	if (*refs->name)
782
		path = git_path_submodule(refs->name, "%s", dirname);
783
	else
784
		path = git_path("%s", dirname);
785

786
	d = opendir(path);
787 788 789
	if (!d)
		return;

790 791
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
792 793 794 795 796 797 798 799 800 801 802

	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;
803
		strbuf_addstr(&refname, de->d_name);
804
		refdir = *refs->name
805 806 807 808 809
			? 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)) {
810
			strbuf_addch(&refname, '/');
811 812
			get_ref_dir(refs, refname.buf,
				    &search_for_subdir(dir, refname.buf, 1)->u.subdir);
813 814 815 816 817 818 819 820 821
		} else {
			if (*refs->name) {
				hashclr(sha1);
				flag = 0;
				if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
					hashclr(sha1);
					flag |= REF_ISBROKEN;
				}
			} else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
822 823 824
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
825 826
			add_entry_to_dir(dir,
					 create_ref_entry(refname.buf, sha1, flag, 1));
827
		}
828
		strbuf_setlen(&refname, dirnamelen);
829
	}
830
	strbuf_release(&refname);
831
	closedir(d);
832 833
}

834
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
835
{
836
	if (!refs->did_loose) {
837 838
		get_ref_dir(refs, "refs/",
			    &search_for_subdir(&refs->loose, "refs/", 1)->u.subdir);
839
		refs->did_loose = 1;
840
	}
841
	return &refs->loose;
842 843
}

844 845
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
846 847
#define MAXREFLEN (1024)

848 849
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
850 851
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
852
 */
853
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
854
				      const char *refname, unsigned char *sha1)
855
{
856
	struct ref_entry *ref;
857
	struct ref_dir *dir = get_packed_refs(refs);
858

859
	ref = find_ref(dir, refname);
860 861 862
	if (ref == NULL)
		return -1;

863
	memcpy(sha1, ref->u.value.sha1, 20);
864
	return 0;
865 866
}

867
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
868
					 const char *refname, unsigned char *sha1,
869
					 int recursion)
870
{
871
	int fd, len;
872
	char buffer[128], *p;
873
	char *path;
874

875
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
876
		return -1;
877 878 879 880
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
881
	if (fd < 0)
882
		return resolve_gitlink_packed_ref(refs, refname, sha1);
883 884 885 886 887 888 889 890 891 892

	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? */
893
	if (!get_sha1_hex(buffer, sha1))
894 895 896 897 898 899 900 901 902
		return 0;

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

903
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
904 905
}

906
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
907 908
{
	int len = strlen(path), retval;
909
	char *submodule;
910
	struct ref_cache *refs;
911 912 913 914 915

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
916 917 918 919
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

920
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
921 922
	return retval;
}
923

924
/*
925 926
 * Try to read ref from the packed references.  On success, set sha1
 * and return 0; otherwise, return -1.
927
 */
928
static int get_packed_ref(const char *refname, unsigned char *sha1)
929
{
930
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
931
	struct ref_entry *entry = find_ref(packed, refname);
932
	if (entry) {
933
		hashcpy(sha1, entry->u.value.sha1);
934
		return 0;
935 936 937 938
	}
	return -1;
}

J
Junio C Hamano 已提交
939
const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
940
{
941 942
	int depth = MAXDEPTH;
	ssize_t len;
943
	char buffer[256];
944
	static char refname_buffer[256];
945

946 947 948
	if (flag)
		*flag = 0;

949
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
950 951
		return NULL;

952
	for (;;) {
953
		char path[PATH_MAX];
954 955 956
		struct stat st;
		char *buf;
		int fd;
957

958 959
		if (--depth < 0)
			return NULL;
960

961
		git_snpath(path, sizeof(path), "%s", refname);
962

963
		if (lstat(path, &st) < 0) {
964 965 966 967 968 969
			if (errno != ENOENT)
				return NULL;
			/*
			 * The loose reference file does not exist;
			 * check for a packed reference.
			 */
970
			if (!get_packed_ref(refname, sha1)) {
971 972
				if (flag)
					*flag |= REF_ISPACKED;
973
				return refname;
974
			}
975 976
			/* The reference is not a packed reference, either. */
			if (reading) {
977
				return NULL;
978 979
			} else {
				hashclr(sha1);
980
				return refname;
981
			}
982
		}
983

984 985 986
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
987 988
			if (len < 0)
				return NULL;
M
Michael Haggerty 已提交
989
			buffer[len] = 0;
990 991
			if (!prefixcmp(buffer, "refs/") &&
					!check_refname_format(buffer, 0)) {
992 993
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
994 995
				if (flag)
					*flag |= REF_ISSYMREF;
996 997
				continue;
			}
998
		}
999

1000 1001 1002 1003 1004 1005
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

1006 1007 1008 1009 1010 1011 1012
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
		if (fd < 0)
			return NULL;
1013
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
1014
		close(fd);
1015 1016 1017 1018 1019
		if (len < 0)
			return NULL;
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1020 1021 1022 1023

		/*
		 * Is it a symbolic ref?
		 */
1024
		if (prefixcmp(buffer, "ref:"))
1025
			break;
1026 1027
		if (flag)
			*flag |= REF_ISSYMREF;
1028
		buf = buffer + 4;
1029 1030
		while (isspace(*buf))
			buf++;
1031
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1032 1033
			if (flag)
				*flag |= REF_ISBROKEN;
1034 1035
			return NULL;
		}
1036
		refname = strcpy(refname_buffer, buf);
1037
	}
1038 1039
	/* Please note that FETCH_HEAD has a second line containing other data. */
	if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1040 1041
		if (flag)
			*flag |= REF_ISBROKEN;
1042
		return NULL;
1043
	}
1044
	return refname;
1045 1046
}

1047 1048
char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
{
1049
	const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1050 1051 1052
	return ret ? xstrdup(ret) : NULL;
}

I
Ilari Liusvaara 已提交
1053 1054 1055 1056 1057 1058 1059
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1060
int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1061
{
J
Junio C Hamano 已提交
1062
	if (resolve_ref_unsafe(refname, sha1, reading, flags))
1063 1064
		return 0;
	return -1;
1065 1066
}

1067
int read_ref(const char *refname, unsigned char *sha1)
1068
{
1069
	return read_ref_full(refname, sha1, 1, NULL);
1070 1071
}

1072
int ref_exists(const char *refname)
1073
{
1074 1075
	unsigned char sha1[20];
	return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1076 1077
}

1078
static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1079
		       void *data)
I
Ilari Liusvaara 已提交
1080 1081
{
	struct ref_filter *filter = (struct ref_filter *)data;
1082
	if (fnmatch(filter->pattern, refname, 0))
I
Ilari Liusvaara 已提交
1083
		return 0;
1084
	return filter->fn(refname, sha1, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1085 1086
}

1087
int peel_ref(const char *refname, unsigned char *sha1)
1088 1089 1090 1091 1092
{
	int flag;
	unsigned char base[20];
	struct object *o;

1093 1094
	if (current_ref && (current_ref->name == refname
		|| !strcmp(current_ref->name, refname))) {
1095
		if (current_ref->flag & REF_KNOWS_PEELED) {
1096
			hashcpy(sha1, current_ref->u.value.peeled);
1097 1098
			return 0;
		}
1099
		hashcpy(base, current_ref->u.value.sha1);
1100 1101 1102
		goto fallback;
	}

1103
	if (read_ref_full(refname, base, 1, &flag))
1104 1105 1106
		return -1;

	if ((flag & REF_ISPACKED)) {
1107
		struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
1108
		struct ref_entry *r = find_ref(dir, refname);
1109

1110
		if (r != NULL && r->flag & REF_KNOWS_PEELED) {
1111
			hashcpy(sha1, r->u.value.peeled);
1112
			return 0;
1113 1114 1115
		}
	}

1116
fallback:
1117
	o = parse_object(base);
1118
	if (o && o->type == OBJ_TAG) {
1119
		o = deref_tag(o, refname, 0);
1120 1121 1122 1123 1124 1125 1126 1127
		if (o) {
			hashcpy(sha1, o->sha1);
			return 0;
		}
	}
	return -1;
}

1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
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);
	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);
}

1162 1163
static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
			   int trim, int flags, void *cb_data)
1164
{
1165
	struct ref_cache *refs = get_ref_cache(submodule);
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
	struct ref_dir *packed_dir = get_packed_refs(refs);
	struct ref_dir *loose_dir = get_loose_refs(refs);
	int retval = 0;

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

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

	return retval;
1194 1195
}

1196
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1197 1198
{
	unsigned char sha1[20];
1199 1200
	int flag;

1201 1202 1203 1204 1205 1206 1207
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

1208
	if (!read_ref_full("HEAD", sha1, 1, &flag))
1209
		return fn("HEAD", sha1, flag, cb_data);
1210

1211
	return 0;
1212 1213
}

1214 1215 1216 1217 1218
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

1219 1220 1221 1222 1223
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

1224
int for_each_ref(each_ref_fn fn, void *cb_data)
1225
{
1226
	return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1227 1228
}

1229 1230
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
1231
	return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1232 1233
}

1234 1235
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
1236
	return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1237 1238
}

1239 1240 1241 1242
int for_each_ref_in_submodule(const char *submodule, const char *prefix,
		each_ref_fn fn, void *cb_data)
{
	return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
1243 1244
}

1245
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1246
{
1247
	return for_each_ref_in("refs/tags/", fn, cb_data);
1248 1249
}

1250 1251 1252 1253 1254
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);
}

1255
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1256
{
1257
	return for_each_ref_in("refs/heads/", fn, cb_data);
1258 1259
}

1260 1261 1262 1263 1264
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);
}

1265
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1266
{
1267
	return for_each_ref_in("refs/remotes/", fn, cb_data);
1268 1269
}

1270 1271 1272 1273 1274
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);
}

1275 1276
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
1277
	return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
1278 1279
}

J
Josh Triplett 已提交
1280 1281 1282 1283 1284 1285 1286 1287
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());
1288
	if (!read_ref_full(buf.buf, sha1, 1, &flag))
J
Josh Triplett 已提交
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304
		ret = fn(buf.buf, sha1, flag, cb_data);
	strbuf_release(&buf);

	return ret;
}

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

1305 1306
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
1307 1308 1309 1310 1311
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

1312
	if (!prefix && prefixcmp(pattern, "refs/"))
I
Ilari Liusvaara 已提交
1313
		strbuf_addstr(&real_pattern, "refs/");
1314 1315
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
1316 1317
	strbuf_addstr(&real_pattern, pattern);

1318
	if (!has_glob_specials(pattern)) {
1319
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
		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;
}

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

1340 1341
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
1342
	return do_for_each_ref(NULL, "", fn, 0,
1343
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1344 1345
}

1346
const char *prettify_refname(const char *name)
1347 1348 1349 1350 1351 1352 1353 1354
{
	return name + (
		!prefixcmp(name, "refs/heads/") ? 11 :
		!prefixcmp(name, "refs/tags/") ? 10 :
		!prefixcmp(name, "refs/remotes/") ? 13 :
		0);
}

S
Steffen Prohaska 已提交
1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378
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 已提交
1379
static struct ref_lock *verify_lock(struct ref_lock *lock,
1380 1381
	const unsigned char *old_sha1, int mustexist)
{
1382
	if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1383
		error("Can't verify ref %s", lock->ref_name);
1384 1385 1386
		unlock_ref(lock);
		return NULL;
	}
1387
	if (hashcmp(lock->old_sha1, old_sha1)) {
1388
		error("Ref %s is at %s but expected %s", lock->ref_name,
1389 1390 1391 1392 1393 1394 1395
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
		return NULL;
	}
	return lock;
}

1396
static int remove_empty_directories(const char *file)
1397 1398 1399 1400 1401
{
	/* 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.
	 */
1402 1403
	struct strbuf path;
	int result;
1404

1405 1406 1407
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

1408
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1409 1410 1411 1412

	strbuf_release(&path);

	return result;
1413 1414
}

1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
/*
 * *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);
1450
		r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1451 1452 1453 1454 1455
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
1456
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1457
			warning("ignoring dangling symref %s.", fullref);
1458 1459 1460
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
	}
	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);
1480
		ref = resolve_ref_unsafe(path, hash, 1, NULL);
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
		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;
}

1503 1504 1505
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
					    int flags, int *type_p)
1506
{
1507
	char *ref_file;
1508
	const char *orig_refname = refname;
1509
	struct ref_lock *lock;
1510
	int last_errno = 0;
1511
	int type, lflags;
1512
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1513
	int missing = 0;
1514 1515 1516 1517

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

J
Junio C Hamano 已提交
1518
	refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1519
	if (!refname && errno == EISDIR) {
1520 1521 1522 1523 1524
		/* 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.
		 */
1525
		ref_file = git_path("%s", orig_refname);
1526 1527
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
1528
			error("there are still refs under '%s'", orig_refname);
1529 1530
			goto error_return;
		}
J
Junio C Hamano 已提交
1531
		refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1532
	}
1533 1534
	if (type_p)
	    *type_p = type;
1535
	if (!refname) {
1536
		last_errno = errno;
1537
		error("unable to resolve reference %s: %s",
1538
			orig_refname, strerror(errno));
1539
		goto error_return;
1540
	}
1541
	missing = is_null_sha1(lock->old_sha1);
1542 1543 1544 1545 1546
	/* 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.
	 */
1547
	if (missing &&
1548
	     !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1549
		last_errno = ENOTDIR;
1550
		goto error_return;
1551
	}
1552

1553
	lock->lk = xcalloc(1, sizeof(struct lock_file));
1554

1555 1556
	lflags = LOCK_DIE_ON_ERROR;
	if (flags & REF_NODEREF) {
1557
		refname = orig_refname;
1558 1559
		lflags |= LOCK_NODEREF;
	}
1560 1561 1562
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
1563
	if (missing)
1564 1565 1566
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
1567

1568 1569 1570 1571 1572
	if (safe_create_leading_directories(ref_file)) {
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
1573

1574
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1575
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1576 1577 1578 1579 1580

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
1581 1582
}

1583
struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
D
Daniel Barkalow 已提交
1584
{
P
Petr Baudis 已提交
1585
	char refpath[PATH_MAX];
1586
	if (check_refname_format(refname, 0))
1587
		return NULL;
1588
	strcpy(refpath, mkpath("refs/%s", refname));
1589
	return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1590 1591
}

1592 1593
struct ref_lock *lock_any_ref_for_update(const char *refname,
					 const unsigned char *old_sha1, int flags)
1594
{
1595
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1596
		return NULL;
1597
	return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
J
Junio C Hamano 已提交
1598 1599
}

1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
struct repack_without_ref_sb {
	const char *refname;
	int fd;
};

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

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

1623 1624
static struct lock_file packlock;

J
Junio C Hamano 已提交
1625 1626
static int repack_without_ref(const char *refname)
{
1627
	struct repack_without_ref_sb data;
1628
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1629
	if (find_ref(packed, refname) == NULL)
J
Junio C Hamano 已提交
1630
		return 0;
1631 1632 1633
	data.refname = refname;
	data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
	if (data.fd < 0) {
1634
		unable_to_lock_error(git_path("packed-refs"), errno);
J
Junio C Hamano 已提交
1635
		return error("cannot delete '%s' from packed refs", refname);
1636
	}
1637
	do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
J
Junio C Hamano 已提交
1638 1639 1640
	return commit_lock_file(&packlock);
}

M
Miklos Vajna 已提交
1641
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
1642 1643
{
	struct ref_lock *lock;
M
Miklos Vajna 已提交
1644
	int err, i = 0, ret = 0, flag = 0;
J
Junio C Hamano 已提交
1645

1646
	lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
J
Junio C Hamano 已提交
1647 1648
	if (!lock)
		return 1;
1649
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
J
Junio C Hamano 已提交
1650
		/* loose */
M
Miklos Vajna 已提交
1651 1652 1653 1654 1655 1656 1657
		const char *path;

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

M
Miklos Vajna 已提交
1664 1665
		if (!(delopt & REF_NODEREF))
			lock->lk->filename[i] = '.';
J
Junio C Hamano 已提交
1666 1667 1668 1669 1670 1671 1672
	}
	/* removing the loose one could have resurrected an earlier
	 * packed one.  Also, if it was not loose we need to repack
	 * without it.
	 */
	ret |= repack_without_ref(refname);

1673
	unlink_or_warn(git_path("logs/%s", lock->ref_name));
1674
	invalidate_ref_cache(NULL);
J
Junio C Hamano 已提交
1675 1676
	unlock_ref(lock);
	return ret;
1677 1678
}

1679 1680 1681 1682 1683 1684 1685 1686 1687
/*
 * 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"

1688
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1689 1690 1691 1692 1693
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
1694
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
1695
	const char *symref = NULL;
1696
	struct ref_cache *refs = get_ref_cache(NULL);
1697

1698
	if (log && S_ISLNK(loginfo.st_mode))
1699
		return error("reflog for %s is a symlink", oldrefname);
1700

J
Junio C Hamano 已提交
1701
	symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
M
Miklos Vajna 已提交
1702
	if (flag & REF_ISSYMREF)
1703
		return error("refname %s is a symbolic ref, renaming it is not supported",
1704
			oldrefname);
M
Miklos Vajna 已提交
1705
	if (!symref)
1706
		return error("refname %s not found", oldrefname);
1707

1708
	if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1709 1710
		return 1;

1711
	if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1712 1713
		return 1;

1714
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1715
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1716
			oldrefname, strerror(errno));
1717

1718 1719
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
1720 1721 1722
		goto rollback;
	}

1723 1724
	if (!read_ref_full(newrefname, sha1, 1, &flag) &&
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
1725
		if (errno==EISDIR) {
1726 1727
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
1728 1729 1730
				goto rollback;
			}
		} else {
1731
			error("unable to delete existing %s", newrefname);
1732 1733 1734 1735
			goto rollback;
		}
	}

1736 1737
	if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
		error("unable to create directory for %s", newrefname);
1738 1739 1740 1741
		goto rollback;
	}

 retry:
1742
	if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1743 1744 1745 1746 1747 1748
		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.
			 */
1749 1750
			if (remove_empty_directories(git_path("logs/%s", newrefname))) {
				error("Directory not empty: logs/%s", newrefname);
1751 1752 1753 1754
				goto rollback;
			}
			goto retry;
		} else {
1755
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1756
				newrefname, strerror(errno));
1757 1758 1759 1760 1761
			goto rollback;
		}
	}
	logmoved = log;

1762
	lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1763
	if (!lock) {
1764
		error("unable to lock %s for update", newrefname);
1765 1766 1767 1768
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
1769
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1770
		error("unable to write current sha1 into %s", newrefname);
1771 1772 1773 1774 1775 1776
		goto rollback;
	}

	return 0;

 rollback:
1777
	lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1778
	if (!lock) {
1779
		error("unable to lock %s for rollback", oldrefname);
1780 1781 1782 1783 1784 1785 1786
		goto rollbacklog;
	}

	lock->force_write = 1;
	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
	if (write_ref_sha1(lock, orig_sha1, NULL))
1787
		error("unable to write current sha1 into %s", oldrefname);
1788 1789 1790
	log_all_ref_updates = flag;

 rollbacklog:
1791
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1792
		error("unable to restore logfile %s from %s: %s",
1793
			oldrefname, newrefname, strerror(errno));
1794
	if (!logmoved && log &&
1795
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1796
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1797
			oldrefname, strerror(errno));
1798 1799 1800 1801

	return 1;
}

1802
int close_ref(struct ref_lock *lock)
1803 1804 1805 1806 1807 1808 1809
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

1810
int commit_ref(struct ref_lock *lock)
1811 1812 1813 1814 1815 1816 1817
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
1818
void unlock_ref(struct ref_lock *lock)
1819
{
B
Brandon Casey 已提交
1820 1821 1822
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
1823
	free(lock->ref_name);
1824
	free(lock->orig_ref_name);
1825 1826 1827
	free(lock);
}

1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853
/*
 * 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;
}

1854
int log_ref_setup(const char *refname, char *logfile, int bufsize)
1855
{
1856
	int logfd, oflags = O_APPEND | O_WRONLY;
1857

1858
	git_snpath(logfile, bufsize, "logs/%s", refname);
1859
	if (log_all_ref_updates &&
1860 1861 1862 1863
	    (!prefixcmp(refname, "refs/heads/") ||
	     !prefixcmp(refname, "refs/remotes/") ||
	     !prefixcmp(refname, "refs/notes/") ||
	     !strcmp(refname, "HEAD"))) {
1864
		if (safe_create_leading_directories(logfile) < 0)
1865
			return error("unable to create directory for %s",
1866
				     logfile);
1867 1868 1869
		oflags |= O_CREAT;
	}

1870
	logfd = open(logfile, oflags, 0666);
1871
	if (logfd < 0) {
J
Junio C Hamano 已提交
1872
		if (!(oflags & O_CREAT) && errno == ENOENT)
1873
			return 0;
1874 1875

		if ((oflags & O_CREAT) && errno == EISDIR) {
1876
			if (remove_empty_directories(logfile)) {
1877
				return error("There are still logs under '%s'",
1878
					     logfile);
1879
			}
1880
			logfd = open(logfile, oflags, 0666);
1881 1882 1883 1884
		}

		if (logfd < 0)
			return error("Unable to append to %s: %s",
1885
				     logfile, strerror(errno));
1886 1887
	}

1888
	adjust_shared_perm(logfile);
1889 1890 1891
	close(logfd);
	return 0;
}
1892

1893
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
1894 1895 1896 1897 1898
			 const unsigned char *new_sha1, const char *msg)
{
	int logfd, result, written, oflags = O_APPEND | O_WRONLY;
	unsigned maxlen, len;
	int msglen;
1899
	char log_file[PATH_MAX];
1900 1901 1902 1903 1904 1905
	char *logrec;
	const char *committer;

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

1906
	result = log_ref_setup(refname, log_file, sizeof(log_file));
1907 1908 1909 1910 1911 1912
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
1913
	msglen = msg ? strlen(msg) : 0;
1914
	committer = git_committer_info(0);
1915 1916 1917
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
1918 1919
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
1920 1921
		      committer);
	if (msglen)
1922
		len += copy_msg(logrec + len - 1, msg) - 1;
1923
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1924
	free(logrec);
1925
	if (close(logfd) != 0 || written != len)
1926
		return error("Unable to append to %s", log_file);
1927 1928 1929
	return 0;
}

1930 1931 1932 1933 1934
static int is_branch(const char *refname)
{
	return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
}

1935 1936 1937 1938
int write_ref_sha1(struct ref_lock *lock,
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
1939
	struct object *o;
1940 1941

	if (!lock)
D
Daniel Barkalow 已提交
1942
		return -1;
1943
	if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1944 1945
		unlock_ref(lock);
		return 0;
D
Daniel Barkalow 已提交
1946
	}
1947 1948
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
1949
		error("Trying to write ref %s with nonexistent object %s",
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959
			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;
	}
1960 1961
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
	    write_in_full(lock->lock_fd, &term, 1) != 1
1962
		|| close_ref(lock) < 0) {
1963
		error("Couldn't write %s", lock->lk->filename);
1964 1965 1966
		unlock_ref(lock);
		return -1;
	}
1967
	clear_loose_ref_cache(get_ref_cache(NULL));
N
Nicolas Pitre 已提交
1968 1969 1970
	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)) {
1971 1972 1973
		unlock_ref(lock);
		return -1;
	}
1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989
	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;
1990
		head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
1991 1992 1993 1994
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
1995
	if (commit_ref(lock)) {
1996
		error("Couldn't set %s", lock->ref_name);
1997 1998 1999 2000 2001
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
2002
}
2003

2004 2005
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
2006 2007 2008 2009
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
2010
	char *git_HEAD = git_pathdup("%s", ref_target);
2011 2012 2013 2014
	unsigned char old_sha1[20], new_sha1[20];

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

2016 2017 2018
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

2019 2020 2021 2022
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
2023
			goto done;
2024 2025 2026 2027 2028 2029 2030
		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);
2031
		goto error_free_return;
2032 2033 2034 2035 2036
	}
	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);
2037
		goto error_free_return;
2038 2039
	}
	written = write_in_full(fd, ref, len);
2040
	if (close(fd) != 0 || written != len) {
2041
		error("Unable to write to %s", lockpath);
2042
		goto error_unlink_return;
2043 2044 2045
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
2046
		goto error_unlink_return;
2047 2048 2049
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
2050
	error_unlink_return:
2051
		unlink_or_warn(lockpath);
2052 2053 2054
	error_free_return:
		free(git_HEAD);
		return -1;
2055
	}
2056

2057
#ifndef NO_SYMLINK_HEAD
2058
	done:
2059
#endif
2060 2061 2062
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

2063
	free(git_HEAD);
2064 2065 2066
	return 0;
}

2067 2068 2069 2070
static char *ref_msg(const char *line, const char *endp)
{
	const char *ep;
	line += 82;
P
Pierre Habouzit 已提交
2071 2072 2073 2074
	ep = memchr(line, '\n', endp - line);
	if (!ep)
		ep = endp;
	return xmemdupz(line, ep - line);
2075 2076
}

2077 2078 2079
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)
2080
{
2081
	const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2082
	char *tz_c;
J
Junio C Hamano 已提交
2083
	int logfd, tz, reccnt = 0;
2084 2085
	struct stat st;
	unsigned long date;
2086
	unsigned char logged_sha1[20];
2087
	void *log_mapped;
2088
	size_t mapsz;
2089

2090
	logfile = git_path("logs/%s", refname);
2091 2092
	logfd = open(logfile, O_RDONLY, 0);
	if (logfd < 0)
2093
		die_errno("Unable to read log '%s'", logfile);
2094 2095 2096
	fstat(logfd, &st);
	if (!st.st_size)
		die("Log %s is empty.", logfile);
2097 2098
	mapsz = xsize_t(st.st_size);
	log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2099
	logdata = log_mapped;
2100 2101
	close(logfd);

2102
	lastrec = NULL;
2103 2104
	rec = logend = logdata + st.st_size;
	while (logdata < rec) {
J
Junio C Hamano 已提交
2105
		reccnt++;
2106 2107
		if (logdata < rec && *(rec-1) == '\n')
			rec--;
2108 2109
		lastgt = NULL;
		while (logdata < rec && *(rec-1) != '\n') {
2110
			rec--;
2111 2112 2113 2114
			if (*rec == '>')
				lastgt = rec;
		}
		if (!lastgt)
2115
			die("Log %s is corrupt.", logfile);
2116
		date = strtoul(lastgt + 1, &tz_c, 10);
2117
		if (date <= at_time || cnt == 0) {
2118
			tz = strtoul(tz_c, NULL, 10);
2119 2120 2121 2122 2123 2124 2125
			if (msg)
				*msg = ref_msg(rec, logend);
			if (cutoff_time)
				*cutoff_time = date;
			if (cutoff_tz)
				*cutoff_tz = tz;
			if (cutoff_cnt)
2126
				*cutoff_cnt = reccnt - 1;
2127 2128 2129 2130 2131
			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);
2132
				if (hashcmp(logged_sha1, sha1)) {
2133
					warning("Log %s has gap after %s.",
2134
						logfile, show_date(date, tz, DATE_RFC2822));
2135
				}
J
Junio C Hamano 已提交
2136 2137
			}
			else if (date == at_time) {
2138 2139
				if (get_sha1_hex(rec + 41, sha1))
					die("Log %s is corrupt.", logfile);
J
Junio C Hamano 已提交
2140 2141
			}
			else {
2142 2143
				if (get_sha1_hex(rec + 41, logged_sha1))
					die("Log %s is corrupt.", logfile);
2144
				if (hashcmp(logged_sha1, sha1)) {
2145
					warning("Log %s unexpectedly ended on %s.",
2146
						logfile, show_date(date, tz, DATE_RFC2822));
2147 2148
				}
			}
2149
			munmap(log_mapped, mapsz);
2150 2151
			return 0;
		}
2152
		lastrec = rec;
2153 2154
		if (cnt > 0)
			cnt--;
2155 2156
	}

2157 2158 2159 2160
	rec = logdata;
	while (rec < logend && *rec != '>' && *rec != '\n')
		rec++;
	if (rec == logend || *rec == '\n')
2161
		die("Log %s is corrupt.", logfile);
2162
	date = strtoul(rec + 1, &tz_c, 10);
2163 2164 2165
	tz = strtoul(tz_c, NULL, 10);
	if (get_sha1_hex(logdata, sha1))
		die("Log %s is corrupt.", logfile);
J
Jeff King 已提交
2166 2167 2168 2169
	if (is_null_sha1(sha1)) {
		if (get_sha1_hex(logdata + 41, sha1))
			die("Log %s is corrupt.", logfile);
	}
2170 2171
	if (msg)
		*msg = ref_msg(logdata, logend);
2172
	munmap(log_mapped, mapsz);
2173 2174 2175 2176 2177 2178 2179 2180

	if (cutoff_time)
		*cutoff_time = date;
	if (cutoff_tz)
		*cutoff_tz = tz;
	if (cutoff_cnt)
		*cutoff_cnt = reccnt;
	return 1;
2181
}
2182

2183
int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2184 2185 2186
{
	const char *logfile;
	FILE *logfp;
2187
	struct strbuf sb = STRBUF_INIT;
2188
	int ret = 0;
2189

2190
	logfile = git_path("logs/%s", refname);
2191 2192
	logfp = fopen(logfile, "r");
	if (!logfp)
2193
		return -1;
2194 2195 2196 2197 2198 2199

	if (ofs) {
		struct stat statbuf;
		if (fstat(fileno(logfp), &statbuf) ||
		    statbuf.st_size < ofs ||
		    fseek(logfp, -ofs, SEEK_END) ||
2200
		    strbuf_getwholeline(&sb, logfp, '\n')) {
2201
			fclose(logfp);
2202
			strbuf_release(&sb);
2203
			return -1;
2204
		}
2205 2206
	}

2207
	while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2208
		unsigned char osha1[20], nsha1[20];
2209 2210
		char *email_end, *message;
		unsigned long timestamp;
2211
		int tz;
2212 2213

		/* old SP new SP name <email> SP time TAB msg LF */
2214 2215 2216 2217
		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, '>')) ||
2218 2219 2220 2221 2222
		    email_end[1] != ' ' ||
		    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
		    !message || message[0] != ' ' ||
		    (message[1] != '+' && message[1] != '-') ||
		    !isdigit(message[2]) || !isdigit(message[3]) ||
2223
		    !isdigit(message[4]) || !isdigit(message[5]))
2224
			continue; /* corrupt? */
2225 2226
		email_end[1] = '\0';
		tz = strtol(message + 1, NULL, 10);
2227 2228 2229 2230
		if (message[6] != '\t')
			message += 6;
		else
			message += 7;
2231 2232
		ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
			 cb_data);
2233
		if (ret)
2234
			break;
2235 2236
	}
	fclose(logfp);
2237
	strbuf_release(&sb);
2238
	return ret;
2239
}
J
Junio C Hamano 已提交
2240

2241
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2242
{
2243
	return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
2244 2245
}

2246 2247 2248 2249 2250 2251
/*
 * 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)
2252
{
2253
	DIR *d = opendir(git_path("logs/%s", name->buf));
2254
	int retval = 0;
2255
	struct dirent *de;
2256
	int oldlen = name->len;
2257

2258
	if (!d)
2259
		return name->len ? errno : 0;
2260

2261 2262
	while ((de = readdir(d)) != NULL) {
		struct stat st;
2263

2264 2265 2266 2267
		if (de->d_name[0] == '.')
			continue;
		if (has_extension(de->d_name, ".lock"))
			continue;
2268 2269 2270
		strbuf_addstr(name, de->d_name);
		if (stat(git_path("logs/%s", name->buf), &st) < 0) {
			; /* silently ignore */
2271
		} else {
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
			if (S_ISDIR(st.st_mode)) {
				strbuf_addch(name, '/');
				retval = do_for_each_reflog(name, fn, cb_data);
			} else {
				unsigned char sha1[20];
				if (read_ref_full(name->buf, sha1, 0, NULL))
					retval = error("bad ref for %s", name->buf);
				else
					retval = fn(name->buf, sha1, 0, cb_data);
			}
			if (retval)
				break;
2284
		}
2285
		strbuf_setlen(name, oldlen);
2286
	}
2287
	closedir(d);
2288 2289 2290 2291 2292
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
2293 2294 2295 2296 2297 2298
	int retval;
	struct strbuf name;
	strbuf_init(&name, PATH_MAX);
	retval = do_for_each_reflog(&name, fn, cb_data);
	strbuf_release(&name);
	return retval;
2299
}
C
Carlos Rica 已提交
2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326

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

2328
struct ref *find_ref_by_name(const struct ref *list, const char *name)
2329 2330 2331
{
	for ( ; list; list = list->next)
		if (!strcmp(list->name, name))
2332
			return (struct ref *)list;
2333 2334
	return NULL;
}
J
Jeff King 已提交
2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358

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

2359
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387
{
	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)
2388
		return xstrdup(refname);
J
Jeff King 已提交
2389

2390 2391
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
2392 2393 2394 2395

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

2399
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
2400 2401 2402 2403
			continue;

		short_name_len = strlen(short_name);

2404 2405 2406 2407 2408 2409 2410
		/*
		 * 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 已提交
2411 2412 2413 2414
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
2415
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
2416 2417 2418
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

2419 2420 2421 2422
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
2423 2424 2425 2426 2427 2428 2429
			/*
			 * 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);
2430
			if (ref_exists(refname))
J
Jeff King 已提交
2431 2432 2433 2434 2435 2436 2437
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
2438
		if (j == rules_to_fail)
J
Jeff King 已提交
2439 2440 2441 2442
			return short_name;
	}

	free(short_name);
2443
	return xstrdup(refname);
J
Jeff King 已提交
2444
}