t5801: skip without hg
[git/dscho.git] / refs.c
blobd6bdb47ad61dc5e7eb1c786dd4115e17bdb2aab7
1 #include "cache.h"
2 #include "refs.h"
3 #include "object.h"
4 #include "tag.h"
5 #include "dir.h"
7 /*
8  * Make sure "ref" is something reasonable to have under ".git/refs/";
9  * We do not like it if:
10  *
11  * - any path component of it begins with ".", or
12  * - it has double dots "..", or
13  * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
14  * - it ends with a "/".
15  * - it ends with ".lock"
16  * - it contains a "\" (backslash)
17  */
19 /* Return true iff ch is not allowed in reference names. */
20 static inline int bad_ref_char(int ch)
22         if (((unsigned) ch) <= ' ' || ch == 0x7f ||
23             ch == '~' || ch == '^' || ch == ':' || ch == '\\')
24                 return 1;
25         /* 2.13 Pattern Matching Notation */
26         if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
27                 return 1;
28         return 0;
32  * Try to read one refname component from the front of refname.  Return
33  * the length of the component found, or -1 if the component is not
34  * legal.
35  */
36 static int check_refname_component(const char *refname, int flags)
38         const char *cp;
39         char last = '\0';
41         for (cp = refname; ; cp++) {
42                 char ch = *cp;
43                 if (ch == '\0' || ch == '/')
44                         break;
45                 if (bad_ref_char(ch))
46                         return -1; /* Illegal character in refname. */
47                 if (last == '.' && ch == '.')
48                         return -1; /* Refname contains "..". */
49                 if (last == '@' && ch == '{')
50                         return -1; /* Refname contains "@{". */
51                 last = ch;
52         }
53         if (cp == refname)
54                 return 0; /* Component has zero length. */
55         if (refname[0] == '.') {
56                 if (!(flags & REFNAME_DOT_COMPONENT))
57                         return -1; /* Component starts with '.'. */
58                 /*
59                  * Even if leading dots are allowed, don't allow "."
60                  * as a component (".." is prevented by a rule above).
61                  */
62                 if (refname[1] == '\0')
63                         return -1; /* Component equals ".". */
64         }
65         if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5))
66                 return -1; /* Refname ends with ".lock". */
67         return cp - refname;
70 int check_refname_format(const char *refname, int flags)
72         int component_len, component_count = 0;
74         while (1) {
75                 /* We are at the start of a path component. */
76                 component_len = check_refname_component(refname, flags);
77                 if (component_len <= 0) {
78                         if ((flags & REFNAME_REFSPEC_PATTERN) &&
79                                         refname[0] == '*' &&
80                                         (refname[1] == '\0' || refname[1] == '/')) {
81                                 /* Accept one wildcard as a full refname component. */
82                                 flags &= ~REFNAME_REFSPEC_PATTERN;
83                                 component_len = 1;
84                         } else {
85                                 return -1;
86                         }
87                 }
88                 component_count++;
89                 if (refname[component_len] == '\0')
90                         break;
91                 /* Skip to next component. */
92                 refname += component_len + 1;
93         }
95         if (refname[component_len - 1] == '.')
96                 return -1; /* Refname ends with '.'. */
97         if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
98                 return -1; /* Refname has only one component. */
99         return 0;
102 struct ref_entry;
105  * Information used (along with the information in ref_entry) to
106  * describe a single cached reference.  This data structure only
107  * occurs embedded in a union in struct ref_entry, and only when
108  * (ref_entry->flag & REF_DIR) is zero.
109  */
110 struct ref_value {
111         unsigned char sha1[20];
112         unsigned char peeled[20];
115 struct ref_cache;
118  * Information used (along with the information in ref_entry) to
119  * describe a level in the hierarchy of references.  This data
120  * structure only occurs embedded in a union in struct ref_entry, and
121  * only when (ref_entry.flag & REF_DIR) is set.  In that case,
122  * (ref_entry.flag & REF_INCOMPLETE) determines whether the references
123  * in the directory have already been read:
125  *     (ref_entry.flag & REF_INCOMPLETE) unset -- a directory of loose
126  *         or packed references, already read.
128  *     (ref_entry.flag & REF_INCOMPLETE) set -- a directory of loose
129  *         references that hasn't been read yet (nor has any of its
130  *         subdirectories).
132  * Entries within a directory are stored within a growable array of
133  * pointers to ref_entries (entries, nr, alloc).  Entries 0 <= i <
134  * sorted are sorted by their component name in strcmp() order and the
135  * remaining entries are unsorted.
137  * Loose references are read lazily, one directory at a time.  When a
138  * directory of loose references is read, then all of the references
139  * in that directory are stored, and REF_INCOMPLETE stubs are created
140  * for any subdirectories, but the subdirectories themselves are not
141  * read.  The reading is triggered by get_ref_dir().
142  */
143 struct ref_dir {
144         int nr, alloc;
146         /*
147          * Entries with index 0 <= i < sorted are sorted by name.  New
148          * entries are appended to the list unsorted, and are sorted
149          * only when required; thus we avoid the need to sort the list
150          * after the addition of every reference.
151          */
152         int sorted;
154         /* A pointer to the ref_cache that contains this ref_dir. */
155         struct ref_cache *ref_cache;
157         struct ref_entry **entries;
160 /* ISSYMREF=0x01, ISPACKED=0x02, and ISBROKEN=0x04 are public interfaces */
161 #define REF_KNOWS_PEELED 0x08
163 /* ref_entry represents a directory of references */
164 #define REF_DIR 0x10
167  * Entry has not yet been read from disk (used only for REF_DIR
168  * entries representing loose references)
169  */
170 #define REF_INCOMPLETE 0x20
173  * A ref_entry represents either a reference or a "subdirectory" of
174  * references.
176  * Each directory in the reference namespace is represented by a
177  * ref_entry with (flags & REF_DIR) set and containing a subdir member
178  * that holds the entries in that directory that have been read so
179  * far.  If (flags & REF_INCOMPLETE) is set, then the directory and
180  * its subdirectories haven't been read yet.  REF_INCOMPLETE is only
181  * used for loose reference directories.
183  * References are represented by a ref_entry with (flags & REF_DIR)
184  * unset and a value member that describes the reference's value.  The
185  * flag member is at the ref_entry level, but it is also needed to
186  * interpret the contents of the value field (in other words, a
187  * ref_value object is not very much use without the enclosing
188  * ref_entry).
190  * Reference names cannot end with slash and directories' names are
191  * always stored with a trailing slash (except for the top-level
192  * directory, which is always denoted by "").  This has two nice
193  * consequences: (1) when the entries in each subdir are sorted
194  * lexicographically by name (as they usually are), the references in
195  * a whole tree can be generated in lexicographic order by traversing
196  * the tree in left-to-right, depth-first order; (2) the names of
197  * references and subdirectories cannot conflict, and therefore the
198  * presence of an empty subdirectory does not block the creation of a
199  * similarly-named reference.  (The fact that reference names with the
200  * same leading components can conflict *with each other* is a
201  * separate issue that is regulated by is_refname_available().)
203  * Please note that the name field contains the fully-qualified
204  * reference (or subdirectory) name.  Space could be saved by only
205  * storing the relative names.  But that would require the full names
206  * to be generated on the fly when iterating in do_for_each_ref(), and
207  * would break callback functions, who have always been able to assume
208  * that the name strings that they are passed will not be freed during
209  * the iteration.
210  */
211 struct ref_entry {
212         unsigned char flag; /* ISSYMREF? ISPACKED? */
213         union {
214                 struct ref_value value; /* if not (flags&REF_DIR) */
215                 struct ref_dir subdir; /* if (flags&REF_DIR) */
216         } u;
217         /*
218          * The full name of the reference (e.g., "refs/heads/master")
219          * or the full name of the directory with a trailing slash
220          * (e.g., "refs/heads/"):
221          */
222         char name[FLEX_ARRAY];
225 static void read_loose_refs(const char *dirname, struct ref_dir *dir);
227 static struct ref_dir *get_ref_dir(struct ref_entry *entry)
229         struct ref_dir *dir;
230         assert(entry->flag & REF_DIR);
231         dir = &entry->u.subdir;
232         if (entry->flag & REF_INCOMPLETE) {
233                 read_loose_refs(entry->name, dir);
234                 entry->flag &= ~REF_INCOMPLETE;
235         }
236         return dir;
239 static struct ref_entry *create_ref_entry(const char *refname,
240                                           const unsigned char *sha1, int flag,
241                                           int check_name)
243         int len;
244         struct ref_entry *ref;
246         if (check_name &&
247             check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
248                 die("Reference has invalid format: '%s'", refname);
249         len = strlen(refname) + 1;
250         ref = xmalloc(sizeof(struct ref_entry) + len);
251         hashcpy(ref->u.value.sha1, sha1);
252         hashclr(ref->u.value.peeled);
253         memcpy(ref->name, refname, len);
254         ref->flag = flag;
255         return ref;
258 static void clear_ref_dir(struct ref_dir *dir);
260 static void free_ref_entry(struct ref_entry *entry)
262         if (entry->flag & REF_DIR)
263                 clear_ref_dir(get_ref_dir(entry));
264         free(entry);
268  * Add a ref_entry to the end of dir (unsorted).  Entry is always
269  * stored directly in dir; no recursion into subdirectories is
270  * done.
271  */
272 static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
274         ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
275         dir->entries[dir->nr++] = entry;
279  * Clear and free all entries in dir, recursively.
280  */
281 static void clear_ref_dir(struct ref_dir *dir)
283         int i;
284         for (i = 0; i < dir->nr; i++)
285                 free_ref_entry(dir->entries[i]);
286         free(dir->entries);
287         dir->sorted = dir->nr = dir->alloc = 0;
288         dir->entries = NULL;
292  * Create a struct ref_entry object for the specified dirname.
293  * dirname is the name of the directory with a trailing slash (e.g.,
294  * "refs/heads/") or "" for the top-level directory.
295  */
296 static struct ref_entry *create_dir_entry(struct ref_cache *ref_cache,
297                                           const char *dirname, int incomplete)
299         struct ref_entry *direntry;
300         int len = strlen(dirname);
301         direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
302         memcpy(direntry->name, dirname, len + 1);
303         direntry->u.subdir.ref_cache = ref_cache;
304         direntry->flag = REF_DIR | (incomplete ? REF_INCOMPLETE : 0);
305         return direntry;
308 static int ref_entry_cmp(const void *a, const void *b)
310         struct ref_entry *one = *(struct ref_entry **)a;
311         struct ref_entry *two = *(struct ref_entry **)b;
312         return strcmp(one->name, two->name);
315 static void sort_ref_dir(struct ref_dir *dir);
318  * Return the entry with the given refname from the ref_dir
319  * (non-recursively), sorting dir if necessary.  Return NULL if no
320  * such entry is found.  dir must already be complete.
321  */
322 static struct ref_entry *search_ref_dir(struct ref_dir *dir, const char *refname)
324         struct ref_entry *e, **r;
325         int len;
327         if (refname == NULL || !dir->nr)
328                 return NULL;
330         sort_ref_dir(dir);
332         len = strlen(refname) + 1;
333         e = xmalloc(sizeof(struct ref_entry) + len);
334         memcpy(e->name, refname, len);
336         r = bsearch(&e, dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
338         free(e);
340         if (r == NULL)
341                 return NULL;
343         return *r;
347  * Search for a directory entry directly within dir (without
348  * recursing).  Sort dir if necessary.  subdirname must be a directory
349  * name (i.e., end in '/').  If mkdir is set, then create the
350  * directory if it is missing; otherwise, return NULL if the desired
351  * directory cannot be found.  dir must already be complete.
352  */
353 static struct ref_dir *search_for_subdir(struct ref_dir *dir,
354                                          const char *subdirname, int mkdir)
356         struct ref_entry *entry = search_ref_dir(dir, subdirname);
357         if (!entry) {
358                 if (!mkdir)
359                         return NULL;
360                 /*
361                  * Since dir is complete, the absence of a subdir
362                  * means that the subdir really doesn't exist;
363                  * therefore, create an empty record for it but mark
364                  * the record complete.
365                  */
366                 entry = create_dir_entry(dir->ref_cache, subdirname, 0);
367                 add_entry_to_dir(dir, entry);
368         }
369         return get_ref_dir(entry);
373  * If refname is a reference name, find the ref_dir within the dir
374  * tree that should hold refname.  If refname is a directory name
375  * (i.e., ends in '/'), then return that ref_dir itself.  dir must
376  * represent the top-level directory and must already be complete.
377  * Sort ref_dirs and recurse into subdirectories as necessary.  If
378  * mkdir is set, then create any missing directories; otherwise,
379  * return NULL if the desired directory cannot be found.
380  */
381 static struct ref_dir *find_containing_dir(struct ref_dir *dir,
382                                            const char *refname, int mkdir)
384         struct strbuf dirname;
385         const char *slash;
386         strbuf_init(&dirname, PATH_MAX);
387         for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
388                 struct ref_dir *subdir;
389                 strbuf_add(&dirname,
390                            refname + dirname.len,
391                            (slash + 1) - (refname + dirname.len));
392                 subdir = search_for_subdir(dir, dirname.buf, mkdir);
393                 if (!subdir) {
394                         dir = NULL;
395                         break;
396                 }
397                 dir = subdir;
398         }
400         strbuf_release(&dirname);
401         return dir;
405  * Find the value entry with the given name in dir, sorting ref_dirs
406  * and recursing into subdirectories as necessary.  If the name is not
407  * found or it corresponds to a directory entry, return NULL.
408  */
409 static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
411         struct ref_entry *entry;
412         dir = find_containing_dir(dir, refname, 0);
413         if (!dir)
414                 return NULL;
415         entry = search_ref_dir(dir, refname);
416         return (entry && !(entry->flag & REF_DIR)) ? entry : NULL;
420  * Add a ref_entry to the ref_dir (unsorted), recursing into
421  * subdirectories as necessary.  dir must represent the top-level
422  * directory.  Return 0 on success.
423  */
424 static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
426         dir = find_containing_dir(dir, ref->name, 1);
427         if (!dir)
428                 return -1;
429         add_entry_to_dir(dir, ref);
430         return 0;
434  * Emit a warning and return true iff ref1 and ref2 have the same name
435  * and the same sha1.  Die if they have the same name but different
436  * sha1s.
437  */
438 static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
440         if (strcmp(ref1->name, ref2->name))
441                 return 0;
443         /* Duplicate name; make sure that they don't conflict: */
445         if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
446                 /* This is impossible by construction */
447                 die("Reference directory conflict: %s", ref1->name);
449         if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
450                 die("Duplicated ref, and SHA1s don't match: %s", ref1->name);
452         warning("Duplicated ref: %s", ref1->name);
453         return 1;
457  * Sort the entries in dir non-recursively (if they are not already
458  * sorted) and remove any duplicate entries.
459  */
460 static void sort_ref_dir(struct ref_dir *dir)
462         int i, j;
463         struct ref_entry *last = NULL;
465         /*
466          * This check also prevents passing a zero-length array to qsort(),
467          * which is a problem on some platforms.
468          */
469         if (dir->sorted == dir->nr)
470                 return;
472         qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
474         /* Remove any duplicates: */
475         for (i = 0, j = 0; j < dir->nr; j++) {
476                 struct ref_entry *entry = dir->entries[j];
477                 if (last && is_dup_ref(last, entry))
478                         free_ref_entry(entry);
479                 else
480                         last = dir->entries[i++] = entry;
481         }
482         dir->sorted = dir->nr = i;
485 #define DO_FOR_EACH_INCLUDE_BROKEN 01
487 static struct ref_entry *current_ref;
489 static int do_one_ref(const char *base, each_ref_fn fn, int trim,
490                       int flags, void *cb_data, struct ref_entry *entry)
492         int retval;
493         if (prefixcmp(entry->name, base))
494                 return 0;
496         if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
497                 if (entry->flag & REF_ISBROKEN)
498                         return 0; /* ignore broken refs e.g. dangling symref */
499                 if (!has_sha1_file(entry->u.value.sha1)) {
500                         error("%s does not point to a valid object!", entry->name);
501                         return 0;
502                 }
503         }
504         current_ref = entry;
505         retval = fn(entry->name + trim, entry->u.value.sha1, entry->flag, cb_data);
506         current_ref = NULL;
507         return retval;
511  * Call fn for each reference in dir that has index in the range
512  * offset <= index < dir->nr.  Recurse into subdirectories that are in
513  * that index range, sorting them before iterating.  This function
514  * does not sort dir itself; it should be sorted beforehand.
515  */
516 static int do_for_each_ref_in_dir(struct ref_dir *dir, int offset,
517                                   const char *base,
518                                   each_ref_fn fn, int trim, int flags, void *cb_data)
520         int i;
521         assert(dir->sorted == dir->nr);
522         for (i = offset; i < dir->nr; i++) {
523                 struct ref_entry *entry = dir->entries[i];
524                 int retval;
525                 if (entry->flag & REF_DIR) {
526                         struct ref_dir *subdir = get_ref_dir(entry);
527                         sort_ref_dir(subdir);
528                         retval = do_for_each_ref_in_dir(subdir, 0,
529                                                         base, fn, trim, flags, cb_data);
530                 } else {
531                         retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
532                 }
533                 if (retval)
534                         return retval;
535         }
536         return 0;
540  * Call fn for each reference in the union of dir1 and dir2, in order
541  * by refname.  Recurse into subdirectories.  If a value entry appears
542  * in both dir1 and dir2, then only process the version that is in
543  * dir2.  The input dirs must already be sorted, but subdirs will be
544  * sorted as needed.
545  */
546 static int do_for_each_ref_in_dirs(struct ref_dir *dir1,
547                                    struct ref_dir *dir2,
548                                    const char *base, each_ref_fn fn, int trim,
549                                    int flags, void *cb_data)
551         int retval;
552         int i1 = 0, i2 = 0;
554         assert(dir1->sorted == dir1->nr);
555         assert(dir2->sorted == dir2->nr);
556         while (1) {
557                 struct ref_entry *e1, *e2;
558                 int cmp;
559                 if (i1 == dir1->nr) {
560                         return do_for_each_ref_in_dir(dir2, i2,
561                                                       base, fn, trim, flags, cb_data);
562                 }
563                 if (i2 == dir2->nr) {
564                         return do_for_each_ref_in_dir(dir1, i1,
565                                                       base, fn, trim, flags, cb_data);
566                 }
567                 e1 = dir1->entries[i1];
568                 e2 = dir2->entries[i2];
569                 cmp = strcmp(e1->name, e2->name);
570                 if (cmp == 0) {
571                         if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
572                                 /* Both are directories; descend them in parallel. */
573                                 struct ref_dir *subdir1 = get_ref_dir(e1);
574                                 struct ref_dir *subdir2 = get_ref_dir(e2);
575                                 sort_ref_dir(subdir1);
576                                 sort_ref_dir(subdir2);
577                                 retval = do_for_each_ref_in_dirs(
578                                                 subdir1, subdir2,
579                                                 base, fn, trim, flags, cb_data);
580                                 i1++;
581                                 i2++;
582                         } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
583                                 /* Both are references; ignore the one from dir1. */
584                                 retval = do_one_ref(base, fn, trim, flags, cb_data, e2);
585                                 i1++;
586                                 i2++;
587                         } else {
588                                 die("conflict between reference and directory: %s",
589                                     e1->name);
590                         }
591                 } else {
592                         struct ref_entry *e;
593                         if (cmp < 0) {
594                                 e = e1;
595                                 i1++;
596                         } else {
597                                 e = e2;
598                                 i2++;
599                         }
600                         if (e->flag & REF_DIR) {
601                                 struct ref_dir *subdir = get_ref_dir(e);
602                                 sort_ref_dir(subdir);
603                                 retval = do_for_each_ref_in_dir(
604                                                 subdir, 0,
605                                                 base, fn, trim, flags, cb_data);
606                         } else {
607                                 retval = do_one_ref(base, fn, trim, flags, cb_data, e);
608                         }
609                 }
610                 if (retval)
611                         return retval;
612         }
613         if (i1 < dir1->nr)
614                 return do_for_each_ref_in_dir(dir1, i1,
615                                               base, fn, trim, flags, cb_data);
616         if (i2 < dir2->nr)
617                 return do_for_each_ref_in_dir(dir2, i2,
618                                               base, fn, trim, flags, cb_data);
619         return 0;
623  * Return true iff refname1 and refname2 conflict with each other.
624  * Two reference names conflict if one of them exactly matches the
625  * leading components of the other; e.g., "foo/bar" conflicts with
626  * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
627  * "foo/barbados".
628  */
629 static int names_conflict(const char *refname1, const char *refname2)
631         for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
632                 ;
633         return (*refname1 == '\0' && *refname2 == '/')
634                 || (*refname1 == '/' && *refname2 == '\0');
637 struct name_conflict_cb {
638         const char *refname;
639         const char *oldrefname;
640         const char *conflicting_refname;
643 static int name_conflict_fn(const char *existingrefname, const unsigned char *sha1,
644                             int flags, void *cb_data)
646         struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
647         if (data->oldrefname && !strcmp(data->oldrefname, existingrefname))
648                 return 0;
649         if (names_conflict(data->refname, existingrefname)) {
650                 data->conflicting_refname = existingrefname;
651                 return 1;
652         }
653         return 0;
657  * Return true iff a reference named refname could be created without
658  * conflicting with the name of an existing reference in array.  If
659  * oldrefname is non-NULL, ignore potential conflicts with oldrefname
660  * (e.g., because oldrefname is scheduled for deletion in the same
661  * operation).
662  */
663 static int is_refname_available(const char *refname, const char *oldrefname,
664                                 struct ref_dir *dir)
666         struct name_conflict_cb data;
667         data.refname = refname;
668         data.oldrefname = oldrefname;
669         data.conflicting_refname = NULL;
671         sort_ref_dir(dir);
672         if (do_for_each_ref_in_dir(dir, 0, "", name_conflict_fn,
673                                    0, DO_FOR_EACH_INCLUDE_BROKEN,
674                                    &data)) {
675                 error("'%s' exists; cannot create '%s'",
676                       data.conflicting_refname, refname);
677                 return 0;
678         }
679         return 1;
683  * Future: need to be in "struct repository"
684  * when doing a full libification.
685  */
686 static struct ref_cache {
687         struct ref_cache *next;
688         struct ref_entry *loose;
689         struct ref_entry *packed;
690         /* The submodule name, or "" for the main repo. */
691         char name[FLEX_ARRAY];
692 } *ref_cache;
694 static void clear_packed_ref_cache(struct ref_cache *refs)
696         if (refs->packed) {
697                 free_ref_entry(refs->packed);
698                 refs->packed = NULL;
699         }
702 static void clear_loose_ref_cache(struct ref_cache *refs)
704         if (refs->loose) {
705                 free_ref_entry(refs->loose);
706                 refs->loose = NULL;
707         }
710 static struct ref_cache *create_ref_cache(const char *submodule)
712         int len;
713         struct ref_cache *refs;
714         if (!submodule)
715                 submodule = "";
716         len = strlen(submodule) + 1;
717         refs = xcalloc(1, sizeof(struct ref_cache) + len);
718         memcpy(refs->name, submodule, len);
719         return refs;
723  * Return a pointer to a ref_cache for the specified submodule. For
724  * the main repository, use submodule==NULL. The returned structure
725  * will be allocated and initialized but not necessarily populated; it
726  * should not be freed.
727  */
728 static struct ref_cache *get_ref_cache(const char *submodule)
730         struct ref_cache *refs = ref_cache;
731         if (!submodule)
732                 submodule = "";
733         while (refs) {
734                 if (!strcmp(submodule, refs->name))
735                         return refs;
736                 refs = refs->next;
737         }
739         refs = create_ref_cache(submodule);
740         refs->next = ref_cache;
741         ref_cache = refs;
742         return refs;
745 void invalidate_ref_cache(const char *submodule)
747         struct ref_cache *refs = get_ref_cache(submodule);
748         clear_packed_ref_cache(refs);
749         clear_loose_ref_cache(refs);
753  * Parse one line from a packed-refs file.  Write the SHA1 to sha1.
754  * Return a pointer to the refname within the line (null-terminated),
755  * or NULL if there was a problem.
756  */
757 static const char *parse_ref_line(char *line, unsigned char *sha1)
759         /*
760          * 42: the answer to everything.
761          *
762          * In this case, it happens to be the answer to
763          *  40 (length of sha1 hex representation)
764          *  +1 (space in between hex and name)
765          *  +1 (newline at the end of the line)
766          */
767         int len = strlen(line) - 42;
769         if (len <= 0)
770                 return NULL;
771         if (get_sha1_hex(line, sha1) < 0)
772                 return NULL;
773         if (!isspace(line[40]))
774                 return NULL;
775         line += 41;
776         if (isspace(*line))
777                 return NULL;
778         if (line[len] != '\n')
779                 return NULL;
780         line[len] = 0;
782         return line;
785 static void read_packed_refs(FILE *f, struct ref_dir *dir)
787         struct ref_entry *last = NULL;
788         char refline[PATH_MAX];
789         int flag = REF_ISPACKED;
791         while (fgets(refline, sizeof(refline), f)) {
792                 unsigned char sha1[20];
793                 const char *refname;
794                 static const char header[] = "# pack-refs with:";
796                 if (!strncmp(refline, header, sizeof(header)-1)) {
797                         const char *traits = refline + sizeof(header) - 1;
798                         if (strstr(traits, " peeled "))
799                                 flag |= REF_KNOWS_PEELED;
800                         /* perhaps other traits later as well */
801                         continue;
802                 }
804                 refname = parse_ref_line(refline, sha1);
805                 if (refname) {
806                         last = create_ref_entry(refname, sha1, flag, 1);
807                         add_ref(dir, last);
808                         continue;
809                 }
810                 if (last &&
811                     refline[0] == '^' &&
812                     strlen(refline) == 42 &&
813                     refline[41] == '\n' &&
814                     !get_sha1_hex(refline + 1, sha1))
815                         hashcpy(last->u.value.peeled, sha1);
816         }
819 static struct ref_dir *get_packed_refs(struct ref_cache *refs)
821         if (!refs->packed) {
822                 const char *packed_refs_file;
823                 FILE *f;
825                 refs->packed = create_dir_entry(refs, "", 0);
826                 if (*refs->name)
827                         packed_refs_file = git_path_submodule(refs->name, "packed-refs");
828                 else
829                         packed_refs_file = git_path("packed-refs");
830                 f = fopen(packed_refs_file, "r");
831                 if (f) {
832                         read_packed_refs(f, get_ref_dir(refs->packed));
833                         fclose(f);
834                 }
835         }
836         return get_ref_dir(refs->packed);
839 void add_packed_ref(const char *refname, const unsigned char *sha1)
841         add_ref(get_packed_refs(get_ref_cache(NULL)),
842                         create_ref_entry(refname, sha1, REF_ISPACKED, 1));
846  * Read the loose references from the namespace dirname into dir
847  * (without recursing).  dirname must end with '/'.  dir must be the
848  * directory entry corresponding to dirname.
849  */
850 static void read_loose_refs(const char *dirname, struct ref_dir *dir)
852         struct ref_cache *refs = dir->ref_cache;
853         DIR *d;
854         const char *path;
855         struct dirent *de;
856         int dirnamelen = strlen(dirname);
857         struct strbuf refname;
859         if (*refs->name)
860                 path = git_path_submodule(refs->name, "%s", dirname);
861         else
862                 path = git_path("%s", dirname);
864         d = opendir(path);
865         if (!d)
866                 return;
868         strbuf_init(&refname, dirnamelen + 257);
869         strbuf_add(&refname, dirname, dirnamelen);
871         while ((de = readdir(d)) != NULL) {
872                 unsigned char sha1[20];
873                 struct stat st;
874                 int flag;
875                 const char *refdir;
877                 if (de->d_name[0] == '.')
878                         continue;
879                 if (has_extension(de->d_name, ".lock"))
880                         continue;
881                 strbuf_addstr(&refname, de->d_name);
882                 refdir = *refs->name
883                         ? git_path_submodule(refs->name, "%s", refname.buf)
884                         : git_path("%s", refname.buf);
885                 if (stat(refdir, &st) < 0) {
886                         ; /* silently ignore */
887                 } else if (S_ISDIR(st.st_mode)) {
888                         strbuf_addch(&refname, '/');
889                         add_entry_to_dir(dir,
890                                          create_dir_entry(refs, refname.buf, 1));
891                 } else {
892                         if (*refs->name) {
893                                 hashclr(sha1);
894                                 flag = 0;
895                                 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
896                                         hashclr(sha1);
897                                         flag |= REF_ISBROKEN;
898                                 }
899                         } else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
900                                 hashclr(sha1);
901                                 flag |= REF_ISBROKEN;
902                         }
903                         add_entry_to_dir(dir,
904                                          create_ref_entry(refname.buf, sha1, flag, 1));
905                 }
906                 strbuf_setlen(&refname, dirnamelen);
907         }
908         strbuf_release(&refname);
909         closedir(d);
912 static struct ref_dir *get_loose_refs(struct ref_cache *refs)
914         if (!refs->loose) {
915                 /*
916                  * Mark the top-level directory complete because we
917                  * are about to read the only subdirectory that can
918                  * hold references:
919                  */
920                 refs->loose = create_dir_entry(refs, "", 0);
921                 /*
922                  * Create an incomplete entry for "refs/":
923                  */
924                 add_entry_to_dir(get_ref_dir(refs->loose),
925                                  create_dir_entry(refs, "refs/", 1));
926         }
927         return get_ref_dir(refs->loose);
930 /* We allow "recursive" symbolic refs. Only within reason, though */
931 #define MAXDEPTH 5
932 #define MAXREFLEN (1024)
935  * Called by resolve_gitlink_ref_recursive() after it failed to read
936  * from the loose refs in ref_cache refs. Find <refname> in the
937  * packed-refs file for the submodule.
938  */
939 static int resolve_gitlink_packed_ref(struct ref_cache *refs,
940                                       const char *refname, unsigned char *sha1)
942         struct ref_entry *ref;
943         struct ref_dir *dir = get_packed_refs(refs);
945         ref = find_ref(dir, refname);
946         if (ref == NULL)
947                 return -1;
949         memcpy(sha1, ref->u.value.sha1, 20);
950         return 0;
953 static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
954                                          const char *refname, unsigned char *sha1,
955                                          int recursion)
957         int fd, len;
958         char buffer[128], *p;
959         char *path;
961         if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
962                 return -1;
963         path = *refs->name
964                 ? git_path_submodule(refs->name, "%s", refname)
965                 : git_path("%s", refname);
966         fd = open(path, O_RDONLY);
967         if (fd < 0)
968                 return resolve_gitlink_packed_ref(refs, refname, sha1);
970         len = read(fd, buffer, sizeof(buffer)-1);
971         close(fd);
972         if (len < 0)
973                 return -1;
974         while (len && isspace(buffer[len-1]))
975                 len--;
976         buffer[len] = 0;
978         /* Was it a detached head or an old-fashioned symlink? */
979         if (!get_sha1_hex(buffer, sha1))
980                 return 0;
982         /* Symref? */
983         if (strncmp(buffer, "ref:", 4))
984                 return -1;
985         p = buffer + 4;
986         while (isspace(*p))
987                 p++;
989         return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
992 int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
994         int len = strlen(path), retval;
995         char *submodule;
996         struct ref_cache *refs;
998         while (len && path[len-1] == '/')
999                 len--;
1000         if (!len)
1001                 return -1;
1002         submodule = xstrndup(path, len);
1003         refs = get_ref_cache(submodule);
1004         free(submodule);
1006         retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
1007         return retval;
1011  * Try to read ref from the packed references.  On success, set sha1
1012  * and return 0; otherwise, return -1.
1013  */
1014 static int get_packed_ref(const char *refname, unsigned char *sha1)
1016         struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1017         struct ref_entry *entry = find_ref(packed, refname);
1018         if (entry) {
1019                 hashcpy(sha1, entry->u.value.sha1);
1020                 return 0;
1021         }
1022         return -1;
1025 const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
1027         int depth = MAXDEPTH;
1028         ssize_t len;
1029         char buffer[256];
1030         static char refname_buffer[256];
1032         if (flag)
1033                 *flag = 0;
1035         if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1036                 return NULL;
1038         for (;;) {
1039                 char path[PATH_MAX];
1040                 struct stat st;
1041                 char *buf;
1042                 int fd;
1044                 if (--depth < 0)
1045                         return NULL;
1047                 git_snpath(path, sizeof(path), "%s", refname);
1049                 if (lstat(path, &st) < 0) {
1050                         if (errno != ENOENT)
1051                                 return NULL;
1052                         /*
1053                          * The loose reference file does not exist;
1054                          * check for a packed reference.
1055                          */
1056                         if (!get_packed_ref(refname, sha1)) {
1057                                 if (flag)
1058                                         *flag |= REF_ISPACKED;
1059                                 return refname;
1060                         }
1061                         /* The reference is not a packed reference, either. */
1062                         if (reading) {
1063                                 return NULL;
1064                         } else {
1065                                 hashclr(sha1);
1066                                 return refname;
1067                         }
1068                 }
1070                 /* Follow "normalized" - ie "refs/.." symlinks by hand */
1071                 if (S_ISLNK(st.st_mode)) {
1072                         len = readlink(path, buffer, sizeof(buffer)-1);
1073                         if (len < 0)
1074                                 return NULL;
1075                         buffer[len] = 0;
1076                         if (!prefixcmp(buffer, "refs/") &&
1077                                         !check_refname_format(buffer, 0)) {
1078                                 strcpy(refname_buffer, buffer);
1079                                 refname = refname_buffer;
1080                                 if (flag)
1081                                         *flag |= REF_ISSYMREF;
1082                                 continue;
1083                         }
1084                 }
1086                 /* Is it a directory? */
1087                 if (S_ISDIR(st.st_mode)) {
1088                         errno = EISDIR;
1089                         return NULL;
1090                 }
1092                 /*
1093                  * Anything else, just open it and try to use it as
1094                  * a ref
1095                  */
1096                 fd = open(path, O_RDONLY);
1097                 if (fd < 0)
1098                         return NULL;
1099                 len = read_in_full(fd, buffer, sizeof(buffer)-1);
1100                 close(fd);
1101                 if (len < 0)
1102                         return NULL;
1103                 while (len && isspace(buffer[len-1]))
1104                         len--;
1105                 buffer[len] = '\0';
1107                 /*
1108                  * Is it a symbolic ref?
1109                  */
1110                 if (prefixcmp(buffer, "ref:"))
1111                         break;
1112                 if (flag)
1113                         *flag |= REF_ISSYMREF;
1114                 buf = buffer + 4;
1115                 while (isspace(*buf))
1116                         buf++;
1117                 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1118                         if (flag)
1119                                 *flag |= REF_ISBROKEN;
1120                         return NULL;
1121                 }
1122                 refname = strcpy(refname_buffer, buf);
1123         }
1124         /* Please note that FETCH_HEAD has a second line containing other data. */
1125         if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1126                 if (flag)
1127                         *flag |= REF_ISBROKEN;
1128                 return NULL;
1129         }
1130         return refname;
1133 char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
1135         const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1136         return ret ? xstrdup(ret) : NULL;
1139 /* The argument to filter_refs */
1140 struct ref_filter {
1141         const char *pattern;
1142         each_ref_fn *fn;
1143         void *cb_data;
1146 int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1148         if (resolve_ref_unsafe(refname, sha1, reading, flags))
1149                 return 0;
1150         return -1;
1153 int read_ref(const char *refname, unsigned char *sha1)
1155         return read_ref_full(refname, sha1, 1, NULL);
1158 int ref_exists(const char *refname)
1160         unsigned char sha1[20];
1161         return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1164 static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1165                        void *data)
1167         struct ref_filter *filter = (struct ref_filter *)data;
1168         if (fnmatch(filter->pattern, refname, 0))
1169                 return 0;
1170         return filter->fn(refname, sha1, flags, filter->cb_data);
1173 int peel_ref(const char *refname, unsigned char *sha1)
1175         int flag;
1176         unsigned char base[20];
1177         struct object *o;
1179         if (current_ref && (current_ref->name == refname
1180                 || !strcmp(current_ref->name, refname))) {
1181                 if (current_ref->flag & REF_KNOWS_PEELED) {
1182                         hashcpy(sha1, current_ref->u.value.peeled);
1183                         return 0;
1184                 }
1185                 hashcpy(base, current_ref->u.value.sha1);
1186                 goto fallback;
1187         }
1189         if (read_ref_full(refname, base, 1, &flag))
1190                 return -1;
1192         if ((flag & REF_ISPACKED)) {
1193                 struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
1194                 struct ref_entry *r = find_ref(dir, refname);
1196                 if (r != NULL && r->flag & REF_KNOWS_PEELED) {
1197                         hashcpy(sha1, r->u.value.peeled);
1198                         return 0;
1199                 }
1200         }
1202 fallback:
1203         o = parse_object(base);
1204         if (o && o->type == OBJ_TAG) {
1205                 o = deref_tag(o, refname, 0);
1206                 if (o) {
1207                         hashcpy(sha1, o->sha1);
1208                         return 0;
1209                 }
1210         }
1211         return -1;
1214 struct warn_if_dangling_data {
1215         FILE *fp;
1216         const char *refname;
1217         const char *msg_fmt;
1220 static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1221                                    int flags, void *cb_data)
1223         struct warn_if_dangling_data *d = cb_data;
1224         const char *resolves_to;
1225         unsigned char junk[20];
1227         if (!(flags & REF_ISSYMREF))
1228                 return 0;
1230         resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
1231         if (!resolves_to || strcmp(resolves_to, d->refname))
1232                 return 0;
1234         fprintf(d->fp, d->msg_fmt, refname);
1235         fputc('\n', d->fp);
1236         return 0;
1239 void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1241         struct warn_if_dangling_data data;
1243         data.fp = fp;
1244         data.refname = refname;
1245         data.msg_fmt = msg_fmt;
1246         for_each_rawref(warn_if_dangling_symref, &data);
1249 static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
1250                            int trim, int flags, void *cb_data)
1252         struct ref_cache *refs = get_ref_cache(submodule);
1253         struct ref_dir *packed_dir = get_packed_refs(refs);
1254         struct ref_dir *loose_dir = get_loose_refs(refs);
1255         int retval = 0;
1257         if (base && *base) {
1258                 packed_dir = find_containing_dir(packed_dir, base, 0);
1259                 loose_dir = find_containing_dir(loose_dir, base, 0);
1260         }
1262         if (packed_dir && loose_dir) {
1263                 sort_ref_dir(packed_dir);
1264                 sort_ref_dir(loose_dir);
1265                 retval = do_for_each_ref_in_dirs(
1266                                 packed_dir, loose_dir,
1267                                 base, fn, trim, flags, cb_data);
1268         } else if (packed_dir) {
1269                 sort_ref_dir(packed_dir);
1270                 retval = do_for_each_ref_in_dir(
1271                                 packed_dir, 0,
1272                                 base, fn, trim, flags, cb_data);
1273         } else if (loose_dir) {
1274                 sort_ref_dir(loose_dir);
1275                 retval = do_for_each_ref_in_dir(
1276                                 loose_dir, 0,
1277                                 base, fn, trim, flags, cb_data);
1278         }
1280         return retval;
1283 static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1285         unsigned char sha1[20];
1286         int flag;
1288         if (submodule) {
1289                 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1290                         return fn("HEAD", sha1, 0, cb_data);
1292                 return 0;
1293         }
1295         if (!read_ref_full("HEAD", sha1, 1, &flag))
1296                 return fn("HEAD", sha1, flag, cb_data);
1298         return 0;
1301 int head_ref(each_ref_fn fn, void *cb_data)
1303         return do_head_ref(NULL, fn, cb_data);
1306 int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1308         return do_head_ref(submodule, fn, cb_data);
1311 int for_each_ref(each_ref_fn fn, void *cb_data)
1313         return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1316 int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1318         return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1321 int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1323         return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1326 int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1327                 each_ref_fn fn, void *cb_data)
1329         return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
1332 int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1334         return for_each_ref_in("refs/tags/", fn, cb_data);
1337 int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1339         return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1342 int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1344         return for_each_ref_in("refs/heads/", fn, cb_data);
1347 int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1349         return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1352 int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1354         return for_each_ref_in("refs/remotes/", fn, cb_data);
1357 int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1359         return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
1362 int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1364         return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
1367 int head_ref_namespaced(each_ref_fn fn, void *cb_data)
1369         struct strbuf buf = STRBUF_INIT;
1370         int ret = 0;
1371         unsigned char sha1[20];
1372         int flag;
1374         strbuf_addf(&buf, "%sHEAD", get_git_namespace());
1375         if (!read_ref_full(buf.buf, sha1, 1, &flag))
1376                 ret = fn(buf.buf, sha1, flag, cb_data);
1377         strbuf_release(&buf);
1379         return ret;
1382 int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1384         struct strbuf buf = STRBUF_INIT;
1385         int ret;
1386         strbuf_addf(&buf, "%srefs/", get_git_namespace());
1387         ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
1388         strbuf_release(&buf);
1389         return ret;
1392 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
1393         const char *prefix, void *cb_data)
1395         struct strbuf real_pattern = STRBUF_INIT;
1396         struct ref_filter filter;
1397         int ret;
1399         if (!prefix && prefixcmp(pattern, "refs/"))
1400                 strbuf_addstr(&real_pattern, "refs/");
1401         else if (prefix)
1402                 strbuf_addstr(&real_pattern, prefix);
1403         strbuf_addstr(&real_pattern, pattern);
1405         if (!has_glob_specials(pattern)) {
1406                 /* Append implied '/' '*' if not present. */
1407                 if (real_pattern.buf[real_pattern.len - 1] != '/')
1408                         strbuf_addch(&real_pattern, '/');
1409                 /* No need to check for '*', there is none. */
1410                 strbuf_addch(&real_pattern, '*');
1411         }
1413         filter.pattern = real_pattern.buf;
1414         filter.fn = fn;
1415         filter.cb_data = cb_data;
1416         ret = for_each_ref(filter_refs, &filter);
1418         strbuf_release(&real_pattern);
1419         return ret;
1422 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
1424         return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
1427 int for_each_rawref(each_ref_fn fn, void *cb_data)
1429         return do_for_each_ref(NULL, "", fn, 0,
1430                                DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1433 const char *prettify_refname(const char *name)
1435         return name + (
1436                 !prefixcmp(name, "refs/heads/") ? 11 :
1437                 !prefixcmp(name, "refs/tags/") ? 10 :
1438                 !prefixcmp(name, "refs/remotes/") ? 13 :
1439                 0);
1442 const char *ref_rev_parse_rules[] = {
1443         "%.*s",
1444         "refs/%.*s",
1445         "refs/tags/%.*s",
1446         "refs/heads/%.*s",
1447         "refs/remotes/%.*s",
1448         "refs/remotes/%.*s/HEAD",
1449         NULL
1452 int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
1454         const char **p;
1455         const int abbrev_name_len = strlen(abbrev_name);
1457         for (p = rules; *p; p++) {
1458                 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1459                         return 1;
1460                 }
1461         }
1463         return 0;
1466 static struct ref_lock *verify_lock(struct ref_lock *lock,
1467         const unsigned char *old_sha1, int mustexist)
1469         if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1470                 error("Can't verify ref %s", lock->ref_name);
1471                 unlock_ref(lock);
1472                 return NULL;
1473         }
1474         if (hashcmp(lock->old_sha1, old_sha1)) {
1475                 error("Ref %s is at %s but expected %s", lock->ref_name,
1476                         sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1477                 unlock_ref(lock);
1478                 return NULL;
1479         }
1480         return lock;
1483 static int remove_empty_directories(const char *file)
1485         /* we want to create a file but there is a directory there;
1486          * if that is an empty directory (or a directory that contains
1487          * only empty directories), remove them.
1488          */
1489         struct strbuf path;
1490         int result;
1492         strbuf_init(&path, 20);
1493         strbuf_addstr(&path, file);
1495         result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1497         strbuf_release(&path);
1499         return result;
1503  * *string and *len will only be substituted, and *string returned (for
1504  * later free()ing) if the string passed in is a magic short-hand form
1505  * to name a branch.
1506  */
1507 static char *substitute_branch_name(const char **string, int *len)
1509         struct strbuf buf = STRBUF_INIT;
1510         int ret = interpret_branch_name(*string, &buf);
1512         if (ret == *len) {
1513                 size_t size;
1514                 *string = strbuf_detach(&buf, &size);
1515                 *len = size;
1516                 return (char *)*string;
1517         }
1519         return NULL;
1522 int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1524         char *last_branch = substitute_branch_name(&str, &len);
1525         const char **p, *r;
1526         int refs_found = 0;
1528         *ref = NULL;
1529         for (p = ref_rev_parse_rules; *p; p++) {
1530                 char fullref[PATH_MAX];
1531                 unsigned char sha1_from_ref[20];
1532                 unsigned char *this_result;
1533                 int flag;
1535                 this_result = refs_found ? sha1_from_ref : sha1;
1536                 mksnpath(fullref, sizeof(fullref), *p, len, str);
1537                 r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1538                 if (r) {
1539                         if (!refs_found++)
1540                                 *ref = xstrdup(r);
1541                         if (!warn_ambiguous_refs)
1542                                 break;
1543                 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1544                         warning("ignoring dangling symref %s.", fullref);
1545                 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
1546                         warning("ignoring broken ref %s.", fullref);
1547                 }
1548         }
1549         free(last_branch);
1550         return refs_found;
1553 int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
1555         char *last_branch = substitute_branch_name(&str, &len);
1556         const char **p;
1557         int logs_found = 0;
1559         *log = NULL;
1560         for (p = ref_rev_parse_rules; *p; p++) {
1561                 struct stat st;
1562                 unsigned char hash[20];
1563                 char path[PATH_MAX];
1564                 const char *ref, *it;
1566                 mksnpath(path, sizeof(path), *p, len, str);
1567                 ref = resolve_ref_unsafe(path, hash, 1, NULL);
1568                 if (!ref)
1569                         continue;
1570                 if (!stat(git_path("logs/%s", path), &st) &&
1571                     S_ISREG(st.st_mode))
1572                         it = path;
1573                 else if (strcmp(ref, path) &&
1574                          !stat(git_path("logs/%s", ref), &st) &&
1575                          S_ISREG(st.st_mode))
1576                         it = ref;
1577                 else
1578                         continue;
1579                 if (!logs_found++) {
1580                         *log = xstrdup(it);
1581                         hashcpy(sha1, hash);
1582                 }
1583                 if (!warn_ambiguous_refs)
1584                         break;
1585         }
1586         free(last_branch);
1587         return logs_found;
1590 static struct ref_lock *lock_ref_sha1_basic(const char *refname,
1591                                             const unsigned char *old_sha1,
1592                                             int flags, int *type_p)
1594         char *ref_file;
1595         const char *orig_refname = refname;
1596         struct ref_lock *lock;
1597         int last_errno = 0;
1598         int type, lflags;
1599         int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1600         int missing = 0;
1602         lock = xcalloc(1, sizeof(struct ref_lock));
1603         lock->lock_fd = -1;
1605         refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1606         if (!refname && errno == EISDIR) {
1607                 /* we are trying to lock foo but we used to
1608                  * have foo/bar which now does not exist;
1609                  * it is normal for the empty directory 'foo'
1610                  * to remain.
1611                  */
1612                 ref_file = git_path("%s", orig_refname);
1613                 if (remove_empty_directories(ref_file)) {
1614                         last_errno = errno;
1615                         error("there are still refs under '%s'", orig_refname);
1616                         goto error_return;
1617                 }
1618                 refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1619         }
1620         if (type_p)
1621             *type_p = type;
1622         if (!refname) {
1623                 last_errno = errno;
1624                 error("unable to resolve reference %s: %s",
1625                         orig_refname, strerror(errno));
1626                 goto error_return;
1627         }
1628         missing = is_null_sha1(lock->old_sha1);
1629         /* When the ref did not exist and we are creating it,
1630          * make sure there is no existing ref that is packed
1631          * whose name begins with our refname, nor a ref whose
1632          * name is a proper prefix of our refname.
1633          */
1634         if (missing &&
1635              !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1636                 last_errno = ENOTDIR;
1637                 goto error_return;
1638         }
1640         lock->lk = xcalloc(1, sizeof(struct lock_file));
1642         lflags = LOCK_DIE_ON_ERROR;
1643         if (flags & REF_NODEREF) {
1644                 refname = orig_refname;
1645                 lflags |= LOCK_NODEREF;
1646         }
1647         lock->ref_name = xstrdup(refname);
1648         lock->orig_ref_name = xstrdup(orig_refname);
1649         ref_file = git_path("%s", refname);
1650         if (missing)
1651                 lock->force_write = 1;
1652         if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1653                 lock->force_write = 1;
1655         if (safe_create_leading_directories(ref_file)) {
1656                 last_errno = errno;
1657                 error("unable to create directory for %s", ref_file);
1658                 goto error_return;
1659         }
1661         lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1662         return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1664  error_return:
1665         unlock_ref(lock);
1666         errno = last_errno;
1667         return NULL;
1670 struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
1672         char refpath[PATH_MAX];
1673         if (check_refname_format(refname, 0))
1674                 return NULL;
1675         strcpy(refpath, mkpath("refs/%s", refname));
1676         return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1679 struct ref_lock *lock_any_ref_for_update(const char *refname,
1680                                          const unsigned char *old_sha1, int flags)
1682         if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1683                 return NULL;
1684         return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
1687 struct repack_without_ref_sb {
1688         const char *refname;
1689         int fd;
1692 static int repack_without_ref_fn(const char *refname, const unsigned char *sha1,
1693                                  int flags, void *cb_data)
1695         struct repack_without_ref_sb *data = cb_data;
1696         char line[PATH_MAX + 100];
1697         int len;
1699         if (!strcmp(data->refname, refname))
1700                 return 0;
1701         len = snprintf(line, sizeof(line), "%s %s\n",
1702                        sha1_to_hex(sha1), refname);
1703         /* this should not happen but just being defensive */
1704         if (len > sizeof(line))
1705                 die("too long a refname '%s'", refname);
1706         write_or_die(data->fd, line, len);
1707         return 0;
1710 static struct lock_file packlock;
1712 static int repack_without_ref(const char *refname)
1714         struct repack_without_ref_sb data;
1715         struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1716         if (find_ref(packed, refname) == NULL)
1717                 return 0;
1718         data.refname = refname;
1719         data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1720         if (data.fd < 0) {
1721                 unable_to_lock_error(git_path("packed-refs"), errno);
1722                 return error("cannot delete '%s' from packed refs", refname);
1723         }
1724         do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
1725         return commit_lock_file(&packlock);
1728 int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1730         struct ref_lock *lock;
1731         int err, i = 0, ret = 0, flag = 0;
1733         lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1734         if (!lock)
1735                 return 1;
1736         if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1737                 /* loose */
1738                 const char *path;
1740                 if (!(delopt & REF_NODEREF)) {
1741                         i = strlen(lock->lk->filename) - 5; /* .lock */
1742                         lock->lk->filename[i] = 0;
1743                         path = lock->lk->filename;
1744                 } else {
1745                         path = git_path("%s", refname);
1746                 }
1747                 err = unlink_or_warn(path);
1748                 if (err && errno != ENOENT)
1749                         ret = 1;
1751                 if (!(delopt & REF_NODEREF))
1752                         lock->lk->filename[i] = '.';
1753         }
1754         /* removing the loose one could have resurrected an earlier
1755          * packed one.  Also, if it was not loose we need to repack
1756          * without it.
1757          */
1758         ret |= repack_without_ref(refname);
1760         unlink_or_warn(git_path("logs/%s", lock->ref_name));
1761         invalidate_ref_cache(NULL);
1762         unlock_ref(lock);
1763         return ret;
1767  * People using contrib's git-new-workdir have .git/logs/refs ->
1768  * /some/other/path/.git/logs/refs, and that may live on another device.
1770  * IOW, to avoid cross device rename errors, the temporary renamed log must
1771  * live into logs/refs.
1772  */
1773 #define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
1775 int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1777         unsigned char sha1[20], orig_sha1[20];
1778         int flag = 0, logmoved = 0;
1779         struct ref_lock *lock;
1780         struct stat loginfo;
1781         int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
1782         const char *symref = NULL;
1783         struct ref_cache *refs = get_ref_cache(NULL);
1785         if (log && S_ISLNK(loginfo.st_mode))
1786                 return error("reflog for %s is a symlink", oldrefname);
1788         symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
1789         if (flag & REF_ISSYMREF)
1790                 return error("refname %s is a symbolic ref, renaming it is not supported",
1791                         oldrefname);
1792         if (!symref)
1793                 return error("refname %s not found", oldrefname);
1795         if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1796                 return 1;
1798         if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1799                 return 1;
1801         if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1802                 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1803                         oldrefname, strerror(errno));
1805         if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
1806                 error("unable to delete old %s", oldrefname);
1807                 goto rollback;
1808         }
1810         if (!read_ref_full(newrefname, sha1, 1, &flag) &&
1811             delete_ref(newrefname, sha1, REF_NODEREF)) {
1812                 if (errno==EISDIR) {
1813                         if (remove_empty_directories(git_path("%s", newrefname))) {
1814                                 error("Directory not empty: %s", newrefname);
1815                                 goto rollback;
1816                         }
1817                 } else {
1818                         error("unable to delete existing %s", newrefname);
1819                         goto rollback;
1820                 }
1821         }
1823         if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
1824                 error("unable to create directory for %s", newrefname);
1825                 goto rollback;
1826         }
1828  retry:
1829         if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1830                 if (errno==EISDIR || errno==ENOTDIR) {
1831                         /*
1832                          * rename(a, b) when b is an existing
1833                          * directory ought to result in ISDIR, but
1834                          * Solaris 5.8 gives ENOTDIR.  Sheesh.
1835                          */
1836                         if (remove_empty_directories(git_path("logs/%s", newrefname))) {
1837                                 error("Directory not empty: logs/%s", newrefname);
1838                                 goto rollback;
1839                         }
1840                         goto retry;
1841                 } else {
1842                         error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1843                                 newrefname, strerror(errno));
1844                         goto rollback;
1845                 }
1846         }
1847         logmoved = log;
1849         lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1850         if (!lock) {
1851                 error("unable to lock %s for update", newrefname);
1852                 goto rollback;
1853         }
1854         lock->force_write = 1;
1855         hashcpy(lock->old_sha1, orig_sha1);
1856         if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1857                 error("unable to write current sha1 into %s", newrefname);
1858                 goto rollback;
1859         }
1861         return 0;
1863  rollback:
1864         lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1865         if (!lock) {
1866                 error("unable to lock %s for rollback", oldrefname);
1867                 goto rollbacklog;
1868         }
1870         lock->force_write = 1;
1871         flag = log_all_ref_updates;
1872         log_all_ref_updates = 0;
1873         if (write_ref_sha1(lock, orig_sha1, NULL))
1874                 error("unable to write current sha1 into %s", oldrefname);
1875         log_all_ref_updates = flag;
1877  rollbacklog:
1878         if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1879                 error("unable to restore logfile %s from %s: %s",
1880                         oldrefname, newrefname, strerror(errno));
1881         if (!logmoved && log &&
1882             rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1883                 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1884                         oldrefname, strerror(errno));
1886         return 1;
1889 int close_ref(struct ref_lock *lock)
1891         if (close_lock_file(lock->lk))
1892                 return -1;
1893         lock->lock_fd = -1;
1894         return 0;
1897 int commit_ref(struct ref_lock *lock)
1899         if (commit_lock_file(lock->lk))
1900                 return -1;
1901         lock->lock_fd = -1;
1902         return 0;
1905 void unlock_ref(struct ref_lock *lock)
1907         /* Do not free lock->lk -- atexit() still looks at them */
1908         if (lock->lk)
1909                 rollback_lock_file(lock->lk);
1910         free(lock->ref_name);
1911         free(lock->orig_ref_name);
1912         free(lock);
1916  * copy the reflog message msg to buf, which has been allocated sufficiently
1917  * large, while cleaning up the whitespaces.  Especially, convert LF to space,
1918  * because reflog file is one line per entry.
1919  */
1920 static int copy_msg(char *buf, const char *msg)
1922         char *cp = buf;
1923         char c;
1924         int wasspace = 1;
1926         *cp++ = '\t';
1927         while ((c = *msg++)) {
1928                 if (wasspace && isspace(c))
1929                         continue;
1930                 wasspace = isspace(c);
1931                 if (wasspace)
1932                         c = ' ';
1933                 *cp++ = c;
1934         }
1935         while (buf < cp && isspace(cp[-1]))
1936                 cp--;
1937         *cp++ = '\n';
1938         return cp - buf;
1941 int log_ref_setup(const char *refname, char *logfile, int bufsize)
1943         int logfd, oflags = O_APPEND | O_WRONLY;
1945         git_snpath(logfile, bufsize, "logs/%s", refname);
1946         if (log_all_ref_updates &&
1947             (!prefixcmp(refname, "refs/heads/") ||
1948              !prefixcmp(refname, "refs/remotes/") ||
1949              !prefixcmp(refname, "refs/notes/") ||
1950              !strcmp(refname, "HEAD"))) {
1951                 if (safe_create_leading_directories(logfile) < 0)
1952                         return error("unable to create directory for %s",
1953                                      logfile);
1954                 oflags |= O_CREAT;
1955         }
1957         logfd = open(logfile, oflags, 0666);
1958         if (logfd < 0) {
1959                 if (!(oflags & O_CREAT) && errno == ENOENT)
1960                         return 0;
1962                 if ((oflags & O_CREAT) && errno == EISDIR) {
1963                         if (remove_empty_directories(logfile)) {
1964                                 return error("There are still logs under '%s'",
1965                                              logfile);
1966                         }
1967                         logfd = open(logfile, oflags, 0666);
1968                 }
1970                 if (logfd < 0)
1971                         return error("Unable to append to %s: %s",
1972                                      logfile, strerror(errno));
1973         }
1975         adjust_shared_perm(logfile);
1976         close(logfd);
1977         return 0;
1980 static int log_ref_write(const char *refname, const unsigned char *old_sha1,
1981                          const unsigned char *new_sha1, const char *msg)
1983         int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1984         unsigned maxlen, len;
1985         int msglen;
1986         char log_file[PATH_MAX];
1987         char *logrec;
1988         const char *committer;
1990         if (log_all_ref_updates < 0)
1991                 log_all_ref_updates = !is_bare_repository();
1993         result = log_ref_setup(refname, log_file, sizeof(log_file));
1994         if (result)
1995                 return result;
1997         logfd = open(log_file, oflags);
1998         if (logfd < 0)
1999                 return 0;
2000         msglen = msg ? strlen(msg) : 0;
2001         committer = git_committer_info(0);
2002         maxlen = strlen(committer) + msglen + 100;
2003         logrec = xmalloc(maxlen);
2004         len = sprintf(logrec, "%s %s %s\n",
2005                       sha1_to_hex(old_sha1),
2006                       sha1_to_hex(new_sha1),
2007                       committer);
2008         if (msglen)
2009                 len += copy_msg(logrec + len - 1, msg) - 1;
2010         written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
2011         free(logrec);
2012         if (close(logfd) != 0 || written != len)
2013                 return error("Unable to append to %s", log_file);
2014         return 0;
2017 static int is_branch(const char *refname)
2019         return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
2022 int write_ref_sha1(struct ref_lock *lock,
2023         const unsigned char *sha1, const char *logmsg)
2025         static char term = '\n';
2026         struct object *o;
2028         if (!lock)
2029                 return -1;
2030         if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
2031                 unlock_ref(lock);
2032                 return 0;
2033         }
2034         o = parse_object(sha1);
2035         if (!o) {
2036                 error("Trying to write ref %s with nonexistent object %s",
2037                         lock->ref_name, sha1_to_hex(sha1));
2038                 unlock_ref(lock);
2039                 return -1;
2040         }
2041         if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
2042                 error("Trying to write non-commit object %s to branch %s",
2043                         sha1_to_hex(sha1), lock->ref_name);
2044                 unlock_ref(lock);
2045                 return -1;
2046         }
2047         if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
2048             write_in_full(lock->lock_fd, &term, 1) != 1
2049                 || close_ref(lock) < 0) {
2050                 error("Couldn't write %s", lock->lk->filename);
2051                 unlock_ref(lock);
2052                 return -1;
2053         }
2054         clear_loose_ref_cache(get_ref_cache(NULL));
2055         if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
2056             (strcmp(lock->ref_name, lock->orig_ref_name) &&
2057              log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
2058                 unlock_ref(lock);
2059                 return -1;
2060         }
2061         if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
2062                 /*
2063                  * Special hack: If a branch is updated directly and HEAD
2064                  * points to it (may happen on the remote side of a push
2065                  * for example) then logically the HEAD reflog should be
2066                  * updated too.
2067                  * A generic solution implies reverse symref information,
2068                  * but finding all symrefs pointing to the given branch
2069                  * would be rather costly for this rare event (the direct
2070                  * update of a branch) to be worth it.  So let's cheat and
2071                  * check with HEAD only which should cover 99% of all usage
2072                  * scenarios (even 100% of the default ones).
2073                  */
2074                 unsigned char head_sha1[20];
2075                 int head_flag;
2076                 const char *head_ref;
2077                 head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
2078                 if (head_ref && (head_flag & REF_ISSYMREF) &&
2079                     !strcmp(head_ref, lock->ref_name))
2080                         log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
2081         }
2082         if (commit_ref(lock)) {
2083                 error("Couldn't set %s", lock->ref_name);
2084                 unlock_ref(lock);
2085                 return -1;
2086         }
2087         unlock_ref(lock);
2088         return 0;
2091 int create_symref(const char *ref_target, const char *refs_heads_master,
2092                   const char *logmsg)
2094         const char *lockpath;
2095         char ref[1000];
2096         int fd, len, written;
2097         char *git_HEAD = git_pathdup("%s", ref_target);
2098         unsigned char old_sha1[20], new_sha1[20];
2100         if (logmsg && read_ref(ref_target, old_sha1))
2101                 hashclr(old_sha1);
2103         if (safe_create_leading_directories(git_HEAD) < 0)
2104                 return error("unable to create directory for %s", git_HEAD);
2106 #ifndef NO_SYMLINK_HEAD
2107         if (prefer_symlink_refs) {
2108                 unlink(git_HEAD);
2109                 if (!symlink(refs_heads_master, git_HEAD))
2110                         goto done;
2111                 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
2112         }
2113 #endif
2115         len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
2116         if (sizeof(ref) <= len) {
2117                 error("refname too long: %s", refs_heads_master);
2118                 goto error_free_return;
2119         }
2120         lockpath = mkpath("%s.lock", git_HEAD);
2121         fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
2122         if (fd < 0) {
2123                 error("Unable to open %s for writing", lockpath);
2124                 goto error_free_return;
2125         }
2126         written = write_in_full(fd, ref, len);
2127         if (close(fd) != 0 || written != len) {
2128                 error("Unable to write to %s", lockpath);
2129                 goto error_unlink_return;
2130         }
2131         if (rename(lockpath, git_HEAD) < 0) {
2132                 error("Unable to create %s", git_HEAD);
2133                 goto error_unlink_return;
2134         }
2135         if (adjust_shared_perm(git_HEAD)) {
2136                 error("Unable to fix permissions on %s", lockpath);
2137         error_unlink_return:
2138                 unlink_or_warn(lockpath);
2139         error_free_return:
2140                 free(git_HEAD);
2141                 return -1;
2142         }
2144 #ifndef NO_SYMLINK_HEAD
2145         done:
2146 #endif
2147         if (logmsg && !read_ref(refs_heads_master, new_sha1))
2148                 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
2150         free(git_HEAD);
2151         return 0;
2154 static char *ref_msg(const char *line, const char *endp)
2156         const char *ep;
2157         line += 82;
2158         ep = memchr(line, '\n', endp - line);
2159         if (!ep)
2160                 ep = endp;
2161         return xmemdupz(line, ep - line);
2164 int read_ref_at(const char *refname, unsigned long at_time, int cnt,
2165                 unsigned char *sha1, char **msg,
2166                 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
2168         const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2169         char *tz_c;
2170         int logfd, tz, reccnt = 0;
2171         struct stat st;
2172         unsigned long date;
2173         unsigned char logged_sha1[20];
2174         void *log_mapped;
2175         size_t mapsz;
2177         logfile = git_path("logs/%s", refname);
2178         logfd = open(logfile, O_RDONLY, 0);
2179         if (logfd < 0)
2180                 die_errno("Unable to read log '%s'", logfile);
2181         fstat(logfd, &st);
2182         if (!st.st_size)
2183                 die("Log %s is empty.", logfile);
2184         mapsz = xsize_t(st.st_size);
2185         log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2186         logdata = log_mapped;
2187         close(logfd);
2189         lastrec = NULL;
2190         rec = logend = logdata + st.st_size;
2191         while (logdata < rec) {
2192                 reccnt++;
2193                 if (logdata < rec && *(rec-1) == '\n')
2194                         rec--;
2195                 lastgt = NULL;
2196                 while (logdata < rec && *(rec-1) != '\n') {
2197                         rec--;
2198                         if (*rec == '>')
2199                                 lastgt = rec;
2200                 }
2201                 if (!lastgt)
2202                         die("Log %s is corrupt.", logfile);
2203                 date = strtoul(lastgt + 1, &tz_c, 10);
2204                 if (date <= at_time || cnt == 0) {
2205                         tz = strtoul(tz_c, NULL, 10);
2206                         if (msg)
2207                                 *msg = ref_msg(rec, logend);
2208                         if (cutoff_time)
2209                                 *cutoff_time = date;
2210                         if (cutoff_tz)
2211                                 *cutoff_tz = tz;
2212                         if (cutoff_cnt)
2213                                 *cutoff_cnt = reccnt - 1;
2214                         if (lastrec) {
2215                                 if (get_sha1_hex(lastrec, logged_sha1))
2216                                         die("Log %s is corrupt.", logfile);
2217                                 if (get_sha1_hex(rec + 41, sha1))
2218                                         die("Log %s is corrupt.", logfile);
2219                                 if (hashcmp(logged_sha1, sha1)) {
2220                                         warning("Log %s has gap after %s.",
2221                                                 logfile, show_date(date, tz, DATE_RFC2822));
2222                                 }
2223                         }
2224                         else if (date == at_time) {
2225                                 if (get_sha1_hex(rec + 41, sha1))
2226                                         die("Log %s is corrupt.", logfile);
2227                         }
2228                         else {
2229                                 if (get_sha1_hex(rec + 41, logged_sha1))
2230                                         die("Log %s is corrupt.", logfile);
2231                                 if (hashcmp(logged_sha1, sha1)) {
2232                                         warning("Log %s unexpectedly ended on %s.",
2233                                                 logfile, show_date(date, tz, DATE_RFC2822));
2234                                 }
2235                         }
2236                         munmap(log_mapped, mapsz);
2237                         return 0;
2238                 }
2239                 lastrec = rec;
2240                 if (cnt > 0)
2241                         cnt--;
2242         }
2244         rec = logdata;
2245         while (rec < logend && *rec != '>' && *rec != '\n')
2246                 rec++;
2247         if (rec == logend || *rec == '\n')
2248                 die("Log %s is corrupt.", logfile);
2249         date = strtoul(rec + 1, &tz_c, 10);
2250         tz = strtoul(tz_c, NULL, 10);
2251         if (get_sha1_hex(logdata, sha1))
2252                 die("Log %s is corrupt.", logfile);
2253         if (is_null_sha1(sha1)) {
2254                 if (get_sha1_hex(logdata + 41, sha1))
2255                         die("Log %s is corrupt.", logfile);
2256         }
2257         if (msg)
2258                 *msg = ref_msg(logdata, logend);
2259         munmap(log_mapped, mapsz);
2261         if (cutoff_time)
2262                 *cutoff_time = date;
2263         if (cutoff_tz)
2264                 *cutoff_tz = tz;
2265         if (cutoff_cnt)
2266                 *cutoff_cnt = reccnt;
2267         return 1;
2270 int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2272         const char *logfile;
2273         FILE *logfp;
2274         struct strbuf sb = STRBUF_INIT;
2275         int ret = 0;
2277         logfile = git_path("logs/%s", refname);
2278         logfp = fopen(logfile, "r");
2279         if (!logfp)
2280                 return -1;
2282         if (ofs) {
2283                 struct stat statbuf;
2284                 if (fstat(fileno(logfp), &statbuf) ||
2285                     statbuf.st_size < ofs ||
2286                     fseek(logfp, -ofs, SEEK_END) ||
2287                     strbuf_getwholeline(&sb, logfp, '\n')) {
2288                         fclose(logfp);
2289                         strbuf_release(&sb);
2290                         return -1;
2291                 }
2292         }
2294         while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2295                 unsigned char osha1[20], nsha1[20];
2296                 char *email_end, *message;
2297                 unsigned long timestamp;
2298                 int tz;
2300                 /* old SP new SP name <email> SP time TAB msg LF */
2301                 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
2302                     get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
2303                     get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
2304                     !(email_end = strchr(sb.buf + 82, '>')) ||
2305                     email_end[1] != ' ' ||
2306                     !(timestamp = strtoul(email_end + 2, &message, 10)) ||
2307                     !message || message[0] != ' ' ||
2308                     (message[1] != '+' && message[1] != '-') ||
2309                     !isdigit(message[2]) || !isdigit(message[3]) ||
2310                     !isdigit(message[4]) || !isdigit(message[5]))
2311                         continue; /* corrupt? */
2312                 email_end[1] = '\0';
2313                 tz = strtol(message + 1, NULL, 10);
2314                 if (message[6] != '\t')
2315                         message += 6;
2316                 else
2317                         message += 7;
2318                 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
2319                          cb_data);
2320                 if (ret)
2321                         break;
2322         }
2323         fclose(logfp);
2324         strbuf_release(&sb);
2325         return ret;
2328 int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2330         return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
2334  * Call fn for each reflog in the namespace indicated by name.  name
2335  * must be empty or end with '/'.  Name will be used as a scratch
2336  * space, but its contents will be restored before return.
2337  */
2338 static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
2340         DIR *d = opendir(git_path("logs/%s", name->buf));
2341         int retval = 0;
2342         struct dirent *de;
2343         int oldlen = name->len;
2345         if (!d)
2346                 return name->len ? errno : 0;
2348         while ((de = readdir(d)) != NULL) {
2349                 struct stat st;
2351                 if (de->d_name[0] == '.')
2352                         continue;
2353                 if (has_extension(de->d_name, ".lock"))
2354                         continue;
2355                 strbuf_addstr(name, de->d_name);
2356                 if (stat(git_path("logs/%s", name->buf), &st) < 0) {
2357                         ; /* silently ignore */
2358                 } else {
2359                         if (S_ISDIR(st.st_mode)) {
2360                                 strbuf_addch(name, '/');
2361                                 retval = do_for_each_reflog(name, fn, cb_data);
2362                         } else {
2363                                 unsigned char sha1[20];
2364                                 if (read_ref_full(name->buf, sha1, 0, NULL))
2365                                         retval = error("bad ref for %s", name->buf);
2366                                 else
2367                                         retval = fn(name->buf, sha1, 0, cb_data);
2368                         }
2369                         if (retval)
2370                                 break;
2371                 }
2372                 strbuf_setlen(name, oldlen);
2373         }
2374         closedir(d);
2375         return retval;
2378 int for_each_reflog(each_ref_fn fn, void *cb_data)
2380         int retval;
2381         struct strbuf name;
2382         strbuf_init(&name, PATH_MAX);
2383         retval = do_for_each_reflog(&name, fn, cb_data);
2384         strbuf_release(&name);
2385         return retval;
2388 int update_ref(const char *action, const char *refname,
2389                 const unsigned char *sha1, const unsigned char *oldval,
2390                 int flags, enum action_on_err onerr)
2392         static struct ref_lock *lock;
2393         lock = lock_any_ref_for_update(refname, oldval, flags);
2394         if (!lock) {
2395                 const char *str = "Cannot lock the ref '%s'.";
2396                 switch (onerr) {
2397                 case MSG_ON_ERR: error(str, refname); break;
2398                 case DIE_ON_ERR: die(str, refname); break;
2399                 case QUIET_ON_ERR: break;
2400                 }
2401                 return 1;
2402         }
2403         if (write_ref_sha1(lock, sha1, action) < 0) {
2404                 const char *str = "Cannot update the ref '%s'.";
2405                 switch (onerr) {
2406                 case MSG_ON_ERR: error(str, refname); break;
2407                 case DIE_ON_ERR: die(str, refname); break;
2408                 case QUIET_ON_ERR: break;
2409                 }
2410                 return 1;
2411         }
2412         return 0;
2415 struct ref *find_ref_by_name(const struct ref *list, const char *name)
2417         for ( ; list; list = list->next)
2418                 if (!strcmp(list->name, name))
2419                         return (struct ref *)list;
2420         return NULL;
2424  * generate a format suitable for scanf from a ref_rev_parse_rules
2425  * rule, that is replace the "%.*s" spec with a "%s" spec
2426  */
2427 static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
2429         char *spec;
2431         spec = strstr(rule, "%.*s");
2432         if (!spec || strstr(spec + 4, "%.*s"))
2433                 die("invalid rule in ref_rev_parse_rules: %s", rule);
2435         /* copy all until spec */
2436         strncpy(scanf_fmt, rule, spec - rule);
2437         scanf_fmt[spec - rule] = '\0';
2438         /* copy new spec */
2439         strcat(scanf_fmt, "%s");
2440         /* copy remaining rule */
2441         strcat(scanf_fmt, spec + 4);
2443         return;
2446 char *shorten_unambiguous_ref(const char *refname, int strict)
2448         int i;
2449         static char **scanf_fmts;
2450         static int nr_rules;
2451         char *short_name;
2453         /* pre generate scanf formats from ref_rev_parse_rules[] */
2454         if (!nr_rules) {
2455                 size_t total_len = 0;
2457                 /* the rule list is NULL terminated, count them first */
2458                 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
2459                         /* no +1 because strlen("%s") < strlen("%.*s") */
2460                         total_len += strlen(ref_rev_parse_rules[nr_rules]);
2462                 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
2464                 total_len = 0;
2465                 for (i = 0; i < nr_rules; i++) {
2466                         scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
2467                                         + total_len;
2468                         gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
2469                         total_len += strlen(ref_rev_parse_rules[i]);
2470                 }
2471         }
2473         /* bail out if there are no rules */
2474         if (!nr_rules)
2475                 return xstrdup(refname);
2477         /* buffer for scanf result, at most refname must fit */
2478         short_name = xstrdup(refname);
2480         /* skip first rule, it will always match */
2481         for (i = nr_rules - 1; i > 0 ; --i) {
2482                 int j;
2483                 int rules_to_fail = i;
2484                 int short_name_len;
2486                 if (1 != sscanf(refname, scanf_fmts[i], short_name))
2487                         continue;
2489                 short_name_len = strlen(short_name);
2491                 /*
2492                  * in strict mode, all (except the matched one) rules
2493                  * must fail to resolve to a valid non-ambiguous ref
2494                  */
2495                 if (strict)
2496                         rules_to_fail = nr_rules;
2498                 /*
2499                  * check if the short name resolves to a valid ref,
2500                  * but use only rules prior to the matched one
2501                  */
2502                 for (j = 0; j < rules_to_fail; j++) {
2503                         const char *rule = ref_rev_parse_rules[j];
2504                         char refname[PATH_MAX];
2506                         /* skip matched rule */
2507                         if (i == j)
2508                                 continue;
2510                         /*
2511                          * the short name is ambiguous, if it resolves
2512                          * (with this previous rule) to a valid ref
2513                          * read_ref() returns 0 on success
2514                          */
2515                         mksnpath(refname, sizeof(refname),
2516                                  rule, short_name_len, short_name);
2517                         if (ref_exists(refname))
2518                                 break;
2519                 }
2521                 /*
2522                  * short name is non-ambiguous if all previous rules
2523                  * haven't resolved to a valid ref
2524                  */
2525                 if (j == rules_to_fail)
2526                         return short_name;
2527         }
2529         free(short_name);
2530         return xstrdup(refname);