Change check_refname_format() to reject unnormalized refnames
[alt-git.git] / refs.c
blobd2aac24a366f946ea5a256a7bc47f10d36f98a88
1 #include "cache.h"
2 #include "refs.h"
3 #include "object.h"
4 #include "tag.h"
5 #include "dir.h"
7 /* ISSYMREF=01 and ISPACKED=02 are public interfaces */
8 #define REF_KNOWS_PEELED 04
9 #define REF_BROKEN 010
11 struct ref_list {
12 struct ref_list *next;
13 unsigned char flag; /* ISSYMREF? ISPACKED? */
14 unsigned char sha1[20];
15 unsigned char peeled[20];
16 char name[FLEX_ARRAY];
19 static const char *parse_ref_line(char *line, unsigned char *sha1)
22 * 42: the answer to everything.
24 * In this case, it happens to be the answer to
25 * 40 (length of sha1 hex representation)
26 * +1 (space in between hex and name)
27 * +1 (newline at the end of the line)
29 int len = strlen(line) - 42;
31 if (len <= 0)
32 return NULL;
33 if (get_sha1_hex(line, sha1) < 0)
34 return NULL;
35 if (!isspace(line[40]))
36 return NULL;
37 line += 41;
38 if (isspace(*line))
39 return NULL;
40 if (line[len] != '\n')
41 return NULL;
42 line[len] = 0;
44 return line;
47 static struct ref_list *add_ref(const char *name, const unsigned char *sha1,
48 int flag, struct ref_list *list,
49 struct ref_list **new_entry)
51 int len;
52 struct ref_list *entry;
54 /* Allocate it and add it in.. */
55 len = strlen(name) + 1;
56 entry = xmalloc(sizeof(struct ref_list) + len);
57 hashcpy(entry->sha1, sha1);
58 hashclr(entry->peeled);
59 memcpy(entry->name, name, len);
60 entry->flag = flag;
61 entry->next = list;
62 if (new_entry)
63 *new_entry = entry;
64 return entry;
67 /* merge sort the ref list */
68 static struct ref_list *sort_ref_list(struct ref_list *list)
70 int psize, qsize, last_merge_count, cmp;
71 struct ref_list *p, *q, *l, *e;
72 struct ref_list *new_list = list;
73 int k = 1;
74 int merge_count = 0;
76 if (!list)
77 return list;
79 do {
80 last_merge_count = merge_count;
81 merge_count = 0;
83 psize = 0;
85 p = new_list;
86 q = new_list;
87 new_list = NULL;
88 l = NULL;
90 while (p) {
91 merge_count++;
93 while (psize < k && q->next) {
94 q = q->next;
95 psize++;
97 qsize = k;
99 while ((psize > 0) || (qsize > 0 && q)) {
100 if (qsize == 0 || !q) {
101 e = p;
102 p = p->next;
103 psize--;
104 } else if (psize == 0) {
105 e = q;
106 q = q->next;
107 qsize--;
108 } else {
109 cmp = strcmp(q->name, p->name);
110 if (cmp < 0) {
111 e = q;
112 q = q->next;
113 qsize--;
114 } else if (cmp > 0) {
115 e = p;
116 p = p->next;
117 psize--;
118 } else {
119 if (hashcmp(q->sha1, p->sha1))
120 die("Duplicated ref, and SHA1s don't match: %s",
121 q->name);
122 warning("Duplicated ref: %s", q->name);
123 e = q;
124 q = q->next;
125 qsize--;
126 free(e);
127 e = p;
128 p = p->next;
129 psize--;
133 e->next = NULL;
135 if (l)
136 l->next = e;
137 if (!new_list)
138 new_list = e;
139 l = e;
142 p = q;
145 k = k * 2;
146 } while ((last_merge_count != merge_count) || (last_merge_count != 1));
148 return new_list;
152 * Future: need to be in "struct repository"
153 * when doing a full libification.
155 static struct cached_refs {
156 char did_loose;
157 char did_packed;
158 struct ref_list *loose;
159 struct ref_list *packed;
160 } cached_refs, submodule_refs;
161 static struct ref_list *current_ref;
163 static struct ref_list *extra_refs;
165 static void free_ref_list(struct ref_list *list)
167 struct ref_list *next;
168 for ( ; list; list = next) {
169 next = list->next;
170 free(list);
174 static void invalidate_cached_refs(void)
176 struct cached_refs *ca = &cached_refs;
178 if (ca->did_loose && ca->loose)
179 free_ref_list(ca->loose);
180 if (ca->did_packed && ca->packed)
181 free_ref_list(ca->packed);
182 ca->loose = ca->packed = NULL;
183 ca->did_loose = ca->did_packed = 0;
186 static void read_packed_refs(FILE *f, struct cached_refs *cached_refs)
188 struct ref_list *list = NULL;
189 struct ref_list *last = NULL;
190 char refline[PATH_MAX];
191 int flag = REF_ISPACKED;
193 while (fgets(refline, sizeof(refline), f)) {
194 unsigned char sha1[20];
195 const char *name;
196 static const char header[] = "# pack-refs with:";
198 if (!strncmp(refline, header, sizeof(header)-1)) {
199 const char *traits = refline + sizeof(header) - 1;
200 if (strstr(traits, " peeled "))
201 flag |= REF_KNOWS_PEELED;
202 /* perhaps other traits later as well */
203 continue;
206 name = parse_ref_line(refline, sha1);
207 if (name) {
208 list = add_ref(name, sha1, flag, list, &last);
209 continue;
211 if (last &&
212 refline[0] == '^' &&
213 strlen(refline) == 42 &&
214 refline[41] == '\n' &&
215 !get_sha1_hex(refline + 1, sha1))
216 hashcpy(last->peeled, sha1);
218 cached_refs->packed = sort_ref_list(list);
221 void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
223 extra_refs = add_ref(name, sha1, flag, extra_refs, NULL);
226 void clear_extra_refs(void)
228 free_ref_list(extra_refs);
229 extra_refs = NULL;
232 static struct ref_list *get_packed_refs(const char *submodule)
234 const char *packed_refs_file;
235 struct cached_refs *refs;
237 if (submodule) {
238 packed_refs_file = git_path_submodule(submodule, "packed-refs");
239 refs = &submodule_refs;
240 free_ref_list(refs->packed);
241 } else {
242 packed_refs_file = git_path("packed-refs");
243 refs = &cached_refs;
246 if (!refs->did_packed || submodule) {
247 FILE *f = fopen(packed_refs_file, "r");
248 refs->packed = NULL;
249 if (f) {
250 read_packed_refs(f, refs);
251 fclose(f);
253 refs->did_packed = 1;
255 return refs->packed;
258 static struct ref_list *get_ref_dir(const char *submodule, const char *base,
259 struct ref_list *list)
261 DIR *dir;
262 const char *path;
264 if (submodule)
265 path = git_path_submodule(submodule, "%s", base);
266 else
267 path = git_path("%s", base);
270 dir = opendir(path);
272 if (dir) {
273 struct dirent *de;
274 int baselen = strlen(base);
275 char *ref = xmalloc(baselen + 257);
277 memcpy(ref, base, baselen);
278 if (baselen && base[baselen-1] != '/')
279 ref[baselen++] = '/';
281 while ((de = readdir(dir)) != NULL) {
282 unsigned char sha1[20];
283 struct stat st;
284 int flag;
285 int namelen;
286 const char *refdir;
288 if (de->d_name[0] == '.')
289 continue;
290 namelen = strlen(de->d_name);
291 if (namelen > 255)
292 continue;
293 if (has_extension(de->d_name, ".lock"))
294 continue;
295 memcpy(ref + baselen, de->d_name, namelen+1);
296 refdir = submodule
297 ? git_path_submodule(submodule, "%s", ref)
298 : git_path("%s", ref);
299 if (stat(refdir, &st) < 0)
300 continue;
301 if (S_ISDIR(st.st_mode)) {
302 list = get_ref_dir(submodule, ref, list);
303 continue;
305 if (submodule) {
306 hashclr(sha1);
307 flag = 0;
308 if (resolve_gitlink_ref(submodule, ref, sha1) < 0) {
309 hashclr(sha1);
310 flag |= REF_BROKEN;
312 } else
313 if (!resolve_ref(ref, sha1, 1, &flag)) {
314 hashclr(sha1);
315 flag |= REF_BROKEN;
317 list = add_ref(ref, sha1, flag, list, NULL);
319 free(ref);
320 closedir(dir);
322 return sort_ref_list(list);
325 struct warn_if_dangling_data {
326 FILE *fp;
327 const char *refname;
328 const char *msg_fmt;
331 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
332 int flags, void *cb_data)
334 struct warn_if_dangling_data *d = cb_data;
335 const char *resolves_to;
336 unsigned char junk[20];
338 if (!(flags & REF_ISSYMREF))
339 return 0;
341 resolves_to = resolve_ref(refname, junk, 0, NULL);
342 if (!resolves_to || strcmp(resolves_to, d->refname))
343 return 0;
345 fprintf(d->fp, d->msg_fmt, refname);
346 return 0;
349 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
351 struct warn_if_dangling_data data;
353 data.fp = fp;
354 data.refname = refname;
355 data.msg_fmt = msg_fmt;
356 for_each_rawref(warn_if_dangling_symref, &data);
359 static struct ref_list *get_loose_refs(const char *submodule)
361 if (submodule) {
362 free_ref_list(submodule_refs.loose);
363 submodule_refs.loose = get_ref_dir(submodule, "refs", NULL);
364 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;
371 return cached_refs.loose;
374 /* We allow "recursive" symbolic refs. Only within reason, though */
375 #define MAXDEPTH 5
376 #define MAXREFLEN (1024)
378 static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
380 FILE *f;
381 struct cached_refs refs;
382 struct ref_list *ref;
383 int retval;
385 strcpy(name + pathlen, "packed-refs");
386 f = fopen(name, "r");
387 if (!f)
388 return -1;
389 read_packed_refs(f, &refs);
390 fclose(f);
391 ref = refs.packed;
392 retval = -1;
393 while (ref) {
394 if (!strcmp(ref->name, refname)) {
395 retval = 0;
396 memcpy(result, ref->sha1, 20);
397 break;
399 ref = ref->next;
401 free_ref_list(refs.packed);
402 return retval;
405 static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
407 int fd, len = strlen(refname);
408 char buffer[128], *p;
410 if (recursion > MAXDEPTH || len > MAXREFLEN)
411 return -1;
412 memcpy(name + pathlen, refname, len+1);
413 fd = open(name, O_RDONLY);
414 if (fd < 0)
415 return resolve_gitlink_packed_ref(name, pathlen, refname, result);
417 len = read(fd, buffer, sizeof(buffer)-1);
418 close(fd);
419 if (len < 0)
420 return -1;
421 while (len && isspace(buffer[len-1]))
422 len--;
423 buffer[len] = 0;
425 /* Was it a detached head or an old-fashioned symlink? */
426 if (!get_sha1_hex(buffer, result))
427 return 0;
429 /* Symref? */
430 if (strncmp(buffer, "ref:", 4))
431 return -1;
432 p = buffer + 4;
433 while (isspace(*p))
434 p++;
436 return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
439 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
441 int len = strlen(path), retval;
442 char *gitdir;
443 const char *tmp;
445 while (len && path[len-1] == '/')
446 len--;
447 if (!len)
448 return -1;
449 gitdir = xmalloc(len + MAXREFLEN + 8);
450 memcpy(gitdir, path, len);
451 memcpy(gitdir + len, "/.git", 6);
452 len += 5;
454 tmp = read_gitfile(gitdir);
455 if (tmp) {
456 free(gitdir);
457 len = strlen(tmp);
458 gitdir = xmalloc(len + MAXREFLEN + 3);
459 memcpy(gitdir, tmp, len);
461 gitdir[len] = '/';
462 gitdir[++len] = '\0';
463 retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
464 free(gitdir);
465 return retval;
469 * If the "reading" argument is set, this function finds out what _object_
470 * the ref points at by "reading" the ref. The ref, if it is not symbolic,
471 * has to exist, and if it is symbolic, it has to point at an existing ref,
472 * because the "read" goes through the symref to the ref it points at.
474 * The access that is not "reading" may often be "writing", but does not
475 * have to; it can be merely checking _where it leads to_. If it is a
476 * prelude to "writing" to the ref, a write to a symref that points at
477 * yet-to-be-born ref will create the real ref pointed by the symref.
478 * 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)
482 int depth = MAXDEPTH;
483 ssize_t len;
484 char buffer[256];
485 static char ref_buffer[256];
487 if (flag)
488 *flag = 0;
490 for (;;) {
491 char path[PATH_MAX];
492 struct stat st;
493 char *buf;
494 int fd;
496 if (--depth < 0)
497 return NULL;
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 if (flag)
507 *flag |= REF_ISPACKED;
508 return ref;
510 list = list->next;
512 if (reading || errno != ENOENT)
513 return NULL;
514 hashclr(sha1);
515 return ref;
518 /* Follow "normalized" - ie "refs/.." symlinks by hand */
519 if (S_ISLNK(st.st_mode)) {
520 len = readlink(path, buffer, sizeof(buffer)-1);
521 if (len >= 5 && !memcmp("refs/", buffer, 5)) {
522 buffer[len] = 0;
523 strcpy(ref_buffer, buffer);
524 ref = ref_buffer;
525 if (flag)
526 *flag |= REF_ISSYMREF;
527 continue;
531 /* Is it a directory? */
532 if (S_ISDIR(st.st_mode)) {
533 errno = EISDIR;
534 return NULL;
538 * Anything else, just open it and try to use it as
539 * a ref
541 fd = open(path, O_RDONLY);
542 if (fd < 0)
543 return NULL;
544 len = read_in_full(fd, buffer, sizeof(buffer)-1);
545 close(fd);
548 * Is it a symbolic ref?
550 if (len < 4 || memcmp("ref:", buffer, 4))
551 break;
552 buf = buffer + 4;
553 len -= 4;
554 while (len && isspace(*buf))
555 buf++, len--;
556 while (len && isspace(buf[len-1]))
557 len--;
558 buf[len] = 0;
559 memcpy(ref_buffer, buf, len + 1);
560 ref = ref_buffer;
561 if (flag)
562 *flag |= REF_ISSYMREF;
564 if (len < 40 || get_sha1_hex(buffer, sha1))
565 return NULL;
566 return ref;
569 /* The argument to filter_refs */
570 struct ref_filter {
571 const char *pattern;
572 each_ref_fn *fn;
573 void *cb_data;
576 int read_ref(const char *ref, unsigned char *sha1)
578 if (resolve_ref(ref, sha1, 1, NULL))
579 return 0;
580 return -1;
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)
587 if (prefixcmp(entry->name, base))
588 return 0;
590 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
591 if (entry->flag & REF_BROKEN)
592 return 0; /* ignore dangling symref */
593 if (!has_sha1_file(entry->sha1)) {
594 error("%s does not point to a valid object!", entry->name);
595 return 0;
598 current_ref = entry;
599 return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
602 static int filter_refs(const char *ref, const unsigned char *sha, int flags,
603 void *data)
605 struct ref_filter *filter = (struct ref_filter *)data;
606 if (fnmatch(filter->pattern, ref, 0))
607 return 0;
608 return filter->fn(ref, sha, flags, filter->cb_data);
611 int peel_ref(const char *ref, unsigned char *sha1)
613 int flag;
614 unsigned char base[20];
615 struct object *o;
617 if (current_ref && (current_ref->name == ref
618 || !strcmp(current_ref->name, ref))) {
619 if (current_ref->flag & REF_KNOWS_PEELED) {
620 hashcpy(sha1, current_ref->peeled);
621 return 0;
623 hashcpy(base, current_ref->sha1);
624 goto fallback;
627 if (!resolve_ref(ref, base, 1, &flag))
628 return -1;
630 if ((flag & REF_ISPACKED)) {
631 struct ref_list *list = get_packed_refs(NULL);
633 while (list) {
634 if (!strcmp(list->name, ref)) {
635 if (list->flag & REF_KNOWS_PEELED) {
636 hashcpy(sha1, list->peeled);
637 return 0;
639 /* older pack-refs did not leave peeled ones */
640 break;
642 list = list->next;
646 fallback:
647 o = parse_object(base);
648 if (o && o->type == OBJ_TAG) {
649 o = deref_tag(o, ref, 0);
650 if (o) {
651 hashcpy(sha1, o->sha1);
652 return 0;
655 return -1;
658 static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
659 int trim, int flags, void *cb_data)
661 int retval = 0;
662 struct ref_list *packed = get_packed_refs(submodule);
663 struct ref_list *loose = get_loose_refs(submodule);
665 struct ref_list *extra;
667 for (extra = extra_refs; extra; extra = extra->next)
668 retval = do_one_ref(base, fn, trim, flags, cb_data, extra);
670 while (packed && loose) {
671 struct ref_list *entry;
672 int cmp = strcmp(packed->name, loose->name);
673 if (!cmp) {
674 packed = packed->next;
675 continue;
677 if (cmp > 0) {
678 entry = loose;
679 loose = loose->next;
680 } else {
681 entry = packed;
682 packed = packed->next;
684 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
685 if (retval)
686 goto end_each;
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;
695 end_each:
696 current_ref = NULL;
697 return retval;
701 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
703 unsigned char sha1[20];
704 int flag;
706 if (submodule) {
707 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
708 return fn("HEAD", sha1, 0, cb_data);
710 return 0;
713 if (resolve_ref("HEAD", sha1, 1, &flag))
714 return fn("HEAD", sha1, flag, cb_data);
716 return 0;
719 int head_ref(each_ref_fn fn, void *cb_data)
721 return do_head_ref(NULL, fn, cb_data);
724 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
726 return do_head_ref(submodule, fn, cb_data);
729 int for_each_ref(each_ref_fn fn, void *cb_data)
731 return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
734 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);
739 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);
744 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
745 each_ref_fn fn, void *cb_data)
747 return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
750 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
752 return for_each_ref_in("refs/tags/", fn, cb_data);
755 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
757 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)
762 return for_each_ref_in("refs/heads/", fn, cb_data);
765 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
767 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)
772 return for_each_ref_in("refs/remotes/", fn, cb_data);
775 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
777 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
780 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);
785 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
787 struct strbuf buf = STRBUF_INIT;
788 int ret = 0;
789 unsigned char sha1[20];
790 int flag;
792 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
793 if (resolve_ref(buf.buf, sha1, 1, &flag))
794 ret = fn(buf.buf, sha1, flag, cb_data);
795 strbuf_release(&buf);
797 return ret;
800 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
802 struct strbuf buf = STRBUF_INIT;
803 int ret;
804 strbuf_addf(&buf, "%srefs/", get_git_namespace());
805 ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
806 strbuf_release(&buf);
807 return ret;
810 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
811 const char *prefix, void *cb_data)
813 struct strbuf real_pattern = STRBUF_INIT;
814 struct ref_filter filter;
815 int ret;
817 if (!prefix && prefixcmp(pattern, "refs/"))
818 strbuf_addstr(&real_pattern, "refs/");
819 else if (prefix)
820 strbuf_addstr(&real_pattern, prefix);
821 strbuf_addstr(&real_pattern, pattern);
823 if (!has_glob_specials(pattern)) {
824 /* Append implied '/' '*' if not present. */
825 if (real_pattern.buf[real_pattern.len - 1] != '/')
826 strbuf_addch(&real_pattern, '/');
827 /* No need to check for '*', there is none. */
828 strbuf_addch(&real_pattern, '*');
831 filter.pattern = real_pattern.buf;
832 filter.fn = fn;
833 filter.cb_data = cb_data;
834 ret = for_each_ref(filter_refs, &filter);
836 strbuf_release(&real_pattern);
837 return ret;
840 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
842 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
845 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);
852 * Make sure "ref" is something reasonable to have under ".git/refs/";
853 * We do not like it if:
855 * - any path component of it begins with ".", or
856 * - it has double dots "..", or
857 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
858 * - it ends with a "/".
859 * - it ends with ".lock"
860 * - it contains a "\" (backslash)
863 /* Return true iff ch is not allowed in reference names. */
864 static inline int bad_ref_char(int ch)
866 if (((unsigned) ch) <= ' ' || ch == 0x7f ||
867 ch == '~' || ch == '^' || ch == ':' || ch == '\\')
868 return 1;
869 /* 2.13 Pattern Matching Notation */
870 if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
871 return 1;
872 return 0;
876 * Try to read one refname component from the front of ref. Return
877 * the length of the component found, or -1 if the component is not
878 * legal.
880 static int check_refname_component(const char *ref)
882 const char *cp;
883 char last = '\0';
885 for (cp = ref; ; cp++) {
886 char ch = *cp;
887 if (ch == '\0' || ch == '/')
888 break;
889 if (bad_ref_char(ch))
890 return -1; /* Illegal character in refname. */
891 if (last == '.' && ch == '.')
892 return -1; /* Refname contains "..". */
893 if (last == '@' && ch == '{')
894 return -1; /* Refname contains "@{". */
895 last = ch;
897 if (cp == ref)
898 return -1; /* Component has zero length. */
899 if (ref[0] == '.')
900 return -1; /* Component starts with '.'. */
901 if (cp - ref >= 5 && !memcmp(cp - 5, ".lock", 5))
902 return -1; /* Refname ends with ".lock". */
903 return cp - ref;
906 int check_refname_format(const char *ref, int flags)
908 int component_len, component_count = 0;
910 while (1) {
911 /* We are at the start of a path component. */
912 component_len = check_refname_component(ref);
913 if (component_len < 0) {
914 if ((flags & REFNAME_REFSPEC_PATTERN) &&
915 ref[0] == '*' &&
916 (ref[1] == '\0' || ref[1] == '/')) {
917 /* Accept one wildcard as a full refname component. */
918 flags &= ~REFNAME_REFSPEC_PATTERN;
919 component_len = 1;
920 } else {
921 return -1;
924 component_count++;
925 if (ref[component_len] == '\0')
926 break;
927 /* Skip to next component. */
928 ref += component_len + 1;
931 if (ref[component_len - 1] == '.')
932 return -1; /* Refname ends with '.'. */
933 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
934 return -1; /* Refname has only one component. */
935 return 0;
938 const char *prettify_refname(const char *name)
940 return name + (
941 !prefixcmp(name, "refs/heads/") ? 11 :
942 !prefixcmp(name, "refs/tags/") ? 10 :
943 !prefixcmp(name, "refs/remotes/") ? 13 :
947 const char *ref_rev_parse_rules[] = {
948 "%.*s",
949 "refs/%.*s",
950 "refs/tags/%.*s",
951 "refs/heads/%.*s",
952 "refs/remotes/%.*s",
953 "refs/remotes/%.*s/HEAD",
954 NULL
957 const char *ref_fetch_rules[] = {
958 "%.*s",
959 "refs/%.*s",
960 "refs/heads/%.*s",
961 NULL
964 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
966 const char **p;
967 const int abbrev_name_len = strlen(abbrev_name);
969 for (p = rules; *p; p++) {
970 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
971 return 1;
975 return 0;
978 static struct ref_lock *verify_lock(struct ref_lock *lock,
979 const unsigned char *old_sha1, int mustexist)
981 if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
982 error("Can't verify ref %s", lock->ref_name);
983 unlock_ref(lock);
984 return NULL;
986 if (hashcmp(lock->old_sha1, old_sha1)) {
987 error("Ref %s is at %s but expected %s", lock->ref_name,
988 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
989 unlock_ref(lock);
990 return NULL;
992 return lock;
995 static int remove_empty_directories(const char *file)
997 /* we want to create a file but there is a directory there;
998 * if that is an empty directory (or a directory that contains
999 * only empty directories), remove them.
1001 struct strbuf path;
1002 int result;
1004 strbuf_init(&path, 20);
1005 strbuf_addstr(&path, file);
1007 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1009 strbuf_release(&path);
1011 return result;
1014 static int is_refname_available(const char *ref, const char *oldref,
1015 struct ref_list *list, int quiet)
1017 int namlen = strlen(ref); /* e.g. 'foo/bar' */
1018 while (list) {
1019 /* list->name could be 'foo' or 'foo/bar/baz' */
1020 if (!oldref || strcmp(oldref, list->name)) {
1021 int len = strlen(list->name);
1022 int cmplen = (namlen < len) ? namlen : len;
1023 const char *lead = (namlen < len) ? list->name : ref;
1024 if (!strncmp(ref, list->name, cmplen) &&
1025 lead[cmplen] == '/') {
1026 if (!quiet)
1027 error("'%s' exists; cannot create '%s'",
1028 list->name, ref);
1029 return 0;
1032 list = list->next;
1034 return 1;
1037 static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
1039 char *ref_file;
1040 const char *orig_ref = ref;
1041 struct ref_lock *lock;
1042 int last_errno = 0;
1043 int type, lflags;
1044 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1045 int missing = 0;
1047 lock = xcalloc(1, sizeof(struct ref_lock));
1048 lock->lock_fd = -1;
1050 ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
1051 if (!ref && errno == EISDIR) {
1052 /* we are trying to lock foo but we used to
1053 * have foo/bar which now does not exist;
1054 * it is normal for the empty directory 'foo'
1055 * to remain.
1057 ref_file = git_path("%s", orig_ref);
1058 if (remove_empty_directories(ref_file)) {
1059 last_errno = errno;
1060 error("there are still refs under '%s'", orig_ref);
1061 goto error_return;
1063 ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
1065 if (type_p)
1066 *type_p = type;
1067 if (!ref) {
1068 last_errno = errno;
1069 error("unable to resolve reference %s: %s",
1070 orig_ref, strerror(errno));
1071 goto error_return;
1073 missing = is_null_sha1(lock->old_sha1);
1074 /* When the ref did not exist and we are creating it,
1075 * make sure there is no existing ref that is packed
1076 * whose name begins with our refname, nor a ref whose
1077 * name is a proper prefix of our refname.
1079 if (missing &&
1080 !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1081 last_errno = ENOTDIR;
1082 goto error_return;
1085 lock->lk = xcalloc(1, sizeof(struct lock_file));
1087 lflags = LOCK_DIE_ON_ERROR;
1088 if (flags & REF_NODEREF) {
1089 ref = orig_ref;
1090 lflags |= LOCK_NODEREF;
1092 lock->ref_name = xstrdup(ref);
1093 lock->orig_ref_name = xstrdup(orig_ref);
1094 ref_file = git_path("%s", ref);
1095 if (missing)
1096 lock->force_write = 1;
1097 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1098 lock->force_write = 1;
1100 if (safe_create_leading_directories(ref_file)) {
1101 last_errno = errno;
1102 error("unable to create directory for %s", ref_file);
1103 goto error_return;
1106 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1107 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1109 error_return:
1110 unlock_ref(lock);
1111 errno = last_errno;
1112 return NULL;
1115 struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
1117 char refpath[PATH_MAX];
1118 if (check_refname_format(ref, 0))
1119 return NULL;
1120 strcpy(refpath, mkpath("refs/%s", ref));
1121 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1124 struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1126 if (check_refname_format(ref, REFNAME_ALLOW_ONELEVEL))
1127 return NULL;
1128 return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
1131 static struct lock_file packlock;
1133 static int repack_without_ref(const char *refname)
1135 struct ref_list *list, *packed_ref_list;
1136 int fd;
1137 int found = 0;
1139 packed_ref_list = get_packed_refs(NULL);
1140 for (list = packed_ref_list; list; list = list->next) {
1141 if (!strcmp(refname, list->name)) {
1142 found = 1;
1143 break;
1146 if (!found)
1147 return 0;
1148 fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1149 if (fd < 0) {
1150 unable_to_lock_error(git_path("packed-refs"), errno);
1151 return error("cannot delete '%s' from packed refs", refname);
1154 for (list = packed_ref_list; list; list = list->next) {
1155 char line[PATH_MAX + 100];
1156 int len;
1158 if (!strcmp(refname, list->name))
1159 continue;
1160 len = snprintf(line, sizeof(line), "%s %s\n",
1161 sha1_to_hex(list->sha1), list->name);
1162 /* this should not happen but just being defensive */
1163 if (len > sizeof(line))
1164 die("too long a refname '%s'", list->name);
1165 write_or_die(fd, line, len);
1167 return commit_lock_file(&packlock);
1170 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1172 struct ref_lock *lock;
1173 int err, i = 0, ret = 0, flag = 0;
1175 lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1176 if (!lock)
1177 return 1;
1178 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1179 /* loose */
1180 const char *path;
1182 if (!(delopt & REF_NODEREF)) {
1183 i = strlen(lock->lk->filename) - 5; /* .lock */
1184 lock->lk->filename[i] = 0;
1185 path = lock->lk->filename;
1186 } else {
1187 path = git_path("%s", refname);
1189 err = unlink_or_warn(path);
1190 if (err && errno != ENOENT)
1191 ret = 1;
1193 if (!(delopt & REF_NODEREF))
1194 lock->lk->filename[i] = '.';
1196 /* removing the loose one could have resurrected an earlier
1197 * packed one. Also, if it was not loose we need to repack
1198 * without it.
1200 ret |= repack_without_ref(refname);
1202 unlink_or_warn(git_path("logs/%s", lock->ref_name));
1203 invalidate_cached_refs();
1204 unlock_ref(lock);
1205 return ret;
1209 * People using contrib's git-new-workdir have .git/logs/refs ->
1210 * /some/other/path/.git/logs/refs, and that may live on another device.
1212 * IOW, to avoid cross device rename errors, the temporary renamed log must
1213 * live into logs/refs.
1215 #define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1217 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1219 static const char renamed_ref[] = "RENAMED-REF";
1220 unsigned char sha1[20], orig_sha1[20];
1221 int flag = 0, logmoved = 0;
1222 struct ref_lock *lock;
1223 struct stat loginfo;
1224 int log = !lstat(git_path("logs/%s", oldref), &loginfo);
1225 const char *symref = NULL;
1227 if (log && S_ISLNK(loginfo.st_mode))
1228 return error("reflog for %s is a symlink", oldref);
1230 symref = resolve_ref(oldref, orig_sha1, 1, &flag);
1231 if (flag & REF_ISSYMREF)
1232 return error("refname %s is a symbolic ref, renaming it is not supported",
1233 oldref);
1234 if (!symref)
1235 return error("refname %s not found", oldref);
1237 if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1238 return 1;
1240 if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1241 return 1;
1243 lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1244 if (!lock)
1245 return error("unable to lock %s", renamed_ref);
1246 lock->force_write = 1;
1247 if (write_ref_sha1(lock, orig_sha1, logmsg))
1248 return error("unable to save current sha1 in %s", renamed_ref);
1250 if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
1251 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1252 oldref, strerror(errno));
1254 if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1255 error("unable to delete old %s", oldref);
1256 goto rollback;
1259 if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1260 if (errno==EISDIR) {
1261 if (remove_empty_directories(git_path("%s", newref))) {
1262 error("Directory not empty: %s", newref);
1263 goto rollback;
1265 } else {
1266 error("unable to delete existing %s", newref);
1267 goto rollback;
1271 if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1272 error("unable to create directory for %s", newref);
1273 goto rollback;
1276 retry:
1277 if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1278 if (errno==EISDIR || errno==ENOTDIR) {
1280 * rename(a, b) when b is an existing
1281 * directory ought to result in ISDIR, but
1282 * Solaris 5.8 gives ENOTDIR. Sheesh.
1284 if (remove_empty_directories(git_path("logs/%s", newref))) {
1285 error("Directory not empty: logs/%s", newref);
1286 goto rollback;
1288 goto retry;
1289 } else {
1290 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1291 newref, strerror(errno));
1292 goto rollback;
1295 logmoved = log;
1297 lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1298 if (!lock) {
1299 error("unable to lock %s for update", newref);
1300 goto rollback;
1302 lock->force_write = 1;
1303 hashcpy(lock->old_sha1, orig_sha1);
1304 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1305 error("unable to write current sha1 into %s", newref);
1306 goto rollback;
1309 return 0;
1311 rollback:
1312 lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1313 if (!lock) {
1314 error("unable to lock %s for rollback", oldref);
1315 goto rollbacklog;
1318 lock->force_write = 1;
1319 flag = log_all_ref_updates;
1320 log_all_ref_updates = 0;
1321 if (write_ref_sha1(lock, orig_sha1, NULL))
1322 error("unable to write current sha1 into %s", oldref);
1323 log_all_ref_updates = flag;
1325 rollbacklog:
1326 if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1327 error("unable to restore logfile %s from %s: %s",
1328 oldref, newref, strerror(errno));
1329 if (!logmoved && log &&
1330 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
1331 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1332 oldref, strerror(errno));
1334 return 1;
1337 int close_ref(struct ref_lock *lock)
1339 if (close_lock_file(lock->lk))
1340 return -1;
1341 lock->lock_fd = -1;
1342 return 0;
1345 int commit_ref(struct ref_lock *lock)
1347 if (commit_lock_file(lock->lk))
1348 return -1;
1349 lock->lock_fd = -1;
1350 return 0;
1353 void unlock_ref(struct ref_lock *lock)
1355 /* Do not free lock->lk -- atexit() still looks at them */
1356 if (lock->lk)
1357 rollback_lock_file(lock->lk);
1358 free(lock->ref_name);
1359 free(lock->orig_ref_name);
1360 free(lock);
1364 * copy the reflog message msg to buf, which has been allocated sufficiently
1365 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1366 * because reflog file is one line per entry.
1368 static int copy_msg(char *buf, const char *msg)
1370 char *cp = buf;
1371 char c;
1372 int wasspace = 1;
1374 *cp++ = '\t';
1375 while ((c = *msg++)) {
1376 if (wasspace && isspace(c))
1377 continue;
1378 wasspace = isspace(c);
1379 if (wasspace)
1380 c = ' ';
1381 *cp++ = c;
1383 while (buf < cp && isspace(cp[-1]))
1384 cp--;
1385 *cp++ = '\n';
1386 return cp - buf;
1389 int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1391 int logfd, oflags = O_APPEND | O_WRONLY;
1393 git_snpath(logfile, bufsize, "logs/%s", ref_name);
1394 if (log_all_ref_updates &&
1395 (!prefixcmp(ref_name, "refs/heads/") ||
1396 !prefixcmp(ref_name, "refs/remotes/") ||
1397 !prefixcmp(ref_name, "refs/notes/") ||
1398 !strcmp(ref_name, "HEAD"))) {
1399 if (safe_create_leading_directories(logfile) < 0)
1400 return error("unable to create directory for %s",
1401 logfile);
1402 oflags |= O_CREAT;
1405 logfd = open(logfile, oflags, 0666);
1406 if (logfd < 0) {
1407 if (!(oflags & O_CREAT) && errno == ENOENT)
1408 return 0;
1410 if ((oflags & O_CREAT) && errno == EISDIR) {
1411 if (remove_empty_directories(logfile)) {
1412 return error("There are still logs under '%s'",
1413 logfile);
1415 logfd = open(logfile, oflags, 0666);
1418 if (logfd < 0)
1419 return error("Unable to append to %s: %s",
1420 logfile, strerror(errno));
1423 adjust_shared_perm(logfile);
1424 close(logfd);
1425 return 0;
1428 static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1429 const unsigned char *new_sha1, const char *msg)
1431 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1432 unsigned maxlen, len;
1433 int msglen;
1434 char log_file[PATH_MAX];
1435 char *logrec;
1436 const char *committer;
1438 if (log_all_ref_updates < 0)
1439 log_all_ref_updates = !is_bare_repository();
1441 result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1442 if (result)
1443 return result;
1445 logfd = open(log_file, oflags);
1446 if (logfd < 0)
1447 return 0;
1448 msglen = msg ? strlen(msg) : 0;
1449 committer = git_committer_info(0);
1450 maxlen = strlen(committer) + msglen + 100;
1451 logrec = xmalloc(maxlen);
1452 len = sprintf(logrec, "%s %s %s\n",
1453 sha1_to_hex(old_sha1),
1454 sha1_to_hex(new_sha1),
1455 committer);
1456 if (msglen)
1457 len += copy_msg(logrec + len - 1, msg) - 1;
1458 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1459 free(logrec);
1460 if (close(logfd) != 0 || written != len)
1461 return error("Unable to append to %s", log_file);
1462 return 0;
1465 static int is_branch(const char *refname)
1467 return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1470 int write_ref_sha1(struct ref_lock *lock,
1471 const unsigned char *sha1, const char *logmsg)
1473 static char term = '\n';
1474 struct object *o;
1476 if (!lock)
1477 return -1;
1478 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1479 unlock_ref(lock);
1480 return 0;
1482 o = parse_object(sha1);
1483 if (!o) {
1484 error("Trying to write ref %s with nonexistent object %s",
1485 lock->ref_name, sha1_to_hex(sha1));
1486 unlock_ref(lock);
1487 return -1;
1489 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1490 error("Trying to write non-commit object %s to branch %s",
1491 sha1_to_hex(sha1), lock->ref_name);
1492 unlock_ref(lock);
1493 return -1;
1495 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1496 write_in_full(lock->lock_fd, &term, 1) != 1
1497 || close_ref(lock) < 0) {
1498 error("Couldn't write %s", lock->lk->filename);
1499 unlock_ref(lock);
1500 return -1;
1502 invalidate_cached_refs();
1503 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1504 (strcmp(lock->ref_name, lock->orig_ref_name) &&
1505 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1506 unlock_ref(lock);
1507 return -1;
1509 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1511 * Special hack: If a branch is updated directly and HEAD
1512 * points to it (may happen on the remote side of a push
1513 * for example) then logically the HEAD reflog should be
1514 * updated too.
1515 * A generic solution implies reverse symref information,
1516 * but finding all symrefs pointing to the given branch
1517 * would be rather costly for this rare event (the direct
1518 * update of a branch) to be worth it. So let's cheat and
1519 * check with HEAD only which should cover 99% of all usage
1520 * scenarios (even 100% of the default ones).
1522 unsigned char head_sha1[20];
1523 int head_flag;
1524 const char *head_ref;
1525 head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1526 if (head_ref && (head_flag & REF_ISSYMREF) &&
1527 !strcmp(head_ref, lock->ref_name))
1528 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1530 if (commit_ref(lock)) {
1531 error("Couldn't set %s", lock->ref_name);
1532 unlock_ref(lock);
1533 return -1;
1535 unlock_ref(lock);
1536 return 0;
1539 int create_symref(const char *ref_target, const char *refs_heads_master,
1540 const char *logmsg)
1542 const char *lockpath;
1543 char ref[1000];
1544 int fd, len, written;
1545 char *git_HEAD = git_pathdup("%s", ref_target);
1546 unsigned char old_sha1[20], new_sha1[20];
1548 if (logmsg && read_ref(ref_target, old_sha1))
1549 hashclr(old_sha1);
1551 if (safe_create_leading_directories(git_HEAD) < 0)
1552 return error("unable to create directory for %s", git_HEAD);
1554 #ifndef NO_SYMLINK_HEAD
1555 if (prefer_symlink_refs) {
1556 unlink(git_HEAD);
1557 if (!symlink(refs_heads_master, git_HEAD))
1558 goto done;
1559 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1561 #endif
1563 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1564 if (sizeof(ref) <= len) {
1565 error("refname too long: %s", refs_heads_master);
1566 goto error_free_return;
1568 lockpath = mkpath("%s.lock", git_HEAD);
1569 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1570 if (fd < 0) {
1571 error("Unable to open %s for writing", lockpath);
1572 goto error_free_return;
1574 written = write_in_full(fd, ref, len);
1575 if (close(fd) != 0 || written != len) {
1576 error("Unable to write to %s", lockpath);
1577 goto error_unlink_return;
1579 if (rename(lockpath, git_HEAD) < 0) {
1580 error("Unable to create %s", git_HEAD);
1581 goto error_unlink_return;
1583 if (adjust_shared_perm(git_HEAD)) {
1584 error("Unable to fix permissions on %s", lockpath);
1585 error_unlink_return:
1586 unlink_or_warn(lockpath);
1587 error_free_return:
1588 free(git_HEAD);
1589 return -1;
1592 #ifndef NO_SYMLINK_HEAD
1593 done:
1594 #endif
1595 if (logmsg && !read_ref(refs_heads_master, new_sha1))
1596 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1598 free(git_HEAD);
1599 return 0;
1602 static char *ref_msg(const char *line, const char *endp)
1604 const char *ep;
1605 line += 82;
1606 ep = memchr(line, '\n', endp - line);
1607 if (!ep)
1608 ep = endp;
1609 return xmemdupz(line, ep - line);
1612 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)
1614 const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1615 char *tz_c;
1616 int logfd, tz, reccnt = 0;
1617 struct stat st;
1618 unsigned long date;
1619 unsigned char logged_sha1[20];
1620 void *log_mapped;
1621 size_t mapsz;
1623 logfile = git_path("logs/%s", ref);
1624 logfd = open(logfile, O_RDONLY, 0);
1625 if (logfd < 0)
1626 die_errno("Unable to read log '%s'", logfile);
1627 fstat(logfd, &st);
1628 if (!st.st_size)
1629 die("Log %s is empty.", logfile);
1630 mapsz = xsize_t(st.st_size);
1631 log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1632 logdata = log_mapped;
1633 close(logfd);
1635 lastrec = NULL;
1636 rec = logend = logdata + st.st_size;
1637 while (logdata < rec) {
1638 reccnt++;
1639 if (logdata < rec && *(rec-1) == '\n')
1640 rec--;
1641 lastgt = NULL;
1642 while (logdata < rec && *(rec-1) != '\n') {
1643 rec--;
1644 if (*rec == '>')
1645 lastgt = rec;
1647 if (!lastgt)
1648 die("Log %s is corrupt.", logfile);
1649 date = strtoul(lastgt + 1, &tz_c, 10);
1650 if (date <= at_time || cnt == 0) {
1651 tz = strtoul(tz_c, NULL, 10);
1652 if (msg)
1653 *msg = ref_msg(rec, logend);
1654 if (cutoff_time)
1655 *cutoff_time = date;
1656 if (cutoff_tz)
1657 *cutoff_tz = tz;
1658 if (cutoff_cnt)
1659 *cutoff_cnt = reccnt - 1;
1660 if (lastrec) {
1661 if (get_sha1_hex(lastrec, logged_sha1))
1662 die("Log %s is corrupt.", logfile);
1663 if (get_sha1_hex(rec + 41, sha1))
1664 die("Log %s is corrupt.", logfile);
1665 if (hashcmp(logged_sha1, sha1)) {
1666 warning("Log %s has gap after %s.",
1667 logfile, show_date(date, tz, DATE_RFC2822));
1670 else if (date == at_time) {
1671 if (get_sha1_hex(rec + 41, sha1))
1672 die("Log %s is corrupt.", logfile);
1674 else {
1675 if (get_sha1_hex(rec + 41, logged_sha1))
1676 die("Log %s is corrupt.", logfile);
1677 if (hashcmp(logged_sha1, sha1)) {
1678 warning("Log %s unexpectedly ended on %s.",
1679 logfile, show_date(date, tz, DATE_RFC2822));
1682 munmap(log_mapped, mapsz);
1683 return 0;
1685 lastrec = rec;
1686 if (cnt > 0)
1687 cnt--;
1690 rec = logdata;
1691 while (rec < logend && *rec != '>' && *rec != '\n')
1692 rec++;
1693 if (rec == logend || *rec == '\n')
1694 die("Log %s is corrupt.", logfile);
1695 date = strtoul(rec + 1, &tz_c, 10);
1696 tz = strtoul(tz_c, NULL, 10);
1697 if (get_sha1_hex(logdata, sha1))
1698 die("Log %s is corrupt.", logfile);
1699 if (is_null_sha1(sha1)) {
1700 if (get_sha1_hex(logdata + 41, sha1))
1701 die("Log %s is corrupt.", logfile);
1703 if (msg)
1704 *msg = ref_msg(logdata, logend);
1705 munmap(log_mapped, mapsz);
1707 if (cutoff_time)
1708 *cutoff_time = date;
1709 if (cutoff_tz)
1710 *cutoff_tz = tz;
1711 if (cutoff_cnt)
1712 *cutoff_cnt = reccnt;
1713 return 1;
1716 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1718 const char *logfile;
1719 FILE *logfp;
1720 struct strbuf sb = STRBUF_INIT;
1721 int ret = 0;
1723 logfile = git_path("logs/%s", ref);
1724 logfp = fopen(logfile, "r");
1725 if (!logfp)
1726 return -1;
1728 if (ofs) {
1729 struct stat statbuf;
1730 if (fstat(fileno(logfp), &statbuf) ||
1731 statbuf.st_size < ofs ||
1732 fseek(logfp, -ofs, SEEK_END) ||
1733 strbuf_getwholeline(&sb, logfp, '\n')) {
1734 fclose(logfp);
1735 strbuf_release(&sb);
1736 return -1;
1740 while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1741 unsigned char osha1[20], nsha1[20];
1742 char *email_end, *message;
1743 unsigned long timestamp;
1744 int tz;
1746 /* old SP new SP name <email> SP time TAB msg LF */
1747 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1748 get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1749 get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1750 !(email_end = strchr(sb.buf + 82, '>')) ||
1751 email_end[1] != ' ' ||
1752 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1753 !message || message[0] != ' ' ||
1754 (message[1] != '+' && message[1] != '-') ||
1755 !isdigit(message[2]) || !isdigit(message[3]) ||
1756 !isdigit(message[4]) || !isdigit(message[5]))
1757 continue; /* corrupt? */
1758 email_end[1] = '\0';
1759 tz = strtol(message + 1, NULL, 10);
1760 if (message[6] != '\t')
1761 message += 6;
1762 else
1763 message += 7;
1764 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1765 cb_data);
1766 if (ret)
1767 break;
1769 fclose(logfp);
1770 strbuf_release(&sb);
1771 return ret;
1774 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1776 return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1779 static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1781 DIR *dir = opendir(git_path("logs/%s", base));
1782 int retval = 0;
1784 if (dir) {
1785 struct dirent *de;
1786 int baselen = strlen(base);
1787 char *log = xmalloc(baselen + 257);
1789 memcpy(log, base, baselen);
1790 if (baselen && base[baselen-1] != '/')
1791 log[baselen++] = '/';
1793 while ((de = readdir(dir)) != NULL) {
1794 struct stat st;
1795 int namelen;
1797 if (de->d_name[0] == '.')
1798 continue;
1799 namelen = strlen(de->d_name);
1800 if (namelen > 255)
1801 continue;
1802 if (has_extension(de->d_name, ".lock"))
1803 continue;
1804 memcpy(log + baselen, de->d_name, namelen+1);
1805 if (stat(git_path("logs/%s", log), &st) < 0)
1806 continue;
1807 if (S_ISDIR(st.st_mode)) {
1808 retval = do_for_each_reflog(log, fn, cb_data);
1809 } else {
1810 unsigned char sha1[20];
1811 if (!resolve_ref(log, sha1, 0, NULL))
1812 retval = error("bad ref for %s", log);
1813 else
1814 retval = fn(log, sha1, 0, cb_data);
1816 if (retval)
1817 break;
1819 free(log);
1820 closedir(dir);
1822 else if (*base)
1823 return errno;
1824 return retval;
1827 int for_each_reflog(each_ref_fn fn, void *cb_data)
1829 return do_for_each_reflog("", fn, cb_data);
1832 int update_ref(const char *action, const char *refname,
1833 const unsigned char *sha1, const unsigned char *oldval,
1834 int flags, enum action_on_err onerr)
1836 static struct ref_lock *lock;
1837 lock = lock_any_ref_for_update(refname, oldval, flags);
1838 if (!lock) {
1839 const char *str = "Cannot lock the ref '%s'.";
1840 switch (onerr) {
1841 case MSG_ON_ERR: error(str, refname); break;
1842 case DIE_ON_ERR: die(str, refname); break;
1843 case QUIET_ON_ERR: break;
1845 return 1;
1847 if (write_ref_sha1(lock, sha1, action) < 0) {
1848 const char *str = "Cannot update the ref '%s'.";
1849 switch (onerr) {
1850 case MSG_ON_ERR: error(str, refname); break;
1851 case DIE_ON_ERR: die(str, refname); break;
1852 case QUIET_ON_ERR: break;
1854 return 1;
1856 return 0;
1859 int ref_exists(char *refname)
1861 unsigned char sha1[20];
1862 return !!resolve_ref(refname, sha1, 1, NULL);
1865 struct ref *find_ref_by_name(const struct ref *list, const char *name)
1867 for ( ; list; list = list->next)
1868 if (!strcmp(list->name, name))
1869 return (struct ref *)list;
1870 return NULL;
1874 * generate a format suitable for scanf from a ref_rev_parse_rules
1875 * rule, that is replace the "%.*s" spec with a "%s" spec
1877 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
1879 char *spec;
1881 spec = strstr(rule, "%.*s");
1882 if (!spec || strstr(spec + 4, "%.*s"))
1883 die("invalid rule in ref_rev_parse_rules: %s", rule);
1885 /* copy all until spec */
1886 strncpy(scanf_fmt, rule, spec - rule);
1887 scanf_fmt[spec - rule] = '\0';
1888 /* copy new spec */
1889 strcat(scanf_fmt, "%s");
1890 /* copy remaining rule */
1891 strcat(scanf_fmt, spec + 4);
1893 return;
1896 char *shorten_unambiguous_ref(const char *ref, int strict)
1898 int i;
1899 static char **scanf_fmts;
1900 static int nr_rules;
1901 char *short_name;
1903 /* pre generate scanf formats from ref_rev_parse_rules[] */
1904 if (!nr_rules) {
1905 size_t total_len = 0;
1907 /* the rule list is NULL terminated, count them first */
1908 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
1909 /* no +1 because strlen("%s") < strlen("%.*s") */
1910 total_len += strlen(ref_rev_parse_rules[nr_rules]);
1912 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
1914 total_len = 0;
1915 for (i = 0; i < nr_rules; i++) {
1916 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
1917 + total_len;
1918 gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
1919 total_len += strlen(ref_rev_parse_rules[i]);
1923 /* bail out if there are no rules */
1924 if (!nr_rules)
1925 return xstrdup(ref);
1927 /* buffer for scanf result, at most ref must fit */
1928 short_name = xstrdup(ref);
1930 /* skip first rule, it will always match */
1931 for (i = nr_rules - 1; i > 0 ; --i) {
1932 int j;
1933 int rules_to_fail = i;
1934 int short_name_len;
1936 if (1 != sscanf(ref, scanf_fmts[i], short_name))
1937 continue;
1939 short_name_len = strlen(short_name);
1942 * in strict mode, all (except the matched one) rules
1943 * must fail to resolve to a valid non-ambiguous ref
1945 if (strict)
1946 rules_to_fail = nr_rules;
1949 * check if the short name resolves to a valid ref,
1950 * but use only rules prior to the matched one
1952 for (j = 0; j < rules_to_fail; j++) {
1953 const char *rule = ref_rev_parse_rules[j];
1954 unsigned char short_objectname[20];
1955 char refname[PATH_MAX];
1957 /* skip matched rule */
1958 if (i == j)
1959 continue;
1962 * the short name is ambiguous, if it resolves
1963 * (with this previous rule) to a valid ref
1964 * read_ref() returns 0 on success
1966 mksnpath(refname, sizeof(refname),
1967 rule, short_name_len, short_name);
1968 if (!read_ref(refname, short_objectname))
1969 break;
1973 * short name is non-ambiguous if all previous rules
1974 * haven't resolved to a valid ref
1976 if (j == rules_to_fail)
1977 return short_name;
1980 free(short_name);
1981 return xstrdup(ref);