1#include "cache.h"
2#include "refs.h"
3#include "object.h"
4#include "tag.h"
5#include "dir.h"
6
7/* ISSYMREF=0x01, ISPACKED=0x02 and ISBROKEN=0x04 are public interfaces */
8#define REF_KNOWS_PEELED 0x10
9
10struct ref_entry {
11 unsigned char flag; /* ISSYMREF? ISPACKED? */
12 unsigned char sha1[20];
13 unsigned char peeled[20];
14 /* The full name of the reference (e.g., "refs/heads/master"): */
15 char name[FLEX_ARRAY];
16};
17
18struct ref_array {
19 int nr, alloc;
20
21 /*
22 * Entries with index 0 <= i < sorted are sorted by name. New
23 * entries are appended to the list unsorted, and are sorted
24 * only when required; thus we avoid the need to sort the list
25 * after the addition of every reference.
26 */
27 int sorted;
28
29 struct ref_entry **refs;
30};
31
32/*
33 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
34 * Return a pointer to the refname within the line (null-terminated),
35 * or NULL if there was a problem.
36 */
37static const char *parse_ref_line(char *line, unsigned char *sha1)
38{
39 /*
40 * 42: the answer to everything.
41 *
42 * In this case, it happens to be the answer to
43 * 40 (length of sha1 hex representation)
44 * +1 (space in between hex and name)
45 * +1 (newline at the end of the line)
46 */
47 int len = strlen(line) - 42;
48
49 if (len <= 0)
50 return NULL;
51 if (get_sha1_hex(line, sha1) < 0)
52 return NULL;
53 if (!isspace(line[40]))
54 return NULL;
55 line += 41;
56 if (isspace(*line))
57 return NULL;
58 if (line[len] != '\n')
59 return NULL;
60 line[len] = 0;
61
62 return line;
63}
64
65static struct ref_entry *create_ref_entry(const char *refname,
66 const unsigned char *sha1, int flag,
67 int check_name)
68{
69 int len;
70 struct ref_entry *ref;
71
72 if (check_name &&
73 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
74 die("Reference has invalid format: '%s'", refname);
75 len = strlen(refname) + 1;
76 ref = xmalloc(sizeof(struct ref_entry) + len);
77 hashcpy(ref->sha1, sha1);
78 hashclr(ref->peeled);
79 memcpy(ref->name, refname, len);
80 ref->flag = flag;
81 return ref;
82}
83
84/* Add a ref_entry to the end of the ref_array (unsorted). */
85static void add_ref(struct ref_array *refs, struct ref_entry *ref)
86{
87 ALLOC_GROW(refs->refs, refs->nr + 1, refs->alloc);
88 refs->refs[refs->nr++] = ref;
89}
90
91static int ref_entry_cmp(const void *a, const void *b)
92{
93 struct ref_entry *one = *(struct ref_entry **)a;
94 struct ref_entry *two = *(struct ref_entry **)b;
95 return strcmp(one->name, two->name);
96}
97
98/*
99 * Emit a warning and return true iff ref1 and ref2 have the same name
100 * and the same sha1. Die if they have the same name but different
101 * sha1s.
102 */
103static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
104{
105 if (!strcmp(ref1->name, ref2->name)) {
106 /* Duplicate name; make sure that the SHA1s match: */
107 if (hashcmp(ref1->sha1, ref2->sha1))
108 die("Duplicated ref, and SHA1s don't match: %s",
109 ref1->name);
110 warning("Duplicated ref: %s", ref1->name);
111 return 1;
112 } else {
113 return 0;
114 }
115}
116
117/*
118 * Sort the entries in array (if they are not already sorted).
119 */
120static void sort_ref_array(struct ref_array *array)
121{
122 int i, j;
123
124 /*
125 * This check also prevents passing a zero-length array to qsort(),
126 * which is a problem on some platforms.
127 */
128 if (array->sorted == array->nr)
129 return;
130
131 qsort(array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
132
133 /* Remove any duplicates from the ref_array */
134 i = 0;
135 for (j = 1; j < array->nr; j++) {
136 if (is_dup_ref(array->refs[i], array->refs[j])) {
137 free(array->refs[j]);
138 continue;
139 }
140 array->refs[++i] = array->refs[j];
141 }
142 array->sorted = array->nr = i + 1;
143}
144
145static struct ref_entry *search_ref_array(struct ref_array *array, const char *refname)
146{
147 struct ref_entry *e, **r;
148 int len;
149
150 if (refname == NULL)
151 return NULL;
152
153 if (!array->nr)
154 return NULL;
155 sort_ref_array(array);
156 len = strlen(refname) + 1;
157 e = xmalloc(sizeof(struct ref_entry) + len);
158 memcpy(e->name, refname, len);
159
160 r = bsearch(&e, array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
161
162 free(e);
163
164 if (r == NULL)
165 return NULL;
166
167 return *r;
168}
169
170/*
171 * Future: need to be in "struct repository"
172 * when doing a full libification.
173 */
174static struct ref_cache {
175 struct ref_cache *next;
176 char did_loose;
177 char did_packed;
178 struct ref_array loose;
179 struct ref_array packed;
180 /* The submodule name, or "" for the main repo. */
181 char name[FLEX_ARRAY];
182} *ref_cache;
183
184static struct ref_entry *current_ref;
185
186static void clear_ref_array(struct ref_array *array)
187{
188 int i;
189 for (i = 0; i < array->nr; i++)
190 free(array->refs[i]);
191 free(array->refs);
192 array->sorted = array->nr = array->alloc = 0;
193 array->refs = NULL;
194}
195
196static void clear_packed_ref_cache(struct ref_cache *refs)
197{
198 if (refs->did_packed)
199 clear_ref_array(&refs->packed);
200 refs->did_packed = 0;
201}
202
203static void clear_loose_ref_cache(struct ref_cache *refs)
204{
205 if (refs->did_loose)
206 clear_ref_array(&refs->loose);
207 refs->did_loose = 0;
208}
209
210static struct ref_cache *create_ref_cache(const char *submodule)
211{
212 int len;
213 struct ref_cache *refs;
214 if (!submodule)
215 submodule = "";
216 len = strlen(submodule) + 1;
217 refs = xcalloc(1, sizeof(struct ref_cache) + len);
218 memcpy(refs->name, submodule, len);
219 return refs;
220}
221
222/*
223 * Return a pointer to a ref_cache for the specified submodule. For
224 * the main repository, use submodule==NULL. The returned structure
225 * will be allocated and initialized but not necessarily populated; it
226 * should not be freed.
227 */
228static struct ref_cache *get_ref_cache(const char *submodule)
229{
230 struct ref_cache *refs = ref_cache;
231 if (!submodule)
232 submodule = "";
233 while (refs) {
234 if (!strcmp(submodule, refs->name))
235 return refs;
236 refs = refs->next;
237 }
238
239 refs = create_ref_cache(submodule);
240 refs->next = ref_cache;
241 ref_cache = refs;
242 return refs;
243}
244
245void invalidate_ref_cache(const char *submodule)
246{
247 struct ref_cache *refs = get_ref_cache(submodule);
248 clear_packed_ref_cache(refs);
249 clear_loose_ref_cache(refs);
250}
251
252static void read_packed_refs(FILE *f, struct ref_array *array)
253{
254 struct ref_entry *last = NULL;
255 char refline[PATH_MAX];
256 int flag = REF_ISPACKED;
257
258 while (fgets(refline, sizeof(refline), f)) {
259 unsigned char sha1[20];
260 const char *refname;
261 static const char header[] = "# pack-refs with:";
262
263 if (!strncmp(refline, header, sizeof(header)-1)) {
264 const char *traits = refline + sizeof(header) - 1;
265 if (strstr(traits, " peeled "))
266 flag |= REF_KNOWS_PEELED;
267 /* perhaps other traits later as well */
268 continue;
269 }
270
271 refname = parse_ref_line(refline, sha1);
272 if (refname) {
273 last = create_ref_entry(refname, sha1, flag, 1);
274 add_ref(array, last);
275 continue;
276 }
277 if (last &&
278 refline[0] == '^' &&
279 strlen(refline) == 42 &&
280 refline[41] == '\n' &&
281 !get_sha1_hex(refline + 1, sha1))
282 hashcpy(last->peeled, sha1);
283 }
284}
285
286static struct ref_array *get_packed_refs(struct ref_cache *refs)
287{
288 if (!refs->did_packed) {
289 const char *packed_refs_file;
290 FILE *f;
291
292 if (*refs->name)
293 packed_refs_file = git_path_submodule(refs->name, "packed-refs");
294 else
295 packed_refs_file = git_path("packed-refs");
296 f = fopen(packed_refs_file, "r");
297 if (f) {
298 read_packed_refs(f, &refs->packed);
299 fclose(f);
300 }
301 refs->did_packed = 1;
302 }
303 return &refs->packed;
304}
305
306void add_packed_ref(const char *refname, const unsigned char *sha1)
307{
308 add_ref(get_packed_refs(get_ref_cache(NULL)),
309 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
310}
311
312static void get_ref_dir(struct ref_cache *refs, const char *base,
313 struct ref_array *array)
314{
315 DIR *dir;
316 const char *path;
317
318 if (*refs->name)
319 path = git_path_submodule(refs->name, "%s", base);
320 else
321 path = git_path("%s", base);
322
323
324 dir = opendir(path);
325
326 if (dir) {
327 struct dirent *de;
328 int baselen = strlen(base);
329 char *refname = xmalloc(baselen + 257);
330
331 memcpy(refname, base, baselen);
332 if (baselen && base[baselen-1] != '/')
333 refname[baselen++] = '/';
334
335 while ((de = readdir(dir)) != NULL) {
336 unsigned char sha1[20];
337 struct stat st;
338 int flag;
339 int namelen;
340 const char *refdir;
341
342 if (de->d_name[0] == '.')
343 continue;
344 namelen = strlen(de->d_name);
345 if (namelen > 255)
346 continue;
347 if (has_extension(de->d_name, ".lock"))
348 continue;
349 memcpy(refname + baselen, de->d_name, namelen+1);
350 refdir = *refs->name
351 ? git_path_submodule(refs->name, "%s", refname)
352 : git_path("%s", refname);
353 if (stat(refdir, &st) < 0)
354 continue;
355 if (S_ISDIR(st.st_mode)) {
356 get_ref_dir(refs, refname, array);
357 continue;
358 }
359 if (*refs->name) {
360 hashclr(sha1);
361 flag = 0;
362 if (resolve_gitlink_ref(refs->name, refname, sha1) < 0) {
363 hashclr(sha1);
364 flag |= REF_ISBROKEN;
365 }
366 } else if (read_ref_full(refname, sha1, 1, &flag)) {
367 hashclr(sha1);
368 flag |= REF_ISBROKEN;
369 }
370 add_ref(array, create_ref_entry(refname, sha1, flag, 1));
371 }
372 free(refname);
373 closedir(dir);
374 }
375}
376
377struct warn_if_dangling_data {
378 FILE *fp;
379 const char *refname;
380 const char *msg_fmt;
381};
382
383static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
384 int flags, void *cb_data)
385{
386 struct warn_if_dangling_data *d = cb_data;
387 const char *resolves_to;
388 unsigned char junk[20];
389
390 if (!(flags & REF_ISSYMREF))
391 return 0;
392
393 resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
394 if (!resolves_to || strcmp(resolves_to, d->refname))
395 return 0;
396
397 fprintf(d->fp, d->msg_fmt, refname);
398 fputc('\n', d->fp);
399 return 0;
400}
401
402void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
403{
404 struct warn_if_dangling_data data;
405
406 data.fp = fp;
407 data.refname = refname;
408 data.msg_fmt = msg_fmt;
409 for_each_rawref(warn_if_dangling_symref, &data);
410}
411
412static struct ref_array *get_loose_refs(struct ref_cache *refs)
413{
414 if (!refs->did_loose) {
415 get_ref_dir(refs, "refs", &refs->loose);
416 refs->did_loose = 1;
417 }
418 return &refs->loose;
419}
420
421/* We allow "recursive" symbolic refs. Only within reason, though */
422#define MAXDEPTH 5
423#define MAXREFLEN (1024)
424
425/*
426 * Called by resolve_gitlink_ref_recursive() after it failed to read
427 * from the loose refs in ref_cache refs. Find <refname> in the
428 * packed-refs file for the submodule.
429 */
430static int resolve_gitlink_packed_ref(struct ref_cache *refs,
431 const char *refname, unsigned char *sha1)
432{
433 struct ref_entry *ref;
434 struct ref_array *array = get_packed_refs(refs);
435
436 ref = search_ref_array(array, refname);
437 if (ref == NULL)
438 return -1;
439
440 memcpy(sha1, ref->sha1, 20);
441 return 0;
442}
443
444static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
445 const char *refname, unsigned char *sha1,
446 int recursion)
447{
448 int fd, len;
449 char buffer[128], *p;
450 char *path;
451
452 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
453 return -1;
454 path = *refs->name
455 ? git_path_submodule(refs->name, "%s", refname)
456 : git_path("%s", refname);
457 fd = open(path, O_RDONLY);
458 if (fd < 0)
459 return resolve_gitlink_packed_ref(refs, refname, sha1);
460
461 len = read(fd, buffer, sizeof(buffer)-1);
462 close(fd);
463 if (len < 0)
464 return -1;
465 while (len && isspace(buffer[len-1]))
466 len--;
467 buffer[len] = 0;
468
469 /* Was it a detached head or an old-fashioned symlink? */
470 if (!get_sha1_hex(buffer, sha1))
471 return 0;
472
473 /* Symref? */
474 if (strncmp(buffer, "ref:", 4))
475 return -1;
476 p = buffer + 4;
477 while (isspace(*p))
478 p++;
479
480 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
481}
482
483int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
484{
485 int len = strlen(path), retval;
486 char *submodule;
487 struct ref_cache *refs;
488
489 while (len && path[len-1] == '/')
490 len--;
491 if (!len)
492 return -1;
493 submodule = xstrndup(path, len);
494 refs = get_ref_cache(submodule);
495 free(submodule);
496
497 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
498 return retval;
499}
500
501/*
502 * Try to read ref from the packed references. On success, set sha1
503 * and return 0; otherwise, return -1.
504 */
505static int get_packed_ref(const char *refname, unsigned char *sha1)
506{
507 struct ref_array *packed = get_packed_refs(get_ref_cache(NULL));
508 struct ref_entry *entry = search_ref_array(packed, refname);
509 if (entry) {
510 hashcpy(sha1, entry->sha1);
511 return 0;
512 }
513 return -1;
514}
515
516const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
517{
518 int depth = MAXDEPTH;
519 ssize_t len;
520 char buffer[256];
521 static char refname_buffer[256];
522
523 if (flag)
524 *flag = 0;
525
526 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
527 return NULL;
528
529 for (;;) {
530 char path[PATH_MAX];
531 struct stat st;
532 char *buf;
533 int fd;
534
535 if (--depth < 0)
536 return NULL;
537
538 git_snpath(path, sizeof(path), "%s", refname);
539
540 if (lstat(path, &st) < 0) {
541 if (errno != ENOENT)
542 return NULL;
543 /*
544 * The loose reference file does not exist;
545 * check for a packed reference.
546 */
547 if (!get_packed_ref(refname, sha1)) {
548 if (flag)
549 *flag |= REF_ISPACKED;
550 return refname;
551 }
552 /* The reference is not a packed reference, either. */
553 if (reading) {
554 return NULL;
555 } else {
556 hashclr(sha1);
557 return refname;
558 }
559 }
560
561 /* Follow "normalized" - ie "refs/.." symlinks by hand */
562 if (S_ISLNK(st.st_mode)) {
563 len = readlink(path, buffer, sizeof(buffer)-1);
564 if (len < 0)
565 return NULL;
566 buffer[len] = 0;
567 if (!prefixcmp(buffer, "refs/") &&
568 !check_refname_format(buffer, 0)) {
569 strcpy(refname_buffer, buffer);
570 refname = refname_buffer;
571 if (flag)
572 *flag |= REF_ISSYMREF;
573 continue;
574 }
575 }
576
577 /* Is it a directory? */
578 if (S_ISDIR(st.st_mode)) {
579 errno = EISDIR;
580 return NULL;
581 }
582
583 /*
584 * Anything else, just open it and try to use it as
585 * a ref
586 */
587 fd = open(path, O_RDONLY);
588 if (fd < 0)
589 return NULL;
590 len = read_in_full(fd, buffer, sizeof(buffer)-1);
591 close(fd);
592 if (len < 0)
593 return NULL;
594 while (len && isspace(buffer[len-1]))
595 len--;
596 buffer[len] = '\0';
597
598 /*
599 * Is it a symbolic ref?
600 */
601 if (prefixcmp(buffer, "ref:"))
602 break;
603 if (flag)
604 *flag |= REF_ISSYMREF;
605 buf = buffer + 4;
606 while (isspace(*buf))
607 buf++;
608 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
609 if (flag)
610 *flag |= REF_ISBROKEN;
611 return NULL;
612 }
613 refname = strcpy(refname_buffer, buf);
614 }
615 /* Please note that FETCH_HEAD has a second line containing other data. */
616 if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
617 if (flag)
618 *flag |= REF_ISBROKEN;
619 return NULL;
620 }
621 return refname;
622}
623
624char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
625{
626 const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
627 return ret ? xstrdup(ret) : NULL;
628}
629
630/* The argument to filter_refs */
631struct ref_filter {
632 const char *pattern;
633 each_ref_fn *fn;
634 void *cb_data;
635};
636
637int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
638{
639 if (resolve_ref_unsafe(refname, sha1, reading, flags))
640 return 0;
641 return -1;
642}
643
644int read_ref(const char *refname, unsigned char *sha1)
645{
646 return read_ref_full(refname, sha1, 1, NULL);
647}
648
649#define DO_FOR_EACH_INCLUDE_BROKEN 01
650static int do_one_ref(const char *base, each_ref_fn fn, int trim,
651 int flags, void *cb_data, struct ref_entry *entry)
652{
653 if (prefixcmp(entry->name, base))
654 return 0;
655
656 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
657 if (entry->flag & REF_ISBROKEN)
658 return 0; /* ignore broken refs e.g. dangling symref */
659 if (!has_sha1_file(entry->sha1)) {
660 error("%s does not point to a valid object!", entry->name);
661 return 0;
662 }
663 }
664 current_ref = entry;
665 return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
666}
667
668static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
669 void *data)
670{
671 struct ref_filter *filter = (struct ref_filter *)data;
672 if (fnmatch(filter->pattern, refname, 0))
673 return 0;
674 return filter->fn(refname, sha1, flags, filter->cb_data);
675}
676
677int peel_ref(const char *refname, unsigned char *sha1)
678{
679 int flag;
680 unsigned char base[20];
681 struct object *o;
682
683 if (current_ref && (current_ref->name == refname
684 || !strcmp(current_ref->name, refname))) {
685 if (current_ref->flag & REF_KNOWS_PEELED) {
686 hashcpy(sha1, current_ref->peeled);
687 return 0;
688 }
689 hashcpy(base, current_ref->sha1);
690 goto fallback;
691 }
692
693 if (read_ref_full(refname, base, 1, &flag))
694 return -1;
695
696 if ((flag & REF_ISPACKED)) {
697 struct ref_array *array = get_packed_refs(get_ref_cache(NULL));
698 struct ref_entry *r = search_ref_array(array, refname);
699
700 if (r != NULL && r->flag & REF_KNOWS_PEELED) {
701 hashcpy(sha1, r->peeled);
702 return 0;
703 }
704 }
705
706fallback:
707 o = parse_object(base);
708 if (o && o->type == OBJ_TAG) {
709 o = deref_tag(o, refname, 0);
710 if (o) {
711 hashcpy(sha1, o->sha1);
712 return 0;
713 }
714 }
715 return -1;
716}
717
718static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
719 int trim, int flags, void *cb_data)
720{
721 int retval = 0, p = 0, l = 0;
722 struct ref_cache *refs = get_ref_cache(submodule);
723 struct ref_array *packed = get_packed_refs(refs);
724 struct ref_array *loose = get_loose_refs(refs);
725
726 sort_ref_array(packed);
727 sort_ref_array(loose);
728 while (p < packed->nr && l < loose->nr) {
729 struct ref_entry *entry;
730 int cmp = strcmp(packed->refs[p]->name, loose->refs[l]->name);
731 if (!cmp) {
732 p++;
733 continue;
734 }
735 if (cmp > 0) {
736 entry = loose->refs[l++];
737 } else {
738 entry = packed->refs[p++];
739 }
740 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
741 if (retval)
742 goto end_each;
743 }
744
745 if (l < loose->nr) {
746 p = l;
747 packed = loose;
748 }
749
750 for (; p < packed->nr; p++) {
751 retval = do_one_ref(base, fn, trim, flags, cb_data, packed->refs[p]);
752 if (retval)
753 goto end_each;
754 }
755
756end_each:
757 current_ref = NULL;
758 return retval;
759}
760
761
762static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
763{
764 unsigned char sha1[20];
765 int flag;
766
767 if (submodule) {
768 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
769 return fn("HEAD", sha1, 0, cb_data);
770
771 return 0;
772 }
773
774 if (!read_ref_full("HEAD", sha1, 1, &flag))
775 return fn("HEAD", sha1, flag, cb_data);
776
777 return 0;
778}
779
780int head_ref(each_ref_fn fn, void *cb_data)
781{
782 return do_head_ref(NULL, fn, cb_data);
783}
784
785int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
786{
787 return do_head_ref(submodule, fn, cb_data);
788}
789
790int for_each_ref(each_ref_fn fn, void *cb_data)
791{
792 return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
793}
794
795int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
796{
797 return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
798}
799
800int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
801{
802 return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
803}
804
805int for_each_ref_in_submodule(const char *submodule, const char *prefix,
806 each_ref_fn fn, void *cb_data)
807{
808 return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
809}
810
811int for_each_tag_ref(each_ref_fn fn, void *cb_data)
812{
813 return for_each_ref_in("refs/tags/", fn, cb_data);
814}
815
816int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
817{
818 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
819}
820
821int for_each_branch_ref(each_ref_fn fn, void *cb_data)
822{
823 return for_each_ref_in("refs/heads/", fn, cb_data);
824}
825
826int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
827{
828 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
829}
830
831int for_each_remote_ref(each_ref_fn fn, void *cb_data)
832{
833 return for_each_ref_in("refs/remotes/", fn, cb_data);
834}
835
836int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
837{
838 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
839}
840
841int for_each_replace_ref(each_ref_fn fn, void *cb_data)
842{
843 return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
844}
845
846int head_ref_namespaced(each_ref_fn fn, void *cb_data)
847{
848 struct strbuf buf = STRBUF_INIT;
849 int ret = 0;
850 unsigned char sha1[20];
851 int flag;
852
853 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
854 if (!read_ref_full(buf.buf, sha1, 1, &flag))
855 ret = fn(buf.buf, sha1, flag, cb_data);
856 strbuf_release(&buf);
857
858 return ret;
859}
860
861int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
862{
863 struct strbuf buf = STRBUF_INIT;
864 int ret;
865 strbuf_addf(&buf, "%srefs/", get_git_namespace());
866 ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
867 strbuf_release(&buf);
868 return ret;
869}
870
871int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
872 const char *prefix, void *cb_data)
873{
874 struct strbuf real_pattern = STRBUF_INIT;
875 struct ref_filter filter;
876 int ret;
877
878 if (!prefix && prefixcmp(pattern, "refs/"))
879 strbuf_addstr(&real_pattern, "refs/");
880 else if (prefix)
881 strbuf_addstr(&real_pattern, prefix);
882 strbuf_addstr(&real_pattern, pattern);
883
884 if (!has_glob_specials(pattern)) {
885 /* Append implied '/' '*' if not present. */
886 if (real_pattern.buf[real_pattern.len - 1] != '/')
887 strbuf_addch(&real_pattern, '/');
888 /* No need to check for '*', there is none. */
889 strbuf_addch(&real_pattern, '*');
890 }
891
892 filter.pattern = real_pattern.buf;
893 filter.fn = fn;
894 filter.cb_data = cb_data;
895 ret = for_each_ref(filter_refs, &filter);
896
897 strbuf_release(&real_pattern);
898 return ret;
899}
900
901int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
902{
903 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
904}
905
906int for_each_rawref(each_ref_fn fn, void *cb_data)
907{
908 return do_for_each_ref(NULL, "", fn, 0,
909 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
910}
911
912/*
913 * Make sure "ref" is something reasonable to have under ".git/refs/";
914 * We do not like it if:
915 *
916 * - any path component of it begins with ".", or
917 * - it has double dots "..", or
918 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
919 * - it ends with a "/".
920 * - it ends with ".lock"
921 * - it contains a "\" (backslash)
922 */
923
924/* Return true iff ch is not allowed in reference names. */
925static inline int bad_ref_char(int ch)
926{
927 if (((unsigned) ch) <= ' ' || ch == 0x7f ||
928 ch == '~' || ch == '^' || ch == ':' || ch == '\\')
929 return 1;
930 /* 2.13 Pattern Matching Notation */
931 if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
932 return 1;
933 return 0;
934}
935
936/*
937 * Try to read one refname component from the front of refname. Return
938 * the length of the component found, or -1 if the component is not
939 * legal.
940 */
941static int check_refname_component(const char *refname, int flags)
942{
943 const char *cp;
944 char last = '\0';
945
946 for (cp = refname; ; cp++) {
947 char ch = *cp;
948 if (ch == '\0' || ch == '/')
949 break;
950 if (bad_ref_char(ch))
951 return -1; /* Illegal character in refname. */
952 if (last == '.' && ch == '.')
953 return -1; /* Refname contains "..". */
954 if (last == '@' && ch == '{')
955 return -1; /* Refname contains "@{". */
956 last = ch;
957 }
958 if (cp == refname)
959 return -1; /* Component has zero length. */
960 if (refname[0] == '.') {
961 if (!(flags & REFNAME_DOT_COMPONENT))
962 return -1; /* Component starts with '.'. */
963 /*
964 * Even if leading dots are allowed, don't allow "."
965 * as a component (".." is prevented by a rule above).
966 */
967 if (refname[1] == '\0')
968 return -1; /* Component equals ".". */
969 }
970 if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5))
971 return -1; /* Refname ends with ".lock". */
972 return cp - refname;
973}
974
975int check_refname_format(const char *refname, int flags)
976{
977 int component_len, component_count = 0;
978
979 while (1) {
980 /* We are at the start of a path component. */
981 component_len = check_refname_component(refname, flags);
982 if (component_len < 0) {
983 if ((flags & REFNAME_REFSPEC_PATTERN) &&
984 refname[0] == '*' &&
985 (refname[1] == '\0' || refname[1] == '/')) {
986 /* Accept one wildcard as a full refname component. */
987 flags &= ~REFNAME_REFSPEC_PATTERN;
988 component_len = 1;
989 } else {
990 return -1;
991 }
992 }
993 component_count++;
994 if (refname[component_len] == '\0')
995 break;
996 /* Skip to next component. */
997 refname += component_len + 1;
998 }
999
1000 if (refname[component_len - 1] == '.')
1001 return -1; /* Refname ends with '.'. */
1002 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
1003 return -1; /* Refname has only one component. */
1004 return 0;
1005}
1006
1007const char *prettify_refname(const char *name)
1008{
1009 return name + (
1010 !prefixcmp(name, "refs/heads/") ? 11 :
1011 !prefixcmp(name, "refs/tags/") ? 10 :
1012 !prefixcmp(name, "refs/remotes/") ? 13 :
1013 0);
1014}
1015
1016const char *ref_rev_parse_rules[] = {
1017 "%.*s",
1018 "refs/%.*s",
1019 "refs/tags/%.*s",
1020 "refs/heads/%.*s",
1021 "refs/remotes/%.*s",
1022 "refs/remotes/%.*s/HEAD",
1023 NULL
1024};
1025
1026int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
1027{
1028 const char **p;
1029 const int abbrev_name_len = strlen(abbrev_name);
1030
1031 for (p = rules; *p; p++) {
1032 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1033 return 1;
1034 }
1035 }
1036
1037 return 0;
1038}
1039
1040static struct ref_lock *verify_lock(struct ref_lock *lock,
1041 const unsigned char *old_sha1, int mustexist)
1042{
1043 if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1044 error("Can't verify ref %s", lock->ref_name);
1045 unlock_ref(lock);
1046 return NULL;
1047 }
1048 if (hashcmp(lock->old_sha1, old_sha1)) {
1049 error("Ref %s is at %s but expected %s", lock->ref_name,
1050 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1051 unlock_ref(lock);
1052 return NULL;
1053 }
1054 return lock;
1055}
1056
1057static int remove_empty_directories(const char *file)
1058{
1059 /* we want to create a file but there is a directory there;
1060 * if that is an empty directory (or a directory that contains
1061 * only empty directories), remove them.
1062 */
1063 struct strbuf path;
1064 int result;
1065
1066 strbuf_init(&path, 20);
1067 strbuf_addstr(&path, file);
1068
1069 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1070
1071 strbuf_release(&path);
1072
1073 return result;
1074}
1075
1076/*
1077 * Return true iff a reference named refname could be created without
1078 * conflicting with the name of an existing reference. If oldrefname
1079 * is non-NULL, ignore potential conflicts with oldrefname (e.g.,
1080 * because oldrefname is scheduled for deletion in the same
1081 * operation).
1082 */
1083static int is_refname_available(const char *refname, const char *oldrefname,
1084 struct ref_array *array)
1085{
1086 int i, namlen = strlen(refname); /* e.g. 'foo/bar' */
1087 for (i = 0; i < array->nr; i++ ) {
1088 struct ref_entry *entry = array->refs[i];
1089 /* entry->name could be 'foo' or 'foo/bar/baz' */
1090 if (!oldrefname || strcmp(oldrefname, entry->name)) {
1091 int len = strlen(entry->name);
1092 int cmplen = (namlen < len) ? namlen : len;
1093 const char *lead = (namlen < len) ? entry->name : refname;
1094 if (!strncmp(refname, entry->name, cmplen) &&
1095 lead[cmplen] == '/') {
1096 error("'%s' exists; cannot create '%s'",
1097 entry->name, refname);
1098 return 0;
1099 }
1100 }
1101 }
1102 return 1;
1103}
1104
1105/*
1106 * *string and *len will only be substituted, and *string returned (for
1107 * later free()ing) if the string passed in is a magic short-hand form
1108 * to name a branch.
1109 */
1110static char *substitute_branch_name(const char **string, int *len)
1111{
1112 struct strbuf buf = STRBUF_INIT;
1113 int ret = interpret_branch_name(*string, &buf);
1114
1115 if (ret == *len) {
1116 size_t size;
1117 *string = strbuf_detach(&buf, &size);
1118 *len = size;
1119 return (char *)*string;
1120 }
1121
1122 return NULL;
1123}
1124
1125int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1126{
1127 char *last_branch = substitute_branch_name(&str, &len);
1128 const char **p, *r;
1129 int refs_found = 0;
1130
1131 *ref = NULL;
1132 for (p = ref_rev_parse_rules; *p; p++) {
1133 char fullref[PATH_MAX];
1134 unsigned char sha1_from_ref[20];
1135 unsigned char *this_result;
1136 int flag;
1137
1138 this_result = refs_found ? sha1_from_ref : sha1;
1139 mksnpath(fullref, sizeof(fullref), *p, len, str);
1140 r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1141 if (r) {
1142 if (!refs_found++)
1143 *ref = xstrdup(r);
1144 if (!warn_ambiguous_refs)
1145 break;
1146 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1147 warning("ignoring dangling symref %s.", fullref);
1148 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
1149 warning("ignoring broken ref %s.", fullref);
1150 }
1151 }
1152 free(last_branch);
1153 return refs_found;
1154}
1155
1156int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
1157{
1158 char *last_branch = substitute_branch_name(&str, &len);
1159 const char **p;
1160 int logs_found = 0;
1161
1162 *log = NULL;
1163 for (p = ref_rev_parse_rules; *p; p++) {
1164 struct stat st;
1165 unsigned char hash[20];
1166 char path[PATH_MAX];
1167 const char *ref, *it;
1168
1169 mksnpath(path, sizeof(path), *p, len, str);
1170 ref = resolve_ref_unsafe(path, hash, 1, NULL);
1171 if (!ref)
1172 continue;
1173 if (!stat(git_path("logs/%s", path), &st) &&
1174 S_ISREG(st.st_mode))
1175 it = path;
1176 else if (strcmp(ref, path) &&
1177 !stat(git_path("logs/%s", ref), &st) &&
1178 S_ISREG(st.st_mode))
1179 it = ref;
1180 else
1181 continue;
1182 if (!logs_found++) {
1183 *log = xstrdup(it);
1184 hashcpy(sha1, hash);
1185 }
1186 if (!warn_ambiguous_refs)
1187 break;
1188 }
1189 free(last_branch);
1190 return logs_found;
1191}
1192
1193static struct ref_lock *lock_ref_sha1_basic(const char *refname,
1194 const unsigned char *old_sha1,
1195 int flags, int *type_p)
1196{
1197 char *ref_file;
1198 const char *orig_refname = refname;
1199 struct ref_lock *lock;
1200 int last_errno = 0;
1201 int type, lflags;
1202 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1203 int missing = 0;
1204
1205 lock = xcalloc(1, sizeof(struct ref_lock));
1206 lock->lock_fd = -1;
1207
1208 refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1209 if (!refname && errno == EISDIR) {
1210 /* we are trying to lock foo but we used to
1211 * have foo/bar which now does not exist;
1212 * it is normal for the empty directory 'foo'
1213 * to remain.
1214 */
1215 ref_file = git_path("%s", orig_refname);
1216 if (remove_empty_directories(ref_file)) {
1217 last_errno = errno;
1218 error("there are still refs under '%s'", orig_refname);
1219 goto error_return;
1220 }
1221 refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1222 }
1223 if (type_p)
1224 *type_p = type;
1225 if (!refname) {
1226 last_errno = errno;
1227 error("unable to resolve reference %s: %s",
1228 orig_refname, strerror(errno));
1229 goto error_return;
1230 }
1231 missing = is_null_sha1(lock->old_sha1);
1232 /* When the ref did not exist and we are creating it,
1233 * make sure there is no existing ref that is packed
1234 * whose name begins with our refname, nor a ref whose
1235 * name is a proper prefix of our refname.
1236 */
1237 if (missing &&
1238 !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1239 last_errno = ENOTDIR;
1240 goto error_return;
1241 }
1242
1243 lock->lk = xcalloc(1, sizeof(struct lock_file));
1244
1245 lflags = LOCK_DIE_ON_ERROR;
1246 if (flags & REF_NODEREF) {
1247 refname = orig_refname;
1248 lflags |= LOCK_NODEREF;
1249 }
1250 lock->ref_name = xstrdup(refname);
1251 lock->orig_ref_name = xstrdup(orig_refname);
1252 ref_file = git_path("%s", refname);
1253 if (missing)
1254 lock->force_write = 1;
1255 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1256 lock->force_write = 1;
1257
1258 if (safe_create_leading_directories(ref_file)) {
1259 last_errno = errno;
1260 error("unable to create directory for %s", ref_file);
1261 goto error_return;
1262 }
1263
1264 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1265 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1266
1267 error_return:
1268 unlock_ref(lock);
1269 errno = last_errno;
1270 return NULL;
1271}
1272
1273struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
1274{
1275 char refpath[PATH_MAX];
1276 if (check_refname_format(refname, 0))
1277 return NULL;
1278 strcpy(refpath, mkpath("refs/%s", refname));
1279 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1280}
1281
1282struct ref_lock *lock_any_ref_for_update(const char *refname,
1283 const unsigned char *old_sha1, int flags)
1284{
1285 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1286 return NULL;
1287 return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
1288}
1289
1290static struct lock_file packlock;
1291
1292static int repack_without_ref(const char *refname)
1293{
1294 struct ref_array *packed;
1295 int fd, i;
1296
1297 packed = get_packed_refs(get_ref_cache(NULL));
1298 if (search_ref_array(packed, refname) == NULL)
1299 return 0;
1300 fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1301 if (fd < 0) {
1302 unable_to_lock_error(git_path("packed-refs"), errno);
1303 return error("cannot delete '%s' from packed refs", refname);
1304 }
1305
1306 for (i = 0; i < packed->nr; i++) {
1307 char line[PATH_MAX + 100];
1308 int len;
1309 struct ref_entry *ref = packed->refs[i];
1310
1311 if (!strcmp(refname, ref->name))
1312 continue;
1313 len = snprintf(line, sizeof(line), "%s %s\n",
1314 sha1_to_hex(ref->sha1), ref->name);
1315 /* this should not happen but just being defensive */
1316 if (len > sizeof(line))
1317 die("too long a refname '%s'", ref->name);
1318 write_or_die(fd, line, len);
1319 }
1320 return commit_lock_file(&packlock);
1321}
1322
1323int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1324{
1325 struct ref_lock *lock;
1326 int err, i = 0, ret = 0, flag = 0;
1327
1328 lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1329 if (!lock)
1330 return 1;
1331 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1332 /* loose */
1333 const char *path;
1334
1335 if (!(delopt & REF_NODEREF)) {
1336 i = strlen(lock->lk->filename) - 5; /* .lock */
1337 lock->lk->filename[i] = 0;
1338 path = lock->lk->filename;
1339 } else {
1340 path = git_path("%s", refname);
1341 }
1342 err = unlink_or_warn(path);
1343 if (err && errno != ENOENT)
1344 ret = 1;
1345
1346 if (!(delopt & REF_NODEREF))
1347 lock->lk->filename[i] = '.';
1348 }
1349 /* removing the loose one could have resurrected an earlier
1350 * packed one. Also, if it was not loose we need to repack
1351 * without it.
1352 */
1353 ret |= repack_without_ref(refname);
1354
1355 unlink_or_warn(git_path("logs/%s", lock->ref_name));
1356 invalidate_ref_cache(NULL);
1357 unlock_ref(lock);
1358 return ret;
1359}
1360
1361/*
1362 * People using contrib's git-new-workdir have .git/logs/refs ->
1363 * /some/other/path/.git/logs/refs, and that may live on another device.
1364 *
1365 * IOW, to avoid cross device rename errors, the temporary renamed log must
1366 * live into logs/refs.
1367 */
1368#define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1369
1370int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1371{
1372 unsigned char sha1[20], orig_sha1[20];
1373 int flag = 0, logmoved = 0;
1374 struct ref_lock *lock;
1375 struct stat loginfo;
1376 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
1377 const char *symref = NULL;
1378 struct ref_cache *refs = get_ref_cache(NULL);
1379
1380 if (log && S_ISLNK(loginfo.st_mode))
1381 return error("reflog for %s is a symlink", oldrefname);
1382
1383 symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
1384 if (flag & REF_ISSYMREF)
1385 return error("refname %s is a symbolic ref, renaming it is not supported",
1386 oldrefname);
1387 if (!symref)
1388 return error("refname %s not found", oldrefname);
1389
1390 if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1391 return 1;
1392
1393 if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1394 return 1;
1395
1396 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1397 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1398 oldrefname, strerror(errno));
1399
1400 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
1401 error("unable to delete old %s", oldrefname);
1402 goto rollback;
1403 }
1404
1405 if (!read_ref_full(newrefname, sha1, 1, &flag) &&
1406 delete_ref(newrefname, sha1, REF_NODEREF)) {
1407 if (errno==EISDIR) {
1408 if (remove_empty_directories(git_path("%s", newrefname))) {
1409 error("Directory not empty: %s", newrefname);
1410 goto rollback;
1411 }
1412 } else {
1413 error("unable to delete existing %s", newrefname);
1414 goto rollback;
1415 }
1416 }
1417
1418 if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
1419 error("unable to create directory for %s", newrefname);
1420 goto rollback;
1421 }
1422
1423 retry:
1424 if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1425 if (errno==EISDIR || errno==ENOTDIR) {
1426 /*
1427 * rename(a, b) when b is an existing
1428 * directory ought to result in ISDIR, but
1429 * Solaris 5.8 gives ENOTDIR. Sheesh.
1430 */
1431 if (remove_empty_directories(git_path("logs/%s", newrefname))) {
1432 error("Directory not empty: logs/%s", newrefname);
1433 goto rollback;
1434 }
1435 goto retry;
1436 } else {
1437 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1438 newrefname, strerror(errno));
1439 goto rollback;
1440 }
1441 }
1442 logmoved = log;
1443
1444 lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1445 if (!lock) {
1446 error("unable to lock %s for update", newrefname);
1447 goto rollback;
1448 }
1449 lock->force_write = 1;
1450 hashcpy(lock->old_sha1, orig_sha1);
1451 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1452 error("unable to write current sha1 into %s", newrefname);
1453 goto rollback;
1454 }
1455
1456 return 0;
1457
1458 rollback:
1459 lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1460 if (!lock) {
1461 error("unable to lock %s for rollback", oldrefname);
1462 goto rollbacklog;
1463 }
1464
1465 lock->force_write = 1;
1466 flag = log_all_ref_updates;
1467 log_all_ref_updates = 0;
1468 if (write_ref_sha1(lock, orig_sha1, NULL))
1469 error("unable to write current sha1 into %s", oldrefname);
1470 log_all_ref_updates = flag;
1471
1472 rollbacklog:
1473 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1474 error("unable to restore logfile %s from %s: %s",
1475 oldrefname, newrefname, strerror(errno));
1476 if (!logmoved && log &&
1477 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1478 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1479 oldrefname, strerror(errno));
1480
1481 return 1;
1482}
1483
1484int close_ref(struct ref_lock *lock)
1485{
1486 if (close_lock_file(lock->lk))
1487 return -1;
1488 lock->lock_fd = -1;
1489 return 0;
1490}
1491
1492int commit_ref(struct ref_lock *lock)
1493{
1494 if (commit_lock_file(lock->lk))
1495 return -1;
1496 lock->lock_fd = -1;
1497 return 0;
1498}
1499
1500void unlock_ref(struct ref_lock *lock)
1501{
1502 /* Do not free lock->lk -- atexit() still looks at them */
1503 if (lock->lk)
1504 rollback_lock_file(lock->lk);
1505 free(lock->ref_name);
1506 free(lock->orig_ref_name);
1507 free(lock);
1508}
1509
1510/*
1511 * copy the reflog message msg to buf, which has been allocated sufficiently
1512 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1513 * because reflog file is one line per entry.
1514 */
1515static int copy_msg(char *buf, const char *msg)
1516{
1517 char *cp = buf;
1518 char c;
1519 int wasspace = 1;
1520
1521 *cp++ = '\t';
1522 while ((c = *msg++)) {
1523 if (wasspace && isspace(c))
1524 continue;
1525 wasspace = isspace(c);
1526 if (wasspace)
1527 c = ' ';
1528 *cp++ = c;
1529 }
1530 while (buf < cp && isspace(cp[-1]))
1531 cp--;
1532 *cp++ = '\n';
1533 return cp - buf;
1534}
1535
1536int log_ref_setup(const char *refname, char *logfile, int bufsize)
1537{
1538 int logfd, oflags = O_APPEND | O_WRONLY;
1539
1540 git_snpath(logfile, bufsize, "logs/%s", refname);
1541 if (log_all_ref_updates &&
1542 (!prefixcmp(refname, "refs/heads/") ||
1543 !prefixcmp(refname, "refs/remotes/") ||
1544 !prefixcmp(refname, "refs/notes/") ||
1545 !strcmp(refname, "HEAD"))) {
1546 if (safe_create_leading_directories(logfile) < 0)
1547 return error("unable to create directory for %s",
1548 logfile);
1549 oflags |= O_CREAT;
1550 }
1551
1552 logfd = open(logfile, oflags, 0666);
1553 if (logfd < 0) {
1554 if (!(oflags & O_CREAT) && errno == ENOENT)
1555 return 0;
1556
1557 if ((oflags & O_CREAT) && errno == EISDIR) {
1558 if (remove_empty_directories(logfile)) {
1559 return error("There are still logs under '%s'",
1560 logfile);
1561 }
1562 logfd = open(logfile, oflags, 0666);
1563 }
1564
1565 if (logfd < 0)
1566 return error("Unable to append to %s: %s",
1567 logfile, strerror(errno));
1568 }
1569
1570 adjust_shared_perm(logfile);
1571 close(logfd);
1572 return 0;
1573}
1574
1575static int log_ref_write(const char *refname, const unsigned char *old_sha1,
1576 const unsigned char *new_sha1, const char *msg)
1577{
1578 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1579 unsigned maxlen, len;
1580 int msglen;
1581 char log_file[PATH_MAX];
1582 char *logrec;
1583 const char *committer;
1584
1585 if (log_all_ref_updates < 0)
1586 log_all_ref_updates = !is_bare_repository();
1587
1588 result = log_ref_setup(refname, log_file, sizeof(log_file));
1589 if (result)
1590 return result;
1591
1592 logfd = open(log_file, oflags);
1593 if (logfd < 0)
1594 return 0;
1595 msglen = msg ? strlen(msg) : 0;
1596 committer = git_committer_info(0);
1597 maxlen = strlen(committer) + msglen + 100;
1598 logrec = xmalloc(maxlen);
1599 len = sprintf(logrec, "%s %s %s\n",
1600 sha1_to_hex(old_sha1),
1601 sha1_to_hex(new_sha1),
1602 committer);
1603 if (msglen)
1604 len += copy_msg(logrec + len - 1, msg) - 1;
1605 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1606 free(logrec);
1607 if (close(logfd) != 0 || written != len)
1608 return error("Unable to append to %s", log_file);
1609 return 0;
1610}
1611
1612static int is_branch(const char *refname)
1613{
1614 return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1615}
1616
1617int write_ref_sha1(struct ref_lock *lock,
1618 const unsigned char *sha1, const char *logmsg)
1619{
1620 static char term = '\n';
1621 struct object *o;
1622
1623 if (!lock)
1624 return -1;
1625 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1626 unlock_ref(lock);
1627 return 0;
1628 }
1629 o = parse_object(sha1);
1630 if (!o) {
1631 error("Trying to write ref %s with nonexistent object %s",
1632 lock->ref_name, sha1_to_hex(sha1));
1633 unlock_ref(lock);
1634 return -1;
1635 }
1636 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1637 error("Trying to write non-commit object %s to branch %s",
1638 sha1_to_hex(sha1), lock->ref_name);
1639 unlock_ref(lock);
1640 return -1;
1641 }
1642 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1643 write_in_full(lock->lock_fd, &term, 1) != 1
1644 || close_ref(lock) < 0) {
1645 error("Couldn't write %s", lock->lk->filename);
1646 unlock_ref(lock);
1647 return -1;
1648 }
1649 clear_loose_ref_cache(get_ref_cache(NULL));
1650 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1651 (strcmp(lock->ref_name, lock->orig_ref_name) &&
1652 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1653 unlock_ref(lock);
1654 return -1;
1655 }
1656 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1657 /*
1658 * Special hack: If a branch is updated directly and HEAD
1659 * points to it (may happen on the remote side of a push
1660 * for example) then logically the HEAD reflog should be
1661 * updated too.
1662 * A generic solution implies reverse symref information,
1663 * but finding all symrefs pointing to the given branch
1664 * would be rather costly for this rare event (the direct
1665 * update of a branch) to be worth it. So let's cheat and
1666 * check with HEAD only which should cover 99% of all usage
1667 * scenarios (even 100% of the default ones).
1668 */
1669 unsigned char head_sha1[20];
1670 int head_flag;
1671 const char *head_ref;
1672 head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
1673 if (head_ref && (head_flag & REF_ISSYMREF) &&
1674 !strcmp(head_ref, lock->ref_name))
1675 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1676 }
1677 if (commit_ref(lock)) {
1678 error("Couldn't set %s", lock->ref_name);
1679 unlock_ref(lock);
1680 return -1;
1681 }
1682 unlock_ref(lock);
1683 return 0;
1684}
1685
1686int create_symref(const char *ref_target, const char *refs_heads_master,
1687 const char *logmsg)
1688{
1689 const char *lockpath;
1690 char ref[1000];
1691 int fd, len, written;
1692 char *git_HEAD = git_pathdup("%s", ref_target);
1693 unsigned char old_sha1[20], new_sha1[20];
1694
1695 if (logmsg && read_ref(ref_target, old_sha1))
1696 hashclr(old_sha1);
1697
1698 if (safe_create_leading_directories(git_HEAD) < 0)
1699 return error("unable to create directory for %s", git_HEAD);
1700
1701#ifndef NO_SYMLINK_HEAD
1702 if (prefer_symlink_refs) {
1703 unlink(git_HEAD);
1704 if (!symlink(refs_heads_master, git_HEAD))
1705 goto done;
1706 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1707 }
1708#endif
1709
1710 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1711 if (sizeof(ref) <= len) {
1712 error("refname too long: %s", refs_heads_master);
1713 goto error_free_return;
1714 }
1715 lockpath = mkpath("%s.lock", git_HEAD);
1716 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1717 if (fd < 0) {
1718 error("Unable to open %s for writing", lockpath);
1719 goto error_free_return;
1720 }
1721 written = write_in_full(fd, ref, len);
1722 if (close(fd) != 0 || written != len) {
1723 error("Unable to write to %s", lockpath);
1724 goto error_unlink_return;
1725 }
1726 if (rename(lockpath, git_HEAD) < 0) {
1727 error("Unable to create %s", git_HEAD);
1728 goto error_unlink_return;
1729 }
1730 if (adjust_shared_perm(git_HEAD)) {
1731 error("Unable to fix permissions on %s", lockpath);
1732 error_unlink_return:
1733 unlink_or_warn(lockpath);
1734 error_free_return:
1735 free(git_HEAD);
1736 return -1;
1737 }
1738
1739#ifndef NO_SYMLINK_HEAD
1740 done:
1741#endif
1742 if (logmsg && !read_ref(refs_heads_master, new_sha1))
1743 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1744
1745 free(git_HEAD);
1746 return 0;
1747}
1748
1749static char *ref_msg(const char *line, const char *endp)
1750{
1751 const char *ep;
1752 line += 82;
1753 ep = memchr(line, '\n', endp - line);
1754 if (!ep)
1755 ep = endp;
1756 return xmemdupz(line, ep - line);
1757}
1758
1759int read_ref_at(const char *refname, unsigned long at_time, int cnt,
1760 unsigned char *sha1, char **msg,
1761 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
1762{
1763 const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1764 char *tz_c;
1765 int logfd, tz, reccnt = 0;
1766 struct stat st;
1767 unsigned long date;
1768 unsigned char logged_sha1[20];
1769 void *log_mapped;
1770 size_t mapsz;
1771
1772 logfile = git_path("logs/%s", refname);
1773 logfd = open(logfile, O_RDONLY, 0);
1774 if (logfd < 0)
1775 die_errno("Unable to read log '%s'", logfile);
1776 fstat(logfd, &st);
1777 if (!st.st_size)
1778 die("Log %s is empty.", logfile);
1779 mapsz = xsize_t(st.st_size);
1780 log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1781 logdata = log_mapped;
1782 close(logfd);
1783
1784 lastrec = NULL;
1785 rec = logend = logdata + st.st_size;
1786 while (logdata < rec) {
1787 reccnt++;
1788 if (logdata < rec && *(rec-1) == '\n')
1789 rec--;
1790 lastgt = NULL;
1791 while (logdata < rec && *(rec-1) != '\n') {
1792 rec--;
1793 if (*rec == '>')
1794 lastgt = rec;
1795 }
1796 if (!lastgt)
1797 die("Log %s is corrupt.", logfile);
1798 date = strtoul(lastgt + 1, &tz_c, 10);
1799 if (date <= at_time || cnt == 0) {
1800 tz = strtoul(tz_c, NULL, 10);
1801 if (msg)
1802 *msg = ref_msg(rec, logend);
1803 if (cutoff_time)
1804 *cutoff_time = date;
1805 if (cutoff_tz)
1806 *cutoff_tz = tz;
1807 if (cutoff_cnt)
1808 *cutoff_cnt = reccnt - 1;
1809 if (lastrec) {
1810 if (get_sha1_hex(lastrec, logged_sha1))
1811 die("Log %s is corrupt.", logfile);
1812 if (get_sha1_hex(rec + 41, sha1))
1813 die("Log %s is corrupt.", logfile);
1814 if (hashcmp(logged_sha1, sha1)) {
1815 warning("Log %s has gap after %s.",
1816 logfile, show_date(date, tz, DATE_RFC2822));
1817 }
1818 }
1819 else if (date == at_time) {
1820 if (get_sha1_hex(rec + 41, sha1))
1821 die("Log %s is corrupt.", logfile);
1822 }
1823 else {
1824 if (get_sha1_hex(rec + 41, logged_sha1))
1825 die("Log %s is corrupt.", logfile);
1826 if (hashcmp(logged_sha1, sha1)) {
1827 warning("Log %s unexpectedly ended on %s.",
1828 logfile, show_date(date, tz, DATE_RFC2822));
1829 }
1830 }
1831 munmap(log_mapped, mapsz);
1832 return 0;
1833 }
1834 lastrec = rec;
1835 if (cnt > 0)
1836 cnt--;
1837 }
1838
1839 rec = logdata;
1840 while (rec < logend && *rec != '>' && *rec != '\n')
1841 rec++;
1842 if (rec == logend || *rec == '\n')
1843 die("Log %s is corrupt.", logfile);
1844 date = strtoul(rec + 1, &tz_c, 10);
1845 tz = strtoul(tz_c, NULL, 10);
1846 if (get_sha1_hex(logdata, sha1))
1847 die("Log %s is corrupt.", logfile);
1848 if (is_null_sha1(sha1)) {
1849 if (get_sha1_hex(logdata + 41, sha1))
1850 die("Log %s is corrupt.", logfile);
1851 }
1852 if (msg)
1853 *msg = ref_msg(logdata, logend);
1854 munmap(log_mapped, mapsz);
1855
1856 if (cutoff_time)
1857 *cutoff_time = date;
1858 if (cutoff_tz)
1859 *cutoff_tz = tz;
1860 if (cutoff_cnt)
1861 *cutoff_cnt = reccnt;
1862 return 1;
1863}
1864
1865int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
1866{
1867 const char *logfile;
1868 FILE *logfp;
1869 struct strbuf sb = STRBUF_INIT;
1870 int ret = 0;
1871
1872 logfile = git_path("logs/%s", refname);
1873 logfp = fopen(logfile, "r");
1874 if (!logfp)
1875 return -1;
1876
1877 if (ofs) {
1878 struct stat statbuf;
1879 if (fstat(fileno(logfp), &statbuf) ||
1880 statbuf.st_size < ofs ||
1881 fseek(logfp, -ofs, SEEK_END) ||
1882 strbuf_getwholeline(&sb, logfp, '\n')) {
1883 fclose(logfp);
1884 strbuf_release(&sb);
1885 return -1;
1886 }
1887 }
1888
1889 while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1890 unsigned char osha1[20], nsha1[20];
1891 char *email_end, *message;
1892 unsigned long timestamp;
1893 int tz;
1894
1895 /* old SP new SP name <email> SP time TAB msg LF */
1896 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1897 get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1898 get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1899 !(email_end = strchr(sb.buf + 82, '>')) ||
1900 email_end[1] != ' ' ||
1901 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1902 !message || message[0] != ' ' ||
1903 (message[1] != '+' && message[1] != '-') ||
1904 !isdigit(message[2]) || !isdigit(message[3]) ||
1905 !isdigit(message[4]) || !isdigit(message[5]))
1906 continue; /* corrupt? */
1907 email_end[1] = '\0';
1908 tz = strtol(message + 1, NULL, 10);
1909 if (message[6] != '\t')
1910 message += 6;
1911 else
1912 message += 7;
1913 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1914 cb_data);
1915 if (ret)
1916 break;
1917 }
1918 fclose(logfp);
1919 strbuf_release(&sb);
1920 return ret;
1921}
1922
1923int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
1924{
1925 return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
1926}
1927
1928static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1929{
1930 DIR *dir = opendir(git_path("logs/%s", base));
1931 int retval = 0;
1932
1933 if (dir) {
1934 struct dirent *de;
1935 int baselen = strlen(base);
1936 char *log = xmalloc(baselen + 257);
1937
1938 memcpy(log, base, baselen);
1939 if (baselen && base[baselen-1] != '/')
1940 log[baselen++] = '/';
1941
1942 while ((de = readdir(dir)) != NULL) {
1943 struct stat st;
1944 int namelen;
1945
1946 if (de->d_name[0] == '.')
1947 continue;
1948 namelen = strlen(de->d_name);
1949 if (namelen > 255)
1950 continue;
1951 if (has_extension(de->d_name, ".lock"))
1952 continue;
1953 memcpy(log + baselen, de->d_name, namelen+1);
1954 if (stat(git_path("logs/%s", log), &st) < 0)
1955 continue;
1956 if (S_ISDIR(st.st_mode)) {
1957 retval = do_for_each_reflog(log, fn, cb_data);
1958 } else {
1959 unsigned char sha1[20];
1960 if (read_ref_full(log, sha1, 0, NULL))
1961 retval = error("bad ref for %s", log);
1962 else
1963 retval = fn(log, sha1, 0, cb_data);
1964 }
1965 if (retval)
1966 break;
1967 }
1968 free(log);
1969 closedir(dir);
1970 }
1971 else if (*base)
1972 return errno;
1973 return retval;
1974}
1975
1976int for_each_reflog(each_ref_fn fn, void *cb_data)
1977{
1978 return do_for_each_reflog("", fn, cb_data);
1979}
1980
1981int update_ref(const char *action, const char *refname,
1982 const unsigned char *sha1, const unsigned char *oldval,
1983 int flags, enum action_on_err onerr)
1984{
1985 static struct ref_lock *lock;
1986 lock = lock_any_ref_for_update(refname, oldval, flags);
1987 if (!lock) {
1988 const char *str = "Cannot lock the ref '%s'.";
1989 switch (onerr) {
1990 case MSG_ON_ERR: error(str, refname); break;
1991 case DIE_ON_ERR: die(str, refname); break;
1992 case QUIET_ON_ERR: break;
1993 }
1994 return 1;
1995 }
1996 if (write_ref_sha1(lock, sha1, action) < 0) {
1997 const char *str = "Cannot update the ref '%s'.";
1998 switch (onerr) {
1999 case MSG_ON_ERR: error(str, refname); break;
2000 case DIE_ON_ERR: die(str, refname); break;
2001 case QUIET_ON_ERR: break;
2002 }
2003 return 1;
2004 }
2005 return 0;
2006}
2007
2008int ref_exists(const char *refname)
2009{
2010 unsigned char sha1[20];
2011 return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
2012}
2013
2014struct ref *find_ref_by_name(const struct ref *list, const char *name)
2015{
2016 for ( ; list; list = list->next)
2017 if (!strcmp(list->name, name))
2018 return (struct ref *)list;
2019 return NULL;
2020}
2021
2022/*
2023 * generate a format suitable for scanf from a ref_rev_parse_rules
2024 * rule, that is replace the "%.*s" spec with a "%s" spec
2025 */
2026static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
2027{
2028 char *spec;
2029
2030 spec = strstr(rule, "%.*s");
2031 if (!spec || strstr(spec + 4, "%.*s"))
2032 die("invalid rule in ref_rev_parse_rules: %s", rule);
2033
2034 /* copy all until spec */
2035 strncpy(scanf_fmt, rule, spec - rule);
2036 scanf_fmt[spec - rule] = '\0';
2037 /* copy new spec */
2038 strcat(scanf_fmt, "%s");
2039 /* copy remaining rule */
2040 strcat(scanf_fmt, spec + 4);
2041
2042 return;
2043}
2044
2045char *shorten_unambiguous_ref(const char *refname, int strict)
2046{
2047 int i;
2048 static char **scanf_fmts;
2049 static int nr_rules;
2050 char *short_name;
2051
2052 /* pre generate scanf formats from ref_rev_parse_rules[] */
2053 if (!nr_rules) {
2054 size_t total_len = 0;
2055
2056 /* the rule list is NULL terminated, count them first */
2057 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
2058 /* no +1 because strlen("%s") < strlen("%.*s") */
2059 total_len += strlen(ref_rev_parse_rules[nr_rules]);
2060
2061 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
2062
2063 total_len = 0;
2064 for (i = 0; i < nr_rules; i++) {
2065 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
2066 + total_len;
2067 gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
2068 total_len += strlen(ref_rev_parse_rules[i]);
2069 }
2070 }
2071
2072 /* bail out if there are no rules */
2073 if (!nr_rules)
2074 return xstrdup(refname);
2075
2076 /* buffer for scanf result, at most refname must fit */
2077 short_name = xstrdup(refname);
2078
2079 /* skip first rule, it will always match */
2080 for (i = nr_rules - 1; i > 0 ; --i) {
2081 int j;
2082 int rules_to_fail = i;
2083 int short_name_len;
2084
2085 if (1 != sscanf(refname, scanf_fmts[i], short_name))
2086 continue;
2087
2088 short_name_len = strlen(short_name);
2089
2090 /*
2091 * in strict mode, all (except the matched one) rules
2092 * must fail to resolve to a valid non-ambiguous ref
2093 */
2094 if (strict)
2095 rules_to_fail = nr_rules;
2096
2097 /*
2098 * check if the short name resolves to a valid ref,
2099 * but use only rules prior to the matched one
2100 */
2101 for (j = 0; j < rules_to_fail; j++) {
2102 const char *rule = ref_rev_parse_rules[j];
2103 char refname[PATH_MAX];
2104
2105 /* skip matched rule */
2106 if (i == j)
2107 continue;
2108
2109 /*
2110 * the short name is ambiguous, if it resolves
2111 * (with this previous rule) to a valid ref
2112 * read_ref() returns 0 on success
2113 */
2114 mksnpath(refname, sizeof(refname),
2115 rule, short_name_len, short_name);
2116 if (ref_exists(refname))
2117 break;
2118 }
2119
2120 /*
2121 * short name is non-ambiguous if all previous rules
2122 * haven't resolved to a valid ref
2123 */
2124 if (j == rules_to_fail)
2125 return short_name;
2126 }
2127
2128 free(short_name);
2129 return xstrdup(refname);
2130}