Code

refs.c: ensure struct whose member may be passed to realloc is initialized
[git.git] / refs.c
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_entry {
12         unsigned char flag; /* ISSYMREF? ISPACKED? */
13         unsigned char sha1[20];
14         unsigned char peeled[20];
15         char name[FLEX_ARRAY];
16 };
18 struct ref_array {
19         int nr, alloc;
20         struct ref_entry **refs;
21 };
23 static const char *parse_ref_line(char *line, unsigned char *sha1)
24 {
25         /*
26          * 42: the answer to everything.
27          *
28          * In this case, it happens to be the answer to
29          *  40 (length of sha1 hex representation)
30          *  +1 (space in between hex and name)
31          *  +1 (newline at the end of the line)
32          */
33         int len = strlen(line) - 42;
35         if (len <= 0)
36                 return NULL;
37         if (get_sha1_hex(line, sha1) < 0)
38                 return NULL;
39         if (!isspace(line[40]))
40                 return NULL;
41         line += 41;
42         if (isspace(*line))
43                 return NULL;
44         if (line[len] != '\n')
45                 return NULL;
46         line[len] = 0;
48         return line;
49 }
51 static void add_ref(const char *name, const unsigned char *sha1,
52                     int flag, struct ref_array *refs,
53                     struct ref_entry **new_entry)
54 {
55         int len;
56         struct ref_entry *entry;
58         /* Allocate it and add it in.. */
59         len = strlen(name) + 1;
60         entry = xmalloc(sizeof(struct ref_entry) + len);
61         hashcpy(entry->sha1, sha1);
62         hashclr(entry->peeled);
63         memcpy(entry->name, name, len);
64         entry->flag = flag;
65         if (new_entry)
66                 *new_entry = entry;
67         ALLOC_GROW(refs->refs, refs->nr + 1, refs->alloc);
68         refs->refs[refs->nr++] = entry;
69 }
71 static int ref_entry_cmp(const void *a, const void *b)
72 {
73         struct ref_entry *one = *(struct ref_entry **)a;
74         struct ref_entry *two = *(struct ref_entry **)b;
75         return strcmp(one->name, two->name);
76 }
78 static void sort_ref_array(struct ref_array *array)
79 {
80         int i = 0, j = 1;
82         /* Nothing to sort unless there are at least two entries */
83         if (array->nr < 2)
84                 return;
86         qsort(array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
88         /* Remove any duplicates from the ref_array */
89         for (; j < array->nr; j++) {
90                 struct ref_entry *a = array->refs[i];
91                 struct ref_entry *b = array->refs[j];
92                 if (!strcmp(a->name, b->name)) {
93                         if (hashcmp(a->sha1, b->sha1))
94                                 die("Duplicated ref, and SHA1s don't match: %s",
95                                     a->name);
96                         warning("Duplicated ref: %s", a->name);
97                         continue;
98                 }
99                 i++;
100                 array->refs[i] = array->refs[j];
101         }
102         array->nr = i + 1;
105 static struct ref_entry *search_ref_array(struct ref_array *array, const char *name)
107         struct ref_entry *e, **r;
108         int len;
110         if (name == NULL)
111                 return NULL;
113         len = strlen(name) + 1;
114         e = xmalloc(sizeof(struct ref_entry) + len);
115         memcpy(e->name, name, len);
117         r = bsearch(&e, array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
119         free(e);
121         if (r == NULL)
122                 return NULL;
124         return *r;
127 /*
128  * Future: need to be in "struct repository"
129  * when doing a full libification.
130  */
131 static struct cached_refs {
132         char did_loose;
133         char did_packed;
134         struct ref_array loose;
135         struct ref_array packed;
136 } cached_refs, submodule_refs;
137 static struct ref_entry *current_ref;
139 static struct ref_array extra_refs;
141 static void free_ref_array(struct ref_array *array)
143         int i;
144         for (i = 0; i < array->nr; i++)
145                 free(array->refs[i]);
146         free(array->refs);
147         array->nr = array->alloc = 0;
148         array->refs = NULL;
151 static void invalidate_cached_refs(void)
153         struct cached_refs *ca = &cached_refs;
155         if (ca->did_loose)
156                 free_ref_array(&ca->loose);
157         if (ca->did_packed)
158                 free_ref_array(&ca->packed);
159         ca->did_loose = ca->did_packed = 0;
162 static void read_packed_refs(FILE *f, struct cached_refs *cached_refs)
164         struct ref_entry *last = NULL;
165         char refline[PATH_MAX];
166         int flag = REF_ISPACKED;
168         while (fgets(refline, sizeof(refline), f)) {
169                 unsigned char sha1[20];
170                 const char *name;
171                 static const char header[] = "# pack-refs with:";
173                 if (!strncmp(refline, header, sizeof(header)-1)) {
174                         const char *traits = refline + sizeof(header) - 1;
175                         if (strstr(traits, " peeled "))
176                                 flag |= REF_KNOWS_PEELED;
177                         /* perhaps other traits later as well */
178                         continue;
179                 }
181                 name = parse_ref_line(refline, sha1);
182                 if (name) {
183                         add_ref(name, sha1, flag, &cached_refs->packed, &last);
184                         continue;
185                 }
186                 if (last &&
187                     refline[0] == '^' &&
188                     strlen(refline) == 42 &&
189                     refline[41] == '\n' &&
190                     !get_sha1_hex(refline + 1, sha1))
191                         hashcpy(last->peeled, sha1);
192         }
193         sort_ref_array(&cached_refs->packed);
196 void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
198         add_ref(name, sha1, flag, &extra_refs, NULL);
201 void clear_extra_refs(void)
203         free_ref_array(&extra_refs);
206 static struct ref_array *get_packed_refs(const char *submodule)
208         const char *packed_refs_file;
209         struct cached_refs *refs;
211         if (submodule) {
212                 packed_refs_file = git_path_submodule(submodule, "packed-refs");
213                 refs = &submodule_refs;
214                 free_ref_array(&refs->packed);
215         } else {
216                 packed_refs_file = git_path("packed-refs");
217                 refs = &cached_refs;
218         }
220         if (!refs->did_packed || submodule) {
221                 FILE *f = fopen(packed_refs_file, "r");
222                 if (f) {
223                         read_packed_refs(f, refs);
224                         fclose(f);
225                 }
226                 refs->did_packed = 1;
227         }
228         return &refs->packed;
231 static void get_ref_dir(const char *submodule, const char *base,
232                         struct ref_array *array)
234         DIR *dir;
235         const char *path;
237         if (submodule)
238                 path = git_path_submodule(submodule, "%s", base);
239         else
240                 path = git_path("%s", base);
243         dir = opendir(path);
245         if (dir) {
246                 struct dirent *de;
247                 int baselen = strlen(base);
248                 char *ref = xmalloc(baselen + 257);
250                 memcpy(ref, base, baselen);
251                 if (baselen && base[baselen-1] != '/')
252                         ref[baselen++] = '/';
254                 while ((de = readdir(dir)) != NULL) {
255                         unsigned char sha1[20];
256                         struct stat st;
257                         int flag;
258                         int namelen;
259                         const char *refdir;
261                         if (de->d_name[0] == '.')
262                                 continue;
263                         namelen = strlen(de->d_name);
264                         if (namelen > 255)
265                                 continue;
266                         if (has_extension(de->d_name, ".lock"))
267                                 continue;
268                         memcpy(ref + baselen, de->d_name, namelen+1);
269                         refdir = submodule
270                                 ? git_path_submodule(submodule, "%s", ref)
271                                 : git_path("%s", ref);
272                         if (stat(refdir, &st) < 0)
273                                 continue;
274                         if (S_ISDIR(st.st_mode)) {
275                                 get_ref_dir(submodule, ref, array);
276                                 continue;
277                         }
278                         if (submodule) {
279                                 hashclr(sha1);
280                                 flag = 0;
281                                 if (resolve_gitlink_ref(submodule, ref, sha1) < 0) {
282                                         hashclr(sha1);
283                                         flag |= REF_BROKEN;
284                                 }
285                         } else
286                                 if (!resolve_ref(ref, sha1, 1, &flag)) {
287                                         hashclr(sha1);
288                                         flag |= REF_BROKEN;
289                                 }
290                         add_ref(ref, sha1, flag, array, NULL);
291                 }
292                 free(ref);
293                 closedir(dir);
294         }
297 struct warn_if_dangling_data {
298         FILE *fp;
299         const char *refname;
300         const char *msg_fmt;
301 };
303 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
304                                    int flags, void *cb_data)
306         struct warn_if_dangling_data *d = cb_data;
307         const char *resolves_to;
308         unsigned char junk[20];
310         if (!(flags & REF_ISSYMREF))
311                 return 0;
313         resolves_to = resolve_ref(refname, junk, 0, NULL);
314         if (!resolves_to || strcmp(resolves_to, d->refname))
315                 return 0;
317         fprintf(d->fp, d->msg_fmt, refname);
318         return 0;
321 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
323         struct warn_if_dangling_data data;
325         data.fp = fp;
326         data.refname = refname;
327         data.msg_fmt = msg_fmt;
328         for_each_rawref(warn_if_dangling_symref, &data);
331 static struct ref_array *get_loose_refs(const char *submodule)
333         if (submodule) {
334                 free_ref_array(&submodule_refs.loose);
335                 get_ref_dir(submodule, "refs", &submodule_refs.loose);
336                 sort_ref_array(&submodule_refs.loose);
337                 return &submodule_refs.loose;
338         }
340         if (!cached_refs.did_loose) {
341                 get_ref_dir(NULL, "refs", &cached_refs.loose);
342                 sort_ref_array(&cached_refs.loose);
343                 cached_refs.did_loose = 1;
344         }
345         return &cached_refs.loose;
348 /* We allow "recursive" symbolic refs. Only within reason, though */
349 #define MAXDEPTH 5
350 #define MAXREFLEN (1024)
352 static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
354         FILE *f;
355         struct cached_refs refs;
356         struct ref_entry *ref;
357         int retval = -1;
359         strcpy(name + pathlen, "packed-refs");
360         f = fopen(name, "r");
361         if (!f)
362                 return -1;
363         memset(&refs, 0, sizeof(refs));
364         read_packed_refs(f, &refs);
365         fclose(f);
366         ref = search_ref_array(&refs.packed, refname);
367         if (ref != NULL) {
368                 memcpy(result, ref->sha1, 20);
369                 retval = 0;
370         }
371         free_ref_array(&refs.packed);
372         return retval;
375 static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
377         int fd, len = strlen(refname);
378         char buffer[128], *p;
380         if (recursion > MAXDEPTH || len > MAXREFLEN)
381                 return -1;
382         memcpy(name + pathlen, refname, len+1);
383         fd = open(name, O_RDONLY);
384         if (fd < 0)
385                 return resolve_gitlink_packed_ref(name, pathlen, refname, result);
387         len = read(fd, buffer, sizeof(buffer)-1);
388         close(fd);
389         if (len < 0)
390                 return -1;
391         while (len && isspace(buffer[len-1]))
392                 len--;
393         buffer[len] = 0;
395         /* Was it a detached head or an old-fashioned symlink? */
396         if (!get_sha1_hex(buffer, result))
397                 return 0;
399         /* Symref? */
400         if (strncmp(buffer, "ref:", 4))
401                 return -1;
402         p = buffer + 4;
403         while (isspace(*p))
404                 p++;
406         return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
409 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
411         int len = strlen(path), retval;
412         char *gitdir;
413         const char *tmp;
415         while (len && path[len-1] == '/')
416                 len--;
417         if (!len)
418                 return -1;
419         gitdir = xmalloc(len + MAXREFLEN + 8);
420         memcpy(gitdir, path, len);
421         memcpy(gitdir + len, "/.git", 6);
422         len += 5;
424         tmp = read_gitfile_gently(gitdir);
425         if (tmp) {
426                 free(gitdir);
427                 len = strlen(tmp);
428                 gitdir = xmalloc(len + MAXREFLEN + 3);
429                 memcpy(gitdir, tmp, len);
430         }
431         gitdir[len] = '/';
432         gitdir[++len] = '\0';
433         retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
434         free(gitdir);
435         return retval;
438 /*
439  * If the "reading" argument is set, this function finds out what _object_
440  * the ref points at by "reading" the ref.  The ref, if it is not symbolic,
441  * has to exist, and if it is symbolic, it has to point at an existing ref,
442  * because the "read" goes through the symref to the ref it points at.
443  *
444  * The access that is not "reading" may often be "writing", but does not
445  * have to; it can be merely checking _where it leads to_. If it is a
446  * prelude to "writing" to the ref, a write to a symref that points at
447  * yet-to-be-born ref will create the real ref pointed by the symref.
448  * reading=0 allows the caller to check where such a symref leads to.
449  */
450 const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
452         int depth = MAXDEPTH;
453         ssize_t len;
454         char buffer[256];
455         static char ref_buffer[256];
457         if (flag)
458                 *flag = 0;
460         for (;;) {
461                 char path[PATH_MAX];
462                 struct stat st;
463                 char *buf;
464                 int fd;
466                 if (--depth < 0)
467                         return NULL;
469                 git_snpath(path, sizeof(path), "%s", ref);
470                 /* Special case: non-existing file. */
471                 if (lstat(path, &st) < 0) {
472                         struct ref_array *packed = get_packed_refs(NULL);
473                         struct ref_entry *r = search_ref_array(packed, ref);
474                         if (r != NULL) {
475                                 hashcpy(sha1, r->sha1);
476                                 if (flag)
477                                         *flag |= REF_ISPACKED;
478                                 return ref;
479                         }
480                         if (reading || errno != ENOENT)
481                                 return NULL;
482                         hashclr(sha1);
483                         return ref;
484                 }
486                 /* Follow "normalized" - ie "refs/.." symlinks by hand */
487                 if (S_ISLNK(st.st_mode)) {
488                         len = readlink(path, buffer, sizeof(buffer)-1);
489                         if (len >= 5 && !memcmp("refs/", buffer, 5)) {
490                                 buffer[len] = 0;
491                                 strcpy(ref_buffer, buffer);
492                                 ref = ref_buffer;
493                                 if (flag)
494                                         *flag |= REF_ISSYMREF;
495                                 continue;
496                         }
497                 }
499                 /* Is it a directory? */
500                 if (S_ISDIR(st.st_mode)) {
501                         errno = EISDIR;
502                         return NULL;
503                 }
505                 /*
506                  * Anything else, just open it and try to use it as
507                  * a ref
508                  */
509                 fd = open(path, O_RDONLY);
510                 if (fd < 0)
511                         return NULL;
512                 len = read_in_full(fd, buffer, sizeof(buffer)-1);
513                 close(fd);
515                 /*
516                  * Is it a symbolic ref?
517                  */
518                 if (len < 4 || memcmp("ref:", buffer, 4))
519                         break;
520                 buf = buffer + 4;
521                 len -= 4;
522                 while (len && isspace(*buf))
523                         buf++, len--;
524                 while (len && isspace(buf[len-1]))
525                         len--;
526                 buf[len] = 0;
527                 memcpy(ref_buffer, buf, len + 1);
528                 ref = ref_buffer;
529                 if (flag)
530                         *flag |= REF_ISSYMREF;
531         }
532         if (len < 40 || get_sha1_hex(buffer, sha1))
533                 return NULL;
534         return ref;
537 /* The argument to filter_refs */
538 struct ref_filter {
539         const char *pattern;
540         each_ref_fn *fn;
541         void *cb_data;
542 };
544 int read_ref(const char *ref, unsigned char *sha1)
546         if (resolve_ref(ref, sha1, 1, NULL))
547                 return 0;
548         return -1;
551 #define DO_FOR_EACH_INCLUDE_BROKEN 01
552 static int do_one_ref(const char *base, each_ref_fn fn, int trim,
553                       int flags, void *cb_data, struct ref_entry *entry)
555         if (strncmp(base, entry->name, trim))
556                 return 0;
558         if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
559                 if (entry->flag & REF_BROKEN)
560                         return 0; /* ignore dangling symref */
561                 if (!has_sha1_file(entry->sha1)) {
562                         error("%s does not point to a valid object!", entry->name);
563                         return 0;
564                 }
565         }
566         current_ref = entry;
567         return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
570 static int filter_refs(const char *ref, const unsigned char *sha, int flags,
571         void *data)
573         struct ref_filter *filter = (struct ref_filter *)data;
574         if (fnmatch(filter->pattern, ref, 0))
575                 return 0;
576         return filter->fn(ref, sha, flags, filter->cb_data);
579 int peel_ref(const char *ref, unsigned char *sha1)
581         int flag;
582         unsigned char base[20];
583         struct object *o;
585         if (current_ref && (current_ref->name == ref
586                 || !strcmp(current_ref->name, ref))) {
587                 if (current_ref->flag & REF_KNOWS_PEELED) {
588                         hashcpy(sha1, current_ref->peeled);
589                         return 0;
590                 }
591                 hashcpy(base, current_ref->sha1);
592                 goto fallback;
593         }
595         if (!resolve_ref(ref, base, 1, &flag))
596                 return -1;
598         if ((flag & REF_ISPACKED)) {
599                 struct ref_array *array = get_packed_refs(NULL);
600                 struct ref_entry *r = search_ref_array(array, ref);
602                 if (r != NULL && r->flag & REF_KNOWS_PEELED) {
603                         hashcpy(sha1, r->peeled);
604                         return 0;
605                 }
606         }
608 fallback:
609         o = parse_object(base);
610         if (o && o->type == OBJ_TAG) {
611                 o = deref_tag(o, ref, 0);
612                 if (o) {
613                         hashcpy(sha1, o->sha1);
614                         return 0;
615                 }
616         }
617         return -1;
620 static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
621                            int trim, int flags, void *cb_data)
623         int retval = 0, i, p = 0, l = 0;
624         struct ref_array *packed = get_packed_refs(submodule);
625         struct ref_array *loose = get_loose_refs(submodule);
627         struct ref_array *extra = &extra_refs;
629         for (i = 0; i < extra->nr; i++)
630                 retval = do_one_ref(base, fn, trim, flags, cb_data, extra->refs[i]);
632         while (p < packed->nr && l < loose->nr) {
633                 struct ref_entry *entry;
634                 int cmp = strcmp(packed->refs[p]->name, loose->refs[l]->name);
635                 if (!cmp) {
636                         p++;
637                         continue;
638                 }
639                 if (cmp > 0) {
640                         entry = loose->refs[l++];
641                 } else {
642                         entry = packed->refs[p++];
643                 }
644                 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
645                 if (retval)
646                         goto end_each;
647         }
649         if (l < loose->nr) {
650                 p = l;
651                 packed = loose;
652         }
654         for (; p < packed->nr; p++) {
655                 retval = do_one_ref(base, fn, trim, flags, cb_data, packed->refs[p]);
656                 if (retval)
657                         goto end_each;
658         }
660 end_each:
661         current_ref = NULL;
662         return retval;
666 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
668         unsigned char sha1[20];
669         int flag;
671         if (submodule) {
672                 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
673                         return fn("HEAD", sha1, 0, cb_data);
675                 return 0;
676         }
678         if (resolve_ref("HEAD", sha1, 1, &flag))
679                 return fn("HEAD", sha1, flag, cb_data);
681         return 0;
684 int head_ref(each_ref_fn fn, void *cb_data)
686         return do_head_ref(NULL, fn, cb_data);
689 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
691         return do_head_ref(submodule, fn, cb_data);
694 int for_each_ref(each_ref_fn fn, void *cb_data)
696         return do_for_each_ref(NULL, "refs/", fn, 0, 0, cb_data);
699 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
701         return do_for_each_ref(submodule, "refs/", fn, 0, 0, cb_data);
704 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
706         return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
709 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
710                 each_ref_fn fn, void *cb_data)
712         return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
715 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
717         return for_each_ref_in("refs/tags/", fn, cb_data);
720 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
722         return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
725 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
727         return for_each_ref_in("refs/heads/", fn, cb_data);
730 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
732         return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
735 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
737         return for_each_ref_in("refs/remotes/", fn, cb_data);
740 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
742         return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
745 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
747         return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
750 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
751         const char *prefix, void *cb_data)
753         struct strbuf real_pattern = STRBUF_INIT;
754         struct ref_filter filter;
755         int ret;
757         if (!prefix && prefixcmp(pattern, "refs/"))
758                 strbuf_addstr(&real_pattern, "refs/");
759         else if (prefix)
760                 strbuf_addstr(&real_pattern, prefix);
761         strbuf_addstr(&real_pattern, pattern);
763         if (!has_glob_specials(pattern)) {
764                 /* Append implied '/' '*' if not present. */
765                 if (real_pattern.buf[real_pattern.len - 1] != '/')
766                         strbuf_addch(&real_pattern, '/');
767                 /* No need to check for '*', there is none. */
768                 strbuf_addch(&real_pattern, '*');
769         }
771         filter.pattern = real_pattern.buf;
772         filter.fn = fn;
773         filter.cb_data = cb_data;
774         ret = for_each_ref(filter_refs, &filter);
776         strbuf_release(&real_pattern);
777         return ret;
780 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
782         return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
785 int for_each_rawref(each_ref_fn fn, void *cb_data)
787         return do_for_each_ref(NULL, "refs/", fn, 0,
788                                DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
791 /*
792  * Make sure "ref" is something reasonable to have under ".git/refs/";
793  * We do not like it if:
794  *
795  * - any path component of it begins with ".", or
796  * - it has double dots "..", or
797  * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
798  * - it ends with a "/".
799  * - it ends with ".lock"
800  * - it contains a "\" (backslash)
801  */
803 static inline int bad_ref_char(int ch)
805         if (((unsigned) ch) <= ' ' ||
806             ch == '~' || ch == '^' || ch == ':' || ch == '\\')
807                 return 1;
808         /* 2.13 Pattern Matching Notation */
809         if (ch == '?' || ch == '[') /* Unsupported */
810                 return 1;
811         if (ch == '*') /* Supported at the end */
812                 return 2;
813         return 0;
816 int check_ref_format(const char *ref)
818         int ch, level, bad_type, last;
819         int ret = CHECK_REF_FORMAT_OK;
820         const char *cp = ref;
822         level = 0;
823         while (1) {
824                 while ((ch = *cp++) == '/')
825                         ; /* tolerate duplicated slashes */
826                 if (!ch)
827                         /* should not end with slashes */
828                         return CHECK_REF_FORMAT_ERROR;
830                 /* we are at the beginning of the path component */
831                 if (ch == '.')
832                         return CHECK_REF_FORMAT_ERROR;
833                 bad_type = bad_ref_char(ch);
834                 if (bad_type) {
835                         if (bad_type == 2 && (!*cp || *cp == '/') &&
836                             ret == CHECK_REF_FORMAT_OK)
837                                 ret = CHECK_REF_FORMAT_WILDCARD;
838                         else
839                                 return CHECK_REF_FORMAT_ERROR;
840                 }
842                 last = ch;
843                 /* scan the rest of the path component */
844                 while ((ch = *cp++) != 0) {
845                         bad_type = bad_ref_char(ch);
846                         if (bad_type)
847                                 return CHECK_REF_FORMAT_ERROR;
848                         if (ch == '/')
849                                 break;
850                         if (last == '.' && ch == '.')
851                                 return CHECK_REF_FORMAT_ERROR;
852                         if (last == '@' && ch == '{')
853                                 return CHECK_REF_FORMAT_ERROR;
854                         last = ch;
855                 }
856                 level++;
857                 if (!ch) {
858                         if (ref <= cp - 2 && cp[-2] == '.')
859                                 return CHECK_REF_FORMAT_ERROR;
860                         if (level < 2)
861                                 return CHECK_REF_FORMAT_ONELEVEL;
862                         if (has_extension(ref, ".lock"))
863                                 return CHECK_REF_FORMAT_ERROR;
864                         return ret;
865                 }
866         }
869 const char *prettify_refname(const char *name)
871         return name + (
872                 !prefixcmp(name, "refs/heads/") ? 11 :
873                 !prefixcmp(name, "refs/tags/") ? 10 :
874                 !prefixcmp(name, "refs/remotes/") ? 13 :
875                 0);
878 const char *ref_rev_parse_rules[] = {
879         "%.*s",
880         "refs/%.*s",
881         "refs/tags/%.*s",
882         "refs/heads/%.*s",
883         "refs/remotes/%.*s",
884         "refs/remotes/%.*s/HEAD",
885         NULL
886 };
888 const char *ref_fetch_rules[] = {
889         "%.*s",
890         "refs/%.*s",
891         "refs/heads/%.*s",
892         NULL
893 };
895 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
897         const char **p;
898         const int abbrev_name_len = strlen(abbrev_name);
900         for (p = rules; *p; p++) {
901                 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
902                         return 1;
903                 }
904         }
906         return 0;
909 static struct ref_lock *verify_lock(struct ref_lock *lock,
910         const unsigned char *old_sha1, int mustexist)
912         if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
913                 error("Can't verify ref %s", lock->ref_name);
914                 unlock_ref(lock);
915                 return NULL;
916         }
917         if (hashcmp(lock->old_sha1, old_sha1)) {
918                 error("Ref %s is at %s but expected %s", lock->ref_name,
919                         sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
920                 unlock_ref(lock);
921                 return NULL;
922         }
923         return lock;
926 static int remove_empty_directories(const char *file)
928         /* we want to create a file but there is a directory there;
929          * if that is an empty directory (or a directory that contains
930          * only empty directories), remove them.
931          */
932         struct strbuf path;
933         int result;
935         strbuf_init(&path, 20);
936         strbuf_addstr(&path, file);
938         result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
940         strbuf_release(&path);
942         return result;
945 static int is_refname_available(const char *ref, const char *oldref,
946                                 struct ref_array *array, int quiet)
948         int i, namlen = strlen(ref); /* e.g. 'foo/bar' */
949         for (i = 0; i < array->nr; i++ ) {
950                 struct ref_entry *entry = array->refs[i];
951                 /* entry->name could be 'foo' or 'foo/bar/baz' */
952                 if (!oldref || strcmp(oldref, entry->name)) {
953                         int len = strlen(entry->name);
954                         int cmplen = (namlen < len) ? namlen : len;
955                         const char *lead = (namlen < len) ? entry->name : ref;
956                         if (!strncmp(ref, entry->name, cmplen) &&
957                             lead[cmplen] == '/') {
958                                 if (!quiet)
959                                         error("'%s' exists; cannot create '%s'",
960                                               entry->name, ref);
961                                 return 0;
962                         }
963                 }
964         }
965         return 1;
968 static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
970         char *ref_file;
971         const char *orig_ref = ref;
972         struct ref_lock *lock;
973         int last_errno = 0;
974         int type, lflags;
975         int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
976         int missing = 0;
978         lock = xcalloc(1, sizeof(struct ref_lock));
979         lock->lock_fd = -1;
981         ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
982         if (!ref && errno == EISDIR) {
983                 /* we are trying to lock foo but we used to
984                  * have foo/bar which now does not exist;
985                  * it is normal for the empty directory 'foo'
986                  * to remain.
987                  */
988                 ref_file = git_path("%s", orig_ref);
989                 if (remove_empty_directories(ref_file)) {
990                         last_errno = errno;
991                         error("there are still refs under '%s'", orig_ref);
992                         goto error_return;
993                 }
994                 ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
995         }
996         if (type_p)
997             *type_p = type;
998         if (!ref) {
999                 last_errno = errno;
1000                 error("unable to resolve reference %s: %s",
1001                         orig_ref, strerror(errno));
1002                 goto error_return;
1003         }
1004         missing = is_null_sha1(lock->old_sha1);
1005         /* When the ref did not exist and we are creating it,
1006          * make sure there is no existing ref that is packed
1007          * whose name begins with our refname, nor a ref whose
1008          * name is a proper prefix of our refname.
1009          */
1010         if (missing &&
1011              !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1012                 last_errno = ENOTDIR;
1013                 goto error_return;
1014         }
1016         lock->lk = xcalloc(1, sizeof(struct lock_file));
1018         lflags = LOCK_DIE_ON_ERROR;
1019         if (flags & REF_NODEREF) {
1020                 ref = orig_ref;
1021                 lflags |= LOCK_NODEREF;
1022         }
1023         lock->ref_name = xstrdup(ref);
1024         lock->orig_ref_name = xstrdup(orig_ref);
1025         ref_file = git_path("%s", ref);
1026         if (missing)
1027                 lock->force_write = 1;
1028         if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1029                 lock->force_write = 1;
1031         if (safe_create_leading_directories(ref_file)) {
1032                 last_errno = errno;
1033                 error("unable to create directory for %s", ref_file);
1034                 goto error_return;
1035         }
1037         lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1038         return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1040  error_return:
1041         unlock_ref(lock);
1042         errno = last_errno;
1043         return NULL;
1046 struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
1048         char refpath[PATH_MAX];
1049         if (check_ref_format(ref))
1050                 return NULL;
1051         strcpy(refpath, mkpath("refs/%s", ref));
1052         return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1055 struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1057         switch (check_ref_format(ref)) {
1058         default:
1059                 return NULL;
1060         case 0:
1061         case CHECK_REF_FORMAT_ONELEVEL:
1062                 return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
1063         }
1066 static struct lock_file packlock;
1068 static int repack_without_ref(const char *refname)
1070         struct ref_array *packed;
1071         struct ref_entry *ref;
1072         int fd, i;
1074         packed = get_packed_refs(NULL);
1075         ref = search_ref_array(packed, refname);
1076         if (ref == NULL)
1077                 return 0;
1078         fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1079         if (fd < 0) {
1080                 unable_to_lock_error(git_path("packed-refs"), errno);
1081                 return error("cannot delete '%s' from packed refs", refname);
1082         }
1084         for (i = 0; i < packed->nr; i++) {
1085                 char line[PATH_MAX + 100];
1086                 int len;
1088                 ref = packed->refs[i];
1090                 if (!strcmp(refname, ref->name))
1091                         continue;
1092                 len = snprintf(line, sizeof(line), "%s %s\n",
1093                                sha1_to_hex(ref->sha1), ref->name);
1094                 /* this should not happen but just being defensive */
1095                 if (len > sizeof(line))
1096                         die("too long a refname '%s'", ref->name);
1097                 write_or_die(fd, line, len);
1098         }
1099         return commit_lock_file(&packlock);
1102 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1104         struct ref_lock *lock;
1105         int err, i = 0, ret = 0, flag = 0;
1107         lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1108         if (!lock)
1109                 return 1;
1110         if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1111                 /* loose */
1112                 const char *path;
1114                 if (!(delopt & REF_NODEREF)) {
1115                         i = strlen(lock->lk->filename) - 5; /* .lock */
1116                         lock->lk->filename[i] = 0;
1117                         path = lock->lk->filename;
1118                 } else {
1119                         path = git_path("%s", refname);
1120                 }
1121                 err = unlink_or_warn(path);
1122                 if (err && errno != ENOENT)
1123                         ret = 1;
1125                 if (!(delopt & REF_NODEREF))
1126                         lock->lk->filename[i] = '.';
1127         }
1128         /* removing the loose one could have resurrected an earlier
1129          * packed one.  Also, if it was not loose we need to repack
1130          * without it.
1131          */
1132         ret |= repack_without_ref(refname);
1134         unlink_or_warn(git_path("logs/%s", lock->ref_name));
1135         invalidate_cached_refs();
1136         unlock_ref(lock);
1137         return ret;
1140 /*
1141  * People using contrib's git-new-workdir have .git/logs/refs ->
1142  * /some/other/path/.git/logs/refs, and that may live on another device.
1143  *
1144  * IOW, to avoid cross device rename errors, the temporary renamed log must
1145  * live into logs/refs.
1146  */
1147 #define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
1149 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1151         static const char renamed_ref[] = "RENAMED-REF";
1152         unsigned char sha1[20], orig_sha1[20];
1153         int flag = 0, logmoved = 0;
1154         struct ref_lock *lock;
1155         struct stat loginfo;
1156         int log = !lstat(git_path("logs/%s", oldref), &loginfo);
1157         const char *symref = NULL;
1159         if (log && S_ISLNK(loginfo.st_mode))
1160                 return error("reflog for %s is a symlink", oldref);
1162         symref = resolve_ref(oldref, orig_sha1, 1, &flag);
1163         if (flag & REF_ISSYMREF)
1164                 return error("refname %s is a symbolic ref, renaming it is not supported",
1165                         oldref);
1166         if (!symref)
1167                 return error("refname %s not found", oldref);
1169         if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1170                 return 1;
1172         if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1173                 return 1;
1175         lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1176         if (!lock)
1177                 return error("unable to lock %s", renamed_ref);
1178         lock->force_write = 1;
1179         if (write_ref_sha1(lock, orig_sha1, logmsg))
1180                 return error("unable to save current sha1 in %s", renamed_ref);
1182         if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
1183                 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1184                         oldref, strerror(errno));
1186         if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1187                 error("unable to delete old %s", oldref);
1188                 goto rollback;
1189         }
1191         if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1192                 if (errno==EISDIR) {
1193                         if (remove_empty_directories(git_path("%s", newref))) {
1194                                 error("Directory not empty: %s", newref);
1195                                 goto rollback;
1196                         }
1197                 } else {
1198                         error("unable to delete existing %s", newref);
1199                         goto rollback;
1200                 }
1201         }
1203         if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1204                 error("unable to create directory for %s", newref);
1205                 goto rollback;
1206         }
1208  retry:
1209         if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1210                 if (errno==EISDIR || errno==ENOTDIR) {
1211                         /*
1212                          * rename(a, b) when b is an existing
1213                          * directory ought to result in ISDIR, but
1214                          * Solaris 5.8 gives ENOTDIR.  Sheesh.
1215                          */
1216                         if (remove_empty_directories(git_path("logs/%s", newref))) {
1217                                 error("Directory not empty: logs/%s", newref);
1218                                 goto rollback;
1219                         }
1220                         goto retry;
1221                 } else {
1222                         error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1223                                 newref, strerror(errno));
1224                         goto rollback;
1225                 }
1226         }
1227         logmoved = log;
1229         lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1230         if (!lock) {
1231                 error("unable to lock %s for update", newref);
1232                 goto rollback;
1233         }
1234         lock->force_write = 1;
1235         hashcpy(lock->old_sha1, orig_sha1);
1236         if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1237                 error("unable to write current sha1 into %s", newref);
1238                 goto rollback;
1239         }
1241         return 0;
1243  rollback:
1244         lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1245         if (!lock) {
1246                 error("unable to lock %s for rollback", oldref);
1247                 goto rollbacklog;
1248         }
1250         lock->force_write = 1;
1251         flag = log_all_ref_updates;
1252         log_all_ref_updates = 0;
1253         if (write_ref_sha1(lock, orig_sha1, NULL))
1254                 error("unable to write current sha1 into %s", oldref);
1255         log_all_ref_updates = flag;
1257  rollbacklog:
1258         if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1259                 error("unable to restore logfile %s from %s: %s",
1260                         oldref, newref, strerror(errno));
1261         if (!logmoved && log &&
1262             rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
1263                 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1264                         oldref, strerror(errno));
1266         return 1;
1269 int close_ref(struct ref_lock *lock)
1271         if (close_lock_file(lock->lk))
1272                 return -1;
1273         lock->lock_fd = -1;
1274         return 0;
1277 int commit_ref(struct ref_lock *lock)
1279         if (commit_lock_file(lock->lk))
1280                 return -1;
1281         lock->lock_fd = -1;
1282         return 0;
1285 void unlock_ref(struct ref_lock *lock)
1287         /* Do not free lock->lk -- atexit() still looks at them */
1288         if (lock->lk)
1289                 rollback_lock_file(lock->lk);
1290         free(lock->ref_name);
1291         free(lock->orig_ref_name);
1292         free(lock);
1295 /*
1296  * copy the reflog message msg to buf, which has been allocated sufficiently
1297  * large, while cleaning up the whitespaces.  Especially, convert LF to space,
1298  * because reflog file is one line per entry.
1299  */
1300 static int copy_msg(char *buf, const char *msg)
1302         char *cp = buf;
1303         char c;
1304         int wasspace = 1;
1306         *cp++ = '\t';
1307         while ((c = *msg++)) {
1308                 if (wasspace && isspace(c))
1309                         continue;
1310                 wasspace = isspace(c);
1311                 if (wasspace)
1312                         c = ' ';
1313                 *cp++ = c;
1314         }
1315         while (buf < cp && isspace(cp[-1]))
1316                 cp--;
1317         *cp++ = '\n';
1318         return cp - buf;
1321 int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1323         int logfd, oflags = O_APPEND | O_WRONLY;
1325         git_snpath(logfile, bufsize, "logs/%s", ref_name);
1326         if (log_all_ref_updates &&
1327             (!prefixcmp(ref_name, "refs/heads/") ||
1328              !prefixcmp(ref_name, "refs/remotes/") ||
1329              !prefixcmp(ref_name, "refs/notes/") ||
1330              !strcmp(ref_name, "HEAD"))) {
1331                 if (safe_create_leading_directories(logfile) < 0)
1332                         return error("unable to create directory for %s",
1333                                      logfile);
1334                 oflags |= O_CREAT;
1335         }
1337         logfd = open(logfile, oflags, 0666);
1338         if (logfd < 0) {
1339                 if (!(oflags & O_CREAT) && errno == ENOENT)
1340                         return 0;
1342                 if ((oflags & O_CREAT) && errno == EISDIR) {
1343                         if (remove_empty_directories(logfile)) {
1344                                 return error("There are still logs under '%s'",
1345                                              logfile);
1346                         }
1347                         logfd = open(logfile, oflags, 0666);
1348                 }
1350                 if (logfd < 0)
1351                         return error("Unable to append to %s: %s",
1352                                      logfile, strerror(errno));
1353         }
1355         adjust_shared_perm(logfile);
1356         close(logfd);
1357         return 0;
1360 static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1361                          const unsigned char *new_sha1, const char *msg)
1363         int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1364         unsigned maxlen, len;
1365         int msglen;
1366         char log_file[PATH_MAX];
1367         char *logrec;
1368         const char *committer;
1370         if (log_all_ref_updates < 0)
1371                 log_all_ref_updates = !is_bare_repository();
1373         result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1374         if (result)
1375                 return result;
1377         logfd = open(log_file, oflags);
1378         if (logfd < 0)
1379                 return 0;
1380         msglen = msg ? strlen(msg) : 0;
1381         committer = git_committer_info(0);
1382         maxlen = strlen(committer) + msglen + 100;
1383         logrec = xmalloc(maxlen);
1384         len = sprintf(logrec, "%s %s %s\n",
1385                       sha1_to_hex(old_sha1),
1386                       sha1_to_hex(new_sha1),
1387                       committer);
1388         if (msglen)
1389                 len += copy_msg(logrec + len - 1, msg) - 1;
1390         written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1391         free(logrec);
1392         if (close(logfd) != 0 || written != len)
1393                 return error("Unable to append to %s", log_file);
1394         return 0;
1397 static int is_branch(const char *refname)
1399         return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1402 int write_ref_sha1(struct ref_lock *lock,
1403         const unsigned char *sha1, const char *logmsg)
1405         static char term = '\n';
1406         struct object *o;
1408         if (!lock)
1409                 return -1;
1410         if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1411                 unlock_ref(lock);
1412                 return 0;
1413         }
1414         o = parse_object(sha1);
1415         if (!o) {
1416                 error("Trying to write ref %s with nonexistant object %s",
1417                         lock->ref_name, sha1_to_hex(sha1));
1418                 unlock_ref(lock);
1419                 return -1;
1420         }
1421         if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1422                 error("Trying to write non-commit object %s to branch %s",
1423                         sha1_to_hex(sha1), lock->ref_name);
1424                 unlock_ref(lock);
1425                 return -1;
1426         }
1427         if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1428             write_in_full(lock->lock_fd, &term, 1) != 1
1429                 || close_ref(lock) < 0) {
1430                 error("Couldn't write %s", lock->lk->filename);
1431                 unlock_ref(lock);
1432                 return -1;
1433         }
1434         invalidate_cached_refs();
1435         if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1436             (strcmp(lock->ref_name, lock->orig_ref_name) &&
1437              log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1438                 unlock_ref(lock);
1439                 return -1;
1440         }
1441         if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1442                 /*
1443                  * Special hack: If a branch is updated directly and HEAD
1444                  * points to it (may happen on the remote side of a push
1445                  * for example) then logically the HEAD reflog should be
1446                  * updated too.
1447                  * A generic solution implies reverse symref information,
1448                  * but finding all symrefs pointing to the given branch
1449                  * would be rather costly for this rare event (the direct
1450                  * update of a branch) to be worth it.  So let's cheat and
1451                  * check with HEAD only which should cover 99% of all usage
1452                  * scenarios (even 100% of the default ones).
1453                  */
1454                 unsigned char head_sha1[20];
1455                 int head_flag;
1456                 const char *head_ref;
1457                 head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1458                 if (head_ref && (head_flag & REF_ISSYMREF) &&
1459                     !strcmp(head_ref, lock->ref_name))
1460                         log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1461         }
1462         if (commit_ref(lock)) {
1463                 error("Couldn't set %s", lock->ref_name);
1464                 unlock_ref(lock);
1465                 return -1;
1466         }
1467         unlock_ref(lock);
1468         return 0;
1471 int create_symref(const char *ref_target, const char *refs_heads_master,
1472                   const char *logmsg)
1474         const char *lockpath;
1475         char ref[1000];
1476         int fd, len, written;
1477         char *git_HEAD = git_pathdup("%s", ref_target);
1478         unsigned char old_sha1[20], new_sha1[20];
1480         if (logmsg && read_ref(ref_target, old_sha1))
1481                 hashclr(old_sha1);
1483         if (safe_create_leading_directories(git_HEAD) < 0)
1484                 return error("unable to create directory for %s", git_HEAD);
1486 #ifndef NO_SYMLINK_HEAD
1487         if (prefer_symlink_refs) {
1488                 unlink(git_HEAD);
1489                 if (!symlink(refs_heads_master, git_HEAD))
1490                         goto done;
1491                 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1492         }
1493 #endif
1495         len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1496         if (sizeof(ref) <= len) {
1497                 error("refname too long: %s", refs_heads_master);
1498                 goto error_free_return;
1499         }
1500         lockpath = mkpath("%s.lock", git_HEAD);
1501         fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1502         if (fd < 0) {
1503                 error("Unable to open %s for writing", lockpath);
1504                 goto error_free_return;
1505         }
1506         written = write_in_full(fd, ref, len);
1507         if (close(fd) != 0 || written != len) {
1508                 error("Unable to write to %s", lockpath);
1509                 goto error_unlink_return;
1510         }
1511         if (rename(lockpath, git_HEAD) < 0) {
1512                 error("Unable to create %s", git_HEAD);
1513                 goto error_unlink_return;
1514         }
1515         if (adjust_shared_perm(git_HEAD)) {
1516                 error("Unable to fix permissions on %s", lockpath);
1517         error_unlink_return:
1518                 unlink_or_warn(lockpath);
1519         error_free_return:
1520                 free(git_HEAD);
1521                 return -1;
1522         }
1524 #ifndef NO_SYMLINK_HEAD
1525         done:
1526 #endif
1527         if (logmsg && !read_ref(refs_heads_master, new_sha1))
1528                 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1530         free(git_HEAD);
1531         return 0;
1534 static char *ref_msg(const char *line, const char *endp)
1536         const char *ep;
1537         line += 82;
1538         ep = memchr(line, '\n', endp - line);
1539         if (!ep)
1540                 ep = endp;
1541         return xmemdupz(line, ep - line);
1544 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)
1546         const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1547         char *tz_c;
1548         int logfd, tz, reccnt = 0;
1549         struct stat st;
1550         unsigned long date;
1551         unsigned char logged_sha1[20];
1552         void *log_mapped;
1553         size_t mapsz;
1555         logfile = git_path("logs/%s", ref);
1556         logfd = open(logfile, O_RDONLY, 0);
1557         if (logfd < 0)
1558                 die_errno("Unable to read log '%s'", logfile);
1559         fstat(logfd, &st);
1560         if (!st.st_size)
1561                 die("Log %s is empty.", logfile);
1562         mapsz = xsize_t(st.st_size);
1563         log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1564         logdata = log_mapped;
1565         close(logfd);
1567         lastrec = NULL;
1568         rec = logend = logdata + st.st_size;
1569         while (logdata < rec) {
1570                 reccnt++;
1571                 if (logdata < rec && *(rec-1) == '\n')
1572                         rec--;
1573                 lastgt = NULL;
1574                 while (logdata < rec && *(rec-1) != '\n') {
1575                         rec--;
1576                         if (*rec == '>')
1577                                 lastgt = rec;
1578                 }
1579                 if (!lastgt)
1580                         die("Log %s is corrupt.", logfile);
1581                 date = strtoul(lastgt + 1, &tz_c, 10);
1582                 if (date <= at_time || cnt == 0) {
1583                         tz = strtoul(tz_c, NULL, 10);
1584                         if (msg)
1585                                 *msg = ref_msg(rec, logend);
1586                         if (cutoff_time)
1587                                 *cutoff_time = date;
1588                         if (cutoff_tz)
1589                                 *cutoff_tz = tz;
1590                         if (cutoff_cnt)
1591                                 *cutoff_cnt = reccnt - 1;
1592                         if (lastrec) {
1593                                 if (get_sha1_hex(lastrec, logged_sha1))
1594                                         die("Log %s is corrupt.", logfile);
1595                                 if (get_sha1_hex(rec + 41, sha1))
1596                                         die("Log %s is corrupt.", logfile);
1597                                 if (hashcmp(logged_sha1, sha1)) {
1598                                         warning("Log %s has gap after %s.",
1599                                                 logfile, show_date(date, tz, DATE_RFC2822));
1600                                 }
1601                         }
1602                         else if (date == at_time) {
1603                                 if (get_sha1_hex(rec + 41, sha1))
1604                                         die("Log %s is corrupt.", logfile);
1605                         }
1606                         else {
1607                                 if (get_sha1_hex(rec + 41, logged_sha1))
1608                                         die("Log %s is corrupt.", logfile);
1609                                 if (hashcmp(logged_sha1, sha1)) {
1610                                         warning("Log %s unexpectedly ended on %s.",
1611                                                 logfile, show_date(date, tz, DATE_RFC2822));
1612                                 }
1613                         }
1614                         munmap(log_mapped, mapsz);
1615                         return 0;
1616                 }
1617                 lastrec = rec;
1618                 if (cnt > 0)
1619                         cnt--;
1620         }
1622         rec = logdata;
1623         while (rec < logend && *rec != '>' && *rec != '\n')
1624                 rec++;
1625         if (rec == logend || *rec == '\n')
1626                 die("Log %s is corrupt.", logfile);
1627         date = strtoul(rec + 1, &tz_c, 10);
1628         tz = strtoul(tz_c, NULL, 10);
1629         if (get_sha1_hex(logdata, sha1))
1630                 die("Log %s is corrupt.", logfile);
1631         if (is_null_sha1(sha1)) {
1632                 if (get_sha1_hex(logdata + 41, sha1))
1633                         die("Log %s is corrupt.", logfile);
1634         }
1635         if (msg)
1636                 *msg = ref_msg(logdata, logend);
1637         munmap(log_mapped, mapsz);
1639         if (cutoff_time)
1640                 *cutoff_time = date;
1641         if (cutoff_tz)
1642                 *cutoff_tz = tz;
1643         if (cutoff_cnt)
1644                 *cutoff_cnt = reccnt;
1645         return 1;
1648 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1650         const char *logfile;
1651         FILE *logfp;
1652         struct strbuf sb = STRBUF_INIT;
1653         int ret = 0;
1655         logfile = git_path("logs/%s", ref);
1656         logfp = fopen(logfile, "r");
1657         if (!logfp)
1658                 return -1;
1660         if (ofs) {
1661                 struct stat statbuf;
1662                 if (fstat(fileno(logfp), &statbuf) ||
1663                     statbuf.st_size < ofs ||
1664                     fseek(logfp, -ofs, SEEK_END) ||
1665                     strbuf_getwholeline(&sb, logfp, '\n')) {
1666                         fclose(logfp);
1667                         strbuf_release(&sb);
1668                         return -1;
1669                 }
1670         }
1672         while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1673                 unsigned char osha1[20], nsha1[20];
1674                 char *email_end, *message;
1675                 unsigned long timestamp;
1676                 int tz;
1678                 /* old SP new SP name <email> SP time TAB msg LF */
1679                 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1680                     get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1681                     get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1682                     !(email_end = strchr(sb.buf + 82, '>')) ||
1683                     email_end[1] != ' ' ||
1684                     !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1685                     !message || message[0] != ' ' ||
1686                     (message[1] != '+' && message[1] != '-') ||
1687                     !isdigit(message[2]) || !isdigit(message[3]) ||
1688                     !isdigit(message[4]) || !isdigit(message[5]))
1689                         continue; /* corrupt? */
1690                 email_end[1] = '\0';
1691                 tz = strtol(message + 1, NULL, 10);
1692                 if (message[6] != '\t')
1693                         message += 6;
1694                 else
1695                         message += 7;
1696                 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1697                          cb_data);
1698                 if (ret)
1699                         break;
1700         }
1701         fclose(logfp);
1702         strbuf_release(&sb);
1703         return ret;
1706 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1708         return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1711 static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1713         DIR *dir = opendir(git_path("logs/%s", base));
1714         int retval = 0;
1716         if (dir) {
1717                 struct dirent *de;
1718                 int baselen = strlen(base);
1719                 char *log = xmalloc(baselen + 257);
1721                 memcpy(log, base, baselen);
1722                 if (baselen && base[baselen-1] != '/')
1723                         log[baselen++] = '/';
1725                 while ((de = readdir(dir)) != NULL) {
1726                         struct stat st;
1727                         int namelen;
1729                         if (de->d_name[0] == '.')
1730                                 continue;
1731                         namelen = strlen(de->d_name);
1732                         if (namelen > 255)
1733                                 continue;
1734                         if (has_extension(de->d_name, ".lock"))
1735                                 continue;
1736                         memcpy(log + baselen, de->d_name, namelen+1);
1737                         if (stat(git_path("logs/%s", log), &st) < 0)
1738                                 continue;
1739                         if (S_ISDIR(st.st_mode)) {
1740                                 retval = do_for_each_reflog(log, fn, cb_data);
1741                         } else {
1742                                 unsigned char sha1[20];
1743                                 if (!resolve_ref(log, sha1, 0, NULL))
1744                                         retval = error("bad ref for %s", log);
1745                                 else
1746                                         retval = fn(log, sha1, 0, cb_data);
1747                         }
1748                         if (retval)
1749                                 break;
1750                 }
1751                 free(log);
1752                 closedir(dir);
1753         }
1754         else if (*base)
1755                 return errno;
1756         return retval;
1759 int for_each_reflog(each_ref_fn fn, void *cb_data)
1761         return do_for_each_reflog("", fn, cb_data);
1764 int update_ref(const char *action, const char *refname,
1765                 const unsigned char *sha1, const unsigned char *oldval,
1766                 int flags, enum action_on_err onerr)
1768         static struct ref_lock *lock;
1769         lock = lock_any_ref_for_update(refname, oldval, flags);
1770         if (!lock) {
1771                 const char *str = "Cannot lock the ref '%s'.";
1772                 switch (onerr) {
1773                 case MSG_ON_ERR: error(str, refname); break;
1774                 case DIE_ON_ERR: die(str, refname); break;
1775                 case QUIET_ON_ERR: break;
1776                 }
1777                 return 1;
1778         }
1779         if (write_ref_sha1(lock, sha1, action) < 0) {
1780                 const char *str = "Cannot update the ref '%s'.";
1781                 switch (onerr) {
1782                 case MSG_ON_ERR: error(str, refname); break;
1783                 case DIE_ON_ERR: die(str, refname); break;
1784                 case QUIET_ON_ERR: break;
1785                 }
1786                 return 1;
1787         }
1788         return 0;
1791 struct ref *find_ref_by_name(const struct ref *list, const char *name)
1793         for ( ; list; list = list->next)
1794                 if (!strcmp(list->name, name))
1795                         return (struct ref *)list;
1796         return NULL;
1799 /*
1800  * generate a format suitable for scanf from a ref_rev_parse_rules
1801  * rule, that is replace the "%.*s" spec with a "%s" spec
1802  */
1803 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
1805         char *spec;
1807         spec = strstr(rule, "%.*s");
1808         if (!spec || strstr(spec + 4, "%.*s"))
1809                 die("invalid rule in ref_rev_parse_rules: %s", rule);
1811         /* copy all until spec */
1812         strncpy(scanf_fmt, rule, spec - rule);
1813         scanf_fmt[spec - rule] = '\0';
1814         /* copy new spec */
1815         strcat(scanf_fmt, "%s");
1816         /* copy remaining rule */
1817         strcat(scanf_fmt, spec + 4);
1819         return;
1822 char *shorten_unambiguous_ref(const char *ref, int strict)
1824         int i;
1825         static char **scanf_fmts;
1826         static int nr_rules;
1827         char *short_name;
1829         /* pre generate scanf formats from ref_rev_parse_rules[] */
1830         if (!nr_rules) {
1831                 size_t total_len = 0;
1833                 /* the rule list is NULL terminated, count them first */
1834                 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
1835                         /* no +1 because strlen("%s") < strlen("%.*s") */
1836                         total_len += strlen(ref_rev_parse_rules[nr_rules]);
1838                 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
1840                 total_len = 0;
1841                 for (i = 0; i < nr_rules; i++) {
1842                         scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
1843                                         + total_len;
1844                         gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
1845                         total_len += strlen(ref_rev_parse_rules[i]);
1846                 }
1847         }
1849         /* bail out if there are no rules */
1850         if (!nr_rules)
1851                 return xstrdup(ref);
1853         /* buffer for scanf result, at most ref must fit */
1854         short_name = xstrdup(ref);
1856         /* skip first rule, it will always match */
1857         for (i = nr_rules - 1; i > 0 ; --i) {
1858                 int j;
1859                 int rules_to_fail = i;
1860                 int short_name_len;
1862                 if (1 != sscanf(ref, scanf_fmts[i], short_name))
1863                         continue;
1865                 short_name_len = strlen(short_name);
1867                 /*
1868                  * in strict mode, all (except the matched one) rules
1869                  * must fail to resolve to a valid non-ambiguous ref
1870                  */
1871                 if (strict)
1872                         rules_to_fail = nr_rules;
1874                 /*
1875                  * check if the short name resolves to a valid ref,
1876                  * but use only rules prior to the matched one
1877                  */
1878                 for (j = 0; j < rules_to_fail; j++) {
1879                         const char *rule = ref_rev_parse_rules[j];
1880                         unsigned char short_objectname[20];
1881                         char refname[PATH_MAX];
1883                         /* skip matched rule */
1884                         if (i == j)
1885                                 continue;
1887                         /*
1888                          * the short name is ambiguous, if it resolves
1889                          * (with this previous rule) to a valid ref
1890                          * read_ref() returns 0 on success
1891                          */
1892                         mksnpath(refname, sizeof(refname),
1893                                  rule, short_name_len, short_name);
1894                         if (!read_ref(refname, short_objectname))
1895                                 break;
1896                 }
1898                 /*
1899                  * short name is non-ambiguous if all previous rules
1900                  * haven't resolved to a valid ref
1901                  */
1902                 if (j == rules_to_fail)
1903                         return short_name;
1904         }
1906         free(short_name);
1907         return xstrdup(ref);