refs.c 62.7 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 177 178 179
static struct ref_dir *get_ref_dir(struct ref_entry *entry)
{
	assert(entry->flag & REF_DIR);
	return &entry->u.subdir;
}

180 181 182
static struct ref_entry *create_ref_entry(const char *refname,
					  const unsigned char *sha1, int flag,
					  int check_name)
183 184
{
	int len;
185
	struct ref_entry *ref;
186

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

199 200
static void clear_ref_dir(struct ref_dir *dir);

201 202
static void free_ref_entry(struct ref_entry *entry)
{
203
	if (entry->flag & REF_DIR)
204
		clear_ref_dir(get_ref_dir(entry));
205 206 207
	free(entry);
}

208 209 210 211 212 213
/*
 * 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)
214
{
215 216
	ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
	dir->entries[dir->nr++] = entry;
217 218
}

219 220 221
/*
 * Clear and free all entries in dir, recursively.
 */
222
static void clear_ref_dir(struct ref_dir *dir)
223 224
{
	int i;
225 226 227 228 229
	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;
230 231
}

232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
/*
 * 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;
}

247
static int ref_entry_cmp(const void *a, const void *b)
248
{
249 250 251 252
	struct ref_entry *one = *(struct ref_entry **)a;
	struct ref_entry *two = *(struct ref_entry **)b;
	return strcmp(one->name, two->name);
}
253

254
static void sort_ref_dir(struct ref_dir *dir);
255

256 257 258 259 260
/*
 * 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.
 */
261
static struct ref_entry *search_ref_dir(struct ref_dir *dir, const char *refname)
262 263 264 265
{
	struct ref_entry *e, **r;
	int len;

266
	if (refname == NULL || !dir->nr)
267 268
		return NULL;

269
	sort_ref_dir(dir);
270

271 272 273 274
	len = strlen(refname) + 1;
	e = xmalloc(sizeof(struct ref_entry) + len);
	memcpy(e->name, refname, len);

275
	r = bsearch(&e, dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
276 277 278 279 280 281 282 283 284

	free(e);

	if (r == NULL)
		return NULL;

	return *r;
}

285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
/*
 * 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;
}

306 307 308 309 310 311 312 313 314 315 316 317
/*
 * 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)
{
318 319 320 321 322 323 324 325 326
	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);
327 328
		if (!entry)
			break;
329
		dir = get_ref_dir(entry);
330 331
	}

332
	strbuf_release(&dirname);
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 359 360 361 362 363 364
	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;
}

365 366 367 368 369 370 371
/*
 * 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)
{
372
	if (strcmp(ref1->name, ref2->name))
373
		return 0;
374 375 376 377 378 379 380 381 382 383 384 385

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

388
/*
389 390
 * Sort the entries in dir non-recursively (if they are not already
 * sorted) and remove any duplicate entries.
391
 */
392
static void sort_ref_dir(struct ref_dir *dir)
393
{
394
	int i, j;
395
	struct ref_entry *last = NULL;
396

397 398 399 400
	/*
	 * This check also prevents passing a zero-length array to qsort(),
	 * which is a problem on some platforms.
	 */
401
	if (dir->sorted == dir->nr)
402
		return;
403

404
	qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
405

406 407 408 409 410 411 412
	/* 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;
413
	}
414
	dir->sorted = dir->nr = i;
415
}
416

417
#define DO_FOR_EACH_INCLUDE_BROKEN 01
418

419
static struct ref_entry *current_ref;
420

421 422 423
static int do_one_ref(const char *base, each_ref_fn fn, int trim,
		      int flags, void *cb_data, struct ref_entry *entry)
{
424
	int retval;
425 426
	if (prefixcmp(entry->name, base))
		return 0;
427

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

442
/*
443
 * Call fn for each reference in dir that has index in the range
444 445 446
 * 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.
447
 */
448 449 450
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)
451 452
{
	int i;
453 454
	assert(dir->sorted == dir->nr);
	for (i = offset; i < dir->nr; i++) {
455 456 457
		struct ref_entry *entry = dir->entries[i];
		int retval;
		if (entry->flag & REF_DIR) {
458 459 460
			struct ref_dir *subdir = get_ref_dir(entry);
			sort_ref_dir(subdir);
			retval = do_for_each_ref_in_dir(subdir, 0,
461 462 463 464
							base, fn, trim, flags, cb_data);
		} else {
			retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
		}
465 466 467 468 469 470
		if (retval)
			return retval;
	}
	return 0;
}

471
/*
472
 * Call fn for each reference in the union of dir1 and dir2, in order
473 474 475 476
 * 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.
477
 */
478 479 480 481
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)
482 483 484 485
{
	int retval;
	int i1 = 0, i2 = 0;

486 487
	assert(dir1->sorted == dir1->nr);
	assert(dir2->sorted == dir2->nr);
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
	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. */
505 506 507 508
				struct ref_dir *subdir1 = get_ref_dir(e1);
				struct ref_dir *subdir2 = get_ref_dir(e2);
				sort_ref_dir(subdir1);
				sort_ref_dir(subdir2);
509
				retval = do_for_each_ref_in_dirs(
510
						subdir1, subdir2,
511 512 513 514 515 516 517 518 519 520 521 522
						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);
			}
523
		} else {
524 525 526
			struct ref_entry *e;
			if (cmp < 0) {
				e = e1;
527
				i1++;
528 529 530 531 532
			} else {
				e = e2;
				i2++;
			}
			if (e->flag & REF_DIR) {
533 534
				struct ref_dir *subdir = get_ref_dir(e);
				sort_ref_dir(subdir);
535
				retval = do_for_each_ref_in_dir(
536
						subdir, 0,
537 538 539
						base, fn, trim, flags, cb_data);
			} else {
				retval = do_one_ref(base, fn, trim, flags, cb_data, e);
540 541 542 543 544
			}
		}
		if (retval)
			return retval;
	}
545 546 547 548 549 550
	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);
551 552 553
	return 0;
}

554 555 556 557 558 559 560 561 562
/*
 * 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)
{
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
	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;
584
	}
585
	return 0;
586 587
}

588 589
/*
 * Return true iff a reference named refname could be created without
590 591 592
 * 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
593 594 595
 * operation).
 */
static int is_refname_available(const char *refname, const char *oldrefname,
596
				struct ref_dir *dir)
597
{
598 599 600 601 602
	struct name_conflict_cb data;
	data.refname = refname;
	data.oldrefname = oldrefname;
	data.conflicting_refname = NULL;

603 604 605 606
	sort_ref_dir(dir);
	if (do_for_each_ref_in_dir(dir, 0, "", name_conflict_fn,
				   0, DO_FOR_EACH_INCLUDE_BROKEN,
				   &data)) {
607 608 609
		error("'%s' exists; cannot create '%s'",
		      data.conflicting_refname, refname);
		return 0;
610 611
	}
	return 1;
612 613
}

614 615 616 617
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
618 619
static struct ref_cache {
	struct ref_cache *next;
620 621
	struct ref_entry *loose;
	struct ref_entry *packed;
622 623
	/* The submodule name, or "" for the main repo. */
	char name[FLEX_ARRAY];
624
} *ref_cache;
625

626
static void clear_packed_ref_cache(struct ref_cache *refs)
627
{
628 629 630 631
	if (refs->packed) {
		free_ref_entry(refs->packed);
		refs->packed = NULL;
	}
632
}
633

634 635
static void clear_loose_ref_cache(struct ref_cache *refs)
{
636 637 638 639
	if (refs->loose) {
		free_ref_entry(refs->loose);
		refs->loose = NULL;
	}
640 641
}

642
static struct ref_cache *create_ref_cache(const char *submodule)
643
{
644
	int len;
645
	struct ref_cache *refs;
646 647 648
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
649
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
650
	memcpy(refs->name, submodule, len);
651 652 653
	return refs;
}

654
/*
655
 * Return a pointer to a ref_cache for the specified submodule. For
656 657 658 659
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
660
static struct ref_cache *get_ref_cache(const char *submodule)
661
{
662
	struct ref_cache *refs = ref_cache;
663 664 665 666 667 668
	if (!submodule)
		submodule = "";
	while (refs) {
		if (!strcmp(submodule, refs->name))
			return refs;
		refs = refs->next;
669
	}
670

671 672 673
	refs = create_ref_cache(submodule);
	refs->next = ref_cache;
	ref_cache = refs;
674
	return refs;
675 676
}

677
void invalidate_ref_cache(const char *submodule)
678
{
679 680 681
	struct ref_cache *refs = get_ref_cache(submodule);
	clear_packed_ref_cache(refs);
	clear_loose_ref_cache(refs);
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 707 708 709 710 711 712 713 714 715 716
/*
 * 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;
}

717
static void read_packed_refs(FILE *f, struct ref_dir *dir)
718
{
719
	struct ref_entry *last = NULL;
720 721 722 723 724
	char refline[PATH_MAX];
	int flag = REF_ISPACKED;

	while (fgets(refline, sizeof(refline), f)) {
		unsigned char sha1[20];
725
		const char *refname;
726 727 728 729 730 731 732 733 734 735
		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;
		}

736 737
		refname = parse_ref_line(refline, sha1);
		if (refname) {
738
			last = create_ref_entry(refname, sha1, flag, 1);
739
			add_ref(dir, last);
740 741 742 743 744 745 746
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
		    strlen(refline) == 42 &&
		    refline[41] == '\n' &&
		    !get_sha1_hex(refline + 1, sha1))
747
			hashcpy(last->u.value.peeled, sha1);
748 749 750
	}
}

751
static struct ref_dir *get_packed_refs(struct ref_cache *refs)
752
{
753
	if (!refs->packed) {
754 755
		const char *packed_refs_file;
		FILE *f;
756

757
		refs->packed = create_dir_entry("");
758 759
		if (*refs->name)
			packed_refs_file = git_path_submodule(refs->name, "packed-refs");
760 761 762
		else
			packed_refs_file = git_path("packed-refs");
		f = fopen(packed_refs_file, "r");
763
		if (f) {
764
			read_packed_refs(f, get_ref_dir(refs->packed));
765 766 767
			fclose(f);
		}
	}
768
	return get_ref_dir(refs->packed);
769 770
}

771 772 773 774 775 776
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));
}

777 778
/*
 * Read the loose references for refs from the namespace dirname.
779 780
 * dirname must end with '/'.  dir must be the directory entry
 * corresponding to dirname.
781
 */
782 783
static void read_loose_refs(struct ref_cache *refs, const char *dirname,
			    struct ref_dir *dir)
784
{
785
	DIR *d;
786
	const char *path;
787
	struct dirent *de;
788
	int dirnamelen = strlen(dirname);
789
	struct strbuf refname;
790

M
Michael Haggerty 已提交
791
	if (*refs->name)
792
		path = git_path_submodule(refs->name, "%s", dirname);
793
	else
794
		path = git_path("%s", dirname);
795

796
	d = opendir(path);
797 798 799
	if (!d)
		return;

800 801
	strbuf_init(&refname, dirnamelen + 257);
	strbuf_add(&refname, dirname, dirnamelen);
802 803 804 805 806 807 808 809 810 811 812

	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;
813
		strbuf_addstr(&refname, de->d_name);
814
		refdir = *refs->name
815 816 817 818 819
			? 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)) {
820
			strbuf_addch(&refname, '/');
821
			read_loose_refs(refs, refname.buf,
822
					get_ref_dir(search_for_subdir(dir, refname.buf, 1)));
823 824 825 826 827 828 829 830 831
		} 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)) {
832 833 834
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
835 836
			add_entry_to_dir(dir,
					 create_ref_entry(refname.buf, sha1, flag, 1));
837
		}
838
		strbuf_setlen(&refname, dirnamelen);
839
	}
840
	strbuf_release(&refname);
841
	closedir(d);
842 843
}

844
static struct ref_dir *get_loose_refs(struct ref_cache *refs)
845
{
846 847
	if (!refs->loose) {
		refs->loose = create_dir_entry("");
848
		read_loose_refs(refs, "refs/",
849 850
				get_ref_dir(search_for_subdir(get_ref_dir(refs->loose),
							      "refs/", 1)));
851
	}
852
	return get_ref_dir(refs->loose);
853 854
}

855 856
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
857 858
#define MAXREFLEN (1024)

859 860
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
861 862
 * from the loose refs in ref_cache refs. Find <refname> in the
 * packed-refs file for the submodule.
863
 */
864
static int resolve_gitlink_packed_ref(struct ref_cache *refs,
865
				      const char *refname, unsigned char *sha1)
866
{
867
	struct ref_entry *ref;
868
	struct ref_dir *dir = get_packed_refs(refs);
869

870
	ref = find_ref(dir, refname);
871 872 873
	if (ref == NULL)
		return -1;

874
	memcpy(sha1, ref->u.value.sha1, 20);
875
	return 0;
876 877
}

878
static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
879
					 const char *refname, unsigned char *sha1,
880
					 int recursion)
881
{
882
	int fd, len;
883
	char buffer[128], *p;
884
	char *path;
885

886
	if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
887
		return -1;
888 889 890 891
	path = *refs->name
		? git_path_submodule(refs->name, "%s", refname)
		: git_path("%s", refname);
	fd = open(path, O_RDONLY);
892
	if (fd < 0)
893
		return resolve_gitlink_packed_ref(refs, refname, sha1);
894 895 896 897 898 899 900 901 902 903

	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? */
904
	if (!get_sha1_hex(buffer, sha1))
905 906 907 908 909 910 911 912 913
		return 0;

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

914
	return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
915 916
}

917
int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
918 919
{
	int len = strlen(path), retval;
920
	char *submodule;
921
	struct ref_cache *refs;
922 923 924 925 926

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
927 928 929 930
	submodule = xstrndup(path, len);
	refs = get_ref_cache(submodule);
	free(submodule);

931
	retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
932 933
	return retval;
}
934

935
/*
936 937
 * Try to read ref from the packed references.  On success, set sha1
 * and return 0; otherwise, return -1.
938
 */
939
static int get_packed_ref(const char *refname, unsigned char *sha1)
940
{
941
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
942
	struct ref_entry *entry = find_ref(packed, refname);
943
	if (entry) {
944
		hashcpy(sha1, entry->u.value.sha1);
945
		return 0;
946 947 948 949
	}
	return -1;
}

J
Junio C Hamano 已提交
950
const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
951
{
952 953
	int depth = MAXDEPTH;
	ssize_t len;
954
	char buffer[256];
955
	static char refname_buffer[256];
956

957 958 959
	if (flag)
		*flag = 0;

960
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
961 962
		return NULL;

963
	for (;;) {
964
		char path[PATH_MAX];
965 966 967
		struct stat st;
		char *buf;
		int fd;
968

969 970
		if (--depth < 0)
			return NULL;
971

972
		git_snpath(path, sizeof(path), "%s", refname);
973

974
		if (lstat(path, &st) < 0) {
975 976 977 978 979 980
			if (errno != ENOENT)
				return NULL;
			/*
			 * The loose reference file does not exist;
			 * check for a packed reference.
			 */
981
			if (!get_packed_ref(refname, sha1)) {
982 983
				if (flag)
					*flag |= REF_ISPACKED;
984
				return refname;
985
			}
986 987
			/* The reference is not a packed reference, either. */
			if (reading) {
988
				return NULL;
989 990
			} else {
				hashclr(sha1);
991
				return refname;
992
			}
993
		}
994

995 996 997
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
998 999
			if (len < 0)
				return NULL;
M
Michael Haggerty 已提交
1000
			buffer[len] = 0;
1001 1002
			if (!prefixcmp(buffer, "refs/") &&
					!check_refname_format(buffer, 0)) {
1003 1004
				strcpy(refname_buffer, buffer);
				refname = refname_buffer;
1005 1006
				if (flag)
					*flag |= REF_ISSYMREF;
1007 1008
				continue;
			}
1009
		}
1010

1011 1012 1013 1014 1015 1016
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

1017 1018 1019 1020 1021 1022 1023
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
		if (fd < 0)
			return NULL;
1024
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
1025
		close(fd);
1026 1027 1028 1029 1030
		if (len < 0)
			return NULL;
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
1031 1032 1033 1034

		/*
		 * Is it a symbolic ref?
		 */
1035
		if (prefixcmp(buffer, "ref:"))
1036
			break;
1037 1038
		if (flag)
			*flag |= REF_ISSYMREF;
1039
		buf = buffer + 4;
1040 1041
		while (isspace(*buf))
			buf++;
1042
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1043 1044
			if (flag)
				*flag |= REF_ISBROKEN;
1045 1046
			return NULL;
		}
1047
		refname = strcpy(refname_buffer, buf);
1048
	}
1049 1050
	/* Please note that FETCH_HEAD has a second line containing other data. */
	if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1051 1052
		if (flag)
			*flag |= REF_ISBROKEN;
1053
		return NULL;
1054
	}
1055
	return refname;
1056 1057
}

1058 1059
char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
{
1060
	const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1061 1062 1063
	return ret ? xstrdup(ret) : NULL;
}

I
Ilari Liusvaara 已提交
1064 1065 1066 1067 1068 1069 1070
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

1071
int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1072
{
J
Junio C Hamano 已提交
1073
	if (resolve_ref_unsafe(refname, sha1, reading, flags))
1074 1075
		return 0;
	return -1;
1076 1077
}

1078
int read_ref(const char *refname, unsigned char *sha1)
1079
{
1080
	return read_ref_full(refname, sha1, 1, NULL);
1081 1082
}

1083
int ref_exists(const char *refname)
1084
{
1085 1086
	unsigned char sha1[20];
	return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1087 1088
}

1089
static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1090
		       void *data)
I
Ilari Liusvaara 已提交
1091 1092
{
	struct ref_filter *filter = (struct ref_filter *)data;
1093
	if (fnmatch(filter->pattern, refname, 0))
I
Ilari Liusvaara 已提交
1094
		return 0;
1095
	return filter->fn(refname, sha1, flags, filter->cb_data);
I
Ilari Liusvaara 已提交
1096 1097
}

1098
int peel_ref(const char *refname, unsigned char *sha1)
1099 1100 1101 1102 1103
{
	int flag;
	unsigned char base[20];
	struct object *o;

1104 1105
	if (current_ref && (current_ref->name == refname
		|| !strcmp(current_ref->name, refname))) {
1106
		if (current_ref->flag & REF_KNOWS_PEELED) {
1107
			hashcpy(sha1, current_ref->u.value.peeled);
1108 1109
			return 0;
		}
1110
		hashcpy(base, current_ref->u.value.sha1);
1111 1112 1113
		goto fallback;
	}

1114
	if (read_ref_full(refname, base, 1, &flag))
1115 1116 1117
		return -1;

	if ((flag & REF_ISPACKED)) {
1118
		struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
1119
		struct ref_entry *r = find_ref(dir, refname);
1120

1121
		if (r != NULL && r->flag & REF_KNOWS_PEELED) {
1122
			hashcpy(sha1, r->u.value.peeled);
1123
			return 0;
1124 1125 1126
		}
	}

1127
fallback:
1128
	o = parse_object(base);
1129
	if (o && o->type == OBJ_TAG) {
1130
		o = deref_tag(o, refname, 0);
1131 1132 1133 1134 1135 1136 1137 1138
		if (o) {
			hashcpy(sha1, o->sha1);
			return 0;
		}
	}
	return -1;
}

1139 1140 1141 1142 1143 1144 1145 1146 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
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);
}

1173 1174
static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
			   int trim, int flags, void *cb_data)
1175
{
1176
	struct ref_cache *refs = get_ref_cache(submodule);
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
	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;
1205 1206
}

1207
static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1208 1209
{
	unsigned char sha1[20];
1210 1211
	int flag;

1212 1213 1214 1215 1216 1217 1218
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

1219
	if (!read_ref_full("HEAD", sha1, 1, &flag))
1220
		return fn("HEAD", sha1, flag, cb_data);
1221

1222
	return 0;
1223 1224
}

1225 1226 1227 1228 1229
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

1230 1231 1232 1233 1234
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

1235
int for_each_ref(each_ref_fn fn, void *cb_data)
1236
{
1237
	return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1238 1239
}

1240 1241
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
1242
	return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1243 1244
}

1245 1246
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
1247
	return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1248 1249
}

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

1256
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1257
{
1258
	return for_each_ref_in("refs/tags/", fn, cb_data);
1259 1260
}

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

1266
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1267
{
1268
	return for_each_ref_in("refs/heads/", fn, cb_data);
1269 1270
}

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

1276
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1277
{
1278
	return for_each_ref_in("refs/remotes/", fn, cb_data);
1279 1280
}

1281 1282 1283 1284 1285
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);
}

1286 1287
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
1288
	return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
1289 1290
}

J
Josh Triplett 已提交
1291 1292 1293 1294 1295 1296 1297 1298
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());
1299
	if (!read_ref_full(buf.buf, sha1, 1, &flag))
J
Josh Triplett 已提交
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
		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;
}

1316 1317
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
1318 1319 1320 1321 1322
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

1323
	if (!prefix && prefixcmp(pattern, "refs/"))
I
Ilari Liusvaara 已提交
1324
		strbuf_addstr(&real_pattern, "refs/");
1325 1326
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
1327 1328
	strbuf_addstr(&real_pattern, pattern);

1329
	if (!has_glob_specials(pattern)) {
1330
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
		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;
}

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

1351 1352
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
1353
	return do_for_each_ref(NULL, "", fn, 0,
1354
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1355 1356
}

1357
const char *prettify_refname(const char *name)
1358 1359 1360 1361 1362 1363 1364 1365
{
	return name + (
		!prefixcmp(name, "refs/heads/") ? 11 :
		!prefixcmp(name, "refs/tags/") ? 10 :
		!prefixcmp(name, "refs/remotes/") ? 13 :
		0);
}

S
Steffen Prohaska 已提交
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
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 已提交
1390
static struct ref_lock *verify_lock(struct ref_lock *lock,
1391 1392
	const unsigned char *old_sha1, int mustexist)
{
1393
	if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1394
		error("Can't verify ref %s", lock->ref_name);
1395 1396 1397
		unlock_ref(lock);
		return NULL;
	}
1398
	if (hashcmp(lock->old_sha1, old_sha1)) {
1399
		error("Ref %s is at %s but expected %s", lock->ref_name,
1400 1401 1402 1403 1404 1405 1406
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
		return NULL;
	}
	return lock;
}

1407
static int remove_empty_directories(const char *file)
1408 1409 1410 1411 1412
{
	/* 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.
	 */
1413 1414
	struct strbuf path;
	int result;
1415

1416 1417 1418
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

1419
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1420 1421 1422 1423

	strbuf_release(&path);

	return result;
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 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460
/*
 * *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);
1461
		r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1462 1463 1464 1465 1466
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
1467
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1468
			warning("ignoring dangling symref %s.", fullref);
1469 1470 1471
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
	}
	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);
1491
		ref = resolve_ref_unsafe(path, hash, 1, NULL);
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
		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;
}

1514 1515 1516
static struct ref_lock *lock_ref_sha1_basic(const char *refname,
					    const unsigned char *old_sha1,
					    int flags, int *type_p)
1517
{
1518
	char *ref_file;
1519
	const char *orig_refname = refname;
1520
	struct ref_lock *lock;
1521
	int last_errno = 0;
1522
	int type, lflags;
1523
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1524
	int missing = 0;
1525 1526 1527 1528

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

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

1564
	lock->lk = xcalloc(1, sizeof(struct lock_file));
1565

1566 1567
	lflags = LOCK_DIE_ON_ERROR;
	if (flags & REF_NODEREF) {
1568
		refname = orig_refname;
1569 1570
		lflags |= LOCK_NODEREF;
	}
1571 1572 1573
	lock->ref_name = xstrdup(refname);
	lock->orig_ref_name = xstrdup(orig_refname);
	ref_file = git_path("%s", refname);
1574
	if (missing)
1575 1576 1577
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
1578

1579 1580 1581 1582 1583
	if (safe_create_leading_directories(ref_file)) {
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
1584

1585
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1586
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1587 1588 1589 1590 1591

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
1592 1593
}

1594
struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
D
Daniel Barkalow 已提交
1595
{
P
Petr Baudis 已提交
1596
	char refpath[PATH_MAX];
1597
	if (check_refname_format(refname, 0))
1598
		return NULL;
1599
	strcpy(refpath, mkpath("refs/%s", refname));
1600
	return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1601 1602
}

1603 1604
struct ref_lock *lock_any_ref_for_update(const char *refname,
					 const unsigned char *old_sha1, int flags)
1605
{
1606
	if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1607
		return NULL;
1608
	return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
J
Junio C Hamano 已提交
1609 1610
}

1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
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;
}

1634 1635
static struct lock_file packlock;

J
Junio C Hamano 已提交
1636 1637
static int repack_without_ref(const char *refname)
{
1638
	struct repack_without_ref_sb data;
1639
	struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1640
	if (find_ref(packed, refname) == NULL)
J
Junio C Hamano 已提交
1641
		return 0;
1642 1643 1644
	data.refname = refname;
	data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
	if (data.fd < 0) {
1645
		unable_to_lock_error(git_path("packed-refs"), errno);
J
Junio C Hamano 已提交
1646
		return error("cannot delete '%s' from packed refs", refname);
1647
	}
1648
	do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
J
Junio C Hamano 已提交
1649 1650 1651
	return commit_lock_file(&packlock);
}

M
Miklos Vajna 已提交
1652
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
1653 1654
{
	struct ref_lock *lock;
M
Miklos Vajna 已提交
1655
	int err, i = 0, ret = 0, flag = 0;
J
Junio C Hamano 已提交
1656

1657
	lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
J
Junio C Hamano 已提交
1658 1659
	if (!lock)
		return 1;
1660
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
J
Junio C Hamano 已提交
1661
		/* loose */
M
Miklos Vajna 已提交
1662 1663 1664 1665 1666 1667 1668
		const char *path;

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

M
Miklos Vajna 已提交
1675 1676
		if (!(delopt & REF_NODEREF))
			lock->lk->filename[i] = '.';
J
Junio C Hamano 已提交
1677 1678 1679 1680 1681 1682 1683
	}
	/* 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);

1684
	unlink_or_warn(git_path("logs/%s", lock->ref_name));
1685
	invalidate_ref_cache(NULL);
J
Junio C Hamano 已提交
1686 1687
	unlock_ref(lock);
	return ret;
1688 1689
}

1690 1691 1692 1693 1694 1695 1696 1697 1698
/*
 * 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"

1699
int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1700 1701 1702 1703 1704
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
1705
	int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
M
Miklos Vajna 已提交
1706
	const char *symref = NULL;
1707
	struct ref_cache *refs = get_ref_cache(NULL);
1708

1709
	if (log && S_ISLNK(loginfo.st_mode))
1710
		return error("reflog for %s is a symlink", oldrefname);
1711

J
Junio C Hamano 已提交
1712
	symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
M
Miklos Vajna 已提交
1713
	if (flag & REF_ISSYMREF)
1714
		return error("refname %s is a symbolic ref, renaming it is not supported",
1715
			oldrefname);
M
Miklos Vajna 已提交
1716
	if (!symref)
1717
		return error("refname %s not found", oldrefname);
1718

1719
	if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1720 1721
		return 1;

1722
	if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1723 1724
		return 1;

1725
	if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1726
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1727
			oldrefname, strerror(errno));
1728

1729 1730
	if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
		error("unable to delete old %s", oldrefname);
1731 1732 1733
		goto rollback;
	}

1734 1735
	if (!read_ref_full(newrefname, sha1, 1, &flag) &&
	    delete_ref(newrefname, sha1, REF_NODEREF)) {
1736
		if (errno==EISDIR) {
1737 1738
			if (remove_empty_directories(git_path("%s", newrefname))) {
				error("Directory not empty: %s", newrefname);
1739 1740 1741
				goto rollback;
			}
		} else {
1742
			error("unable to delete existing %s", newrefname);
1743 1744 1745 1746
			goto rollback;
		}
	}

1747 1748
	if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
		error("unable to create directory for %s", newrefname);
1749 1750 1751 1752
		goto rollback;
	}

 retry:
1753
	if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1754 1755 1756 1757 1758 1759
		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.
			 */
1760 1761
			if (remove_empty_directories(git_path("logs/%s", newrefname))) {
				error("Directory not empty: logs/%s", newrefname);
1762 1763 1764 1765
				goto rollback;
			}
			goto retry;
		} else {
1766
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1767
				newrefname, strerror(errno));
1768 1769 1770 1771 1772
			goto rollback;
		}
	}
	logmoved = log;

1773
	lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1774
	if (!lock) {
1775
		error("unable to lock %s for update", newrefname);
1776 1777 1778 1779
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
1780
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1781
		error("unable to write current sha1 into %s", newrefname);
1782 1783 1784 1785 1786 1787
		goto rollback;
	}

	return 0;

 rollback:
1788
	lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1789
	if (!lock) {
1790
		error("unable to lock %s for rollback", oldrefname);
1791 1792 1793 1794 1795 1796 1797
		goto rollbacklog;
	}

	lock->force_write = 1;
	flag = log_all_ref_updates;
	log_all_ref_updates = 0;
	if (write_ref_sha1(lock, orig_sha1, NULL))
1798
		error("unable to write current sha1 into %s", oldrefname);
1799 1800 1801
	log_all_ref_updates = flag;

 rollbacklog:
1802
	if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1803
		error("unable to restore logfile %s from %s: %s",
1804
			oldrefname, newrefname, strerror(errno));
1805
	if (!logmoved && log &&
1806
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1807
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1808
			oldrefname, strerror(errno));
1809 1810 1811 1812

	return 1;
}

1813
int close_ref(struct ref_lock *lock)
1814 1815 1816 1817 1818 1819 1820
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

1821
int commit_ref(struct ref_lock *lock)
1822 1823 1824 1825 1826 1827 1828
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
1829
void unlock_ref(struct ref_lock *lock)
1830
{
B
Brandon Casey 已提交
1831 1832 1833
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
1834
	free(lock->ref_name);
1835
	free(lock->orig_ref_name);
1836 1837 1838
	free(lock);
}

1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
/*
 * 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;
}

1865
int log_ref_setup(const char *refname, char *logfile, int bufsize)
1866
{
1867
	int logfd, oflags = O_APPEND | O_WRONLY;
1868

1869
	git_snpath(logfile, bufsize, "logs/%s", refname);
1870
	if (log_all_ref_updates &&
1871 1872 1873 1874
	    (!prefixcmp(refname, "refs/heads/") ||
	     !prefixcmp(refname, "refs/remotes/") ||
	     !prefixcmp(refname, "refs/notes/") ||
	     !strcmp(refname, "HEAD"))) {
1875
		if (safe_create_leading_directories(logfile) < 0)
1876
			return error("unable to create directory for %s",
1877
				     logfile);
1878 1879 1880
		oflags |= O_CREAT;
	}

1881
	logfd = open(logfile, oflags, 0666);
1882
	if (logfd < 0) {
J
Junio C Hamano 已提交
1883
		if (!(oflags & O_CREAT) && errno == ENOENT)
1884
			return 0;
1885 1886

		if ((oflags & O_CREAT) && errno == EISDIR) {
1887
			if (remove_empty_directories(logfile)) {
1888
				return error("There are still logs under '%s'",
1889
					     logfile);
1890
			}
1891
			logfd = open(logfile, oflags, 0666);
1892 1893 1894 1895
		}

		if (logfd < 0)
			return error("Unable to append to %s: %s",
1896
				     logfile, strerror(errno));
1897 1898
	}

1899
	adjust_shared_perm(logfile);
1900 1901 1902
	close(logfd);
	return 0;
}
1903

1904
static int log_ref_write(const char *refname, const unsigned char *old_sha1,
1905 1906 1907 1908 1909
			 const unsigned char *new_sha1, const char *msg)
{
	int logfd, result, written, oflags = O_APPEND | O_WRONLY;
	unsigned maxlen, len;
	int msglen;
1910
	char log_file[PATH_MAX];
1911 1912 1913 1914 1915 1916
	char *logrec;
	const char *committer;

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

1917
	result = log_ref_setup(refname, log_file, sizeof(log_file));
1918 1919 1920 1921 1922 1923
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
1924
	msglen = msg ? strlen(msg) : 0;
1925
	committer = git_committer_info(0);
1926 1927 1928
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
1929 1930
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
1931 1932
		      committer);
	if (msglen)
1933
		len += copy_msg(logrec + len - 1, msg) - 1;
1934
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1935
	free(logrec);
1936
	if (close(logfd) != 0 || written != len)
1937
		return error("Unable to append to %s", log_file);
1938 1939 1940
	return 0;
}

1941 1942 1943 1944 1945
static int is_branch(const char *refname)
{
	return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
}

1946 1947 1948 1949
int write_ref_sha1(struct ref_lock *lock,
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
1950
	struct object *o;
1951 1952

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

2015 2016
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
2017 2018 2019 2020
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
2021
	char *git_HEAD = git_pathdup("%s", ref_target);
2022 2023 2024 2025
	unsigned char old_sha1[20], new_sha1[20];

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

2027 2028 2029
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

2030 2031 2032 2033
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
2034
			goto done;
2035 2036 2037 2038 2039 2040 2041
		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);
2042
		goto error_free_return;
2043 2044 2045 2046 2047
	}
	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);
2048
		goto error_free_return;
2049 2050
	}
	written = write_in_full(fd, ref, len);
2051
	if (close(fd) != 0 || written != len) {
2052
		error("Unable to write to %s", lockpath);
2053
		goto error_unlink_return;
2054 2055 2056
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
2057
		goto error_unlink_return;
2058 2059 2060
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
2061
	error_unlink_return:
2062
		unlink_or_warn(lockpath);
2063 2064 2065
	error_free_return:
		free(git_HEAD);
		return -1;
2066
	}
2067

2068
#ifndef NO_SYMLINK_HEAD
2069
	done:
2070
#endif
2071 2072 2073
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

2074
	free(git_HEAD);
2075 2076 2077
	return 0;
}

2078 2079 2080 2081
static char *ref_msg(const char *line, const char *endp)
{
	const char *ep;
	line += 82;
P
Pierre Habouzit 已提交
2082 2083 2084 2085
	ep = memchr(line, '\n', endp - line);
	if (!ep)
		ep = endp;
	return xmemdupz(line, ep - line);
2086 2087
}

2088 2089 2090
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)
2091
{
2092
	const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2093
	char *tz_c;
J
Junio C Hamano 已提交
2094
	int logfd, tz, reccnt = 0;
2095 2096
	struct stat st;
	unsigned long date;
2097
	unsigned char logged_sha1[20];
2098
	void *log_mapped;
2099
	size_t mapsz;
2100

2101
	logfile = git_path("logs/%s", refname);
2102 2103
	logfd = open(logfile, O_RDONLY, 0);
	if (logfd < 0)
2104
		die_errno("Unable to read log '%s'", logfile);
2105 2106 2107
	fstat(logfd, &st);
	if (!st.st_size)
		die("Log %s is empty.", logfile);
2108 2109
	mapsz = xsize_t(st.st_size);
	log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2110
	logdata = log_mapped;
2111 2112
	close(logfd);

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

2168 2169 2170 2171
	rec = logdata;
	while (rec < logend && *rec != '>' && *rec != '\n')
		rec++;
	if (rec == logend || *rec == '\n')
2172
		die("Log %s is corrupt.", logfile);
2173
	date = strtoul(rec + 1, &tz_c, 10);
2174 2175 2176
	tz = strtoul(tz_c, NULL, 10);
	if (get_sha1_hex(logdata, sha1))
		die("Log %s is corrupt.", logfile);
J
Jeff King 已提交
2177 2178 2179 2180
	if (is_null_sha1(sha1)) {
		if (get_sha1_hex(logdata + 41, sha1))
			die("Log %s is corrupt.", logfile);
	}
2181 2182
	if (msg)
		*msg = ref_msg(logdata, logend);
2183
	munmap(log_mapped, mapsz);
2184 2185 2186 2187 2188 2189 2190 2191

	if (cutoff_time)
		*cutoff_time = date;
	if (cutoff_tz)
		*cutoff_tz = tz;
	if (cutoff_cnt)
		*cutoff_cnt = reccnt;
	return 1;
2192
}
2193

2194
int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2195 2196 2197
{
	const char *logfile;
	FILE *logfp;
2198
	struct strbuf sb = STRBUF_INIT;
2199
	int ret = 0;
2200

2201
	logfile = git_path("logs/%s", refname);
2202 2203
	logfp = fopen(logfile, "r");
	if (!logfp)
2204
		return -1;
2205 2206 2207 2208 2209 2210

	if (ofs) {
		struct stat statbuf;
		if (fstat(fileno(logfp), &statbuf) ||
		    statbuf.st_size < ofs ||
		    fseek(logfp, -ofs, SEEK_END) ||
2211
		    strbuf_getwholeline(&sb, logfp, '\n')) {
2212
			fclose(logfp);
2213
			strbuf_release(&sb);
2214
			return -1;
2215
		}
2216 2217
	}

2218
	while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2219
		unsigned char osha1[20], nsha1[20];
2220 2221
		char *email_end, *message;
		unsigned long timestamp;
2222
		int tz;
2223 2224

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

2252
int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2253
{
2254
	return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
2255 2256
}

2257 2258 2259 2260 2261 2262
/*
 * 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)
2263
{
2264
	DIR *d = opendir(git_path("logs/%s", name->buf));
2265
	int retval = 0;
2266
	struct dirent *de;
2267
	int oldlen = name->len;
2268

2269
	if (!d)
2270
		return name->len ? errno : 0;
2271

2272 2273
	while ((de = readdir(d)) != NULL) {
		struct stat st;
2274

2275 2276 2277 2278
		if (de->d_name[0] == '.')
			continue;
		if (has_extension(de->d_name, ".lock"))
			continue;
2279 2280 2281
		strbuf_addstr(name, de->d_name);
		if (stat(git_path("logs/%s", name->buf), &st) < 0) {
			; /* silently ignore */
2282
		} else {
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294
			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;
2295
		}
2296
		strbuf_setlen(name, oldlen);
2297
	}
2298
	closedir(d);
2299 2300 2301 2302 2303
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
2304 2305 2306 2307 2308 2309
	int retval;
	struct strbuf name;
	strbuf_init(&name, PATH_MAX);
	retval = do_for_each_reflog(&name, fn, cb_data);
	strbuf_release(&name);
	return retval;
2310
}
C
Carlos Rica 已提交
2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337

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

2339
struct ref *find_ref_by_name(const struct ref *list, const char *name)
2340 2341 2342
{
	for ( ; list; list = list->next)
		if (!strcmp(list->name, name))
2343
			return (struct ref *)list;
2344 2345
	return NULL;
}
J
Jeff King 已提交
2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369

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

2370
char *shorten_unambiguous_ref(const char *refname, int strict)
J
Jeff King 已提交
2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398
{
	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)
2399
		return xstrdup(refname);
J
Jeff King 已提交
2400

2401 2402
	/* buffer for scanf result, at most refname must fit */
	short_name = xstrdup(refname);
J
Jeff King 已提交
2403 2404 2405 2406

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

2410
		if (1 != sscanf(refname, scanf_fmts[i], short_name))
J
Jeff King 已提交
2411 2412 2413 2414
			continue;

		short_name_len = strlen(short_name);

2415 2416 2417 2418 2419 2420 2421
		/*
		 * 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 已提交
2422 2423 2424 2425
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
2426
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
2427 2428 2429
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

2430 2431 2432 2433
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
2434 2435 2436 2437 2438 2439 2440
			/*
			 * 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);
2441
			if (ref_exists(refname))
J
Jeff King 已提交
2442 2443 2444 2445 2446 2447 2448
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
2449
		if (j == rules_to_fail)
J
Jeff King 已提交
2450 2451 2452 2453
			return short_name;
	}

	free(short_name);
2454
	return xstrdup(refname);
J
Jeff King 已提交
2455
}