]> git.ipfire.org Git - thirdparty/git.git/blame - refs.c
get_ref_dir(): add function for getting a ref_dir from a ref_entry
[thirdparty/git.git] / refs.c
CommitLineData
95fc7512 1#include "cache.h"
85023577 2#include "refs.h"
cf0adba7
JH
3#include "object.h"
4#include "tag.h"
7155b727 5#include "dir.h"
95fc7512 6
bc5fd6d3
MH
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 */
f4204ab9 18
bc5fd6d3
MH
19/* Return true iff ch is not allowed in reference names. */
20static inline int bad_ref_char(int ch)
21{
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;
29}
30
31/*
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 */
36static int check_refname_component(const char *refname, int flags)
37{
38 const char *cp;
39 char last = '\0';
40
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)
dac529e4 54 return 0; /* Component has zero length. */
bc5fd6d3
MH
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;
68}
69
70int check_refname_format(const char *refname, int flags)
71{
72 int component_len, component_count = 0;
73
74 while (1) {
75 /* We are at the start of a path component. */
76 component_len = check_refname_component(refname, flags);
dac529e4 77 if (component_len <= 0) {
bc5fd6d3
MH
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 }
94
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;
100}
101
102struct ref_entry;
e1e22e37 103
593f1bb8
MH
104struct ref_value {
105 unsigned char sha1[20];
106 unsigned char peeled[20];
107};
108
d3177275 109struct ref_dir {
e9c4c111 110 int nr, alloc;
e6ed3ca6
MH
111
112 /*
113 * Entries with index 0 <= i < sorted are sorted by name. New
114 * entries are appended to the list unsorted, and are sorted
115 * only when required; thus we avoid the need to sort the list
116 * after the addition of every reference.
117 */
118 int sorted;
119
d3177275 120 struct ref_entry **entries;
e9c4c111
JP
121};
122
432ad41e
MH
123/* ISSYMREF=0x01, ISPACKED=0x02, and ISBROKEN=0x04 are public interfaces */
124#define REF_KNOWS_PEELED 0x08
125#define REF_DIR 0x10
cf0adba7 126
432ad41e
MH
127/*
128 * A ref_entry represents either a reference or a "subdirectory" of
129 * references. Each directory in the reference namespace is
130 * represented by a ref_entry with (flags & REF_DIR) set and
131 * containing a subdir member that holds the entries in that
132 * directory. References are represented by a ref_entry with (flags &
133 * REF_DIR) unset and a value member that describes the reference's
134 * value. The flag member is at the ref_entry level, but it is also
135 * needed to interpret the contents of the value field (in other
136 * words, a ref_value object is not very much use without the
137 * enclosing ref_entry).
138 *
139 * Reference names cannot end with slash and directories' names are
140 * always stored with a trailing slash (except for the top-level
141 * directory, which is always denoted by ""). This has two nice
142 * consequences: (1) when the entries in each subdir are sorted
143 * lexicographically by name (as they usually are), the references in
144 * a whole tree can be generated in lexicographic order by traversing
145 * the tree in left-to-right, depth-first order; (2) the names of
146 * references and subdirectories cannot conflict, and therefore the
147 * presence of an empty subdirectory does not block the creation of a
148 * similarly-named reference. (The fact that reference names with the
149 * same leading components can conflict *with each other* is a
150 * separate issue that is regulated by is_refname_available().)
151 *
152 * Please note that the name field contains the fully-qualified
153 * reference (or subdirectory) name. Space could be saved by only
154 * storing the relative names. But that would require the full names
155 * to be generated on the fly when iterating in do_for_each_ref(), and
156 * would break callback functions, who have always been able to assume
157 * that the name strings that they are passed will not be freed during
158 * the iteration.
159 */
bc5fd6d3
MH
160struct ref_entry {
161 unsigned char flag; /* ISSYMREF? ISPACKED? */
593f1bb8 162 union {
432ad41e
MH
163 struct ref_value value; /* if not (flags&REF_DIR) */
164 struct ref_dir subdir; /* if (flags&REF_DIR) */
593f1bb8 165 } u;
432ad41e
MH
166 /*
167 * The full name of the reference (e.g., "refs/heads/master")
168 * or the full name of the directory with a trailing slash
169 * (e.g., "refs/heads/"):
170 */
bc5fd6d3
MH
171 char name[FLEX_ARRAY];
172};
e1e22e37 173
d7826d54
MH
174static struct ref_dir *get_ref_dir(struct ref_entry *entry)
175{
176 assert(entry->flag & REF_DIR);
177 return &entry->u.subdir;
178}
179
cddc4258
MH
180static struct ref_entry *create_ref_entry(const char *refname,
181 const unsigned char *sha1, int flag,
182 int check_name)
e1e22e37
LT
183{
184 int len;
cddc4258 185 struct ref_entry *ref;
e1e22e37 186
09116a1c 187 if (check_name &&
dfefa935
MH
188 check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
189 die("Reference has invalid format: '%s'", refname);
cddc4258
MH
190 len = strlen(refname) + 1;
191 ref = xmalloc(sizeof(struct ref_entry) + len);
593f1bb8
MH
192 hashcpy(ref->u.value.sha1, sha1);
193 hashclr(ref->u.value.peeled);
cddc4258
MH
194 memcpy(ref->name, refname, len);
195 ref->flag = flag;
196 return ref;
197}
198
432ad41e
MH
199static void clear_ref_dir(struct ref_dir *dir);
200
732134ed
MH
201static void free_ref_entry(struct ref_entry *entry)
202{
432ad41e 203 if (entry->flag & REF_DIR)
d7826d54 204 clear_ref_dir(get_ref_dir(entry));
732134ed
MH
205 free(entry);
206}
207
432ad41e
MH
208/*
209 * Add a ref_entry to the end of dir (unsorted). Entry is always
210 * stored directly in dir; no recursion into subdirectories is
211 * done.
212 */
213static void add_entry_to_dir(struct ref_dir *dir, struct ref_entry *entry)
cddc4258 214{
432ad41e
MH
215 ALLOC_GROW(dir->entries, dir->nr + 1, dir->alloc);
216 dir->entries[dir->nr++] = entry;
c774aab9
JP
217}
218
432ad41e
MH
219/*
220 * Clear and free all entries in dir, recursively.
221 */
d3177275 222static void clear_ref_dir(struct ref_dir *dir)
bc5fd6d3
MH
223{
224 int i;
d3177275
MH
225 for (i = 0; i < dir->nr; i++)
226 free_ref_entry(dir->entries[i]);
227 free(dir->entries);
228 dir->sorted = dir->nr = dir->alloc = 0;
229 dir->entries = NULL;
bc5fd6d3
MH
230}
231
432ad41e
MH
232/*
233 * Create a struct ref_entry object for the specified dirname.
234 * dirname is the name of the directory with a trailing slash (e.g.,
235 * "refs/heads/") or "" for the top-level directory.
236 */
237static struct ref_entry *create_dir_entry(const char *dirname)
238{
239 struct ref_entry *direntry;
240 int len = strlen(dirname);
241 direntry = xcalloc(1, sizeof(struct ref_entry) + len + 1);
242 memcpy(direntry->name, dirname, len + 1);
243 direntry->flag = REF_DIR;
244 return direntry;
245}
246
e9c4c111 247static int ref_entry_cmp(const void *a, const void *b)
c774aab9 248{
e9c4c111
JP
249 struct ref_entry *one = *(struct ref_entry **)a;
250 struct ref_entry *two = *(struct ref_entry **)b;
251 return strcmp(one->name, two->name);
252}
c774aab9 253
d3177275 254static void sort_ref_dir(struct ref_dir *dir);
bc5fd6d3 255
432ad41e
MH
256/*
257 * Return the entry with the given refname from the ref_dir
258 * (non-recursively), sorting dir if necessary. Return NULL if no
259 * such entry is found.
260 */
d3177275 261static struct ref_entry *search_ref_dir(struct ref_dir *dir, const char *refname)
bc5fd6d3
MH
262{
263 struct ref_entry *e, **r;
264 int len;
265
432ad41e 266 if (refname == NULL || !dir->nr)
bc5fd6d3
MH
267 return NULL;
268
d3177275 269 sort_ref_dir(dir);
432ad41e 270
bc5fd6d3
MH
271 len = strlen(refname) + 1;
272 e = xmalloc(sizeof(struct ref_entry) + len);
273 memcpy(e->name, refname, len);
274
d3177275 275 r = bsearch(&e, dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
bc5fd6d3
MH
276
277 free(e);
278
279 if (r == NULL)
280 return NULL;
281
282 return *r;
283}
284
f348ac92
MH
285/*
286 * Search for a directory entry directly within dir (without
287 * recursing). Sort dir if necessary. subdirname must be a directory
288 * name (i.e., end in '/'). If mkdir is set, then create the
289 * directory if it is missing; otherwise, return NULL if the desired
290 * directory cannot be found.
291 */
292static struct ref_entry *search_for_subdir(struct ref_dir *dir,
293 const char *subdirname, int mkdir)
294{
295 struct ref_entry *entry = search_ref_dir(dir, subdirname);
296 if (!entry) {
297 if (!mkdir)
298 return NULL;
299 entry = create_dir_entry(subdirname);
300 add_entry_to_dir(dir, entry);
301 }
302 assert(entry->flag & REF_DIR);
303 return entry;
304}
305
432ad41e
MH
306/*
307 * If refname is a reference name, find the ref_dir within the dir
308 * tree that should hold refname. If refname is a directory name
309 * (i.e., ends in '/'), then return that ref_dir itself. dir must
310 * represent the top-level directory. Sort ref_dirs and recurse into
311 * subdirectories as necessary. If mkdir is set, then create any
312 * missing directories; otherwise, return NULL if the desired
313 * directory cannot be found.
314 */
315static struct ref_dir *find_containing_dir(struct ref_dir *dir,
316 const char *refname, int mkdir)
317{
5fa04418
MH
318 struct strbuf dirname;
319 const char *slash;
320 strbuf_init(&dirname, PATH_MAX);
321 for (slash = strchr(refname, '/'); slash; slash = strchr(slash + 1, '/')) {
322 struct ref_entry *entry;
323 strbuf_add(&dirname,
324 refname + dirname.len,
325 (slash + 1) - (refname + dirname.len));
326 entry = search_for_subdir(dir, dirname.buf, mkdir);
f348ac92
MH
327 if (!entry)
328 break;
d7826d54 329 dir = get_ref_dir(entry);
432ad41e
MH
330 }
331
5fa04418 332 strbuf_release(&dirname);
432ad41e
MH
333 return dir;
334}
335
336/*
337 * Find the value entry with the given name in dir, sorting ref_dirs
338 * and recursing into subdirectories as necessary. If the name is not
339 * found or it corresponds to a directory entry, return NULL.
340 */
341static struct ref_entry *find_ref(struct ref_dir *dir, const char *refname)
342{
343 struct ref_entry *entry;
344 dir = find_containing_dir(dir, refname, 0);
345 if (!dir)
346 return NULL;
347 entry = search_ref_dir(dir, refname);
348 return (entry && !(entry->flag & REF_DIR)) ? entry : NULL;
349}
350
351/*
352 * Add a ref_entry to the ref_dir (unsorted), recursing into
353 * subdirectories as necessary. dir must represent the top-level
354 * directory. Return 0 on success.
355 */
356static int add_ref(struct ref_dir *dir, struct ref_entry *ref)
357{
358 dir = find_containing_dir(dir, ref->name, 1);
359 if (!dir)
360 return -1;
361 add_entry_to_dir(dir, ref);
362 return 0;
363}
364
202a56a9
MH
365/*
366 * Emit a warning and return true iff ref1 and ref2 have the same name
367 * and the same sha1. Die if they have the same name but different
368 * sha1s.
369 */
370static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
371{
432ad41e 372 if (strcmp(ref1->name, ref2->name))
202a56a9 373 return 0;
432ad41e
MH
374
375 /* Duplicate name; make sure that they don't conflict: */
376
377 if ((ref1->flag & REF_DIR) || (ref2->flag & REF_DIR))
378 /* This is impossible by construction */
379 die("Reference directory conflict: %s", ref1->name);
380
381 if (hashcmp(ref1->u.value.sha1, ref2->u.value.sha1))
382 die("Duplicated ref, and SHA1s don't match: %s", ref1->name);
383
384 warning("Duplicated ref: %s", ref1->name);
385 return 1;
202a56a9
MH
386}
387
e6ed3ca6 388/*
432ad41e
MH
389 * Sort the entries in dir non-recursively (if they are not already
390 * sorted) and remove any duplicate entries.
e6ed3ca6 391 */
d3177275 392static void sort_ref_dir(struct ref_dir *dir)
e9c4c111 393{
202a56a9 394 int i, j;
81a79d8e 395 struct ref_entry *last = NULL;
c774aab9 396
e6ed3ca6
MH
397 /*
398 * This check also prevents passing a zero-length array to qsort(),
399 * which is a problem on some platforms.
400 */
d3177275 401 if (dir->sorted == dir->nr)
e9c4c111 402 return;
c774aab9 403
d3177275 404 qsort(dir->entries, dir->nr, sizeof(*dir->entries), ref_entry_cmp);
c774aab9 405
81a79d8e
MH
406 /* Remove any duplicates: */
407 for (i = 0, j = 0; j < dir->nr; j++) {
408 struct ref_entry *entry = dir->entries[j];
409 if (last && is_dup_ref(last, entry))
410 free_ref_entry(entry);
411 else
412 last = dir->entries[i++] = entry;
e9c4c111 413 }
81a79d8e 414 dir->sorted = dir->nr = i;
e9c4c111 415}
c774aab9 416
bc5fd6d3 417#define DO_FOR_EACH_INCLUDE_BROKEN 01
c774aab9 418
bc5fd6d3 419static struct ref_entry *current_ref;
c774aab9 420
bc5fd6d3
MH
421static int do_one_ref(const char *base, each_ref_fn fn, int trim,
422 int flags, void *cb_data, struct ref_entry *entry)
423{
429213e4 424 int retval;
bc5fd6d3
MH
425 if (prefixcmp(entry->name, base))
426 return 0;
c774aab9 427
bc5fd6d3
MH
428 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
429 if (entry->flag & REF_ISBROKEN)
430 return 0; /* ignore broken refs e.g. dangling symref */
593f1bb8 431 if (!has_sha1_file(entry->u.value.sha1)) {
bc5fd6d3
MH
432 error("%s does not point to a valid object!", entry->name);
433 return 0;
434 }
435 }
436 current_ref = entry;
593f1bb8 437 retval = fn(entry->name + trim, entry->u.value.sha1, entry->flag, cb_data);
429213e4
MH
438 current_ref = NULL;
439 return retval;
bc5fd6d3 440}
c774aab9 441
c36b5bc2 442/*
d3177275 443 * Call fn for each reference in dir that has index in the range
432ad41e
MH
444 * offset <= index < dir->nr. Recurse into subdirectories that are in
445 * that index range, sorting them before iterating. This function
446 * does not sort dir itself; it should be sorted beforehand.
c36b5bc2 447 */
d3177275
MH
448static int do_for_each_ref_in_dir(struct ref_dir *dir, int offset,
449 const char *base,
450 each_ref_fn fn, int trim, int flags, void *cb_data)
c36b5bc2
MH
451{
452 int i;
d3177275
MH
453 assert(dir->sorted == dir->nr);
454 for (i = offset; i < dir->nr; i++) {
432ad41e
MH
455 struct ref_entry *entry = dir->entries[i];
456 int retval;
457 if (entry->flag & REF_DIR) {
d7826d54
MH
458 struct ref_dir *subdir = get_ref_dir(entry);
459 sort_ref_dir(subdir);
460 retval = do_for_each_ref_in_dir(subdir, 0,
432ad41e
MH
461 base, fn, trim, flags, cb_data);
462 } else {
463 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
464 }
c36b5bc2
MH
465 if (retval)
466 return retval;
467 }
468 return 0;
469}
470
b3fd060f 471/*
d3177275 472 * Call fn for each reference in the union of dir1 and dir2, in order
432ad41e
MH
473 * by refname. Recurse into subdirectories. If a value entry appears
474 * in both dir1 and dir2, then only process the version that is in
475 * dir2. The input dirs must already be sorted, but subdirs will be
476 * sorted as needed.
b3fd060f 477 */
d3177275
MH
478static int do_for_each_ref_in_dirs(struct ref_dir *dir1,
479 struct ref_dir *dir2,
480 const char *base, each_ref_fn fn, int trim,
481 int flags, void *cb_data)
b3fd060f
MH
482{
483 int retval;
484 int i1 = 0, i2 = 0;
485
d3177275
MH
486 assert(dir1->sorted == dir1->nr);
487 assert(dir2->sorted == dir2->nr);
432ad41e
MH
488 while (1) {
489 struct ref_entry *e1, *e2;
490 int cmp;
491 if (i1 == dir1->nr) {
492 return do_for_each_ref_in_dir(dir2, i2,
493 base, fn, trim, flags, cb_data);
494 }
495 if (i2 == dir2->nr) {
496 return do_for_each_ref_in_dir(dir1, i1,
497 base, fn, trim, flags, cb_data);
498 }
499 e1 = dir1->entries[i1];
500 e2 = dir2->entries[i2];
501 cmp = strcmp(e1->name, e2->name);
502 if (cmp == 0) {
503 if ((e1->flag & REF_DIR) && (e2->flag & REF_DIR)) {
504 /* Both are directories; descend them in parallel. */
d7826d54
MH
505 struct ref_dir *subdir1 = get_ref_dir(e1);
506 struct ref_dir *subdir2 = get_ref_dir(e2);
507 sort_ref_dir(subdir1);
508 sort_ref_dir(subdir2);
432ad41e 509 retval = do_for_each_ref_in_dirs(
d7826d54 510 subdir1, subdir2,
432ad41e
MH
511 base, fn, trim, flags, cb_data);
512 i1++;
513 i2++;
514 } else if (!(e1->flag & REF_DIR) && !(e2->flag & REF_DIR)) {
515 /* Both are references; ignore the one from dir1. */
516 retval = do_one_ref(base, fn, trim, flags, cb_data, e2);
517 i1++;
518 i2++;
519 } else {
520 die("conflict between reference and directory: %s",
521 e1->name);
522 }
b3fd060f 523 } else {
432ad41e
MH
524 struct ref_entry *e;
525 if (cmp < 0) {
526 e = e1;
b3fd060f 527 i1++;
432ad41e
MH
528 } else {
529 e = e2;
530 i2++;
531 }
532 if (e->flag & REF_DIR) {
d7826d54
MH
533 struct ref_dir *subdir = get_ref_dir(e);
534 sort_ref_dir(subdir);
432ad41e 535 retval = do_for_each_ref_in_dir(
d7826d54 536 subdir, 0,
432ad41e
MH
537 base, fn, trim, flags, cb_data);
538 } else {
539 retval = do_one_ref(base, fn, trim, flags, cb_data, e);
b3fd060f
MH
540 }
541 }
542 if (retval)
543 return retval;
544 }
d3177275
MH
545 if (i1 < dir1->nr)
546 return do_for_each_ref_in_dir(dir1, i1,
547 base, fn, trim, flags, cb_data);
548 if (i2 < dir2->nr)
549 return do_for_each_ref_in_dir(dir2, i2,
550 base, fn, trim, flags, cb_data);
b3fd060f
MH
551 return 0;
552}
553
d66da478
MH
554/*
555 * Return true iff refname1 and refname2 conflict with each other.
556 * Two reference names conflict if one of them exactly matches the
557 * leading components of the other; e.g., "foo/bar" conflicts with
558 * both "foo" and with "foo/bar/baz" but not with "foo/bar" or
559 * "foo/barbados".
560 */
561static int names_conflict(const char *refname1, const char *refname2)
562{
5a4d4947
MH
563 for (; *refname1 && *refname1 == *refname2; refname1++, refname2++)
564 ;
565 return (*refname1 == '\0' && *refname2 == '/')
566 || (*refname1 == '/' && *refname2 == '\0');
567}
568
569struct name_conflict_cb {
570 const char *refname;
571 const char *oldrefname;
572 const char *conflicting_refname;
573};
574
575static int name_conflict_fn(const char *existingrefname, const unsigned char *sha1,
576 int flags, void *cb_data)
577{
578 struct name_conflict_cb *data = (struct name_conflict_cb *)cb_data;
579 if (data->oldrefname && !strcmp(data->oldrefname, existingrefname))
580 return 0;
581 if (names_conflict(data->refname, existingrefname)) {
582 data->conflicting_refname = existingrefname;
583 return 1;
d66da478 584 }
5a4d4947 585 return 0;
d66da478
MH
586}
587
bc5fd6d3
MH
588/*
589 * Return true iff a reference named refname could be created without
5a4d4947
MH
590 * conflicting with the name of an existing reference in array. If
591 * oldrefname is non-NULL, ignore potential conflicts with oldrefname
592 * (e.g., because oldrefname is scheduled for deletion in the same
bc5fd6d3
MH
593 * operation).
594 */
595static int is_refname_available(const char *refname, const char *oldrefname,
d3177275 596 struct ref_dir *dir)
bc5fd6d3 597{
5a4d4947
MH
598 struct name_conflict_cb data;
599 data.refname = refname;
600 data.oldrefname = oldrefname;
601 data.conflicting_refname = NULL;
602
d3177275
MH
603 sort_ref_dir(dir);
604 if (do_for_each_ref_in_dir(dir, 0, "", name_conflict_fn,
605 0, DO_FOR_EACH_INCLUDE_BROKEN,
606 &data)) {
5a4d4947
MH
607 error("'%s' exists; cannot create '%s'",
608 data.conflicting_refname, refname);
609 return 0;
bc5fd6d3
MH
610 }
611 return 1;
e1e22e37
LT
612}
613
5e290ff7
JH
614/*
615 * Future: need to be in "struct repository"
616 * when doing a full libification.
617 */
79c7ca54
MH
618static struct ref_cache {
619 struct ref_cache *next;
d12229f5
MH
620 struct ref_entry *loose;
621 struct ref_entry *packed;
ce40979c
MH
622 /* The submodule name, or "" for the main repo. */
623 char name[FLEX_ARRAY];
79c7ca54 624} *ref_cache;
0e88c130 625
760c4512 626static void clear_packed_ref_cache(struct ref_cache *refs)
e1e22e37 627{
d12229f5
MH
628 if (refs->packed) {
629 free_ref_entry(refs->packed);
630 refs->packed = NULL;
631 }
5e290ff7 632}
e1e22e37 633
760c4512
MH
634static void clear_loose_ref_cache(struct ref_cache *refs)
635{
d12229f5
MH
636 if (refs->loose) {
637 free_ref_entry(refs->loose);
638 refs->loose = NULL;
639 }
760c4512
MH
640}
641
79c7ca54 642static struct ref_cache *create_ref_cache(const char *submodule)
e5dbf605 643{
ce40979c 644 int len;
79c7ca54 645 struct ref_cache *refs;
ce40979c
MH
646 if (!submodule)
647 submodule = "";
648 len = strlen(submodule) + 1;
79c7ca54 649 refs = xcalloc(1, sizeof(struct ref_cache) + len);
ce40979c 650 memcpy(refs->name, submodule, len);
e5dbf605
MH
651 return refs;
652}
653
4349a668 654/*
79c7ca54 655 * Return a pointer to a ref_cache for the specified submodule. For
4349a668
MH
656 * the main repository, use submodule==NULL. The returned structure
657 * will be allocated and initialized but not necessarily populated; it
658 * should not be freed.
659 */
79c7ca54 660static struct ref_cache *get_ref_cache(const char *submodule)
4349a668 661{
79c7ca54 662 struct ref_cache *refs = ref_cache;
0e88c130
MH
663 if (!submodule)
664 submodule = "";
665 while (refs) {
666 if (!strcmp(submodule, refs->name))
667 return refs;
668 refs = refs->next;
4349a668 669 }
0e88c130 670
79c7ca54
MH
671 refs = create_ref_cache(submodule);
672 refs->next = ref_cache;
673 ref_cache = refs;
0e88c130 674 return refs;
4349a668
MH
675}
676
8be8bde7 677void invalidate_ref_cache(const char *submodule)
f130b116 678{
c5f29abd
MH
679 struct ref_cache *refs = get_ref_cache(submodule);
680 clear_packed_ref_cache(refs);
681 clear_loose_ref_cache(refs);
5e290ff7 682}
e1e22e37 683
bc5fd6d3
MH
684/*
685 * Parse one line from a packed-refs file. Write the SHA1 to sha1.
686 * Return a pointer to the refname within the line (null-terminated),
687 * or NULL if there was a problem.
688 */
689static const char *parse_ref_line(char *line, unsigned char *sha1)
690{
691 /*
692 * 42: the answer to everything.
693 *
694 * In this case, it happens to be the answer to
695 * 40 (length of sha1 hex representation)
696 * +1 (space in between hex and name)
697 * +1 (newline at the end of the line)
698 */
699 int len = strlen(line) - 42;
700
701 if (len <= 0)
702 return NULL;
703 if (get_sha1_hex(line, sha1) < 0)
704 return NULL;
705 if (!isspace(line[40]))
706 return NULL;
707 line += 41;
708 if (isspace(*line))
709 return NULL;
710 if (line[len] != '\n')
711 return NULL;
712 line[len] = 0;
713
714 return line;
715}
716
d3177275 717static void read_packed_refs(FILE *f, struct ref_dir *dir)
f4204ab9 718{
e9c4c111 719 struct ref_entry *last = NULL;
f4204ab9
JH
720 char refline[PATH_MAX];
721 int flag = REF_ISPACKED;
722
723 while (fgets(refline, sizeof(refline), f)) {
724 unsigned char sha1[20];
dfefa935 725 const char *refname;
f4204ab9
JH
726 static const char header[] = "# pack-refs with:";
727
728 if (!strncmp(refline, header, sizeof(header)-1)) {
729 const char *traits = refline + sizeof(header) - 1;
730 if (strstr(traits, " peeled "))
731 flag |= REF_KNOWS_PEELED;
732 /* perhaps other traits later as well */
733 continue;
734 }
735
dfefa935
MH
736 refname = parse_ref_line(refline, sha1);
737 if (refname) {
dd73ecd1 738 last = create_ref_entry(refname, sha1, flag, 1);
d3177275 739 add_ref(dir, last);
f4204ab9
JH
740 continue;
741 }
742 if (last &&
743 refline[0] == '^' &&
744 strlen(refline) == 42 &&
745 refline[41] == '\n' &&
746 !get_sha1_hex(refline + 1, sha1))
593f1bb8 747 hashcpy(last->u.value.peeled, sha1);
f4204ab9 748 }
f4204ab9
JH
749}
750
d3177275 751static struct ref_dir *get_packed_refs(struct ref_cache *refs)
5e290ff7 752{
d12229f5 753 if (!refs->packed) {
4349a668
MH
754 const char *packed_refs_file;
755 FILE *f;
0bad611b 756
d12229f5 757 refs->packed = create_dir_entry("");
316b097a
MH
758 if (*refs->name)
759 packed_refs_file = git_path_submodule(refs->name, "packed-refs");
4349a668
MH
760 else
761 packed_refs_file = git_path("packed-refs");
762 f = fopen(packed_refs_file, "r");
e1e22e37 763 if (f) {
d7826d54 764 read_packed_refs(f, get_ref_dir(refs->packed));
e1e22e37 765 fclose(f);
e1e22e37 766 }
e1e22e37 767 }
d7826d54 768 return get_ref_dir(refs->packed);
e1e22e37
LT
769}
770
30249ee6
MH
771void add_packed_ref(const char *refname, const unsigned char *sha1)
772{
773 add_ref(get_packed_refs(get_ref_cache(NULL)),
774 create_ref_entry(refname, sha1, REF_ISPACKED, 1));
775}
776
abc39098
MH
777/*
778 * Read the loose references for refs from the namespace dirname.
9f2fb4a3
MH
779 * dirname must end with '/'. dir must be the directory entry
780 * corresponding to dirname.
abc39098 781 */
1900b976
MH
782static void read_loose_refs(struct ref_cache *refs, const char *dirname,
783 struct ref_dir *dir)
e1e22e37 784{
d3177275 785 DIR *d;
0bad611b 786 const char *path;
d5fdae67 787 struct dirent *de;
abc39098 788 int dirnamelen = strlen(dirname);
72b64b44 789 struct strbuf refname;
0bad611b 790
3b124823 791 if (*refs->name)
66a3d20b 792 path = git_path_submodule(refs->name, "%s", dirname);
0bad611b 793 else
66a3d20b 794 path = git_path("%s", dirname);
0bad611b 795
d3177275 796 d = opendir(path);
d5fdae67
MH
797 if (!d)
798 return;
799
66a3d20b
MH
800 strbuf_init(&refname, dirnamelen + 257);
801 strbuf_add(&refname, dirname, dirnamelen);
d5fdae67
MH
802
803 while ((de = readdir(d)) != NULL) {
804 unsigned char sha1[20];
805 struct stat st;
806 int flag;
d5fdae67
MH
807 const char *refdir;
808
809 if (de->d_name[0] == '.')
810 continue;
d5fdae67
MH
811 if (has_extension(de->d_name, ".lock"))
812 continue;
72b64b44 813 strbuf_addstr(&refname, de->d_name);
d5fdae67 814 refdir = *refs->name
72b64b44
MH
815 ? git_path_submodule(refs->name, "%s", refname.buf)
816 : git_path("%s", refname.buf);
817 if (stat(refdir, &st) < 0) {
818 ; /* silently ignore */
819 } else if (S_ISDIR(st.st_mode)) {
abc39098 820 strbuf_addch(&refname, '/');
1900b976 821 read_loose_refs(refs, refname.buf,
d7826d54 822 get_ref_dir(search_for_subdir(dir, refname.buf, 1)));
72b64b44
MH
823 } else {
824 if (*refs->name) {
825 hashclr(sha1);
826 flag = 0;
827 if (resolve_gitlink_ref(refs->name, refname.buf, sha1) < 0) {
828 hashclr(sha1);
829 flag |= REF_ISBROKEN;
830 }
831 } else if (read_ref_full(refname.buf, sha1, 1, &flag)) {
09116a1c
JH
832 hashclr(sha1);
833 flag |= REF_ISBROKEN;
834 }
9f2fb4a3
MH
835 add_entry_to_dir(dir,
836 create_ref_entry(refname.buf, sha1, flag, 1));
e1e22e37 837 }
66a3d20b 838 strbuf_setlen(&refname, dirnamelen);
e1e22e37 839 }
72b64b44 840 strbuf_release(&refname);
d5fdae67 841 closedir(d);
e1e22e37
LT
842}
843
d3177275 844static struct ref_dir *get_loose_refs(struct ref_cache *refs)
e1e22e37 845{
d12229f5
MH
846 if (!refs->loose) {
847 refs->loose = create_dir_entry("");
1900b976 848 read_loose_refs(refs, "refs/",
d7826d54
MH
849 get_ref_dir(search_for_subdir(get_ref_dir(refs->loose),
850 "refs/", 1)));
e1e22e37 851 }
d7826d54 852 return get_ref_dir(refs->loose);
e1e22e37
LT
853}
854
ca8db142
LT
855/* We allow "recursive" symbolic refs. Only within reason, though */
856#define MAXDEPTH 5
0ebde32c
LT
857#define MAXREFLEN (1024)
858
e5fa45c1
JH
859/*
860 * Called by resolve_gitlink_ref_recursive() after it failed to read
b0626608
MH
861 * from the loose refs in ref_cache refs. Find <refname> in the
862 * packed-refs file for the submodule.
e5fa45c1 863 */
b0626608 864static int resolve_gitlink_packed_ref(struct ref_cache *refs,
85be1fe3 865 const char *refname, unsigned char *sha1)
0ebde32c 866{
2c5c66be 867 struct ref_entry *ref;
d3177275 868 struct ref_dir *dir = get_packed_refs(refs);
0ebde32c 869
432ad41e 870 ref = find_ref(dir, refname);
b0626608
MH
871 if (ref == NULL)
872 return -1;
873
593f1bb8 874 memcpy(sha1, ref->u.value.sha1, 20);
b0626608 875 return 0;
0ebde32c
LT
876}
877
b0626608 878static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
85be1fe3 879 const char *refname, unsigned char *sha1,
dfefa935 880 int recursion)
0ebde32c 881{
064d51dc 882 int fd, len;
0ebde32c 883 char buffer[128], *p;
064d51dc 884 char *path;
0ebde32c 885
064d51dc 886 if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
0ebde32c 887 return -1;
064d51dc
MH
888 path = *refs->name
889 ? git_path_submodule(refs->name, "%s", refname)
890 : git_path("%s", refname);
891 fd = open(path, O_RDONLY);
0ebde32c 892 if (fd < 0)
b0626608 893 return resolve_gitlink_packed_ref(refs, refname, sha1);
0ebde32c
LT
894
895 len = read(fd, buffer, sizeof(buffer)-1);
896 close(fd);
897 if (len < 0)
898 return -1;
899 while (len && isspace(buffer[len-1]))
900 len--;
901 buffer[len] = 0;
902
903 /* Was it a detached head or an old-fashioned symlink? */
85be1fe3 904 if (!get_sha1_hex(buffer, sha1))
0ebde32c
LT
905 return 0;
906
907 /* Symref? */
908 if (strncmp(buffer, "ref:", 4))
909 return -1;
910 p = buffer + 4;
911 while (isspace(*p))
912 p++;
913
064d51dc 914 return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
0ebde32c
LT
915}
916
85be1fe3 917int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
0ebde32c
LT
918{
919 int len = strlen(path), retval;
064d51dc 920 char *submodule;
b0626608 921 struct ref_cache *refs;
0ebde32c
LT
922
923 while (len && path[len-1] == '/')
924 len--;
925 if (!len)
926 return -1;
b0626608
MH
927 submodule = xstrndup(path, len);
928 refs = get_ref_cache(submodule);
929 free(submodule);
930
064d51dc 931 retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
0ebde32c
LT
932 return retval;
933}
ca8db142 934
4886b89f 935/*
c224ca7f
MH
936 * Try to read ref from the packed references. On success, set sha1
937 * and return 0; otherwise, return -1.
4886b89f 938 */
dfefa935 939static int get_packed_ref(const char *refname, unsigned char *sha1)
c224ca7f 940{
d3177275 941 struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
432ad41e 942 struct ref_entry *entry = find_ref(packed, refname);
2c5c66be 943 if (entry) {
593f1bb8 944 hashcpy(sha1, entry->u.value.sha1);
2c5c66be 945 return 0;
c224ca7f
MH
946 }
947 return -1;
948}
949
8d68493f 950const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
8a65ff76 951{
0104ca09
HO
952 int depth = MAXDEPTH;
953 ssize_t len;
a876ed83 954 char buffer[256];
dfefa935 955 static char refname_buffer[256];
ca8db142 956
8da19775
JH
957 if (flag)
958 *flag = 0;
959
dfefa935 960 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
8384d788
MH
961 return NULL;
962
a876ed83 963 for (;;) {
55956350 964 char path[PATH_MAX];
a876ed83
JH
965 struct stat st;
966 char *buf;
967 int fd;
8a65ff76 968
a876ed83
JH
969 if (--depth < 0)
970 return NULL;
ca8db142 971
dfefa935 972 git_snpath(path, sizeof(path), "%s", refname);
c224ca7f 973
a876ed83 974 if (lstat(path, &st) < 0) {
c224ca7f
MH
975 if (errno != ENOENT)
976 return NULL;
977 /*
978 * The loose reference file does not exist;
979 * check for a packed reference.
980 */
dfefa935 981 if (!get_packed_ref(refname, sha1)) {
c224ca7f
MH
982 if (flag)
983 *flag |= REF_ISPACKED;
dfefa935 984 return refname;
434cd0cd 985 }
c224ca7f
MH
986 /* The reference is not a packed reference, either. */
987 if (reading) {
a876ed83 988 return NULL;
c224ca7f
MH
989 } else {
990 hashclr(sha1);
dfefa935 991 return refname;
c224ca7f 992 }
a876ed83 993 }
ca8db142 994
a876ed83
JH
995 /* Follow "normalized" - ie "refs/.." symlinks by hand */
996 if (S_ISLNK(st.st_mode)) {
997 len = readlink(path, buffer, sizeof(buffer)-1);
7bb2bf8e
MH
998 if (len < 0)
999 return NULL;
b54cb795 1000 buffer[len] = 0;
1f58a038
MH
1001 if (!prefixcmp(buffer, "refs/") &&
1002 !check_refname_format(buffer, 0)) {
dfefa935
MH
1003 strcpy(refname_buffer, buffer);
1004 refname = refname_buffer;
8da19775
JH
1005 if (flag)
1006 *flag |= REF_ISSYMREF;
a876ed83
JH
1007 continue;
1008 }
ca8db142 1009 }
a876ed83 1010
7a21632f
DS
1011 /* Is it a directory? */
1012 if (S_ISDIR(st.st_mode)) {
1013 errno = EISDIR;
1014 return NULL;
1015 }
1016
a876ed83
JH
1017 /*
1018 * Anything else, just open it and try to use it as
1019 * a ref
1020 */
1021 fd = open(path, O_RDONLY);
1022 if (fd < 0)
1023 return NULL;
93d26e4c 1024 len = read_in_full(fd, buffer, sizeof(buffer)-1);
a876ed83 1025 close(fd);
28775050
MH
1026 if (len < 0)
1027 return NULL;
1028 while (len && isspace(buffer[len-1]))
1029 len--;
1030 buffer[len] = '\0';
a876ed83
JH
1031
1032 /*
1033 * Is it a symbolic ref?
1034 */
28775050 1035 if (prefixcmp(buffer, "ref:"))
a876ed83 1036 break;
55956350
JH
1037 if (flag)
1038 *flag |= REF_ISSYMREF;
a876ed83 1039 buf = buffer + 4;
28775050
MH
1040 while (isspace(*buf))
1041 buf++;
313fb010 1042 if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
55956350
JH
1043 if (flag)
1044 *flag |= REF_ISBROKEN;
313fb010
MH
1045 return NULL;
1046 }
dfefa935 1047 refname = strcpy(refname_buffer, buf);
8a65ff76 1048 }
f989fea0
MH
1049 /* Please note that FETCH_HEAD has a second line containing other data. */
1050 if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
55956350
JH
1051 if (flag)
1052 *flag |= REF_ISBROKEN;
a876ed83 1053 return NULL;
629cd3ac 1054 }
dfefa935 1055 return refname;
a876ed83
JH
1056}
1057
96ec7b1e
NTND
1058char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
1059{
8cad4744 1060 const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
96ec7b1e
NTND
1061 return ret ? xstrdup(ret) : NULL;
1062}
1063
d08bae7e
IL
1064/* The argument to filter_refs */
1065struct ref_filter {
1066 const char *pattern;
1067 each_ref_fn *fn;
1068 void *cb_data;
1069};
1070
dfefa935 1071int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
a876ed83 1072{
8d68493f 1073 if (resolve_ref_unsafe(refname, sha1, reading, flags))
a876ed83
JH
1074 return 0;
1075 return -1;
8a65ff76
LT
1076}
1077
dfefa935 1078int read_ref(const char *refname, unsigned char *sha1)
c6893323 1079{
dfefa935 1080 return read_ref_full(refname, sha1, 1, NULL);
c6893323
NTND
1081}
1082
bc5fd6d3 1083int ref_exists(const char *refname)
ef06b918 1084{
bc5fd6d3
MH
1085 unsigned char sha1[20];
1086 return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
ef06b918
JH
1087}
1088
85be1fe3 1089static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
dfefa935 1090 void *data)
d08bae7e
IL
1091{
1092 struct ref_filter *filter = (struct ref_filter *)data;
dfefa935 1093 if (fnmatch(filter->pattern, refname, 0))
d08bae7e 1094 return 0;
85be1fe3 1095 return filter->fn(refname, sha1, flags, filter->cb_data);
d08bae7e
IL
1096}
1097
dfefa935 1098int peel_ref(const char *refname, unsigned char *sha1)
cf0adba7
JH
1099{
1100 int flag;
1101 unsigned char base[20];
1102 struct object *o;
1103
dfefa935
MH
1104 if (current_ref && (current_ref->name == refname
1105 || !strcmp(current_ref->name, refname))) {
0ae91be0 1106 if (current_ref->flag & REF_KNOWS_PEELED) {
593f1bb8 1107 hashcpy(sha1, current_ref->u.value.peeled);
0ae91be0
SP
1108 return 0;
1109 }
593f1bb8 1110 hashcpy(base, current_ref->u.value.sha1);
0ae91be0
SP
1111 goto fallback;
1112 }
1113
dfefa935 1114 if (read_ref_full(refname, base, 1, &flag))
cf0adba7
JH
1115 return -1;
1116
1117 if ((flag & REF_ISPACKED)) {
d3177275 1118 struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
432ad41e 1119 struct ref_entry *r = find_ref(dir, refname);
cf0adba7 1120
e9c4c111 1121 if (r != NULL && r->flag & REF_KNOWS_PEELED) {
593f1bb8 1122 hashcpy(sha1, r->u.value.peeled);
e9c4c111 1123 return 0;
cf0adba7 1124 }
cf0adba7
JH
1125 }
1126
0ae91be0 1127fallback:
cf0adba7 1128 o = parse_object(base);
8c87dc77 1129 if (o && o->type == OBJ_TAG) {
dfefa935 1130 o = deref_tag(o, refname, 0);
cf0adba7
JH
1131 if (o) {
1132 hashcpy(sha1, o->sha1);
1133 return 0;
1134 }
1135 }
1136 return -1;
1137}
1138
bc5fd6d3
MH
1139struct warn_if_dangling_data {
1140 FILE *fp;
1141 const char *refname;
1142 const char *msg_fmt;
1143};
1144
1145static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1146 int flags, void *cb_data)
1147{
1148 struct warn_if_dangling_data *d = cb_data;
1149 const char *resolves_to;
1150 unsigned char junk[20];
1151
1152 if (!(flags & REF_ISSYMREF))
1153 return 0;
1154
1155 resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
1156 if (!resolves_to || strcmp(resolves_to, d->refname))
1157 return 0;
1158
1159 fprintf(d->fp, d->msg_fmt, refname);
1160 return 0;
1161}
1162
1163void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1164{
1165 struct warn_if_dangling_data data;
1166
1167 data.fp = fp;
1168 data.refname = refname;
1169 data.msg_fmt = msg_fmt;
1170 for_each_rawref(warn_if_dangling_symref, &data);
1171}
1172
0bad611b
HV
1173static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
1174 int trim, int flags, void *cb_data)
8a65ff76 1175{
316b097a 1176 struct ref_cache *refs = get_ref_cache(submodule);
933ac036
MH
1177 struct ref_dir *packed_dir = get_packed_refs(refs);
1178 struct ref_dir *loose_dir = get_loose_refs(refs);
1179 int retval = 0;
1180
1181 if (base && *base) {
1182 packed_dir = find_containing_dir(packed_dir, base, 0);
1183 loose_dir = find_containing_dir(loose_dir, base, 0);
1184 }
1185
1186 if (packed_dir && loose_dir) {
1187 sort_ref_dir(packed_dir);
1188 sort_ref_dir(loose_dir);
1189 retval = do_for_each_ref_in_dirs(
1190 packed_dir, loose_dir,
1191 base, fn, trim, flags, cb_data);
1192 } else if (packed_dir) {
1193 sort_ref_dir(packed_dir);
1194 retval = do_for_each_ref_in_dir(
1195 packed_dir, 0,
1196 base, fn, trim, flags, cb_data);
1197 } else if (loose_dir) {
1198 sort_ref_dir(loose_dir);
1199 retval = do_for_each_ref_in_dir(
1200 loose_dir, 0,
1201 base, fn, trim, flags, cb_data);
1202 }
1203
1204 return retval;
8a65ff76
LT
1205}
1206
0bad611b 1207static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
723c31fe
LT
1208{
1209 unsigned char sha1[20];
8da19775
JH
1210 int flag;
1211
0bad611b
HV
1212 if (submodule) {
1213 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1214 return fn("HEAD", sha1, 0, cb_data);
1215
1216 return 0;
1217 }
1218
c6893323 1219 if (!read_ref_full("HEAD", sha1, 1, &flag))
8da19775 1220 return fn("HEAD", sha1, flag, cb_data);
0bad611b 1221
2f34ba32 1222 return 0;
723c31fe
LT
1223}
1224
0bad611b
HV
1225int head_ref(each_ref_fn fn, void *cb_data)
1226{
1227 return do_head_ref(NULL, fn, cb_data);
1228}
1229
9ef6aeb0
HV
1230int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1231{
1232 return do_head_ref(submodule, fn, cb_data);
1233}
1234
cb5d709f 1235int for_each_ref(each_ref_fn fn, void *cb_data)
8a65ff76 1236{
b3cfc406 1237 return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
a62be77f
SE
1238}
1239
9ef6aeb0
HV
1240int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1241{
b3cfc406 1242 return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
a62be77f
SE
1243}
1244
2a8177b6
CC
1245int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1246{
0bad611b 1247 return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
2a8177b6
CC
1248}
1249
9ef6aeb0
HV
1250int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1251 each_ref_fn fn, void *cb_data)
1252{
1253 return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
2a8177b6
CC
1254}
1255
cb5d709f 1256int for_each_tag_ref(each_ref_fn fn, void *cb_data)
a62be77f 1257{
2a8177b6 1258 return for_each_ref_in("refs/tags/", fn, cb_data);
a62be77f
SE
1259}
1260
9ef6aeb0
HV
1261int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1262{
1263 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1264}
1265
cb5d709f 1266int for_each_branch_ref(each_ref_fn fn, void *cb_data)
a62be77f 1267{
2a8177b6 1268 return for_each_ref_in("refs/heads/", fn, cb_data);
a62be77f
SE
1269}
1270
9ef6aeb0
HV
1271int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1272{
1273 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1274}
1275
cb5d709f 1276int for_each_remote_ref(each_ref_fn fn, void *cb_data)
a62be77f 1277{
2a8177b6 1278 return for_each_ref_in("refs/remotes/", fn, cb_data);
f8948e2f
JH
1279}
1280
9ef6aeb0
HV
1281int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1282{
1283 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
1284}
1285
29268700
CC
1286int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1287{
0bad611b 1288 return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
29268700
CC
1289}
1290
a1bea2c1
JT
1291int head_ref_namespaced(each_ref_fn fn, void *cb_data)
1292{
1293 struct strbuf buf = STRBUF_INIT;
1294 int ret = 0;
1295 unsigned char sha1[20];
1296 int flag;
1297
1298 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
c6893323 1299 if (!read_ref_full(buf.buf, sha1, 1, &flag))
a1bea2c1
JT
1300 ret = fn(buf.buf, sha1, flag, cb_data);
1301 strbuf_release(&buf);
1302
1303 return ret;
1304}
1305
1306int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1307{
1308 struct strbuf buf = STRBUF_INIT;
1309 int ret;
1310 strbuf_addf(&buf, "%srefs/", get_git_namespace());
1311 ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
1312 strbuf_release(&buf);
1313 return ret;
1314}
1315
b09fe971
IL
1316int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
1317 const char *prefix, void *cb_data)
d08bae7e
IL
1318{
1319 struct strbuf real_pattern = STRBUF_INIT;
1320 struct ref_filter filter;
d08bae7e
IL
1321 int ret;
1322
b09fe971 1323 if (!prefix && prefixcmp(pattern, "refs/"))
d08bae7e 1324 strbuf_addstr(&real_pattern, "refs/");
b09fe971
IL
1325 else if (prefix)
1326 strbuf_addstr(&real_pattern, prefix);
d08bae7e
IL
1327 strbuf_addstr(&real_pattern, pattern);
1328
894a9d33 1329 if (!has_glob_specials(pattern)) {
9517e6b8 1330 /* Append implied '/' '*' if not present. */
d08bae7e
IL
1331 if (real_pattern.buf[real_pattern.len - 1] != '/')
1332 strbuf_addch(&real_pattern, '/');
1333 /* No need to check for '*', there is none. */
1334 strbuf_addch(&real_pattern, '*');
1335 }
1336
1337 filter.pattern = real_pattern.buf;
1338 filter.fn = fn;
1339 filter.cb_data = cb_data;
1340 ret = for_each_ref(filter_refs, &filter);
1341
1342 strbuf_release(&real_pattern);
1343 return ret;
1344}
1345
b09fe971
IL
1346int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
1347{
1348 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
1349}
1350
f8948e2f
JH
1351int for_each_rawref(each_ref_fn fn, void *cb_data)
1352{
b3cfc406 1353 return do_for_each_ref(NULL, "", fn, 0,
f8948e2f 1354 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
8a65ff76
LT
1355}
1356
4577e483 1357const char *prettify_refname(const char *name)
a9c37a72 1358{
a9c37a72
DB
1359 return name + (
1360 !prefixcmp(name, "refs/heads/") ? 11 :
1361 !prefixcmp(name, "refs/tags/") ? 10 :
1362 !prefixcmp(name, "refs/remotes/") ? 13 :
1363 0);
1364}
1365
79803322
SP
1366const char *ref_rev_parse_rules[] = {
1367 "%.*s",
1368 "refs/%.*s",
1369 "refs/tags/%.*s",
1370 "refs/heads/%.*s",
1371 "refs/remotes/%.*s",
1372 "refs/remotes/%.*s/HEAD",
1373 NULL
1374};
1375
1376int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
1377{
1378 const char **p;
1379 const int abbrev_name_len = strlen(abbrev_name);
1380
1381 for (p = rules; *p; p++) {
1382 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1383 return 1;
1384 }
1385 }
1386
1387 return 0;
1388}
1389
e5f38ec3 1390static struct ref_lock *verify_lock(struct ref_lock *lock,
4bd18c43
SP
1391 const unsigned char *old_sha1, int mustexist)
1392{
c6893323 1393 if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
434cd0cd 1394 error("Can't verify ref %s", lock->ref_name);
4bd18c43
SP
1395 unlock_ref(lock);
1396 return NULL;
1397 }
a89fccd2 1398 if (hashcmp(lock->old_sha1, old_sha1)) {
434cd0cd 1399 error("Ref %s is at %s but expected %s", lock->ref_name,
4bd18c43
SP
1400 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1401 unlock_ref(lock);
1402 return NULL;
1403 }
1404 return lock;
1405}
1406
7155b727 1407static int remove_empty_directories(const char *file)
bc7127ef
JH
1408{
1409 /* we want to create a file but there is a directory there;
1410 * if that is an empty directory (or a directory that contains
1411 * only empty directories), remove them.
1412 */
7155b727
JS
1413 struct strbuf path;
1414 int result;
bc7127ef 1415
7155b727
JS
1416 strbuf_init(&path, 20);
1417 strbuf_addstr(&path, file);
1418
a0f4afbe 1419 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
7155b727
JS
1420
1421 strbuf_release(&path);
1422
1423 return result;
bc7127ef
JH
1424}
1425
ff74f7f1
JH
1426/*
1427 * *string and *len will only be substituted, and *string returned (for
1428 * later free()ing) if the string passed in is a magic short-hand form
1429 * to name a branch.
1430 */
1431static char *substitute_branch_name(const char **string, int *len)
1432{
1433 struct strbuf buf = STRBUF_INIT;
1434 int ret = interpret_branch_name(*string, &buf);
1435
1436 if (ret == *len) {
1437 size_t size;
1438 *string = strbuf_detach(&buf, &size);
1439 *len = size;
1440 return (char *)*string;
1441 }
1442
1443 return NULL;
1444}
1445
1446int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1447{
1448 char *last_branch = substitute_branch_name(&str, &len);
1449 const char **p, *r;
1450 int refs_found = 0;
1451
1452 *ref = NULL;
1453 for (p = ref_rev_parse_rules; *p; p++) {
1454 char fullref[PATH_MAX];
1455 unsigned char sha1_from_ref[20];
1456 unsigned char *this_result;
1457 int flag;
1458
1459 this_result = refs_found ? sha1_from_ref : sha1;
1460 mksnpath(fullref, sizeof(fullref), *p, len, str);
8cad4744 1461 r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
ff74f7f1
JH
1462 if (r) {
1463 if (!refs_found++)
1464 *ref = xstrdup(r);
1465 if (!warn_ambiguous_refs)
1466 break;
55956350 1467 } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
ff74f7f1 1468 warning("ignoring dangling symref %s.", fullref);
55956350
JH
1469 } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
1470 warning("ignoring broken ref %s.", fullref);
1471 }
ff74f7f1
JH
1472 }
1473 free(last_branch);
1474 return refs_found;
1475}
1476
1477int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
1478{
1479 char *last_branch = substitute_branch_name(&str, &len);
1480 const char **p;
1481 int logs_found = 0;
1482
1483 *log = NULL;
1484 for (p = ref_rev_parse_rules; *p; p++) {
1485 struct stat st;
1486 unsigned char hash[20];
1487 char path[PATH_MAX];
1488 const char *ref, *it;
1489
1490 mksnpath(path, sizeof(path), *p, len, str);
8cad4744 1491 ref = resolve_ref_unsafe(path, hash, 1, NULL);
ff74f7f1
JH
1492 if (!ref)
1493 continue;
1494 if (!stat(git_path("logs/%s", path), &st) &&
1495 S_ISREG(st.st_mode))
1496 it = path;
1497 else if (strcmp(ref, path) &&
1498 !stat(git_path("logs/%s", ref), &st) &&
1499 S_ISREG(st.st_mode))
1500 it = ref;
1501 else
1502 continue;
1503 if (!logs_found++) {
1504 *log = xstrdup(it);
1505 hashcpy(sha1, hash);
1506 }
1507 if (!warn_ambiguous_refs)
1508 break;
1509 }
1510 free(last_branch);
1511 return logs_found;
1512}
1513
dfefa935
MH
1514static struct ref_lock *lock_ref_sha1_basic(const char *refname,
1515 const unsigned char *old_sha1,
1516 int flags, int *type_p)
4bd18c43 1517{
434cd0cd 1518 char *ref_file;
dfefa935 1519 const char *orig_refname = refname;
4bd18c43 1520 struct ref_lock *lock;
5cc3cef9 1521 int last_errno = 0;
acd3b9ec 1522 int type, lflags;
4431fcc4 1523 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
5bdd8d4a 1524 int missing = 0;
4bd18c43
SP
1525
1526 lock = xcalloc(1, sizeof(struct ref_lock));
1527 lock->lock_fd = -1;
1528
8d68493f 1529 refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
dfefa935 1530 if (!refname && errno == EISDIR) {
bc7127ef
JH
1531 /* we are trying to lock foo but we used to
1532 * have foo/bar which now does not exist;
1533 * it is normal for the empty directory 'foo'
1534 * to remain.
1535 */
dfefa935 1536 ref_file = git_path("%s", orig_refname);
5cc3cef9
JH
1537 if (remove_empty_directories(ref_file)) {
1538 last_errno = errno;
dfefa935 1539 error("there are still refs under '%s'", orig_refname);
5cc3cef9
JH
1540 goto error_return;
1541 }
8d68493f 1542 refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
bc7127ef 1543 }
68db31cc
SV
1544 if (type_p)
1545 *type_p = type;
dfefa935 1546 if (!refname) {
5cc3cef9 1547 last_errno = errno;
818f477c 1548 error("unable to resolve reference %s: %s",
dfefa935 1549 orig_refname, strerror(errno));
5cc3cef9 1550 goto error_return;
4bd18c43 1551 }
5bdd8d4a 1552 missing = is_null_sha1(lock->old_sha1);
c976d415
LH
1553 /* When the ref did not exist and we are creating it,
1554 * make sure there is no existing ref that is packed
1555 * whose name begins with our refname, nor a ref whose
1556 * name is a proper prefix of our refname.
1557 */
5bdd8d4a 1558 if (missing &&
316b097a 1559 !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
f475e08e 1560 last_errno = ENOTDIR;
c976d415 1561 goto error_return;
f475e08e 1562 }
22a3844e 1563
c33d5174 1564 lock->lk = xcalloc(1, sizeof(struct lock_file));
4bd18c43 1565
acd3b9ec
JH
1566 lflags = LOCK_DIE_ON_ERROR;
1567 if (flags & REF_NODEREF) {
dfefa935 1568 refname = orig_refname;
acd3b9ec
JH
1569 lflags |= LOCK_NODEREF;
1570 }
dfefa935
MH
1571 lock->ref_name = xstrdup(refname);
1572 lock->orig_ref_name = xstrdup(orig_refname);
1573 ref_file = git_path("%s", refname);
5bdd8d4a 1574 if (missing)
68db31cc
SV
1575 lock->force_write = 1;
1576 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1577 lock->force_write = 1;
4bd18c43 1578
5cc3cef9
JH
1579 if (safe_create_leading_directories(ref_file)) {
1580 last_errno = errno;
1581 error("unable to create directory for %s", ref_file);
1582 goto error_return;
1583 }
4bd18c43 1584
acd3b9ec 1585 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
4bd18c43 1586 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
5cc3cef9
JH
1587
1588 error_return:
1589 unlock_ref(lock);
1590 errno = last_errno;
1591 return NULL;
4bd18c43
SP
1592}
1593
dfefa935 1594struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
95fc7512 1595{
53cce84c 1596 char refpath[PATH_MAX];
dfefa935 1597 if (check_refname_format(refname, 0))
4bd18c43 1598 return NULL;
dfefa935 1599 strcpy(refpath, mkpath("refs/%s", refname));
68db31cc 1600 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
4bd18c43
SP
1601}
1602
dfefa935
MH
1603struct ref_lock *lock_any_ref_for_update(const char *refname,
1604 const unsigned char *old_sha1, int flags)
4bd18c43 1605{
dfefa935 1606 if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
257f3020 1607 return NULL;
dfefa935 1608 return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
c0277d15
JH
1609}
1610
d66da478
MH
1611struct repack_without_ref_sb {
1612 const char *refname;
1613 int fd;
1614};
1615
1616static int repack_without_ref_fn(const char *refname, const unsigned char *sha1,
1617 int flags, void *cb_data)
1618{
1619 struct repack_without_ref_sb *data = cb_data;
1620 char line[PATH_MAX + 100];
1621 int len;
1622
1623 if (!strcmp(data->refname, refname))
1624 return 0;
1625 len = snprintf(line, sizeof(line), "%s %s\n",
1626 sha1_to_hex(sha1), refname);
1627 /* this should not happen but just being defensive */
1628 if (len > sizeof(line))
1629 die("too long a refname '%s'", refname);
1630 write_or_die(data->fd, line, len);
1631 return 0;
1632}
1633
26a063a1
JH
1634static struct lock_file packlock;
1635
c0277d15
JH
1636static int repack_without_ref(const char *refname)
1637{
d66da478 1638 struct repack_without_ref_sb data;
d3177275 1639 struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
432ad41e 1640 if (find_ref(packed, refname) == NULL)
c0277d15 1641 return 0;
d66da478
MH
1642 data.refname = refname;
1643 data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1644 if (data.fd < 0) {
1b018fd9 1645 unable_to_lock_error(git_path("packed-refs"), errno);
c0277d15 1646 return error("cannot delete '%s' from packed refs", refname);
1b018fd9 1647 }
d3177275 1648 do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
c0277d15
JH
1649 return commit_lock_file(&packlock);
1650}
1651
eca35a25 1652int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
c0277d15
JH
1653{
1654 struct ref_lock *lock;
eca35a25 1655 int err, i = 0, ret = 0, flag = 0;
c0277d15 1656
68db31cc 1657 lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
c0277d15
JH
1658 if (!lock)
1659 return 1;
045a476f 1660 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
c0277d15 1661 /* loose */
eca35a25
MV
1662 const char *path;
1663
1664 if (!(delopt & REF_NODEREF)) {
1665 i = strlen(lock->lk->filename) - 5; /* .lock */
1666 lock->lk->filename[i] = 0;
1667 path = lock->lk->filename;
1668 } else {
9db56f71 1669 path = git_path("%s", refname);
eca35a25 1670 }
691f1a28
AR
1671 err = unlink_or_warn(path);
1672 if (err && errno != ENOENT)
c0277d15 1673 ret = 1;
691f1a28 1674
eca35a25
MV
1675 if (!(delopt & REF_NODEREF))
1676 lock->lk->filename[i] = '.';
c0277d15
JH
1677 }
1678 /* removing the loose one could have resurrected an earlier
1679 * packed one. Also, if it was not loose we need to repack
1680 * without it.
1681 */
1682 ret |= repack_without_ref(refname);
1683
691f1a28 1684 unlink_or_warn(git_path("logs/%s", lock->ref_name));
3870a0d1 1685 invalidate_ref_cache(NULL);
c0277d15
JH
1686 unlock_ref(lock);
1687 return ret;
4bd18c43
SP
1688}
1689
765c2258
PH
1690/*
1691 * People using contrib's git-new-workdir have .git/logs/refs ->
1692 * /some/other/path/.git/logs/refs, and that may live on another device.
1693 *
1694 * IOW, to avoid cross device rename errors, the temporary renamed log must
1695 * live into logs/refs.
1696 */
1697#define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1698
dfefa935 1699int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
c976d415 1700{
c976d415
LH
1701 unsigned char sha1[20], orig_sha1[20];
1702 int flag = 0, logmoved = 0;
1703 struct ref_lock *lock;
c976d415 1704 struct stat loginfo;
dfefa935 1705 int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
eca35a25 1706 const char *symref = NULL;
316b097a 1707 struct ref_cache *refs = get_ref_cache(NULL);
c976d415 1708
450d4c0f 1709 if (log && S_ISLNK(loginfo.st_mode))
dfefa935 1710 return error("reflog for %s is a symlink", oldrefname);
c976d415 1711
8d68493f 1712 symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
eca35a25 1713 if (flag & REF_ISSYMREF)
fa58186c 1714 return error("refname %s is a symbolic ref, renaming it is not supported",
dfefa935 1715 oldrefname);
eca35a25 1716 if (!symref)
dfefa935 1717 return error("refname %s not found", oldrefname);
c976d415 1718
316b097a 1719 if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
c976d415
LH
1720 return 1;
1721
316b097a 1722 if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
c976d415
LH
1723 return 1;
1724
dfefa935 1725 if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
765c2258 1726 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
dfefa935 1727 oldrefname, strerror(errno));
c976d415 1728
dfefa935
MH
1729 if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
1730 error("unable to delete old %s", oldrefname);
c976d415
LH
1731 goto rollback;
1732 }
1733
dfefa935
MH
1734 if (!read_ref_full(newrefname, sha1, 1, &flag) &&
1735 delete_ref(newrefname, sha1, REF_NODEREF)) {
c976d415 1736 if (errno==EISDIR) {
dfefa935
MH
1737 if (remove_empty_directories(git_path("%s", newrefname))) {
1738 error("Directory not empty: %s", newrefname);
c976d415
LH
1739 goto rollback;
1740 }
1741 } else {
dfefa935 1742 error("unable to delete existing %s", newrefname);
c976d415
LH
1743 goto rollback;
1744 }
1745 }
1746
dfefa935
MH
1747 if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
1748 error("unable to create directory for %s", newrefname);
c976d415
LH
1749 goto rollback;
1750 }
1751
1752 retry:
dfefa935 1753 if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
d9e74d57
JR
1754 if (errno==EISDIR || errno==ENOTDIR) {
1755 /*
1756 * rename(a, b) when b is an existing
1757 * directory ought to result in ISDIR, but
1758 * Solaris 5.8 gives ENOTDIR. Sheesh.
1759 */
dfefa935
MH
1760 if (remove_empty_directories(git_path("logs/%s", newrefname))) {
1761 error("Directory not empty: logs/%s", newrefname);
c976d415
LH
1762 goto rollback;
1763 }
1764 goto retry;
1765 } else {
765c2258 1766 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
dfefa935 1767 newrefname, strerror(errno));
c976d415
LH
1768 goto rollback;
1769 }
1770 }
1771 logmoved = log;
1772
dfefa935 1773 lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
c976d415 1774 if (!lock) {
dfefa935 1775 error("unable to lock %s for update", newrefname);
c976d415
LH
1776 goto rollback;
1777 }
c976d415
LH
1778 lock->force_write = 1;
1779 hashcpy(lock->old_sha1, orig_sha1);
678d0f4c 1780 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
dfefa935 1781 error("unable to write current sha1 into %s", newrefname);
c976d415
LH
1782 goto rollback;
1783 }
1784
1785 return 0;
1786
1787 rollback:
dfefa935 1788 lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
c976d415 1789 if (!lock) {
dfefa935 1790 error("unable to lock %s for rollback", oldrefname);
c976d415
LH
1791 goto rollbacklog;
1792 }
1793
1794 lock->force_write = 1;
1795 flag = log_all_ref_updates;
1796 log_all_ref_updates = 0;
1797 if (write_ref_sha1(lock, orig_sha1, NULL))
dfefa935 1798 error("unable to write current sha1 into %s", oldrefname);
c976d415
LH
1799 log_all_ref_updates = flag;
1800
1801 rollbacklog:
dfefa935 1802 if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
c976d415 1803 error("unable to restore logfile %s from %s: %s",
dfefa935 1804 oldrefname, newrefname, strerror(errno));
c976d415 1805 if (!logmoved && log &&
dfefa935 1806 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
765c2258 1807 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
dfefa935 1808 oldrefname, strerror(errno));
c976d415
LH
1809
1810 return 1;
1811}
1812
435fc852 1813int close_ref(struct ref_lock *lock)
b531394d
BC
1814{
1815 if (close_lock_file(lock->lk))
1816 return -1;
1817 lock->lock_fd = -1;
1818 return 0;
1819}
1820
435fc852 1821int commit_ref(struct ref_lock *lock)
b531394d
BC
1822{
1823 if (commit_lock_file(lock->lk))
1824 return -1;
1825 lock->lock_fd = -1;
1826 return 0;
1827}
1828
e5f38ec3 1829void unlock_ref(struct ref_lock *lock)
4bd18c43 1830{
4ed7cd3a
BC
1831 /* Do not free lock->lk -- atexit() still looks at them */
1832 if (lock->lk)
1833 rollback_lock_file(lock->lk);
434cd0cd 1834 free(lock->ref_name);
1655707c 1835 free(lock->orig_ref_name);
4bd18c43
SP
1836 free(lock);
1837}
1838
0ec29a47
JH
1839/*
1840 * copy the reflog message msg to buf, which has been allocated sufficiently
1841 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1842 * because reflog file is one line per entry.
1843 */
1844static int copy_msg(char *buf, const char *msg)
1845{
1846 char *cp = buf;
1847 char c;
1848 int wasspace = 1;
1849
1850 *cp++ = '\t';
1851 while ((c = *msg++)) {
1852 if (wasspace && isspace(c))
1853 continue;
1854 wasspace = isspace(c);
1855 if (wasspace)
1856 c = ' ';
1857 *cp++ = c;
1858 }
1859 while (buf < cp && isspace(cp[-1]))
1860 cp--;
1861 *cp++ = '\n';
1862 return cp - buf;
1863}
1864
dfefa935 1865int log_ref_setup(const char *refname, char *logfile, int bufsize)
6de08ae6 1866{
859c3017 1867 int logfd, oflags = O_APPEND | O_WRONLY;
9a13f0b7 1868
dfefa935 1869 git_snpath(logfile, bufsize, "logs/%s", refname);
4057deb5 1870 if (log_all_ref_updates &&
dfefa935
MH
1871 (!prefixcmp(refname, "refs/heads/") ||
1872 !prefixcmp(refname, "refs/remotes/") ||
1873 !prefixcmp(refname, "refs/notes/") ||
1874 !strcmp(refname, "HEAD"))) {
157aaea5 1875 if (safe_create_leading_directories(logfile) < 0)
6de08ae6 1876 return error("unable to create directory for %s",
157aaea5 1877 logfile);
6de08ae6
SP
1878 oflags |= O_CREAT;
1879 }
1880
157aaea5 1881 logfd = open(logfile, oflags, 0666);
6de08ae6 1882 if (logfd < 0) {
1974bf62 1883 if (!(oflags & O_CREAT) && errno == ENOENT)
6de08ae6 1884 return 0;
3b463c3f
JH
1885
1886 if ((oflags & O_CREAT) && errno == EISDIR) {
157aaea5 1887 if (remove_empty_directories(logfile)) {
3b463c3f 1888 return error("There are still logs under '%s'",
157aaea5 1889 logfile);
3b463c3f 1890 }
157aaea5 1891 logfd = open(logfile, oflags, 0666);
3b463c3f
JH
1892 }
1893
1894 if (logfd < 0)
1895 return error("Unable to append to %s: %s",
157aaea5 1896 logfile, strerror(errno));
6de08ae6
SP
1897 }
1898
157aaea5 1899 adjust_shared_perm(logfile);
859c3017
EM
1900 close(logfd);
1901 return 0;
1902}
443b92b6 1903
dfefa935 1904static int log_ref_write(const char *refname, const unsigned char *old_sha1,
859c3017
EM
1905 const unsigned char *new_sha1, const char *msg)
1906{
1907 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1908 unsigned maxlen, len;
1909 int msglen;
157aaea5 1910 char log_file[PATH_MAX];
859c3017
EM
1911 char *logrec;
1912 const char *committer;
1913
1914 if (log_all_ref_updates < 0)
1915 log_all_ref_updates = !is_bare_repository();
1916
dfefa935 1917 result = log_ref_setup(refname, log_file, sizeof(log_file));
859c3017
EM
1918 if (result)
1919 return result;
1920
1921 logfd = open(log_file, oflags);
1922 if (logfd < 0)
1923 return 0;
0ec29a47 1924 msglen = msg ? strlen(msg) : 0;
774751a8 1925 committer = git_committer_info(0);
8ac65937
JH
1926 maxlen = strlen(committer) + msglen + 100;
1927 logrec = xmalloc(maxlen);
1928 len = sprintf(logrec, "%s %s %s\n",
9a13f0b7
NP
1929 sha1_to_hex(old_sha1),
1930 sha1_to_hex(new_sha1),
8ac65937
JH
1931 committer);
1932 if (msglen)
0ec29a47 1933 len += copy_msg(logrec + len - 1, msg) - 1;
93822c22 1934 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
6de08ae6 1935 free(logrec);
91c8d590 1936 if (close(logfd) != 0 || written != len)
9a13f0b7 1937 return error("Unable to append to %s", log_file);
6de08ae6
SP
1938 return 0;
1939}
1940
c3b0dec5
LT
1941static int is_branch(const char *refname)
1942{
1943 return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1944}
1945
4bd18c43
SP
1946int write_ref_sha1(struct ref_lock *lock,
1947 const unsigned char *sha1, const char *logmsg)
1948{
1949 static char term = '\n';
c3b0dec5 1950 struct object *o;
4bd18c43
SP
1951
1952 if (!lock)
95fc7512 1953 return -1;
a89fccd2 1954 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
4bd18c43
SP
1955 unlock_ref(lock);
1956 return 0;
95fc7512 1957 }
c3b0dec5
LT
1958 o = parse_object(sha1);
1959 if (!o) {
7be8b3ba 1960 error("Trying to write ref %s with nonexistent object %s",
c3b0dec5
LT
1961 lock->ref_name, sha1_to_hex(sha1));
1962 unlock_ref(lock);
1963 return -1;
1964 }
1965 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1966 error("Trying to write non-commit object %s to branch %s",
1967 sha1_to_hex(sha1), lock->ref_name);
1968 unlock_ref(lock);
1969 return -1;
1970 }
93822c22
AW
1971 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1972 write_in_full(lock->lock_fd, &term, 1) != 1
b531394d 1973 || close_ref(lock) < 0) {
c33d5174 1974 error("Couldn't write %s", lock->lk->filename);
4bd18c43
SP
1975 unlock_ref(lock);
1976 return -1;
1977 }
8bf90dc9 1978 clear_loose_ref_cache(get_ref_cache(NULL));
bd104db1
NP
1979 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1980 (strcmp(lock->ref_name, lock->orig_ref_name) &&
1981 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
6de08ae6
SP
1982 unlock_ref(lock);
1983 return -1;
1984 }
605fac8b
NP
1985 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1986 /*
1987 * Special hack: If a branch is updated directly and HEAD
1988 * points to it (may happen on the remote side of a push
1989 * for example) then logically the HEAD reflog should be
1990 * updated too.
1991 * A generic solution implies reverse symref information,
1992 * but finding all symrefs pointing to the given branch
1993 * would be rather costly for this rare event (the direct
1994 * update of a branch) to be worth it. So let's cheat and
1995 * check with HEAD only which should cover 99% of all usage
1996 * scenarios (even 100% of the default ones).
1997 */
1998 unsigned char head_sha1[20];
1999 int head_flag;
2000 const char *head_ref;
8cad4744 2001 head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
605fac8b
NP
2002 if (head_ref && (head_flag & REF_ISSYMREF) &&
2003 !strcmp(head_ref, lock->ref_name))
2004 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
2005 }
b531394d 2006 if (commit_ref(lock)) {
434cd0cd 2007 error("Couldn't set %s", lock->ref_name);
4bd18c43
SP
2008 unlock_ref(lock);
2009 return -1;
2010 }
4bd18c43
SP
2011 unlock_ref(lock);
2012 return 0;
95fc7512 2013}
d556fae2 2014
8b5157e4
NP
2015int create_symref(const char *ref_target, const char *refs_heads_master,
2016 const char *logmsg)
41b625b0
NP
2017{
2018 const char *lockpath;
2019 char ref[1000];
2020 int fd, len, written;
a4f34cbb 2021 char *git_HEAD = git_pathdup("%s", ref_target);
8b5157e4
NP
2022 unsigned char old_sha1[20], new_sha1[20];
2023
2024 if (logmsg && read_ref(ref_target, old_sha1))
2025 hashclr(old_sha1);
41b625b0 2026
d48744d1
JH
2027 if (safe_create_leading_directories(git_HEAD) < 0)
2028 return error("unable to create directory for %s", git_HEAD);
2029
41b625b0
NP
2030#ifndef NO_SYMLINK_HEAD
2031 if (prefer_symlink_refs) {
2032 unlink(git_HEAD);
2033 if (!symlink(refs_heads_master, git_HEAD))
8b5157e4 2034 goto done;
41b625b0
NP
2035 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
2036 }
2037#endif
2038
2039 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
2040 if (sizeof(ref) <= len) {
2041 error("refname too long: %s", refs_heads_master);
47fc52e2 2042 goto error_free_return;
41b625b0
NP
2043 }
2044 lockpath = mkpath("%s.lock", git_HEAD);
2045 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
2046 if (fd < 0) {
2047 error("Unable to open %s for writing", lockpath);
47fc52e2 2048 goto error_free_return;
41b625b0
NP
2049 }
2050 written = write_in_full(fd, ref, len);
91c8d590 2051 if (close(fd) != 0 || written != len) {
41b625b0 2052 error("Unable to write to %s", lockpath);
47fc52e2 2053 goto error_unlink_return;
41b625b0
NP
2054 }
2055 if (rename(lockpath, git_HEAD) < 0) {
41b625b0 2056 error("Unable to create %s", git_HEAD);
47fc52e2 2057 goto error_unlink_return;
41b625b0
NP
2058 }
2059 if (adjust_shared_perm(git_HEAD)) {
41b625b0 2060 error("Unable to fix permissions on %s", lockpath);
47fc52e2 2061 error_unlink_return:
691f1a28 2062 unlink_or_warn(lockpath);
47fc52e2
JH
2063 error_free_return:
2064 free(git_HEAD);
2065 return -1;
41b625b0 2066 }
8b5157e4 2067
ee96d11b 2068#ifndef NO_SYMLINK_HEAD
8b5157e4 2069 done:
ee96d11b 2070#endif
8b5157e4
NP
2071 if (logmsg && !read_ref(refs_heads_master, new_sha1))
2072 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
2073
47fc52e2 2074 free(git_HEAD);
41b625b0
NP
2075 return 0;
2076}
2077
16d7cc90
JH
2078static char *ref_msg(const char *line, const char *endp)
2079{
2080 const char *ep;
16d7cc90 2081 line += 82;
182af834
PH
2082 ep = memchr(line, '\n', endp - line);
2083 if (!ep)
2084 ep = endp;
2085 return xmemdupz(line, ep - line);
16d7cc90
JH
2086}
2087
dfefa935
MH
2088int read_ref_at(const char *refname, unsigned long at_time, int cnt,
2089 unsigned char *sha1, char **msg,
2090 unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
d556fae2 2091{
e5229042 2092 const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
d556fae2 2093 char *tz_c;
e29cb53a 2094 int logfd, tz, reccnt = 0;
d556fae2
SP
2095 struct stat st;
2096 unsigned long date;
e5229042 2097 unsigned char logged_sha1[20];
cb48cb58 2098 void *log_mapped;
dc49cd76 2099 size_t mapsz;
d556fae2 2100
dfefa935 2101 logfile = git_path("logs/%s", refname);
d556fae2
SP
2102 logfd = open(logfile, O_RDONLY, 0);
2103 if (logfd < 0)
d824cbba 2104 die_errno("Unable to read log '%s'", logfile);
d556fae2
SP
2105 fstat(logfd, &st);
2106 if (!st.st_size)
2107 die("Log %s is empty.", logfile);
dc49cd76
SP
2108 mapsz = xsize_t(st.st_size);
2109 log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
cb48cb58 2110 logdata = log_mapped;
d556fae2
SP
2111 close(logfd);
2112
e5229042 2113 lastrec = NULL;
d556fae2
SP
2114 rec = logend = logdata + st.st_size;
2115 while (logdata < rec) {
e29cb53a 2116 reccnt++;
d556fae2
SP
2117 if (logdata < rec && *(rec-1) == '\n')
2118 rec--;
e5229042
SP
2119 lastgt = NULL;
2120 while (logdata < rec && *(rec-1) != '\n') {
d556fae2 2121 rec--;
e5229042
SP
2122 if (*rec == '>')
2123 lastgt = rec;
2124 }
2125 if (!lastgt)
d556fae2 2126 die("Log %s is corrupt.", logfile);
e5229042 2127 date = strtoul(lastgt + 1, &tz_c, 10);
ab2a1a32 2128 if (date <= at_time || cnt == 0) {
76a44c5c 2129 tz = strtoul(tz_c, NULL, 10);
16d7cc90
JH
2130 if (msg)
2131 *msg = ref_msg(rec, logend);
2132 if (cutoff_time)
2133 *cutoff_time = date;
2134 if (cutoff_tz)
2135 *cutoff_tz = tz;
2136 if (cutoff_cnt)
76a44c5c 2137 *cutoff_cnt = reccnt - 1;
e5229042
SP
2138 if (lastrec) {
2139 if (get_sha1_hex(lastrec, logged_sha1))
2140 die("Log %s is corrupt.", logfile);
2141 if (get_sha1_hex(rec + 41, sha1))
2142 die("Log %s is corrupt.", logfile);
a89fccd2 2143 if (hashcmp(logged_sha1, sha1)) {
edbc25c5 2144 warning("Log %s has gap after %s.",
73013afd 2145 logfile, show_date(date, tz, DATE_RFC2822));
e5229042 2146 }
e5f38ec3
JH
2147 }
2148 else if (date == at_time) {
e5229042
SP
2149 if (get_sha1_hex(rec + 41, sha1))
2150 die("Log %s is corrupt.", logfile);
e5f38ec3
JH
2151 }
2152 else {
e5229042
SP
2153 if (get_sha1_hex(rec + 41, logged_sha1))
2154 die("Log %s is corrupt.", logfile);
a89fccd2 2155 if (hashcmp(logged_sha1, sha1)) {
edbc25c5 2156 warning("Log %s unexpectedly ended on %s.",
73013afd 2157 logfile, show_date(date, tz, DATE_RFC2822));
e5229042
SP
2158 }
2159 }
dc49cd76 2160 munmap(log_mapped, mapsz);
d556fae2
SP
2161 return 0;
2162 }
e5229042 2163 lastrec = rec;
ab2a1a32
JH
2164 if (cnt > 0)
2165 cnt--;
d556fae2
SP
2166 }
2167
e5229042
SP
2168 rec = logdata;
2169 while (rec < logend && *rec != '>' && *rec != '\n')
2170 rec++;
2171 if (rec == logend || *rec == '\n')
d556fae2 2172 die("Log %s is corrupt.", logfile);
e5229042 2173 date = strtoul(rec + 1, &tz_c, 10);
d556fae2
SP
2174 tz = strtoul(tz_c, NULL, 10);
2175 if (get_sha1_hex(logdata, sha1))
2176 die("Log %s is corrupt.", logfile);
d1a4489a
JK
2177 if (is_null_sha1(sha1)) {
2178 if (get_sha1_hex(logdata + 41, sha1))
2179 die("Log %s is corrupt.", logfile);
2180 }
16d7cc90
JH
2181 if (msg)
2182 *msg = ref_msg(logdata, logend);
dc49cd76 2183 munmap(log_mapped, mapsz);
16d7cc90
JH
2184
2185 if (cutoff_time)
2186 *cutoff_time = date;
2187 if (cutoff_tz)
2188 *cutoff_tz = tz;
2189 if (cutoff_cnt)
2190 *cutoff_cnt = reccnt;
2191 return 1;
d556fae2 2192}
2ff81662 2193
dfefa935 2194int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2ff81662
JH
2195{
2196 const char *logfile;
2197 FILE *logfp;
8ca78803 2198 struct strbuf sb = STRBUF_INIT;
2266bf27 2199 int ret = 0;
2ff81662 2200
dfefa935 2201 logfile = git_path("logs/%s", refname);
2ff81662
JH
2202 logfp = fopen(logfile, "r");
2203 if (!logfp)
883d60fa 2204 return -1;
101d15e0
JH
2205
2206 if (ofs) {
2207 struct stat statbuf;
2208 if (fstat(fileno(logfp), &statbuf) ||
2209 statbuf.st_size < ofs ||
2210 fseek(logfp, -ofs, SEEK_END) ||
8ca78803 2211 strbuf_getwholeline(&sb, logfp, '\n')) {
9d33f7c2 2212 fclose(logfp);
8ca78803 2213 strbuf_release(&sb);
101d15e0 2214 return -1;
9d33f7c2 2215 }
101d15e0
JH
2216 }
2217
8ca78803 2218 while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2ff81662 2219 unsigned char osha1[20], nsha1[20];
883d60fa
JS
2220 char *email_end, *message;
2221 unsigned long timestamp;
8ca78803 2222 int tz;
2ff81662
JH
2223
2224 /* old SP new SP name <email> SP time TAB msg LF */
8ca78803
RS
2225 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
2226 get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
2227 get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
2228 !(email_end = strchr(sb.buf + 82, '>')) ||
883d60fa
JS
2229 email_end[1] != ' ' ||
2230 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
2231 !message || message[0] != ' ' ||
2232 (message[1] != '+' && message[1] != '-') ||
2233 !isdigit(message[2]) || !isdigit(message[3]) ||
b4dd4856 2234 !isdigit(message[4]) || !isdigit(message[5]))
2ff81662 2235 continue; /* corrupt? */
883d60fa
JS
2236 email_end[1] = '\0';
2237 tz = strtol(message + 1, NULL, 10);
b4dd4856
JS
2238 if (message[6] != '\t')
2239 message += 6;
2240 else
2241 message += 7;
8ca78803
RS
2242 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
2243 cb_data);
883d60fa 2244 if (ret)
2266bf27 2245 break;
2ff81662
JH
2246 }
2247 fclose(logfp);
8ca78803 2248 strbuf_release(&sb);
2266bf27 2249 return ret;
2ff81662 2250}
e29cb53a 2251
dfefa935 2252int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
101d15e0 2253{
dfefa935 2254 return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
101d15e0
JH
2255}
2256
989c0e5d
MH
2257/*
2258 * Call fn for each reflog in the namespace indicated by name. name
2259 * must be empty or end with '/'. Name will be used as a scratch
2260 * space, but its contents will be restored before return.
2261 */
2262static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
eb8381c8 2263{
989c0e5d 2264 DIR *d = opendir(git_path("logs/%s", name->buf));
fcee5a14 2265 int retval = 0;
93c603fc 2266 struct dirent *de;
989c0e5d 2267 int oldlen = name->len;
eb8381c8 2268
93c603fc 2269 if (!d)
989c0e5d 2270 return name->len ? errno : 0;
eb8381c8 2271
93c603fc
MH
2272 while ((de = readdir(d)) != NULL) {
2273 struct stat st;
eb8381c8 2274
93c603fc
MH
2275 if (de->d_name[0] == '.')
2276 continue;
93c603fc
MH
2277 if (has_extension(de->d_name, ".lock"))
2278 continue;
989c0e5d
MH
2279 strbuf_addstr(name, de->d_name);
2280 if (stat(git_path("logs/%s", name->buf), &st) < 0) {
2281 ; /* silently ignore */
93c603fc 2282 } else {
989c0e5d
MH
2283 if (S_ISDIR(st.st_mode)) {
2284 strbuf_addch(name, '/');
2285 retval = do_for_each_reflog(name, fn, cb_data);
2286 } else {
2287 unsigned char sha1[20];
2288 if (read_ref_full(name->buf, sha1, 0, NULL))
2289 retval = error("bad ref for %s", name->buf);
2290 else
2291 retval = fn(name->buf, sha1, 0, cb_data);
2292 }
2293 if (retval)
2294 break;
eb8381c8 2295 }
989c0e5d 2296 strbuf_setlen(name, oldlen);
eb8381c8 2297 }
93c603fc 2298 closedir(d);
eb8381c8
NP
2299 return retval;
2300}
2301
2302int for_each_reflog(each_ref_fn fn, void *cb_data)
2303{
989c0e5d
MH
2304 int retval;
2305 struct strbuf name;
2306 strbuf_init(&name, PATH_MAX);
2307 retval = do_for_each_reflog(&name, fn, cb_data);
2308 strbuf_release(&name);
2309 return retval;
eb8381c8 2310}
3d9f037c
CR
2311
2312int update_ref(const char *action, const char *refname,
2313 const unsigned char *sha1, const unsigned char *oldval,
2314 int flags, enum action_on_err onerr)
2315{
2316 static struct ref_lock *lock;
2317 lock = lock_any_ref_for_update(refname, oldval, flags);
2318 if (!lock) {
2319 const char *str = "Cannot lock the ref '%s'.";
2320 switch (onerr) {
2321 case MSG_ON_ERR: error(str, refname); break;
2322 case DIE_ON_ERR: die(str, refname); break;
2323 case QUIET_ON_ERR: break;
2324 }
2325 return 1;
2326 }
2327 if (write_ref_sha1(lock, sha1, action) < 0) {
2328 const char *str = "Cannot update the ref '%s'.";
2329 switch (onerr) {
2330 case MSG_ON_ERR: error(str, refname); break;
2331 case DIE_ON_ERR: die(str, refname); break;
2332 case QUIET_ON_ERR: break;
2333 }
2334 return 1;
2335 }
2336 return 0;
2337}
cda69f48 2338
5483f799 2339struct ref *find_ref_by_name(const struct ref *list, const char *name)
cda69f48
JK
2340{
2341 for ( ; list; list = list->next)
2342 if (!strcmp(list->name, name))
5483f799 2343 return (struct ref *)list;
cda69f48
JK
2344 return NULL;
2345}
7c2b3029
JK
2346
2347/*
2348 * generate a format suitable for scanf from a ref_rev_parse_rules
2349 * rule, that is replace the "%.*s" spec with a "%s" spec
2350 */
2351static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
2352{
2353 char *spec;
2354
2355 spec = strstr(rule, "%.*s");
2356 if (!spec || strstr(spec + 4, "%.*s"))
2357 die("invalid rule in ref_rev_parse_rules: %s", rule);
2358
2359 /* copy all until spec */
2360 strncpy(scanf_fmt, rule, spec - rule);
2361 scanf_fmt[spec - rule] = '\0';
2362 /* copy new spec */
2363 strcat(scanf_fmt, "%s");
2364 /* copy remaining rule */
2365 strcat(scanf_fmt, spec + 4);
2366
2367 return;
2368}
2369
dfefa935 2370char *shorten_unambiguous_ref(const char *refname, int strict)
7c2b3029
JK
2371{
2372 int i;
2373 static char **scanf_fmts;
2374 static int nr_rules;
2375 char *short_name;
2376
2377 /* pre generate scanf formats from ref_rev_parse_rules[] */
2378 if (!nr_rules) {
2379 size_t total_len = 0;
2380
2381 /* the rule list is NULL terminated, count them first */
2382 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
2383 /* no +1 because strlen("%s") < strlen("%.*s") */
2384 total_len += strlen(ref_rev_parse_rules[nr_rules]);
2385
2386 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
2387
2388 total_len = 0;
2389 for (i = 0; i < nr_rules; i++) {
2390 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
2391 + total_len;
2392 gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
2393 total_len += strlen(ref_rev_parse_rules[i]);
2394 }
2395 }
2396
2397 /* bail out if there are no rules */
2398 if (!nr_rules)
dfefa935 2399 return xstrdup(refname);
7c2b3029 2400
dfefa935
MH
2401 /* buffer for scanf result, at most refname must fit */
2402 short_name = xstrdup(refname);
7c2b3029
JK
2403
2404 /* skip first rule, it will always match */
2405 for (i = nr_rules - 1; i > 0 ; --i) {
2406 int j;
6e7b3309 2407 int rules_to_fail = i;
7c2b3029
JK
2408 int short_name_len;
2409
dfefa935 2410 if (1 != sscanf(refname, scanf_fmts[i], short_name))
7c2b3029
JK
2411 continue;
2412
2413 short_name_len = strlen(short_name);
2414
6e7b3309
BW
2415 /*
2416 * in strict mode, all (except the matched one) rules
2417 * must fail to resolve to a valid non-ambiguous ref
2418 */
2419 if (strict)
2420 rules_to_fail = nr_rules;
2421
7c2b3029
JK
2422 /*
2423 * check if the short name resolves to a valid ref,
2424 * but use only rules prior to the matched one
2425 */
6e7b3309 2426 for (j = 0; j < rules_to_fail; j++) {
7c2b3029 2427 const char *rule = ref_rev_parse_rules[j];
7c2b3029
JK
2428 char refname[PATH_MAX];
2429
6e7b3309
BW
2430 /* skip matched rule */
2431 if (i == j)
2432 continue;
2433
7c2b3029
JK
2434 /*
2435 * the short name is ambiguous, if it resolves
2436 * (with this previous rule) to a valid ref
2437 * read_ref() returns 0 on success
2438 */
2439 mksnpath(refname, sizeof(refname),
2440 rule, short_name_len, short_name);
c6893323 2441 if (ref_exists(refname))
7c2b3029
JK
2442 break;
2443 }
2444
2445 /*
2446 * short name is non-ambiguous if all previous rules
2447 * haven't resolved to a valid ref
2448 */
6e7b3309 2449 if (j == rules_to_fail)
7c2b3029
JK
2450 return short_name;
2451 }
2452
2453 free(short_name);
dfefa935 2454 return xstrdup(refname);
7c2b3029 2455}