refs.c 47.0 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 12
struct ref_list {
	struct ref_list *next;
13
	unsigned char flag; /* ISSYMREF? ISPACKED? */
14
	unsigned char sha1[20];
15
	unsigned char peeled[20];
16 17 18
	char name[FLEX_ARRAY];
};

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

44 45 46
	return line;
}

47
static struct ref_list *add_ref(const char *name, const unsigned char *sha1,
48 49
				int flag, struct ref_list *list,
				struct ref_list **new_entry)
50 51
{
	int len;
52
	struct ref_list *entry;
53 54 55 56 57

	/* Allocate it and add it in.. */
	len = strlen(name) + 1;
	entry = xmalloc(sizeof(struct ref_list) + len);
	hashcpy(entry->sha1, sha1);
58
	hashclr(entry->peeled);
59
	memcpy(entry->name, name, len);
60
	entry->flag = flag;
61
	entry->next = list;
62 63
	if (new_entry)
		*new_entry = entry;
64 65 66 67 68 69 70 71 72 73 74 75 76 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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
	return entry;
}

/* merge sort the ref list */
static struct ref_list *sort_ref_list(struct ref_list *list)
{
	int psize, qsize, last_merge_count, cmp;
	struct ref_list *p, *q, *l, *e;
	struct ref_list *new_list = list;
	int k = 1;
	int merge_count = 0;

	if (!list)
		return list;

	do {
		last_merge_count = merge_count;
		merge_count = 0;

		psize = 0;

		p = new_list;
		q = new_list;
		new_list = NULL;
		l = NULL;

		while (p) {
			merge_count++;

			while (psize < k && q->next) {
				q = q->next;
				psize++;
			}
			qsize = k;

			while ((psize > 0) || (qsize > 0 && q)) {
				if (qsize == 0 || !q) {
					e = p;
					p = p->next;
					psize--;
				} else if (psize == 0) {
					e = q;
					q = q->next;
					qsize--;
				} else {
					cmp = strcmp(q->name, p->name);
					if (cmp < 0) {
						e = q;
						q = q->next;
						qsize--;
					} else if (cmp > 0) {
						e = p;
						p = p->next;
						psize--;
					} else {
						if (hashcmp(q->sha1, p->sha1))
							die("Duplicated ref, and SHA1s don't match: %s",
							    q->name);
						warning("Duplicated ref: %s", q->name);
						e = q;
						q = q->next;
						qsize--;
						free(e);
						e = p;
						p = p->next;
						psize--;
					}
				}

				e->next = NULL;

				if (l)
					l->next = e;
				if (!new_list)
					new_list = e;
				l = e;
			}

			p = q;
		};

		k = k * 2;
	} while ((last_merge_count != merge_count) || (last_merge_count != 1));

	return new_list;
149 150
}

151 152 153 154
/*
 * Future: need to be in "struct repository"
 * when doing a full libification.
 */
J
Junio C Hamano 已提交
155
static struct cached_refs {
156 157 158 159
	char did_loose;
	char did_packed;
	struct ref_list *loose;
	struct ref_list *packed;
160
} cached_refs, submodule_refs;
161
static struct ref_list *current_ref;
162

163 164
static struct ref_list *extra_refs;

165 166 167 168 169 170 171 172 173 174
static void free_ref_list(struct ref_list *list)
{
	struct ref_list *next;
	for ( ; list; list = next) {
		next = list->next;
		free(list);
	}
}

static void invalidate_cached_refs(void)
175
{
176 177 178 179 180 181 182 183 184
	struct cached_refs *ca = &cached_refs;

	if (ca->did_loose && ca->loose)
		free_ref_list(ca->loose);
	if (ca->did_packed && ca->packed)
		free_ref_list(ca->packed);
	ca->loose = ca->packed = NULL;
	ca->did_loose = ca->did_packed = 0;
}
185

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
static void read_packed_refs(FILE *f, struct cached_refs *cached_refs)
{
	struct ref_list *list = NULL;
	struct ref_list *last = NULL;
	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) {
			list = add_ref(name, sha1, flag, list, &last);
			continue;
		}
		if (last &&
		    refline[0] == '^' &&
		    strlen(refline) == 42 &&
		    refline[41] == '\n' &&
		    !get_sha1_hex(refline + 1, sha1))
			hashcpy(last->peeled, sha1);
	}
218
	cached_refs->packed = sort_ref_list(list);
219 220
}

221 222 223 224 225 226 227 228 229 230 231
void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
{
	extra_refs = add_ref(name, sha1, flag, extra_refs, NULL);
}

void clear_extra_refs(void)
{
	free_ref_list(extra_refs);
	extra_refs = NULL;
}

232
static struct ref_list *get_packed_refs(const char *submodule)
233
{
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
	const char *packed_refs_file;
	struct cached_refs *refs;

	if (submodule) {
		packed_refs_file = git_path_submodule(submodule, "packed-refs");
		refs = &submodule_refs;
		free_ref_list(refs->packed);
	} else {
		packed_refs_file = git_path("packed-refs");
		refs = &cached_refs;
	}

	if (!refs->did_packed || submodule) {
		FILE *f = fopen(packed_refs_file, "r");
		refs->packed = NULL;
249
		if (f) {
250
			read_packed_refs(f, refs);
251 252
			fclose(f);
		}
253
		refs->did_packed = 1;
254
	}
255
	return refs->packed;
256 257
}

258 259
static struct ref_list *get_ref_dir(const char *submodule, const char *base,
				    struct ref_list *list)
260
{
261 262 263 264 265 266 267 268 269 270
	DIR *dir;
	const char *path;

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


	dir = opendir(path);
271 272 273 274

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

L
Linus Torvalds 已提交
277
		memcpy(ref, base, baselen);
278
		if (baselen && base[baselen-1] != '/')
L
Linus Torvalds 已提交
279
			ref[baselen++] = '/';
280 281 282 283

		while ((de = readdir(dir)) != NULL) {
			unsigned char sha1[20];
			struct stat st;
284
			int flag;
285
			int namelen;
286
			const char *refdir;
287 288 289 290 291 292 293 294

			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 已提交
295
			memcpy(ref + baselen, de->d_name, namelen+1);
296 297 298 299
			refdir = submodule
				? git_path_submodule(submodule, "%s", ref)
				: git_path("%s", ref);
			if (stat(refdir, &st) < 0)
300 301
				continue;
			if (S_ISDIR(st.st_mode)) {
302
				list = get_ref_dir(submodule, ref, list);
303 304
				continue;
			}
305
			if (submodule) {
306
				hashclr(sha1);
307 308 309 310 311 312 313 314 315 316
				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;
				}
317
			list = add_ref(ref, sha1, flag, list, NULL);
318
		}
L
Linus Torvalds 已提交
319
		free(ref);
320 321
		closedir(dir);
	}
322
	return sort_ref_list(list);
323 324
}

325
struct warn_if_dangling_data {
326
	FILE *fp;
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
	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;

345
	fprintf(d->fp, d->msg_fmt, refname);
346 347 348
	return 0;
}

349
void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
350
{
351 352 353 354 355
	struct warn_if_dangling_data data;

	data.fp = fp;
	data.refname = refname;
	data.msg_fmt = msg_fmt;
356 357 358
	for_each_rawref(warn_if_dangling_symref, &data);
}

359
static struct ref_list *get_loose_refs(const char *submodule)
360
{
361 362 363 364 365 366
	if (submodule) {
		free_ref_list(submodule_refs.loose);
		submodule_refs.loose = get_ref_dir(submodule, "refs", NULL);
		return submodule_refs.loose;
	}

367
	if (!cached_refs.did_loose) {
368
		cached_refs.loose = get_ref_dir(NULL, "refs", NULL);
369
		cached_refs.did_loose = 1;
370
	}
371
	return cached_refs.loose;
372 373
}

374 375
/* We allow "recursive" symbolic refs. Only within reason, though */
#define MAXDEPTH 5
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 416 417 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
#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;
	struct ref_list *ref;
	int retval;

	strcpy(name + pathlen, "packed-refs");
	f = fopen(name, "r");
	if (!f)
		return -1;
	read_packed_refs(f, &refs);
	fclose(f);
	ref = refs.packed;
	retval = -1;
	while (ref) {
		if (!strcmp(ref->name, refname)) {
			retval = 0;
			memcpy(result, ref->sha1, 20);
			break;
		}
		ref = ref->next;
	}
	free_ref_list(refs.packed);
	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;
443
	const char *tmp;
444 445 446 447 448 449 450

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

454
	tmp = read_gitfile(gitdir);
455 456 457 458 459 460 461 462 463
	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);
464 465 466
	free(gitdir);
	return retval;
}
467

468 469 470 471 472 473 474 475 476 477 478 479
/*
 * 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.
 */
480
const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
481
{
482 483
	int depth = MAXDEPTH;
	ssize_t len;
484
	char buffer[256];
L
Linus Torvalds 已提交
485
	static char ref_buffer[256];
486

487 488 489
	if (flag)
		*flag = 0;

490
	for (;;) {
491
		char path[PATH_MAX];
492 493 494
		struct stat st;
		char *buf;
		int fd;
495

496 497
		if (--depth < 0)
			return NULL;
498

499
		git_snpath(path, sizeof(path), "%s", ref);
500
		/* Special case: non-existing file. */
501
		if (lstat(path, &st) < 0) {
502
			struct ref_list *list = get_packed_refs(NULL);
503
			while (list) {
504
				if (!strcmp(ref, list->name)) {
505
					hashcpy(sha1, list->sha1);
506 507
					if (flag)
						*flag |= REF_ISPACKED;
508 509 510 511
					return ref;
				}
				list = list->next;
			}
512 513
			if (reading || errno != ENOENT)
				return NULL;
514
			hashclr(sha1);
L
Linus Torvalds 已提交
515
			return ref;
516
		}
517

518 519 520 521
		/* 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 已提交
522 523 524
				buffer[len] = 0;
				strcpy(ref_buffer, buffer);
				ref = ref_buffer;
525 526
				if (flag)
					*flag |= REF_ISSYMREF;
527 528
				continue;
			}
529
		}
530

531 532 533 534 535 536
		/* Is it a directory? */
		if (S_ISDIR(st.st_mode)) {
			errno = EISDIR;
			return NULL;
		}

537 538 539 540 541 542 543
		/*
		 * Anything else, just open it and try to use it as
		 * a ref
		 */
		fd = open(path, O_RDONLY);
		if (fd < 0)
			return NULL;
544
		len = read_in_full(fd, buffer, sizeof(buffer)-1);
545 546 547 548 549 550 551 552 553 554 555 556
		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 已提交
557 558 559 560
			len--;
		buf[len] = 0;
		memcpy(ref_buffer, buf, len + 1);
		ref = ref_buffer;
561 562
		if (flag)
			*flag |= REF_ISSYMREF;
563
	}
564 565
	if (len < 40 || get_sha1_hex(buffer, sha1))
		return NULL;
L
Linus Torvalds 已提交
566
	return ref;
567 568
}

I
Ilari Liusvaara 已提交
569 570 571 572 573 574 575
/* The argument to filter_refs */
struct ref_filter {
	const char *pattern;
	each_ref_fn *fn;
	void *cb_data;
};

L
Linus Torvalds 已提交
576
int read_ref(const char *ref, unsigned char *sha1)
577
{
578
	if (resolve_ref(ref, sha1, 1, NULL))
579 580
		return 0;
	return -1;
581 582
}

583
#define DO_FOR_EACH_INCLUDE_BROKEN 01
584
static int do_one_ref(const char *base, each_ref_fn fn, int trim,
585
		      int flags, void *cb_data, struct ref_list *entry)
586
{
587
	if (prefixcmp(entry->name, base))
588
		return 0;
589

590
	if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
591 592
		if (entry->flag & REF_BROKEN)
			return 0; /* ignore dangling symref */
593 594 595 596
		if (!has_sha1_file(entry->sha1)) {
			error("%s does not point to a valid object!", entry->name);
			return 0;
		}
597
	}
598
	current_ref = entry;
599 600 601
	return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
}

I
Ilari Liusvaara 已提交
602 603 604 605 606 607 608 609 610
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);
}

611 612 613 614 615 616
int peel_ref(const char *ref, unsigned char *sha1)
{
	int flag;
	unsigned char base[20];
	struct object *o;

617 618 619 620 621 622 623 624 625 626
	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;
	}

627 628 629 630
	if (!resolve_ref(ref, base, 1, &flag))
		return -1;

	if ((flag & REF_ISPACKED)) {
631
		struct ref_list *list = get_packed_refs(NULL);
632 633

		while (list) {
634 635 636 637 638 639 640
			if (!strcmp(list->name, ref)) {
				if (list->flag & REF_KNOWS_PEELED) {
					hashcpy(sha1, list->peeled);
					return 0;
				}
				/* older pack-refs did not leave peeled ones */
				break;
641 642 643 644 645
			}
			list = list->next;
		}
	}

646
fallback:
647
	o = parse_object(base);
648
	if (o && o->type == OBJ_TAG) {
649 650 651 652 653 654 655 656 657
		o = deref_tag(o, ref, 0);
		if (o) {
			hashcpy(sha1, o->sha1);
			return 0;
		}
	}
	return -1;
}

658 659
static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
			   int trim, int flags, void *cb_data)
660
{
661
	int retval = 0;
662 663
	struct ref_list *packed = get_packed_refs(submodule);
	struct ref_list *loose = get_loose_refs(submodule);
664

665 666 667
	struct ref_list *extra;

	for (extra = extra_refs; extra; extra = extra->next)
668
		retval = do_one_ref(base, fn, trim, flags, cb_data, extra);
669

670 671 672 673 674 675
	while (packed && loose) {
		struct ref_list *entry;
		int cmp = strcmp(packed->name, loose->name);
		if (!cmp) {
			packed = packed->next;
			continue;
676
		}
677 678 679 680 681 682 683
		if (cmp > 0) {
			entry = loose;
			loose = loose->next;
		} else {
			entry = packed;
			packed = packed->next;
		}
684
		retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
685
		if (retval)
686
			goto end_each;
687
	}
688

689
	for (packed = packed ? packed : loose; packed; packed = packed->next) {
690
		retval = do_one_ref(base, fn, trim, flags, cb_data, packed);
691
		if (retval)
692
			goto end_each;
693
	}
694 695 696 697

end_each:
	current_ref = NULL;
	return retval;
698 699
}

700 701

static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
702 703
{
	unsigned char sha1[20];
704 705
	int flag;

706 707 708 709 710 711 712
	if (submodule) {
		if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
			return fn("HEAD", sha1, 0, cb_data);

		return 0;
	}

713 714
	if (resolve_ref("HEAD", sha1, 1, &flag))
		return fn("HEAD", sha1, flag, cb_data);
715

716
	return 0;
717 718
}

719 720 721 722 723
int head_ref(each_ref_fn fn, void *cb_data)
{
	return do_head_ref(NULL, fn, cb_data);
}

724 725 726 727 728
int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
	return do_head_ref(submodule, fn, cb_data);
}

729
int for_each_ref(each_ref_fn fn, void *cb_data)
730
{
731
	return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
732 733
}

734 735
int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
{
736
	return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
737 738
}

739 740
int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
{
741
	return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
742 743
}

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

750
int for_each_tag_ref(each_ref_fn fn, void *cb_data)
751
{
752
	return for_each_ref_in("refs/tags/", fn, cb_data);
753 754
}

755 756 757 758 759
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);
}

760
int for_each_branch_ref(each_ref_fn fn, void *cb_data)
761
{
762
	return for_each_ref_in("refs/heads/", fn, cb_data);
763 764
}

765 766 767 768 769
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);
}

770
int for_each_remote_ref(each_ref_fn fn, void *cb_data)
771
{
772
	return for_each_ref_in("refs/remotes/", fn, cb_data);
773 774
}

775 776 777 778 779
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);
}

780 781
int for_each_replace_ref(each_ref_fn fn, void *cb_data)
{
782
	return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
783 784
}

J
Josh Triplett 已提交
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
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());
	if (resolve_ref(buf.buf, sha1, 1, &flag))
		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;
}

810 811
int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
	const char *prefix, void *cb_data)
I
Ilari Liusvaara 已提交
812 813 814 815 816
{
	struct strbuf real_pattern = STRBUF_INIT;
	struct ref_filter filter;
	int ret;

817
	if (!prefix && prefixcmp(pattern, "refs/"))
I
Ilari Liusvaara 已提交
818
		strbuf_addstr(&real_pattern, "refs/");
819 820
	else if (prefix)
		strbuf_addstr(&real_pattern, prefix);
I
Ilari Liusvaara 已提交
821 822
	strbuf_addstr(&real_pattern, pattern);

823
	if (!has_glob_specials(pattern)) {
824
		/* Append implied '/' '*' if not present. */
I
Ilari Liusvaara 已提交
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
		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;
}

840 841 842 843 844
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);
}

845 846
int for_each_rawref(each_ref_fn fn, void *cb_data)
{
847
	return do_for_each_ref(NULL, "", fn, 0,
848
			       DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
849 850
}

851 852 853 854 855 856 857 858
/*
 * 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 "/".
859
 * - it ends with ".lock"
R
Robin Rosenberg 已提交
860
 * - it contains a "\" (backslash)
861 862 863 864
 */

static inline int bad_ref_char(int ch)
{
865
	if (((unsigned) ch) <= ' ' || ch == 0x7f ||
R
Robin Rosenberg 已提交
866
	    ch == '~' || ch == '^' || ch == ':' || ch == '\\')
867 868 869 870 871 872 873
		return 1;
	/* 2.13 Pattern Matching Notation */
	if (ch == '?' || ch == '[') /* Unsupported */
		return 1;
	if (ch == '*') /* Supported at the end */
		return 2;
	return 0;
874 875
}

D
Daniel Barkalow 已提交
876 877
int check_ref_format(const char *ref)
{
878
	int ch, level, bad_type, last;
879
	int ret = CHECK_REF_FORMAT_OK;
880 881 882 883 884 885 886
	const char *cp = ref;

	level = 0;
	while (1) {
		while ((ch = *cp++) == '/')
			; /* tolerate duplicated slashes */
		if (!ch)
887 888
			/* should not end with slashes */
			return CHECK_REF_FORMAT_ERROR;
889 890

		/* we are at the beginning of the path component */
891
		if (ch == '.')
892
			return CHECK_REF_FORMAT_ERROR;
893 894
		bad_type = bad_ref_char(ch);
		if (bad_type) {
895 896 897 898 899
			if (bad_type == 2 && (!*cp || *cp == '/') &&
			    ret == CHECK_REF_FORMAT_OK)
				ret = CHECK_REF_FORMAT_WILDCARD;
			else
				return CHECK_REF_FORMAT_ERROR;
900
		}
901

902
		last = ch;
903 904
		/* scan the rest of the path component */
		while ((ch = *cp++) != 0) {
905
			bad_type = bad_ref_char(ch);
906
			if (bad_type)
D
Daniel Barkalow 已提交
907
				return CHECK_REF_FORMAT_ERROR;
908 909
			if (ch == '/')
				break;
910 911 912
			if (last == '.' && ch == '.')
				return CHECK_REF_FORMAT_ERROR;
			if (last == '@' && ch == '{')
913
				return CHECK_REF_FORMAT_ERROR;
914
			last = ch;
915 916 917
		}
		level++;
		if (!ch) {
918 919
			if (ref <= cp - 2 && cp[-2] == '.')
				return CHECK_REF_FORMAT_ERROR;
920
			if (level < 2)
921
				return CHECK_REF_FORMAT_ONELEVEL;
922 923
			if (has_extension(ref, ".lock"))
				return CHECK_REF_FORMAT_ERROR;
924
			return ret;
925 926
		}
	}
D
Daniel Barkalow 已提交
927 928
}

929
const char *prettify_refname(const char *name)
930 931 932 933 934 935 936 937
{
	return name + (
		!prefixcmp(name, "refs/heads/") ? 11 :
		!prefixcmp(name, "refs/tags/") ? 10 :
		!prefixcmp(name, "refs/remotes/") ? 13 :
		0);
}

S
Steffen Prohaska 已提交
938 939 940 941 942 943 944 945 946 947
const char *ref_rev_parse_rules[] = {
	"%.*s",
	"refs/%.*s",
	"refs/tags/%.*s",
	"refs/heads/%.*s",
	"refs/remotes/%.*s",
	"refs/remotes/%.*s/HEAD",
	NULL
};

948 949 950 951 952 953 954
const char *ref_fetch_rules[] = {
	"%.*s",
	"refs/%.*s",
	"refs/heads/%.*s",
	NULL
};

S
Steffen Prohaska 已提交
955 956 957 958 959 960 961 962 963 964 965 966 967 968
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 已提交
969
static struct ref_lock *verify_lock(struct ref_lock *lock,
970 971
	const unsigned char *old_sha1, int mustexist)
{
972
	if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
973
		error("Can't verify ref %s", lock->ref_name);
974 975 976
		unlock_ref(lock);
		return NULL;
	}
977
	if (hashcmp(lock->old_sha1, old_sha1)) {
978
		error("Ref %s is at %s but expected %s", lock->ref_name,
979 980 981 982 983 984 985
			sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
		unlock_ref(lock);
		return NULL;
	}
	return lock;
}

986
static int remove_empty_directories(const char *file)
987 988 989 990 991
{
	/* 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.
	 */
992 993
	struct strbuf path;
	int result;
994

995 996 997
	strbuf_init(&path, 20);
	strbuf_addstr(&path, file);

998
	result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
999 1000 1001 1002

	strbuf_release(&path);

	return result;
1003 1004
}

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
static int is_refname_available(const char *ref, const char *oldref,
				struct ref_list *list, int quiet)
{
	int namlen = strlen(ref); /* e.g. 'foo/bar' */
	while (list) {
		/* list->name could be 'foo' or 'foo/bar/baz' */
		if (!oldref || strcmp(oldref, list->name)) {
			int len = strlen(list->name);
			int cmplen = (namlen < len) ? namlen : len;
			const char *lead = (namlen < len) ? list->name : ref;
			if (!strncmp(ref, list->name, cmplen) &&
			    lead[cmplen] == '/') {
				if (!quiet)
					error("'%s' exists; cannot create '%s'",
					      list->name, ref);
				return 0;
			}
		}
		list = list->next;
	}
	return 1;
}

1028
static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
1029
{
1030
	char *ref_file;
L
Linus Torvalds 已提交
1031
	const char *orig_ref = ref;
1032
	struct ref_lock *lock;
1033
	int last_errno = 0;
1034
	int type, lflags;
1035
	int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1036
	int missing = 0;
1037 1038 1039 1040

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

1041
	ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
1042 1043 1044 1045 1046 1047 1048
	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);
1049 1050 1051 1052 1053
		if (remove_empty_directories(ref_file)) {
			last_errno = errno;
			error("there are still refs under '%s'", orig_ref);
			goto error_return;
		}
1054
		ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
1055
	}
1056 1057
	if (type_p)
	    *type_p = type;
L
Linus Torvalds 已提交
1058
	if (!ref) {
1059
		last_errno = errno;
1060
		error("unable to resolve reference %s: %s",
L
Linus Torvalds 已提交
1061
			orig_ref, strerror(errno));
1062
		goto error_return;
1063
	}
1064
	missing = is_null_sha1(lock->old_sha1);
1065 1066 1067 1068 1069
	/* 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.
	 */
1070
	if (missing &&
1071
	     !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1072
		last_errno = ENOTDIR;
1073
		goto error_return;
1074
	}
1075

1076
	lock->lk = xcalloc(1, sizeof(struct lock_file));
1077

1078 1079
	lflags = LOCK_DIE_ON_ERROR;
	if (flags & REF_NODEREF) {
1080
		ref = orig_ref;
1081 1082
		lflags |= LOCK_NODEREF;
	}
1083
	lock->ref_name = xstrdup(ref);
1084
	lock->orig_ref_name = xstrdup(orig_ref);
P
Petr Baudis 已提交
1085
	ref_file = git_path("%s", ref);
1086
	if (missing)
1087 1088 1089
		lock->force_write = 1;
	if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
		lock->force_write = 1;
1090

1091 1092 1093 1094 1095
	if (safe_create_leading_directories(ref_file)) {
		last_errno = errno;
		error("unable to create directory for %s", ref_file);
		goto error_return;
	}
1096

1097
	lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1098
	return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1099 1100 1101 1102 1103

 error_return:
	unlock_ref(lock);
	errno = last_errno;
	return NULL;
1104 1105
}

1106
struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
D
Daniel Barkalow 已提交
1107
{
P
Petr Baudis 已提交
1108
	char refpath[PATH_MAX];
D
Daniel Barkalow 已提交
1109
	if (check_ref_format(ref))
1110
		return NULL;
P
Petr Baudis 已提交
1111
	strcpy(refpath, mkpath("refs/%s", ref));
1112
	return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1113 1114
}

1115
struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1116
{
1117 1118
	switch (check_ref_format(ref)) {
	default:
1119 1120 1121
		return NULL;
	case 0:
	case CHECK_REF_FORMAT_ONELEVEL:
1122 1123
		return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
	}
J
Junio C Hamano 已提交
1124 1125
}

1126 1127
static struct lock_file packlock;

J
Junio C Hamano 已提交
1128 1129 1130 1131 1132 1133
static int repack_without_ref(const char *refname)
{
	struct ref_list *list, *packed_ref_list;
	int fd;
	int found = 0;

1134
	packed_ref_list = get_packed_refs(NULL);
J
Junio C Hamano 已提交
1135 1136 1137 1138 1139 1140 1141 1142 1143
	for (list = packed_ref_list; list; list = list->next) {
		if (!strcmp(refname, list->name)) {
			found = 1;
			break;
		}
	}
	if (!found)
		return 0;
	fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1144 1145
	if (fd < 0) {
		unable_to_lock_error(git_path("packed-refs"), errno);
J
Junio C Hamano 已提交
1146
		return error("cannot delete '%s' from packed refs", refname);
1147
	}
J
Junio C Hamano 已提交
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164

	for (list = packed_ref_list; list; list = list->next) {
		char line[PATH_MAX + 100];
		int len;

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

M
Miklos Vajna 已提交
1165
int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
J
Junio C Hamano 已提交
1166 1167
{
	struct ref_lock *lock;
M
Miklos Vajna 已提交
1168
	int err, i = 0, ret = 0, flag = 0;
J
Junio C Hamano 已提交
1169

1170
	lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
J
Junio C Hamano 已提交
1171 1172
	if (!lock)
		return 1;
1173
	if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
J
Junio C Hamano 已提交
1174
		/* loose */
M
Miklos Vajna 已提交
1175 1176 1177 1178 1179 1180 1181
		const char *path;

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

M
Miklos Vajna 已提交
1188 1189
		if (!(delopt & REF_NODEREF))
			lock->lk->filename[i] = '.';
J
Junio C Hamano 已提交
1190 1191 1192 1193 1194 1195 1196
	}
	/* 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);

1197
	unlink_or_warn(git_path("logs/%s", lock->ref_name));
J
Junio C Hamano 已提交
1198 1199 1200
	invalidate_cached_refs();
	unlock_ref(lock);
	return ret;
1201 1202
}

1203 1204 1205 1206 1207 1208 1209 1210 1211
/*
 * 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"

1212
int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1213 1214 1215 1216 1217 1218
{
	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;
1219
	int log = !lstat(git_path("logs/%s", oldref), &loginfo);
M
Miklos Vajna 已提交
1220
	const char *symref = NULL;
1221

1222
	if (log && S_ISLNK(loginfo.st_mode))
1223 1224
		return error("reflog for %s is a symlink", oldref);

M
Miklos Vajna 已提交
1225 1226
	symref = resolve_ref(oldref, orig_sha1, 1, &flag);
	if (flag & REF_ISSYMREF)
1227 1228
		return error("refname %s is a symbolic ref, renaming it is not supported",
			oldref);
M
Miklos Vajna 已提交
1229
	if (!symref)
1230 1231
		return error("refname %s not found", oldref);

1232
	if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1233 1234
		return 1;

1235
	if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1236 1237
		return 1;

1238
	lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1239 1240 1241
	if (!lock)
		return error("unable to lock %s", renamed_ref);
	lock->force_write = 1;
1242
	if (write_ref_sha1(lock, orig_sha1, logmsg))
1243 1244
		return error("unable to save current sha1 in %s", renamed_ref);

1245 1246
	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",
1247 1248
			oldref, strerror(errno));

M
Miklos Vajna 已提交
1249
	if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1250 1251 1252 1253
		error("unable to delete old %s", oldref);
		goto rollback;
	}

M
Miklos Vajna 已提交
1254
	if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
		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:
1272
	if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1273 1274 1275 1276 1277 1278
		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.
			 */
1279 1280 1281 1282 1283 1284
			if (remove_empty_directories(git_path("logs/%s", newref))) {
				error("Directory not empty: logs/%s", newref);
				goto rollback;
			}
			goto retry;
		} else {
1285
			error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1286 1287 1288 1289 1290 1291
				newref, strerror(errno));
			goto rollback;
		}
	}
	logmoved = log;

1292
	lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1293 1294 1295 1296 1297 1298
	if (!lock) {
		error("unable to lock %s for update", newref);
		goto rollback;
	}
	lock->force_write = 1;
	hashcpy(lock->old_sha1, orig_sha1);
1299
	if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1300 1301 1302 1303 1304 1305 1306
		error("unable to write current sha1 into %s", newref);
		goto rollback;
	}

	return 0;

 rollback:
1307
	lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
	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 &&
1325 1326
	    rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
		error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1327 1328 1329 1330 1331
			oldref, strerror(errno));

	return 1;
}

1332
int close_ref(struct ref_lock *lock)
1333 1334 1335 1336 1337 1338 1339
{
	if (close_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

1340
int commit_ref(struct ref_lock *lock)
1341 1342 1343 1344 1345 1346 1347
{
	if (commit_lock_file(lock->lk))
		return -1;
	lock->lock_fd = -1;
	return 0;
}

J
Junio C Hamano 已提交
1348
void unlock_ref(struct ref_lock *lock)
1349
{
B
Brandon Casey 已提交
1350 1351 1352
	/* Do not free lock->lk -- atexit() still looks at them */
	if (lock->lk)
		rollback_lock_file(lock->lk);
1353
	free(lock->ref_name);
1354
	free(lock->orig_ref_name);
1355 1356 1357
	free(lock);
}

1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383
/*
 * 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;
}

1384
int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1385
{
1386
	int logfd, oflags = O_APPEND | O_WRONLY;
1387

1388
	git_snpath(logfile, bufsize, "logs/%s", ref_name);
1389
	if (log_all_ref_updates &&
1390 1391
	    (!prefixcmp(ref_name, "refs/heads/") ||
	     !prefixcmp(ref_name, "refs/remotes/") ||
1392
	     !prefixcmp(ref_name, "refs/notes/") ||
N
Nicolas Pitre 已提交
1393
	     !strcmp(ref_name, "HEAD"))) {
1394
		if (safe_create_leading_directories(logfile) < 0)
1395
			return error("unable to create directory for %s",
1396
				     logfile);
1397 1398 1399
		oflags |= O_CREAT;
	}

1400
	logfd = open(logfile, oflags, 0666);
1401
	if (logfd < 0) {
J
Junio C Hamano 已提交
1402
		if (!(oflags & O_CREAT) && errno == ENOENT)
1403
			return 0;
1404 1405

		if ((oflags & O_CREAT) && errno == EISDIR) {
1406
			if (remove_empty_directories(logfile)) {
1407
				return error("There are still logs under '%s'",
1408
					     logfile);
1409
			}
1410
			logfd = open(logfile, oflags, 0666);
1411 1412 1413 1414
		}

		if (logfd < 0)
			return error("Unable to append to %s: %s",
1415
				     logfile, strerror(errno));
1416 1417
	}

1418
	adjust_shared_perm(logfile);
1419 1420 1421
	close(logfd);
	return 0;
}
1422

1423 1424 1425 1426 1427 1428
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;
1429
	char log_file[PATH_MAX];
1430 1431 1432 1433 1434 1435
	char *logrec;
	const char *committer;

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

1436
	result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1437 1438 1439 1440 1441 1442
	if (result)
		return result;

	logfd = open(log_file, oflags);
	if (logfd < 0)
		return 0;
1443
	msglen = msg ? strlen(msg) : 0;
1444
	committer = git_committer_info(0);
1445 1446 1447
	maxlen = strlen(committer) + msglen + 100;
	logrec = xmalloc(maxlen);
	len = sprintf(logrec, "%s %s %s\n",
1448 1449
		      sha1_to_hex(old_sha1),
		      sha1_to_hex(new_sha1),
1450 1451
		      committer);
	if (msglen)
1452
		len += copy_msg(logrec + len - 1, msg) - 1;
1453
	written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1454
	free(logrec);
1455
	if (close(logfd) != 0 || written != len)
1456
		return error("Unable to append to %s", log_file);
1457 1458 1459
	return 0;
}

1460 1461 1462 1463 1464
static int is_branch(const char *refname)
{
	return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
}

1465 1466 1467 1468
int write_ref_sha1(struct ref_lock *lock,
	const unsigned char *sha1, const char *logmsg)
{
	static char term = '\n';
1469
	struct object *o;
1470 1471

	if (!lock)
D
Daniel Barkalow 已提交
1472
		return -1;
1473
	if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1474 1475
		unlock_ref(lock);
		return 0;
D
Daniel Barkalow 已提交
1476
	}
1477 1478
	o = parse_object(sha1);
	if (!o) {
D
Dmitry Ivankov 已提交
1479
		error("Trying to write ref %s with nonexistent object %s",
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489
			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;
	}
1490 1491
	if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
	    write_in_full(lock->lock_fd, &term, 1) != 1
1492
		|| close_ref(lock) < 0) {
1493
		error("Couldn't write %s", lock->lk->filename);
1494 1495 1496
		unlock_ref(lock);
		return -1;
	}
1497
	invalidate_cached_refs();
N
Nicolas Pitre 已提交
1498 1499 1500
	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)) {
1501 1502 1503
		unlock_ref(lock);
		return -1;
	}
1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524
	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);
	}
1525
	if (commit_ref(lock)) {
1526
		error("Couldn't set %s", lock->ref_name);
1527 1528 1529 1530 1531
		unlock_ref(lock);
		return -1;
	}
	unlock_ref(lock);
	return 0;
D
Daniel Barkalow 已提交
1532
}
1533

1534 1535
int create_symref(const char *ref_target, const char *refs_heads_master,
		  const char *logmsg)
1536 1537 1538 1539
{
	const char *lockpath;
	char ref[1000];
	int fd, len, written;
1540
	char *git_HEAD = git_pathdup("%s", ref_target);
1541 1542 1543 1544
	unsigned char old_sha1[20], new_sha1[20];

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

1546 1547 1548
	if (safe_create_leading_directories(git_HEAD) < 0)
		return error("unable to create directory for %s", git_HEAD);

1549 1550 1551 1552
#ifndef NO_SYMLINK_HEAD
	if (prefer_symlink_refs) {
		unlink(git_HEAD);
		if (!symlink(refs_heads_master, git_HEAD))
1553
			goto done;
1554 1555 1556 1557 1558 1559 1560
		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);
1561
		goto error_free_return;
1562 1563 1564 1565 1566
	}
	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);
1567
		goto error_free_return;
1568 1569
	}
	written = write_in_full(fd, ref, len);
1570
	if (close(fd) != 0 || written != len) {
1571
		error("Unable to write to %s", lockpath);
1572
		goto error_unlink_return;
1573 1574 1575
	}
	if (rename(lockpath, git_HEAD) < 0) {
		error("Unable to create %s", git_HEAD);
1576
		goto error_unlink_return;
1577 1578 1579
	}
	if (adjust_shared_perm(git_HEAD)) {
		error("Unable to fix permissions on %s", lockpath);
1580
	error_unlink_return:
1581
		unlink_or_warn(lockpath);
1582 1583 1584
	error_free_return:
		free(git_HEAD);
		return -1;
1585
	}
1586

1587
#ifndef NO_SYMLINK_HEAD
1588
	done:
1589
#endif
1590 1591 1592
	if (logmsg && !read_ref(refs_heads_master, new_sha1))
		log_ref_write(ref_target, old_sha1, new_sha1, logmsg);

1593
	free(git_HEAD);
1594 1595 1596
	return 0;
}

1597 1598 1599 1600
static char *ref_msg(const char *line, const char *endp)
{
	const char *ep;
	line += 82;
P
Pierre Habouzit 已提交
1601 1602 1603 1604
	ep = memchr(line, '\n', endp - line);
	if (!ep)
		ep = endp;
	return xmemdupz(line, ep - line);
1605 1606 1607
}

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)
1608
{
1609
	const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1610
	char *tz_c;
J
Junio C Hamano 已提交
1611
	int logfd, tz, reccnt = 0;
1612 1613
	struct stat st;
	unsigned long date;
1614
	unsigned char logged_sha1[20];
1615
	void *log_mapped;
1616
	size_t mapsz;
1617 1618 1619 1620

	logfile = git_path("logs/%s", ref);
	logfd = open(logfile, O_RDONLY, 0);
	if (logfd < 0)
1621
		die_errno("Unable to read log '%s'", logfile);
1622 1623 1624
	fstat(logfd, &st);
	if (!st.st_size)
		die("Log %s is empty.", logfile);
1625 1626
	mapsz = xsize_t(st.st_size);
	log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1627
	logdata = log_mapped;
1628 1629
	close(logfd);

1630
	lastrec = NULL;
1631 1632
	rec = logend = logdata + st.st_size;
	while (logdata < rec) {
J
Junio C Hamano 已提交
1633
		reccnt++;
1634 1635
		if (logdata < rec && *(rec-1) == '\n')
			rec--;
1636 1637
		lastgt = NULL;
		while (logdata < rec && *(rec-1) != '\n') {
1638
			rec--;
1639 1640 1641 1642
			if (*rec == '>')
				lastgt = rec;
		}
		if (!lastgt)
1643
			die("Log %s is corrupt.", logfile);
1644
		date = strtoul(lastgt + 1, &tz_c, 10);
1645
		if (date <= at_time || cnt == 0) {
1646
			tz = strtoul(tz_c, NULL, 10);
1647 1648 1649 1650 1651 1652 1653
			if (msg)
				*msg = ref_msg(rec, logend);
			if (cutoff_time)
				*cutoff_time = date;
			if (cutoff_tz)
				*cutoff_tz = tz;
			if (cutoff_cnt)
1654
				*cutoff_cnt = reccnt - 1;
1655 1656 1657 1658 1659
			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);
1660
				if (hashcmp(logged_sha1, sha1)) {
1661
					warning("Log %s has gap after %s.",
1662
						logfile, show_date(date, tz, DATE_RFC2822));
1663
				}
J
Junio C Hamano 已提交
1664 1665
			}
			else if (date == at_time) {
1666 1667
				if (get_sha1_hex(rec + 41, sha1))
					die("Log %s is corrupt.", logfile);
J
Junio C Hamano 已提交
1668 1669
			}
			else {
1670 1671
				if (get_sha1_hex(rec + 41, logged_sha1))
					die("Log %s is corrupt.", logfile);
1672
				if (hashcmp(logged_sha1, sha1)) {
1673
					warning("Log %s unexpectedly ended on %s.",
1674
						logfile, show_date(date, tz, DATE_RFC2822));
1675 1676
				}
			}
1677
			munmap(log_mapped, mapsz);
1678 1679
			return 0;
		}
1680
		lastrec = rec;
1681 1682
		if (cnt > 0)
			cnt--;
1683 1684
	}

1685 1686 1687 1688
	rec = logdata;
	while (rec < logend && *rec != '>' && *rec != '\n')
		rec++;
	if (rec == logend || *rec == '\n')
1689
		die("Log %s is corrupt.", logfile);
1690
	date = strtoul(rec + 1, &tz_c, 10);
1691 1692 1693
	tz = strtoul(tz_c, NULL, 10);
	if (get_sha1_hex(logdata, sha1))
		die("Log %s is corrupt.", logfile);
J
Jeff King 已提交
1694 1695 1696 1697
	if (is_null_sha1(sha1)) {
		if (get_sha1_hex(logdata + 41, sha1))
			die("Log %s is corrupt.", logfile);
	}
1698 1699
	if (msg)
		*msg = ref_msg(logdata, logend);
1700
	munmap(log_mapped, mapsz);
1701 1702 1703 1704 1705 1706 1707 1708

	if (cutoff_time)
		*cutoff_time = date;
	if (cutoff_tz)
		*cutoff_tz = tz;
	if (cutoff_cnt)
		*cutoff_cnt = reccnt;
	return 1;
1709
}
1710

1711
int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1712 1713 1714
{
	const char *logfile;
	FILE *logfp;
1715
	struct strbuf sb = STRBUF_INIT;
1716
	int ret = 0;
1717 1718 1719 1720

	logfile = git_path("logs/%s", ref);
	logfp = fopen(logfile, "r");
	if (!logfp)
1721
		return -1;
1722 1723 1724 1725 1726 1727

	if (ofs) {
		struct stat statbuf;
		if (fstat(fileno(logfp), &statbuf) ||
		    statbuf.st_size < ofs ||
		    fseek(logfp, -ofs, SEEK_END) ||
1728
		    strbuf_getwholeline(&sb, logfp, '\n')) {
1729
			fclose(logfp);
1730
			strbuf_release(&sb);
1731
			return -1;
1732
		}
1733 1734
	}

1735
	while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1736
		unsigned char osha1[20], nsha1[20];
1737 1738
		char *email_end, *message;
		unsigned long timestamp;
1739
		int tz;
1740 1741

		/* old SP new SP name <email> SP time TAB msg LF */
1742 1743 1744 1745
		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, '>')) ||
1746 1747 1748 1749 1750
		    email_end[1] != ' ' ||
		    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
		    !message || message[0] != ' ' ||
		    (message[1] != '+' && message[1] != '-') ||
		    !isdigit(message[2]) || !isdigit(message[3]) ||
1751
		    !isdigit(message[4]) || !isdigit(message[5]))
1752
			continue; /* corrupt? */
1753 1754
		email_end[1] = '\0';
		tz = strtol(message + 1, NULL, 10);
1755 1756 1757 1758
		if (message[6] != '\t')
			message += 6;
		else
			message += 7;
1759 1760
		ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
			 cb_data);
1761
		if (ret)
1762
			break;
1763 1764
	}
	fclose(logfp);
1765
	strbuf_release(&sb);
1766
	return ret;
1767
}
J
Junio C Hamano 已提交
1768

1769 1770 1771 1772 1773
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);
}

1774 1775 1776
static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
{
	DIR *dir = opendir(git_path("logs/%s", base));
1777
	int retval = 0;
1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816

	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);
	}
1817
	else if (*base)
1818
		return errno;
1819 1820 1821 1822 1823 1824 1825
	return retval;
}

int for_each_reflog(each_ref_fn fn, void *cb_data)
{
	return do_for_each_reflog("", fn, cb_data);
}
C
Carlos Rica 已提交
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

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

1854 1855 1856 1857 1858 1859
int ref_exists(char *refname)
{
	unsigned char sha1[20];
	return !!resolve_ref(refname, sha1, 1, NULL);
}

1860
struct ref *find_ref_by_name(const struct ref *list, const char *name)
1861 1862 1863
{
	for ( ; list; list = list->next)
		if (!strcmp(list->name, name))
1864
			return (struct ref *)list;
1865 1866
	return NULL;
}
J
Jeff King 已提交
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890

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

1891
char *shorten_unambiguous_ref(const char *ref, int strict)
J
Jeff King 已提交
1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
{
	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;
1928
		int rules_to_fail = i;
J
Jeff King 已提交
1929 1930 1931 1932 1933 1934 1935
		int short_name_len;

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

		short_name_len = strlen(short_name);

1936 1937 1938 1939 1940 1941 1942
		/*
		 * 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 已提交
1943 1944 1945 1946
		/*
		 * check if the short name resolves to a valid ref,
		 * but use only rules prior to the matched one
		 */
1947
		for (j = 0; j < rules_to_fail; j++) {
J
Jeff King 已提交
1948 1949 1950 1951
			const char *rule = ref_rev_parse_rules[j];
			unsigned char short_objectname[20];
			char refname[PATH_MAX];

1952 1953 1954 1955
			/* skip matched rule */
			if (i == j)
				continue;

J
Jeff King 已提交
1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970
			/*
			 * 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
		 */
1971
		if (j == rules_to_fail)
J
Jeff King 已提交
1972 1973 1974 1975 1976 1977
			return short_name;
	}

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