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