refs.c 50.9 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
/* ISSYMREF=0x01, ISPACKED=0x02 and ISBROKEN=0x04 are public interfaces */
#define REF_KNOWS_PEELED 0x10
9

10
struct ref_entry {
11
	unsigned char flag; /* ISSYMREF? ISPACKED? */
12
	unsigned char sha1[20];
13
	unsigned char peeled[20];
14 15 16
	char name[FLEX_ARRAY];
};

17 18 19 20 21
struct ref_array {
	int nr, alloc;
	struct ref_entry **refs;
};

22
static const char *parse_ref_line(char *line, unsigned char *sha1)
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
{
	/*
	 * 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;
41 42
	if (isspace(*line))
		return NULL;
43 44 45
	if (line[len] != '\n')
		return NULL;
	line[len] = 0;
46

47 48 49
	return line;
}

50
static void add_ref(const char *name, const unsigned char *sha1,
51
		    int flag, int check_name, struct ref_array *refs,
52
		    struct ref_entry **new_entry)
53 54
{
	int len;
55
	struct ref_entry *entry;
56 57 58

	/* Allocate it and add it in.. */
	len = strlen(name) + 1;
59
	entry = xmalloc(sizeof(struct ref_entry) + len);
60
	hashcpy(entry->sha1, sha1);
61
	hashclr(entry->peeled);
62 63
	if (check_name &&
	    check_refname_format(name, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
64
		die("Reference has invalid format: '%s'", name);
65
	memcpy(entry->name, name, len);
66
	entry->flag = flag;
67 68
	if (new_entry)
		*new_entry = entry;
69 70
	ALLOC_GROW(refs->refs, refs->nr + 1, refs->alloc);
	refs->refs[refs->nr++] = entry;
71 72
}

73
static int ref_entry_cmp(const void *a, const void *b)
74
{
75 76 77 78
	struct ref_entry *one = *(struct ref_entry **)a;
	struct ref_entry *two = *(struct ref_entry **)b;
	return strcmp(one->name, two->name);
}
79

80 81 82
static void sort_ref_array(struct ref_array *array)
{
	int i = 0, j = 1;
83

84 85 86
	/* Nothing to sort unless there are at least two entries */
	if (array->nr < 2)
		return;
87

88
	qsort(array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
89

90 91 92 93 94 95 96 97 98
	/* Remove any duplicates from the ref_array */
	for (; j < array->nr; j++) {
		struct ref_entry *a = array->refs[i];
		struct ref_entry *b = array->refs[j];
		if (!strcmp(a->name, b->name)) {
			if (hashcmp(a->sha1, b->sha1))
				die("Duplicated ref, and SHA1s don't match: %s",
				    a->name);
			warning("Duplicated ref: %s", a->name);
99
			free(b);
100 101 102 103 104 105 106
			continue;
		}
		i++;
		array->refs[i] = array->refs[j];
	}
	array->nr = i + 1;
}
107

108 109 110 111
static struct ref_entry *search_ref_array(struct ref_array *array, const char *name)
{
	struct ref_entry *e, **r;
	int len;
112

113 114
	if (name == NULL)
		return NULL;
115

116 117
	if (!array->nr)
		return NULL;
118

119 120 121
	len = strlen(name) + 1;
	e = xmalloc(sizeof(struct ref_entry) + len);
	memcpy(e->name, name, len);
122

123
	r = bsearch(&e, array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
124

125
	free(e);
126

127 128
	if (r == NULL)
		return NULL;
129

130
	return *r;
131 132
}

133 134 135 136
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
137 138
static struct ref_cache {
	struct ref_cache *next;
139 140
	char did_loose;
	char did_packed;
141 142
	struct ref_array loose;
	struct ref_array packed;
143 144
	/* The submodule name, or "" for the main repo. */
	char name[FLEX_ARRAY];
145
} *ref_cache;
146

147
static struct ref_entry *current_ref;
148

149
static struct ref_array extra_refs;
150

151
static void free_ref_array(struct ref_array *array)
152
{
153 154 155 156 157 158
	int i;
	for (i = 0; i < array->nr; i++)
		free(array->refs[i]);
	free(array->refs);
	array->nr = array->alloc = 0;
	array->refs = NULL;
159 160
}

161
static void clear_packed_ref_cache(struct ref_cache *refs)
162
{
163 164
	if (refs->did_packed)
		free_ref_array(&refs->packed);
165
	refs->did_packed = 0;
166
}
167

168 169 170 171 172 173 174
static void clear_loose_ref_cache(struct ref_cache *refs)
{
	if (refs->did_loose)
		free_ref_array(&refs->loose);
	refs->did_loose = 0;
}

175
static struct ref_cache *create_ref_cache(const char *submodule)
176
{
177
	int len;
178
	struct ref_cache *refs;
179 180 181
	if (!submodule)
		submodule = "";
	len = strlen(submodule) + 1;
182
	refs = xcalloc(1, sizeof(struct ref_cache) + len);
183
	memcpy(refs->name, submodule, len);
184 185 186
	return refs;
}

187
/*
188
 * Return a pointer to a ref_cache for the specified submodule. For
189 190 191 192
 * the main repository, use submodule==NULL. The returned structure
 * will be allocated and initialized but not necessarily populated; it
 * should not be freed.
 */
193
static struct ref_cache *get_ref_cache(const char *submodule)
194
{
195
	struct ref_cache *refs = ref_cache;
196 197 198 199 200 201
	if (!submodule)
		submodule = "";
	while (refs) {
		if (!strcmp(submodule, refs->name))
			return refs;
		refs = refs->next;
202
	}
203

204 205 206
	refs = create_ref_cache(submodule);
	refs->next = ref_cache;
	ref_cache = refs;
207
	return refs;
208 209
}

210
void invalidate_ref_cache(const char *submodule)
211
{
212 213 214
	struct ref_cache *refs = get_ref_cache(submodule);
	clear_packed_ref_cache(refs);
	clear_loose_ref_cache(refs);
215
}
216

217
static void read_packed_refs(FILE *f, struct ref_array *array)
218
{
219
	struct ref_entry *last = NULL;
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
	char refline[PATH_MAX];
	int flag = REF_ISPACKED;

	while (fgets(refline, sizeof(refline), f)) {
		unsigned char sha1[20];
		const char *name;
		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;
		}

		name = parse_ref_line(refline, sha1);
		if (name) {
238
			add_ref(name, sha1, flag, 1, array, &last);
239 240 241 242 243 244 245 246 247
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
		    strlen(refline) == 42 &&
		    refline[41] == '\n' &&
		    !get_sha1_hex(refline + 1, sha1))
			hashcpy(last->peeled, sha1);
	}
248
	sort_ref_array(array);
249 250
}

251 252
void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
{
253
	add_ref(name, sha1, flag, 0, &extra_refs, NULL);
254 255 256 257
}

void clear_extra_refs(void)
{
258
	free_ref_array(&extra_refs);
259 260
}

261
static struct ref_array *get_packed_refs(const char *submodule)
262
{
263
	struct ref_cache *refs = get_ref_cache(submodule);
264

265 266 267
	if (!refs->did_packed) {
		const char *packed_refs_file;
		FILE *f;
268

269 270 271 272 273
		if (submodule)
			packed_refs_file = git_path_submodule(submodule, "packed-refs");
		else
			packed_refs_file = git_path("packed-refs");
		f = fopen(packed_refs_file, "r");
274
		if (f) {
275
			read_packed_refs(f, &refs->packed);
276 277
			fclose(f);
		}
278
		refs->did_packed = 1;
279
	}
280
	return &refs->packed;
281 282
}

283 284
static void get_ref_dir(const char *submodule, const char *base,
			struct ref_array *array)
285
{
286 287 288 289 290 291 292 293 294 295
	DIR *dir;
	const char *path;

	if (submodule)
		path = git_path_submodule(submodule, "%s", base);
	else
		path = git_path("%s", base);


	dir = opendir(path);
296 297 298 299

	if (dir) {
		struct dirent *de;
		int baselen = strlen(base);
L
Linus Torvalds 已提交
300
		char *ref = xmalloc(baselen + 257);
301

L
Linus Torvalds 已提交
302
		memcpy(ref, base, baselen);
303
		if (baselen && base[baselen-1] != '/')
L
Linus Torvalds 已提交
304
			ref[baselen++] = '/';
305 306 307 308

		while ((de = readdir(dir)) != NULL) {
			unsigned char sha1[20];
			struct stat st;
309
			int flag;
310
			int namelen;
311
			const char *refdir;
312 313 314 315 316 317 318 319

			if (de->d_name[0] == '.')
				continue;
			namelen = strlen(de->d_name);
			if (namelen > 255)
				continue;
			if (has_extension(de->d_name, ".lock"))
				continue;
L
Linus Torvalds 已提交
320
			memcpy(ref + baselen, de->d_name, namelen+1);
321 322 323 324
			refdir = submodule
				? git_path_submodule(submodule, "%s", ref)
				: git_path("%s", ref);
			if (stat(refdir, &st) < 0)
325 326
				continue;
			if (S_ISDIR(st.st_mode)) {
327
				get_ref_dir(submodule, ref, array);
328 329
				continue;
			}
330
			if (submodule) {
331
				hashclr(sha1);
332 333 334
				flag = 0;
				if (resolve_gitlink_ref(submodule, ref, sha1) < 0) {
					hashclr(sha1);
335
					flag |= REF_ISBROKEN;
336
				}
J
Junio C Hamano 已提交
337
			} else if (read_ref_full(ref, sha1, 1, &flag)) {
338 339 340 341
				hashclr(sha1);
				flag |= REF_ISBROKEN;
			}
			add_ref(ref, sha1, flag, 1, array, NULL);
342
		}
L
Linus Torvalds 已提交
343
		free(ref);
344 345 346 347
		closedir(dir);
	}
}

348
struct warn_if_dangling_data {
349
	FILE *fp;
350 351 352 353 354 355 356 357 358 359 360 361 362 363
	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;

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

368
	fprintf(d->fp, d->msg_fmt, refname);
369 370 371
	return 0;
}

372
void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
373
{
374 375 376 377 378
	struct warn_if_dangling_data data;

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

382
static struct ref_array *get_loose_refs(const char *submodule)
383
{
384
	struct ref_cache *refs = get_ref_cache(submodule);
385

386
	if (!refs->did_loose) {
387 388
		get_ref_dir(submodule, "refs", &refs->loose);
		sort_ref_array(&refs->loose);
389
		refs->did_loose = 1;
390
	}
391
	return &refs->loose;
392 393
}

394 395
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
396 397
#define MAXREFLEN (1024)

398 399 400 401 402
/*
 * Called by resolve_gitlink_ref_recursive() after it failed to read
 * from "name", which is "module/.git/<refname>". Find <refname> in
 * the packed-refs file for the submodule.
 */
403 404
static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
{
405
	int retval = -1;
406
	struct ref_entry *ref;
407
	struct ref_array *array;
408

409 410 411 412 413
	/* being defensive: resolve_gitlink_ref() did this for us */
	if (pathlen < 6 || memcmp(name + pathlen - 6, "/.git/", 6))
		die("Oops");
	name[pathlen - 6] = '\0'; /* make it path to the submodule */
	array = get_packed_refs(name);
414
	ref = search_ref_array(array, refname);
415 416 417
	if (ref != NULL) {
		memcpy(result, ref->sha1, 20);
		retval = 0;
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
	}
	return retval;
}

static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
{
	int fd, len = strlen(refname);
	char buffer[128], *p;

	if (recursion > MAXDEPTH || len > MAXREFLEN)
		return -1;
	memcpy(name + pathlen, refname, len+1);
	fd = open(name, O_RDONLY);
	if (fd < 0)
		return resolve_gitlink_packed_ref(name, pathlen, refname, result);

	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? */
	if (!get_sha1_hex(buffer, result))
		return 0;

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

	return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
}

int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
{
	int len = strlen(path), retval;
	char *gitdir;
460
	const char *tmp;
461 462 463 464 465 466 467

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
	gitdir = xmalloc(len + MAXREFLEN + 8);
	memcpy(gitdir, path, len);
468 469 470
	memcpy(gitdir + len, "/.git", 6);
	len += 5;

471
	tmp = read_gitfile(gitdir);
472 473 474 475 476 477 478 479 480
	if (tmp) {
		free(gitdir);
		len = strlen(tmp);
		gitdir = xmalloc(len + MAXREFLEN + 3);
		memcpy(gitdir, tmp, len);
	}
	gitdir[len] = '/';
	gitdir[++len] = '\0';
	retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
481 482 483
	free(gitdir);
	return retval;
}
484

485
/*
486 487
 * Try to read ref from the packed references.  On success, set sha1
 * and return 0; otherwise, return -1.
488
 */
489 490
static int get_packed_ref(const char *ref, unsigned char *sha1)
{
491 492 493 494 495
	struct ref_array *packed = get_packed_refs(NULL);
	struct ref_entry *entry = search_ref_array(packed, ref);
	if (entry) {
		hashcpy(sha1, entry->sha1);
		return 0;
496 497 498 499
	}
	return -1;
}

500
const char *resolve_ref_unsafe(const char *ref, unsigned char *sha1, int reading, int *flag)
501
{
502 503
	int depth = MAXDEPTH;
	ssize_t len;
504
	char buffer[256];
L
Linus Torvalds 已提交
505
	static char ref_buffer[256];
506

507 508 509
	if (flag)
		*flag = 0;

510 511 512
	if (check_refname_format(ref, REFNAME_ALLOW_ONELEVEL))
		return NULL;

513
	for (;;) {
514
		char path[PATH_MAX];
515 516 517
		struct stat st;
		char *buf;
		int fd;
518

519 520
		if (--depth < 0)
			return NULL;
521

522
		git_snpath(path, sizeof(path), "%s", ref);
523

524
		if (lstat(path, &st) < 0) {
525 526 527 528 529 530 531 532 533 534
			if (errno != ENOENT)
				return NULL;
			/*
			 * The loose reference file does not exist;
			 * check for a packed reference.
			 */
			if (!get_packed_ref(ref, sha1)) {
				if (flag)
					*flag |= REF_ISPACKED;
				return ref;
535
			}
536 537
			/* The reference is not a packed reference, either. */
			if (reading) {
538
				return NULL;
539 540 541 542
			} else {
				hashclr(sha1);
				return ref;
			}
543
		}
544

545 546 547
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
548 549
			if (len < 0)
				return NULL;
M
Michael Haggerty 已提交
550
			buffer[len] = 0;
551 552
			if (!prefixcmp(buffer, "refs/") &&
					!check_refname_format(buffer, 0)) {
L
Linus Torvalds 已提交
553 554
				strcpy(ref_buffer, buffer);
				ref = ref_buffer;
555 556
				if (flag)
					*flag |= REF_ISSYMREF;
557 558
				continue;
			}
559
		}
560

561 562 563 564 565 566
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

567 568 569 570 571 572 573
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
		if (fd < 0)
			return NULL;
574
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
575
		close(fd);
576 577 578 579 580
		if (len < 0)
			return NULL;
		while (len && isspace(buffer[len-1]))
			len--;
		buffer[len] = '\0';
581 582 583 584

		/*
		 * Is it a symbolic ref?
		 */
585
		if (prefixcmp(buffer, "ref:"))
586
			break;
587 588
		if (flag)
			*flag |= REF_ISSYMREF;
589
		buf = buffer + 4;
590 591
		while (isspace(*buf))
			buf++;
592
		if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
593 594
			if (flag)
				*flag |= REF_ISBROKEN;
595 596
			return NULL;
		}
597
		ref = strcpy(ref_buffer, buf);
598
	}
599 600
	/* Please note that FETCH_HEAD has a second line containing other data. */
	if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
601 602
		if (flag)
			*flag |= REF_ISBROKEN;
603
		return NULL;
604
	}
L
Linus Torvalds 已提交
605
	return ref;
606 607
}

608 609
char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
{
610
	const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
611 612 613
	return ret ? xstrdup(ret) : NULL;
}

I
Ilari Liusvaara 已提交
614 615 616 617 618 619 620
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

621
int read_ref_full(const char *ref, unsigned char *sha1, int reading, int *flags)
622
{
623
	if (resolve_ref_unsafe(ref, sha1, reading, flags))
624 625
		return 0;
	return -1;
626 627
}

628 629 630 631 632
int read_ref(const char *ref, unsigned char *sha1)
{
	return read_ref_full(ref, sha1, 1, NULL);
}

633
#define DO_FOR_EACH_INCLUDE_BROKEN 01
634
static int do_one_ref(const char *base, each_ref_fn fn, int trim,
635
		      int flags, void *cb_data, struct ref_entry *entry)
636
{
637
	if (prefixcmp(entry->name, base))
638
		return 0;
639

640
	if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
641 642
		if (entry->flag & REF_ISBROKEN)
			return 0; /* ignore broken refs e.g. dangling symref */
643 644 645 646
		if (!has_sha1_file(entry->sha1)) {
			error("%s does not point to a valid object!", entry->name);
			return 0;
		}
647
	}
648
	current_ref = entry;
649 650 651
	return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
}

I
Ilari Liusvaara 已提交
652 653 654 655 656 657 658 659 660
static int filter_refs(const char *ref, const unsigned char *sha, int flags,
	void *data)
{
	struct ref_filter *filter = (struct ref_filter *)data;
	if (fnmatch(filter->pattern, ref, 0))
		return 0;
	return filter->fn(ref, sha, flags, filter->cb_data);
}

661 662 663 664 665 666
int peel_ref(const char *ref, unsigned char *sha1)
{
	int flag;
	unsigned char base[20];
	struct object *o;

667 668 669 670 671 672 673 674 675 676
	if (current_ref && (current_ref->name == ref
		|| !strcmp(current_ref->name, ref))) {
		if (current_ref->flag & REF_KNOWS_PEELED) {
			hashcpy(sha1, current_ref->peeled);
			return 0;
		}
		hashcpy(base, current_ref->sha1);
		goto fallback;
	}

677
	if (read_ref_full(ref, base, 1, &flag))
678 679 680
		return -1;

	if ((flag & REF_ISPACKED)) {
681 682
		struct ref_array *array = get_packed_refs(NULL);
		struct ref_entry *r = search_ref_array(array, ref);
683

684 685 686
		if (r != NULL && r->flag & REF_KNOWS_PEELED) {
			hashcpy(sha1, r->peeled);
			return 0;
687 688 689
		}
	}

690
fallback:
691
	o = parse_object(base);
692
	if (o && o->type == OBJ_TAG) {
693 694 695 696 697 698 699 700 701
		o = deref_tag(o, ref, 0);
		if (o) {
			hashcpy(sha1, o->sha1);
			return 0;
		}
	}
	return -1;
}

702 703
static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
			   int trim, int flags, void *cb_data)
704
{
705 706 707
	int retval = 0, i, p = 0, l = 0;
	struct ref_array *packed = get_packed_refs(submodule);
	struct ref_array *loose = get_loose_refs(submodule);
708

709
	struct ref_array *extra = &extra_refs;
710

711 712
	for (i = 0; i < extra->nr; i++)
		retval = do_one_ref(base, fn, trim, flags, cb_data, extra->refs[i]);
713

714 715 716
	while (p < packed->nr && l < loose->nr) {
		struct ref_entry *entry;
		int cmp = strcmp(packed->refs[p]->name, loose->refs[l]->name);
717
		if (!cmp) {
718
			p++;
719
			continue;
720
		}
721
		if (cmp > 0) {
722
			entry = loose->refs[l++];
723
		} else {
724
			entry = packed->refs[p++];
725
		}
726
		retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
727
		if (retval)
728
			goto end_each;
729
	}
730

731 732 733 734 735 736 737
	if (l < loose->nr) {
		p = l;
		packed = loose;
	}

	for (; p < packed->nr; p++) {
		retval = do_one_ref(base, fn, trim, flags, cb_data, packed->refs[p]);
738
		if (retval)
739
			goto end_each;
740
	}
741 742 743 744

end_each:
	current_ref = NULL;
	return retval;
745 746
}

747 748

static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
749 750
{
	unsigned char sha1[20];
751 752
	int flag;

753 754 755 756 757 758 759
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

760
	if (!read_ref_full("HEAD", sha1, 1, &flag))
761
		return fn("HEAD", sha1, flag, cb_data);
762

763
	return 0;
764 765
}

766 767 768 769 770
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

771 772 773 774 775
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

776
int for_each_ref(each_ref_fn fn, void *cb_data)
777
{
778
	return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
779 780
}

781 782
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
783
	return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
784 785
}

786 787
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
788
	return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
789 790
}

791 792 793 794
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);
795 796
}

797
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
798
{
799
	return for_each_ref_in("refs/tags/", fn, cb_data);
800 801
}

802 803 804 805 806
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);
}

807
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
808
{
809
	return for_each_ref_in("refs/heads/", fn, cb_data);
810 811
}

812 813 814 815 816
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);
}

817
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
818
{
819
	return for_each_ref_in("refs/remotes/", fn, cb_data);
820 821
}

822 823 824 825 826
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);
}

827 828
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
829
	return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
830 831
}

J
Josh Triplett 已提交
832 833 834 835 836 837 838 839
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());
840
	if (!read_ref_full(buf.buf, sha1, 1, &flag))
J
Josh Triplett 已提交
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
		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;
}

857 858
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
859 860 861 862 863
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

864
	if (!prefix && prefixcmp(pattern, "refs/"))
I
Ilari Liusvaara 已提交
865
		strbuf_addstr(&real_pattern, "refs/");
866 867
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
868 869
	strbuf_addstr(&real_pattern, pattern);

870
	if (!has_glob_specials(pattern)) {
871
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
		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;
}

887 888 889 890 891
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);
}

892 893
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
894
	return do_for_each_ref(NULL, "", fn, 0,
895
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
896 897
}

898 899 900 901 902 903 904 905
/*
 * 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 "/".
906
 * - it ends with ".lock"
R
Robin Rosenberg 已提交
907
 * - it contains a "\" (backslash)
908 909
 */

910
/* Return true iff ch is not allowed in reference names. */
911 912
static inline int bad_ref_char(int ch)
{
913
	if (((unsigned) ch) <= ' ' || ch == 0x7f ||
R
Robin Rosenberg 已提交
914
	    ch == '~' || ch == '^' || ch == ':' || ch == '\\')
915 916
		return 1;
	/* 2.13 Pattern Matching Notation */
917
	if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
918 919
		return 1;
	return 0;
920 921
}

M
Michael Haggerty 已提交
922 923 924 925 926
/*
 * Try to read one refname component from the front of ref.  Return
 * the length of the component found, or -1 if the component is not
 * legal.
 */
927
static int check_refname_component(const char *ref, int flags)
D
Daniel Barkalow 已提交
928
{
M
Michael Haggerty 已提交
929 930
	const char *cp;
	char last = '\0';
931

M
Michael Haggerty 已提交
932 933 934 935 936 937 938 939 940 941
	for (cp = ref; ; 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 "@{". */
942
		last = ch;
M
Michael Haggerty 已提交
943 944 945
	}
	if (cp == ref)
		return -1; /* Component has zero length. */
946 947 948 949 950 951 952 953 954 955
	if (ref[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 (ref[1] == '\0')
			return -1; /* Component equals ".". */
	}
956 957
	if (cp - ref >= 5 && !memcmp(cp - 5, ".lock", 5))
		return -1; /* Refname ends with ".lock". */
M
Michael Haggerty 已提交
958 959 960
	return cp - ref;
}

961
int check_refname_format(const char *ref, int flags)
D
Daniel Barkalow 已提交
962
{
M
Michael Haggerty 已提交
963
	int component_len, component_count = 0;
964 965

	while (1) {
M
Michael Haggerty 已提交
966
		/* We are at the start of a path component. */
967
		component_len = check_refname_component(ref, flags);
M
Michael Haggerty 已提交
968 969 970 971
		if (component_len < 0) {
			if ((flags & REFNAME_REFSPEC_PATTERN) &&
					ref[0] == '*' &&
					(ref[1] == '\0' || ref[1] == '/')) {
972 973
				/* Accept one wildcard as a full refname component. */
				flags &= ~REFNAME_REFSPEC_PATTERN;
M
Michael Haggerty 已提交
974 975
				component_len = 1;
			} else {
976
				return -1;
M
Michael Haggerty 已提交
977
			}
978
		}
M
Michael Haggerty 已提交
979 980 981 982 983
		component_count++;
		if (ref[component_len] == '\0')
			break;
		/* Skip to next component. */
		ref += component_len + 1;
984
	}
M
Michael Haggerty 已提交
985 986 987 988 989 990

	if (ref[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;
D
Daniel Barkalow 已提交
991 992
}

993
const char *prettify_refname(const char *name)
994 995 996 997 998 999 1000 1001
{
	return name + (
		!prefixcmp(name, "refs/heads/") ? 11 :
		!prefixcmp(name, "refs/tags/") ? 10 :
		!prefixcmp(name, "refs/remotes/") ? 13 :
		0);
}

S
Steffen Prohaska 已提交
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
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 已提交
1026
static struct ref_lock *verify_lock(struct ref_lock *lock,
1027 1028
	const unsigned char *old_sha1, int mustexist)
{
1029
	if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1030
		error("Can't verify ref %s", lock->ref_name);
1031 1032 1033
		unlock_ref(lock);
		return NULL;
	}
1034
	if (hashcmp(lock->old_sha1, old_sha1)) {
1035
		error("Ref %s is at %s but expected %s", lock->ref_name,
1036 1037 1038 1039 1040 1041 1042
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
		return NULL;
	}
	return lock;
}

1043
static int remove_empty_directories(const char *file)
1044 1045 1046 1047 1048
{
	/* 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.
	 */
1049 1050
	struct strbuf path;
	int result;
1051

1052 1053 1054
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

1055
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1056 1057 1058 1059

	strbuf_release(&path);

	return result;
1060 1061
}

1062
static int is_refname_available(const char *ref, const char *oldref,
1063
				struct ref_array *array, int quiet)
1064
{
1065 1066 1067 1068 1069 1070
	int i, namlen = strlen(ref); /* e.g. 'foo/bar' */
	for (i = 0; i < array->nr; i++ ) {
		struct ref_entry *entry = array->refs[i];
		/* entry->name could be 'foo' or 'foo/bar/baz' */
		if (!oldref || strcmp(oldref, entry->name)) {
			int len = strlen(entry->name);
1071
			int cmplen = (namlen < len) ? namlen : len;
1072 1073
			const char *lead = (namlen < len) ? entry->name : ref;
			if (!strncmp(ref, entry->name, cmplen) &&
1074 1075 1076
			    lead[cmplen] == '/') {
				if (!quiet)
					error("'%s' exists; cannot create '%s'",
1077
					      entry->name, ref);
1078 1079 1080 1081 1082 1083 1084
				return 0;
			}
		}
	}
	return 1;
}

1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
/*
 * *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);
1120
		r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1121 1122 1123 1124 1125
		if (r) {
			if (!refs_found++)
				*ref = xstrdup(r);
			if (!warn_ambiguous_refs)
				break;
1126
		} else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1127
			warning("ignoring dangling symref %s.", fullref);
1128 1129 1130
		} else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
			warning("ignoring broken ref %s.", fullref);
		}
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
	}
	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);
1150
		ref = resolve_ref_unsafe(path, hash, 1, NULL);
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
		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;
}

1173
static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
1174
{
1175
	char *ref_file;
L
Linus Torvalds 已提交
1176
	const char *orig_ref = ref;
1177
	struct ref_lock *lock;
1178
	int last_errno = 0;
1179
	int type, lflags;
1180
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1181
	int missing = 0;
1182 1183 1184 1185

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

1186
	ref = resolve_ref_unsafe(ref, lock->old_sha1, mustexist, &type);
1187 1188 1189 1190 1191 1192 1193
	if (!ref && errno == EISDIR) {
		/* 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.
		 */
		ref_file = git_path("%s", orig_ref);
1194 1195 1196 1197 1198
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
			error("there are still refs under '%s'", orig_ref);
			goto error_return;
		}
1199
		ref = resolve_ref_unsafe(orig_ref, lock->old_sha1, mustexist, &type);
1200
	}
1201 1202
	if (type_p)
	    *type_p = type;
L
Linus Torvalds 已提交
1203
	if (!ref) {
1204
		last_errno = errno;
1205
		error("unable to resolve reference %s: %s",
L
Linus Torvalds 已提交
1206
			orig_ref, strerror(errno));
1207
		goto error_return;
1208
	}
1209
	missing = is_null_sha1(lock->old_sha1);
1210 1211 1212 1213 1214
	/* 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.
	 */
1215
	if (missing &&
1216
	     !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1217
		last_errno = ENOTDIR;
1218
		goto error_return;
1219
	}
1220

1221
	lock->lk = xcalloc(1, sizeof(struct lock_file));
1222

1223 1224
	lflags = LOCK_DIE_ON_ERROR;
	if (flags & REF_NODEREF) {
1225
		ref = orig_ref;
1226 1227
		lflags |= LOCK_NODEREF;
	}
1228
	lock->ref_name = xstrdup(ref);
1229
	lock->orig_ref_name = xstrdup(orig_ref);
P
Petr Baudis 已提交
1230
	ref_file = git_path("%s", ref);
1231
	if (missing)
1232 1233 1234
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
1235

1236 1237 1238 1239 1240
	if (safe_create_leading_directories(ref_file)) {
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
1241

1242
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1243
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1244 1245 1246 1247 1248

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
1249 1250
}

1251
struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
D
Daniel Barkalow 已提交
1252
{
P
Petr Baudis 已提交
1253
	char refpath[PATH_MAX];
1254
	if (check_refname_format(ref, 0))
1255
		return NULL;
P
Petr Baudis 已提交
1256
	strcpy(refpath, mkpath("refs/%s", ref));
1257
	return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1258 1259
}

1260
struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1261
{
1262
	if (check_refname_format(ref, REFNAME_ALLOW_ONELEVEL))
1263
		return NULL;
1264
	return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
J
Junio C Hamano 已提交
1265 1266
}

1267 1268
static struct lock_file packlock;

J
Junio C Hamano 已提交
1269 1270
static int repack_without_ref(const char *refname)
{
1271 1272 1273
	struct ref_array *packed;
	struct ref_entry *ref;
	int fd, i;
J
Junio C Hamano 已提交
1274

1275 1276 1277
	packed = get_packed_refs(NULL);
	ref = search_ref_array(packed, refname);
	if (ref == NULL)
J
Junio C Hamano 已提交
1278 1279
		return 0;
	fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1280 1281
	if (fd < 0) {
		unable_to_lock_error(git_path("packed-refs"), errno);
J
Junio C Hamano 已提交
1282
		return error("cannot delete '%s' from packed refs", refname);
1283
	}
J
Junio C Hamano 已提交
1284

1285
	for (i = 0; i < packed->nr; i++) {
J
Junio C Hamano 已提交
1286 1287 1288
		char line[PATH_MAX + 100];
		int len;

1289 1290 1291
		ref = packed->refs[i];

		if (!strcmp(refname, ref->name))
J
Junio C Hamano 已提交
1292 1293
			continue;
		len = snprintf(line, sizeof(line), "%s %s\n",
1294
			       sha1_to_hex(ref->sha1), ref->name);
J
Junio C Hamano 已提交
1295 1296
		/* this should not happen but just being defensive */
		if (len > sizeof(line))
1297
			die("too long a refname '%s'", ref->name);
J
Junio C Hamano 已提交
1298 1299 1300 1301 1302
		write_or_die(fd, line, len);
	}
	return commit_lock_file(&packlock);
}

M
Miklos Vajna 已提交
1303
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
1304 1305
{
	struct ref_lock *lock;
M
Miklos Vajna 已提交
1306
	int err, i = 0, ret = 0, flag = 0;
J
Junio C Hamano 已提交
1307

1308
	lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
J
Junio C Hamano 已提交
1309 1310
	if (!lock)
		return 1;
1311
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
J
Junio C Hamano 已提交
1312
		/* loose */
M
Miklos Vajna 已提交
1313 1314 1315 1316 1317 1318 1319
		const char *path;

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

M
Miklos Vajna 已提交
1326 1327
		if (!(delopt & REF_NODEREF))
			lock->lk->filename[i] = '.';
J
Junio C Hamano 已提交
1328 1329 1330 1331 1332 1333 1334
	}
	/* 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);

1335
	unlink_or_warn(git_path("logs/%s", lock->ref_name));
1336
	invalidate_ref_cache(NULL);
J
Junio C Hamano 已提交
1337 1338
	unlock_ref(lock);
	return ret;
1339 1340
}

1341 1342 1343 1344 1345 1346 1347 1348 1349
/*
 * 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"

1350
int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1351 1352 1353 1354 1355
{
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
1356
	int log = !lstat(git_path("logs/%s", oldref), &loginfo);
M
Miklos Vajna 已提交
1357
	const char *symref = NULL;
1358

1359
	if (log && S_ISLNK(loginfo.st_mode))
1360 1361
		return error("reflog for %s is a symlink", oldref);

1362
	symref = resolve_ref_unsafe(oldref, orig_sha1, 1, &flag);
M
Miklos Vajna 已提交
1363
	if (flag & REF_ISSYMREF)
1364 1365
		return error("refname %s is a symbolic ref, renaming it is not supported",
			oldref);
M
Miklos Vajna 已提交
1366
	if (!symref)
1367 1368
		return error("refname %s not found", oldref);

1369
	if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1370 1371
		return 1;

1372
	if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1373 1374
		return 1;

1375 1376
	if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
		return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1377 1378
			oldref, strerror(errno));

M
Miklos Vajna 已提交
1379
	if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1380 1381 1382 1383
		error("unable to delete old %s", oldref);
		goto rollback;
	}

1384 1385
	if (!read_ref_full(newref, sha1, 1, &flag) &&
	    delete_ref(newref, sha1, REF_NODEREF)) {
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
		if (errno==EISDIR) {
			if (remove_empty_directories(git_path("%s", newref))) {
				error("Directory not empty: %s", newref);
				goto rollback;
			}
		} else {
			error("unable to delete existing %s", newref);
			goto rollback;
		}
	}

	if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
		error("unable to create directory for %s", newref);
		goto rollback;
	}

 retry:
1403
	if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1404 1405 1406 1407 1408 1409
		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.
			 */
1410 1411 1412 1413 1414 1415
			if (remove_empty_directories(git_path("logs/%s", newref))) {
				error("Directory not empty: logs/%s", newref);
				goto rollback;
			}
			goto retry;
		} else {
1416
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1417 1418 1419 1420 1421 1422
				newref, strerror(errno));
			goto rollback;
		}
	}
	logmoved = log;

1423
	lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1424 1425 1426 1427 1428 1429
	if (!lock) {
		error("unable to lock %s for update", newref);
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
1430
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1431 1432 1433 1434 1435 1436 1437
		error("unable to write current sha1 into %s", newref);
		goto rollback;
	}

	return 0;

 rollback:
1438
	lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455
	if (!lock) {
		error("unable to lock %s for rollback", oldref);
		goto rollbacklog;
	}

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

 rollbacklog:
	if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
		error("unable to restore logfile %s from %s: %s",
			oldref, newref, strerror(errno));
	if (!logmoved && log &&
1456 1457
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1458 1459 1460 1461 1462
			oldref, strerror(errno));

	return 1;
}

1463
int close_ref(struct ref_lock *lock)
1464 1465 1466 1467 1468 1469 1470
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

1471
int commit_ref(struct ref_lock *lock)
1472 1473 1474 1475 1476 1477 1478
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
1479
void unlock_ref(struct ref_lock *lock)
1480
{
B
Brandon Casey 已提交
1481 1482 1483
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
1484
	free(lock->ref_name);
1485
	free(lock->orig_ref_name);
1486 1487 1488
	free(lock);
}

1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
/*
 * 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;
}

1515
int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1516
{
1517
	int logfd, oflags = O_APPEND | O_WRONLY;
1518

1519
	git_snpath(logfile, bufsize, "logs/%s", ref_name);
1520
	if (log_all_ref_updates &&
1521 1522
	    (!prefixcmp(ref_name, "refs/heads/") ||
	     !prefixcmp(ref_name, "refs/remotes/") ||
1523
	     !prefixcmp(ref_name, "refs/notes/") ||
N
Nicolas Pitre 已提交
1524
	     !strcmp(ref_name, "HEAD"))) {
1525
		if (safe_create_leading_directories(logfile) < 0)
1526
			return error("unable to create directory for %s",
1527
				     logfile);
1528 1529 1530
		oflags |= O_CREAT;
	}

1531
	logfd = open(logfile, oflags, 0666);
1532
	if (logfd < 0) {
J
Junio C Hamano 已提交
1533
		if (!(oflags & O_CREAT) && errno == ENOENT)
1534
			return 0;
1535 1536

		if ((oflags & O_CREAT) && errno == EISDIR) {
1537
			if (remove_empty_directories(logfile)) {
1538
				return error("There are still logs under '%s'",
1539
					     logfile);
1540
			}
1541
			logfd = open(logfile, oflags, 0666);
1542 1543 1544 1545
		}

		if (logfd < 0)
			return error("Unable to append to %s: %s",
1546
				     logfile, strerror(errno));
1547 1548
	}

1549
	adjust_shared_perm(logfile);
1550 1551 1552
	close(logfd);
	return 0;
}
1553

1554 1555 1556 1557 1558 1559
static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
			 const unsigned char *new_sha1, const char *msg)
{
	int logfd, result, written, oflags = O_APPEND | O_WRONLY;
	unsigned maxlen, len;
	int msglen;
1560
	char log_file[PATH_MAX];
1561 1562 1563 1564 1565 1566
	char *logrec;
	const char *committer;

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

1567
	result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1568 1569 1570 1571 1572 1573
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
1574
	msglen = msg ? strlen(msg) : 0;
1575
	committer = git_committer_info(0);
1576 1577 1578
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
1579 1580
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
1581 1582
		      committer);
	if (msglen)
1583
		len += copy_msg(logrec + len - 1, msg) - 1;
1584
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1585
	free(logrec);
1586
	if (close(logfd) != 0 || written != len)
1587
		return error("Unable to append to %s", log_file);
1588 1589 1590
	return 0;
}

1591 1592 1593 1594 1595
static int is_branch(const char *refname)
{
	return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
}

1596 1597 1598 1599
int write_ref_sha1(struct ref_lock *lock,
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
1600
	struct object *o;
1601 1602

	if (!lock)
D
Daniel Barkalow 已提交
1603
		return -1;
1604
	if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1605 1606
		unlock_ref(lock);
		return 0;
D
Daniel Barkalow 已提交
1607
	}
1608 1609
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
1610
		error("Trying to write ref %s with nonexistent object %s",
1611 1612 1613 1614 1615 1616 1617 1618 1619 1620
			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;
	}
1621 1622
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
	    write_in_full(lock->lock_fd, &term, 1) != 1
1623
		|| close_ref(lock) < 0) {
1624
		error("Couldn't write %s", lock->lk->filename);
1625 1626 1627
		unlock_ref(lock);
		return -1;
	}
1628
	clear_loose_ref_cache(get_ref_cache(NULL));
N
Nicolas Pitre 已提交
1629 1630 1631
	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)) {
1632 1633 1634
		unlock_ref(lock);
		return -1;
	}
1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
	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;
1651
		head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
1652 1653 1654 1655
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
1656
	if (commit_ref(lock)) {
1657
		error("Couldn't set %s", lock->ref_name);
1658 1659 1660 1661 1662
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
1663
}
1664

1665 1666
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
1667 1668 1669 1670
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
1671
	char *git_HEAD = git_pathdup("%s", ref_target);
1672 1673 1674 1675
	unsigned char old_sha1[20], new_sha1[20];

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

1677 1678 1679
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

1680 1681 1682 1683
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
1684
			goto done;
1685 1686 1687 1688 1689 1690 1691
		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);
1692
		goto error_free_return;
1693 1694 1695 1696 1697
	}
	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);
1698
		goto error_free_return;
1699 1700
	}
	written = write_in_full(fd, ref, len);
1701
	if (close(fd) != 0 || written != len) {
1702
		error("Unable to write to %s", lockpath);
1703
		goto error_unlink_return;
1704 1705 1706
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
1707
		goto error_unlink_return;
1708 1709 1710
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
1711
	error_unlink_return:
1712
		unlink_or_warn(lockpath);
1713 1714 1715
	error_free_return:
		free(git_HEAD);
		return -1;
1716
	}
1717

1718
#ifndef NO_SYMLINK_HEAD
1719
	done:
1720
#endif
1721 1722 1723
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

1724
	free(git_HEAD);
1725 1726 1727
	return 0;
}

1728 1729 1730 1731
static char *ref_msg(const char *line, const char *endp)
{
	const char *ep;
	line += 82;
P
Pierre Habouzit 已提交
1732 1733 1734 1735
	ep = memchr(line, '\n', endp - line);
	if (!ep)
		ep = endp;
	return xmemdupz(line, ep - line);
1736 1737 1738
}

int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1, char **msg, unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
1739
{
1740
	const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1741
	char *tz_c;
J
Junio C Hamano 已提交
1742
	int logfd, tz, reccnt = 0;
1743 1744
	struct stat st;
	unsigned long date;
1745
	unsigned char logged_sha1[20];
1746
	void *log_mapped;
1747
	size_t mapsz;
1748 1749 1750 1751

	logfile = git_path("logs/%s", ref);
	logfd = open(logfile, O_RDONLY, 0);
	if (logfd < 0)
1752
		die_errno("Unable to read log '%s'", logfile);
1753 1754 1755
	fstat(logfd, &st);
	if (!st.st_size)
		die("Log %s is empty.", logfile);
1756 1757
	mapsz = xsize_t(st.st_size);
	log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1758
	logdata = log_mapped;
1759 1760
	close(logfd);

1761
	lastrec = NULL;
1762 1763
	rec = logend = logdata + st.st_size;
	while (logdata < rec) {
J
Junio C Hamano 已提交
1764
		reccnt++;
1765 1766
		if (logdata < rec && *(rec-1) == '\n')
			rec--;
1767 1768
		lastgt = NULL;
		while (logdata < rec && *(rec-1) != '\n') {
1769
			rec--;
1770 1771 1772 1773
			if (*rec == '>')
				lastgt = rec;
		}
		if (!lastgt)
1774
			die("Log %s is corrupt.", logfile);
1775
		date = strtoul(lastgt + 1, &tz_c, 10);
1776
		if (date <= at_time || cnt == 0) {
1777
			tz = strtoul(tz_c, NULL, 10);
1778 1779 1780 1781 1782 1783 1784
			if (msg)
				*msg = ref_msg(rec, logend);
			if (cutoff_time)
				*cutoff_time = date;
			if (cutoff_tz)
				*cutoff_tz = tz;
			if (cutoff_cnt)
1785
				*cutoff_cnt = reccnt - 1;
1786 1787 1788 1789 1790
			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);
1791
				if (hashcmp(logged_sha1, sha1)) {
1792
					warning("Log %s has gap after %s.",
1793
						logfile, show_date(date, tz, DATE_RFC2822));
1794
				}
J
Junio C Hamano 已提交
1795 1796
			}
			else if (date == at_time) {
1797 1798
				if (get_sha1_hex(rec + 41, sha1))
					die("Log %s is corrupt.", logfile);
J
Junio C Hamano 已提交
1799 1800
			}
			else {
1801 1802
				if (get_sha1_hex(rec + 41, logged_sha1))
					die("Log %s is corrupt.", logfile);
1803
				if (hashcmp(logged_sha1, sha1)) {
1804
					warning("Log %s unexpectedly ended on %s.",
1805
						logfile, show_date(date, tz, DATE_RFC2822));
1806 1807
				}
			}
1808
			munmap(log_mapped, mapsz);
1809 1810
			return 0;
		}
1811
		lastrec = rec;
1812 1813
		if (cnt > 0)
			cnt--;
1814 1815
	}

1816 1817 1818 1819
	rec = logdata;
	while (rec < logend && *rec != '>' && *rec != '\n')
		rec++;
	if (rec == logend || *rec == '\n')
1820
		die("Log %s is corrupt.", logfile);
1821
	date = strtoul(rec + 1, &tz_c, 10);
1822 1823 1824
	tz = strtoul(tz_c, NULL, 10);
	if (get_sha1_hex(logdata, sha1))
		die("Log %s is corrupt.", logfile);
J
Jeff King 已提交
1825 1826 1827 1828
	if (is_null_sha1(sha1)) {
		if (get_sha1_hex(logdata + 41, sha1))
			die("Log %s is corrupt.", logfile);
	}
1829 1830
	if (msg)
		*msg = ref_msg(logdata, logend);
1831
	munmap(log_mapped, mapsz);
1832 1833 1834 1835 1836 1837 1838 1839

	if (cutoff_time)
		*cutoff_time = date;
	if (cutoff_tz)
		*cutoff_tz = tz;
	if (cutoff_cnt)
		*cutoff_cnt = reccnt;
	return 1;
1840
}
1841

1842
int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1843 1844 1845
{
	const char *logfile;
	FILE *logfp;
1846
	struct strbuf sb = STRBUF_INIT;
1847
	int ret = 0;
1848 1849 1850 1851

	logfile = git_path("logs/%s", ref);
	logfp = fopen(logfile, "r");
	if (!logfp)
1852
		return -1;
1853 1854 1855 1856 1857 1858

	if (ofs) {
		struct stat statbuf;
		if (fstat(fileno(logfp), &statbuf) ||
		    statbuf.st_size < ofs ||
		    fseek(logfp, -ofs, SEEK_END) ||
1859
		    strbuf_getwholeline(&sb, logfp, '\n')) {
1860
			fclose(logfp);
1861
			strbuf_release(&sb);
1862
			return -1;
1863
		}
1864 1865
	}

1866
	while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1867
		unsigned char osha1[20], nsha1[20];
1868 1869
		char *email_end, *message;
		unsigned long timestamp;
1870
		int tz;
1871 1872

		/* old SP new SP name <email> SP time TAB msg LF */
1873 1874 1875 1876
		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, '>')) ||
1877 1878 1879 1880 1881
		    email_end[1] != ' ' ||
		    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
		    !message || message[0] != ' ' ||
		    (message[1] != '+' && message[1] != '-') ||
		    !isdigit(message[2]) || !isdigit(message[3]) ||
1882
		    !isdigit(message[4]) || !isdigit(message[5]))
1883
			continue; /* corrupt? */
1884 1885
		email_end[1] = '\0';
		tz = strtol(message + 1, NULL, 10);
1886 1887 1888 1889
		if (message[6] != '\t')
			message += 6;
		else
			message += 7;
1890 1891
		ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
			 cb_data);
1892
		if (ret)
1893
			break;
1894 1895
	}
	fclose(logfp);
1896
	strbuf_release(&sb);
1897
	return ret;
1898
}
J
Junio C Hamano 已提交
1899

1900 1901 1902 1903 1904
int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
{
	return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
}

1905 1906 1907
static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
{
	DIR *dir = opendir(git_path("logs/%s", base));
1908
	int retval = 0;
1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936

	if (dir) {
		struct dirent *de;
		int baselen = strlen(base);
		char *log = xmalloc(baselen + 257);

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

		while ((de = readdir(dir)) != NULL) {
			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];
1937
				if (read_ref_full(log, sha1, 0, NULL))
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947
					retval = error("bad ref for %s", log);
				else
					retval = fn(log, sha1, 0, cb_data);
			}
			if (retval)
				break;
		}
		free(log);
		closedir(dir);
	}
1948
	else if (*base)
1949
		return errno;
1950 1951 1952 1953 1954 1955 1956
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
	return do_for_each_reflog("", fn, cb_data);
}
C
Carlos Rica 已提交
1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983

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

1985
int ref_exists(const char *refname)
1986 1987
{
	unsigned char sha1[20];
1988
	return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1989 1990
}

1991
struct ref *find_ref_by_name(const struct ref *list, const char *name)
1992 1993 1994
{
	for ( ; list; list = list->next)
		if (!strcmp(list->name, name))
1995
			return (struct ref *)list;
1996 1997
	return NULL;
}
J
Jeff King 已提交
1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021

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

2022
char *shorten_unambiguous_ref(const char *ref, int strict)
J
Jeff King 已提交
2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
{
	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)
		return xstrdup(ref);

	/* buffer for scanf result, at most ref must fit */
	short_name = xstrdup(ref);

	/* skip first rule, it will always match */
	for (i = nr_rules - 1; i > 0 ; --i) {
		int j;
2059
		int rules_to_fail = i;
J
Jeff King 已提交
2060 2061 2062 2063 2064 2065 2066
		int short_name_len;

		if (1 != sscanf(ref, scanf_fmts[i], short_name))
			continue;

		short_name_len = strlen(short_name);

2067 2068 2069 2070 2071 2072 2073
		/*
		 * 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 已提交
2074 2075 2076 2077
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
2078
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
2079 2080 2081
			const char *rule = ref_rev_parse_rules[j];
			char refname[PATH_MAX];

2082 2083 2084 2085
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
2086 2087 2088 2089 2090 2091 2092
			/*
			 * 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);
2093
			if (ref_exists(refname))
J
Jeff King 已提交
2094 2095 2096 2097 2098 2099 2100
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
2101
		if (j == rules_to_fail)
J
Jeff King 已提交
2102 2103 2104 2105 2106 2107
			return short_name;
	}

	free(short_name);
	return xstrdup(ref);
}