sha1-name.con commit tag: add repository argument to deref_tag (a74093d)
   1#include "cache.h"
   2#include "config.h"
   3#include "tag.h"
   4#include "commit.h"
   5#include "tree.h"
   6#include "blob.h"
   7#include "tree-walk.h"
   8#include "refs.h"
   9#include "remote.h"
  10#include "dir.h"
  11#include "sha1-array.h"
  12#include "packfile.h"
  13#include "object-store.h"
  14#include "repository.h"
  15
  16static int get_oid_oneline(const char *, struct object_id *, struct commit_list *);
  17
  18typedef int (*disambiguate_hint_fn)(const struct object_id *, void *);
  19
  20struct disambiguate_state {
  21        int len; /* length of prefix in hex chars */
  22        char hex_pfx[GIT_MAX_HEXSZ + 1];
  23        struct object_id bin_pfx;
  24
  25        disambiguate_hint_fn fn;
  26        void *cb_data;
  27        struct object_id candidate;
  28        unsigned candidate_exists:1;
  29        unsigned candidate_checked:1;
  30        unsigned candidate_ok:1;
  31        unsigned disambiguate_fn_used:1;
  32        unsigned ambiguous:1;
  33        unsigned always_call_fn:1;
  34};
  35
  36static void update_candidates(struct disambiguate_state *ds, const struct object_id *current)
  37{
  38        if (ds->always_call_fn) {
  39                ds->ambiguous = ds->fn(current, ds->cb_data) ? 1 : 0;
  40                return;
  41        }
  42        if (!ds->candidate_exists) {
  43                /* this is the first candidate */
  44                oidcpy(&ds->candidate, current);
  45                ds->candidate_exists = 1;
  46                return;
  47        } else if (!oidcmp(&ds->candidate, current)) {
  48                /* the same as what we already have seen */
  49                return;
  50        }
  51
  52        if (!ds->fn) {
  53                /* cannot disambiguate between ds->candidate and current */
  54                ds->ambiguous = 1;
  55                return;
  56        }
  57
  58        if (!ds->candidate_checked) {
  59                ds->candidate_ok = ds->fn(&ds->candidate, ds->cb_data);
  60                ds->disambiguate_fn_used = 1;
  61                ds->candidate_checked = 1;
  62        }
  63
  64        if (!ds->candidate_ok) {
  65                /* discard the candidate; we know it does not satisfy fn */
  66                oidcpy(&ds->candidate, current);
  67                ds->candidate_checked = 0;
  68                return;
  69        }
  70
  71        /* if we reach this point, we know ds->candidate satisfies fn */
  72        if (ds->fn(current, ds->cb_data)) {
  73                /*
  74                 * if both current and candidate satisfy fn, we cannot
  75                 * disambiguate.
  76                 */
  77                ds->candidate_ok = 0;
  78                ds->ambiguous = 1;
  79        }
  80
  81        /* otherwise, current can be discarded and candidate is still good */
  82}
  83
  84static int append_loose_object(const struct object_id *oid, const char *path,
  85                               void *data)
  86{
  87        oid_array_append(data, oid);
  88        return 0;
  89}
  90
  91static int match_sha(unsigned, const unsigned char *, const unsigned char *);
  92
  93static void find_short_object_filename(struct disambiguate_state *ds)
  94{
  95        int subdir_nr = ds->bin_pfx.hash[0];
  96        struct alternate_object_database *alt;
  97        static struct alternate_object_database *fakeent;
  98
  99        if (!fakeent) {
 100                /*
 101                 * Create a "fake" alternate object database that
 102                 * points to our own object database, to make it
 103                 * easier to get a temporary working space in
 104                 * alt->name/alt->base while iterating over the
 105                 * object databases including our own.
 106                 */
 107                fakeent = alloc_alt_odb(get_object_directory());
 108        }
 109        fakeent->next = the_repository->objects->alt_odb_list;
 110
 111        for (alt = fakeent; alt && !ds->ambiguous; alt = alt->next) {
 112                int pos;
 113
 114                if (!alt->loose_objects_subdir_seen[subdir_nr]) {
 115                        struct strbuf *buf = alt_scratch_buf(alt);
 116                        for_each_file_in_obj_subdir(subdir_nr, buf,
 117                                                    append_loose_object,
 118                                                    NULL, NULL,
 119                                                    &alt->loose_objects_cache);
 120                        alt->loose_objects_subdir_seen[subdir_nr] = 1;
 121                }
 122
 123                pos = oid_array_lookup(&alt->loose_objects_cache, &ds->bin_pfx);
 124                if (pos < 0)
 125                        pos = -1 - pos;
 126                while (!ds->ambiguous && pos < alt->loose_objects_cache.nr) {
 127                        const struct object_id *oid;
 128                        oid = alt->loose_objects_cache.oid + pos;
 129                        if (!match_sha(ds->len, ds->bin_pfx.hash, oid->hash))
 130                                break;
 131                        update_candidates(ds, oid);
 132                        pos++;
 133                }
 134        }
 135}
 136
 137static int match_sha(unsigned len, const unsigned char *a, const unsigned char *b)
 138{
 139        do {
 140                if (*a != *b)
 141                        return 0;
 142                a++;
 143                b++;
 144                len -= 2;
 145        } while (len > 1);
 146        if (len)
 147                if ((*a ^ *b) & 0xf0)
 148                        return 0;
 149        return 1;
 150}
 151
 152static void unique_in_pack(struct packed_git *p,
 153                           struct disambiguate_state *ds)
 154{
 155        uint32_t num, i, first = 0;
 156        const struct object_id *current = NULL;
 157
 158        if (open_pack_index(p) || !p->num_objects)
 159                return;
 160
 161        num = p->num_objects;
 162        bsearch_pack(&ds->bin_pfx, p, &first);
 163
 164        /*
 165         * At this point, "first" is the location of the lowest object
 166         * with an object name that could match "bin_pfx".  See if we have
 167         * 0, 1 or more objects that actually match(es).
 168         */
 169        for (i = first; i < num && !ds->ambiguous; i++) {
 170                struct object_id oid;
 171                current = nth_packed_object_oid(&oid, p, i);
 172                if (!match_sha(ds->len, ds->bin_pfx.hash, current->hash))
 173                        break;
 174                update_candidates(ds, current);
 175        }
 176}
 177
 178static void find_short_packed_object(struct disambiguate_state *ds)
 179{
 180        struct packed_git *p;
 181
 182        for (p = get_packed_git(the_repository); p && !ds->ambiguous;
 183             p = p->next)
 184                unique_in_pack(p, ds);
 185}
 186
 187#define SHORT_NAME_NOT_FOUND (-1)
 188#define SHORT_NAME_AMBIGUOUS (-2)
 189
 190static int finish_object_disambiguation(struct disambiguate_state *ds,
 191                                        struct object_id *oid)
 192{
 193        if (ds->ambiguous)
 194                return SHORT_NAME_AMBIGUOUS;
 195
 196        if (!ds->candidate_exists)
 197                return SHORT_NAME_NOT_FOUND;
 198
 199        if (!ds->candidate_checked)
 200                /*
 201                 * If this is the only candidate, there is no point
 202                 * calling the disambiguation hint callback.
 203                 *
 204                 * On the other hand, if the current candidate
 205                 * replaced an earlier candidate that did _not_ pass
 206                 * the disambiguation hint callback, then we do have
 207                 * more than one objects that match the short name
 208                 * given, so we should make sure this one matches;
 209                 * otherwise, if we discovered this one and the one
 210                 * that we previously discarded in the reverse order,
 211                 * we would end up showing different results in the
 212                 * same repository!
 213                 */
 214                ds->candidate_ok = (!ds->disambiguate_fn_used ||
 215                                    ds->fn(&ds->candidate, ds->cb_data));
 216
 217        if (!ds->candidate_ok)
 218                return SHORT_NAME_AMBIGUOUS;
 219
 220        oidcpy(oid, &ds->candidate);
 221        return 0;
 222}
 223
 224static int disambiguate_commit_only(const struct object_id *oid, void *cb_data_unused)
 225{
 226        int kind = oid_object_info(the_repository, oid, NULL);
 227        return kind == OBJ_COMMIT;
 228}
 229
 230static int disambiguate_committish_only(const struct object_id *oid, void *cb_data_unused)
 231{
 232        struct object *obj;
 233        int kind;
 234
 235        kind = oid_object_info(the_repository, oid, NULL);
 236        if (kind == OBJ_COMMIT)
 237                return 1;
 238        if (kind != OBJ_TAG)
 239                return 0;
 240
 241        /* We need to do this the hard way... */
 242        obj = deref_tag(the_repository, parse_object(the_repository, oid),
 243                        NULL, 0);
 244        if (obj && obj->type == OBJ_COMMIT)
 245                return 1;
 246        return 0;
 247}
 248
 249static int disambiguate_tree_only(const struct object_id *oid, void *cb_data_unused)
 250{
 251        int kind = oid_object_info(the_repository, oid, NULL);
 252        return kind == OBJ_TREE;
 253}
 254
 255static int disambiguate_treeish_only(const struct object_id *oid, void *cb_data_unused)
 256{
 257        struct object *obj;
 258        int kind;
 259
 260        kind = oid_object_info(the_repository, oid, NULL);
 261        if (kind == OBJ_TREE || kind == OBJ_COMMIT)
 262                return 1;
 263        if (kind != OBJ_TAG)
 264                return 0;
 265
 266        /* We need to do this the hard way... */
 267        obj = deref_tag(the_repository, parse_object(the_repository, oid),
 268                        NULL, 0);
 269        if (obj && (obj->type == OBJ_TREE || obj->type == OBJ_COMMIT))
 270                return 1;
 271        return 0;
 272}
 273
 274static int disambiguate_blob_only(const struct object_id *oid, void *cb_data_unused)
 275{
 276        int kind = oid_object_info(the_repository, oid, NULL);
 277        return kind == OBJ_BLOB;
 278}
 279
 280static disambiguate_hint_fn default_disambiguate_hint;
 281
 282int set_disambiguate_hint_config(const char *var, const char *value)
 283{
 284        static const struct {
 285                const char *name;
 286                disambiguate_hint_fn fn;
 287        } hints[] = {
 288                { "none", NULL },
 289                { "commit", disambiguate_commit_only },
 290                { "committish", disambiguate_committish_only },
 291                { "tree", disambiguate_tree_only },
 292                { "treeish", disambiguate_treeish_only },
 293                { "blob", disambiguate_blob_only }
 294        };
 295        int i;
 296
 297        if (!value)
 298                return config_error_nonbool(var);
 299
 300        for (i = 0; i < ARRAY_SIZE(hints); i++) {
 301                if (!strcasecmp(value, hints[i].name)) {
 302                        default_disambiguate_hint = hints[i].fn;
 303                        return 0;
 304                }
 305        }
 306
 307        return error("unknown hint type for '%s': %s", var, value);
 308}
 309
 310static int init_object_disambiguation(const char *name, int len,
 311                                      struct disambiguate_state *ds)
 312{
 313        int i;
 314
 315        if (len < MINIMUM_ABBREV || len > GIT_SHA1_HEXSZ)
 316                return -1;
 317
 318        memset(ds, 0, sizeof(*ds));
 319
 320        for (i = 0; i < len ;i++) {
 321                unsigned char c = name[i];
 322                unsigned char val;
 323                if (c >= '0' && c <= '9')
 324                        val = c - '0';
 325                else if (c >= 'a' && c <= 'f')
 326                        val = c - 'a' + 10;
 327                else if (c >= 'A' && c <='F') {
 328                        val = c - 'A' + 10;
 329                        c -= 'A' - 'a';
 330                }
 331                else
 332                        return -1;
 333                ds->hex_pfx[i] = c;
 334                if (!(i & 1))
 335                        val <<= 4;
 336                ds->bin_pfx.hash[i >> 1] |= val;
 337        }
 338
 339        ds->len = len;
 340        ds->hex_pfx[len] = '\0';
 341        prepare_alt_odb(the_repository);
 342        return 0;
 343}
 344
 345static int show_ambiguous_object(const struct object_id *oid, void *data)
 346{
 347        const struct disambiguate_state *ds = data;
 348        struct strbuf desc = STRBUF_INIT;
 349        int type;
 350
 351        if (ds->fn && !ds->fn(oid, ds->cb_data))
 352                return 0;
 353
 354        type = oid_object_info(the_repository, oid, NULL);
 355        if (type == OBJ_COMMIT) {
 356                struct commit *commit = lookup_commit(the_repository, oid);
 357                if (commit) {
 358                        struct pretty_print_context pp = {0};
 359                        pp.date_mode.type = DATE_SHORT;
 360                        format_commit_message(commit, " %ad - %s", &desc, &pp);
 361                }
 362        } else if (type == OBJ_TAG) {
 363                struct tag *tag = lookup_tag(the_repository, oid);
 364                if (!parse_tag(tag) && tag->tag)
 365                        strbuf_addf(&desc, " %s", tag->tag);
 366        }
 367
 368        advise("  %s %s%s",
 369               find_unique_abbrev(oid, DEFAULT_ABBREV),
 370               type_name(type) ? type_name(type) : "unknown type",
 371               desc.buf);
 372
 373        strbuf_release(&desc);
 374        return 0;
 375}
 376
 377static int collect_ambiguous(const struct object_id *oid, void *data)
 378{
 379        oid_array_append(data, oid);
 380        return 0;
 381}
 382
 383static int sort_ambiguous(const void *a, const void *b)
 384{
 385        int a_type = oid_object_info(the_repository, a, NULL);
 386        int b_type = oid_object_info(the_repository, b, NULL);
 387        int a_type_sort;
 388        int b_type_sort;
 389
 390        /*
 391         * Sorts by hash within the same object type, just as
 392         * oid_array_for_each_unique() would do.
 393         */
 394        if (a_type == b_type)
 395                return oidcmp(a, b);
 396
 397        /*
 398         * Between object types show tags, then commits, and finally
 399         * trees and blobs.
 400         *
 401         * The object_type enum is commit, tree, blob, tag, but we
 402         * want tag, commit, tree blob. Cleverly (perhaps too
 403         * cleverly) do that with modulus, since the enum assigns 1 to
 404         * commit, so tag becomes 0.
 405         */
 406        a_type_sort = a_type % 4;
 407        b_type_sort = b_type % 4;
 408        return a_type_sort > b_type_sort ? 1 : -1;
 409}
 410
 411static int get_short_oid(const char *name, int len, struct object_id *oid,
 412                          unsigned flags)
 413{
 414        int status;
 415        struct disambiguate_state ds;
 416        int quietly = !!(flags & GET_OID_QUIETLY);
 417
 418        if (init_object_disambiguation(name, len, &ds) < 0)
 419                return -1;
 420
 421        if (HAS_MULTI_BITS(flags & GET_OID_DISAMBIGUATORS))
 422                BUG("multiple get_short_oid disambiguator flags");
 423
 424        if (flags & GET_OID_COMMIT)
 425                ds.fn = disambiguate_commit_only;
 426        else if (flags & GET_OID_COMMITTISH)
 427                ds.fn = disambiguate_committish_only;
 428        else if (flags & GET_OID_TREE)
 429                ds.fn = disambiguate_tree_only;
 430        else if (flags & GET_OID_TREEISH)
 431                ds.fn = disambiguate_treeish_only;
 432        else if (flags & GET_OID_BLOB)
 433                ds.fn = disambiguate_blob_only;
 434        else
 435                ds.fn = default_disambiguate_hint;
 436
 437        find_short_object_filename(&ds);
 438        find_short_packed_object(&ds);
 439        status = finish_object_disambiguation(&ds, oid);
 440
 441        if (!quietly && (status == SHORT_NAME_AMBIGUOUS)) {
 442                struct oid_array collect = OID_ARRAY_INIT;
 443
 444                error(_("short SHA1 %s is ambiguous"), ds.hex_pfx);
 445
 446                /*
 447                 * We may still have ambiguity if we simply saw a series of
 448                 * candidates that did not satisfy our hint function. In
 449                 * that case, we still want to show them, so disable the hint
 450                 * function entirely.
 451                 */
 452                if (!ds.ambiguous)
 453                        ds.fn = NULL;
 454
 455                advise(_("The candidates are:"));
 456                for_each_abbrev(ds.hex_pfx, collect_ambiguous, &collect);
 457                QSORT(collect.oid, collect.nr, sort_ambiguous);
 458
 459                if (oid_array_for_each(&collect, show_ambiguous_object, &ds))
 460                        BUG("show_ambiguous_object shouldn't return non-zero");
 461                oid_array_clear(&collect);
 462        }
 463
 464        return status;
 465}
 466
 467int for_each_abbrev(const char *prefix, each_abbrev_fn fn, void *cb_data)
 468{
 469        struct oid_array collect = OID_ARRAY_INIT;
 470        struct disambiguate_state ds;
 471        int ret;
 472
 473        if (init_object_disambiguation(prefix, strlen(prefix), &ds) < 0)
 474                return -1;
 475
 476        ds.always_call_fn = 1;
 477        ds.fn = collect_ambiguous;
 478        ds.cb_data = &collect;
 479        find_short_object_filename(&ds);
 480        find_short_packed_object(&ds);
 481
 482        ret = oid_array_for_each_unique(&collect, fn, cb_data);
 483        oid_array_clear(&collect);
 484        return ret;
 485}
 486
 487/*
 488 * Return the slot of the most-significant bit set in "val". There are various
 489 * ways to do this quickly with fls() or __builtin_clzl(), but speed is
 490 * probably not a big deal here.
 491 */
 492static unsigned msb(unsigned long val)
 493{
 494        unsigned r = 0;
 495        while (val >>= 1)
 496                r++;
 497        return r;
 498}
 499
 500struct min_abbrev_data {
 501        unsigned int init_len;
 502        unsigned int cur_len;
 503        char *hex;
 504        const struct object_id *oid;
 505};
 506
 507static inline char get_hex_char_from_oid(const struct object_id *oid,
 508                                         unsigned int pos)
 509{
 510        static const char hex[] = "0123456789abcdef";
 511
 512        if ((pos & 1) == 0)
 513                return hex[oid->hash[pos >> 1] >> 4];
 514        else
 515                return hex[oid->hash[pos >> 1] & 0xf];
 516}
 517
 518static int extend_abbrev_len(const struct object_id *oid, void *cb_data)
 519{
 520        struct min_abbrev_data *mad = cb_data;
 521
 522        unsigned int i = mad->init_len;
 523        while (mad->hex[i] && mad->hex[i] == get_hex_char_from_oid(oid, i))
 524                i++;
 525
 526        if (i < GIT_MAX_RAWSZ && i >= mad->cur_len)
 527                mad->cur_len = i + 1;
 528
 529        return 0;
 530}
 531
 532static void find_abbrev_len_for_pack(struct packed_git *p,
 533                                     struct min_abbrev_data *mad)
 534{
 535        int match = 0;
 536        uint32_t num, first = 0;
 537        struct object_id oid;
 538        const struct object_id *mad_oid;
 539
 540        if (open_pack_index(p) || !p->num_objects)
 541                return;
 542
 543        num = p->num_objects;
 544        mad_oid = mad->oid;
 545        match = bsearch_pack(mad_oid, p, &first);
 546
 547        /*
 548         * first is now the position in the packfile where we would insert
 549         * mad->hash if it does not exist (or the position of mad->hash if
 550         * it does exist). Hence, we consider a maximum of two objects
 551         * nearby for the abbreviation length.
 552         */
 553        mad->init_len = 0;
 554        if (!match) {
 555                if (nth_packed_object_oid(&oid, p, first))
 556                        extend_abbrev_len(&oid, mad);
 557        } else if (first < num - 1) {
 558                if (nth_packed_object_oid(&oid, p, first + 1))
 559                        extend_abbrev_len(&oid, mad);
 560        }
 561        if (first > 0) {
 562                if (nth_packed_object_oid(&oid, p, first - 1))
 563                        extend_abbrev_len(&oid, mad);
 564        }
 565        mad->init_len = mad->cur_len;
 566}
 567
 568static void find_abbrev_len_packed(struct min_abbrev_data *mad)
 569{
 570        struct packed_git *p;
 571
 572        for (p = get_packed_git(the_repository); p; p = p->next)
 573                find_abbrev_len_for_pack(p, mad);
 574}
 575
 576int find_unique_abbrev_r(char *hex, const struct object_id *oid, int len)
 577{
 578        struct disambiguate_state ds;
 579        struct min_abbrev_data mad;
 580        struct object_id oid_ret;
 581        if (len < 0) {
 582                unsigned long count = approximate_object_count();
 583                /*
 584                 * Add one because the MSB only tells us the highest bit set,
 585                 * not including the value of all the _other_ bits (so "15"
 586                 * is only one off of 2^4, but the MSB is the 3rd bit.
 587                 */
 588                len = msb(count) + 1;
 589                /*
 590                 * We now know we have on the order of 2^len objects, which
 591                 * expects a collision at 2^(len/2). But we also care about hex
 592                 * chars, not bits, and there are 4 bits per hex. So all
 593                 * together we need to divide by 2 and round up.
 594                 */
 595                len = DIV_ROUND_UP(len, 2);
 596                /*
 597                 * For very small repos, we stick with our regular fallback.
 598                 */
 599                if (len < FALLBACK_DEFAULT_ABBREV)
 600                        len = FALLBACK_DEFAULT_ABBREV;
 601        }
 602
 603        oid_to_hex_r(hex, oid);
 604        if (len == GIT_SHA1_HEXSZ || !len)
 605                return GIT_SHA1_HEXSZ;
 606
 607        mad.init_len = len;
 608        mad.cur_len = len;
 609        mad.hex = hex;
 610        mad.oid = oid;
 611
 612        find_abbrev_len_packed(&mad);
 613
 614        if (init_object_disambiguation(hex, mad.cur_len, &ds) < 0)
 615                return -1;
 616
 617        ds.fn = extend_abbrev_len;
 618        ds.always_call_fn = 1;
 619        ds.cb_data = (void *)&mad;
 620
 621        find_short_object_filename(&ds);
 622        (void)finish_object_disambiguation(&ds, &oid_ret);
 623
 624        hex[mad.cur_len] = 0;
 625        return mad.cur_len;
 626}
 627
 628const char *find_unique_abbrev(const struct object_id *oid, int len)
 629{
 630        static int bufno;
 631        static char hexbuffer[4][GIT_MAX_HEXSZ + 1];
 632        char *hex = hexbuffer[bufno];
 633        bufno = (bufno + 1) % ARRAY_SIZE(hexbuffer);
 634        find_unique_abbrev_r(hex, oid, len);
 635        return hex;
 636}
 637
 638static int ambiguous_path(const char *path, int len)
 639{
 640        int slash = 1;
 641        int cnt;
 642
 643        for (cnt = 0; cnt < len; cnt++) {
 644                switch (*path++) {
 645                case '\0':
 646                        break;
 647                case '/':
 648                        if (slash)
 649                                break;
 650                        slash = 1;
 651                        continue;
 652                case '.':
 653                        continue;
 654                default:
 655                        slash = 0;
 656                        continue;
 657                }
 658                break;
 659        }
 660        return slash;
 661}
 662
 663static inline int at_mark(const char *string, int len,
 664                          const char **suffix, int nr)
 665{
 666        int i;
 667
 668        for (i = 0; i < nr; i++) {
 669                int suffix_len = strlen(suffix[i]);
 670                if (suffix_len <= len
 671                    && !strncasecmp(string, suffix[i], suffix_len))
 672                        return suffix_len;
 673        }
 674        return 0;
 675}
 676
 677static inline int upstream_mark(const char *string, int len)
 678{
 679        const char *suffix[] = { "@{upstream}", "@{u}" };
 680        return at_mark(string, len, suffix, ARRAY_SIZE(suffix));
 681}
 682
 683static inline int push_mark(const char *string, int len)
 684{
 685        const char *suffix[] = { "@{push}" };
 686        return at_mark(string, len, suffix, ARRAY_SIZE(suffix));
 687}
 688
 689static int get_oid_1(const char *name, int len, struct object_id *oid, unsigned lookup_flags);
 690static int interpret_nth_prior_checkout(const char *name, int namelen, struct strbuf *buf);
 691
 692static int get_oid_basic(const char *str, int len, struct object_id *oid,
 693                          unsigned int flags)
 694{
 695        static const char *warn_msg = "refname '%.*s' is ambiguous.";
 696        static const char *object_name_msg = N_(
 697        "Git normally never creates a ref that ends with 40 hex characters\n"
 698        "because it will be ignored when you just specify 40-hex. These refs\n"
 699        "may be created by mistake. For example,\n"
 700        "\n"
 701        "  git checkout -b $br $(git rev-parse ...)\n"
 702        "\n"
 703        "where \"$br\" is somehow empty and a 40-hex ref is created. Please\n"
 704        "examine these refs and maybe delete them. Turn this message off by\n"
 705        "running \"git config advice.objectNameWarning false\"");
 706        struct object_id tmp_oid;
 707        char *real_ref = NULL;
 708        int refs_found = 0;
 709        int at, reflog_len, nth_prior = 0;
 710
 711        if (len == GIT_SHA1_HEXSZ && !get_oid_hex(str, oid)) {
 712                if (warn_ambiguous_refs && warn_on_object_refname_ambiguity) {
 713                        refs_found = dwim_ref(str, len, &tmp_oid, &real_ref);
 714                        if (refs_found > 0) {
 715                                warning(warn_msg, len, str);
 716                                if (advice_object_name_warning)
 717                                        fprintf(stderr, "%s\n", _(object_name_msg));
 718                        }
 719                        free(real_ref);
 720                }
 721                return 0;
 722        }
 723
 724        /* basic@{time or number or -number} format to query ref-log */
 725        reflog_len = at = 0;
 726        if (len && str[len-1] == '}') {
 727                for (at = len-4; at >= 0; at--) {
 728                        if (str[at] == '@' && str[at+1] == '{') {
 729                                if (str[at+2] == '-') {
 730                                        if (at != 0)
 731                                                /* @{-N} not at start */
 732                                                return -1;
 733                                        nth_prior = 1;
 734                                        continue;
 735                                }
 736                                if (!upstream_mark(str + at, len - at) &&
 737                                    !push_mark(str + at, len - at)) {
 738                                        reflog_len = (len-1) - (at+2);
 739                                        len = at;
 740                                }
 741                                break;
 742                        }
 743                }
 744        }
 745
 746        /* Accept only unambiguous ref paths. */
 747        if (len && ambiguous_path(str, len))
 748                return -1;
 749
 750        if (nth_prior) {
 751                struct strbuf buf = STRBUF_INIT;
 752                int detached;
 753
 754                if (interpret_nth_prior_checkout(str, len, &buf) > 0) {
 755                        detached = (buf.len == GIT_SHA1_HEXSZ && !get_oid_hex(buf.buf, oid));
 756                        strbuf_release(&buf);
 757                        if (detached)
 758                                return 0;
 759                }
 760        }
 761
 762        if (!len && reflog_len)
 763                /* allow "@{...}" to mean the current branch reflog */
 764                refs_found = dwim_ref("HEAD", 4, oid, &real_ref);
 765        else if (reflog_len)
 766                refs_found = dwim_log(str, len, oid, &real_ref);
 767        else
 768                refs_found = dwim_ref(str, len, oid, &real_ref);
 769
 770        if (!refs_found)
 771                return -1;
 772
 773        if (warn_ambiguous_refs && !(flags & GET_OID_QUIETLY) &&
 774            (refs_found > 1 ||
 775             !get_short_oid(str, len, &tmp_oid, GET_OID_QUIETLY)))
 776                warning(warn_msg, len, str);
 777
 778        if (reflog_len) {
 779                int nth, i;
 780                timestamp_t at_time;
 781                timestamp_t co_time;
 782                int co_tz, co_cnt;
 783
 784                /* Is it asking for N-th entry, or approxidate? */
 785                for (i = nth = 0; 0 <= nth && i < reflog_len; i++) {
 786                        char ch = str[at+2+i];
 787                        if ('0' <= ch && ch <= '9')
 788                                nth = nth * 10 + ch - '0';
 789                        else
 790                                nth = -1;
 791                }
 792                if (100000000 <= nth) {
 793                        at_time = nth;
 794                        nth = -1;
 795                } else if (0 <= nth)
 796                        at_time = 0;
 797                else {
 798                        int errors = 0;
 799                        char *tmp = xstrndup(str + at + 2, reflog_len);
 800                        at_time = approxidate_careful(tmp, &errors);
 801                        free(tmp);
 802                        if (errors) {
 803                                free(real_ref);
 804                                return -1;
 805                        }
 806                }
 807                if (read_ref_at(real_ref, flags, at_time, nth, oid, NULL,
 808                                &co_time, &co_tz, &co_cnt)) {
 809                        if (!len) {
 810                                if (starts_with(real_ref, "refs/heads/")) {
 811                                        str = real_ref + 11;
 812                                        len = strlen(real_ref + 11);
 813                                } else {
 814                                        /* detached HEAD */
 815                                        str = "HEAD";
 816                                        len = 4;
 817                                }
 818                        }
 819                        if (at_time) {
 820                                if (!(flags & GET_OID_QUIETLY)) {
 821                                        warning("Log for '%.*s' only goes "
 822                                                "back to %s.", len, str,
 823                                                show_date(co_time, co_tz, DATE_MODE(RFC2822)));
 824                                }
 825                        } else {
 826                                if (flags & GET_OID_QUIETLY) {
 827                                        exit(128);
 828                                }
 829                                die("Log for '%.*s' only has %d entries.",
 830                                    len, str, co_cnt);
 831                        }
 832                }
 833        }
 834
 835        free(real_ref);
 836        return 0;
 837}
 838
 839static int get_parent(const char *name, int len,
 840                      struct object_id *result, int idx)
 841{
 842        struct object_id oid;
 843        int ret = get_oid_1(name, len, &oid, GET_OID_COMMITTISH);
 844        struct commit *commit;
 845        struct commit_list *p;
 846
 847        if (ret)
 848                return ret;
 849        commit = lookup_commit_reference(the_repository, &oid);
 850        if (parse_commit(commit))
 851                return -1;
 852        if (!idx) {
 853                oidcpy(result, &commit->object.oid);
 854                return 0;
 855        }
 856        p = commit->parents;
 857        while (p) {
 858                if (!--idx) {
 859                        oidcpy(result, &p->item->object.oid);
 860                        return 0;
 861                }
 862                p = p->next;
 863        }
 864        return -1;
 865}
 866
 867static int get_nth_ancestor(const char *name, int len,
 868                            struct object_id *result, int generation)
 869{
 870        struct object_id oid;
 871        struct commit *commit;
 872        int ret;
 873
 874        ret = get_oid_1(name, len, &oid, GET_OID_COMMITTISH);
 875        if (ret)
 876                return ret;
 877        commit = lookup_commit_reference(the_repository, &oid);
 878        if (!commit)
 879                return -1;
 880
 881        while (generation--) {
 882                if (parse_commit(commit) || !commit->parents)
 883                        return -1;
 884                commit = commit->parents->item;
 885        }
 886        oidcpy(result, &commit->object.oid);
 887        return 0;
 888}
 889
 890struct object *peel_to_type(const char *name, int namelen,
 891                            struct object *o, enum object_type expected_type)
 892{
 893        if (name && !namelen)
 894                namelen = strlen(name);
 895        while (1) {
 896                if (!o || (!o->parsed && !parse_object(the_repository, &o->oid)))
 897                        return NULL;
 898                if (expected_type == OBJ_ANY || o->type == expected_type)
 899                        return o;
 900                if (o->type == OBJ_TAG)
 901                        o = ((struct tag*) o)->tagged;
 902                else if (o->type == OBJ_COMMIT)
 903                        o = &(get_commit_tree(((struct commit *)o))->object);
 904                else {
 905                        if (name)
 906                                error("%.*s: expected %s type, but the object "
 907                                      "dereferences to %s type",
 908                                      namelen, name, type_name(expected_type),
 909                                      type_name(o->type));
 910                        return NULL;
 911                }
 912        }
 913}
 914
 915static int peel_onion(const char *name, int len, struct object_id *oid,
 916                      unsigned lookup_flags)
 917{
 918        struct object_id outer;
 919        const char *sp;
 920        unsigned int expected_type = 0;
 921        struct object *o;
 922
 923        /*
 924         * "ref^{type}" dereferences ref repeatedly until you cannot
 925         * dereference anymore, or you get an object of given type,
 926         * whichever comes first.  "ref^{}" means just dereference
 927         * tags until you get a non-tag.  "ref^0" is a shorthand for
 928         * "ref^{commit}".  "commit^{tree}" could be used to find the
 929         * top-level tree of the given commit.
 930         */
 931        if (len < 4 || name[len-1] != '}')
 932                return -1;
 933
 934        for (sp = name + len - 1; name <= sp; sp--) {
 935                int ch = *sp;
 936                if (ch == '{' && name < sp && sp[-1] == '^')
 937                        break;
 938        }
 939        if (sp <= name)
 940                return -1;
 941
 942        sp++; /* beginning of type name, or closing brace for empty */
 943        if (starts_with(sp, "commit}"))
 944                expected_type = OBJ_COMMIT;
 945        else if (starts_with(sp, "tag}"))
 946                expected_type = OBJ_TAG;
 947        else if (starts_with(sp, "tree}"))
 948                expected_type = OBJ_TREE;
 949        else if (starts_with(sp, "blob}"))
 950                expected_type = OBJ_BLOB;
 951        else if (starts_with(sp, "object}"))
 952                expected_type = OBJ_ANY;
 953        else if (sp[0] == '}')
 954                expected_type = OBJ_NONE;
 955        else if (sp[0] == '/')
 956                expected_type = OBJ_COMMIT;
 957        else
 958                return -1;
 959
 960        lookup_flags &= ~GET_OID_DISAMBIGUATORS;
 961        if (expected_type == OBJ_COMMIT)
 962                lookup_flags |= GET_OID_COMMITTISH;
 963        else if (expected_type == OBJ_TREE)
 964                lookup_flags |= GET_OID_TREEISH;
 965
 966        if (get_oid_1(name, sp - name - 2, &outer, lookup_flags))
 967                return -1;
 968
 969        o = parse_object(the_repository, &outer);
 970        if (!o)
 971                return -1;
 972        if (!expected_type) {
 973                o = deref_tag(the_repository, o, name, sp - name - 2);
 974                if (!o || (!o->parsed && !parse_object(the_repository, &o->oid)))
 975                        return -1;
 976                oidcpy(oid, &o->oid);
 977                return 0;
 978        }
 979
 980        /*
 981         * At this point, the syntax look correct, so
 982         * if we do not get the needed object, we should
 983         * barf.
 984         */
 985        o = peel_to_type(name, len, o, expected_type);
 986        if (!o)
 987                return -1;
 988
 989        oidcpy(oid, &o->oid);
 990        if (sp[0] == '/') {
 991                /* "$commit^{/foo}" */
 992                char *prefix;
 993                int ret;
 994                struct commit_list *list = NULL;
 995
 996                /*
 997                 * $commit^{/}. Some regex implementation may reject.
 998                 * We don't need regex anyway. '' pattern always matches.
 999                 */
1000                if (sp[1] == '}')
1001                        return 0;
1002
1003                prefix = xstrndup(sp + 1, name + len - 1 - (sp + 1));
1004                commit_list_insert((struct commit *)o, &list);
1005                ret = get_oid_oneline(prefix, oid, list);
1006                free(prefix);
1007                return ret;
1008        }
1009        return 0;
1010}
1011
1012static int get_describe_name(const char *name, int len, struct object_id *oid)
1013{
1014        const char *cp;
1015        unsigned flags = GET_OID_QUIETLY | GET_OID_COMMIT;
1016
1017        for (cp = name + len - 1; name + 2 <= cp; cp--) {
1018                char ch = *cp;
1019                if (!isxdigit(ch)) {
1020                        /* We must be looking at g in "SOMETHING-g"
1021                         * for it to be describe output.
1022                         */
1023                        if (ch == 'g' && cp[-1] == '-') {
1024                                cp++;
1025                                len -= cp - name;
1026                                return get_short_oid(cp, len, oid, flags);
1027                        }
1028                }
1029        }
1030        return -1;
1031}
1032
1033static int get_oid_1(const char *name, int len, struct object_id *oid, unsigned lookup_flags)
1034{
1035        int ret, has_suffix;
1036        const char *cp;
1037
1038        /*
1039         * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
1040         */
1041        has_suffix = 0;
1042        for (cp = name + len - 1; name <= cp; cp--) {
1043                int ch = *cp;
1044                if ('0' <= ch && ch <= '9')
1045                        continue;
1046                if (ch == '~' || ch == '^')
1047                        has_suffix = ch;
1048                break;
1049        }
1050
1051        if (has_suffix) {
1052                int num = 0;
1053                int len1 = cp - name;
1054                cp++;
1055                while (cp < name + len)
1056                        num = num * 10 + *cp++ - '0';
1057                if (!num && len1 == len - 1)
1058                        num = 1;
1059                if (has_suffix == '^')
1060                        return get_parent(name, len1, oid, num);
1061                /* else if (has_suffix == '~') -- goes without saying */
1062                return get_nth_ancestor(name, len1, oid, num);
1063        }
1064
1065        ret = peel_onion(name, len, oid, lookup_flags);
1066        if (!ret)
1067                return 0;
1068
1069        ret = get_oid_basic(name, len, oid, lookup_flags);
1070        if (!ret)
1071                return 0;
1072
1073        /* It could be describe output that is "SOMETHING-gXXXX" */
1074        ret = get_describe_name(name, len, oid);
1075        if (!ret)
1076                return 0;
1077
1078        return get_short_oid(name, len, oid, lookup_flags);
1079}
1080
1081/*
1082 * This interprets names like ':/Initial revision of "git"' by searching
1083 * through history and returning the first commit whose message starts
1084 * the given regular expression.
1085 *
1086 * For negative-matching, prefix the pattern-part with '!-', like: ':/!-WIP'.
1087 *
1088 * For a literal '!' character at the beginning of a pattern, you have to repeat
1089 * that, like: ':/!!foo'
1090 *
1091 * For future extension, all other sequences beginning with ':/!' are reserved.
1092 */
1093
1094/* Remember to update object flag allocation in object.h */
1095#define ONELINE_SEEN (1u<<20)
1096
1097static int handle_one_ref(const char *path, const struct object_id *oid,
1098                          int flag, void *cb_data)
1099{
1100        struct commit_list **list = cb_data;
1101        struct object *object = parse_object(the_repository, oid);
1102        if (!object)
1103                return 0;
1104        if (object->type == OBJ_TAG) {
1105                object = deref_tag(the_repository, object, path,
1106                                   strlen(path));
1107                if (!object)
1108                        return 0;
1109        }
1110        if (object->type != OBJ_COMMIT)
1111                return 0;
1112        commit_list_insert((struct commit *)object, list);
1113        return 0;
1114}
1115
1116static int get_oid_oneline(const char *prefix, struct object_id *oid,
1117                            struct commit_list *list)
1118{
1119        struct commit_list *backup = NULL, *l;
1120        int found = 0;
1121        int negative = 0;
1122        regex_t regex;
1123
1124        if (prefix[0] == '!') {
1125                prefix++;
1126
1127                if (prefix[0] == '-') {
1128                        prefix++;
1129                        negative = 1;
1130                } else if (prefix[0] != '!') {
1131                        return -1;
1132                }
1133        }
1134
1135        if (regcomp(&regex, prefix, REG_EXTENDED))
1136                return -1;
1137
1138        for (l = list; l; l = l->next) {
1139                l->item->object.flags |= ONELINE_SEEN;
1140                commit_list_insert(l->item, &backup);
1141        }
1142        while (list) {
1143                const char *p, *buf;
1144                struct commit *commit;
1145                int matches;
1146
1147                commit = pop_most_recent_commit(&list, ONELINE_SEEN);
1148                if (!parse_object(the_repository, &commit->object.oid))
1149                        continue;
1150                buf = get_commit_buffer(commit, NULL);
1151                p = strstr(buf, "\n\n");
1152                matches = negative ^ (p && !regexec(&regex, p + 2, 0, NULL, 0));
1153                unuse_commit_buffer(commit, buf);
1154
1155                if (matches) {
1156                        oidcpy(oid, &commit->object.oid);
1157                        found = 1;
1158                        break;
1159                }
1160        }
1161        regfree(&regex);
1162        free_commit_list(list);
1163        for (l = backup; l; l = l->next)
1164                clear_commit_marks(l->item, ONELINE_SEEN);
1165        free_commit_list(backup);
1166        return found ? 0 : -1;
1167}
1168
1169struct grab_nth_branch_switch_cbdata {
1170        int remaining;
1171        struct strbuf buf;
1172};
1173
1174static int grab_nth_branch_switch(struct object_id *ooid, struct object_id *noid,
1175                                  const char *email, timestamp_t timestamp, int tz,
1176                                  const char *message, void *cb_data)
1177{
1178        struct grab_nth_branch_switch_cbdata *cb = cb_data;
1179        const char *match = NULL, *target = NULL;
1180        size_t len;
1181
1182        if (skip_prefix(message, "checkout: moving from ", &match))
1183                target = strstr(match, " to ");
1184
1185        if (!match || !target)
1186                return 0;
1187        if (--(cb->remaining) == 0) {
1188                len = target - match;
1189                strbuf_reset(&cb->buf);
1190                strbuf_add(&cb->buf, match, len);
1191                return 1; /* we are done */
1192        }
1193        return 0;
1194}
1195
1196/*
1197 * Parse @{-N} syntax, return the number of characters parsed
1198 * if successful; otherwise signal an error with negative value.
1199 */
1200static int interpret_nth_prior_checkout(const char *name, int namelen,
1201                                        struct strbuf *buf)
1202{
1203        long nth;
1204        int retval;
1205        struct grab_nth_branch_switch_cbdata cb;
1206        const char *brace;
1207        char *num_end;
1208
1209        if (namelen < 4)
1210                return -1;
1211        if (name[0] != '@' || name[1] != '{' || name[2] != '-')
1212                return -1;
1213        brace = memchr(name, '}', namelen);
1214        if (!brace)
1215                return -1;
1216        nth = strtol(name + 3, &num_end, 10);
1217        if (num_end != brace)
1218                return -1;
1219        if (nth <= 0)
1220                return -1;
1221        cb.remaining = nth;
1222        strbuf_init(&cb.buf, 20);
1223
1224        retval = 0;
1225        if (0 < for_each_reflog_ent_reverse("HEAD", grab_nth_branch_switch, &cb)) {
1226                strbuf_reset(buf);
1227                strbuf_addbuf(buf, &cb.buf);
1228                retval = brace - name + 1;
1229        }
1230
1231        strbuf_release(&cb.buf);
1232        return retval;
1233}
1234
1235int get_oid_mb(const char *name, struct object_id *oid)
1236{
1237        struct commit *one, *two;
1238        struct commit_list *mbs;
1239        struct object_id oid_tmp;
1240        const char *dots;
1241        int st;
1242
1243        dots = strstr(name, "...");
1244        if (!dots)
1245                return get_oid(name, oid);
1246        if (dots == name)
1247                st = get_oid("HEAD", &oid_tmp);
1248        else {
1249                struct strbuf sb;
1250                strbuf_init(&sb, dots - name);
1251                strbuf_add(&sb, name, dots - name);
1252                st = get_oid_committish(sb.buf, &oid_tmp);
1253                strbuf_release(&sb);
1254        }
1255        if (st)
1256                return st;
1257        one = lookup_commit_reference_gently(the_repository, &oid_tmp, 0);
1258        if (!one)
1259                return -1;
1260
1261        if (get_oid_committish(dots[3] ? (dots + 3) : "HEAD", &oid_tmp))
1262                return -1;
1263        two = lookup_commit_reference_gently(the_repository, &oid_tmp, 0);
1264        if (!two)
1265                return -1;
1266        mbs = get_merge_bases(one, two);
1267        if (!mbs || mbs->next)
1268                st = -1;
1269        else {
1270                st = 0;
1271                oidcpy(oid, &mbs->item->object.oid);
1272        }
1273        free_commit_list(mbs);
1274        return st;
1275}
1276
1277/* parse @something syntax, when 'something' is not {.*} */
1278static int interpret_empty_at(const char *name, int namelen, int len, struct strbuf *buf)
1279{
1280        const char *next;
1281
1282        if (len || name[1] == '{')
1283                return -1;
1284
1285        /* make sure it's a single @, or @@{.*}, not @foo */
1286        next = memchr(name + len + 1, '@', namelen - len - 1);
1287        if (next && next[1] != '{')
1288                return -1;
1289        if (!next)
1290                next = name + namelen;
1291        if (next != name + 1)
1292                return -1;
1293
1294        strbuf_reset(buf);
1295        strbuf_add(buf, "HEAD", 4);
1296        return 1;
1297}
1298
1299static int reinterpret(const char *name, int namelen, int len,
1300                       struct strbuf *buf, unsigned allowed)
1301{
1302        /* we have extra data, which might need further processing */
1303        struct strbuf tmp = STRBUF_INIT;
1304        int used = buf->len;
1305        int ret;
1306
1307        strbuf_add(buf, name + len, namelen - len);
1308        ret = interpret_branch_name(buf->buf, buf->len, &tmp, allowed);
1309        /* that data was not interpreted, remove our cruft */
1310        if (ret < 0) {
1311                strbuf_setlen(buf, used);
1312                return len;
1313        }
1314        strbuf_reset(buf);
1315        strbuf_addbuf(buf, &tmp);
1316        strbuf_release(&tmp);
1317        /* tweak for size of {-N} versus expanded ref name */
1318        return ret - used + len;
1319}
1320
1321static void set_shortened_ref(struct strbuf *buf, const char *ref)
1322{
1323        char *s = shorten_unambiguous_ref(ref, 0);
1324        strbuf_reset(buf);
1325        strbuf_addstr(buf, s);
1326        free(s);
1327}
1328
1329static int branch_interpret_allowed(const char *refname, unsigned allowed)
1330{
1331        if (!allowed)
1332                return 1;
1333
1334        if ((allowed & INTERPRET_BRANCH_LOCAL) &&
1335            starts_with(refname, "refs/heads/"))
1336                return 1;
1337        if ((allowed & INTERPRET_BRANCH_REMOTE) &&
1338            starts_with(refname, "refs/remotes/"))
1339                return 1;
1340
1341        return 0;
1342}
1343
1344static int interpret_branch_mark(const char *name, int namelen,
1345                                 int at, struct strbuf *buf,
1346                                 int (*get_mark)(const char *, int),
1347                                 const char *(*get_data)(struct branch *,
1348                                                         struct strbuf *),
1349                                 unsigned allowed)
1350{
1351        int len;
1352        struct branch *branch;
1353        struct strbuf err = STRBUF_INIT;
1354        const char *value;
1355
1356        len = get_mark(name + at, namelen - at);
1357        if (!len)
1358                return -1;
1359
1360        if (memchr(name, ':', at))
1361                return -1;
1362
1363        if (at) {
1364                char *name_str = xmemdupz(name, at);
1365                branch = branch_get(name_str);
1366                free(name_str);
1367        } else
1368                branch = branch_get(NULL);
1369
1370        value = get_data(branch, &err);
1371        if (!value)
1372                die("%s", err.buf);
1373
1374        if (!branch_interpret_allowed(value, allowed))
1375                return -1;
1376
1377        set_shortened_ref(buf, value);
1378        return len + at;
1379}
1380
1381int interpret_branch_name(const char *name, int namelen, struct strbuf *buf,
1382                          unsigned allowed)
1383{
1384        char *at;
1385        const char *start;
1386        int len;
1387
1388        if (!namelen)
1389                namelen = strlen(name);
1390
1391        if (!allowed || (allowed & INTERPRET_BRANCH_LOCAL)) {
1392                len = interpret_nth_prior_checkout(name, namelen, buf);
1393                if (!len) {
1394                        return len; /* syntax Ok, not enough switches */
1395                } else if (len > 0) {
1396                        if (len == namelen)
1397                                return len; /* consumed all */
1398                        else
1399                                return reinterpret(name, namelen, len, buf, allowed);
1400                }
1401        }
1402
1403        for (start = name;
1404             (at = memchr(start, '@', namelen - (start - name)));
1405             start = at + 1) {
1406
1407                if (!allowed || (allowed & INTERPRET_BRANCH_HEAD)) {
1408                        len = interpret_empty_at(name, namelen, at - name, buf);
1409                        if (len > 0)
1410                                return reinterpret(name, namelen, len, buf,
1411                                                   allowed);
1412                }
1413
1414                len = interpret_branch_mark(name, namelen, at - name, buf,
1415                                            upstream_mark, branch_get_upstream,
1416                                            allowed);
1417                if (len > 0)
1418                        return len;
1419
1420                len = interpret_branch_mark(name, namelen, at - name, buf,
1421                                            push_mark, branch_get_push,
1422                                            allowed);
1423                if (len > 0)
1424                        return len;
1425        }
1426
1427        return -1;
1428}
1429
1430void strbuf_branchname(struct strbuf *sb, const char *name, unsigned allowed)
1431{
1432        int len = strlen(name);
1433        int used = interpret_branch_name(name, len, sb, allowed);
1434
1435        if (used < 0)
1436                used = 0;
1437        strbuf_add(sb, name + used, len - used);
1438}
1439
1440int strbuf_check_branch_ref(struct strbuf *sb, const char *name)
1441{
1442        if (startup_info->have_repository)
1443                strbuf_branchname(sb, name, INTERPRET_BRANCH_LOCAL);
1444        else
1445                strbuf_addstr(sb, name);
1446
1447        /*
1448         * This splice must be done even if we end up rejecting the
1449         * name; builtin/branch.c::copy_or_rename_branch() still wants
1450         * to see what the name expanded to so that "branch -m" can be
1451         * used as a tool to correct earlier mistakes.
1452         */
1453        strbuf_splice(sb, 0, 0, "refs/heads/", 11);
1454
1455        if (*name == '-' ||
1456            !strcmp(sb->buf, "refs/heads/HEAD"))
1457                return -1;
1458
1459        return check_refname_format(sb->buf, 0);
1460}
1461
1462/*
1463 * This is like "get_oid_basic()", except it allows "object ID expressions",
1464 * notably "xyz^" for "parent of xyz"
1465 */
1466int get_oid(const char *name, struct object_id *oid)
1467{
1468        struct object_context unused;
1469        return get_oid_with_context(name, 0, oid, &unused);
1470}
1471
1472
1473/*
1474 * Many callers know that the user meant to name a commit-ish by
1475 * syntactical positions where the object name appears.  Calling this
1476 * function allows the machinery to disambiguate shorter-than-unique
1477 * abbreviated object names between commit-ish and others.
1478 *
1479 * Note that this does NOT error out when the named object is not a
1480 * commit-ish. It is merely to give a hint to the disambiguation
1481 * machinery.
1482 */
1483int get_oid_committish(const char *name, struct object_id *oid)
1484{
1485        struct object_context unused;
1486        return get_oid_with_context(name, GET_OID_COMMITTISH,
1487                                    oid, &unused);
1488}
1489
1490int get_oid_treeish(const char *name, struct object_id *oid)
1491{
1492        struct object_context unused;
1493        return get_oid_with_context(name, GET_OID_TREEISH,
1494                                    oid, &unused);
1495}
1496
1497int get_oid_commit(const char *name, struct object_id *oid)
1498{
1499        struct object_context unused;
1500        return get_oid_with_context(name, GET_OID_COMMIT,
1501                                    oid, &unused);
1502}
1503
1504int get_oid_tree(const char *name, struct object_id *oid)
1505{
1506        struct object_context unused;
1507        return get_oid_with_context(name, GET_OID_TREE,
1508                                    oid, &unused);
1509}
1510
1511int get_oid_blob(const char *name, struct object_id *oid)
1512{
1513        struct object_context unused;
1514        return get_oid_with_context(name, GET_OID_BLOB,
1515                                    oid, &unused);
1516}
1517
1518/* Must be called only when object_name:filename doesn't exist. */
1519static void diagnose_invalid_oid_path(const char *prefix,
1520                                      const char *filename,
1521                                      const struct object_id *tree_oid,
1522                                      const char *object_name,
1523                                      int object_name_len)
1524{
1525        struct object_id oid;
1526        unsigned mode;
1527
1528        if (!prefix)
1529                prefix = "";
1530
1531        if (file_exists(filename))
1532                die("Path '%s' exists on disk, but not in '%.*s'.",
1533                    filename, object_name_len, object_name);
1534        if (is_missing_file_error(errno)) {
1535                char *fullname = xstrfmt("%s%s", prefix, filename);
1536
1537                if (!get_tree_entry(tree_oid, fullname, &oid, &mode)) {
1538                        die("Path '%s' exists, but not '%s'.\n"
1539                            "Did you mean '%.*s:%s' aka '%.*s:./%s'?",
1540                            fullname,
1541                            filename,
1542                            object_name_len, object_name,
1543                            fullname,
1544                            object_name_len, object_name,
1545                            filename);
1546                }
1547                die("Path '%s' does not exist in '%.*s'",
1548                    filename, object_name_len, object_name);
1549        }
1550}
1551
1552/* Must be called only when :stage:filename doesn't exist. */
1553static void diagnose_invalid_index_path(int stage,
1554                                        const char *prefix,
1555                                        const char *filename)
1556{
1557        const struct cache_entry *ce;
1558        int pos;
1559        unsigned namelen = strlen(filename);
1560        struct strbuf fullname = STRBUF_INIT;
1561
1562        if (!prefix)
1563                prefix = "";
1564
1565        /* Wrong stage number? */
1566        pos = cache_name_pos(filename, namelen);
1567        if (pos < 0)
1568                pos = -pos - 1;
1569        if (pos < active_nr) {
1570                ce = active_cache[pos];
1571                if (ce_namelen(ce) == namelen &&
1572                    !memcmp(ce->name, filename, namelen))
1573                        die("Path '%s' is in the index, but not at stage %d.\n"
1574                            "Did you mean ':%d:%s'?",
1575                            filename, stage,
1576                            ce_stage(ce), filename);
1577        }
1578
1579        /* Confusion between relative and absolute filenames? */
1580        strbuf_addstr(&fullname, prefix);
1581        strbuf_addstr(&fullname, filename);
1582        pos = cache_name_pos(fullname.buf, fullname.len);
1583        if (pos < 0)
1584                pos = -pos - 1;
1585        if (pos < active_nr) {
1586                ce = active_cache[pos];
1587                if (ce_namelen(ce) == fullname.len &&
1588                    !memcmp(ce->name, fullname.buf, fullname.len))
1589                        die("Path '%s' is in the index, but not '%s'.\n"
1590                            "Did you mean ':%d:%s' aka ':%d:./%s'?",
1591                            fullname.buf, filename,
1592                            ce_stage(ce), fullname.buf,
1593                            ce_stage(ce), filename);
1594        }
1595
1596        if (file_exists(filename))
1597                die("Path '%s' exists on disk, but not in the index.", filename);
1598        if (is_missing_file_error(errno))
1599                die("Path '%s' does not exist (neither on disk nor in the index).",
1600                    filename);
1601
1602        strbuf_release(&fullname);
1603}
1604
1605
1606static char *resolve_relative_path(const char *rel)
1607{
1608        if (!starts_with(rel, "./") && !starts_with(rel, "../"))
1609                return NULL;
1610
1611        if (!is_inside_work_tree())
1612                die("relative path syntax can't be used outside working tree.");
1613
1614        /* die() inside prefix_path() if resolved path is outside worktree */
1615        return prefix_path(startup_info->prefix,
1616                           startup_info->prefix ? strlen(startup_info->prefix) : 0,
1617                           rel);
1618}
1619
1620static int get_oid_with_context_1(const char *name,
1621                                  unsigned flags,
1622                                  const char *prefix,
1623                                  struct object_id *oid,
1624                                  struct object_context *oc)
1625{
1626        int ret, bracket_depth;
1627        int namelen = strlen(name);
1628        const char *cp;
1629        int only_to_die = flags & GET_OID_ONLY_TO_DIE;
1630
1631        if (only_to_die)
1632                flags |= GET_OID_QUIETLY;
1633
1634        memset(oc, 0, sizeof(*oc));
1635        oc->mode = S_IFINVALID;
1636        strbuf_init(&oc->symlink_path, 0);
1637        ret = get_oid_1(name, namelen, oid, flags);
1638        if (!ret)
1639                return ret;
1640        /*
1641         * sha1:path --> object name of path in ent sha1
1642         * :path -> object name of absolute path in index
1643         * :./path -> object name of path relative to cwd in index
1644         * :[0-3]:path -> object name of path in index at stage
1645         * :/foo -> recent commit matching foo
1646         */
1647        if (name[0] == ':') {
1648                int stage = 0;
1649                const struct cache_entry *ce;
1650                char *new_path = NULL;
1651                int pos;
1652                if (!only_to_die && namelen > 2 && name[1] == '/') {
1653                        struct commit_list *list = NULL;
1654
1655                        for_each_ref(handle_one_ref, &list);
1656                        commit_list_sort_by_date(&list);
1657                        return get_oid_oneline(name + 2, oid, list);
1658                }
1659                if (namelen < 3 ||
1660                    name[2] != ':' ||
1661                    name[1] < '0' || '3' < name[1])
1662                        cp = name + 1;
1663                else {
1664                        stage = name[1] - '0';
1665                        cp = name + 3;
1666                }
1667                new_path = resolve_relative_path(cp);
1668                if (!new_path) {
1669                        namelen = namelen - (cp - name);
1670                } else {
1671                        cp = new_path;
1672                        namelen = strlen(cp);
1673                }
1674
1675                if (flags & GET_OID_RECORD_PATH)
1676                        oc->path = xstrdup(cp);
1677
1678                if (!active_cache)
1679                        read_cache();
1680                pos = cache_name_pos(cp, namelen);
1681                if (pos < 0)
1682                        pos = -pos - 1;
1683                while (pos < active_nr) {
1684                        ce = active_cache[pos];
1685                        if (ce_namelen(ce) != namelen ||
1686                            memcmp(ce->name, cp, namelen))
1687                                break;
1688                        if (ce_stage(ce) == stage) {
1689                                oidcpy(oid, &ce->oid);
1690                                oc->mode = ce->ce_mode;
1691                                free(new_path);
1692                                return 0;
1693                        }
1694                        pos++;
1695                }
1696                if (only_to_die && name[1] && name[1] != '/')
1697                        diagnose_invalid_index_path(stage, prefix, cp);
1698                free(new_path);
1699                return -1;
1700        }
1701        for (cp = name, bracket_depth = 0; *cp; cp++) {
1702                if (*cp == '{')
1703                        bracket_depth++;
1704                else if (bracket_depth && *cp == '}')
1705                        bracket_depth--;
1706                else if (!bracket_depth && *cp == ':')
1707                        break;
1708        }
1709        if (*cp == ':') {
1710                struct object_id tree_oid;
1711                int len = cp - name;
1712                unsigned sub_flags = flags;
1713
1714                sub_flags &= ~GET_OID_DISAMBIGUATORS;
1715                sub_flags |= GET_OID_TREEISH;
1716
1717                if (!get_oid_1(name, len, &tree_oid, sub_flags)) {
1718                        const char *filename = cp+1;
1719                        char *new_filename = NULL;
1720
1721                        new_filename = resolve_relative_path(filename);
1722                        if (new_filename)
1723                                filename = new_filename;
1724                        if (flags & GET_OID_FOLLOW_SYMLINKS) {
1725                                ret = get_tree_entry_follow_symlinks(&tree_oid,
1726                                        filename, oid, &oc->symlink_path,
1727                                        &oc->mode);
1728                        } else {
1729                                ret = get_tree_entry(&tree_oid, filename, oid,
1730                                                     &oc->mode);
1731                                if (ret && only_to_die) {
1732                                        diagnose_invalid_oid_path(prefix,
1733                                                                   filename,
1734                                                                   &tree_oid,
1735                                                                   name, len);
1736                                }
1737                        }
1738                        if (flags & GET_OID_RECORD_PATH)
1739                                oc->path = xstrdup(filename);
1740
1741                        free(new_filename);
1742                        return ret;
1743                } else {
1744                        if (only_to_die)
1745                                die("Invalid object name '%.*s'.", len, name);
1746                }
1747        }
1748        return ret;
1749}
1750
1751/*
1752 * Call this function when you know "name" given by the end user must
1753 * name an object but it doesn't; the function _may_ die with a better
1754 * diagnostic message than "no such object 'name'", e.g. "Path 'doc' does not
1755 * exist in 'HEAD'" when given "HEAD:doc", or it may return in which case
1756 * you have a chance to diagnose the error further.
1757 */
1758void maybe_die_on_misspelt_object_name(const char *name, const char *prefix)
1759{
1760        struct object_context oc;
1761        struct object_id oid;
1762        get_oid_with_context_1(name, GET_OID_ONLY_TO_DIE, prefix, &oid, &oc);
1763}
1764
1765int get_oid_with_context(const char *str, unsigned flags, struct object_id *oid, struct object_context *oc)
1766{
1767        if (flags & GET_OID_FOLLOW_SYMLINKS && flags & GET_OID_ONLY_TO_DIE)
1768                BUG("incompatible flags for get_sha1_with_context");
1769        return get_oid_with_context_1(str, flags, NULL, oid, oc);
1770}