refs.c 61.5 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 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
/*
 * 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)
{
	char *refname_copy = xstrdup(refname);
	char *slash;
	struct ref_entry *entry;
	for (slash = strchr(refname_copy, '/'); slash; slash = strchr(slash + 1, '/')) {
		char tmp = slash[1];
		slash[1] = '\0';
		entry = search_ref_dir(dir, refname_copy);
		if (!entry) {
			if (!mkdir) {
				dir = NULL;
				break;
			}
			entry = create_dir_entry(refname_copy);
			add_entry_to_dir(dir, entry);
		}
		slash[1] = tmp;
		assert(entry->flag & REF_DIR);
		dir = &entry->u.subdir;
	}

	free(refname_copy);
	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;
}

344 345 346 347 348 349 350
/*
 * 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)
{
351
	if (strcmp(ref1->name, ref2->name))
352
		return 0;
353 354 355 356 357 358 359 360 361 362 363 364

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

367
/*
368 369
 * Sort the entries in dir non-recursively (if they are not already
 * sorted) and remove any duplicate entries.
370
 */
371
static void sort_ref_dir(struct ref_dir *dir)
372
{
373
	int i, j;
374
	struct ref_entry *last = NULL;
375

376 377 378 379
	/*
	 * This check also prevents passing a zero-length array to qsort(),
	 * which is a problem on some platforms.
	 */
380
	if (dir->sorted == dir->nr)
381
		return;
382

383
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
384

385 386 387 388 389 390 391
	/* 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;
392
	}
393
	dir->sorted = dir->nr = i;
394
}
395

396
#define DO_FOR_EACH_INCLUDE_BROKEN 01
397

398
static struct ref_entry *current_ref;
399

400 401 402
static int do_one_ref(const char *base, each_ref_fn fn, int trim,
		      int flags, void *cb_data, struct ref_entry *entry)
{
403
	int retval;
404 405
	if (prefixcmp(entry->name, base))
		return 0;
406

407 408 409
	if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
		if (entry->flag & REF_ISBROKEN)
			return 0; /* ignore broken refs e.g. dangling symref */
410
		if (!has_sha1_file(entry->u.value.sha1)) {
411 412 413 414 415
			error("%s does not point to a valid object!", entry->name);
			return 0;
		}
	}
	current_ref = entry;
416
	retval = fn(entry->name + trim, entry->u.value.sha1, entry->flag, cb_data);
417 418
	current_ref = NULL;
	return retval;
419
}
420

421
/*
422
 * Call fn for each reference in dir that has index in the range
423 424 425
 * 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.
426
 */
427 428 429
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)
430 431
{
	int i;
432 433
	assert(dir->sorted == dir->nr);
	for (i = offset; i < dir->nr; i++) {
434 435 436 437 438 439 440 441 442
		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);
		}
443 444 445 446 447 448
		if (retval)
			return retval;
	}
	return 0;
}

449
/*
450
 * Call fn for each reference in the union of dir1 and dir2, in order
451 452 453 454
 * 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.
455
 */
456 457 458 459
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)
460 461 462 463
{
	int retval;
	int i1 = 0, i2 = 0;

464 465
	assert(dir1->sorted == dir1->nr);
	assert(dir2->sorted == dir2->nr);
466 467 468 469 470 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
	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);
			}
499
		} else {
500 501 502
			struct ref_entry *e;
			if (cmp < 0) {
				e = e1;
503
				i1++;
504 505 506 507 508 509 510 511 512 513 514
			} 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);
515 516 517 518 519
			}
		}
		if (retval)
			return retval;
	}
520 521 522 523 524 525
	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);
526 527 528
	return 0;
}

529 530 531 532 533 534 535 536 537
/*
 * 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)
{
538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
	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;
559
	}
560
	return 0;
561 562
}

563 564
/*
 * Return true iff a reference named refname could be created without
565 566 567
 * 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
568 569 570
 * operation).
 */
static int is_refname_available(const char *refname, const char *oldrefname,
571
				struct ref_dir *dir)
572
{
573 574 575 576 577
	struct name_conflict_cb data;
	data.refname = refname;
	data.oldrefname = oldrefname;
	data.conflicting_refname = NULL;

578 579 580 581
	sort_ref_dir(dir);
	if (do_for_each_ref_in_dir(dir, 0, "", name_conflict_fn,
				   0, DO_FOR_EACH_INCLUDE_BROKEN,
				   &data)) {
582 583 584
		error("'%s' exists; cannot create '%s'",
		      data.conflicting_refname, refname);
		return 0;
585 586
	}
	return 1;
587 588
}

589 590 591 592
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
593 594
static struct ref_cache {
	struct ref_cache *next;
595 596
	char did_loose;
	char did_packed;
597 598
	struct ref_dir loose;
	struct ref_dir packed;
599 600
	/* The submodule name, or "" for the main repo. */
	char name[FLEX_ARRAY];
601
} *ref_cache;
602

603
static void clear_packed_ref_cache(struct ref_cache *refs)
604
{
605
	if (refs->did_packed)
606
		clear_ref_dir(&refs->packed);
607
	refs->did_packed = 0;
608
}
609

610 611 612
static void clear_loose_ref_cache(struct ref_cache *refs)
{
	if (refs->did_loose)
613
		clear_ref_dir(&refs->loose);
614 615 616
	refs->did_loose = 0;
}

617
static struct ref_cache *create_ref_cache(const char *submodule)
618
{
619
	int len;
620
	struct ref_cache *refs;
621 622 623
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
624
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
625
	memcpy(refs->name, submodule, len);
626 627 628
	return refs;
}

629
/*
630
 * Return a pointer to a ref_cache for the specified submodule. For
631 632 633 634
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
635
static struct ref_cache *get_ref_cache(const char *submodule)
636
{
637
	struct ref_cache *refs = ref_cache;
638 639 640 641 642 643
	if (!submodule)
		submodule = "";
	while (refs) {
		if (!strcmp(submodule, refs->name))
			return refs;
		refs = refs->next;
644
	}
645

646 647 648
	refs = create_ref_cache(submodule);
	refs->next = ref_cache;
	ref_cache = refs;
649
	return refs;
650 651
}

652
void invalidate_ref_cache(const char *submodule)
653
{
654 655 656
	struct ref_cache *refs = get_ref_cache(submodule);
	clear_packed_ref_cache(refs);
	clear_loose_ref_cache(refs);
657
}
658

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
/*
 * 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;
}

692
static void read_packed_refs(FILE *f, struct ref_dir *dir)
693
{
694
	struct ref_entry *last = NULL;
695 696 697 698 699
	char refline[PATH_MAX];
	int flag = REF_ISPACKED;

	while (fgets(refline, sizeof(refline), f)) {
		unsigned char sha1[20];
700
		const char *refname;
701 702 703 704 705 706 707 708 709 710
		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;
		}

711 712
		refname = parse_ref_line(refline, sha1);
		if (refname) {
713
			last = create_ref_entry(refname, sha1, flag, 1);
714
			add_ref(dir, last);
715 716 717 718 719 720 721
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
		    strlen(refline) == 42 &&
		    refline[41] == '\n' &&
		    !get_sha1_hex(refline + 1, sha1))
722
			hashcpy(last->u.value.peeled, sha1);
723 724 725
	}
}

726
static struct ref_dir *get_packed_refs(struct ref_cache *refs)
727
{
728 729 730
	if (!refs->did_packed) {
		const char *packed_refs_file;
		FILE *f;
731

732 733
		if (*refs->name)
			packed_refs_file = git_path_submodule(refs->name, "packed-refs");
734 735 736
		else
			packed_refs_file = git_path("packed-refs");
		f = fopen(packed_refs_file, "r");
737
		if (f) {
738
			read_packed_refs(f, &refs->packed);
739 740
			fclose(f);
		}
741
		refs->did_packed = 1;
742
	}
743
	return &refs->packed;
744 745
}

746 747 748 749 750 751
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));
}

752 753 754 755
/*
 * Read the loose references for refs from the namespace dirname.
 * dirname must end with '/'.
 */
756
static void get_ref_dir(struct ref_cache *refs, const char *dirname,
757
			struct ref_dir *dir)
758
{
759
	DIR *d;
760
	const char *path;
761
	struct dirent *de;
762
	int dirnamelen = strlen(dirname);
763
	struct strbuf refname;
764

M
Michael Haggerty 已提交
765
	if (*refs->name)
766
		path = git_path_submodule(refs->name, "%s", dirname);
767
	else
768
		path = git_path("%s", dirname);
769

770
	d = opendir(path);
771 772 773
	if (!d)
		return;

774 775
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
776 777 778 779 780 781 782 783 784 785 786

	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;
787
		strbuf_addstr(&refname, de->d_name);
788
		refdir = *refs->name
789 790 791 792 793
			? 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)) {
794
			strbuf_addch(&refname, '/');
795 796 797 798 799 800 801 802 803 804
			get_ref_dir(refs, refname.buf, dir);
		} 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)) {
805 806 807
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
808
			add_ref(dir, create_ref_entry(refname.buf, sha1, flag, 1));
809
		}
810
		strbuf_setlen(&refname, dirnamelen);
811
	}
812
	strbuf_release(&refname);
813
	closedir(d);
814 815
}

816
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
817
{
818
	if (!refs->did_loose) {
819
		get_ref_dir(refs, "refs/", &refs->loose);
820
		refs->did_loose = 1;
821
	}
822
	return &refs->loose;
823 824
}

825 826
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
827 828
#define MAXREFLEN (1024)

829 830
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
831 832
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
833
 */
834
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
835
				      const char *refname, unsigned char *sha1)
836
{
837
	struct ref_entry *ref;
838
	struct ref_dir *dir = get_packed_refs(refs);
839

840
	ref = find_ref(dir, refname);
841 842 843
	if (ref == NULL)
		return -1;

844
	memcpy(sha1, ref->u.value.sha1, 20);
845
	return 0;
846 847
}

848
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
849
					 const char *refname, unsigned char *sha1,
850
					 int recursion)
851
{
852
	int fd, len;
853
	char buffer[128], *p;
854
	char *path;
855

856
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
857
		return -1;
858 859 860 861
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
862
	if (fd < 0)
863
		return resolve_gitlink_packed_ref(refs, refname, sha1);
864 865 866 867 868 869 870 871 872 873

	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? */
874
	if (!get_sha1_hex(buffer, sha1))
875 876 877 878 879 880 881 882 883
		return 0;

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

884
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
885 886
}

887
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
888 889
{
	int len = strlen(path), retval;
890
	char *submodule;
891
	struct ref_cache *refs;
892 893 894 895 896

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
897 898 899 900
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

901
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
902 903
	return retval;
}
904

905
/*
906 907
 * Try to read ref from the packed references.  On success, set sha1
 * and return 0; otherwise, return -1.
908
 */
909
static int get_packed_ref(const char *refname, unsigned char *sha1)
910
{
911
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
912
	struct ref_entry *entry = find_ref(packed, refname);
913
	if (entry) {
914
		hashcpy(sha1, entry->u.value.sha1);
915
		return 0;
916 917 918 919
	}
	return -1;
}

J
Junio C Hamano 已提交
920
const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
921
{
922 923
	int depth = MAXDEPTH;
	ssize_t len;
924
	char buffer[256];
925
	static char refname_buffer[256];
926

927 928 929
	if (flag)
		*flag = 0;

930
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
931 932
		return NULL;

933
	for (;;) {
934
		char path[PATH_MAX];
935 936 937
		struct stat st;
		char *buf;
		int fd;
938

939 940
		if (--depth < 0)
			return NULL;
941

942
		git_snpath(path, sizeof(path), "%s", refname);
943

944
		if (lstat(path, &st) < 0) {
945 946 947 948 949 950
			if (errno != ENOENT)
				return NULL;
			/*
			 * The loose reference file does not exist;
			 * check for a packed reference.
			 */
951
			if (!get_packed_ref(refname, sha1)) {
952 953
				if (flag)
					*flag |= REF_ISPACKED;
954
				return refname;
955
			}
956 957
			/* The reference is not a packed reference, either. */
			if (reading) {
958
				return NULL;
959 960
			} else {
				hashclr(sha1);
961
				return refname;
962
			}
963
		}
964

965 966 967
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
968 969
			if (len < 0)
				return NULL;
M
Michael Haggerty 已提交
970
			buffer[len] = 0;
971 972
			if (!prefixcmp(buffer, "refs/") &&
					!check_refname_format(buffer, 0)) {
973 974
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
975 976
				if (flag)
					*flag |= REF_ISSYMREF;
977 978
				continue;
			}
979
		}
980

981 982 983 984 985 986
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

987 988 989 990 991 992 993
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
		if (fd < 0)
			return NULL;
994
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
995
		close(fd);
996 997 998 999 1000
		if (len < 0)
			return NULL;
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1001 1002 1003 1004

		/*
		 * Is it a symbolic ref?
		 */
1005
		if (prefixcmp(buffer, "ref:"))
1006
			break;
1007 1008
		if (flag)
			*flag |= REF_ISSYMREF;
1009
		buf = buffer + 4;
1010 1011
		while (isspace(*buf))
			buf++;
1012
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1013 1014
			if (flag)
				*flag |= REF_ISBROKEN;
1015 1016
			return NULL;
		}
1017
		refname = strcpy(refname_buffer, buf);
1018
	}
1019 1020
	/* Please note that FETCH_HEAD has a second line containing other data. */
	if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1021 1022
		if (flag)
			*flag |= REF_ISBROKEN;
1023
		return NULL;
1024
	}
1025
	return refname;
1026 1027
}

1028 1029
char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
{
1030
	const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1031 1032 1033
	return ret ? xstrdup(ret) : NULL;
}

I
Ilari Liusvaara 已提交
1034 1035 1036 1037 1038 1039 1040
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1041
int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1042
{
J
Junio C Hamano 已提交
1043
	if (resolve_ref_unsafe(refname, sha1, reading, flags))
1044 1045
		return 0;
	return -1;
1046 1047
}

1048
int read_ref(const char *refname, unsigned char *sha1)
1049
{
1050
	return read_ref_full(refname, sha1, 1, NULL);
1051 1052
}

1053
int ref_exists(const char *refname)
1054
{
1055 1056
	unsigned char sha1[20];
	return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1057 1058
}

1059
static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1060
		       void *data)
I
Ilari Liusvaara 已提交
1061 1062
{
	struct ref_filter *filter = (struct ref_filter *)data;
1063
	if (fnmatch(filter->pattern, refname, 0))
I
Ilari Liusvaara 已提交
1064
		return 0;
1065
	return filter->fn(refname, sha1, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1066 1067
}

1068
int peel_ref(const char *refname, unsigned char *sha1)
1069 1070 1071 1072 1073
{
	int flag;
	unsigned char base[20];
	struct object *o;

1074 1075
	if (current_ref && (current_ref->name == refname
		|| !strcmp(current_ref->name, refname))) {
1076
		if (current_ref->flag & REF_KNOWS_PEELED) {
1077
			hashcpy(sha1, current_ref->u.value.peeled);
1078 1079
			return 0;
		}
1080
		hashcpy(base, current_ref->u.value.sha1);
1081 1082 1083
		goto fallback;
	}

1084
	if (read_ref_full(refname, base, 1, &flag))
1085 1086 1087
		return -1;

	if ((flag & REF_ISPACKED)) {
1088
		struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
1089
		struct ref_entry *r = find_ref(dir, refname);
1090

1091
		if (r != NULL && r->flag & REF_KNOWS_PEELED) {
1092
			hashcpy(sha1, r->u.value.peeled);
1093
			return 0;
1094 1095 1096
		}
	}

1097
fallback:
1098
	o = parse_object(base);
1099
	if (o && o->type == OBJ_TAG) {
1100
		o = deref_tag(o, refname, 0);
1101 1102 1103 1104 1105 1106 1107 1108
		if (o) {
			hashcpy(sha1, o->sha1);
			return 0;
		}
	}
	return -1;
}

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
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);
}

1143 1144
static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
			   int trim, int flags, void *cb_data)
1145
{
1146
	struct ref_cache *refs = get_ref_cache(submodule);
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
	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;
1175 1176
}

1177
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1178 1179
{
	unsigned char sha1[20];
1180 1181
	int flag;

1182 1183 1184 1185 1186 1187 1188
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

1189
	if (!read_ref_full("HEAD", sha1, 1, &flag))
1190
		return fn("HEAD", sha1, flag, cb_data);
1191

1192
	return 0;
1193 1194
}

1195 1196 1197 1198 1199
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

1200 1201 1202 1203 1204
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

1205
int for_each_ref(each_ref_fn fn, void *cb_data)
1206
{
1207
	return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1208 1209
}

1210 1211
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
1212
	return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1213 1214
}

1215 1216
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
1217
	return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1218 1219
}

1220 1221 1222 1223
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);
1224 1225
}

1226
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1227
{
1228
	return for_each_ref_in("refs/tags/", fn, cb_data);
1229 1230
}

1231 1232 1233 1234 1235
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);
}

1236
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1237
{
1238
	return for_each_ref_in("refs/heads/", fn, cb_data);
1239 1240
}

1241 1242 1243 1244 1245
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);
}

1246
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1247
{
1248
	return for_each_ref_in("refs/remotes/", fn, cb_data);
1249 1250
}

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

1256 1257
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
1258
	return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
1259 1260
}

J
Josh Triplett 已提交
1261 1262 1263 1264 1265 1266 1267 1268
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());
1269
	if (!read_ref_full(buf.buf, sha1, 1, &flag))
J
Josh Triplett 已提交
1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
		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;
}

1286 1287
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
1288 1289 1290 1291 1292
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

1293
	if (!prefix && prefixcmp(pattern, "refs/"))
I
Ilari Liusvaara 已提交
1294
		strbuf_addstr(&real_pattern, "refs/");
1295 1296
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
1297 1298
	strbuf_addstr(&real_pattern, pattern);

1299
	if (!has_glob_specials(pattern)) {
1300
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
		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;
}

1316 1317 1318 1319 1320
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);
}

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

1327
const char *prettify_refname(const char *name)
1328 1329 1330 1331 1332 1333 1334 1335
{
	return name + (
		!prefixcmp(name, "refs/heads/") ? 11 :
		!prefixcmp(name, "refs/tags/") ? 10 :
		!prefixcmp(name, "refs/remotes/") ? 13 :
		0);
}

S
Steffen Prohaska 已提交
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
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 已提交
1360
static struct ref_lock *verify_lock(struct ref_lock *lock,
1361 1362
	const unsigned char *old_sha1, int mustexist)
{
1363
	if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1364
		error("Can't verify ref %s", lock->ref_name);
1365 1366 1367
		unlock_ref(lock);
		return NULL;
	}
1368
	if (hashcmp(lock->old_sha1, old_sha1)) {
1369
		error("Ref %s is at %s but expected %s", lock->ref_name,
1370 1371 1372 1373 1374 1375 1376
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
		return NULL;
	}
	return lock;
}

1377
static int remove_empty_directories(const char *file)
1378 1379 1380 1381 1382
{
	/* 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.
	 */
1383 1384
	struct strbuf path;
	int result;
1385

1386 1387 1388
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

1389
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1390 1391 1392 1393

	strbuf_release(&path);

	return result;
1394 1395
}

1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
/*
 * *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);
1431
		r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1432 1433 1434 1435 1436
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
1437
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1438
			warning("ignoring dangling symref %s.", fullref);
1439 1440 1441
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
	}
	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);
1461
		ref = resolve_ref_unsafe(path, hash, 1, NULL);
1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
		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;
}

1484 1485 1486
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
					    int flags, int *type_p)
1487
{
1488
	char *ref_file;
1489
	const char *orig_refname = refname;
1490
	struct ref_lock *lock;
1491
	int last_errno = 0;
1492
	int type, lflags;
1493
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1494
	int missing = 0;
1495 1496 1497 1498

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

J
Junio C Hamano 已提交
1499
	refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1500
	if (!refname && errno == EISDIR) {
1501 1502 1503 1504 1505
		/* 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.
		 */
1506
		ref_file = git_path("%s", orig_refname);
1507 1508
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
1509
			error("there are still refs under '%s'", orig_refname);
1510 1511
			goto error_return;
		}
J
Junio C Hamano 已提交
1512
		refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1513
	}
1514 1515
	if (type_p)
	    *type_p = type;
1516
	if (!refname) {
1517
		last_errno = errno;
1518
		error("unable to resolve reference %s: %s",
1519
			orig_refname, strerror(errno));
1520
		goto error_return;
1521
	}
1522
	missing = is_null_sha1(lock->old_sha1);
1523 1524 1525 1526 1527
	/* 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.
	 */
1528
	if (missing &&
1529
	     !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1530
		last_errno = ENOTDIR;
1531
		goto error_return;
1532
	}
1533

1534
	lock->lk = xcalloc(1, sizeof(struct lock_file));
1535

1536 1537
	lflags = LOCK_DIE_ON_ERROR;
	if (flags & REF_NODEREF) {
1538
		refname = orig_refname;
1539 1540
		lflags |= LOCK_NODEREF;
	}
1541 1542 1543
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
1544
	if (missing)
1545 1546 1547
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
1548

1549 1550 1551 1552 1553
	if (safe_create_leading_directories(ref_file)) {
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
1554

1555
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1556
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1557 1558 1559 1560 1561

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
1562 1563
}

1564
struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
D
Daniel Barkalow 已提交
1565
{
P
Petr Baudis 已提交
1566
	char refpath[PATH_MAX];
1567
	if (check_refname_format(refname, 0))
1568
		return NULL;
1569
	strcpy(refpath, mkpath("refs/%s", refname));
1570
	return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1571 1572
}

1573 1574
struct ref_lock *lock_any_ref_for_update(const char *refname,
					 const unsigned char *old_sha1, int flags)
1575
{
1576
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1577
		return NULL;
1578
	return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
J
Junio C Hamano 已提交
1579 1580
}

1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603
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;
}

1604 1605
static struct lock_file packlock;

J
Junio C Hamano 已提交
1606 1607
static int repack_without_ref(const char *refname)
{
1608
	struct repack_without_ref_sb data;
1609
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1610
	if (find_ref(packed, refname) == NULL)
J
Junio C Hamano 已提交
1611
		return 0;
1612 1613 1614
	data.refname = refname;
	data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
	if (data.fd < 0) {
1615
		unable_to_lock_error(git_path("packed-refs"), errno);
J
Junio C Hamano 已提交
1616
		return error("cannot delete '%s' from packed refs", refname);
1617
	}
1618
	do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
J
Junio C Hamano 已提交
1619 1620 1621
	return commit_lock_file(&packlock);
}

M
Miklos Vajna 已提交
1622
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
1623 1624
{
	struct ref_lock *lock;
M
Miklos Vajna 已提交
1625
	int err, i = 0, ret = 0, flag = 0;
J
Junio C Hamano 已提交
1626

1627
	lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
J
Junio C Hamano 已提交
1628 1629
	if (!lock)
		return 1;
1630
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
J
Junio C Hamano 已提交
1631
		/* loose */
M
Miklos Vajna 已提交
1632 1633 1634 1635 1636 1637 1638
		const char *path;

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

M
Miklos Vajna 已提交
1645 1646
		if (!(delopt & REF_NODEREF))
			lock->lk->filename[i] = '.';
J
Junio C Hamano 已提交
1647 1648 1649 1650 1651 1652 1653
	}
	/* 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);

1654
	unlink_or_warn(git_path("logs/%s", lock->ref_name));
1655
	invalidate_ref_cache(NULL);
J
Junio C Hamano 已提交
1656 1657
	unlock_ref(lock);
	return ret;
1658 1659
}

1660 1661 1662 1663 1664 1665 1666 1667 1668
/*
 * 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"

1669
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1670 1671 1672 1673 1674
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
1675
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
1676
	const char *symref = NULL;
1677
	struct ref_cache *refs = get_ref_cache(NULL);
1678

1679
	if (log && S_ISLNK(loginfo.st_mode))
1680
		return error("reflog for %s is a symlink", oldrefname);
1681

J
Junio C Hamano 已提交
1682
	symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
M
Miklos Vajna 已提交
1683
	if (flag & REF_ISSYMREF)
1684
		return error("refname %s is a symbolic ref, renaming it is not supported",
1685
			oldrefname);
M
Miklos Vajna 已提交
1686
	if (!symref)
1687
		return error("refname %s not found", oldrefname);
1688

1689
	if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1690 1691
		return 1;

1692
	if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1693 1694
		return 1;

1695
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1696
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1697
			oldrefname, strerror(errno));
1698

1699 1700
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
1701 1702 1703
		goto rollback;
	}

1704 1705
	if (!read_ref_full(newrefname, sha1, 1, &flag) &&
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
1706
		if (errno==EISDIR) {
1707 1708
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
1709 1710 1711
				goto rollback;
			}
		} else {
1712
			error("unable to delete existing %s", newrefname);
1713 1714 1715 1716
			goto rollback;
		}
	}

1717 1718
	if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
		error("unable to create directory for %s", newrefname);
1719 1720 1721 1722
		goto rollback;
	}

 retry:
1723
	if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1724 1725 1726 1727 1728 1729
		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.
			 */
1730 1731
			if (remove_empty_directories(git_path("logs/%s", newrefname))) {
				error("Directory not empty: logs/%s", newrefname);
1732 1733 1734 1735
				goto rollback;
			}
			goto retry;
		} else {
1736
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1737
				newrefname, strerror(errno));
1738 1739 1740 1741 1742
			goto rollback;
		}
	}
	logmoved = log;

1743
	lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1744
	if (!lock) {
1745
		error("unable to lock %s for update", newrefname);
1746 1747 1748 1749
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
1750
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1751
		error("unable to write current sha1 into %s", newrefname);
1752 1753 1754 1755 1756 1757
		goto rollback;
	}

	return 0;

 rollback:
1758
	lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1759
	if (!lock) {
1760
		error("unable to lock %s for rollback", oldrefname);
1761 1762 1763 1764 1765 1766 1767
		goto rollbacklog;
	}

	lock->force_write = 1;
	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
	if (write_ref_sha1(lock, orig_sha1, NULL))
1768
		error("unable to write current sha1 into %s", oldrefname);
1769 1770 1771
	log_all_ref_updates = flag;

 rollbacklog:
1772
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1773
		error("unable to restore logfile %s from %s: %s",
1774
			oldrefname, newrefname, strerror(errno));
1775
	if (!logmoved && log &&
1776
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1777
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1778
			oldrefname, strerror(errno));
1779 1780 1781 1782

	return 1;
}

1783
int close_ref(struct ref_lock *lock)
1784 1785 1786 1787 1788 1789 1790
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

1791
int commit_ref(struct ref_lock *lock)
1792 1793 1794 1795 1796 1797 1798
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
1799
void unlock_ref(struct ref_lock *lock)
1800
{
B
Brandon Casey 已提交
1801 1802 1803
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
1804
	free(lock->ref_name);
1805
	free(lock->orig_ref_name);
1806 1807 1808
	free(lock);
}

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

1835
int log_ref_setup(const char *refname, char *logfile, int bufsize)
1836
{
1837
	int logfd, oflags = O_APPEND | O_WRONLY;
1838

1839
	git_snpath(logfile, bufsize, "logs/%s", refname);
1840
	if (log_all_ref_updates &&
1841 1842 1843 1844
	    (!prefixcmp(refname, "refs/heads/") ||
	     !prefixcmp(refname, "refs/remotes/") ||
	     !prefixcmp(refname, "refs/notes/") ||
	     !strcmp(refname, "HEAD"))) {
1845
		if (safe_create_leading_directories(logfile) < 0)
1846
			return error("unable to create directory for %s",
1847
				     logfile);
1848 1849 1850
		oflags |= O_CREAT;
	}

1851
	logfd = open(logfile, oflags, 0666);
1852
	if (logfd < 0) {
J
Junio C Hamano 已提交
1853
		if (!(oflags & O_CREAT) && errno == ENOENT)
1854
			return 0;
1855 1856

		if ((oflags & O_CREAT) && errno == EISDIR) {
1857
			if (remove_empty_directories(logfile)) {
1858
				return error("There are still logs under '%s'",
1859
					     logfile);
1860
			}
1861
			logfd = open(logfile, oflags, 0666);
1862 1863 1864 1865
		}

		if (logfd < 0)
			return error("Unable to append to %s: %s",
1866
				     logfile, strerror(errno));
1867 1868
	}

1869
	adjust_shared_perm(logfile);
1870 1871 1872
	close(logfd);
	return 0;
}
1873

1874
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
1875 1876 1877 1878 1879
			 const unsigned char *new_sha1, const char *msg)
{
	int logfd, result, written, oflags = O_APPEND | O_WRONLY;
	unsigned maxlen, len;
	int msglen;
1880
	char log_file[PATH_MAX];
1881 1882 1883 1884 1885 1886
	char *logrec;
	const char *committer;

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

1887
	result = log_ref_setup(refname, log_file, sizeof(log_file));
1888 1889 1890 1891 1892 1893
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
1894
	msglen = msg ? strlen(msg) : 0;
1895
	committer = git_committer_info(0);
1896 1897 1898
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
1899 1900
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
1901 1902
		      committer);
	if (msglen)
1903
		len += copy_msg(logrec + len - 1, msg) - 1;
1904
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1905
	free(logrec);
1906
	if (close(logfd) != 0 || written != len)
1907
		return error("Unable to append to %s", log_file);
1908 1909 1910
	return 0;
}

1911 1912 1913 1914 1915
static int is_branch(const char *refname)
{
	return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
}

1916 1917 1918 1919
int write_ref_sha1(struct ref_lock *lock,
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
1920
	struct object *o;
1921 1922

	if (!lock)
D
Daniel Barkalow 已提交
1923
		return -1;
1924
	if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1925 1926
		unlock_ref(lock);
		return 0;
D
Daniel Barkalow 已提交
1927
	}
1928 1929
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
1930
		error("Trying to write ref %s with nonexistent object %s",
1931 1932 1933 1934 1935 1936 1937 1938 1939 1940
			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;
	}
1941 1942
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
	    write_in_full(lock->lock_fd, &term, 1) != 1
1943
		|| close_ref(lock) < 0) {
1944
		error("Couldn't write %s", lock->lk->filename);
1945 1946 1947
		unlock_ref(lock);
		return -1;
	}
1948
	clear_loose_ref_cache(get_ref_cache(NULL));
N
Nicolas Pitre 已提交
1949 1950 1951
	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)) {
1952 1953 1954
		unlock_ref(lock);
		return -1;
	}
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970
	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;
1971
		head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
1972 1973 1974 1975
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
1976
	if (commit_ref(lock)) {
1977
		error("Couldn't set %s", lock->ref_name);
1978 1979 1980 1981 1982
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
1983
}
1984

1985 1986
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
1987 1988 1989 1990
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
1991
	char *git_HEAD = git_pathdup("%s", ref_target);
1992 1993 1994 1995
	unsigned char old_sha1[20], new_sha1[20];

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

1997 1998 1999
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

2000 2001 2002 2003
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
2004
			goto done;
2005 2006 2007 2008 2009 2010 2011
		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);
2012
		goto error_free_return;
2013 2014 2015 2016 2017
	}
	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);
2018
		goto error_free_return;
2019 2020
	}
	written = write_in_full(fd, ref, len);
2021
	if (close(fd) != 0 || written != len) {
2022
		error("Unable to write to %s", lockpath);
2023
		goto error_unlink_return;
2024 2025 2026
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
2027
		goto error_unlink_return;
2028 2029 2030
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
2031
	error_unlink_return:
2032
		unlink_or_warn(lockpath);
2033 2034 2035
	error_free_return:
		free(git_HEAD);
		return -1;
2036
	}
2037

2038
#ifndef NO_SYMLINK_HEAD
2039
	done:
2040
#endif
2041 2042 2043
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

2044
	free(git_HEAD);
2045 2046 2047
	return 0;
}

2048 2049 2050 2051
static char *ref_msg(const char *line, const char *endp)
{
	const char *ep;
	line += 82;
P
Pierre Habouzit 已提交
2052 2053 2054 2055
	ep = memchr(line, '\n', endp - line);
	if (!ep)
		ep = endp;
	return xmemdupz(line, ep - line);
2056 2057
}

2058 2059 2060
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)
2061
{
2062
	const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2063
	char *tz_c;
J
Junio C Hamano 已提交
2064
	int logfd, tz, reccnt = 0;
2065 2066
	struct stat st;
	unsigned long date;
2067
	unsigned char logged_sha1[20];
2068
	void *log_mapped;
2069
	size_t mapsz;
2070

2071
	logfile = git_path("logs/%s", refname);
2072 2073
	logfd = open(logfile, O_RDONLY, 0);
	if (logfd < 0)
2074
		die_errno("Unable to read log '%s'", logfile);
2075 2076 2077
	fstat(logfd, &st);
	if (!st.st_size)
		die("Log %s is empty.", logfile);
2078 2079
	mapsz = xsize_t(st.st_size);
	log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2080
	logdata = log_mapped;
2081 2082
	close(logfd);

2083
	lastrec = NULL;
2084 2085
	rec = logend = logdata + st.st_size;
	while (logdata < rec) {
J
Junio C Hamano 已提交
2086
		reccnt++;
2087 2088
		if (logdata < rec && *(rec-1) == '\n')
			rec--;
2089 2090
		lastgt = NULL;
		while (logdata < rec && *(rec-1) != '\n') {
2091
			rec--;
2092 2093 2094 2095
			if (*rec == '>')
				lastgt = rec;
		}
		if (!lastgt)
2096
			die("Log %s is corrupt.", logfile);
2097
		date = strtoul(lastgt + 1, &tz_c, 10);
2098
		if (date <= at_time || cnt == 0) {
2099
			tz = strtoul(tz_c, NULL, 10);
2100 2101 2102 2103 2104 2105 2106
			if (msg)
				*msg = ref_msg(rec, logend);
			if (cutoff_time)
				*cutoff_time = date;
			if (cutoff_tz)
				*cutoff_tz = tz;
			if (cutoff_cnt)
2107
				*cutoff_cnt = reccnt - 1;
2108 2109 2110 2111 2112
			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);
2113
				if (hashcmp(logged_sha1, sha1)) {
2114
					warning("Log %s has gap after %s.",
2115
						logfile, show_date(date, tz, DATE_RFC2822));
2116
				}
J
Junio C Hamano 已提交
2117 2118
			}
			else if (date == at_time) {
2119 2120
				if (get_sha1_hex(rec + 41, sha1))
					die("Log %s is corrupt.", logfile);
J
Junio C Hamano 已提交
2121 2122
			}
			else {
2123 2124
				if (get_sha1_hex(rec + 41, logged_sha1))
					die("Log %s is corrupt.", logfile);
2125
				if (hashcmp(logged_sha1, sha1)) {
2126
					warning("Log %s unexpectedly ended on %s.",
2127
						logfile, show_date(date, tz, DATE_RFC2822));
2128 2129
				}
			}
2130
			munmap(log_mapped, mapsz);
2131 2132
			return 0;
		}
2133
		lastrec = rec;
2134 2135
		if (cnt > 0)
			cnt--;
2136 2137
	}

2138 2139 2140 2141
	rec = logdata;
	while (rec < logend && *rec != '>' && *rec != '\n')
		rec++;
	if (rec == logend || *rec == '\n')
2142
		die("Log %s is corrupt.", logfile);
2143
	date = strtoul(rec + 1, &tz_c, 10);
2144 2145 2146
	tz = strtoul(tz_c, NULL, 10);
	if (get_sha1_hex(logdata, sha1))
		die("Log %s is corrupt.", logfile);
J
Jeff King 已提交
2147 2148 2149 2150
	if (is_null_sha1(sha1)) {
		if (get_sha1_hex(logdata + 41, sha1))
			die("Log %s is corrupt.", logfile);
	}
2151 2152
	if (msg)
		*msg = ref_msg(logdata, logend);
2153
	munmap(log_mapped, mapsz);
2154 2155 2156 2157 2158 2159 2160 2161

	if (cutoff_time)
		*cutoff_time = date;
	if (cutoff_tz)
		*cutoff_tz = tz;
	if (cutoff_cnt)
		*cutoff_cnt = reccnt;
	return 1;
2162
}
2163

2164
int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2165 2166 2167
{
	const char *logfile;
	FILE *logfp;
2168
	struct strbuf sb = STRBUF_INIT;
2169
	int ret = 0;
2170

2171
	logfile = git_path("logs/%s", refname);
2172 2173
	logfp = fopen(logfile, "r");
	if (!logfp)
2174
		return -1;
2175 2176 2177 2178 2179 2180

	if (ofs) {
		struct stat statbuf;
		if (fstat(fileno(logfp), &statbuf) ||
		    statbuf.st_size < ofs ||
		    fseek(logfp, -ofs, SEEK_END) ||
2181
		    strbuf_getwholeline(&sb, logfp, '\n')) {
2182
			fclose(logfp);
2183
			strbuf_release(&sb);
2184
			return -1;
2185
		}
2186 2187
	}

2188
	while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2189
		unsigned char osha1[20], nsha1[20];
2190 2191
		char *email_end, *message;
		unsigned long timestamp;
2192
		int tz;
2193 2194

		/* old SP new SP name <email> SP time TAB msg LF */
2195 2196 2197 2198
		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, '>')) ||
2199 2200 2201 2202 2203
		    email_end[1] != ' ' ||
		    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
		    !message || message[0] != ' ' ||
		    (message[1] != '+' && message[1] != '-') ||
		    !isdigit(message[2]) || !isdigit(message[3]) ||
2204
		    !isdigit(message[4]) || !isdigit(message[5]))
2205
			continue; /* corrupt? */
2206 2207
		email_end[1] = '\0';
		tz = strtol(message + 1, NULL, 10);
2208 2209 2210 2211
		if (message[6] != '\t')
			message += 6;
		else
			message += 7;
2212 2213
		ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
			 cb_data);
2214
		if (ret)
2215
			break;
2216 2217
	}
	fclose(logfp);
2218
	strbuf_release(&sb);
2219
	return ret;
2220
}
J
Junio C Hamano 已提交
2221

2222
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2223
{
2224
	return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
2225 2226
}

2227 2228
static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
{
2229
	DIR *d = opendir(git_path("logs/%s", base));
2230
	int retval = 0;
2231

2232
	if (d) {
2233 2234 2235 2236 2237 2238 2239 2240
		struct dirent *de;
		int baselen = strlen(base);
		char *log = xmalloc(baselen + 257);

		memcpy(log, base, baselen);
		if (baselen && base[baselen-1] != '/')
			log[baselen++] = '/';

2241
		while ((de = readdir(d)) != NULL) {
2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258
			struct stat st;
			int namelen;

			if (de->d_name[0] == '.')
				continue;
			namelen = strlen(de->d_name);
			if (namelen > 255)
				continue;
			if (has_extension(de->d_name, ".lock"))
				continue;
			memcpy(log + baselen, de->d_name, namelen+1);
			if (stat(git_path("logs/%s", log), &st) < 0)
				continue;
			if (S_ISDIR(st.st_mode)) {
				retval = do_for_each_reflog(log, fn, cb_data);
			} else {
				unsigned char sha1[20];
2259
				if (read_ref_full(log, sha1, 0, NULL))
2260 2261 2262 2263 2264 2265 2266 2267
					retval = error("bad ref for %s", log);
				else
					retval = fn(log, sha1, 0, cb_data);
			}
			if (retval)
				break;
		}
		free(log);
2268
		closedir(d);
2269
	}
2270
	else if (*base)
2271
		return errno;
2272 2273 2274 2275 2276 2277 2278
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
	return do_for_each_reflog("", fn, cb_data);
}
C
Carlos Rica 已提交
2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305

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

2307
struct ref *find_ref_by_name(const struct ref *list, const char *name)
2308 2309 2310
{
	for ( ; list; list = list->next)
		if (!strcmp(list->name, name))
2311
			return (struct ref *)list;
2312 2313
	return NULL;
}
J
Jeff King 已提交
2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337

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

2338
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
{
	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)
2367
		return xstrdup(refname);
J
Jeff King 已提交
2368

2369 2370
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
2371 2372 2373 2374

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

2378
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
2379 2380 2381 2382
			continue;

		short_name_len = strlen(short_name);

2383 2384 2385 2386 2387 2388 2389
		/*
		 * 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 已提交
2390 2391 2392 2393
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
2394
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
2395 2396 2397
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

2398 2399 2400 2401
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
2402 2403 2404 2405 2406 2407 2408
			/*
			 * 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);
2409
			if (ref_exists(refname))
J
Jeff King 已提交
2410 2411 2412 2413 2414 2415 2416
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
2417
		if (j == rules_to_fail)
J
Jeff King 已提交
2418 2419 2420 2421
			return short_name;
	}

	free(short_name);
2422
	return xstrdup(refname);
J
Jeff King 已提交
2423
}