Code

resolve_ref(): extract a function get_packed_ref()
[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_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];
17 };
19 static const char *parse_ref_line(char *line, unsigned char *sha1)
20 {
21         /*
22          * 42: the answer to everything.
23          *
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)
28          */
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;
45 }
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)
50 {
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;
65 }
67 /* merge sort the ref list */
68 static struct ref_list *sort_ref_list(struct ref_list *list)
69 {
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++;
96                         }
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--;
130                                         }
131                                 }
133                                 e->next = NULL;
135                                 if (l)
136                                         l->next = e;
137                                 if (!new_list)
138                                         new_list = e;
139                                 l = e;
140                         }
142                         p = q;
143                 };
145                 k = k * 2;
146         } while ((last_merge_count != merge_count) || (last_merge_count != 1));
148         return new_list;
151 /*
152  * Future: need to be in "struct repository"
153  * when doing a full libification.
154  */
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);
171         }
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;
204                 }
206                 name = parse_ref_line(refline, sha1);
207                 if (name) {
208                         list = add_ref(name, sha1, flag, list, &last);
209                         continue;
210                 }
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);
217         }
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;
244         }
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);
252                 }
253                 refs->did_packed = 1;
254         }
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;
304                         }
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;
311                                 }
312                         } else
313                                 if (!resolve_ref(ref, sha1, 1, &flag)) {
314                                         hashclr(sha1);
315                                         flag |= REF_BROKEN;
316                                 }
317                         list = add_ref(ref, sha1, flag, list, NULL);
318                 }
319                 free(ref);
320                 closedir(dir);
321         }
322         return sort_ref_list(list);
325 struct warn_if_dangling_data {
326         FILE *fp;
327         const char *refname;
328         const char *msg_fmt;
329 };
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;
365         }
367         if (!cached_refs.did_loose) {
368                 cached_refs.loose = get_ref_dir(NULL, "refs", NULL);
369                 cached_refs.did_loose = 1;
370         }
371         return cached_refs.loose;
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;
398                 }
399                 ref = ref->next;
400         }
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);
460         }
461         gitdir[len] = '/';
462         gitdir[++len] = '\0';
463         retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
464         free(gitdir);
465         return retval;
468 /*
469  * Try to read ref from the packed references.  On success, set sha1
470  * and return 0; otherwise, return -1.
471  */
472 static int get_packed_ref(const char *ref, unsigned char *sha1)
474         struct ref_list *list = get_packed_refs(NULL);
475         while (list) {
476                 if (!strcmp(ref, list->name)) {
477                         hashcpy(sha1, list->sha1);
478                         return 0;
479                 }
480                 list = list->next;
481         }
482         return -1;
485 /*
486  * If the "reading" argument is set, this function finds out what _object_
487  * the ref points at by "reading" the ref.  The ref, if it is not symbolic,
488  * has to exist, and if it is symbolic, it has to point at an existing ref,
489  * because the "read" goes through the symref to the ref it points at.
490  *
491  * The access that is not "reading" may often be "writing", but does not
492  * have to; it can be merely checking _where it leads to_. If it is a
493  * prelude to "writing" to the ref, a write to a symref that points at
494  * yet-to-be-born ref will create the real ref pointed by the symref.
495  * reading=0 allows the caller to check where such a symref leads to.
496  */
497 const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
499         int depth = MAXDEPTH;
500         ssize_t len;
501         char buffer[256];
502         static char ref_buffer[256];
504         if (flag)
505                 *flag = 0;
507         for (;;) {
508                 char path[PATH_MAX];
509                 struct stat st;
510                 char *buf;
511                 int fd;
513                 if (--depth < 0)
514                         return NULL;
516                 git_snpath(path, sizeof(path), "%s", ref);
518                 if (lstat(path, &st) < 0) {
519                         if (errno != ENOENT)
520                                 return NULL;
521                         /*
522                          * The loose reference file does not exist;
523                          * check for a packed reference.
524                          */
525                         if (!get_packed_ref(ref, sha1)) {
526                                 if (flag)
527                                         *flag |= REF_ISPACKED;
528                                 return ref;
529                         }
530                         /* The reference is not a packed reference, either. */
531                         if (reading) {
532                                 return NULL;
533                         } else {
534                                 hashclr(sha1);
535                                 return ref;
536                         }
537                 }
539                 /* Follow "normalized" - ie "refs/.." symlinks by hand */
540                 if (S_ISLNK(st.st_mode)) {
541                         len = readlink(path, buffer, sizeof(buffer)-1);
542                         if (len < 0)
543                                 return NULL;
544                         buffer[len] = 0;
545                         if (!prefixcmp(buffer, "refs/") &&
546                                         !check_refname_format(buffer, 0)) {
547                                 strcpy(ref_buffer, buffer);
548                                 ref = ref_buffer;
549                                 if (flag)
550                                         *flag |= REF_ISSYMREF;
551                                 continue;
552                         }
553                 }
555                 /* Is it a directory? */
556                 if (S_ISDIR(st.st_mode)) {
557                         errno = EISDIR;
558                         return NULL;
559                 }
561                 /*
562                  * Anything else, just open it and try to use it as
563                  * a ref
564                  */
565                 fd = open(path, O_RDONLY);
566                 if (fd < 0)
567                         return NULL;
568                 len = read_in_full(fd, buffer, sizeof(buffer)-1);
569                 close(fd);
570                 if (len < 0)
571                         return NULL;
572                 while (len && isspace(buffer[len-1]))
573                         len--;
574                 buffer[len] = '\0';
576                 /*
577                  * Is it a symbolic ref?
578                  */
579                 if (prefixcmp(buffer, "ref:"))
580                         break;
581                 buf = buffer + 4;
582                 while (isspace(*buf))
583                         buf++;
584                 ref = strcpy(ref_buffer, buf);
585                 if (flag)
586                         *flag |= REF_ISSYMREF;
587         }
588         if (get_sha1_hex(buffer, sha1))
589                 return NULL;
590         return ref;
593 /* The argument to filter_refs */
594 struct ref_filter {
595         const char *pattern;
596         each_ref_fn *fn;
597         void *cb_data;
598 };
600 int read_ref(const char *ref, unsigned char *sha1)
602         if (resolve_ref(ref, sha1, 1, NULL))
603                 return 0;
604         return -1;
607 #define DO_FOR_EACH_INCLUDE_BROKEN 01
608 static int do_one_ref(const char *base, each_ref_fn fn, int trim,
609                       int flags, void *cb_data, struct ref_list *entry)
611         if (prefixcmp(entry->name, base))
612                 return 0;
614         if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
615                 if (entry->flag & REF_BROKEN)
616                         return 0; /* ignore dangling symref */
617                 if (!has_sha1_file(entry->sha1)) {
618                         error("%s does not point to a valid object!", entry->name);
619                         return 0;
620                 }
621         }
622         current_ref = entry;
623         return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
626 static int filter_refs(const char *ref, const unsigned char *sha, int flags,
627         void *data)
629         struct ref_filter *filter = (struct ref_filter *)data;
630         if (fnmatch(filter->pattern, ref, 0))
631                 return 0;
632         return filter->fn(ref, sha, flags, filter->cb_data);
635 int peel_ref(const char *ref, unsigned char *sha1)
637         int flag;
638         unsigned char base[20];
639         struct object *o;
641         if (current_ref && (current_ref->name == ref
642                 || !strcmp(current_ref->name, ref))) {
643                 if (current_ref->flag & REF_KNOWS_PEELED) {
644                         hashcpy(sha1, current_ref->peeled);
645                         return 0;
646                 }
647                 hashcpy(base, current_ref->sha1);
648                 goto fallback;
649         }
651         if (!resolve_ref(ref, base, 1, &flag))
652                 return -1;
654         if ((flag & REF_ISPACKED)) {
655                 struct ref_list *list = get_packed_refs(NULL);
657                 while (list) {
658                         if (!strcmp(list->name, ref)) {
659                                 if (list->flag & REF_KNOWS_PEELED) {
660                                         hashcpy(sha1, list->peeled);
661                                         return 0;
662                                 }
663                                 /* older pack-refs did not leave peeled ones */
664                                 break;
665                         }
666                         list = list->next;
667                 }
668         }
670 fallback:
671         o = parse_object(base);
672         if (o && o->type == OBJ_TAG) {
673                 o = deref_tag(o, ref, 0);
674                 if (o) {
675                         hashcpy(sha1, o->sha1);
676                         return 0;
677                 }
678         }
679         return -1;
682 static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
683                            int trim, int flags, void *cb_data)
685         int retval = 0;
686         struct ref_list *packed = get_packed_refs(submodule);
687         struct ref_list *loose = get_loose_refs(submodule);
689         struct ref_list *extra;
691         for (extra = extra_refs; extra; extra = extra->next)
692                 retval = do_one_ref(base, fn, trim, flags, cb_data, extra);
694         while (packed && loose) {
695                 struct ref_list *entry;
696                 int cmp = strcmp(packed->name, loose->name);
697                 if (!cmp) {
698                         packed = packed->next;
699                         continue;
700                 }
701                 if (cmp > 0) {
702                         entry = loose;
703                         loose = loose->next;
704                 } else {
705                         entry = packed;
706                         packed = packed->next;
707                 }
708                 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
709                 if (retval)
710                         goto end_each;
711         }
713         for (packed = packed ? packed : loose; packed; packed = packed->next) {
714                 retval = do_one_ref(base, fn, trim, flags, cb_data, packed);
715                 if (retval)
716                         goto end_each;
717         }
719 end_each:
720         current_ref = NULL;
721         return retval;
725 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
727         unsigned char sha1[20];
728         int flag;
730         if (submodule) {
731                 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
732                         return fn("HEAD", sha1, 0, cb_data);
734                 return 0;
735         }
737         if (resolve_ref("HEAD", sha1, 1, &flag))
738                 return fn("HEAD", sha1, flag, cb_data);
740         return 0;
743 int head_ref(each_ref_fn fn, void *cb_data)
745         return do_head_ref(NULL, fn, cb_data);
748 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
750         return do_head_ref(submodule, fn, cb_data);
753 int for_each_ref(each_ref_fn fn, void *cb_data)
755         return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
758 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
760         return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
763 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
765         return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
768 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
769                 each_ref_fn fn, void *cb_data)
771         return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
774 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
776         return for_each_ref_in("refs/tags/", fn, cb_data);
779 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
781         return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
784 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
786         return for_each_ref_in("refs/heads/", fn, cb_data);
789 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
791         return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
794 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
796         return for_each_ref_in("refs/remotes/", fn, cb_data);
799 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
801         return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
804 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
806         return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
809 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
811         struct strbuf buf = STRBUF_INIT;
812         int ret = 0;
813         unsigned char sha1[20];
814         int flag;
816         strbuf_addf(&buf, "%sHEAD", get_git_namespace());
817         if (resolve_ref(buf.buf, sha1, 1, &flag))
818                 ret = fn(buf.buf, sha1, flag, cb_data);
819         strbuf_release(&buf);
821         return ret;
824 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
826         struct strbuf buf = STRBUF_INIT;
827         int ret;
828         strbuf_addf(&buf, "%srefs/", get_git_namespace());
829         ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
830         strbuf_release(&buf);
831         return ret;
834 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
835         const char *prefix, void *cb_data)
837         struct strbuf real_pattern = STRBUF_INIT;
838         struct ref_filter filter;
839         int ret;
841         if (!prefix && prefixcmp(pattern, "refs/"))
842                 strbuf_addstr(&real_pattern, "refs/");
843         else if (prefix)
844                 strbuf_addstr(&real_pattern, prefix);
845         strbuf_addstr(&real_pattern, pattern);
847         if (!has_glob_specials(pattern)) {
848                 /* Append implied '/' '*' if not present. */
849                 if (real_pattern.buf[real_pattern.len - 1] != '/')
850                         strbuf_addch(&real_pattern, '/');
851                 /* No need to check for '*', there is none. */
852                 strbuf_addch(&real_pattern, '*');
853         }
855         filter.pattern = real_pattern.buf;
856         filter.fn = fn;
857         filter.cb_data = cb_data;
858         ret = for_each_ref(filter_refs, &filter);
860         strbuf_release(&real_pattern);
861         return ret;
864 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
866         return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
869 int for_each_rawref(each_ref_fn fn, void *cb_data)
871         return do_for_each_ref(NULL, "", fn, 0,
872                                DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
875 /*
876  * Make sure "ref" is something reasonable to have under ".git/refs/";
877  * We do not like it if:
878  *
879  * - any path component of it begins with ".", or
880  * - it has double dots "..", or
881  * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
882  * - it ends with a "/".
883  * - it ends with ".lock"
884  * - it contains a "\" (backslash)
885  */
887 /* Return true iff ch is not allowed in reference names. */
888 static inline int bad_ref_char(int ch)
890         if (((unsigned) ch) <= ' ' || ch == 0x7f ||
891             ch == '~' || ch == '^' || ch == ':' || ch == '\\')
892                 return 1;
893         /* 2.13 Pattern Matching Notation */
894         if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
895                 return 1;
896         return 0;
899 /*
900  * Try to read one refname component from the front of ref.  Return
901  * the length of the component found, or -1 if the component is not
902  * legal.
903  */
904 static int check_refname_component(const char *ref)
906         const char *cp;
907         char last = '\0';
909         for (cp = ref; ; cp++) {
910                 char ch = *cp;
911                 if (ch == '\0' || ch == '/')
912                         break;
913                 if (bad_ref_char(ch))
914                         return -1; /* Illegal character in refname. */
915                 if (last == '.' && ch == '.')
916                         return -1; /* Refname contains "..". */
917                 if (last == '@' && ch == '{')
918                         return -1; /* Refname contains "@{". */
919                 last = ch;
920         }
921         if (cp == ref)
922                 return -1; /* Component has zero length. */
923         if (ref[0] == '.')
924                 return -1; /* Component starts with '.'. */
925         if (cp - ref >= 5 && !memcmp(cp - 5, ".lock", 5))
926                 return -1; /* Refname ends with ".lock". */
927         return cp - ref;
930 int check_refname_format(const char *ref, int flags)
932         int component_len, component_count = 0;
934         while (1) {
935                 /* We are at the start of a path component. */
936                 component_len = check_refname_component(ref);
937                 if (component_len < 0) {
938                         if ((flags & REFNAME_REFSPEC_PATTERN) &&
939                                         ref[0] == '*' &&
940                                         (ref[1] == '\0' || ref[1] == '/')) {
941                                 /* Accept one wildcard as a full refname component. */
942                                 flags &= ~REFNAME_REFSPEC_PATTERN;
943                                 component_len = 1;
944                         } else {
945                                 return -1;
946                         }
947                 }
948                 component_count++;
949                 if (ref[component_len] == '\0')
950                         break;
951                 /* Skip to next component. */
952                 ref += component_len + 1;
953         }
955         if (ref[component_len - 1] == '.')
956                 return -1; /* Refname ends with '.'. */
957         if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
958                 return -1; /* Refname has only one component. */
959         return 0;
962 const char *prettify_refname(const char *name)
964         return name + (
965                 !prefixcmp(name, "refs/heads/") ? 11 :
966                 !prefixcmp(name, "refs/tags/") ? 10 :
967                 !prefixcmp(name, "refs/remotes/") ? 13 :
968                 0);
971 const char *ref_rev_parse_rules[] = {
972         "%.*s",
973         "refs/%.*s",
974         "refs/tags/%.*s",
975         "refs/heads/%.*s",
976         "refs/remotes/%.*s",
977         "refs/remotes/%.*s/HEAD",
978         NULL
979 };
981 const char *ref_fetch_rules[] = {
982         "%.*s",
983         "refs/%.*s",
984         "refs/heads/%.*s",
985         NULL
986 };
988 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
990         const char **p;
991         const int abbrev_name_len = strlen(abbrev_name);
993         for (p = rules; *p; p++) {
994                 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
995                         return 1;
996                 }
997         }
999         return 0;
1002 static struct ref_lock *verify_lock(struct ref_lock *lock,
1003         const unsigned char *old_sha1, int mustexist)
1005         if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1006                 error("Can't verify ref %s", lock->ref_name);
1007                 unlock_ref(lock);
1008                 return NULL;
1009         }
1010         if (hashcmp(lock->old_sha1, old_sha1)) {
1011                 error("Ref %s is at %s but expected %s", lock->ref_name,
1012                         sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1013                 unlock_ref(lock);
1014                 return NULL;
1015         }
1016         return lock;
1019 static int remove_empty_directories(const char *file)
1021         /* we want to create a file but there is a directory there;
1022          * if that is an empty directory (or a directory that contains
1023          * only empty directories), remove them.
1024          */
1025         struct strbuf path;
1026         int result;
1028         strbuf_init(&path, 20);
1029         strbuf_addstr(&path, file);
1031         result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1033         strbuf_release(&path);
1035         return result;
1038 static int is_refname_available(const char *ref, const char *oldref,
1039                                 struct ref_list *list, int quiet)
1041         int namlen = strlen(ref); /* e.g. 'foo/bar' */
1042         while (list) {
1043                 /* list->name could be 'foo' or 'foo/bar/baz' */
1044                 if (!oldref || strcmp(oldref, list->name)) {
1045                         int len = strlen(list->name);
1046                         int cmplen = (namlen < len) ? namlen : len;
1047                         const char *lead = (namlen < len) ? list->name : ref;
1048                         if (!strncmp(ref, list->name, cmplen) &&
1049                             lead[cmplen] == '/') {
1050                                 if (!quiet)
1051                                         error("'%s' exists; cannot create '%s'",
1052                                               list->name, ref);
1053                                 return 0;
1054                         }
1055                 }
1056                 list = list->next;
1057         }
1058         return 1;
1061 static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
1063         char *ref_file;
1064         const char *orig_ref = ref;
1065         struct ref_lock *lock;
1066         int last_errno = 0;
1067         int type, lflags;
1068         int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1069         int missing = 0;
1071         lock = xcalloc(1, sizeof(struct ref_lock));
1072         lock->lock_fd = -1;
1074         ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
1075         if (!ref && errno == EISDIR) {
1076                 /* we are trying to lock foo but we used to
1077                  * have foo/bar which now does not exist;
1078                  * it is normal for the empty directory 'foo'
1079                  * to remain.
1080                  */
1081                 ref_file = git_path("%s", orig_ref);
1082                 if (remove_empty_directories(ref_file)) {
1083                         last_errno = errno;
1084                         error("there are still refs under '%s'", orig_ref);
1085                         goto error_return;
1086                 }
1087                 ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
1088         }
1089         if (type_p)
1090             *type_p = type;
1091         if (!ref) {
1092                 last_errno = errno;
1093                 error("unable to resolve reference %s: %s",
1094                         orig_ref, strerror(errno));
1095                 goto error_return;
1096         }
1097         missing = is_null_sha1(lock->old_sha1);
1098         /* When the ref did not exist and we are creating it,
1099          * make sure there is no existing ref that is packed
1100          * whose name begins with our refname, nor a ref whose
1101          * name is a proper prefix of our refname.
1102          */
1103         if (missing &&
1104              !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
1105                 last_errno = ENOTDIR;
1106                 goto error_return;
1107         }
1109         lock->lk = xcalloc(1, sizeof(struct lock_file));
1111         lflags = LOCK_DIE_ON_ERROR;
1112         if (flags & REF_NODEREF) {
1113                 ref = orig_ref;
1114                 lflags |= LOCK_NODEREF;
1115         }
1116         lock->ref_name = xstrdup(ref);
1117         lock->orig_ref_name = xstrdup(orig_ref);
1118         ref_file = git_path("%s", ref);
1119         if (missing)
1120                 lock->force_write = 1;
1121         if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1122                 lock->force_write = 1;
1124         if (safe_create_leading_directories(ref_file)) {
1125                 last_errno = errno;
1126                 error("unable to create directory for %s", ref_file);
1127                 goto error_return;
1128         }
1130         lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1131         return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1133  error_return:
1134         unlock_ref(lock);
1135         errno = last_errno;
1136         return NULL;
1139 struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
1141         char refpath[PATH_MAX];
1142         if (check_refname_format(ref, 0))
1143                 return NULL;
1144         strcpy(refpath, mkpath("refs/%s", ref));
1145         return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1148 struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
1150         if (check_refname_format(ref, REFNAME_ALLOW_ONELEVEL))
1151                 return NULL;
1152         return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
1155 static struct lock_file packlock;
1157 static int repack_without_ref(const char *refname)
1159         struct ref_list *list, *packed_ref_list;
1160         int fd;
1161         int found = 0;
1163         packed_ref_list = get_packed_refs(NULL);
1164         for (list = packed_ref_list; list; list = list->next) {
1165                 if (!strcmp(refname, list->name)) {
1166                         found = 1;
1167                         break;
1168                 }
1169         }
1170         if (!found)
1171                 return 0;
1172         fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1173         if (fd < 0) {
1174                 unable_to_lock_error(git_path("packed-refs"), errno);
1175                 return error("cannot delete '%s' from packed refs", refname);
1176         }
1178         for (list = packed_ref_list; list; list = list->next) {
1179                 char line[PATH_MAX + 100];
1180                 int len;
1182                 if (!strcmp(refname, list->name))
1183                         continue;
1184                 len = snprintf(line, sizeof(line), "%s %s\n",
1185                                sha1_to_hex(list->sha1), list->name);
1186                 /* this should not happen but just being defensive */
1187                 if (len > sizeof(line))
1188                         die("too long a refname '%s'", list->name);
1189                 write_or_die(fd, line, len);
1190         }
1191         return commit_lock_file(&packlock);
1194 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1196         struct ref_lock *lock;
1197         int err, i = 0, ret = 0, flag = 0;
1199         lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1200         if (!lock)
1201                 return 1;
1202         if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1203                 /* loose */
1204                 const char *path;
1206                 if (!(delopt & REF_NODEREF)) {
1207                         i = strlen(lock->lk->filename) - 5; /* .lock */
1208                         lock->lk->filename[i] = 0;
1209                         path = lock->lk->filename;
1210                 } else {
1211                         path = git_path("%s", refname);
1212                 }
1213                 err = unlink_or_warn(path);
1214                 if (err && errno != ENOENT)
1215                         ret = 1;
1217                 if (!(delopt & REF_NODEREF))
1218                         lock->lk->filename[i] = '.';
1219         }
1220         /* removing the loose one could have resurrected an earlier
1221          * packed one.  Also, if it was not loose we need to repack
1222          * without it.
1223          */
1224         ret |= repack_without_ref(refname);
1226         unlink_or_warn(git_path("logs/%s", lock->ref_name));
1227         invalidate_cached_refs();
1228         unlock_ref(lock);
1229         return ret;
1232 /*
1233  * People using contrib's git-new-workdir have .git/logs/refs ->
1234  * /some/other/path/.git/logs/refs, and that may live on another device.
1235  *
1236  * IOW, to avoid cross device rename errors, the temporary renamed log must
1237  * live into logs/refs.
1238  */
1239 #define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
1241 int rename_ref(const char *oldref, const char *newref, const char *logmsg)
1243         static const char renamed_ref[] = "RENAMED-REF";
1244         unsigned char sha1[20], orig_sha1[20];
1245         int flag = 0, logmoved = 0;
1246         struct ref_lock *lock;
1247         struct stat loginfo;
1248         int log = !lstat(git_path("logs/%s", oldref), &loginfo);
1249         const char *symref = NULL;
1251         if (log && S_ISLNK(loginfo.st_mode))
1252                 return error("reflog for %s is a symlink", oldref);
1254         symref = resolve_ref(oldref, orig_sha1, 1, &flag);
1255         if (flag & REF_ISSYMREF)
1256                 return error("refname %s is a symbolic ref, renaming it is not supported",
1257                         oldref);
1258         if (!symref)
1259                 return error("refname %s not found", oldref);
1261         if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
1262                 return 1;
1264         if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
1265                 return 1;
1267         lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
1268         if (!lock)
1269                 return error("unable to lock %s", renamed_ref);
1270         lock->force_write = 1;
1271         if (write_ref_sha1(lock, orig_sha1, logmsg))
1272                 return error("unable to save current sha1 in %s", renamed_ref);
1274         if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
1275                 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1276                         oldref, strerror(errno));
1278         if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
1279                 error("unable to delete old %s", oldref);
1280                 goto rollback;
1281         }
1283         if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
1284                 if (errno==EISDIR) {
1285                         if (remove_empty_directories(git_path("%s", newref))) {
1286                                 error("Directory not empty: %s", newref);
1287                                 goto rollback;
1288                         }
1289                 } else {
1290                         error("unable to delete existing %s", newref);
1291                         goto rollback;
1292                 }
1293         }
1295         if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1296                 error("unable to create directory for %s", newref);
1297                 goto rollback;
1298         }
1300  retry:
1301         if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
1302                 if (errno==EISDIR || errno==ENOTDIR) {
1303                         /*
1304                          * rename(a, b) when b is an existing
1305                          * directory ought to result in ISDIR, but
1306                          * Solaris 5.8 gives ENOTDIR.  Sheesh.
1307                          */
1308                         if (remove_empty_directories(git_path("logs/%s", newref))) {
1309                                 error("Directory not empty: logs/%s", newref);
1310                                 goto rollback;
1311                         }
1312                         goto retry;
1313                 } else {
1314                         error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1315                                 newref, strerror(errno));
1316                         goto rollback;
1317                 }
1318         }
1319         logmoved = log;
1321         lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
1322         if (!lock) {
1323                 error("unable to lock %s for update", newref);
1324                 goto rollback;
1325         }
1326         lock->force_write = 1;
1327         hashcpy(lock->old_sha1, orig_sha1);
1328         if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1329                 error("unable to write current sha1 into %s", newref);
1330                 goto rollback;
1331         }
1333         return 0;
1335  rollback:
1336         lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
1337         if (!lock) {
1338                 error("unable to lock %s for rollback", oldref);
1339                 goto rollbacklog;
1340         }
1342         lock->force_write = 1;
1343         flag = log_all_ref_updates;
1344         log_all_ref_updates = 0;
1345         if (write_ref_sha1(lock, orig_sha1, NULL))
1346                 error("unable to write current sha1 into %s", oldref);
1347         log_all_ref_updates = flag;
1349  rollbacklog:
1350         if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1351                 error("unable to restore logfile %s from %s: %s",
1352                         oldref, newref, strerror(errno));
1353         if (!logmoved && log &&
1354             rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
1355                 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1356                         oldref, strerror(errno));
1358         return 1;
1361 int close_ref(struct ref_lock *lock)
1363         if (close_lock_file(lock->lk))
1364                 return -1;
1365         lock->lock_fd = -1;
1366         return 0;
1369 int commit_ref(struct ref_lock *lock)
1371         if (commit_lock_file(lock->lk))
1372                 return -1;
1373         lock->lock_fd = -1;
1374         return 0;
1377 void unlock_ref(struct ref_lock *lock)
1379         /* Do not free lock->lk -- atexit() still looks at them */
1380         if (lock->lk)
1381                 rollback_lock_file(lock->lk);
1382         free(lock->ref_name);
1383         free(lock->orig_ref_name);
1384         free(lock);
1387 /*
1388  * copy the reflog message msg to buf, which has been allocated sufficiently
1389  * large, while cleaning up the whitespaces.  Especially, convert LF to space,
1390  * because reflog file is one line per entry.
1391  */
1392 static int copy_msg(char *buf, const char *msg)
1394         char *cp = buf;
1395         char c;
1396         int wasspace = 1;
1398         *cp++ = '\t';
1399         while ((c = *msg++)) {
1400                 if (wasspace && isspace(c))
1401                         continue;
1402                 wasspace = isspace(c);
1403                 if (wasspace)
1404                         c = ' ';
1405                 *cp++ = c;
1406         }
1407         while (buf < cp && isspace(cp[-1]))
1408                 cp--;
1409         *cp++ = '\n';
1410         return cp - buf;
1413 int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
1415         int logfd, oflags = O_APPEND | O_WRONLY;
1417         git_snpath(logfile, bufsize, "logs/%s", ref_name);
1418         if (log_all_ref_updates &&
1419             (!prefixcmp(ref_name, "refs/heads/") ||
1420              !prefixcmp(ref_name, "refs/remotes/") ||
1421              !prefixcmp(ref_name, "refs/notes/") ||
1422              !strcmp(ref_name, "HEAD"))) {
1423                 if (safe_create_leading_directories(logfile) < 0)
1424                         return error("unable to create directory for %s",
1425                                      logfile);
1426                 oflags |= O_CREAT;
1427         }
1429         logfd = open(logfile, oflags, 0666);
1430         if (logfd < 0) {
1431                 if (!(oflags & O_CREAT) && errno == ENOENT)
1432                         return 0;
1434                 if ((oflags & O_CREAT) && errno == EISDIR) {
1435                         if (remove_empty_directories(logfile)) {
1436                                 return error("There are still logs under '%s'",
1437                                              logfile);
1438                         }
1439                         logfd = open(logfile, oflags, 0666);
1440                 }
1442                 if (logfd < 0)
1443                         return error("Unable to append to %s: %s",
1444                                      logfile, strerror(errno));
1445         }
1447         adjust_shared_perm(logfile);
1448         close(logfd);
1449         return 0;
1452 static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1453                          const unsigned char *new_sha1, const char *msg)
1455         int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1456         unsigned maxlen, len;
1457         int msglen;
1458         char log_file[PATH_MAX];
1459         char *logrec;
1460         const char *committer;
1462         if (log_all_ref_updates < 0)
1463                 log_all_ref_updates = !is_bare_repository();
1465         result = log_ref_setup(ref_name, log_file, sizeof(log_file));
1466         if (result)
1467                 return result;
1469         logfd = open(log_file, oflags);
1470         if (logfd < 0)
1471                 return 0;
1472         msglen = msg ? strlen(msg) : 0;
1473         committer = git_committer_info(0);
1474         maxlen = strlen(committer) + msglen + 100;
1475         logrec = xmalloc(maxlen);
1476         len = sprintf(logrec, "%s %s %s\n",
1477                       sha1_to_hex(old_sha1),
1478                       sha1_to_hex(new_sha1),
1479                       committer);
1480         if (msglen)
1481                 len += copy_msg(logrec + len - 1, msg) - 1;
1482         written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1483         free(logrec);
1484         if (close(logfd) != 0 || written != len)
1485                 return error("Unable to append to %s", log_file);
1486         return 0;
1489 static int is_branch(const char *refname)
1491         return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1494 int write_ref_sha1(struct ref_lock *lock,
1495         const unsigned char *sha1, const char *logmsg)
1497         static char term = '\n';
1498         struct object *o;
1500         if (!lock)
1501                 return -1;
1502         if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1503                 unlock_ref(lock);
1504                 return 0;
1505         }
1506         o = parse_object(sha1);
1507         if (!o) {
1508                 error("Trying to write ref %s with nonexistent object %s",
1509                         lock->ref_name, sha1_to_hex(sha1));
1510                 unlock_ref(lock);
1511                 return -1;
1512         }
1513         if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1514                 error("Trying to write non-commit object %s to branch %s",
1515                         sha1_to_hex(sha1), lock->ref_name);
1516                 unlock_ref(lock);
1517                 return -1;
1518         }
1519         if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1520             write_in_full(lock->lock_fd, &term, 1) != 1
1521                 || close_ref(lock) < 0) {
1522                 error("Couldn't write %s", lock->lk->filename);
1523                 unlock_ref(lock);
1524                 return -1;
1525         }
1526         invalidate_cached_refs();
1527         if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1528             (strcmp(lock->ref_name, lock->orig_ref_name) &&
1529              log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1530                 unlock_ref(lock);
1531                 return -1;
1532         }
1533         if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1534                 /*
1535                  * Special hack: If a branch is updated directly and HEAD
1536                  * points to it (may happen on the remote side of a push
1537                  * for example) then logically the HEAD reflog should be
1538                  * updated too.
1539                  * A generic solution implies reverse symref information,
1540                  * but finding all symrefs pointing to the given branch
1541                  * would be rather costly for this rare event (the direct
1542                  * update of a branch) to be worth it.  So let's cheat and
1543                  * check with HEAD only which should cover 99% of all usage
1544                  * scenarios (even 100% of the default ones).
1545                  */
1546                 unsigned char head_sha1[20];
1547                 int head_flag;
1548                 const char *head_ref;
1549                 head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1550                 if (head_ref && (head_flag & REF_ISSYMREF) &&
1551                     !strcmp(head_ref, lock->ref_name))
1552                         log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1553         }
1554         if (commit_ref(lock)) {
1555                 error("Couldn't set %s", lock->ref_name);
1556                 unlock_ref(lock);
1557                 return -1;
1558         }
1559         unlock_ref(lock);
1560         return 0;
1563 int create_symref(const char *ref_target, const char *refs_heads_master,
1564                   const char *logmsg)
1566         const char *lockpath;
1567         char ref[1000];
1568         int fd, len, written;
1569         char *git_HEAD = git_pathdup("%s", ref_target);
1570         unsigned char old_sha1[20], new_sha1[20];
1572         if (logmsg && read_ref(ref_target, old_sha1))
1573                 hashclr(old_sha1);
1575         if (safe_create_leading_directories(git_HEAD) < 0)
1576                 return error("unable to create directory for %s", git_HEAD);
1578 #ifndef NO_SYMLINK_HEAD
1579         if (prefer_symlink_refs) {
1580                 unlink(git_HEAD);
1581                 if (!symlink(refs_heads_master, git_HEAD))
1582                         goto done;
1583                 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1584         }
1585 #endif
1587         len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1588         if (sizeof(ref) <= len) {
1589                 error("refname too long: %s", refs_heads_master);
1590                 goto error_free_return;
1591         }
1592         lockpath = mkpath("%s.lock", git_HEAD);
1593         fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1594         if (fd < 0) {
1595                 error("Unable to open %s for writing", lockpath);
1596                 goto error_free_return;
1597         }
1598         written = write_in_full(fd, ref, len);
1599         if (close(fd) != 0 || written != len) {
1600                 error("Unable to write to %s", lockpath);
1601                 goto error_unlink_return;
1602         }
1603         if (rename(lockpath, git_HEAD) < 0) {
1604                 error("Unable to create %s", git_HEAD);
1605                 goto error_unlink_return;
1606         }
1607         if (adjust_shared_perm(git_HEAD)) {
1608                 error("Unable to fix permissions on %s", lockpath);
1609         error_unlink_return:
1610                 unlink_or_warn(lockpath);
1611         error_free_return:
1612                 free(git_HEAD);
1613                 return -1;
1614         }
1616 #ifndef NO_SYMLINK_HEAD
1617         done:
1618 #endif
1619         if (logmsg && !read_ref(refs_heads_master, new_sha1))
1620                 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1622         free(git_HEAD);
1623         return 0;
1626 static char *ref_msg(const char *line, const char *endp)
1628         const char *ep;
1629         line += 82;
1630         ep = memchr(line, '\n', endp - line);
1631         if (!ep)
1632                 ep = endp;
1633         return xmemdupz(line, ep - line);
1636 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)
1638         const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1639         char *tz_c;
1640         int logfd, tz, reccnt = 0;
1641         struct stat st;
1642         unsigned long date;
1643         unsigned char logged_sha1[20];
1644         void *log_mapped;
1645         size_t mapsz;
1647         logfile = git_path("logs/%s", ref);
1648         logfd = open(logfile, O_RDONLY, 0);
1649         if (logfd < 0)
1650                 die_errno("Unable to read log '%s'", logfile);
1651         fstat(logfd, &st);
1652         if (!st.st_size)
1653                 die("Log %s is empty.", logfile);
1654         mapsz = xsize_t(st.st_size);
1655         log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1656         logdata = log_mapped;
1657         close(logfd);
1659         lastrec = NULL;
1660         rec = logend = logdata + st.st_size;
1661         while (logdata < rec) {
1662                 reccnt++;
1663                 if (logdata < rec && *(rec-1) == '\n')
1664                         rec--;
1665                 lastgt = NULL;
1666                 while (logdata < rec && *(rec-1) != '\n') {
1667                         rec--;
1668                         if (*rec == '>')
1669                                 lastgt = rec;
1670                 }
1671                 if (!lastgt)
1672                         die("Log %s is corrupt.", logfile);
1673                 date = strtoul(lastgt + 1, &tz_c, 10);
1674                 if (date <= at_time || cnt == 0) {
1675                         tz = strtoul(tz_c, NULL, 10);
1676                         if (msg)
1677                                 *msg = ref_msg(rec, logend);
1678                         if (cutoff_time)
1679                                 *cutoff_time = date;
1680                         if (cutoff_tz)
1681                                 *cutoff_tz = tz;
1682                         if (cutoff_cnt)
1683                                 *cutoff_cnt = reccnt - 1;
1684                         if (lastrec) {
1685                                 if (get_sha1_hex(lastrec, logged_sha1))
1686                                         die("Log %s is corrupt.", logfile);
1687                                 if (get_sha1_hex(rec + 41, sha1))
1688                                         die("Log %s is corrupt.", logfile);
1689                                 if (hashcmp(logged_sha1, sha1)) {
1690                                         warning("Log %s has gap after %s.",
1691                                                 logfile, show_date(date, tz, DATE_RFC2822));
1692                                 }
1693                         }
1694                         else if (date == at_time) {
1695                                 if (get_sha1_hex(rec + 41, sha1))
1696                                         die("Log %s is corrupt.", logfile);
1697                         }
1698                         else {
1699                                 if (get_sha1_hex(rec + 41, logged_sha1))
1700                                         die("Log %s is corrupt.", logfile);
1701                                 if (hashcmp(logged_sha1, sha1)) {
1702                                         warning("Log %s unexpectedly ended on %s.",
1703                                                 logfile, show_date(date, tz, DATE_RFC2822));
1704                                 }
1705                         }
1706                         munmap(log_mapped, mapsz);
1707                         return 0;
1708                 }
1709                 lastrec = rec;
1710                 if (cnt > 0)
1711                         cnt--;
1712         }
1714         rec = logdata;
1715         while (rec < logend && *rec != '>' && *rec != '\n')
1716                 rec++;
1717         if (rec == logend || *rec == '\n')
1718                 die("Log %s is corrupt.", logfile);
1719         date = strtoul(rec + 1, &tz_c, 10);
1720         tz = strtoul(tz_c, NULL, 10);
1721         if (get_sha1_hex(logdata, sha1))
1722                 die("Log %s is corrupt.", logfile);
1723         if (is_null_sha1(sha1)) {
1724                 if (get_sha1_hex(logdata + 41, sha1))
1725                         die("Log %s is corrupt.", logfile);
1726         }
1727         if (msg)
1728                 *msg = ref_msg(logdata, logend);
1729         munmap(log_mapped, mapsz);
1731         if (cutoff_time)
1732                 *cutoff_time = date;
1733         if (cutoff_tz)
1734                 *cutoff_tz = tz;
1735         if (cutoff_cnt)
1736                 *cutoff_cnt = reccnt;
1737         return 1;
1740 int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
1742         const char *logfile;
1743         FILE *logfp;
1744         struct strbuf sb = STRBUF_INIT;
1745         int ret = 0;
1747         logfile = git_path("logs/%s", ref);
1748         logfp = fopen(logfile, "r");
1749         if (!logfp)
1750                 return -1;
1752         if (ofs) {
1753                 struct stat statbuf;
1754                 if (fstat(fileno(logfp), &statbuf) ||
1755                     statbuf.st_size < ofs ||
1756                     fseek(logfp, -ofs, SEEK_END) ||
1757                     strbuf_getwholeline(&sb, logfp, '\n')) {
1758                         fclose(logfp);
1759                         strbuf_release(&sb);
1760                         return -1;
1761                 }
1762         }
1764         while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1765                 unsigned char osha1[20], nsha1[20];
1766                 char *email_end, *message;
1767                 unsigned long timestamp;
1768                 int tz;
1770                 /* old SP new SP name <email> SP time TAB msg LF */
1771                 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1772                     get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1773                     get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1774                     !(email_end = strchr(sb.buf + 82, '>')) ||
1775                     email_end[1] != ' ' ||
1776                     !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1777                     !message || message[0] != ' ' ||
1778                     (message[1] != '+' && message[1] != '-') ||
1779                     !isdigit(message[2]) || !isdigit(message[3]) ||
1780                     !isdigit(message[4]) || !isdigit(message[5]))
1781                         continue; /* corrupt? */
1782                 email_end[1] = '\0';
1783                 tz = strtol(message + 1, NULL, 10);
1784                 if (message[6] != '\t')
1785                         message += 6;
1786                 else
1787                         message += 7;
1788                 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1789                          cb_data);
1790                 if (ret)
1791                         break;
1792         }
1793         fclose(logfp);
1794         strbuf_release(&sb);
1795         return ret;
1798 int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1800         return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1803 static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1805         DIR *dir = opendir(git_path("logs/%s", base));
1806         int retval = 0;
1808         if (dir) {
1809                 struct dirent *de;
1810                 int baselen = strlen(base);
1811                 char *log = xmalloc(baselen + 257);
1813                 memcpy(log, base, baselen);
1814                 if (baselen && base[baselen-1] != '/')
1815                         log[baselen++] = '/';
1817                 while ((de = readdir(dir)) != NULL) {
1818                         struct stat st;
1819                         int namelen;
1821                         if (de->d_name[0] == '.')
1822                                 continue;
1823                         namelen = strlen(de->d_name);
1824                         if (namelen > 255)
1825                                 continue;
1826                         if (has_extension(de->d_name, ".lock"))
1827                                 continue;
1828                         memcpy(log + baselen, de->d_name, namelen+1);
1829                         if (stat(git_path("logs/%s", log), &st) < 0)
1830                                 continue;
1831                         if (S_ISDIR(st.st_mode)) {
1832                                 retval = do_for_each_reflog(log, fn, cb_data);
1833                         } else {
1834                                 unsigned char sha1[20];
1835                                 if (!resolve_ref(log, sha1, 0, NULL))
1836                                         retval = error("bad ref for %s", log);
1837                                 else
1838                                         retval = fn(log, sha1, 0, cb_data);
1839                         }
1840                         if (retval)
1841                                 break;
1842                 }
1843                 free(log);
1844                 closedir(dir);
1845         }
1846         else if (*base)
1847                 return errno;
1848         return retval;
1851 int for_each_reflog(each_ref_fn fn, void *cb_data)
1853         return do_for_each_reflog("", fn, cb_data);
1856 int update_ref(const char *action, const char *refname,
1857                 const unsigned char *sha1, const unsigned char *oldval,
1858                 int flags, enum action_on_err onerr)
1860         static struct ref_lock *lock;
1861         lock = lock_any_ref_for_update(refname, oldval, flags);
1862         if (!lock) {
1863                 const char *str = "Cannot lock the ref '%s'.";
1864                 switch (onerr) {
1865                 case MSG_ON_ERR: error(str, refname); break;
1866                 case DIE_ON_ERR: die(str, refname); break;
1867                 case QUIET_ON_ERR: break;
1868                 }
1869                 return 1;
1870         }
1871         if (write_ref_sha1(lock, sha1, action) < 0) {
1872                 const char *str = "Cannot update the ref '%s'.";
1873                 switch (onerr) {
1874                 case MSG_ON_ERR: error(str, refname); break;
1875                 case DIE_ON_ERR: die(str, refname); break;
1876                 case QUIET_ON_ERR: break;
1877                 }
1878                 return 1;
1879         }
1880         return 0;
1883 int ref_exists(char *refname)
1885         unsigned char sha1[20];
1886         return !!resolve_ref(refname, sha1, 1, NULL);
1889 struct ref *find_ref_by_name(const struct ref *list, const char *name)
1891         for ( ; list; list = list->next)
1892                 if (!strcmp(list->name, name))
1893                         return (struct ref *)list;
1894         return NULL;
1897 /*
1898  * generate a format suitable for scanf from a ref_rev_parse_rules
1899  * rule, that is replace the "%.*s" spec with a "%s" spec
1900  */
1901 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
1903         char *spec;
1905         spec = strstr(rule, "%.*s");
1906         if (!spec || strstr(spec + 4, "%.*s"))
1907                 die("invalid rule in ref_rev_parse_rules: %s", rule);
1909         /* copy all until spec */
1910         strncpy(scanf_fmt, rule, spec - rule);
1911         scanf_fmt[spec - rule] = '\0';
1912         /* copy new spec */
1913         strcat(scanf_fmt, "%s");
1914         /* copy remaining rule */
1915         strcat(scanf_fmt, spec + 4);
1917         return;
1920 char *shorten_unambiguous_ref(const char *ref, int strict)
1922         int i;
1923         static char **scanf_fmts;
1924         static int nr_rules;
1925         char *short_name;
1927         /* pre generate scanf formats from ref_rev_parse_rules[] */
1928         if (!nr_rules) {
1929                 size_t total_len = 0;
1931                 /* the rule list is NULL terminated, count them first */
1932                 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
1933                         /* no +1 because strlen("%s") < strlen("%.*s") */
1934                         total_len += strlen(ref_rev_parse_rules[nr_rules]);
1936                 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
1938                 total_len = 0;
1939                 for (i = 0; i < nr_rules; i++) {
1940                         scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
1941                                         + total_len;
1942                         gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
1943                         total_len += strlen(ref_rev_parse_rules[i]);
1944                 }
1945         }
1947         /* bail out if there are no rules */
1948         if (!nr_rules)
1949                 return xstrdup(ref);
1951         /* buffer for scanf result, at most ref must fit */
1952         short_name = xstrdup(ref);
1954         /* skip first rule, it will always match */
1955         for (i = nr_rules - 1; i > 0 ; --i) {
1956                 int j;
1957                 int rules_to_fail = i;
1958                 int short_name_len;
1960                 if (1 != sscanf(ref, scanf_fmts[i], short_name))
1961                         continue;
1963                 short_name_len = strlen(short_name);
1965                 /*
1966                  * in strict mode, all (except the matched one) rules
1967                  * must fail to resolve to a valid non-ambiguous ref
1968                  */
1969                 if (strict)
1970                         rules_to_fail = nr_rules;
1972                 /*
1973                  * check if the short name resolves to a valid ref,
1974                  * but use only rules prior to the matched one
1975                  */
1976                 for (j = 0; j < rules_to_fail; j++) {
1977                         const char *rule = ref_rev_parse_rules[j];
1978                         unsigned char short_objectname[20];
1979                         char refname[PATH_MAX];
1981                         /* skip matched rule */
1982                         if (i == j)
1983                                 continue;
1985                         /*
1986                          * the short name is ambiguous, if it resolves
1987                          * (with this previous rule) to a valid ref
1988                          * read_ref() returns 0 on success
1989                          */
1990                         mksnpath(refname, sizeof(refname),
1991                                  rule, short_name_len, short_name);
1992                         if (!read_ref(refname, short_objectname))
1993                                 break;
1994                 }
1996                 /*
1997                  * short name is non-ambiguous if all previous rules
1998                  * haven't resolved to a valid ref
1999                  */
2000                 if (j == rules_to_fail)
2001                         return short_name;
2002         }
2004         free(short_name);
2005         return xstrdup(ref);