]> git.ipfire.org Git - thirdparty/git.git/blame - refs.c
resolve_ref(): explicitly fail if a symlink is not readable
[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
f4204ab9
JH
7/* ISSYMREF=01 and ISPACKED=02 are public interfaces */
8#define REF_KNOWS_PEELED 04
e01de1c9 9#define REF_BROKEN 010
f4204ab9 10
e1e22e37
LT
11struct ref_list {
12 struct ref_list *next;
f4204ab9 13 unsigned char flag; /* ISSYMREF? ISPACKED? */
e1e22e37 14 unsigned char sha1[20];
f4204ab9 15 unsigned char peeled[20];
e1e22e37
LT
16 char name[FLEX_ARRAY];
17};
18
f4204ab9 19static const char *parse_ref_line(char *line, unsigned char *sha1)
e1e22e37
LT
20{
21 /*
22 * 42: the answer to everything.
23 *
24 * In this case, it happens to be the answer to
25 * 40 (length of sha1 hex representation)
26 * +1 (space in between hex and name)
27 * +1 (newline at the end of the line)
28 */
29 int len = strlen(line) - 42;
30
31 if (len <= 0)
32 return NULL;
33 if (get_sha1_hex(line, sha1) < 0)
34 return NULL;
35 if (!isspace(line[40]))
36 return NULL;
37 line += 41;
f4204ab9
JH
38 if (isspace(*line))
39 return NULL;
e1e22e37
LT
40 if (line[len] != '\n')
41 return NULL;
42 line[len] = 0;
cf0adba7 43
e1e22e37
LT
44 return line;
45}
46
8da19775 47static struct ref_list *add_ref(const char *name, const unsigned char *sha1,
f4204ab9
JH
48 int flag, struct ref_list *list,
49 struct ref_list **new_entry)
e1e22e37
LT
50{
51 int len;
c774aab9 52 struct ref_list *entry;
e1e22e37
LT
53
54 /* Allocate it and add it in.. */
55 len = strlen(name) + 1;
56 entry = xmalloc(sizeof(struct ref_list) + len);
57 hashcpy(entry->sha1, sha1);
f4204ab9 58 hashclr(entry->peeled);
e1e22e37 59 memcpy(entry->name, name, len);
8da19775 60 entry->flag = flag;
c774aab9 61 entry->next = list;
f4204ab9
JH
62 if (new_entry)
63 *new_entry = entry;
c774aab9
JP
64 return entry;
65}
66
67/* merge sort the ref list */
68static struct ref_list *sort_ref_list(struct ref_list *list)
69{
70 int psize, qsize, last_merge_count, cmp;
71 struct ref_list *p, *q, *l, *e;
72 struct ref_list *new_list = list;
73 int k = 1;
74 int merge_count = 0;
75
76 if (!list)
77 return list;
78
79 do {
80 last_merge_count = merge_count;
81 merge_count = 0;
82
83 psize = 0;
84
85 p = new_list;
86 q = new_list;
87 new_list = NULL;
88 l = NULL;
89
90 while (p) {
91 merge_count++;
92
93 while (psize < k && q->next) {
94 q = q->next;
95 psize++;
96 }
97 qsize = k;
98
99 while ((psize > 0) || (qsize > 0 && q)) {
100 if (qsize == 0 || !q) {
101 e = p;
102 p = p->next;
103 psize--;
104 } else if (psize == 0) {
105 e = q;
106 q = q->next;
107 qsize--;
108 } else {
109 cmp = strcmp(q->name, p->name);
110 if (cmp < 0) {
111 e = q;
112 q = q->next;
113 qsize--;
114 } else if (cmp > 0) {
115 e = p;
116 p = p->next;
117 psize--;
118 } else {
119 if (hashcmp(q->sha1, p->sha1))
120 die("Duplicated ref, and SHA1s don't match: %s",
121 q->name);
122 warning("Duplicated ref: %s", q->name);
123 e = q;
124 q = q->next;
125 qsize--;
126 free(e);
127 e = p;
128 p = p->next;
129 psize--;
130 }
131 }
132
133 e->next = NULL;
134
135 if (l)
136 l->next = e;
137 if (!new_list)
138 new_list = e;
139 l = e;
140 }
141
142 p = q;
143 };
144
145 k = k * 2;
146 } while ((last_merge_count != merge_count) || (last_merge_count != 1));
147
148 return new_list;
e1e22e37
LT
149}
150
5e290ff7
JH
151/*
152 * Future: need to be in "struct repository"
153 * when doing a full libification.
154 */
4175e9e3 155static struct cached_refs {
5e290ff7
JH
156 char did_loose;
157 char did_packed;
158 struct ref_list *loose;
159 struct ref_list *packed;
0bad611b 160} cached_refs, submodule_refs;
0ae91be0 161static struct ref_list *current_ref;
5e290ff7 162
e142a3c6
DB
163static struct ref_list *extra_refs;
164
5e290ff7
JH
165static void free_ref_list(struct ref_list *list)
166{
167 struct ref_list *next;
168 for ( ; list; list = next) {
169 next = list->next;
170 free(list);
171 }
172}
173
174static void invalidate_cached_refs(void)
e1e22e37 175{
5e290ff7
JH
176 struct cached_refs *ca = &cached_refs;
177
178 if (ca->did_loose && ca->loose)
179 free_ref_list(ca->loose);
180 if (ca->did_packed && ca->packed)
181 free_ref_list(ca->packed);
182 ca->loose = ca->packed = NULL;
183 ca->did_loose = ca->did_packed = 0;
184}
e1e22e37 185
f4204ab9
JH
186static void read_packed_refs(FILE *f, struct cached_refs *cached_refs)
187{
188 struct ref_list *list = NULL;
189 struct ref_list *last = NULL;
190 char refline[PATH_MAX];
191 int flag = REF_ISPACKED;
192
193 while (fgets(refline, sizeof(refline), f)) {
194 unsigned char sha1[20];
195 const char *name;
196 static const char header[] = "# pack-refs with:";
197
198 if (!strncmp(refline, header, sizeof(header)-1)) {
199 const char *traits = refline + sizeof(header) - 1;
200 if (strstr(traits, " peeled "))
201 flag |= REF_KNOWS_PEELED;
202 /* perhaps other traits later as well */
203 continue;
204 }
205
206 name = parse_ref_line(refline, sha1);
207 if (name) {
208 list = add_ref(name, sha1, flag, list, &last);
209 continue;
210 }
211 if (last &&
212 refline[0] == '^' &&
213 strlen(refline) == 42 &&
214 refline[41] == '\n' &&
215 !get_sha1_hex(refline + 1, sha1))
216 hashcpy(last->peeled, sha1);
217 }
c774aab9 218 cached_refs->packed = sort_ref_list(list);
f4204ab9
JH
219}
220
e142a3c6
DB
221void add_extra_ref(const char *name, const unsigned char *sha1, int flag)
222{
223 extra_refs = add_ref(name, sha1, flag, extra_refs, NULL);
224}
225
226void clear_extra_refs(void)
227{
228 free_ref_list(extra_refs);
229 extra_refs = NULL;
230}
231
0bad611b 232static struct ref_list *get_packed_refs(const char *submodule)
5e290ff7 233{
0bad611b
HV
234 const char *packed_refs_file;
235 struct cached_refs *refs;
236
237 if (submodule) {
238 packed_refs_file = git_path_submodule(submodule, "packed-refs");
239 refs = &submodule_refs;
240 free_ref_list(refs->packed);
241 } else {
242 packed_refs_file = git_path("packed-refs");
243 refs = &cached_refs;
244 }
245
246 if (!refs->did_packed || submodule) {
247 FILE *f = fopen(packed_refs_file, "r");
248 refs->packed = NULL;
e1e22e37 249 if (f) {
0bad611b 250 read_packed_refs(f, refs);
e1e22e37 251 fclose(f);
e1e22e37 252 }
0bad611b 253 refs->did_packed = 1;
e1e22e37 254 }
0bad611b 255 return refs->packed;
e1e22e37
LT
256}
257
0bad611b
HV
258static struct ref_list *get_ref_dir(const char *submodule, const char *base,
259 struct ref_list *list)
e1e22e37 260{
0bad611b
HV
261 DIR *dir;
262 const char *path;
263
264 if (submodule)
265 path = git_path_submodule(submodule, "%s", base);
266 else
267 path = git_path("%s", base);
268
269
270 dir = opendir(path);
e1e22e37
LT
271
272 if (dir) {
273 struct dirent *de;
274 int baselen = strlen(base);
ed378ec7 275 char *ref = xmalloc(baselen + 257);
e1e22e37 276
ed378ec7 277 memcpy(ref, base, baselen);
e1e22e37 278 if (baselen && base[baselen-1] != '/')
ed378ec7 279 ref[baselen++] = '/';
e1e22e37
LT
280
281 while ((de = readdir(dir)) != NULL) {
282 unsigned char sha1[20];
283 struct stat st;
8da19775 284 int flag;
e1e22e37 285 int namelen;
0bad611b 286 const char *refdir;
e1e22e37
LT
287
288 if (de->d_name[0] == '.')
289 continue;
290 namelen = strlen(de->d_name);
291 if (namelen > 255)
292 continue;
293 if (has_extension(de->d_name, ".lock"))
294 continue;
ed378ec7 295 memcpy(ref + baselen, de->d_name, namelen+1);
0bad611b
HV
296 refdir = submodule
297 ? git_path_submodule(submodule, "%s", ref)
298 : git_path("%s", ref);
299 if (stat(refdir, &st) < 0)
e1e22e37
LT
300 continue;
301 if (S_ISDIR(st.st_mode)) {
0bad611b 302 list = get_ref_dir(submodule, ref, list);
e1e22e37
LT
303 continue;
304 }
0bad611b 305 if (submodule) {
f8948e2f 306 hashclr(sha1);
0bad611b
HV
307 flag = 0;
308 if (resolve_gitlink_ref(submodule, ref, sha1) < 0) {
309 hashclr(sha1);
310 flag |= REF_BROKEN;
311 }
312 } else
313 if (!resolve_ref(ref, sha1, 1, &flag)) {
314 hashclr(sha1);
315 flag |= REF_BROKEN;
316 }
f4204ab9 317 list = add_ref(ref, sha1, flag, list, NULL);
e1e22e37 318 }
ed378ec7 319 free(ref);
e1e22e37
LT
320 closedir(dir);
321 }
c774aab9 322 return sort_ref_list(list);
e1e22e37
LT
323}
324
f8948e2f 325struct warn_if_dangling_data {
3cf6134a 326 FILE *fp;
f8948e2f
JH
327 const char *refname;
328 const char *msg_fmt;
329};
330
331static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
332 int flags, void *cb_data)
333{
334 struct warn_if_dangling_data *d = cb_data;
335 const char *resolves_to;
336 unsigned char junk[20];
337
338 if (!(flags & REF_ISSYMREF))
339 return 0;
340
341 resolves_to = resolve_ref(refname, junk, 0, NULL);
342 if (!resolves_to || strcmp(resolves_to, d->refname))
343 return 0;
344
3cf6134a 345 fprintf(d->fp, d->msg_fmt, refname);
f8948e2f
JH
346 return 0;
347}
348
3cf6134a 349void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
f8948e2f 350{
66dbfd55
GV
351 struct warn_if_dangling_data data;
352
353 data.fp = fp;
354 data.refname = refname;
355 data.msg_fmt = msg_fmt;
f8948e2f
JH
356 for_each_rawref(warn_if_dangling_symref, &data);
357}
358
0bad611b 359static struct ref_list *get_loose_refs(const char *submodule)
e1e22e37 360{
0bad611b
HV
361 if (submodule) {
362 free_ref_list(submodule_refs.loose);
363 submodule_refs.loose = get_ref_dir(submodule, "refs", NULL);
364 return submodule_refs.loose;
365 }
366
5e290ff7 367 if (!cached_refs.did_loose) {
0bad611b 368 cached_refs.loose = get_ref_dir(NULL, "refs", NULL);
5e290ff7 369 cached_refs.did_loose = 1;
e1e22e37 370 }
5e290ff7 371 return cached_refs.loose;
e1e22e37
LT
372}
373
ca8db142
LT
374/* We allow "recursive" symbolic refs. Only within reason, though */
375#define MAXDEPTH 5
0ebde32c
LT
376#define MAXREFLEN (1024)
377
378static int resolve_gitlink_packed_ref(char *name, int pathlen, const char *refname, unsigned char *result)
379{
380 FILE *f;
381 struct cached_refs refs;
382 struct ref_list *ref;
383 int retval;
384
385 strcpy(name + pathlen, "packed-refs");
386 f = fopen(name, "r");
387 if (!f)
388 return -1;
389 read_packed_refs(f, &refs);
390 fclose(f);
391 ref = refs.packed;
392 retval = -1;
393 while (ref) {
394 if (!strcmp(ref->name, refname)) {
395 retval = 0;
396 memcpy(result, ref->sha1, 20);
397 break;
398 }
399 ref = ref->next;
400 }
401 free_ref_list(refs.packed);
402 return retval;
403}
404
405static int resolve_gitlink_ref_recursive(char *name, int pathlen, const char *refname, unsigned char *result, int recursion)
406{
407 int fd, len = strlen(refname);
408 char buffer[128], *p;
409
410 if (recursion > MAXDEPTH || len > MAXREFLEN)
411 return -1;
412 memcpy(name + pathlen, refname, len+1);
413 fd = open(name, O_RDONLY);
414 if (fd < 0)
415 return resolve_gitlink_packed_ref(name, pathlen, refname, result);
416
417 len = read(fd, buffer, sizeof(buffer)-1);
418 close(fd);
419 if (len < 0)
420 return -1;
421 while (len && isspace(buffer[len-1]))
422 len--;
423 buffer[len] = 0;
424
425 /* Was it a detached head or an old-fashioned symlink? */
426 if (!get_sha1_hex(buffer, result))
427 return 0;
428
429 /* Symref? */
430 if (strncmp(buffer, "ref:", 4))
431 return -1;
432 p = buffer + 4;
433 while (isspace(*p))
434 p++;
435
436 return resolve_gitlink_ref_recursive(name, pathlen, p, result, recursion+1);
437}
438
439int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *result)
440{
441 int len = strlen(path), retval;
442 char *gitdir;
842abf06 443 const char *tmp;
0ebde32c
LT
444
445 while (len && path[len-1] == '/')
446 len--;
447 if (!len)
448 return -1;
449 gitdir = xmalloc(len + MAXREFLEN + 8);
450 memcpy(gitdir, path, len);
842abf06
LH
451 memcpy(gitdir + len, "/.git", 6);
452 len += 5;
453
13d6ec91 454 tmp = read_gitfile(gitdir);
842abf06
LH
455 if (tmp) {
456 free(gitdir);
457 len = strlen(tmp);
458 gitdir = xmalloc(len + MAXREFLEN + 3);
459 memcpy(gitdir, tmp, len);
460 }
461 gitdir[len] = '/';
462 gitdir[++len] = '\0';
463 retval = resolve_gitlink_ref_recursive(gitdir, len, refname, result, 0);
0ebde32c
LT
464 free(gitdir);
465 return retval;
466}
ca8db142 467
4886b89f
CC
468/*
469 * If the "reading" argument is set, this function finds out what _object_
470 * the ref points at by "reading" the ref. The ref, if it is not symbolic,
471 * has to exist, and if it is symbolic, it has to point at an existing ref,
472 * because the "read" goes through the symref to the ref it points at.
473 *
474 * The access that is not "reading" may often be "writing", but does not
475 * have to; it can be merely checking _where it leads to_. If it is a
476 * prelude to "writing" to the ref, a write to a symref that points at
477 * yet-to-be-born ref will create the real ref pointed by the symref.
478 * reading=0 allows the caller to check where such a symref leads to.
479 */
8da19775 480const char *resolve_ref(const char *ref, unsigned char *sha1, int reading, int *flag)
8a65ff76 481{
0104ca09
HO
482 int depth = MAXDEPTH;
483 ssize_t len;
a876ed83 484 char buffer[256];
ed378ec7 485 static char ref_buffer[256];
ca8db142 486
8da19775
JH
487 if (flag)
488 *flag = 0;
489
a876ed83 490 for (;;) {
958a4789 491 char path[PATH_MAX];
a876ed83
JH
492 struct stat st;
493 char *buf;
494 int fd;
8a65ff76 495
a876ed83
JH
496 if (--depth < 0)
497 return NULL;
ca8db142 498
958a4789 499 git_snpath(path, sizeof(path), "%s", ref);
4886b89f 500 /* Special case: non-existing file. */
a876ed83 501 if (lstat(path, &st) < 0) {
0bad611b 502 struct ref_list *list = get_packed_refs(NULL);
434cd0cd 503 while (list) {
f4204ab9 504 if (!strcmp(ref, list->name)) {
434cd0cd 505 hashcpy(sha1, list->sha1);
8da19775
JH
506 if (flag)
507 *flag |= REF_ISPACKED;
434cd0cd
LT
508 return ref;
509 }
510 list = list->next;
511 }
a876ed83
JH
512 if (reading || errno != ENOENT)
513 return NULL;
e702496e 514 hashclr(sha1);
ed378ec7 515 return ref;
a876ed83 516 }
ca8db142 517
a876ed83
JH
518 /* Follow "normalized" - ie "refs/.." symlinks by hand */
519 if (S_ISLNK(st.st_mode)) {
520 len = readlink(path, buffer, sizeof(buffer)-1);
7bb2bf8e
MH
521 if (len < 0)
522 return NULL;
a876ed83 523 if (len >= 5 && !memcmp("refs/", buffer, 5)) {
ed378ec7
LT
524 buffer[len] = 0;
525 strcpy(ref_buffer, buffer);
526 ref = ref_buffer;
8da19775
JH
527 if (flag)
528 *flag |= REF_ISSYMREF;
a876ed83
JH
529 continue;
530 }
ca8db142 531 }
a876ed83 532
7a21632f
DS
533 /* Is it a directory? */
534 if (S_ISDIR(st.st_mode)) {
535 errno = EISDIR;
536 return NULL;
537 }
538
a876ed83
JH
539 /*
540 * Anything else, just open it and try to use it as
541 * a ref
542 */
543 fd = open(path, O_RDONLY);
544 if (fd < 0)
545 return NULL;
93d26e4c 546 len = read_in_full(fd, buffer, sizeof(buffer)-1);
a876ed83
JH
547 close(fd);
548
549 /*
550 * Is it a symbolic ref?
551 */
552 if (len < 4 || memcmp("ref:", buffer, 4))
553 break;
554 buf = buffer + 4;
555 len -= 4;
556 while (len && isspace(*buf))
557 buf++, len--;
558 while (len && isspace(buf[len-1]))
ed378ec7
LT
559 len--;
560 buf[len] = 0;
561 memcpy(ref_buffer, buf, len + 1);
562 ref = ref_buffer;
8da19775
JH
563 if (flag)
564 *flag |= REF_ISSYMREF;
8a65ff76 565 }
a876ed83
JH
566 if (len < 40 || get_sha1_hex(buffer, sha1))
567 return NULL;
ed378ec7 568 return ref;
a876ed83
JH
569}
570
d08bae7e
IL
571/* The argument to filter_refs */
572struct ref_filter {
573 const char *pattern;
574 each_ref_fn *fn;
575 void *cb_data;
576};
577
ed378ec7 578int read_ref(const char *ref, unsigned char *sha1)
a876ed83 579{
8da19775 580 if (resolve_ref(ref, sha1, 1, NULL))
a876ed83
JH
581 return 0;
582 return -1;
8a65ff76
LT
583}
584
f8948e2f 585#define DO_FOR_EACH_INCLUDE_BROKEN 01
ef06b918 586static int do_one_ref(const char *base, each_ref_fn fn, int trim,
f8948e2f 587 int flags, void *cb_data, struct ref_list *entry)
ef06b918 588{
b3cfc406 589 if (prefixcmp(entry->name, base))
ef06b918 590 return 0;
e01de1c9 591
f8948e2f 592 if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
e01de1c9
JH
593 if (entry->flag & REF_BROKEN)
594 return 0; /* ignore dangling symref */
f8948e2f
JH
595 if (!has_sha1_file(entry->sha1)) {
596 error("%s does not point to a valid object!", entry->name);
597 return 0;
598 }
ef06b918 599 }
0ae91be0 600 current_ref = entry;
ef06b918
JH
601 return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
602}
603
d08bae7e
IL
604static int filter_refs(const char *ref, const unsigned char *sha, int flags,
605 void *data)
606{
607 struct ref_filter *filter = (struct ref_filter *)data;
608 if (fnmatch(filter->pattern, ref, 0))
609 return 0;
610 return filter->fn(ref, sha, flags, filter->cb_data);
611}
612
cf0adba7
JH
613int peel_ref(const char *ref, unsigned char *sha1)
614{
615 int flag;
616 unsigned char base[20];
617 struct object *o;
618
0ae91be0
SP
619 if (current_ref && (current_ref->name == ref
620 || !strcmp(current_ref->name, ref))) {
621 if (current_ref->flag & REF_KNOWS_PEELED) {
622 hashcpy(sha1, current_ref->peeled);
623 return 0;
624 }
625 hashcpy(base, current_ref->sha1);
626 goto fallback;
627 }
628
cf0adba7
JH
629 if (!resolve_ref(ref, base, 1, &flag))
630 return -1;
631
632 if ((flag & REF_ISPACKED)) {
0bad611b 633 struct ref_list *list = get_packed_refs(NULL);
cf0adba7
JH
634
635 while (list) {
f4204ab9
JH
636 if (!strcmp(list->name, ref)) {
637 if (list->flag & REF_KNOWS_PEELED) {
638 hashcpy(sha1, list->peeled);
639 return 0;
640 }
641 /* older pack-refs did not leave peeled ones */
642 break;
cf0adba7
JH
643 }
644 list = list->next;
645 }
cf0adba7
JH
646 }
647
0ae91be0 648fallback:
cf0adba7 649 o = parse_object(base);
8c87dc77 650 if (o && o->type == OBJ_TAG) {
cf0adba7
JH
651 o = deref_tag(o, ref, 0);
652 if (o) {
653 hashcpy(sha1, o->sha1);
654 return 0;
655 }
656 }
657 return -1;
658}
659
0bad611b
HV
660static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
661 int trim, int flags, void *cb_data)
8a65ff76 662{
0ae91be0 663 int retval = 0;
0bad611b
HV
664 struct ref_list *packed = get_packed_refs(submodule);
665 struct ref_list *loose = get_loose_refs(submodule);
8a65ff76 666
e142a3c6
DB
667 struct ref_list *extra;
668
669 for (extra = extra_refs; extra; extra = extra->next)
f8948e2f 670 retval = do_one_ref(base, fn, trim, flags, cb_data, extra);
e142a3c6 671
e1e22e37
LT
672 while (packed && loose) {
673 struct ref_list *entry;
674 int cmp = strcmp(packed->name, loose->name);
675 if (!cmp) {
676 packed = packed->next;
677 continue;
6cada6a9 678 }
e1e22e37
LT
679 if (cmp > 0) {
680 entry = loose;
681 loose = loose->next;
682 } else {
683 entry = packed;
684 packed = packed->next;
685 }
f8948e2f 686 retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
e1e22e37 687 if (retval)
0ae91be0 688 goto end_each;
e1e22e37 689 }
8a65ff76 690
ef06b918 691 for (packed = packed ? packed : loose; packed; packed = packed->next) {
f8948e2f 692 retval = do_one_ref(base, fn, trim, flags, cb_data, packed);
ef06b918 693 if (retval)
0ae91be0 694 goto end_each;
8a65ff76 695 }
0ae91be0
SP
696
697end_each:
698 current_ref = NULL;
699 return retval;
8a65ff76
LT
700}
701
0bad611b
HV
702
703static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
723c31fe
LT
704{
705 unsigned char sha1[20];
8da19775
JH
706 int flag;
707
0bad611b
HV
708 if (submodule) {
709 if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
710 return fn("HEAD", sha1, 0, cb_data);
711
712 return 0;
713 }
714
8da19775
JH
715 if (resolve_ref("HEAD", sha1, 1, &flag))
716 return fn("HEAD", sha1, flag, cb_data);
0bad611b 717
2f34ba32 718 return 0;
723c31fe
LT
719}
720
0bad611b
HV
721int head_ref(each_ref_fn fn, void *cb_data)
722{
723 return do_head_ref(NULL, fn, cb_data);
724}
725
9ef6aeb0
HV
726int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
727{
728 return do_head_ref(submodule, fn, cb_data);
729}
730
cb5d709f 731int for_each_ref(each_ref_fn fn, void *cb_data)
8a65ff76 732{
b3cfc406 733 return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
a62be77f
SE
734}
735
9ef6aeb0
HV
736int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
737{
b3cfc406 738 return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
a62be77f
SE
739}
740
2a8177b6
CC
741int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
742{
0bad611b 743 return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
2a8177b6
CC
744}
745
9ef6aeb0
HV
746int for_each_ref_in_submodule(const char *submodule, const char *prefix,
747 each_ref_fn fn, void *cb_data)
748{
749 return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
2a8177b6
CC
750}
751
cb5d709f 752int for_each_tag_ref(each_ref_fn fn, void *cb_data)
a62be77f 753{
2a8177b6 754 return for_each_ref_in("refs/tags/", fn, cb_data);
a62be77f
SE
755}
756
9ef6aeb0
HV
757int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
758{
759 return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
760}
761
cb5d709f 762int for_each_branch_ref(each_ref_fn fn, void *cb_data)
a62be77f 763{
2a8177b6 764 return for_each_ref_in("refs/heads/", fn, cb_data);
a62be77f
SE
765}
766
9ef6aeb0
HV
767int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
768{
769 return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
770}
771
cb5d709f 772int for_each_remote_ref(each_ref_fn fn, void *cb_data)
a62be77f 773{
2a8177b6 774 return for_each_ref_in("refs/remotes/", fn, cb_data);
f8948e2f
JH
775}
776
9ef6aeb0
HV
777int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
778{
779 return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
780}
781
29268700
CC
782int for_each_replace_ref(each_ref_fn fn, void *cb_data)
783{
0bad611b 784 return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
29268700
CC
785}
786
a1bea2c1
JT
787int head_ref_namespaced(each_ref_fn fn, void *cb_data)
788{
789 struct strbuf buf = STRBUF_INIT;
790 int ret = 0;
791 unsigned char sha1[20];
792 int flag;
793
794 strbuf_addf(&buf, "%sHEAD", get_git_namespace());
795 if (resolve_ref(buf.buf, sha1, 1, &flag))
796 ret = fn(buf.buf, sha1, flag, cb_data);
797 strbuf_release(&buf);
798
799 return ret;
800}
801
802int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
803{
804 struct strbuf buf = STRBUF_INIT;
805 int ret;
806 strbuf_addf(&buf, "%srefs/", get_git_namespace());
807 ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
808 strbuf_release(&buf);
809 return ret;
810}
811
b09fe971
IL
812int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
813 const char *prefix, void *cb_data)
d08bae7e
IL
814{
815 struct strbuf real_pattern = STRBUF_INIT;
816 struct ref_filter filter;
d08bae7e
IL
817 int ret;
818
b09fe971 819 if (!prefix && prefixcmp(pattern, "refs/"))
d08bae7e 820 strbuf_addstr(&real_pattern, "refs/");
b09fe971
IL
821 else if (prefix)
822 strbuf_addstr(&real_pattern, prefix);
d08bae7e
IL
823 strbuf_addstr(&real_pattern, pattern);
824
894a9d33 825 if (!has_glob_specials(pattern)) {
9517e6b8 826 /* Append implied '/' '*' if not present. */
d08bae7e
IL
827 if (real_pattern.buf[real_pattern.len - 1] != '/')
828 strbuf_addch(&real_pattern, '/');
829 /* No need to check for '*', there is none. */
830 strbuf_addch(&real_pattern, '*');
831 }
832
833 filter.pattern = real_pattern.buf;
834 filter.fn = fn;
835 filter.cb_data = cb_data;
836 ret = for_each_ref(filter_refs, &filter);
837
838 strbuf_release(&real_pattern);
839 return ret;
840}
841
b09fe971
IL
842int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
843{
844 return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
845}
846
f8948e2f
JH
847int for_each_rawref(each_ref_fn fn, void *cb_data)
848{
b3cfc406 849 return do_for_each_ref(NULL, "", fn, 0,
f8948e2f 850 DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
8a65ff76
LT
851}
852
03feddd6
JH
853/*
854 * Make sure "ref" is something reasonable to have under ".git/refs/";
855 * We do not like it if:
856 *
857 * - any path component of it begins with ".", or
858 * - it has double dots "..", or
859 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
860 * - it ends with a "/".
3e262b95 861 * - it ends with ".lock"
a4c2e699 862 * - it contains a "\" (backslash)
03feddd6
JH
863 */
864
9224b73b 865/* Return true iff ch is not allowed in reference names. */
03feddd6
JH
866static inline int bad_ref_char(int ch)
867{
f3738c1c 868 if (((unsigned) ch) <= ' ' || ch == 0x7f ||
a4c2e699 869 ch == '~' || ch == '^' || ch == ':' || ch == '\\')
8558fd9e
DB
870 return 1;
871 /* 2.13 Pattern Matching Notation */
9224b73b 872 if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
8558fd9e 873 return 1;
8558fd9e 874 return 0;
03feddd6
JH
875}
876
49295d4e
MH
877/*
878 * Try to read one refname component from the front of ref. Return
879 * the length of the component found, or -1 if the component is not
880 * legal.
881 */
882static int check_refname_component(const char *ref)
883{
884 const char *cp;
885 char last = '\0';
886
887 for (cp = ref; ; cp++) {
888 char ch = *cp;
889 if (ch == '\0' || ch == '/')
890 break;
891 if (bad_ref_char(ch))
892 return -1; /* Illegal character in refname. */
893 if (last == '.' && ch == '.')
894 return -1; /* Refname contains "..". */
895 if (last == '@' && ch == '{')
896 return -1; /* Refname contains "@{". */
897 last = ch;
898 }
899 if (cp == ref)
900 return -1; /* Component has zero length. */
901 if (ref[0] == '.')
902 return -1; /* Component starts with '.'. */
7e9d2fe9
MH
903 if (cp - ref >= 5 && !memcmp(cp - 5, ".lock", 5))
904 return -1; /* Refname ends with ".lock". */
49295d4e
MH
905 return cp - ref;
906}
907
8d9c5010 908int check_refname_format(const char *ref, int flags)
95fc7512 909{
49295d4e 910 int component_len, component_count = 0;
03feddd6 911
03feddd6 912 while (1) {
49295d4e
MH
913 /* We are at the start of a path component. */
914 component_len = check_refname_component(ref);
915 if (component_len < 0) {
916 if ((flags & REFNAME_REFSPEC_PATTERN) &&
917 ref[0] == '*' &&
918 (ref[1] == '\0' || ref[1] == '/')) {
8d9c5010
MH
919 /* Accept one wildcard as a full refname component. */
920 flags &= ~REFNAME_REFSPEC_PATTERN;
49295d4e
MH
921 component_len = 1;
922 } else {
8d9c5010 923 return -1;
49295d4e 924 }
03feddd6 925 }
49295d4e
MH
926 component_count++;
927 if (ref[component_len] == '\0')
928 break;
929 /* Skip to next component. */
930 ref += component_len + 1;
03feddd6 931 }
49295d4e
MH
932
933 if (ref[component_len - 1] == '.')
934 return -1; /* Refname ends with '.'. */
49295d4e
MH
935 if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
936 return -1; /* Refname has only one component. */
937 return 0;
95fc7512
DB
938}
939
4577e483 940const char *prettify_refname(const char *name)
a9c37a72 941{
a9c37a72
DB
942 return name + (
943 !prefixcmp(name, "refs/heads/") ? 11 :
944 !prefixcmp(name, "refs/tags/") ? 10 :
945 !prefixcmp(name, "refs/remotes/") ? 13 :
946 0);
947}
948
79803322
SP
949const char *ref_rev_parse_rules[] = {
950 "%.*s",
951 "refs/%.*s",
952 "refs/tags/%.*s",
953 "refs/heads/%.*s",
954 "refs/remotes/%.*s",
955 "refs/remotes/%.*s/HEAD",
956 NULL
957};
958
605b4978
SP
959const char *ref_fetch_rules[] = {
960 "%.*s",
961 "refs/%.*s",
962 "refs/heads/%.*s",
963 NULL
964};
965
79803322
SP
966int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
967{
968 const char **p;
969 const int abbrev_name_len = strlen(abbrev_name);
970
971 for (p = rules; *p; p++) {
972 if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
973 return 1;
974 }
975 }
976
977 return 0;
978}
979
e5f38ec3 980static struct ref_lock *verify_lock(struct ref_lock *lock,
4bd18c43
SP
981 const unsigned char *old_sha1, int mustexist)
982{
8da19775 983 if (!resolve_ref(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
434cd0cd 984 error("Can't verify ref %s", lock->ref_name);
4bd18c43
SP
985 unlock_ref(lock);
986 return NULL;
987 }
a89fccd2 988 if (hashcmp(lock->old_sha1, old_sha1)) {
434cd0cd 989 error("Ref %s is at %s but expected %s", lock->ref_name,
4bd18c43
SP
990 sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
991 unlock_ref(lock);
992 return NULL;
993 }
994 return lock;
995}
996
7155b727 997static int remove_empty_directories(const char *file)
bc7127ef
JH
998{
999 /* we want to create a file but there is a directory there;
1000 * if that is an empty directory (or a directory that contains
1001 * only empty directories), remove them.
1002 */
7155b727
JS
1003 struct strbuf path;
1004 int result;
bc7127ef 1005
7155b727
JS
1006 strbuf_init(&path, 20);
1007 strbuf_addstr(&path, file);
1008
a0f4afbe 1009 result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
7155b727
JS
1010
1011 strbuf_release(&path);
1012
1013 return result;
bc7127ef
JH
1014}
1015
c976d415
LH
1016static int is_refname_available(const char *ref, const char *oldref,
1017 struct ref_list *list, int quiet)
1018{
1019 int namlen = strlen(ref); /* e.g. 'foo/bar' */
1020 while (list) {
1021 /* list->name could be 'foo' or 'foo/bar/baz' */
1022 if (!oldref || strcmp(oldref, list->name)) {
1023 int len = strlen(list->name);
1024 int cmplen = (namlen < len) ? namlen : len;
1025 const char *lead = (namlen < len) ? list->name : ref;
1026 if (!strncmp(ref, list->name, cmplen) &&
1027 lead[cmplen] == '/') {
1028 if (!quiet)
1029 error("'%s' exists; cannot create '%s'",
1030 list->name, ref);
1031 return 0;
1032 }
1033 }
1034 list = list->next;
1035 }
1036 return 1;
1037}
1038
68db31cc 1039static struct ref_lock *lock_ref_sha1_basic(const char *ref, const unsigned char *old_sha1, int flags, int *type_p)
4bd18c43 1040{
434cd0cd 1041 char *ref_file;
ed378ec7 1042 const char *orig_ref = ref;
4bd18c43 1043 struct ref_lock *lock;
5cc3cef9 1044 int last_errno = 0;
acd3b9ec 1045 int type, lflags;
4431fcc4 1046 int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
5bdd8d4a 1047 int missing = 0;
4bd18c43
SP
1048
1049 lock = xcalloc(1, sizeof(struct ref_lock));
1050 lock->lock_fd = -1;
1051
68db31cc 1052 ref = resolve_ref(ref, lock->old_sha1, mustexist, &type);
bc7127ef
JH
1053 if (!ref && errno == EISDIR) {
1054 /* we are trying to lock foo but we used to
1055 * have foo/bar which now does not exist;
1056 * it is normal for the empty directory 'foo'
1057 * to remain.
1058 */
1059 ref_file = git_path("%s", orig_ref);
5cc3cef9
JH
1060 if (remove_empty_directories(ref_file)) {
1061 last_errno = errno;
1062 error("there are still refs under '%s'", orig_ref);
1063 goto error_return;
1064 }
68db31cc 1065 ref = resolve_ref(orig_ref, lock->old_sha1, mustexist, &type);
bc7127ef 1066 }
68db31cc
SV
1067 if (type_p)
1068 *type_p = type;
ed378ec7 1069 if (!ref) {
5cc3cef9 1070 last_errno = errno;
818f477c 1071 error("unable to resolve reference %s: %s",
ed378ec7 1072 orig_ref, strerror(errno));
5cc3cef9 1073 goto error_return;
4bd18c43 1074 }
5bdd8d4a 1075 missing = is_null_sha1(lock->old_sha1);
c976d415
LH
1076 /* When the ref did not exist and we are creating it,
1077 * make sure there is no existing ref that is packed
1078 * whose name begins with our refname, nor a ref whose
1079 * name is a proper prefix of our refname.
1080 */
5bdd8d4a 1081 if (missing &&
0bad611b 1082 !is_refname_available(ref, NULL, get_packed_refs(NULL), 0)) {
f475e08e 1083 last_errno = ENOTDIR;
c976d415 1084 goto error_return;
f475e08e 1085 }
22a3844e 1086
c33d5174 1087 lock->lk = xcalloc(1, sizeof(struct lock_file));
4bd18c43 1088
acd3b9ec
JH
1089 lflags = LOCK_DIE_ON_ERROR;
1090 if (flags & REF_NODEREF) {
68db31cc 1091 ref = orig_ref;
acd3b9ec
JH
1092 lflags |= LOCK_NODEREF;
1093 }
434cd0cd 1094 lock->ref_name = xstrdup(ref);
1655707c 1095 lock->orig_ref_name = xstrdup(orig_ref);
7c1a278d 1096 ref_file = git_path("%s", ref);
5bdd8d4a 1097 if (missing)
68db31cc
SV
1098 lock->force_write = 1;
1099 if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1100 lock->force_write = 1;
4bd18c43 1101
5cc3cef9
JH
1102 if (safe_create_leading_directories(ref_file)) {
1103 last_errno = errno;
1104 error("unable to create directory for %s", ref_file);
1105 goto error_return;
1106 }
4bd18c43 1107
acd3b9ec 1108 lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
4bd18c43 1109 return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
5cc3cef9
JH
1110
1111 error_return:
1112 unlock_ref(lock);
1113 errno = last_errno;
1114 return NULL;
4bd18c43
SP
1115}
1116
4431fcc4 1117struct ref_lock *lock_ref_sha1(const char *ref, const unsigned char *old_sha1)
95fc7512 1118{
53cce84c 1119 char refpath[PATH_MAX];
8d9c5010 1120 if (check_refname_format(ref, 0))
4bd18c43 1121 return NULL;
53cce84c 1122 strcpy(refpath, mkpath("refs/%s", ref));
68db31cc 1123 return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
4bd18c43
SP
1124}
1125
68db31cc 1126struct ref_lock *lock_any_ref_for_update(const char *ref, const unsigned char *old_sha1, int flags)
4bd18c43 1127{
8d9c5010 1128 if (check_refname_format(ref, REFNAME_ALLOW_ONELEVEL))
257f3020 1129 return NULL;
8d9c5010 1130 return lock_ref_sha1_basic(ref, old_sha1, flags, NULL);
c0277d15
JH
1131}
1132
26a063a1
JH
1133static struct lock_file packlock;
1134
c0277d15
JH
1135static int repack_without_ref(const char *refname)
1136{
1137 struct ref_list *list, *packed_ref_list;
1138 int fd;
1139 int found = 0;
c0277d15 1140
0bad611b 1141 packed_ref_list = get_packed_refs(NULL);
c0277d15
JH
1142 for (list = packed_ref_list; list; list = list->next) {
1143 if (!strcmp(refname, list->name)) {
1144 found = 1;
1145 break;
1146 }
1147 }
1148 if (!found)
1149 return 0;
c0277d15 1150 fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1b018fd9
MV
1151 if (fd < 0) {
1152 unable_to_lock_error(git_path("packed-refs"), errno);
c0277d15 1153 return error("cannot delete '%s' from packed refs", refname);
1b018fd9 1154 }
c0277d15
JH
1155
1156 for (list = packed_ref_list; list; list = list->next) {
1157 char line[PATH_MAX + 100];
1158 int len;
1159
1160 if (!strcmp(refname, list->name))
1161 continue;
1162 len = snprintf(line, sizeof(line), "%s %s\n",
1163 sha1_to_hex(list->sha1), list->name);
1164 /* this should not happen but just being defensive */
1165 if (len > sizeof(line))
1166 die("too long a refname '%s'", list->name);
1167 write_or_die(fd, line, len);
1168 }
1169 return commit_lock_file(&packlock);
1170}
1171
eca35a25 1172int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
c0277d15
JH
1173{
1174 struct ref_lock *lock;
eca35a25 1175 int err, i = 0, ret = 0, flag = 0;
c0277d15 1176
68db31cc 1177 lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
c0277d15
JH
1178 if (!lock)
1179 return 1;
045a476f 1180 if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
c0277d15 1181 /* loose */
eca35a25
MV
1182 const char *path;
1183
1184 if (!(delopt & REF_NODEREF)) {
1185 i = strlen(lock->lk->filename) - 5; /* .lock */
1186 lock->lk->filename[i] = 0;
1187 path = lock->lk->filename;
1188 } else {
9db56f71 1189 path = git_path("%s", refname);
eca35a25 1190 }
691f1a28
AR
1191 err = unlink_or_warn(path);
1192 if (err && errno != ENOENT)
c0277d15 1193 ret = 1;
691f1a28 1194
eca35a25
MV
1195 if (!(delopt & REF_NODEREF))
1196 lock->lk->filename[i] = '.';
c0277d15
JH
1197 }
1198 /* removing the loose one could have resurrected an earlier
1199 * packed one. Also, if it was not loose we need to repack
1200 * without it.
1201 */
1202 ret |= repack_without_ref(refname);
1203
691f1a28 1204 unlink_or_warn(git_path("logs/%s", lock->ref_name));
c0277d15
JH
1205 invalidate_cached_refs();
1206 unlock_ref(lock);
1207 return ret;
4bd18c43
SP
1208}
1209
765c2258
PH
1210/*
1211 * People using contrib's git-new-workdir have .git/logs/refs ->
1212 * /some/other/path/.git/logs/refs, and that may live on another device.
1213 *
1214 * IOW, to avoid cross device rename errors, the temporary renamed log must
1215 * live into logs/refs.
1216 */
1217#define TMP_RENAMED_LOG "logs/refs/.tmp-renamed-log"
1218
678d0f4c 1219int rename_ref(const char *oldref, const char *newref, const char *logmsg)
c976d415
LH
1220{
1221 static const char renamed_ref[] = "RENAMED-REF";
1222 unsigned char sha1[20], orig_sha1[20];
1223 int flag = 0, logmoved = 0;
1224 struct ref_lock *lock;
c976d415 1225 struct stat loginfo;
16c2bfbb 1226 int log = !lstat(git_path("logs/%s", oldref), &loginfo);
eca35a25 1227 const char *symref = NULL;
c976d415 1228
450d4c0f 1229 if (log && S_ISLNK(loginfo.st_mode))
c976d415
LH
1230 return error("reflog for %s is a symlink", oldref);
1231
eca35a25
MV
1232 symref = resolve_ref(oldref, orig_sha1, 1, &flag);
1233 if (flag & REF_ISSYMREF)
fa58186c
MV
1234 return error("refname %s is a symbolic ref, renaming it is not supported",
1235 oldref);
eca35a25 1236 if (!symref)
c976d415
LH
1237 return error("refname %s not found", oldref);
1238
0bad611b 1239 if (!is_refname_available(newref, oldref, get_packed_refs(NULL), 0))
c976d415
LH
1240 return 1;
1241
0bad611b 1242 if (!is_refname_available(newref, oldref, get_loose_refs(NULL), 0))
c976d415
LH
1243 return 1;
1244
68db31cc 1245 lock = lock_ref_sha1_basic(renamed_ref, NULL, 0, NULL);
c976d415
LH
1246 if (!lock)
1247 return error("unable to lock %s", renamed_ref);
1248 lock->force_write = 1;
678d0f4c 1249 if (write_ref_sha1(lock, orig_sha1, logmsg))
c976d415
LH
1250 return error("unable to save current sha1 in %s", renamed_ref);
1251
765c2258
PH
1252 if (log && rename(git_path("logs/%s", oldref), git_path(TMP_RENAMED_LOG)))
1253 return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
c976d415
LH
1254 oldref, strerror(errno));
1255
eca35a25 1256 if (delete_ref(oldref, orig_sha1, REF_NODEREF)) {
c976d415
LH
1257 error("unable to delete old %s", oldref);
1258 goto rollback;
1259 }
1260
eca35a25 1261 if (resolve_ref(newref, sha1, 1, &flag) && delete_ref(newref, sha1, REF_NODEREF)) {
c976d415
LH
1262 if (errno==EISDIR) {
1263 if (remove_empty_directories(git_path("%s", newref))) {
1264 error("Directory not empty: %s", newref);
1265 goto rollback;
1266 }
1267 } else {
1268 error("unable to delete existing %s", newref);
1269 goto rollback;
1270 }
1271 }
1272
1273 if (log && safe_create_leading_directories(git_path("logs/%s", newref))) {
1274 error("unable to create directory for %s", newref);
1275 goto rollback;
1276 }
1277
1278 retry:
765c2258 1279 if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newref))) {
d9e74d57
JR
1280 if (errno==EISDIR || errno==ENOTDIR) {
1281 /*
1282 * rename(a, b) when b is an existing
1283 * directory ought to result in ISDIR, but
1284 * Solaris 5.8 gives ENOTDIR. Sheesh.
1285 */
c976d415
LH
1286 if (remove_empty_directories(git_path("logs/%s", newref))) {
1287 error("Directory not empty: logs/%s", newref);
1288 goto rollback;
1289 }
1290 goto retry;
1291 } else {
765c2258 1292 error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
c976d415
LH
1293 newref, strerror(errno));
1294 goto rollback;
1295 }
1296 }
1297 logmoved = log;
1298
68db31cc 1299 lock = lock_ref_sha1_basic(newref, NULL, 0, NULL);
c976d415
LH
1300 if (!lock) {
1301 error("unable to lock %s for update", newref);
1302 goto rollback;
1303 }
c976d415
LH
1304 lock->force_write = 1;
1305 hashcpy(lock->old_sha1, orig_sha1);
678d0f4c 1306 if (write_ref_sha1(lock, orig_sha1, logmsg)) {
c976d415
LH
1307 error("unable to write current sha1 into %s", newref);
1308 goto rollback;
1309 }
1310
1311 return 0;
1312
1313 rollback:
68db31cc 1314 lock = lock_ref_sha1_basic(oldref, NULL, 0, NULL);
c976d415
LH
1315 if (!lock) {
1316 error("unable to lock %s for rollback", oldref);
1317 goto rollbacklog;
1318 }
1319
1320 lock->force_write = 1;
1321 flag = log_all_ref_updates;
1322 log_all_ref_updates = 0;
1323 if (write_ref_sha1(lock, orig_sha1, NULL))
1324 error("unable to write current sha1 into %s", oldref);
1325 log_all_ref_updates = flag;
1326
1327 rollbacklog:
1328 if (logmoved && rename(git_path("logs/%s", newref), git_path("logs/%s", oldref)))
1329 error("unable to restore logfile %s from %s: %s",
1330 oldref, newref, strerror(errno));
1331 if (!logmoved && log &&
765c2258
PH
1332 rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldref)))
1333 error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
c976d415
LH
1334 oldref, strerror(errno));
1335
1336 return 1;
1337}
1338
435fc852 1339int close_ref(struct ref_lock *lock)
b531394d
BC
1340{
1341 if (close_lock_file(lock->lk))
1342 return -1;
1343 lock->lock_fd = -1;
1344 return 0;
1345}
1346
435fc852 1347int commit_ref(struct ref_lock *lock)
b531394d
BC
1348{
1349 if (commit_lock_file(lock->lk))
1350 return -1;
1351 lock->lock_fd = -1;
1352 return 0;
1353}
1354
e5f38ec3 1355void unlock_ref(struct ref_lock *lock)
4bd18c43 1356{
4ed7cd3a
BC
1357 /* Do not free lock->lk -- atexit() still looks at them */
1358 if (lock->lk)
1359 rollback_lock_file(lock->lk);
434cd0cd 1360 free(lock->ref_name);
1655707c 1361 free(lock->orig_ref_name);
4bd18c43
SP
1362 free(lock);
1363}
1364
0ec29a47
JH
1365/*
1366 * copy the reflog message msg to buf, which has been allocated sufficiently
1367 * large, while cleaning up the whitespaces. Especially, convert LF to space,
1368 * because reflog file is one line per entry.
1369 */
1370static int copy_msg(char *buf, const char *msg)
1371{
1372 char *cp = buf;
1373 char c;
1374 int wasspace = 1;
1375
1376 *cp++ = '\t';
1377 while ((c = *msg++)) {
1378 if (wasspace && isspace(c))
1379 continue;
1380 wasspace = isspace(c);
1381 if (wasspace)
1382 c = ' ';
1383 *cp++ = c;
1384 }
1385 while (buf < cp && isspace(cp[-1]))
1386 cp--;
1387 *cp++ = '\n';
1388 return cp - buf;
1389}
1390
157aaea5 1391int log_ref_setup(const char *ref_name, char *logfile, int bufsize)
6de08ae6 1392{
859c3017 1393 int logfd, oflags = O_APPEND | O_WRONLY;
9a13f0b7 1394
157aaea5 1395 git_snpath(logfile, bufsize, "logs/%s", ref_name);
4057deb5 1396 if (log_all_ref_updates &&
cc44c765
JH
1397 (!prefixcmp(ref_name, "refs/heads/") ||
1398 !prefixcmp(ref_name, "refs/remotes/") ||
b2e256b0 1399 !prefixcmp(ref_name, "refs/notes/") ||
bd104db1 1400 !strcmp(ref_name, "HEAD"))) {
157aaea5 1401 if (safe_create_leading_directories(logfile) < 0)
6de08ae6 1402 return error("unable to create directory for %s",
157aaea5 1403 logfile);
6de08ae6
SP
1404 oflags |= O_CREAT;
1405 }
1406
157aaea5 1407 logfd = open(logfile, oflags, 0666);
6de08ae6 1408 if (logfd < 0) {
1974bf62 1409 if (!(oflags & O_CREAT) && errno == ENOENT)
6de08ae6 1410 return 0;
3b463c3f
JH
1411
1412 if ((oflags & O_CREAT) && errno == EISDIR) {
157aaea5 1413 if (remove_empty_directories(logfile)) {
3b463c3f 1414 return error("There are still logs under '%s'",
157aaea5 1415 logfile);
3b463c3f 1416 }
157aaea5 1417 logfd = open(logfile, oflags, 0666);
3b463c3f
JH
1418 }
1419
1420 if (logfd < 0)
1421 return error("Unable to append to %s: %s",
157aaea5 1422 logfile, strerror(errno));
6de08ae6
SP
1423 }
1424
157aaea5 1425 adjust_shared_perm(logfile);
859c3017
EM
1426 close(logfd);
1427 return 0;
1428}
443b92b6 1429
859c3017
EM
1430static int log_ref_write(const char *ref_name, const unsigned char *old_sha1,
1431 const unsigned char *new_sha1, const char *msg)
1432{
1433 int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1434 unsigned maxlen, len;
1435 int msglen;
157aaea5 1436 char log_file[PATH_MAX];
859c3017
EM
1437 char *logrec;
1438 const char *committer;
1439
1440 if (log_all_ref_updates < 0)
1441 log_all_ref_updates = !is_bare_repository();
1442
157aaea5 1443 result = log_ref_setup(ref_name, log_file, sizeof(log_file));
859c3017
EM
1444 if (result)
1445 return result;
1446
1447 logfd = open(log_file, oflags);
1448 if (logfd < 0)
1449 return 0;
0ec29a47 1450 msglen = msg ? strlen(msg) : 0;
774751a8 1451 committer = git_committer_info(0);
8ac65937
JH
1452 maxlen = strlen(committer) + msglen + 100;
1453 logrec = xmalloc(maxlen);
1454 len = sprintf(logrec, "%s %s %s\n",
9a13f0b7
NP
1455 sha1_to_hex(old_sha1),
1456 sha1_to_hex(new_sha1),
8ac65937
JH
1457 committer);
1458 if (msglen)
0ec29a47 1459 len += copy_msg(logrec + len - 1, msg) - 1;
93822c22 1460 written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
6de08ae6 1461 free(logrec);
91c8d590 1462 if (close(logfd) != 0 || written != len)
9a13f0b7 1463 return error("Unable to append to %s", log_file);
6de08ae6
SP
1464 return 0;
1465}
1466
c3b0dec5
LT
1467static int is_branch(const char *refname)
1468{
1469 return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1470}
1471
4bd18c43
SP
1472int write_ref_sha1(struct ref_lock *lock,
1473 const unsigned char *sha1, const char *logmsg)
1474{
1475 static char term = '\n';
c3b0dec5 1476 struct object *o;
4bd18c43
SP
1477
1478 if (!lock)
95fc7512 1479 return -1;
a89fccd2 1480 if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
4bd18c43
SP
1481 unlock_ref(lock);
1482 return 0;
95fc7512 1483 }
c3b0dec5
LT
1484 o = parse_object(sha1);
1485 if (!o) {
7be8b3ba 1486 error("Trying to write ref %s with nonexistent object %s",
c3b0dec5
LT
1487 lock->ref_name, sha1_to_hex(sha1));
1488 unlock_ref(lock);
1489 return -1;
1490 }
1491 if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1492 error("Trying to write non-commit object %s to branch %s",
1493 sha1_to_hex(sha1), lock->ref_name);
1494 unlock_ref(lock);
1495 return -1;
1496 }
93822c22
AW
1497 if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1498 write_in_full(lock->lock_fd, &term, 1) != 1
b531394d 1499 || close_ref(lock) < 0) {
c33d5174 1500 error("Couldn't write %s", lock->lk->filename);
4bd18c43
SP
1501 unlock_ref(lock);
1502 return -1;
1503 }
5e290ff7 1504 invalidate_cached_refs();
bd104db1
NP
1505 if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1506 (strcmp(lock->ref_name, lock->orig_ref_name) &&
1507 log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
6de08ae6
SP
1508 unlock_ref(lock);
1509 return -1;
1510 }
605fac8b
NP
1511 if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1512 /*
1513 * Special hack: If a branch is updated directly and HEAD
1514 * points to it (may happen on the remote side of a push
1515 * for example) then logically the HEAD reflog should be
1516 * updated too.
1517 * A generic solution implies reverse symref information,
1518 * but finding all symrefs pointing to the given branch
1519 * would be rather costly for this rare event (the direct
1520 * update of a branch) to be worth it. So let's cheat and
1521 * check with HEAD only which should cover 99% of all usage
1522 * scenarios (even 100% of the default ones).
1523 */
1524 unsigned char head_sha1[20];
1525 int head_flag;
1526 const char *head_ref;
1527 head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1528 if (head_ref && (head_flag & REF_ISSYMREF) &&
1529 !strcmp(head_ref, lock->ref_name))
1530 log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1531 }
b531394d 1532 if (commit_ref(lock)) {
434cd0cd 1533 error("Couldn't set %s", lock->ref_name);
4bd18c43
SP
1534 unlock_ref(lock);
1535 return -1;
1536 }
4bd18c43
SP
1537 unlock_ref(lock);
1538 return 0;
95fc7512 1539}
d556fae2 1540
8b5157e4
NP
1541int create_symref(const char *ref_target, const char *refs_heads_master,
1542 const char *logmsg)
41b625b0
NP
1543{
1544 const char *lockpath;
1545 char ref[1000];
1546 int fd, len, written;
a4f34cbb 1547 char *git_HEAD = git_pathdup("%s", ref_target);
8b5157e4
NP
1548 unsigned char old_sha1[20], new_sha1[20];
1549
1550 if (logmsg && read_ref(ref_target, old_sha1))
1551 hashclr(old_sha1);
41b625b0 1552
d48744d1
JH
1553 if (safe_create_leading_directories(git_HEAD) < 0)
1554 return error("unable to create directory for %s", git_HEAD);
1555
41b625b0
NP
1556#ifndef NO_SYMLINK_HEAD
1557 if (prefer_symlink_refs) {
1558 unlink(git_HEAD);
1559 if (!symlink(refs_heads_master, git_HEAD))
8b5157e4 1560 goto done;
41b625b0
NP
1561 fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1562 }
1563#endif
1564
1565 len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1566 if (sizeof(ref) <= len) {
1567 error("refname too long: %s", refs_heads_master);
47fc52e2 1568 goto error_free_return;
41b625b0
NP
1569 }
1570 lockpath = mkpath("%s.lock", git_HEAD);
1571 fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1572 if (fd < 0) {
1573 error("Unable to open %s for writing", lockpath);
47fc52e2 1574 goto error_free_return;
41b625b0
NP
1575 }
1576 written = write_in_full(fd, ref, len);
91c8d590 1577 if (close(fd) != 0 || written != len) {
41b625b0 1578 error("Unable to write to %s", lockpath);
47fc52e2 1579 goto error_unlink_return;
41b625b0
NP
1580 }
1581 if (rename(lockpath, git_HEAD) < 0) {
41b625b0 1582 error("Unable to create %s", git_HEAD);
47fc52e2 1583 goto error_unlink_return;
41b625b0
NP
1584 }
1585 if (adjust_shared_perm(git_HEAD)) {
41b625b0 1586 error("Unable to fix permissions on %s", lockpath);
47fc52e2 1587 error_unlink_return:
691f1a28 1588 unlink_or_warn(lockpath);
47fc52e2
JH
1589 error_free_return:
1590 free(git_HEAD);
1591 return -1;
41b625b0 1592 }
8b5157e4 1593
ee96d11b 1594#ifndef NO_SYMLINK_HEAD
8b5157e4 1595 done:
ee96d11b 1596#endif
8b5157e4
NP
1597 if (logmsg && !read_ref(refs_heads_master, new_sha1))
1598 log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1599
47fc52e2 1600 free(git_HEAD);
41b625b0
NP
1601 return 0;
1602}
1603
16d7cc90
JH
1604static char *ref_msg(const char *line, const char *endp)
1605{
1606 const char *ep;
16d7cc90 1607 line += 82;
182af834
PH
1608 ep = memchr(line, '\n', endp - line);
1609 if (!ep)
1610 ep = endp;
1611 return xmemdupz(line, ep - line);
16d7cc90
JH
1612}
1613
1614int read_ref_at(const char *ref, unsigned long at_time, int cnt, unsigned char *sha1, char **msg, unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
d556fae2 1615{
e5229042 1616 const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
d556fae2 1617 char *tz_c;
e29cb53a 1618 int logfd, tz, reccnt = 0;
d556fae2
SP
1619 struct stat st;
1620 unsigned long date;
e5229042 1621 unsigned char logged_sha1[20];
cb48cb58 1622 void *log_mapped;
dc49cd76 1623 size_t mapsz;
d556fae2
SP
1624
1625 logfile = git_path("logs/%s", ref);
1626 logfd = open(logfile, O_RDONLY, 0);
1627 if (logfd < 0)
d824cbba 1628 die_errno("Unable to read log '%s'", logfile);
d556fae2
SP
1629 fstat(logfd, &st);
1630 if (!st.st_size)
1631 die("Log %s is empty.", logfile);
dc49cd76
SP
1632 mapsz = xsize_t(st.st_size);
1633 log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
cb48cb58 1634 logdata = log_mapped;
d556fae2
SP
1635 close(logfd);
1636
e5229042 1637 lastrec = NULL;
d556fae2
SP
1638 rec = logend = logdata + st.st_size;
1639 while (logdata < rec) {
e29cb53a 1640 reccnt++;
d556fae2
SP
1641 if (logdata < rec && *(rec-1) == '\n')
1642 rec--;
e5229042
SP
1643 lastgt = NULL;
1644 while (logdata < rec && *(rec-1) != '\n') {
d556fae2 1645 rec--;
e5229042
SP
1646 if (*rec == '>')
1647 lastgt = rec;
1648 }
1649 if (!lastgt)
d556fae2 1650 die("Log %s is corrupt.", logfile);
e5229042 1651 date = strtoul(lastgt + 1, &tz_c, 10);
ab2a1a32 1652 if (date <= at_time || cnt == 0) {
76a44c5c 1653 tz = strtoul(tz_c, NULL, 10);
16d7cc90
JH
1654 if (msg)
1655 *msg = ref_msg(rec, logend);
1656 if (cutoff_time)
1657 *cutoff_time = date;
1658 if (cutoff_tz)
1659 *cutoff_tz = tz;
1660 if (cutoff_cnt)
76a44c5c 1661 *cutoff_cnt = reccnt - 1;
e5229042
SP
1662 if (lastrec) {
1663 if (get_sha1_hex(lastrec, logged_sha1))
1664 die("Log %s is corrupt.", logfile);
1665 if (get_sha1_hex(rec + 41, sha1))
1666 die("Log %s is corrupt.", logfile);
a89fccd2 1667 if (hashcmp(logged_sha1, sha1)) {
edbc25c5 1668 warning("Log %s has gap after %s.",
73013afd 1669 logfile, show_date(date, tz, DATE_RFC2822));
e5229042 1670 }
e5f38ec3
JH
1671 }
1672 else if (date == at_time) {
e5229042
SP
1673 if (get_sha1_hex(rec + 41, sha1))
1674 die("Log %s is corrupt.", logfile);
e5f38ec3
JH
1675 }
1676 else {
e5229042
SP
1677 if (get_sha1_hex(rec + 41, logged_sha1))
1678 die("Log %s is corrupt.", logfile);
a89fccd2 1679 if (hashcmp(logged_sha1, sha1)) {
edbc25c5 1680 warning("Log %s unexpectedly ended on %s.",
73013afd 1681 logfile, show_date(date, tz, DATE_RFC2822));
e5229042
SP
1682 }
1683 }
dc49cd76 1684 munmap(log_mapped, mapsz);
d556fae2
SP
1685 return 0;
1686 }
e5229042 1687 lastrec = rec;
ab2a1a32
JH
1688 if (cnt > 0)
1689 cnt--;
d556fae2
SP
1690 }
1691
e5229042
SP
1692 rec = logdata;
1693 while (rec < logend && *rec != '>' && *rec != '\n')
1694 rec++;
1695 if (rec == logend || *rec == '\n')
d556fae2 1696 die("Log %s is corrupt.", logfile);
e5229042 1697 date = strtoul(rec + 1, &tz_c, 10);
d556fae2
SP
1698 tz = strtoul(tz_c, NULL, 10);
1699 if (get_sha1_hex(logdata, sha1))
1700 die("Log %s is corrupt.", logfile);
d1a4489a
JK
1701 if (is_null_sha1(sha1)) {
1702 if (get_sha1_hex(logdata + 41, sha1))
1703 die("Log %s is corrupt.", logfile);
1704 }
16d7cc90
JH
1705 if (msg)
1706 *msg = ref_msg(logdata, logend);
dc49cd76 1707 munmap(log_mapped, mapsz);
16d7cc90
JH
1708
1709 if (cutoff_time)
1710 *cutoff_time = date;
1711 if (cutoff_tz)
1712 *cutoff_tz = tz;
1713 if (cutoff_cnt)
1714 *cutoff_cnt = reccnt;
1715 return 1;
d556fae2 1716}
2ff81662 1717
101d15e0 1718int for_each_recent_reflog_ent(const char *ref, each_reflog_ent_fn fn, long ofs, void *cb_data)
2ff81662
JH
1719{
1720 const char *logfile;
1721 FILE *logfp;
8ca78803 1722 struct strbuf sb = STRBUF_INIT;
2266bf27 1723 int ret = 0;
2ff81662
JH
1724
1725 logfile = git_path("logs/%s", ref);
1726 logfp = fopen(logfile, "r");
1727 if (!logfp)
883d60fa 1728 return -1;
101d15e0
JH
1729
1730 if (ofs) {
1731 struct stat statbuf;
1732 if (fstat(fileno(logfp), &statbuf) ||
1733 statbuf.st_size < ofs ||
1734 fseek(logfp, -ofs, SEEK_END) ||
8ca78803 1735 strbuf_getwholeline(&sb, logfp, '\n')) {
9d33f7c2 1736 fclose(logfp);
8ca78803 1737 strbuf_release(&sb);
101d15e0 1738 return -1;
9d33f7c2 1739 }
101d15e0
JH
1740 }
1741
8ca78803 1742 while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2ff81662 1743 unsigned char osha1[20], nsha1[20];
883d60fa
JS
1744 char *email_end, *message;
1745 unsigned long timestamp;
8ca78803 1746 int tz;
2ff81662
JH
1747
1748 /* old SP new SP name <email> SP time TAB msg LF */
8ca78803
RS
1749 if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1750 get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1751 get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1752 !(email_end = strchr(sb.buf + 82, '>')) ||
883d60fa
JS
1753 email_end[1] != ' ' ||
1754 !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1755 !message || message[0] != ' ' ||
1756 (message[1] != '+' && message[1] != '-') ||
1757 !isdigit(message[2]) || !isdigit(message[3]) ||
b4dd4856 1758 !isdigit(message[4]) || !isdigit(message[5]))
2ff81662 1759 continue; /* corrupt? */
883d60fa
JS
1760 email_end[1] = '\0';
1761 tz = strtol(message + 1, NULL, 10);
b4dd4856
JS
1762 if (message[6] != '\t')
1763 message += 6;
1764 else
1765 message += 7;
8ca78803
RS
1766 ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1767 cb_data);
883d60fa 1768 if (ret)
2266bf27 1769 break;
2ff81662
JH
1770 }
1771 fclose(logfp);
8ca78803 1772 strbuf_release(&sb);
2266bf27 1773 return ret;
2ff81662 1774}
e29cb53a 1775
101d15e0
JH
1776int for_each_reflog_ent(const char *ref, each_reflog_ent_fn fn, void *cb_data)
1777{
1778 return for_each_recent_reflog_ent(ref, fn, 0, cb_data);
1779}
1780
eb8381c8
NP
1781static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1782{
1783 DIR *dir = opendir(git_path("logs/%s", base));
fcee5a14 1784 int retval = 0;
eb8381c8
NP
1785
1786 if (dir) {
1787 struct dirent *de;
1788 int baselen = strlen(base);
1789 char *log = xmalloc(baselen + 257);
1790
1791 memcpy(log, base, baselen);
1792 if (baselen && base[baselen-1] != '/')
1793 log[baselen++] = '/';
1794
1795 while ((de = readdir(dir)) != NULL) {
1796 struct stat st;
1797 int namelen;
1798
1799 if (de->d_name[0] == '.')
1800 continue;
1801 namelen = strlen(de->d_name);
1802 if (namelen > 255)
1803 continue;
1804 if (has_extension(de->d_name, ".lock"))
1805 continue;
1806 memcpy(log + baselen, de->d_name, namelen+1);
1807 if (stat(git_path("logs/%s", log), &st) < 0)
1808 continue;
1809 if (S_ISDIR(st.st_mode)) {
1810 retval = do_for_each_reflog(log, fn, cb_data);
1811 } else {
1812 unsigned char sha1[20];
1813 if (!resolve_ref(log, sha1, 0, NULL))
1814 retval = error("bad ref for %s", log);
1815 else
1816 retval = fn(log, sha1, 0, cb_data);
1817 }
1818 if (retval)
1819 break;
1820 }
1821 free(log);
1822 closedir(dir);
1823 }
acb39f64 1824 else if (*base)
fcee5a14 1825 return errno;
eb8381c8
NP
1826 return retval;
1827}
1828
1829int for_each_reflog(each_ref_fn fn, void *cb_data)
1830{
1831 return do_for_each_reflog("", fn, cb_data);
1832}
3d9f037c
CR
1833
1834int update_ref(const char *action, const char *refname,
1835 const unsigned char *sha1, const unsigned char *oldval,
1836 int flags, enum action_on_err onerr)
1837{
1838 static struct ref_lock *lock;
1839 lock = lock_any_ref_for_update(refname, oldval, flags);
1840 if (!lock) {
1841 const char *str = "Cannot lock the ref '%s'.";
1842 switch (onerr) {
1843 case MSG_ON_ERR: error(str, refname); break;
1844 case DIE_ON_ERR: die(str, refname); break;
1845 case QUIET_ON_ERR: break;
1846 }
1847 return 1;
1848 }
1849 if (write_ref_sha1(lock, sha1, action) < 0) {
1850 const char *str = "Cannot update the ref '%s'.";
1851 switch (onerr) {
1852 case MSG_ON_ERR: error(str, refname); break;
1853 case DIE_ON_ERR: die(str, refname); break;
1854 case QUIET_ON_ERR: break;
1855 }
1856 return 1;
1857 }
1858 return 0;
1859}
cda69f48 1860
c17b2294
JH
1861int ref_exists(char *refname)
1862{
1863 unsigned char sha1[20];
1864 return !!resolve_ref(refname, sha1, 1, NULL);
1865}
1866
5483f799 1867struct ref *find_ref_by_name(const struct ref *list, const char *name)
cda69f48
JK
1868{
1869 for ( ; list; list = list->next)
1870 if (!strcmp(list->name, name))
5483f799 1871 return (struct ref *)list;
cda69f48
JK
1872 return NULL;
1873}
7c2b3029
JK
1874
1875/*
1876 * generate a format suitable for scanf from a ref_rev_parse_rules
1877 * rule, that is replace the "%.*s" spec with a "%s" spec
1878 */
1879static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
1880{
1881 char *spec;
1882
1883 spec = strstr(rule, "%.*s");
1884 if (!spec || strstr(spec + 4, "%.*s"))
1885 die("invalid rule in ref_rev_parse_rules: %s", rule);
1886
1887 /* copy all until spec */
1888 strncpy(scanf_fmt, rule, spec - rule);
1889 scanf_fmt[spec - rule] = '\0';
1890 /* copy new spec */
1891 strcat(scanf_fmt, "%s");
1892 /* copy remaining rule */
1893 strcat(scanf_fmt, spec + 4);
1894
1895 return;
1896}
1897
6e7b3309 1898char *shorten_unambiguous_ref(const char *ref, int strict)
7c2b3029
JK
1899{
1900 int i;
1901 static char **scanf_fmts;
1902 static int nr_rules;
1903 char *short_name;
1904
1905 /* pre generate scanf formats from ref_rev_parse_rules[] */
1906 if (!nr_rules) {
1907 size_t total_len = 0;
1908
1909 /* the rule list is NULL terminated, count them first */
1910 for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
1911 /* no +1 because strlen("%s") < strlen("%.*s") */
1912 total_len += strlen(ref_rev_parse_rules[nr_rules]);
1913
1914 scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
1915
1916 total_len = 0;
1917 for (i = 0; i < nr_rules; i++) {
1918 scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
1919 + total_len;
1920 gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
1921 total_len += strlen(ref_rev_parse_rules[i]);
1922 }
1923 }
1924
1925 /* bail out if there are no rules */
1926 if (!nr_rules)
1927 return xstrdup(ref);
1928
1929 /* buffer for scanf result, at most ref must fit */
1930 short_name = xstrdup(ref);
1931
1932 /* skip first rule, it will always match */
1933 for (i = nr_rules - 1; i > 0 ; --i) {
1934 int j;
6e7b3309 1935 int rules_to_fail = i;
7c2b3029
JK
1936 int short_name_len;
1937
1938 if (1 != sscanf(ref, scanf_fmts[i], short_name))
1939 continue;
1940
1941 short_name_len = strlen(short_name);
1942
6e7b3309
BW
1943 /*
1944 * in strict mode, all (except the matched one) rules
1945 * must fail to resolve to a valid non-ambiguous ref
1946 */
1947 if (strict)
1948 rules_to_fail = nr_rules;
1949
7c2b3029
JK
1950 /*
1951 * check if the short name resolves to a valid ref,
1952 * but use only rules prior to the matched one
1953 */
6e7b3309 1954 for (j = 0; j < rules_to_fail; j++) {
7c2b3029
JK
1955 const char *rule = ref_rev_parse_rules[j];
1956 unsigned char short_objectname[20];
1957 char refname[PATH_MAX];
1958
6e7b3309
BW
1959 /* skip matched rule */
1960 if (i == j)
1961 continue;
1962
7c2b3029
JK
1963 /*
1964 * the short name is ambiguous, if it resolves
1965 * (with this previous rule) to a valid ref
1966 * read_ref() returns 0 on success
1967 */
1968 mksnpath(refname, sizeof(refname),
1969 rule, short_name_len, short_name);
1970 if (!read_ref(refname, short_objectname))
1971 break;
1972 }
1973
1974 /*
1975 * short name is non-ambiguous if all previous rules
1976 * haven't resolved to a valid ref
1977 */
6e7b3309 1978 if (j == rules_to_fail)
7c2b3029
JK
1979 return short_name;
1980 }
1981
1982 free(short_name);
1983 return xstrdup(ref);
1984}