refs.c 46.2 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=01 and ISPACKED=02 are public interfaces */
#define REF_KNOWS_PEELED 04
9
#define REF_BROKEN 010
10

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

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

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

48 49 50
	return line;
}

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

	/* Allocate it and add it in.. */
	len = strlen(name) + 1;
60
	entry = xmalloc(sizeof(struct ref_entry) + len);
61
	hashcpy(entry->sha1, sha1);
62
	hashclr(entry->peeled);
63
	memcpy(entry->name, name, len);
64
	entry->flag = flag;
65 66
	if (new_entry)
		*new_entry = entry;
67 68
	ALLOC_GROW(refs->refs, refs->nr + 1, refs->alloc);
	refs->refs[refs->nr++] = entry;
69 70
}

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

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 103
static void sort_ref_array(struct ref_array *array)
{
	int i = 0, j = 1;

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

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

	/* 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);
			continue;
		}
		i++;
		array->refs[i] = array->refs[j];
	}
	array->nr = i + 1;
}
104

105 106 107 108
static struct ref_entry *search_ref_array(struct ref_array *array, const char *name)
{
	struct ref_entry *e, **r;
	int len;
109

110 111
	if (name == NULL)
		return NULL;
112

113 114 115
	if (!array->nr)
		return NULL;

116 117 118
	len = strlen(name) + 1;
	e = xmalloc(sizeof(struct ref_entry) + len);
	memcpy(e->name, name, len);
119

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

122
	free(e);
123

124 125
	if (r == NULL)
		return NULL;
126

127
	return *r;
128 129
}

130 131 132 133
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
J
Junio C Hamano 已提交
134
static struct cached_refs {
135 136
	char did_loose;
	char did_packed;
137 138
	struct ref_array loose;
	struct ref_array packed;
139
} cached_refs, submodule_refs;
140
static struct ref_entry *current_ref;
141

142
static struct ref_array extra_refs;
143

144
static void free_ref_array(struct ref_array *array)
145
{
146 147 148 149 150 151
	int i;
	for (i = 0; i < array->nr; i++)
		free(array->refs[i]);
	free(array->refs);
	array->nr = array->alloc = 0;
	array->refs = NULL;
152 153 154
}

static void invalidate_cached_refs(void)
155
{
156 157
	struct cached_refs *ca = &cached_refs;

158 159 160 161
	if (ca->did_loose)
		free_ref_array(&ca->loose);
	if (ca->did_packed)
		free_ref_array(&ca->packed);
162 163
	ca->did_loose = ca->did_packed = 0;
}
164

165 166
static void read_packed_refs(FILE *f, struct cached_refs *cached_refs)
{
167
	struct ref_entry *last = NULL;
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
	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) {
186
			add_ref(name, sha1, flag, &cached_refs->packed, &last);
187 188 189 190 191 192 193 194 195
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
		    strlen(refline) == 42 &&
		    refline[41] == '\n' &&
		    !get_sha1_hex(refline + 1, sha1))
			hashcpy(last->peeled, sha1);
	}
196
	sort_ref_array(&cached_refs->packed);
197 198
}

199 200
void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
{
201
	add_ref(name, sha1, flag, &extra_refs, NULL);
202 203 204 205
}

void clear_extra_refs(void)
{
206
	free_ref_array(&extra_refs);
207 208
}

209
static struct ref_array *get_packed_refs(const char *submodule)
210
{
211 212 213 214 215 216
	const char *packed_refs_file;
	struct cached_refs *refs;

	if (submodule) {
		packed_refs_file = git_path_submodule(submodule, "packed-refs");
		refs = &submodule_refs;
217
		free_ref_array(&refs->packed);
218 219 220 221 222 223 224
	} else {
		packed_refs_file = git_path("packed-refs");
		refs = &cached_refs;
	}

	if (!refs->did_packed || submodule) {
		FILE *f = fopen(packed_refs_file, "r");
225
		if (f) {
226
			read_packed_refs(f, refs);
227 228
			fclose(f);
		}
229
		refs->did_packed = 1;
230
	}
231
	return &refs->packed;
232 233
}

234 235
static void get_ref_dir(const char *submodule, const char *base,
			struct ref_array *array)
236
{
237 238 239 240 241 242 243 244 245 246
	DIR *dir;
	const char *path;

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


	dir = opendir(path);
247 248 249 250

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

L
Linus Torvalds 已提交
253
		memcpy(ref, base, baselen);
254
		if (baselen && base[baselen-1] != '/')
L
Linus Torvalds 已提交
255
			ref[baselen++] = '/';
256 257 258 259

		while ((de = readdir(dir)) != NULL) {
			unsigned char sha1[20];
			struct stat st;
260
			int flag;
261
			int namelen;
262
			const char *refdir;
263 264 265 266 267 268 269 270

			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 已提交
271
			memcpy(ref + baselen, de->d_name, namelen+1);
272 273 274 275
			refdir = submodule
				? git_path_submodule(submodule, "%s", ref)
				: git_path("%s", ref);
			if (stat(refdir, &st) < 0)
276 277
				continue;
			if (S_ISDIR(st.st_mode)) {
278
				get_ref_dir(submodule, ref, array);
279 280
				continue;
			}
281
			if (submodule) {
282
				hashclr(sha1);
283 284 285 286 287 288 289 290 291 292
				flag = 0;
				if (resolve_gitlink_ref(submodule, ref, sha1) < 0) {
					hashclr(sha1);
					flag |= REF_BROKEN;
				}
			} else
				if (!resolve_ref(ref, sha1, 1, &flag)) {
					hashclr(sha1);
					flag |= REF_BROKEN;
				}
293
			add_ref(ref, sha1, flag, array, NULL);
294
		}
L
Linus Torvalds 已提交
295
		free(ref);
296 297 298 299
		closedir(dir);
	}
}

300
struct warn_if_dangling_data {
301
	FILE *fp;
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
	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(refname, junk, 0, NULL);
	if (!resolves_to || strcmp(resolves_to, d->refname))
		return 0;

320
	fprintf(d->fp, d->msg_fmt, refname);
321 322 323
	return 0;
}

324
void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
325
{
326 327 328 329 330
	struct warn_if_dangling_data data;

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

334
static struct ref_array *get_loose_refs(const char *submodule)
335
{
336
	if (submodule) {
337 338 339 340
		free_ref_array(&submodule_refs.loose);
		get_ref_dir(submodule, "refs", &submodule_refs.loose);
		sort_ref_array(&submodule_refs.loose);
		return &submodule_refs.loose;
341 342
	}

343
	if (!cached_refs.did_loose) {
344 345
		get_ref_dir(NULL, "refs", &cached_refs.loose);
		sort_ref_array(&cached_refs.loose);
346
		cached_refs.did_loose = 1;
347
	}
348
	return &cached_refs.loose;
349 350
}

351 352
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
353 354 355 356 357 358
#define MAXREFLEN (1024)

static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
{
	FILE *f;
	struct cached_refs refs;
359 360
	struct ref_entry *ref;
	int retval = -1;
361 362 363 364 365

	strcpy(name + pathlen, "packed-refs");
	f = fopen(name, "r");
	if (!f)
		return -1;
366
	memset(&refs, 0, sizeof(refs));
367 368
	read_packed_refs(f, &refs);
	fclose(f);
369 370 371 372
	ref = search_ref_array(&refs.packed, refname);
	if (ref != NULL) {
		memcpy(result, ref->sha1, 20);
		retval = 0;
373
	}
374
	free_ref_array(&refs.packed);
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
	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;
416
	const char *tmp;
417 418 419 420 421 422 423

	while (len && path[len-1] == '/')
		len--;
	if (!len)
		return -1;
	gitdir = xmalloc(len + MAXREFLEN + 8);
	memcpy(gitdir, path, len);
424 425 426 427 428 429 430 431 432 433 434 435 436
	memcpy(gitdir + len, "/.git", 6);
	len += 5;

	tmp = read_gitfile_gently(gitdir);
	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);
437 438 439
	free(gitdir);
	return retval;
}
440

441 442 443 444 445 446 447 448 449 450 451 452
/*
 * If the "reading" argument is set, this function finds out what _object_
 * the ref points at by "reading" the ref.  The ref, if it is not symbolic,
 * has to exist, and if it is symbolic, it has to point at an existing ref,
 * because the "read" goes through the symref to the ref it points at.
 *
 * The access that is not "reading" may often be "writing", but does not
 * have to; it can be merely checking _where it leads to_. If it is a
 * prelude to "writing" to the ref, a write to a symref that points at
 * yet-to-be-born ref will create the real ref pointed by the symref.
 * reading=0 allows the caller to check where such a symref leads to.
 */
453
const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
454
{
455 456
	int depth = MAXDEPTH;
	ssize_t len;
457
	char buffer[256];
L
Linus Torvalds 已提交
458
	static char ref_buffer[256];
459

460 461 462
	if (flag)
		*flag = 0;

463
	for (;;) {
464
		char path[PATH_MAX];
465 466 467
		struct stat st;
		char *buf;
		int fd;
468

469 470
		if (--depth < 0)
			return NULL;
471

472
		git_snpath(path, sizeof(path), "%s", ref);
473
		/* Special case: non-existing file. */
474
		if (lstat(path, &st) < 0) {
475 476 477 478 479 480 481
			struct ref_array *packed = get_packed_refs(NULL);
			struct ref_entry *r = search_ref_array(packed, ref);
			if (r != NULL) {
				hashcpy(sha1, r->sha1);
				if (flag)
					*flag |= REF_ISPACKED;
				return ref;
482
			}
483 484
			if (reading || errno != ENOENT)
				return NULL;
485
			hashclr(sha1);
L
Linus Torvalds 已提交
486
			return ref;
487
		}
488

489 490 491 492
		/* Follow "normalized" - ie "refs/.." symlinks by hand */
		if (S_ISLNK(st.st_mode)) {
			len = readlink(path, buffer, sizeof(buffer)-1);
			if (len >= 5 && !memcmp("refs/", buffer, 5)) {
L
Linus Torvalds 已提交
493 494 495
				buffer[len] = 0;
				strcpy(ref_buffer, buffer);
				ref = ref_buffer;
496 497
				if (flag)
					*flag |= REF_ISSYMREF;
498 499
				continue;
			}
500
		}
501

502 503 504 505 506 507
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

508 509 510 511 512 513 514
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
		if (fd < 0)
			return NULL;
515
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
516 517 518 519 520 521 522 523 524 525 526 527
		close(fd);

		/*
		 * Is it a symbolic ref?
		 */
		if (len < 4 || memcmp("ref:", buffer, 4))
			break;
		buf = buffer + 4;
		len -= 4;
		while (len && isspace(*buf))
			buf++, len--;
		while (len && isspace(buf[len-1]))
L
Linus Torvalds 已提交
528 529 530 531
			len--;
		buf[len] = 0;
		memcpy(ref_buffer, buf, len + 1);
		ref = ref_buffer;
532 533
		if (flag)
			*flag |= REF_ISSYMREF;
534
	}
535 536
	if (len < 40 || get_sha1_hex(buffer, sha1))
		return NULL;
L
Linus Torvalds 已提交
537
	return ref;
538 539
}

I
Ilari Liusvaara 已提交
540 541 542 543 544 545 546
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

L
Linus Torvalds 已提交
547
int read_ref(const char *ref, unsigned char *sha1)
548
{
549
	if (resolve_ref(ref, sha1, 1, NULL))
550 551
		return 0;
	return -1;
552 553
}

554
#define DO_FOR_EACH_INCLUDE_BROKEN 01
555
static int do_one_ref(const char *base, each_ref_fn fn, int trim,
556
		      int flags, void *cb_data, struct ref_entry *entry)
557 558 559
{
	if (strncmp(base, entry->name, trim))
		return 0;
560

561
	if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
562 563
		if (entry->flag & REF_BROKEN)
			return 0; /* ignore dangling symref */
564 565 566 567
		if (!has_sha1_file(entry->sha1)) {
			error("%s does not point to a valid object!", entry->name);
			return 0;
		}
568
	}
569
	current_ref = entry;
570 571 572
	return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
}

I
Ilari Liusvaara 已提交
573 574 575 576 577 578 579 580 581
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);
}

582 583 584 585 586 587
int peel_ref(const char *ref, unsigned char *sha1)
{
	int flag;
	unsigned char base[20];
	struct object *o;

588 589 590 591 592 593 594 595 596 597
	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;
	}

598 599 600 601
	if (!resolve_ref(ref, base, 1, &flag))
		return -1;

	if ((flag & REF_ISPACKED)) {
602 603
		struct ref_array *array = get_packed_refs(NULL);
		struct ref_entry *r = search_ref_array(array, ref);
604

605 606 607
		if (r != NULL && r->flag & REF_KNOWS_PEELED) {
			hashcpy(sha1, r->peeled);
			return 0;
608 609 610
		}
	}

611
fallback:
612
	o = parse_object(base);
613
	if (o && o->type == OBJ_TAG) {
614 615 616 617 618 619 620 621 622
		o = deref_tag(o, ref, 0);
		if (o) {
			hashcpy(sha1, o->sha1);
			return 0;
		}
	}
	return -1;
}

623 624
static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
			   int trim, int flags, void *cb_data)
625
{
626 627 628
	int retval = 0, i, p = 0, l = 0;
	struct ref_array *packed = get_packed_refs(submodule);
	struct ref_array *loose = get_loose_refs(submodule);
629

630
	struct ref_array *extra = &extra_refs;
631

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

635 636 637
	while (p < packed->nr && l < loose->nr) {
		struct ref_entry *entry;
		int cmp = strcmp(packed->refs[p]->name, loose->refs[l]->name);
638
		if (!cmp) {
639
			p++;
640
			continue;
641
		}
642
		if (cmp > 0) {
643
			entry = loose->refs[l++];
644
		} else {
645
			entry = packed->refs[p++];
646
		}
647
		retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
648
		if (retval)
649
			goto end_each;
650
	}
651

652 653 654 655 656 657 658
	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]);
659
		if (retval)
660
			goto end_each;
661
	}
662 663 664 665

end_each:
	current_ref = NULL;
	return retval;
666 667
}

668 669

static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
670 671
{
	unsigned char sha1[20];
672 673
	int flag;

674 675 676 677 678 679 680
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

681 682
	if (resolve_ref("HEAD", sha1, 1, &flag))
		return fn("HEAD", sha1, flag, cb_data);
683

684
	return 0;
685 686
}

687 688 689 690 691
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

692 693 694 695 696
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

697
int for_each_ref(each_ref_fn fn, void *cb_data)
698
{
699
	return do_for_each_ref(NULL, "refs/", fn, 0, 0, cb_data);
700 701
}

702 703 704
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_for_each_ref(submodule, "refs/", fn, 0, 0, cb_data);
705 706
}

707 708
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
709
	return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
710 711
}

712 713 714 715
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);
716 717
}

718
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
719
{
720
	return for_each_ref_in("refs/tags/", fn, cb_data);
721 722
}

723 724 725 726 727
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);
}

728
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
729
{
730
	return for_each_ref_in("refs/heads/", fn, cb_data);
731 732
}

733 734 735 736 737
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);
}

738
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
739
{
740
	return for_each_ref_in("refs/remotes/", fn, cb_data);
741 742
}

743 744 745 746 747
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);
}

748 749
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
750
	return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
751 752
}

753 754
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
755 756 757 758 759
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

760
	if (!prefix && prefixcmp(pattern, "refs/"))
I
Ilari Liusvaara 已提交
761
		strbuf_addstr(&real_pattern, "refs/");
762 763
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
764 765
	strbuf_addstr(&real_pattern, pattern);

766
	if (!has_glob_specials(pattern)) {
767
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
		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;
}

783 784 785 786 787
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);
}

788 789
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
790
	return do_for_each_ref(NULL, "refs/", fn, 0,
791
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
792 793
}

794 795 796 797 798 799 800 801
/*
 * 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 "/".
802
 * - it ends with ".lock"
R
Robin Rosenberg 已提交
803
 * - it contains a "\" (backslash)
804 805 806 807
 */

static inline int bad_ref_char(int ch)
{
808
	if (((unsigned) ch) <= ' ' ||
R
Robin Rosenberg 已提交
809
	    ch == '~' || ch == '^' || ch == ':' || ch == '\\')
810 811 812 813 814 815 816
		return 1;
	/* 2.13 Pattern Matching Notation */
	if (ch == '?' || ch == '[') /* Unsupported */
		return 1;
	if (ch == '*') /* Supported at the end */
		return 2;
	return 0;
817 818
}

D
Daniel Barkalow 已提交
819 820
int check_ref_format(const char *ref)
{
821
	int ch, level, bad_type, last;
822
	int ret = CHECK_REF_FORMAT_OK;
823 824 825 826 827 828 829
	const char *cp = ref;

	level = 0;
	while (1) {
		while ((ch = *cp++) == '/')
			; /* tolerate duplicated slashes */
		if (!ch)
830 831
			/* should not end with slashes */
			return CHECK_REF_FORMAT_ERROR;
832 833

		/* we are at the beginning of the path component */
834
		if (ch == '.')
835
			return CHECK_REF_FORMAT_ERROR;
836 837
		bad_type = bad_ref_char(ch);
		if (bad_type) {
838 839 840 841 842
			if (bad_type == 2 && (!*cp || *cp == '/') &&
			    ret == CHECK_REF_FORMAT_OK)
				ret = CHECK_REF_FORMAT_WILDCARD;
			else
				return CHECK_REF_FORMAT_ERROR;
843
		}
844

845
		last = ch;
846 847
		/* scan the rest of the path component */
		while ((ch = *cp++) != 0) {
848
			bad_type = bad_ref_char(ch);
849
			if (bad_type)
D
Daniel Barkalow 已提交
850
				return CHECK_REF_FORMAT_ERROR;
851 852
			if (ch == '/')
				break;
853 854 855
			if (last == '.' && ch == '.')
				return CHECK_REF_FORMAT_ERROR;
			if (last == '@' && ch == '{')
856
				return CHECK_REF_FORMAT_ERROR;
857
			last = ch;
858 859 860
		}
		level++;
		if (!ch) {
861 862
			if (ref <= cp - 2 && cp[-2] == '.')
				return CHECK_REF_FORMAT_ERROR;
863
			if (level < 2)
864
				return CHECK_REF_FORMAT_ONELEVEL;
865 866
			if (has_extension(ref, ".lock"))
				return CHECK_REF_FORMAT_ERROR;
867
			return ret;
868 869
		}
	}
D
Daniel Barkalow 已提交
870 871
}

872
const char *prettify_refname(const char *name)
873 874 875 876 877 878 879 880
{
	return name + (
		!prefixcmp(name, "refs/heads/") ? 11 :
		!prefixcmp(name, "refs/tags/") ? 10 :
		!prefixcmp(name, "refs/remotes/") ? 13 :
		0);
}

S
Steffen Prohaska 已提交
881 882 883 884 885 886 887 888 889 890
const char *ref_rev_parse_rules[] = {
	"%.*s",
	"refs/%.*s",
	"refs/tags/%.*s",
	"refs/heads/%.*s",
	"refs/remotes/%.*s",
	"refs/remotes/%.*s/HEAD",
	NULL
};

891 892 893 894 895 896 897
const char *ref_fetch_rules[] = {
	"%.*s",
	"refs/%.*s",
	"refs/heads/%.*s",
	NULL
};

S
Steffen Prohaska 已提交
898 899 900 901 902 903 904 905 906 907 908 909 910 911
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 已提交
912
static struct ref_lock *verify_lock(struct ref_lock *lock,
913 914
	const unsigned char *old_sha1, int mustexist)
{
915
	if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
916
		error("Can't verify ref %s", lock->ref_name);
917 918 919
		unlock_ref(lock);
		return NULL;
	}
920
	if (hashcmp(lock->old_sha1, old_sha1)) {
921
		error("Ref %s is at %s but expected %s", lock->ref_name,
922 923 924 925 926 927 928
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
		return NULL;
	}
	return lock;
}

929
static int remove_empty_directories(const char *file)
930 931 932 933 934
{
	/* 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.
	 */
935 936
	struct strbuf path;
	int result;
937

938 939 940
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

941
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
942 943 944 945

	strbuf_release(&path);

	return result;
946 947
}

948
static int is_refname_available(const char *ref, const char *oldref,
949
				struct ref_array *array, int quiet)
950
{
951 952 953 954 955 956
	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);
957
			int cmplen = (namlen < len) ? namlen : len;
958 959
			const char *lead = (namlen < len) ? entry->name : ref;
			if (!strncmp(ref, entry->name, cmplen) &&
960 961 962
			    lead[cmplen] == '/') {
				if (!quiet)
					error("'%s' exists; cannot create '%s'",
963
					      entry->name, ref);
964 965 966 967 968 969 970
				return 0;
			}
		}
	}
	return 1;
}

971
static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
972
{
973
	char *ref_file;
L
Linus Torvalds 已提交
974
	const char *orig_ref = ref;
975
	struct ref_lock *lock;
976
	int last_errno = 0;
977
	int type, lflags;
978
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
979
	int missing = 0;
980 981 982 983

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

984
	ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
985 986 987 988 989 990 991
	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);
992 993 994 995 996
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
			error("there are still refs under '%s'", orig_ref);
			goto error_return;
		}
997
		ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
998
	}
999 1000
	if (type_p)
	    *type_p = type;
L
Linus Torvalds 已提交
1001
	if (!ref) {
1002
		last_errno = errno;
1003
		error("unable to resolve reference %s: %s",
L
Linus Torvalds 已提交
1004
			orig_ref, strerror(errno));
1005
		goto error_return;
1006
	}
1007
	missing = is_null_sha1(lock->old_sha1);
1008 1009 1010 1011 1012
	/* 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.
	 */
1013
	if (missing &&
1014
	     !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1015
		last_errno = ENOTDIR;
1016
		goto error_return;
1017
	}
1018

1019
	lock->lk = xcalloc(1, sizeof(struct lock_file));
1020

1021 1022
	lflags = LOCK_DIE_ON_ERROR;
	if (flags & REF_NODEREF) {
1023
		ref = orig_ref;
1024 1025
		lflags |= LOCK_NODEREF;
	}
1026
	lock->ref_name = xstrdup(ref);
1027
	lock->orig_ref_name = xstrdup(orig_ref);
P
Petr Baudis 已提交
1028
	ref_file = git_path("%s", ref);
1029
	if (missing)
1030 1031 1032
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
1033

1034 1035 1036 1037 1038
	if (safe_create_leading_directories(ref_file)) {
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
1039

1040
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1041
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1042 1043 1044 1045 1046

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
1047 1048
}

1049
struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
D
Daniel Barkalow 已提交
1050
{
P
Petr Baudis 已提交
1051
	char refpath[PATH_MAX];
D
Daniel Barkalow 已提交
1052
	if (check_ref_format(ref))
1053
		return NULL;
P
Petr Baudis 已提交
1054
	strcpy(refpath, mkpath("refs/%s", ref));
1055
	return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1056 1057
}

1058
struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1059
{
1060 1061
	switch (check_ref_format(ref)) {
	default:
1062 1063 1064
		return NULL;
	case 0:
	case CHECK_REF_FORMAT_ONELEVEL:
1065 1066
		return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
	}
J
Junio C Hamano 已提交
1067 1068
}

1069 1070
static struct lock_file packlock;

J
Junio C Hamano 已提交
1071 1072
static int repack_without_ref(const char *refname)
{
1073 1074 1075 1076 1077 1078 1079
	struct ref_array *packed;
	struct ref_entry *ref;
	int fd, i;

	packed = get_packed_refs(NULL);
	ref = search_ref_array(packed, refname);
	if (ref == NULL)
J
Junio C Hamano 已提交
1080 1081
		return 0;
	fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1082 1083
	if (fd < 0) {
		unable_to_lock_error(git_path("packed-refs"), errno);
J
Junio C Hamano 已提交
1084
		return error("cannot delete '%s' from packed refs", refname);
1085
	}
J
Junio C Hamano 已提交
1086

1087
	for (i = 0; i < packed->nr; i++) {
J
Junio C Hamano 已提交
1088 1089 1090
		char line[PATH_MAX + 100];
		int len;

1091 1092 1093
		ref = packed->refs[i];

		if (!strcmp(refname, ref->name))
J
Junio C Hamano 已提交
1094 1095
			continue;
		len = snprintf(line, sizeof(line), "%s %s\n",
1096
			       sha1_to_hex(ref->sha1), ref->name);
J
Junio C Hamano 已提交
1097 1098
		/* this should not happen but just being defensive */
		if (len > sizeof(line))
1099
			die("too long a refname '%s'", ref->name);
J
Junio C Hamano 已提交
1100 1101 1102 1103 1104
		write_or_die(fd, line, len);
	}
	return commit_lock_file(&packlock);
}

M
Miklos Vajna 已提交
1105
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
1106 1107
{
	struct ref_lock *lock;
M
Miklos Vajna 已提交
1108
	int err, i = 0, ret = 0, flag = 0;
J
Junio C Hamano 已提交
1109

1110
	lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
J
Junio C Hamano 已提交
1111 1112
	if (!lock)
		return 1;
1113
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
J
Junio C Hamano 已提交
1114
		/* loose */
M
Miklos Vajna 已提交
1115 1116 1117 1118 1119 1120 1121
		const char *path;

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

M
Miklos Vajna 已提交
1128 1129
		if (!(delopt & REF_NODEREF))
			lock->lk->filename[i] = '.';
J
Junio C Hamano 已提交
1130 1131 1132 1133 1134 1135 1136
	}
	/* 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);

1137
	unlink_or_warn(git_path("logs/%s", lock->ref_name));
J
Junio C Hamano 已提交
1138 1139 1140
	invalidate_cached_refs();
	unlock_ref(lock);
	return ret;
1141 1142
}

1143 1144 1145 1146 1147 1148 1149 1150 1151
/*
 * 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"

1152
int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1153 1154 1155 1156 1157 1158
{
	static const char renamed_ref[] = "RENAMED-REF";
	unsigned char sha1[20], orig_sha1[20];
	int flag = 0, logmoved = 0;
	struct ref_lock *lock;
	struct stat loginfo;
1159
	int log = !lstat(git_path("logs/%s", oldref), &loginfo);
M
Miklos Vajna 已提交
1160
	const char *symref = NULL;
1161

1162
	if (log && S_ISLNK(loginfo.st_mode))
1163 1164
		return error("reflog for %s is a symlink", oldref);

M
Miklos Vajna 已提交
1165 1166
	symref = resolve_ref(oldref, orig_sha1, 1, &flag);
	if (flag & REF_ISSYMREF)
1167 1168
		return error("refname %s is a symbolic ref, renaming it is not supported",
			oldref);
M
Miklos Vajna 已提交
1169
	if (!symref)
1170 1171
		return error("refname %s not found", oldref);

1172
	if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1173 1174
		return 1;

1175
	if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1176 1177
		return 1;

1178
	lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1179 1180 1181
	if (!lock)
		return error("unable to lock %s", renamed_ref);
	lock->force_write = 1;
1182
	if (write_ref_sha1(lock, orig_sha1, logmsg))
1183 1184
		return error("unable to save current sha1 in %s", renamed_ref);

1185 1186
	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",
1187 1188
			oldref, strerror(errno));

M
Miklos Vajna 已提交
1189
	if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1190 1191 1192 1193
		error("unable to delete old %s", oldref);
		goto rollback;
	}

M
Miklos Vajna 已提交
1194
	if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
		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:
1212
	if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1213 1214 1215 1216 1217 1218
		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.
			 */
1219 1220 1221 1222 1223 1224
			if (remove_empty_directories(git_path("logs/%s", newref))) {
				error("Directory not empty: logs/%s", newref);
				goto rollback;
			}
			goto retry;
		} else {
1225
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1226 1227 1228 1229 1230 1231
				newref, strerror(errno));
			goto rollback;
		}
	}
	logmoved = log;

1232
	lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1233 1234 1235 1236 1237 1238
	if (!lock) {
		error("unable to lock %s for update", newref);
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
1239
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1240 1241 1242 1243 1244 1245 1246
		error("unable to write current sha1 into %s", newref);
		goto rollback;
	}

	return 0;

 rollback:
1247
	lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264
	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 &&
1265 1266
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1267 1268 1269 1270 1271
			oldref, strerror(errno));

	return 1;
}

1272
int close_ref(struct ref_lock *lock)
1273 1274 1275 1276 1277 1278 1279
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

1280
int commit_ref(struct ref_lock *lock)
1281 1282 1283 1284 1285 1286 1287
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
1288
void unlock_ref(struct ref_lock *lock)
1289
{
B
Brandon Casey 已提交
1290 1291 1292
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
1293
	free(lock->ref_name);
1294
	free(lock->orig_ref_name);
1295 1296 1297
	free(lock);
}

1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323
/*
 * 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;
}

1324
int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1325
{
1326
	int logfd, oflags = O_APPEND | O_WRONLY;
1327

1328
	git_snpath(logfile, bufsize, "logs/%s", ref_name);
1329
	if (log_all_ref_updates &&
1330 1331
	    (!prefixcmp(ref_name, "refs/heads/") ||
	     !prefixcmp(ref_name, "refs/remotes/") ||
1332
	     !prefixcmp(ref_name, "refs/notes/") ||
N
Nicolas Pitre 已提交
1333
	     !strcmp(ref_name, "HEAD"))) {
1334
		if (safe_create_leading_directories(logfile) < 0)
1335
			return error("unable to create directory for %s",
1336
				     logfile);
1337 1338 1339
		oflags |= O_CREAT;
	}

1340
	logfd = open(logfile, oflags, 0666);
1341
	if (logfd < 0) {
J
Junio C Hamano 已提交
1342
		if (!(oflags & O_CREAT) && errno == ENOENT)
1343
			return 0;
1344 1345

		if ((oflags & O_CREAT) && errno == EISDIR) {
1346
			if (remove_empty_directories(logfile)) {
1347
				return error("There are still logs under '%s'",
1348
					     logfile);
1349
			}
1350
			logfd = open(logfile, oflags, 0666);
1351 1352 1353 1354
		}

		if (logfd < 0)
			return error("Unable to append to %s: %s",
1355
				     logfile, strerror(errno));
1356 1357
	}

1358
	adjust_shared_perm(logfile);
1359 1360 1361
	close(logfd);
	return 0;
}
1362

1363 1364 1365 1366 1367 1368
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;
1369
	char log_file[PATH_MAX];
1370 1371 1372 1373 1374 1375
	char *logrec;
	const char *committer;

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

1376
	result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1377 1378 1379 1380 1381 1382
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
1383
	msglen = msg ? strlen(msg) : 0;
1384
	committer = git_committer_info(0);
1385 1386 1387
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
1388 1389
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
1390 1391
		      committer);
	if (msglen)
1392
		len += copy_msg(logrec + len - 1, msg) - 1;
1393
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1394
	free(logrec);
1395
	if (close(logfd) != 0 || written != len)
1396
		return error("Unable to append to %s", log_file);
1397 1398 1399
	return 0;
}

1400 1401 1402 1403 1404
static int is_branch(const char *refname)
{
	return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
}

1405 1406 1407 1408
int write_ref_sha1(struct ref_lock *lock,
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
1409
	struct object *o;
1410 1411

	if (!lock)
D
Daniel Barkalow 已提交
1412
		return -1;
1413
	if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1414 1415
		unlock_ref(lock);
		return 0;
D
Daniel Barkalow 已提交
1416
	}
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
	o = parse_object(sha1);
	if (!o) {
		error("Trying to write ref %s with nonexistant object %s",
			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;
	}
1430 1431
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
	    write_in_full(lock->lock_fd, &term, 1) != 1
1432
		|| close_ref(lock) < 0) {
1433
		error("Couldn't write %s", lock->lk->filename);
1434 1435 1436
		unlock_ref(lock);
		return -1;
	}
1437
	invalidate_cached_refs();
N
Nicolas Pitre 已提交
1438 1439 1440
	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)) {
1441 1442 1443
		unlock_ref(lock);
		return -1;
	}
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
	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;
		head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
		if (head_ref && (head_flag & REF_ISSYMREF) &&
		    !strcmp(head_ref, lock->ref_name))
			log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
	}
1465
	if (commit_ref(lock)) {
1466
		error("Couldn't set %s", lock->ref_name);
1467 1468 1469 1470 1471
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
1472
}
1473

1474 1475
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
1476 1477 1478 1479
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
1480
	char *git_HEAD = git_pathdup("%s", ref_target);
1481 1482 1483 1484
	unsigned char old_sha1[20], new_sha1[20];

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

1486 1487 1488
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

1489 1490 1491 1492
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
1493
			goto done;
1494 1495 1496 1497 1498 1499 1500
		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);
1501
		goto error_free_return;
1502 1503 1504 1505 1506
	}
	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);
1507
		goto error_free_return;
1508 1509
	}
	written = write_in_full(fd, ref, len);
1510
	if (close(fd) != 0 || written != len) {
1511
		error("Unable to write to %s", lockpath);
1512
		goto error_unlink_return;
1513 1514 1515
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
1516
		goto error_unlink_return;
1517 1518 1519
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
1520
	error_unlink_return:
1521
		unlink_or_warn(lockpath);
1522 1523 1524
	error_free_return:
		free(git_HEAD);
		return -1;
1525
	}
1526

1527
#ifndef NO_SYMLINK_HEAD
1528
	done:
1529
#endif
1530 1531 1532
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

1533
	free(git_HEAD);
1534 1535 1536
	return 0;
}

1537 1538 1539 1540
static char *ref_msg(const char *line, const char *endp)
{
	const char *ep;
	line += 82;
P
Pierre Habouzit 已提交
1541 1542 1543 1544
	ep = memchr(line, '\n', endp - line);
	if (!ep)
		ep = endp;
	return xmemdupz(line, ep - line);
1545 1546 1547
}

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)
1548
{
1549
	const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1550
	char *tz_c;
J
Junio C Hamano 已提交
1551
	int logfd, tz, reccnt = 0;
1552 1553
	struct stat st;
	unsigned long date;
1554
	unsigned char logged_sha1[20];
1555
	void *log_mapped;
1556
	size_t mapsz;
1557 1558 1559 1560

	logfile = git_path("logs/%s", ref);
	logfd = open(logfile, O_RDONLY, 0);
	if (logfd < 0)
1561
		die_errno("Unable to read log '%s'", logfile);
1562 1563 1564
	fstat(logfd, &st);
	if (!st.st_size)
		die("Log %s is empty.", logfile);
1565 1566
	mapsz = xsize_t(st.st_size);
	log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1567
	logdata = log_mapped;
1568 1569
	close(logfd);

1570
	lastrec = NULL;
1571 1572
	rec = logend = logdata + st.st_size;
	while (logdata < rec) {
J
Junio C Hamano 已提交
1573
		reccnt++;
1574 1575
		if (logdata < rec && *(rec-1) == '\n')
			rec--;
1576 1577
		lastgt = NULL;
		while (logdata < rec && *(rec-1) != '\n') {
1578
			rec--;
1579 1580 1581 1582
			if (*rec == '>')
				lastgt = rec;
		}
		if (!lastgt)
1583
			die("Log %s is corrupt.", logfile);
1584
		date = strtoul(lastgt + 1, &tz_c, 10);
1585
		if (date <= at_time || cnt == 0) {
1586
			tz = strtoul(tz_c, NULL, 10);
1587 1588 1589 1590 1591 1592 1593
			if (msg)
				*msg = ref_msg(rec, logend);
			if (cutoff_time)
				*cutoff_time = date;
			if (cutoff_tz)
				*cutoff_tz = tz;
			if (cutoff_cnt)
1594
				*cutoff_cnt = reccnt - 1;
1595 1596 1597 1598 1599
			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);
1600
				if (hashcmp(logged_sha1, sha1)) {
1601
					warning("Log %s has gap after %s.",
1602
						logfile, show_date(date, tz, DATE_RFC2822));
1603
				}
J
Junio C Hamano 已提交
1604 1605
			}
			else if (date == at_time) {
1606 1607
				if (get_sha1_hex(rec + 41, sha1))
					die("Log %s is corrupt.", logfile);
J
Junio C Hamano 已提交
1608 1609
			}
			else {
1610 1611
				if (get_sha1_hex(rec + 41, logged_sha1))
					die("Log %s is corrupt.", logfile);
1612
				if (hashcmp(logged_sha1, sha1)) {
1613
					warning("Log %s unexpectedly ended on %s.",
1614
						logfile, show_date(date, tz, DATE_RFC2822));
1615 1616
				}
			}
1617
			munmap(log_mapped, mapsz);
1618 1619
			return 0;
		}
1620
		lastrec = rec;
1621 1622
		if (cnt > 0)
			cnt--;
1623 1624
	}

1625 1626 1627 1628
	rec = logdata;
	while (rec < logend && *rec != '>' && *rec != '\n')
		rec++;
	if (rec == logend || *rec == '\n')
1629
		die("Log %s is corrupt.", logfile);
1630
	date = strtoul(rec + 1, &tz_c, 10);
1631 1632 1633
	tz = strtoul(tz_c, NULL, 10);
	if (get_sha1_hex(logdata, sha1))
		die("Log %s is corrupt.", logfile);
J
Jeff King 已提交
1634 1635 1636 1637
	if (is_null_sha1(sha1)) {
		if (get_sha1_hex(logdata + 41, sha1))
			die("Log %s is corrupt.", logfile);
	}
1638 1639
	if (msg)
		*msg = ref_msg(logdata, logend);
1640
	munmap(log_mapped, mapsz);
1641 1642 1643 1644 1645 1646 1647 1648

	if (cutoff_time)
		*cutoff_time = date;
	if (cutoff_tz)
		*cutoff_tz = tz;
	if (cutoff_cnt)
		*cutoff_cnt = reccnt;
	return 1;
1649
}
1650

1651
int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1652 1653 1654
{
	const char *logfile;
	FILE *logfp;
1655
	struct strbuf sb = STRBUF_INIT;
1656
	int ret = 0;
1657 1658 1659 1660

	logfile = git_path("logs/%s", ref);
	logfp = fopen(logfile, "r");
	if (!logfp)
1661
		return -1;
1662 1663 1664 1665 1666 1667

	if (ofs) {
		struct stat statbuf;
		if (fstat(fileno(logfp), &statbuf) ||
		    statbuf.st_size < ofs ||
		    fseek(logfp, -ofs, SEEK_END) ||
1668
		    strbuf_getwholeline(&sb, logfp, '\n')) {
1669
			fclose(logfp);
1670
			strbuf_release(&sb);
1671
			return -1;
1672
		}
1673 1674
	}

1675
	while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1676
		unsigned char osha1[20], nsha1[20];
1677 1678
		char *email_end, *message;
		unsigned long timestamp;
1679
		int tz;
1680 1681

		/* old SP new SP name <email> SP time TAB msg LF */
1682 1683 1684 1685
		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, '>')) ||
1686 1687 1688 1689 1690
		    email_end[1] != ' ' ||
		    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
		    !message || message[0] != ' ' ||
		    (message[1] != '+' && message[1] != '-') ||
		    !isdigit(message[2]) || !isdigit(message[3]) ||
1691
		    !isdigit(message[4]) || !isdigit(message[5]))
1692
			continue; /* corrupt? */
1693 1694
		email_end[1] = '\0';
		tz = strtol(message + 1, NULL, 10);
1695 1696 1697 1698
		if (message[6] != '\t')
			message += 6;
		else
			message += 7;
1699 1700
		ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
			 cb_data);
1701
		if (ret)
1702
			break;
1703 1704
	}
	fclose(logfp);
1705
	strbuf_release(&sb);
1706
	return ret;
1707
}
J
Junio C Hamano 已提交
1708

1709 1710 1711 1712 1713
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);
}

1714 1715 1716
static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
{
	DIR *dir = opendir(git_path("logs/%s", base));
1717
	int retval = 0;
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756

	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];
				if (!resolve_ref(log, sha1, 0, NULL))
					retval = error("bad ref for %s", log);
				else
					retval = fn(log, sha1, 0, cb_data);
			}
			if (retval)
				break;
		}
		free(log);
		closedir(dir);
	}
1757
	else if (*base)
1758
		return errno;
1759 1760 1761 1762 1763 1764 1765
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
	return do_for_each_reflog("", fn, cb_data);
}
C
Carlos Rica 已提交
1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792

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

1794
struct ref *find_ref_by_name(const struct ref *list, const char *name)
1795 1796 1797
{
	for ( ; list; list = list->next)
		if (!strcmp(list->name, name))
1798
			return (struct ref *)list;
1799 1800
	return NULL;
}
J
Jeff King 已提交
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824

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

1825
char *shorten_unambiguous_ref(const char *ref, int strict)
J
Jeff King 已提交
1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861
{
	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;
1862
		int rules_to_fail = i;
J
Jeff King 已提交
1863 1864 1865 1866 1867 1868 1869
		int short_name_len;

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

		short_name_len = strlen(short_name);

1870 1871 1872 1873 1874 1875 1876
		/*
		 * 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 已提交
1877 1878 1879 1880
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
1881
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
1882 1883 1884 1885
			const char *rule = ref_rev_parse_rules[j];
			unsigned char short_objectname[20];
			char refname[PATH_MAX];

1886 1887 1888 1889
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904
			/*
			 * 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);
			if (!read_ref(refname, short_objectname))
				break;
		}

		/*
		 * short name is non-ambiguous if all previous rules
		 * haven't resolved to a valid ref
		 */
1905
		if (j == rules_to_fail)
J
Jeff King 已提交
1906 1907 1908 1909 1910 1911
			return short_name;
	}

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