Merge branch 'nd/warn-ambiguous-object-name' into jk/cat-file-batch-optim
[git/gitweb.git] / sha1_name.c
bloba1e0f804dc1844a0df936bc48bcdc4839c612566
1 #include "cache.h"
2 #include "tag.h"
3 #include "commit.h"
4 #include "tree.h"
5 #include "blob.h"
6 #include "tree-walk.h"
7 #include "refs.h"
8 #include "remote.h"
10 static int get_sha1_oneline(const char *, unsigned char *, struct commit_list *);
12 typedef int (*disambiguate_hint_fn)(const unsigned char *, void *);
14 struct disambiguate_state {
15 disambiguate_hint_fn fn;
16 void *cb_data;
17 unsigned char candidate[20];
18 unsigned candidate_exists:1;
19 unsigned candidate_checked:1;
20 unsigned candidate_ok:1;
21 unsigned disambiguate_fn_used:1;
22 unsigned ambiguous:1;
23 unsigned always_call_fn:1;
26 static void update_candidates(struct disambiguate_state *ds, const unsigned char *current)
28 if (ds->always_call_fn) {
29 ds->ambiguous = ds->fn(current, ds->cb_data) ? 1 : 0;
30 return;
32 if (!ds->candidate_exists) {
33 /* this is the first candidate */
34 hashcpy(ds->candidate, current);
35 ds->candidate_exists = 1;
36 return;
37 } else if (!hashcmp(ds->candidate, current)) {
38 /* the same as what we already have seen */
39 return;
42 if (!ds->fn) {
43 /* cannot disambiguate between ds->candidate and current */
44 ds->ambiguous = 1;
45 return;
48 if (!ds->candidate_checked) {
49 ds->candidate_ok = ds->fn(ds->candidate, ds->cb_data);
50 ds->disambiguate_fn_used = 1;
51 ds->candidate_checked = 1;
54 if (!ds->candidate_ok) {
55 /* discard the candidate; we know it does not satisify fn */
56 hashcpy(ds->candidate, current);
57 ds->candidate_checked = 0;
58 return;
61 /* if we reach this point, we know ds->candidate satisfies fn */
62 if (ds->fn(current, ds->cb_data)) {
64 * if both current and candidate satisfy fn, we cannot
65 * disambiguate.
67 ds->candidate_ok = 0;
68 ds->ambiguous = 1;
71 /* otherwise, current can be discarded and candidate is still good */
74 static void find_short_object_filename(int len, const char *hex_pfx, struct disambiguate_state *ds)
76 struct alternate_object_database *alt;
77 char hex[40];
78 static struct alternate_object_database *fakeent;
80 if (!fakeent) {
82 * Create a "fake" alternate object database that
83 * points to our own object database, to make it
84 * easier to get a temporary working space in
85 * alt->name/alt->base while iterating over the
86 * object databases including our own.
88 const char *objdir = get_object_directory();
89 int objdir_len = strlen(objdir);
90 int entlen = objdir_len + 43;
91 fakeent = xmalloc(sizeof(*fakeent) + entlen);
92 memcpy(fakeent->base, objdir, objdir_len);
93 fakeent->name = fakeent->base + objdir_len + 1;
94 fakeent->name[-1] = '/';
96 fakeent->next = alt_odb_list;
98 sprintf(hex, "%.2s", hex_pfx);
99 for (alt = fakeent; alt && !ds->ambiguous; alt = alt->next) {
100 struct dirent *de;
101 DIR *dir;
102 sprintf(alt->name, "%.2s/", hex_pfx);
103 dir = opendir(alt->base);
104 if (!dir)
105 continue;
107 while (!ds->ambiguous && (de = readdir(dir)) != NULL) {
108 unsigned char sha1[20];
110 if (strlen(de->d_name) != 38)
111 continue;
112 if (memcmp(de->d_name, hex_pfx + 2, len - 2))
113 continue;
114 memcpy(hex + 2, de->d_name, 38);
115 if (!get_sha1_hex(hex, sha1))
116 update_candidates(ds, sha1);
118 closedir(dir);
122 static int match_sha(unsigned len, const unsigned char *a, const unsigned char *b)
124 do {
125 if (*a != *b)
126 return 0;
127 a++;
128 b++;
129 len -= 2;
130 } while (len > 1);
131 if (len)
132 if ((*a ^ *b) & 0xf0)
133 return 0;
134 return 1;
137 static void unique_in_pack(int len,
138 const unsigned char *bin_pfx,
139 struct packed_git *p,
140 struct disambiguate_state *ds)
142 uint32_t num, last, i, first = 0;
143 const unsigned char *current = NULL;
145 open_pack_index(p);
146 num = p->num_objects;
147 last = num;
148 while (first < last) {
149 uint32_t mid = (first + last) / 2;
150 const unsigned char *current;
151 int cmp;
153 current = nth_packed_object_sha1(p, mid);
154 cmp = hashcmp(bin_pfx, current);
155 if (!cmp) {
156 first = mid;
157 break;
159 if (cmp > 0) {
160 first = mid+1;
161 continue;
163 last = mid;
167 * At this point, "first" is the location of the lowest object
168 * with an object name that could match "bin_pfx". See if we have
169 * 0, 1 or more objects that actually match(es).
171 for (i = first; i < num && !ds->ambiguous; i++) {
172 current = nth_packed_object_sha1(p, i);
173 if (!match_sha(len, bin_pfx, current))
174 break;
175 update_candidates(ds, current);
179 static void find_short_packed_object(int len, const unsigned char *bin_pfx,
180 struct disambiguate_state *ds)
182 struct packed_git *p;
184 prepare_packed_git();
185 for (p = packed_git; p && !ds->ambiguous; p = p->next)
186 unique_in_pack(len, bin_pfx, p, ds);
189 #define SHORT_NAME_NOT_FOUND (-1)
190 #define SHORT_NAME_AMBIGUOUS (-2)
192 static int finish_object_disambiguation(struct disambiguate_state *ds,
193 unsigned char *sha1)
195 if (ds->ambiguous)
196 return SHORT_NAME_AMBIGUOUS;
198 if (!ds->candidate_exists)
199 return SHORT_NAME_NOT_FOUND;
201 if (!ds->candidate_checked)
203 * If this is the only candidate, there is no point
204 * calling the disambiguation hint callback.
206 * On the other hand, if the current candidate
207 * replaced an earlier candidate that did _not_ pass
208 * the disambiguation hint callback, then we do have
209 * more than one objects that match the short name
210 * given, so we should make sure this one matches;
211 * otherwise, if we discovered this one and the one
212 * that we previously discarded in the reverse order,
213 * we would end up showing different results in the
214 * same repository!
216 ds->candidate_ok = (!ds->disambiguate_fn_used ||
217 ds->fn(ds->candidate, ds->cb_data));
219 if (!ds->candidate_ok)
220 return SHORT_NAME_AMBIGUOUS;
222 hashcpy(sha1, ds->candidate);
223 return 0;
226 static int disambiguate_commit_only(const unsigned char *sha1, void *cb_data_unused)
228 int kind = sha1_object_info(sha1, NULL);
229 return kind == OBJ_COMMIT;
232 static int disambiguate_committish_only(const unsigned char *sha1, void *cb_data_unused)
234 struct object *obj;
235 int kind;
237 kind = sha1_object_info(sha1, NULL);
238 if (kind == OBJ_COMMIT)
239 return 1;
240 if (kind != OBJ_TAG)
241 return 0;
243 /* We need to do this the hard way... */
244 obj = deref_tag(lookup_object(sha1), NULL, 0);
245 if (obj && obj->type == OBJ_COMMIT)
246 return 1;
247 return 0;
250 static int disambiguate_tree_only(const unsigned char *sha1, void *cb_data_unused)
252 int kind = sha1_object_info(sha1, NULL);
253 return kind == OBJ_TREE;
256 static int disambiguate_treeish_only(const unsigned char *sha1, void *cb_data_unused)
258 struct object *obj;
259 int kind;
261 kind = sha1_object_info(sha1, NULL);
262 if (kind == OBJ_TREE || kind == OBJ_COMMIT)
263 return 1;
264 if (kind != OBJ_TAG)
265 return 0;
267 /* We need to do this the hard way... */
268 obj = deref_tag(lookup_object(sha1), NULL, 0);
269 if (obj && (obj->type == OBJ_TREE || obj->type == OBJ_COMMIT))
270 return 1;
271 return 0;
274 static int disambiguate_blob_only(const unsigned char *sha1, void *cb_data_unused)
276 int kind = sha1_object_info(sha1, NULL);
277 return kind == OBJ_BLOB;
280 static int prepare_prefixes(const char *name, int len,
281 unsigned char *bin_pfx,
282 char *hex_pfx)
284 int i;
286 hashclr(bin_pfx);
287 memset(hex_pfx, 'x', 40);
288 for (i = 0; i < len ;i++) {
289 unsigned char c = name[i];
290 unsigned char val;
291 if (c >= '0' && c <= '9')
292 val = c - '0';
293 else if (c >= 'a' && c <= 'f')
294 val = c - 'a' + 10;
295 else if (c >= 'A' && c <='F') {
296 val = c - 'A' + 10;
297 c -= 'A' - 'a';
299 else
300 return -1;
301 hex_pfx[i] = c;
302 if (!(i & 1))
303 val <<= 4;
304 bin_pfx[i >> 1] |= val;
306 return 0;
309 static int get_short_sha1(const char *name, int len, unsigned char *sha1,
310 unsigned flags)
312 int status;
313 char hex_pfx[40];
314 unsigned char bin_pfx[20];
315 struct disambiguate_state ds;
316 int quietly = !!(flags & GET_SHA1_QUIETLY);
318 if (len < MINIMUM_ABBREV || len > 40)
319 return -1;
320 if (prepare_prefixes(name, len, bin_pfx, hex_pfx) < 0)
321 return -1;
323 prepare_alt_odb();
325 memset(&ds, 0, sizeof(ds));
326 if (flags & GET_SHA1_COMMIT)
327 ds.fn = disambiguate_commit_only;
328 else if (flags & GET_SHA1_COMMITTISH)
329 ds.fn = disambiguate_committish_only;
330 else if (flags & GET_SHA1_TREE)
331 ds.fn = disambiguate_tree_only;
332 else if (flags & GET_SHA1_TREEISH)
333 ds.fn = disambiguate_treeish_only;
334 else if (flags & GET_SHA1_BLOB)
335 ds.fn = disambiguate_blob_only;
337 find_short_object_filename(len, hex_pfx, &ds);
338 find_short_packed_object(len, bin_pfx, &ds);
339 status = finish_object_disambiguation(&ds, sha1);
341 if (!quietly && (status == SHORT_NAME_AMBIGUOUS))
342 return error("short SHA1 %.*s is ambiguous.", len, hex_pfx);
343 return status;
347 int for_each_abbrev(const char *prefix, each_abbrev_fn fn, void *cb_data)
349 char hex_pfx[40];
350 unsigned char bin_pfx[20];
351 struct disambiguate_state ds;
352 int len = strlen(prefix);
354 if (len < MINIMUM_ABBREV || len > 40)
355 return -1;
356 if (prepare_prefixes(prefix, len, bin_pfx, hex_pfx) < 0)
357 return -1;
359 prepare_alt_odb();
361 memset(&ds, 0, sizeof(ds));
362 ds.always_call_fn = 1;
363 ds.cb_data = cb_data;
364 ds.fn = fn;
366 find_short_object_filename(len, hex_pfx, &ds);
367 find_short_packed_object(len, bin_pfx, &ds);
368 return ds.ambiguous;
371 const char *find_unique_abbrev(const unsigned char *sha1, int len)
373 int status, exists;
374 static char hex[41];
376 exists = has_sha1_file(sha1);
377 memcpy(hex, sha1_to_hex(sha1), 40);
378 if (len == 40 || !len)
379 return hex;
380 while (len < 40) {
381 unsigned char sha1_ret[20];
382 status = get_short_sha1(hex, len, sha1_ret, GET_SHA1_QUIETLY);
383 if (exists
384 ? !status
385 : status == SHORT_NAME_NOT_FOUND) {
386 hex[len] = 0;
387 return hex;
389 len++;
391 return hex;
394 static int ambiguous_path(const char *path, int len)
396 int slash = 1;
397 int cnt;
399 for (cnt = 0; cnt < len; cnt++) {
400 switch (*path++) {
401 case '\0':
402 break;
403 case '/':
404 if (slash)
405 break;
406 slash = 1;
407 continue;
408 case '.':
409 continue;
410 default:
411 slash = 0;
412 continue;
414 break;
416 return slash;
419 static inline int upstream_mark(const char *string, int len)
421 const char *suffix[] = { "@{upstream}", "@{u}" };
422 int i;
424 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
425 int suffix_len = strlen(suffix[i]);
426 if (suffix_len <= len
427 && !memcmp(string, suffix[i], suffix_len))
428 return suffix_len;
430 return 0;
433 static int get_sha1_1(const char *name, int len, unsigned char *sha1, unsigned lookup_flags);
435 static int get_sha1_basic(const char *str, int len, unsigned char *sha1)
437 static const char *warn_msg = "refname '%.*s' is ambiguous.";
438 static const char *object_name_msg = N_(
439 "Git normally never creates a ref that ends with 40 hex characters\n"
440 "because it will be ignored when you just specify 40-hex. These refs\n"
441 "may be created by mistake. For example,\n"
442 "\n"
443 " git checkout -b $br $(git rev-parse ...)\n"
444 "\n"
445 "where \"$br\" is somehow empty and a 40-hex ref is created. Please\n"
446 "examine these refs and maybe delete them. Turn this message off by\n"
447 "running \"git config advice.object_name_warning false\"");
448 unsigned char tmp_sha1[20];
449 char *real_ref = NULL;
450 int refs_found = 0;
451 int at, reflog_len;
453 if (len == 40 && !get_sha1_hex(str, sha1)) {
454 refs_found = dwim_ref(str, len, tmp_sha1, &real_ref);
455 if (refs_found > 0 && warn_ambiguous_refs) {
456 warning(warn_msg, len, str);
457 if (advice_object_name_warning)
458 fprintf(stderr, "%s\n", _(object_name_msg));
460 free(real_ref);
461 return 0;
464 /* basic@{time or number or -number} format to query ref-log */
465 reflog_len = at = 0;
466 if (len && str[len-1] == '}') {
467 for (at = len-2; at >= 0; at--) {
468 if (str[at] == '@' && str[at+1] == '{') {
469 if (!upstream_mark(str + at, len - at)) {
470 reflog_len = (len-1) - (at+2);
471 len = at;
473 break;
478 /* Accept only unambiguous ref paths. */
479 if (len && ambiguous_path(str, len))
480 return -1;
482 if (!len && reflog_len) {
483 struct strbuf buf = STRBUF_INIT;
484 int ret;
485 /* try the @{-N} syntax for n-th checkout */
486 ret = interpret_branch_name(str+at, &buf);
487 if (ret > 0) {
488 /* substitute this branch name and restart */
489 return get_sha1_1(buf.buf, buf.len, sha1, 0);
490 } else if (ret == 0) {
491 return -1;
493 /* allow "@{...}" to mean the current branch reflog */
494 refs_found = dwim_ref("HEAD", 4, sha1, &real_ref);
495 } else if (reflog_len)
496 refs_found = dwim_log(str, len, sha1, &real_ref);
497 else
498 refs_found = dwim_ref(str, len, sha1, &real_ref);
500 if (!refs_found)
501 return -1;
503 if (warn_ambiguous_refs &&
504 (refs_found > 1 ||
505 !get_short_sha1(str, len, tmp_sha1, GET_SHA1_QUIETLY)))
506 warning(warn_msg, len, str);
508 if (reflog_len) {
509 int nth, i;
510 unsigned long at_time;
511 unsigned long co_time;
512 int co_tz, co_cnt;
514 /* a @{-N} placed anywhere except the start is an error */
515 if (str[at+2] == '-')
516 return -1;
518 /* Is it asking for N-th entry, or approxidate? */
519 for (i = nth = 0; 0 <= nth && i < reflog_len; i++) {
520 char ch = str[at+2+i];
521 if ('0' <= ch && ch <= '9')
522 nth = nth * 10 + ch - '0';
523 else
524 nth = -1;
526 if (100000000 <= nth) {
527 at_time = nth;
528 nth = -1;
529 } else if (0 <= nth)
530 at_time = 0;
531 else {
532 int errors = 0;
533 char *tmp = xstrndup(str + at + 2, reflog_len);
534 at_time = approxidate_careful(tmp, &errors);
535 free(tmp);
536 if (errors)
537 return -1;
539 if (read_ref_at(real_ref, at_time, nth, sha1, NULL,
540 &co_time, &co_tz, &co_cnt)) {
541 if (at_time)
542 warning("Log for '%.*s' only goes "
543 "back to %s.", len, str,
544 show_date(co_time, co_tz, DATE_RFC2822));
545 else {
546 free(real_ref);
547 die("Log for '%.*s' only has %d entries.",
548 len, str, co_cnt);
553 free(real_ref);
554 return 0;
557 static int get_parent(const char *name, int len,
558 unsigned char *result, int idx)
560 unsigned char sha1[20];
561 int ret = get_sha1_1(name, len, sha1, GET_SHA1_COMMITTISH);
562 struct commit *commit;
563 struct commit_list *p;
565 if (ret)
566 return ret;
567 commit = lookup_commit_reference(sha1);
568 if (!commit)
569 return -1;
570 if (parse_commit(commit))
571 return -1;
572 if (!idx) {
573 hashcpy(result, commit->object.sha1);
574 return 0;
576 p = commit->parents;
577 while (p) {
578 if (!--idx) {
579 hashcpy(result, p->item->object.sha1);
580 return 0;
582 p = p->next;
584 return -1;
587 static int get_nth_ancestor(const char *name, int len,
588 unsigned char *result, int generation)
590 unsigned char sha1[20];
591 struct commit *commit;
592 int ret;
594 ret = get_sha1_1(name, len, sha1, GET_SHA1_COMMITTISH);
595 if (ret)
596 return ret;
597 commit = lookup_commit_reference(sha1);
598 if (!commit)
599 return -1;
601 while (generation--) {
602 if (parse_commit(commit) || !commit->parents)
603 return -1;
604 commit = commit->parents->item;
606 hashcpy(result, commit->object.sha1);
607 return 0;
610 struct object *peel_to_type(const char *name, int namelen,
611 struct object *o, enum object_type expected_type)
613 if (name && !namelen)
614 namelen = strlen(name);
615 while (1) {
616 if (!o || (!o->parsed && !parse_object(o->sha1)))
617 return NULL;
618 if (expected_type == OBJ_ANY || o->type == expected_type)
619 return o;
620 if (o->type == OBJ_TAG)
621 o = ((struct tag*) o)->tagged;
622 else if (o->type == OBJ_COMMIT)
623 o = &(((struct commit *) o)->tree->object);
624 else {
625 if (name)
626 error("%.*s: expected %s type, but the object "
627 "dereferences to %s type",
628 namelen, name, typename(expected_type),
629 typename(o->type));
630 return NULL;
635 static int peel_onion(const char *name, int len, unsigned char *sha1)
637 unsigned char outer[20];
638 const char *sp;
639 unsigned int expected_type = 0;
640 unsigned lookup_flags = 0;
641 struct object *o;
644 * "ref^{type}" dereferences ref repeatedly until you cannot
645 * dereference anymore, or you get an object of given type,
646 * whichever comes first. "ref^{}" means just dereference
647 * tags until you get a non-tag. "ref^0" is a shorthand for
648 * "ref^{commit}". "commit^{tree}" could be used to find the
649 * top-level tree of the given commit.
651 if (len < 4 || name[len-1] != '}')
652 return -1;
654 for (sp = name + len - 1; name <= sp; sp--) {
655 int ch = *sp;
656 if (ch == '{' && name < sp && sp[-1] == '^')
657 break;
659 if (sp <= name)
660 return -1;
662 sp++; /* beginning of type name, or closing brace for empty */
663 if (!strncmp(commit_type, sp, 6) && sp[6] == '}')
664 expected_type = OBJ_COMMIT;
665 else if (!strncmp(tree_type, sp, 4) && sp[4] == '}')
666 expected_type = OBJ_TREE;
667 else if (!strncmp(blob_type, sp, 4) && sp[4] == '}')
668 expected_type = OBJ_BLOB;
669 else if (!prefixcmp(sp, "object}"))
670 expected_type = OBJ_ANY;
671 else if (sp[0] == '}')
672 expected_type = OBJ_NONE;
673 else if (sp[0] == '/')
674 expected_type = OBJ_COMMIT;
675 else
676 return -1;
678 if (expected_type == OBJ_COMMIT)
679 lookup_flags = GET_SHA1_COMMITTISH;
680 else if (expected_type == OBJ_TREE)
681 lookup_flags = GET_SHA1_TREEISH;
683 if (get_sha1_1(name, sp - name - 2, outer, lookup_flags))
684 return -1;
686 o = parse_object(outer);
687 if (!o)
688 return -1;
689 if (!expected_type) {
690 o = deref_tag(o, name, sp - name - 2);
691 if (!o || (!o->parsed && !parse_object(o->sha1)))
692 return -1;
693 hashcpy(sha1, o->sha1);
694 return 0;
698 * At this point, the syntax look correct, so
699 * if we do not get the needed object, we should
700 * barf.
702 o = peel_to_type(name, len, o, expected_type);
703 if (!o)
704 return -1;
706 hashcpy(sha1, o->sha1);
707 if (sp[0] == '/') {
708 /* "$commit^{/foo}" */
709 char *prefix;
710 int ret;
711 struct commit_list *list = NULL;
714 * $commit^{/}. Some regex implementation may reject.
715 * We don't need regex anyway. '' pattern always matches.
717 if (sp[1] == '}')
718 return 0;
720 prefix = xstrndup(sp + 1, name + len - 1 - (sp + 1));
721 commit_list_insert((struct commit *)o, &list);
722 ret = get_sha1_oneline(prefix, sha1, list);
723 free(prefix);
724 return ret;
726 return 0;
729 static int get_describe_name(const char *name, int len, unsigned char *sha1)
731 const char *cp;
732 unsigned flags = GET_SHA1_QUIETLY | GET_SHA1_COMMIT;
734 for (cp = name + len - 1; name + 2 <= cp; cp--) {
735 char ch = *cp;
736 if (hexval(ch) & ~0377) {
737 /* We must be looking at g in "SOMETHING-g"
738 * for it to be describe output.
740 if (ch == 'g' && cp[-1] == '-') {
741 cp++;
742 len -= cp - name;
743 return get_short_sha1(cp, len, sha1, flags);
747 return -1;
750 static int get_sha1_1(const char *name, int len, unsigned char *sha1, unsigned lookup_flags)
752 int ret, has_suffix;
753 const char *cp;
756 * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
758 has_suffix = 0;
759 for (cp = name + len - 1; name <= cp; cp--) {
760 int ch = *cp;
761 if ('0' <= ch && ch <= '9')
762 continue;
763 if (ch == '~' || ch == '^')
764 has_suffix = ch;
765 break;
768 if (has_suffix) {
769 int num = 0;
770 int len1 = cp - name;
771 cp++;
772 while (cp < name + len)
773 num = num * 10 + *cp++ - '0';
774 if (!num && len1 == len - 1)
775 num = 1;
776 if (has_suffix == '^')
777 return get_parent(name, len1, sha1, num);
778 /* else if (has_suffix == '~') -- goes without saying */
779 return get_nth_ancestor(name, len1, sha1, num);
782 ret = peel_onion(name, len, sha1);
783 if (!ret)
784 return 0;
786 ret = get_sha1_basic(name, len, sha1);
787 if (!ret)
788 return 0;
790 /* It could be describe output that is "SOMETHING-gXXXX" */
791 ret = get_describe_name(name, len, sha1);
792 if (!ret)
793 return 0;
795 return get_short_sha1(name, len, sha1, lookup_flags);
799 * This interprets names like ':/Initial revision of "git"' by searching
800 * through history and returning the first commit whose message starts
801 * the given regular expression.
803 * For future extension, ':/!' is reserved. If you want to match a message
804 * beginning with a '!', you have to repeat the exclamation mark.
806 #define ONELINE_SEEN (1u<<20)
808 static int handle_one_ref(const char *path,
809 const unsigned char *sha1, int flag, void *cb_data)
811 struct commit_list **list = cb_data;
812 struct object *object = parse_object(sha1);
813 if (!object)
814 return 0;
815 if (object->type == OBJ_TAG) {
816 object = deref_tag(object, path, strlen(path));
817 if (!object)
818 return 0;
820 if (object->type != OBJ_COMMIT)
821 return 0;
822 commit_list_insert_by_date((struct commit *)object, list);
823 return 0;
826 static int get_sha1_oneline(const char *prefix, unsigned char *sha1,
827 struct commit_list *list)
829 struct commit_list *backup = NULL, *l;
830 int found = 0;
831 regex_t regex;
833 if (prefix[0] == '!') {
834 if (prefix[1] != '!')
835 die ("Invalid search pattern: %s", prefix);
836 prefix++;
839 if (regcomp(&regex, prefix, REG_EXTENDED))
840 die("Invalid search pattern: %s", prefix);
842 for (l = list; l; l = l->next) {
843 l->item->object.flags |= ONELINE_SEEN;
844 commit_list_insert(l->item, &backup);
846 while (list) {
847 char *p, *to_free = NULL;
848 struct commit *commit;
849 enum object_type type;
850 unsigned long size;
851 int matches;
853 commit = pop_most_recent_commit(&list, ONELINE_SEEN);
854 if (!parse_object(commit->object.sha1))
855 continue;
856 if (commit->buffer)
857 p = commit->buffer;
858 else {
859 p = read_sha1_file(commit->object.sha1, &type, &size);
860 if (!p)
861 continue;
862 to_free = p;
865 p = strstr(p, "\n\n");
866 matches = p && !regexec(&regex, p + 2, 0, NULL, 0);
867 free(to_free);
869 if (matches) {
870 hashcpy(sha1, commit->object.sha1);
871 found = 1;
872 break;
875 regfree(&regex);
876 free_commit_list(list);
877 for (l = backup; l; l = l->next)
878 clear_commit_marks(l->item, ONELINE_SEEN);
879 free_commit_list(backup);
880 return found ? 0 : -1;
883 struct grab_nth_branch_switch_cbdata {
884 int remaining;
885 struct strbuf buf;
888 static int grab_nth_branch_switch(unsigned char *osha1, unsigned char *nsha1,
889 const char *email, unsigned long timestamp, int tz,
890 const char *message, void *cb_data)
892 struct grab_nth_branch_switch_cbdata *cb = cb_data;
893 const char *match = NULL, *target = NULL;
894 size_t len;
896 if (!prefixcmp(message, "checkout: moving from ")) {
897 match = message + strlen("checkout: moving from ");
898 target = strstr(match, " to ");
901 if (!match || !target)
902 return 0;
903 if (--(cb->remaining) == 0) {
904 len = target - match;
905 strbuf_reset(&cb->buf);
906 strbuf_add(&cb->buf, match, len);
907 return 1; /* we are done */
909 return 0;
913 * Parse @{-N} syntax, return the number of characters parsed
914 * if successful; otherwise signal an error with negative value.
916 static int interpret_nth_prior_checkout(const char *name, struct strbuf *buf)
918 long nth;
919 int retval;
920 struct grab_nth_branch_switch_cbdata cb;
921 const char *brace;
922 char *num_end;
924 if (name[0] != '@' || name[1] != '{' || name[2] != '-')
925 return -1;
926 brace = strchr(name, '}');
927 if (!brace)
928 return -1;
929 nth = strtol(name + 3, &num_end, 10);
930 if (num_end != brace)
931 return -1;
932 if (nth <= 0)
933 return -1;
934 cb.remaining = nth;
935 strbuf_init(&cb.buf, 20);
937 retval = 0;
938 if (0 < for_each_reflog_ent_reverse("HEAD", grab_nth_branch_switch, &cb)) {
939 strbuf_reset(buf);
940 strbuf_add(buf, cb.buf.buf, cb.buf.len);
941 retval = brace - name + 1;
944 strbuf_release(&cb.buf);
945 return retval;
948 int get_sha1_mb(const char *name, unsigned char *sha1)
950 struct commit *one, *two;
951 struct commit_list *mbs;
952 unsigned char sha1_tmp[20];
953 const char *dots;
954 int st;
956 dots = strstr(name, "...");
957 if (!dots)
958 return get_sha1(name, sha1);
959 if (dots == name)
960 st = get_sha1("HEAD", sha1_tmp);
961 else {
962 struct strbuf sb;
963 strbuf_init(&sb, dots - name);
964 strbuf_add(&sb, name, dots - name);
965 st = get_sha1_committish(sb.buf, sha1_tmp);
966 strbuf_release(&sb);
968 if (st)
969 return st;
970 one = lookup_commit_reference_gently(sha1_tmp, 0);
971 if (!one)
972 return -1;
974 if (get_sha1_committish(dots[3] ? (dots + 3) : "HEAD", sha1_tmp))
975 return -1;
976 two = lookup_commit_reference_gently(sha1_tmp, 0);
977 if (!two)
978 return -1;
979 mbs = get_merge_bases(one, two, 1);
980 if (!mbs || mbs->next)
981 st = -1;
982 else {
983 st = 0;
984 hashcpy(sha1, mbs->item->object.sha1);
986 free_commit_list(mbs);
987 return st;
991 * This reads short-hand syntax that not only evaluates to a commit
992 * object name, but also can act as if the end user spelled the name
993 * of the branch from the command line.
995 * - "@{-N}" finds the name of the Nth previous branch we were on, and
996 * places the name of the branch in the given buf and returns the
997 * number of characters parsed if successful.
999 * - "<branch>@{upstream}" finds the name of the other ref that
1000 * <branch> is configured to merge with (missing <branch> defaults
1001 * to the current branch), and places the name of the branch in the
1002 * given buf and returns the number of characters parsed if
1003 * successful.
1005 * If the input is not of the accepted format, it returns a negative
1006 * number to signal an error.
1008 * If the input was ok but there are not N branch switches in the
1009 * reflog, it returns 0.
1011 int interpret_branch_name(const char *name, struct strbuf *buf)
1013 char *cp;
1014 struct branch *upstream;
1015 int namelen = strlen(name);
1016 int len = interpret_nth_prior_checkout(name, buf);
1017 int tmp_len;
1019 if (!len)
1020 return len; /* syntax Ok, not enough switches */
1021 if (0 < len && len == namelen)
1022 return len; /* consumed all */
1023 else if (0 < len) {
1024 /* we have extra data, which might need further processing */
1025 struct strbuf tmp = STRBUF_INIT;
1026 int used = buf->len;
1027 int ret;
1029 strbuf_add(buf, name + len, namelen - len);
1030 ret = interpret_branch_name(buf->buf, &tmp);
1031 /* that data was not interpreted, remove our cruft */
1032 if (ret < 0) {
1033 strbuf_setlen(buf, used);
1034 return len;
1036 strbuf_reset(buf);
1037 strbuf_addbuf(buf, &tmp);
1038 strbuf_release(&tmp);
1039 /* tweak for size of {-N} versus expanded ref name */
1040 return ret - used + len;
1043 cp = strchr(name, '@');
1044 if (!cp)
1045 return -1;
1046 tmp_len = upstream_mark(cp, namelen - (cp - name));
1047 if (!tmp_len)
1048 return -1;
1049 len = cp + tmp_len - name;
1050 cp = xstrndup(name, cp - name);
1051 upstream = branch_get(*cp ? cp : NULL);
1053 * Upstream can be NULL only if cp refers to HEAD and HEAD
1054 * points to something different than a branch.
1056 if (!upstream)
1057 return error(_("HEAD does not point to a branch"));
1058 if (!upstream->merge || !upstream->merge[0]->dst) {
1059 if (!ref_exists(upstream->refname))
1060 return error(_("No such branch: '%s'"), cp);
1061 if (!upstream->merge)
1062 return error(_("No upstream configured for branch '%s'"),
1063 upstream->name);
1064 return error(
1065 _("Upstream branch '%s' not stored as a remote-tracking branch"),
1066 upstream->merge[0]->src);
1068 free(cp);
1069 cp = shorten_unambiguous_ref(upstream->merge[0]->dst, 0);
1070 strbuf_reset(buf);
1071 strbuf_addstr(buf, cp);
1072 free(cp);
1073 return len;
1076 int strbuf_branchname(struct strbuf *sb, const char *name)
1078 int len = strlen(name);
1079 if (interpret_branch_name(name, sb) == len)
1080 return 0;
1081 strbuf_add(sb, name, len);
1082 return len;
1085 int strbuf_check_branch_ref(struct strbuf *sb, const char *name)
1087 strbuf_branchname(sb, name);
1088 if (name[0] == '-')
1089 return -1;
1090 strbuf_splice(sb, 0, 0, "refs/heads/", 11);
1091 return check_refname_format(sb->buf, 0);
1095 * This is like "get_sha1_basic()", except it allows "sha1 expressions",
1096 * notably "xyz^" for "parent of xyz"
1098 int get_sha1(const char *name, unsigned char *sha1)
1100 struct object_context unused;
1101 return get_sha1_with_context(name, 0, sha1, &unused);
1105 * Many callers know that the user meant to name a committish by
1106 * syntactical positions where the object name appears. Calling this
1107 * function allows the machinery to disambiguate shorter-than-unique
1108 * abbreviated object names between committish and others.
1110 * Note that this does NOT error out when the named object is not a
1111 * committish. It is merely to give a hint to the disambiguation
1112 * machinery.
1114 int get_sha1_committish(const char *name, unsigned char *sha1)
1116 struct object_context unused;
1117 return get_sha1_with_context(name, GET_SHA1_COMMITTISH,
1118 sha1, &unused);
1121 int get_sha1_treeish(const char *name, unsigned char *sha1)
1123 struct object_context unused;
1124 return get_sha1_with_context(name, GET_SHA1_TREEISH,
1125 sha1, &unused);
1128 int get_sha1_commit(const char *name, unsigned char *sha1)
1130 struct object_context unused;
1131 return get_sha1_with_context(name, GET_SHA1_COMMIT,
1132 sha1, &unused);
1135 int get_sha1_tree(const char *name, unsigned char *sha1)
1137 struct object_context unused;
1138 return get_sha1_with_context(name, GET_SHA1_TREE,
1139 sha1, &unused);
1142 int get_sha1_blob(const char *name, unsigned char *sha1)
1144 struct object_context unused;
1145 return get_sha1_with_context(name, GET_SHA1_BLOB,
1146 sha1, &unused);
1149 /* Must be called only when object_name:filename doesn't exist. */
1150 static void diagnose_invalid_sha1_path(const char *prefix,
1151 const char *filename,
1152 const unsigned char *tree_sha1,
1153 const char *object_name,
1154 int object_name_len)
1156 struct stat st;
1157 unsigned char sha1[20];
1158 unsigned mode;
1160 if (!prefix)
1161 prefix = "";
1163 if (!lstat(filename, &st))
1164 die("Path '%s' exists on disk, but not in '%.*s'.",
1165 filename, object_name_len, object_name);
1166 if (errno == ENOENT || errno == ENOTDIR) {
1167 char *fullname = xmalloc(strlen(filename)
1168 + strlen(prefix) + 1);
1169 strcpy(fullname, prefix);
1170 strcat(fullname, filename);
1172 if (!get_tree_entry(tree_sha1, fullname,
1173 sha1, &mode)) {
1174 die("Path '%s' exists, but not '%s'.\n"
1175 "Did you mean '%.*s:%s' aka '%.*s:./%s'?",
1176 fullname,
1177 filename,
1178 object_name_len, object_name,
1179 fullname,
1180 object_name_len, object_name,
1181 filename);
1183 die("Path '%s' does not exist in '%.*s'",
1184 filename, object_name_len, object_name);
1188 /* Must be called only when :stage:filename doesn't exist. */
1189 static void diagnose_invalid_index_path(int stage,
1190 const char *prefix,
1191 const char *filename)
1193 struct stat st;
1194 struct cache_entry *ce;
1195 int pos;
1196 unsigned namelen = strlen(filename);
1197 unsigned fullnamelen;
1198 char *fullname;
1200 if (!prefix)
1201 prefix = "";
1203 /* Wrong stage number? */
1204 pos = cache_name_pos(filename, namelen);
1205 if (pos < 0)
1206 pos = -pos - 1;
1207 if (pos < active_nr) {
1208 ce = active_cache[pos];
1209 if (ce_namelen(ce) == namelen &&
1210 !memcmp(ce->name, filename, namelen))
1211 die("Path '%s' is in the index, but not at stage %d.\n"
1212 "Did you mean ':%d:%s'?",
1213 filename, stage,
1214 ce_stage(ce), filename);
1217 /* Confusion between relative and absolute filenames? */
1218 fullnamelen = namelen + strlen(prefix);
1219 fullname = xmalloc(fullnamelen + 1);
1220 strcpy(fullname, prefix);
1221 strcat(fullname, filename);
1222 pos = cache_name_pos(fullname, fullnamelen);
1223 if (pos < 0)
1224 pos = -pos - 1;
1225 if (pos < active_nr) {
1226 ce = active_cache[pos];
1227 if (ce_namelen(ce) == fullnamelen &&
1228 !memcmp(ce->name, fullname, fullnamelen))
1229 die("Path '%s' is in the index, but not '%s'.\n"
1230 "Did you mean ':%d:%s' aka ':%d:./%s'?",
1231 fullname, filename,
1232 ce_stage(ce), fullname,
1233 ce_stage(ce), filename);
1236 if (!lstat(filename, &st))
1237 die("Path '%s' exists on disk, but not in the index.", filename);
1238 if (errno == ENOENT || errno == ENOTDIR)
1239 die("Path '%s' does not exist (neither on disk nor in the index).",
1240 filename);
1242 free(fullname);
1246 static char *resolve_relative_path(const char *rel)
1248 if (prefixcmp(rel, "./") && prefixcmp(rel, "../"))
1249 return NULL;
1251 if (!startup_info)
1252 die("BUG: startup_info struct is not initialized.");
1254 if (!is_inside_work_tree())
1255 die("relative path syntax can't be used outside working tree.");
1257 /* die() inside prefix_path() if resolved path is outside worktree */
1258 return prefix_path(startup_info->prefix,
1259 startup_info->prefix ? strlen(startup_info->prefix) : 0,
1260 rel);
1263 static int get_sha1_with_context_1(const char *name,
1264 unsigned flags,
1265 const char *prefix,
1266 unsigned char *sha1,
1267 struct object_context *oc)
1269 int ret, bracket_depth;
1270 int namelen = strlen(name);
1271 const char *cp;
1272 int only_to_die = flags & GET_SHA1_ONLY_TO_DIE;
1274 memset(oc, 0, sizeof(*oc));
1275 oc->mode = S_IFINVALID;
1276 ret = get_sha1_1(name, namelen, sha1, flags);
1277 if (!ret)
1278 return ret;
1280 * sha1:path --> object name of path in ent sha1
1281 * :path -> object name of absolute path in index
1282 * :./path -> object name of path relative to cwd in index
1283 * :[0-3]:path -> object name of path in index at stage
1284 * :/foo -> recent commit matching foo
1286 if (name[0] == ':') {
1287 int stage = 0;
1288 struct cache_entry *ce;
1289 char *new_path = NULL;
1290 int pos;
1291 if (!only_to_die && namelen > 2 && name[1] == '/') {
1292 struct commit_list *list = NULL;
1293 for_each_ref(handle_one_ref, &list);
1294 return get_sha1_oneline(name + 2, sha1, list);
1296 if (namelen < 3 ||
1297 name[2] != ':' ||
1298 name[1] < '0' || '3' < name[1])
1299 cp = name + 1;
1300 else {
1301 stage = name[1] - '0';
1302 cp = name + 3;
1304 new_path = resolve_relative_path(cp);
1305 if (!new_path) {
1306 namelen = namelen - (cp - name);
1307 } else {
1308 cp = new_path;
1309 namelen = strlen(cp);
1312 strncpy(oc->path, cp,
1313 sizeof(oc->path));
1314 oc->path[sizeof(oc->path)-1] = '\0';
1316 if (!active_cache)
1317 read_cache();
1318 pos = cache_name_pos(cp, namelen);
1319 if (pos < 0)
1320 pos = -pos - 1;
1321 while (pos < active_nr) {
1322 ce = active_cache[pos];
1323 if (ce_namelen(ce) != namelen ||
1324 memcmp(ce->name, cp, namelen))
1325 break;
1326 if (ce_stage(ce) == stage) {
1327 hashcpy(sha1, ce->sha1);
1328 oc->mode = ce->ce_mode;
1329 free(new_path);
1330 return 0;
1332 pos++;
1334 if (only_to_die && name[1] && name[1] != '/')
1335 diagnose_invalid_index_path(stage, prefix, cp);
1336 free(new_path);
1337 return -1;
1339 for (cp = name, bracket_depth = 0; *cp; cp++) {
1340 if (*cp == '{')
1341 bracket_depth++;
1342 else if (bracket_depth && *cp == '}')
1343 bracket_depth--;
1344 else if (!bracket_depth && *cp == ':')
1345 break;
1347 if (*cp == ':') {
1348 unsigned char tree_sha1[20];
1349 int len = cp - name;
1350 if (!get_sha1_1(name, len, tree_sha1, GET_SHA1_TREEISH)) {
1351 const char *filename = cp+1;
1352 char *new_filename = NULL;
1354 new_filename = resolve_relative_path(filename);
1355 if (new_filename)
1356 filename = new_filename;
1357 ret = get_tree_entry(tree_sha1, filename, sha1, &oc->mode);
1358 if (ret && only_to_die) {
1359 diagnose_invalid_sha1_path(prefix, filename,
1360 tree_sha1,
1361 name, len);
1363 hashcpy(oc->tree, tree_sha1);
1364 strncpy(oc->path, filename,
1365 sizeof(oc->path));
1366 oc->path[sizeof(oc->path)-1] = '\0';
1368 free(new_filename);
1369 return ret;
1370 } else {
1371 if (only_to_die)
1372 die("Invalid object name '%.*s'.", len, name);
1375 return ret;
1379 * Call this function when you know "name" given by the end user must
1380 * name an object but it doesn't; the function _may_ die with a better
1381 * diagnostic message than "no such object 'name'", e.g. "Path 'doc' does not
1382 * exist in 'HEAD'" when given "HEAD:doc", or it may return in which case
1383 * you have a chance to diagnose the error further.
1385 void maybe_die_on_misspelt_object_name(const char *name, const char *prefix)
1387 struct object_context oc;
1388 unsigned char sha1[20];
1389 get_sha1_with_context_1(name, GET_SHA1_ONLY_TO_DIE, prefix, sha1, &oc);
1392 int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc)
1394 return get_sha1_with_context_1(str, flags, NULL, sha1, orc);