sha1-name.con commit sha1-name.c: add repo_find_unique_abbrev_r() (8bb9557)
   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        struct repository *repo;
 518        const struct object_id *oid;
 519};
 520
 521static inline char get_hex_char_from_oid(const struct object_id *oid,
 522                                         unsigned int pos)
 523{
 524        static const char hex[] = "0123456789abcdef";
 525
 526        if ((pos & 1) == 0)
 527                return hex[oid->hash[pos >> 1] >> 4];
 528        else
 529                return hex[oid->hash[pos >> 1] & 0xf];
 530}
 531
 532static int extend_abbrev_len(const struct object_id *oid, void *cb_data)
 533{
 534        struct min_abbrev_data *mad = cb_data;
 535
 536        unsigned int i = mad->init_len;
 537        while (mad->hex[i] && mad->hex[i] == get_hex_char_from_oid(oid, i))
 538                i++;
 539
 540        if (i < GIT_MAX_RAWSZ && i >= mad->cur_len)
 541                mad->cur_len = i + 1;
 542
 543        return 0;
 544}
 545
 546static void find_abbrev_len_for_midx(struct multi_pack_index *m,
 547                                     struct min_abbrev_data *mad)
 548{
 549        int match = 0;
 550        uint32_t num, first = 0;
 551        struct object_id oid;
 552        const struct object_id *mad_oid;
 553
 554        if (!m->num_objects)
 555                return;
 556
 557        num = m->num_objects;
 558        mad_oid = mad->oid;
 559        match = bsearch_midx(mad_oid, m, &first);
 560
 561        /*
 562         * first is now the position in the packfile where we would insert
 563         * mad->hash if it does not exist (or the position of mad->hash if
 564         * it does exist). Hence, we consider a maximum of two objects
 565         * nearby for the abbreviation length.
 566         */
 567        mad->init_len = 0;
 568        if (!match) {
 569                if (nth_midxed_object_oid(&oid, m, first))
 570                        extend_abbrev_len(&oid, mad);
 571        } else if (first < num - 1) {
 572                if (nth_midxed_object_oid(&oid, m, first + 1))
 573                        extend_abbrev_len(&oid, mad);
 574        }
 575        if (first > 0) {
 576                if (nth_midxed_object_oid(&oid, m, first - 1))
 577                        extend_abbrev_len(&oid, mad);
 578        }
 579        mad->init_len = mad->cur_len;
 580}
 581
 582static void find_abbrev_len_for_pack(struct packed_git *p,
 583                                     struct min_abbrev_data *mad)
 584{
 585        int match = 0;
 586        uint32_t num, first = 0;
 587        struct object_id oid;
 588        const struct object_id *mad_oid;
 589
 590        if (open_pack_index(p) || !p->num_objects)
 591                return;
 592
 593        num = p->num_objects;
 594        mad_oid = mad->oid;
 595        match = bsearch_pack(mad_oid, p, &first);
 596
 597        /*
 598         * first is now the position in the packfile where we would insert
 599         * mad->hash if it does not exist (or the position of mad->hash if
 600         * it does exist). Hence, we consider a maximum of two objects
 601         * nearby for the abbreviation length.
 602         */
 603        mad->init_len = 0;
 604        if (!match) {
 605                if (nth_packed_object_oid(&oid, p, first))
 606                        extend_abbrev_len(&oid, mad);
 607        } else if (first < num - 1) {
 608                if (nth_packed_object_oid(&oid, p, first + 1))
 609                        extend_abbrev_len(&oid, mad);
 610        }
 611        if (first > 0) {
 612                if (nth_packed_object_oid(&oid, p, first - 1))
 613                        extend_abbrev_len(&oid, mad);
 614        }
 615        mad->init_len = mad->cur_len;
 616}
 617
 618static void find_abbrev_len_packed(struct min_abbrev_data *mad)
 619{
 620        struct multi_pack_index *m;
 621        struct packed_git *p;
 622
 623        for (m = get_multi_pack_index(mad->repo); m; m = m->next)
 624                find_abbrev_len_for_midx(m, mad);
 625        for (p = get_packed_git(mad->repo); p; p = p->next)
 626                find_abbrev_len_for_pack(p, mad);
 627}
 628
 629int repo_find_unique_abbrev_r(struct repository *r, char *hex,
 630                              const struct object_id *oid, int len)
 631{
 632        struct disambiguate_state ds;
 633        struct min_abbrev_data mad;
 634        struct object_id oid_ret;
 635        const unsigned hexsz = r->hash_algo->hexsz;
 636
 637        if (len < 0) {
 638                unsigned long count = repo_approximate_object_count(r);
 639                /*
 640                 * Add one because the MSB only tells us the highest bit set,
 641                 * not including the value of all the _other_ bits (so "15"
 642                 * is only one off of 2^4, but the MSB is the 3rd bit.
 643                 */
 644                len = msb(count) + 1;
 645                /*
 646                 * We now know we have on the order of 2^len objects, which
 647                 * expects a collision at 2^(len/2). But we also care about hex
 648                 * chars, not bits, and there are 4 bits per hex. So all
 649                 * together we need to divide by 2 and round up.
 650                 */
 651                len = DIV_ROUND_UP(len, 2);
 652                /*
 653                 * For very small repos, we stick with our regular fallback.
 654                 */
 655                if (len < FALLBACK_DEFAULT_ABBREV)
 656                        len = FALLBACK_DEFAULT_ABBREV;
 657        }
 658
 659        oid_to_hex_r(hex, oid);
 660        if (len == hexsz || !len)
 661                return hexsz;
 662
 663        mad.repo = r;
 664        mad.init_len = len;
 665        mad.cur_len = len;
 666        mad.hex = hex;
 667        mad.oid = oid;
 668
 669        find_abbrev_len_packed(&mad);
 670
 671        if (init_object_disambiguation(hex, mad.cur_len, &ds) < 0)
 672                return -1;
 673
 674        ds.fn = extend_abbrev_len;
 675        ds.always_call_fn = 1;
 676        ds.cb_data = (void *)&mad;
 677
 678        find_short_object_filename(&ds);
 679        (void)finish_object_disambiguation(&ds, &oid_ret);
 680
 681        hex[mad.cur_len] = 0;
 682        return mad.cur_len;
 683}
 684
 685const char *repo_find_unique_abbrev(struct repository *r,
 686                                    const struct object_id *oid,
 687                                    int len)
 688{
 689        static int bufno;
 690        static char hexbuffer[4][GIT_MAX_HEXSZ + 1];
 691        char *hex = hexbuffer[bufno];
 692        bufno = (bufno + 1) % ARRAY_SIZE(hexbuffer);
 693        repo_find_unique_abbrev_r(r, hex, oid, len);
 694        return hex;
 695}
 696
 697static int ambiguous_path(const char *path, int len)
 698{
 699        int slash = 1;
 700        int cnt;
 701
 702        for (cnt = 0; cnt < len; cnt++) {
 703                switch (*path++) {
 704                case '\0':
 705                        break;
 706                case '/':
 707                        if (slash)
 708                                break;
 709                        slash = 1;
 710                        continue;
 711                case '.':
 712                        continue;
 713                default:
 714                        slash = 0;
 715                        continue;
 716                }
 717                break;
 718        }
 719        return slash;
 720}
 721
 722static inline int at_mark(const char *string, int len,
 723                          const char **suffix, int nr)
 724{
 725        int i;
 726
 727        for (i = 0; i < nr; i++) {
 728                int suffix_len = strlen(suffix[i]);
 729                if (suffix_len <= len
 730                    && !strncasecmp(string, suffix[i], suffix_len))
 731                        return suffix_len;
 732        }
 733        return 0;
 734}
 735
 736static inline int upstream_mark(const char *string, int len)
 737{
 738        const char *suffix[] = { "@{upstream}", "@{u}" };
 739        return at_mark(string, len, suffix, ARRAY_SIZE(suffix));
 740}
 741
 742static inline int push_mark(const char *string, int len)
 743{
 744        const char *suffix[] = { "@{push}" };
 745        return at_mark(string, len, suffix, ARRAY_SIZE(suffix));
 746}
 747
 748static enum get_oid_result get_oid_1(const char *name, int len, struct object_id *oid, unsigned lookup_flags);
 749static int interpret_nth_prior_checkout(const char *name, int namelen, struct strbuf *buf);
 750
 751static int get_oid_basic(const char *str, int len, struct object_id *oid,
 752                          unsigned int flags)
 753{
 754        static const char *warn_msg = "refname '%.*s' is ambiguous.";
 755        static const char *object_name_msg = N_(
 756        "Git normally never creates a ref that ends with 40 hex characters\n"
 757        "because it will be ignored when you just specify 40-hex. These refs\n"
 758        "may be created by mistake. For example,\n"
 759        "\n"
 760        "  git checkout -b $br $(git rev-parse ...)\n"
 761        "\n"
 762        "where \"$br\" is somehow empty and a 40-hex ref is created. Please\n"
 763        "examine these refs and maybe delete them. Turn this message off by\n"
 764        "running \"git config advice.objectNameWarning false\"");
 765        struct object_id tmp_oid;
 766        char *real_ref = NULL;
 767        int refs_found = 0;
 768        int at, reflog_len, nth_prior = 0;
 769
 770        if (len == the_hash_algo->hexsz && !get_oid_hex(str, oid)) {
 771                if (warn_ambiguous_refs && warn_on_object_refname_ambiguity) {
 772                        refs_found = dwim_ref(str, len, &tmp_oid, &real_ref);
 773                        if (refs_found > 0) {
 774                                warning(warn_msg, len, str);
 775                                if (advice_object_name_warning)
 776                                        fprintf(stderr, "%s\n", _(object_name_msg));
 777                        }
 778                        free(real_ref);
 779                }
 780                return 0;
 781        }
 782
 783        /* basic@{time or number or -number} format to query ref-log */
 784        reflog_len = at = 0;
 785        if (len && str[len-1] == '}') {
 786                for (at = len-4; at >= 0; at--) {
 787                        if (str[at] == '@' && str[at+1] == '{') {
 788                                if (str[at+2] == '-') {
 789                                        if (at != 0)
 790                                                /* @{-N} not at start */
 791                                                return -1;
 792                                        nth_prior = 1;
 793                                        continue;
 794                                }
 795                                if (!upstream_mark(str + at, len - at) &&
 796                                    !push_mark(str + at, len - at)) {
 797                                        reflog_len = (len-1) - (at+2);
 798                                        len = at;
 799                                }
 800                                break;
 801                        }
 802                }
 803        }
 804
 805        /* Accept only unambiguous ref paths. */
 806        if (len && ambiguous_path(str, len))
 807                return -1;
 808
 809        if (nth_prior) {
 810                struct strbuf buf = STRBUF_INIT;
 811                int detached;
 812
 813                if (interpret_nth_prior_checkout(str, len, &buf) > 0) {
 814                        detached = (buf.len == the_hash_algo->hexsz && !get_oid_hex(buf.buf, oid));
 815                        strbuf_release(&buf);
 816                        if (detached)
 817                                return 0;
 818                }
 819        }
 820
 821        if (!len && reflog_len)
 822                /* allow "@{...}" to mean the current branch reflog */
 823                refs_found = dwim_ref("HEAD", 4, oid, &real_ref);
 824        else if (reflog_len)
 825                refs_found = dwim_log(str, len, oid, &real_ref);
 826        else
 827                refs_found = dwim_ref(str, len, oid, &real_ref);
 828
 829        if (!refs_found)
 830                return -1;
 831
 832        if (warn_ambiguous_refs && !(flags & GET_OID_QUIETLY) &&
 833            (refs_found > 1 ||
 834             !get_short_oid(str, len, &tmp_oid, GET_OID_QUIETLY)))
 835                warning(warn_msg, len, str);
 836
 837        if (reflog_len) {
 838                int nth, i;
 839                timestamp_t at_time;
 840                timestamp_t co_time;
 841                int co_tz, co_cnt;
 842
 843                /* Is it asking for N-th entry, or approxidate? */
 844                for (i = nth = 0; 0 <= nth && i < reflog_len; i++) {
 845                        char ch = str[at+2+i];
 846                        if ('0' <= ch && ch <= '9')
 847                                nth = nth * 10 + ch - '0';
 848                        else
 849                                nth = -1;
 850                }
 851                if (100000000 <= nth) {
 852                        at_time = nth;
 853                        nth = -1;
 854                } else if (0 <= nth)
 855                        at_time = 0;
 856                else {
 857                        int errors = 0;
 858                        char *tmp = xstrndup(str + at + 2, reflog_len);
 859                        at_time = approxidate_careful(tmp, &errors);
 860                        free(tmp);
 861                        if (errors) {
 862                                free(real_ref);
 863                                return -1;
 864                        }
 865                }
 866                if (read_ref_at(get_main_ref_store(the_repository),
 867                                real_ref, flags, at_time, nth, oid, NULL,
 868                                &co_time, &co_tz, &co_cnt)) {
 869                        if (!len) {
 870                                if (starts_with(real_ref, "refs/heads/")) {
 871                                        str = real_ref + 11;
 872                                        len = strlen(real_ref + 11);
 873                                } else {
 874                                        /* detached HEAD */
 875                                        str = "HEAD";
 876                                        len = 4;
 877                                }
 878                        }
 879                        if (at_time) {
 880                                if (!(flags & GET_OID_QUIETLY)) {
 881                                        warning("Log for '%.*s' only goes "
 882                                                "back to %s.", len, str,
 883                                                show_date(co_time, co_tz, DATE_MODE(RFC2822)));
 884                                }
 885                        } else {
 886                                if (flags & GET_OID_QUIETLY) {
 887                                        exit(128);
 888                                }
 889                                die("Log for '%.*s' only has %d entries.",
 890                                    len, str, co_cnt);
 891                        }
 892                }
 893        }
 894
 895        free(real_ref);
 896        return 0;
 897}
 898
 899static enum get_oid_result get_parent(const char *name, int len,
 900                                      struct object_id *result, int idx)
 901{
 902        struct object_id oid;
 903        enum get_oid_result ret = get_oid_1(name, len, &oid,
 904                                            GET_OID_COMMITTISH);
 905        struct commit *commit;
 906        struct commit_list *p;
 907
 908        if (ret)
 909                return ret;
 910        commit = lookup_commit_reference(the_repository, &oid);
 911        if (parse_commit(commit))
 912                return MISSING_OBJECT;
 913        if (!idx) {
 914                oidcpy(result, &commit->object.oid);
 915                return FOUND;
 916        }
 917        p = commit->parents;
 918        while (p) {
 919                if (!--idx) {
 920                        oidcpy(result, &p->item->object.oid);
 921                        return FOUND;
 922                }
 923                p = p->next;
 924        }
 925        return MISSING_OBJECT;
 926}
 927
 928static enum get_oid_result get_nth_ancestor(const char *name, int len,
 929                                            struct object_id *result,
 930                                            int generation)
 931{
 932        struct object_id oid;
 933        struct commit *commit;
 934        int ret;
 935
 936        ret = get_oid_1(name, len, &oid, GET_OID_COMMITTISH);
 937        if (ret)
 938                return ret;
 939        commit = lookup_commit_reference(the_repository, &oid);
 940        if (!commit)
 941                return MISSING_OBJECT;
 942
 943        while (generation--) {
 944                if (parse_commit(commit) || !commit->parents)
 945                        return MISSING_OBJECT;
 946                commit = commit->parents->item;
 947        }
 948        oidcpy(result, &commit->object.oid);
 949        return FOUND;
 950}
 951
 952struct object *peel_to_type(const char *name, int namelen,
 953                            struct object *o, enum object_type expected_type)
 954{
 955        if (name && !namelen)
 956                namelen = strlen(name);
 957        while (1) {
 958                if (!o || (!o->parsed && !parse_object(the_repository, &o->oid)))
 959                        return NULL;
 960                if (expected_type == OBJ_ANY || o->type == expected_type)
 961                        return o;
 962                if (o->type == OBJ_TAG)
 963                        o = ((struct tag*) o)->tagged;
 964                else if (o->type == OBJ_COMMIT)
 965                        o = &(get_commit_tree(((struct commit *)o))->object);
 966                else {
 967                        if (name)
 968                                error("%.*s: expected %s type, but the object "
 969                                      "dereferences to %s type",
 970                                      namelen, name, type_name(expected_type),
 971                                      type_name(o->type));
 972                        return NULL;
 973                }
 974        }
 975}
 976
 977static int peel_onion(const char *name, int len, struct object_id *oid,
 978                      unsigned lookup_flags)
 979{
 980        struct object_id outer;
 981        const char *sp;
 982        unsigned int expected_type = 0;
 983        struct object *o;
 984
 985        /*
 986         * "ref^{type}" dereferences ref repeatedly until you cannot
 987         * dereference anymore, or you get an object of given type,
 988         * whichever comes first.  "ref^{}" means just dereference
 989         * tags until you get a non-tag.  "ref^0" is a shorthand for
 990         * "ref^{commit}".  "commit^{tree}" could be used to find the
 991         * top-level tree of the given commit.
 992         */
 993        if (len < 4 || name[len-1] != '}')
 994                return -1;
 995
 996        for (sp = name + len - 1; name <= sp; sp--) {
 997                int ch = *sp;
 998                if (ch == '{' && name < sp && sp[-1] == '^')
 999                        break;
1000        }
1001        if (sp <= name)
1002                return -1;
1003
1004        sp++; /* beginning of type name, or closing brace for empty */
1005        if (starts_with(sp, "commit}"))
1006                expected_type = OBJ_COMMIT;
1007        else if (starts_with(sp, "tag}"))
1008                expected_type = OBJ_TAG;
1009        else if (starts_with(sp, "tree}"))
1010                expected_type = OBJ_TREE;
1011        else if (starts_with(sp, "blob}"))
1012                expected_type = OBJ_BLOB;
1013        else if (starts_with(sp, "object}"))
1014                expected_type = OBJ_ANY;
1015        else if (sp[0] == '}')
1016                expected_type = OBJ_NONE;
1017        else if (sp[0] == '/')
1018                expected_type = OBJ_COMMIT;
1019        else
1020                return -1;
1021
1022        lookup_flags &= ~GET_OID_DISAMBIGUATORS;
1023        if (expected_type == OBJ_COMMIT)
1024                lookup_flags |= GET_OID_COMMITTISH;
1025        else if (expected_type == OBJ_TREE)
1026                lookup_flags |= GET_OID_TREEISH;
1027
1028        if (get_oid_1(name, sp - name - 2, &outer, lookup_flags))
1029                return -1;
1030
1031        o = parse_object(the_repository, &outer);
1032        if (!o)
1033                return -1;
1034        if (!expected_type) {
1035                o = deref_tag(the_repository, o, name, sp - name - 2);
1036                if (!o || (!o->parsed && !parse_object(the_repository, &o->oid)))
1037                        return -1;
1038                oidcpy(oid, &o->oid);
1039                return 0;
1040        }
1041
1042        /*
1043         * At this point, the syntax look correct, so
1044         * if we do not get the needed object, we should
1045         * barf.
1046         */
1047        o = peel_to_type(name, len, o, expected_type);
1048        if (!o)
1049                return -1;
1050
1051        oidcpy(oid, &o->oid);
1052        if (sp[0] == '/') {
1053                /* "$commit^{/foo}" */
1054                char *prefix;
1055                int ret;
1056                struct commit_list *list = NULL;
1057
1058                /*
1059                 * $commit^{/}. Some regex implementation may reject.
1060                 * We don't need regex anyway. '' pattern always matches.
1061                 */
1062                if (sp[1] == '}')
1063                        return 0;
1064
1065                prefix = xstrndup(sp + 1, name + len - 1 - (sp + 1));
1066                commit_list_insert((struct commit *)o, &list);
1067                ret = get_oid_oneline(prefix, oid, list);
1068                free(prefix);
1069                return ret;
1070        }
1071        return 0;
1072}
1073
1074static int get_describe_name(const char *name, int len, struct object_id *oid)
1075{
1076        const char *cp;
1077        unsigned flags = GET_OID_QUIETLY | GET_OID_COMMIT;
1078
1079        for (cp = name + len - 1; name + 2 <= cp; cp--) {
1080                char ch = *cp;
1081                if (!isxdigit(ch)) {
1082                        /* We must be looking at g in "SOMETHING-g"
1083                         * for it to be describe output.
1084                         */
1085                        if (ch == 'g' && cp[-1] == '-') {
1086                                cp++;
1087                                len -= cp - name;
1088                                return get_short_oid(cp, len, oid, flags);
1089                        }
1090                }
1091        }
1092        return -1;
1093}
1094
1095static enum get_oid_result get_oid_1(const char *name, int len,
1096                                     struct object_id *oid,
1097                                     unsigned lookup_flags)
1098{
1099        int ret, has_suffix;
1100        const char *cp;
1101
1102        /*
1103         * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
1104         */
1105        has_suffix = 0;
1106        for (cp = name + len - 1; name <= cp; cp--) {
1107                int ch = *cp;
1108                if ('0' <= ch && ch <= '9')
1109                        continue;
1110                if (ch == '~' || ch == '^')
1111                        has_suffix = ch;
1112                break;
1113        }
1114
1115        if (has_suffix) {
1116                int num = 0;
1117                int len1 = cp - name;
1118                cp++;
1119                while (cp < name + len)
1120                        num = num * 10 + *cp++ - '0';
1121                if (!num && len1 == len - 1)
1122                        num = 1;
1123                if (has_suffix == '^')
1124                        return get_parent(name, len1, oid, num);
1125                /* else if (has_suffix == '~') -- goes without saying */
1126                return get_nth_ancestor(name, len1, oid, num);
1127        }
1128
1129        ret = peel_onion(name, len, oid, lookup_flags);
1130        if (!ret)
1131                return FOUND;
1132
1133        ret = get_oid_basic(name, len, oid, lookup_flags);
1134        if (!ret)
1135                return FOUND;
1136
1137        /* It could be describe output that is "SOMETHING-gXXXX" */
1138        ret = get_describe_name(name, len, oid);
1139        if (!ret)
1140                return FOUND;
1141
1142        return get_short_oid(name, len, oid, lookup_flags);
1143}
1144
1145/*
1146 * This interprets names like ':/Initial revision of "git"' by searching
1147 * through history and returning the first commit whose message starts
1148 * the given regular expression.
1149 *
1150 * For negative-matching, prefix the pattern-part with '!-', like: ':/!-WIP'.
1151 *
1152 * For a literal '!' character at the beginning of a pattern, you have to repeat
1153 * that, like: ':/!!foo'
1154 *
1155 * For future extension, all other sequences beginning with ':/!' are reserved.
1156 */
1157
1158/* Remember to update object flag allocation in object.h */
1159#define ONELINE_SEEN (1u<<20)
1160
1161static int handle_one_ref(const char *path, const struct object_id *oid,
1162                          int flag, void *cb_data)
1163{
1164        struct commit_list **list = cb_data;
1165        struct object *object = parse_object(the_repository, oid);
1166        if (!object)
1167                return 0;
1168        if (object->type == OBJ_TAG) {
1169                object = deref_tag(the_repository, object, path,
1170                                   strlen(path));
1171                if (!object)
1172                        return 0;
1173        }
1174        if (object->type != OBJ_COMMIT)
1175                return 0;
1176        commit_list_insert((struct commit *)object, list);
1177        return 0;
1178}
1179
1180static int get_oid_oneline(const char *prefix, struct object_id *oid,
1181                            struct commit_list *list)
1182{
1183        struct commit_list *backup = NULL, *l;
1184        int found = 0;
1185        int negative = 0;
1186        regex_t regex;
1187
1188        if (prefix[0] == '!') {
1189                prefix++;
1190
1191                if (prefix[0] == '-') {
1192                        prefix++;
1193                        negative = 1;
1194                } else if (prefix[0] != '!') {
1195                        return -1;
1196                }
1197        }
1198
1199        if (regcomp(&regex, prefix, REG_EXTENDED))
1200                return -1;
1201
1202        for (l = list; l; l = l->next) {
1203                l->item->object.flags |= ONELINE_SEEN;
1204                commit_list_insert(l->item, &backup);
1205        }
1206        while (list) {
1207                const char *p, *buf;
1208                struct commit *commit;
1209                int matches;
1210
1211                commit = pop_most_recent_commit(&list, ONELINE_SEEN);
1212                if (!parse_object(the_repository, &commit->object.oid))
1213                        continue;
1214                buf = get_commit_buffer(commit, NULL);
1215                p = strstr(buf, "\n\n");
1216                matches = negative ^ (p && !regexec(&regex, p + 2, 0, NULL, 0));
1217                unuse_commit_buffer(commit, buf);
1218
1219                if (matches) {
1220                        oidcpy(oid, &commit->object.oid);
1221                        found = 1;
1222                        break;
1223                }
1224        }
1225        regfree(&regex);
1226        free_commit_list(list);
1227        for (l = backup; l; l = l->next)
1228                clear_commit_marks(l->item, ONELINE_SEEN);
1229        free_commit_list(backup);
1230        return found ? 0 : -1;
1231}
1232
1233struct grab_nth_branch_switch_cbdata {
1234        int remaining;
1235        struct strbuf buf;
1236};
1237
1238static int grab_nth_branch_switch(struct object_id *ooid, struct object_id *noid,
1239                                  const char *email, timestamp_t timestamp, int tz,
1240                                  const char *message, void *cb_data)
1241{
1242        struct grab_nth_branch_switch_cbdata *cb = cb_data;
1243        const char *match = NULL, *target = NULL;
1244        size_t len;
1245
1246        if (skip_prefix(message, "checkout: moving from ", &match))
1247                target = strstr(match, " to ");
1248
1249        if (!match || !target)
1250                return 0;
1251        if (--(cb->remaining) == 0) {
1252                len = target - match;
1253                strbuf_reset(&cb->buf);
1254                strbuf_add(&cb->buf, match, len);
1255                return 1; /* we are done */
1256        }
1257        return 0;
1258}
1259
1260/*
1261 * Parse @{-N} syntax, return the number of characters parsed
1262 * if successful; otherwise signal an error with negative value.
1263 */
1264static int interpret_nth_prior_checkout(const char *name, int namelen,
1265                                        struct strbuf *buf)
1266{
1267        long nth;
1268        int retval;
1269        struct grab_nth_branch_switch_cbdata cb;
1270        const char *brace;
1271        char *num_end;
1272
1273        if (namelen < 4)
1274                return -1;
1275        if (name[0] != '@' || name[1] != '{' || name[2] != '-')
1276                return -1;
1277        brace = memchr(name, '}', namelen);
1278        if (!brace)
1279                return -1;
1280        nth = strtol(name + 3, &num_end, 10);
1281        if (num_end != brace)
1282                return -1;
1283        if (nth <= 0)
1284                return -1;
1285        cb.remaining = nth;
1286        strbuf_init(&cb.buf, 20);
1287
1288        retval = 0;
1289        if (0 < for_each_reflog_ent_reverse("HEAD", grab_nth_branch_switch, &cb)) {
1290                strbuf_reset(buf);
1291                strbuf_addbuf(buf, &cb.buf);
1292                retval = brace - name + 1;
1293        }
1294
1295        strbuf_release(&cb.buf);
1296        return retval;
1297}
1298
1299int get_oid_mb(const char *name, struct object_id *oid)
1300{
1301        struct commit *one, *two;
1302        struct commit_list *mbs;
1303        struct object_id oid_tmp;
1304        const char *dots;
1305        int st;
1306
1307        dots = strstr(name, "...");
1308        if (!dots)
1309                return get_oid(name, oid);
1310        if (dots == name)
1311                st = get_oid("HEAD", &oid_tmp);
1312        else {
1313                struct strbuf sb;
1314                strbuf_init(&sb, dots - name);
1315                strbuf_add(&sb, name, dots - name);
1316                st = get_oid_committish(sb.buf, &oid_tmp);
1317                strbuf_release(&sb);
1318        }
1319        if (st)
1320                return st;
1321        one = lookup_commit_reference_gently(the_repository, &oid_tmp, 0);
1322        if (!one)
1323                return -1;
1324
1325        if (get_oid_committish(dots[3] ? (dots + 3) : "HEAD", &oid_tmp))
1326                return -1;
1327        two = lookup_commit_reference_gently(the_repository, &oid_tmp, 0);
1328        if (!two)
1329                return -1;
1330        mbs = get_merge_bases(one, two);
1331        if (!mbs || mbs->next)
1332                st = -1;
1333        else {
1334                st = 0;
1335                oidcpy(oid, &mbs->item->object.oid);
1336        }
1337        free_commit_list(mbs);
1338        return st;
1339}
1340
1341/* parse @something syntax, when 'something' is not {.*} */
1342static int interpret_empty_at(const char *name, int namelen, int len, struct strbuf *buf)
1343{
1344        const char *next;
1345
1346        if (len || name[1] == '{')
1347                return -1;
1348
1349        /* make sure it's a single @, or @@{.*}, not @foo */
1350        next = memchr(name + len + 1, '@', namelen - len - 1);
1351        if (next && next[1] != '{')
1352                return -1;
1353        if (!next)
1354                next = name + namelen;
1355        if (next != name + 1)
1356                return -1;
1357
1358        strbuf_reset(buf);
1359        strbuf_add(buf, "HEAD", 4);
1360        return 1;
1361}
1362
1363static int reinterpret(const char *name, int namelen, int len,
1364                       struct strbuf *buf, unsigned allowed)
1365{
1366        /* we have extra data, which might need further processing */
1367        struct strbuf tmp = STRBUF_INIT;
1368        int used = buf->len;
1369        int ret;
1370
1371        strbuf_add(buf, name + len, namelen - len);
1372        ret = interpret_branch_name(buf->buf, buf->len, &tmp, allowed);
1373        /* that data was not interpreted, remove our cruft */
1374        if (ret < 0) {
1375                strbuf_setlen(buf, used);
1376                return len;
1377        }
1378        strbuf_reset(buf);
1379        strbuf_addbuf(buf, &tmp);
1380        strbuf_release(&tmp);
1381        /* tweak for size of {-N} versus expanded ref name */
1382        return ret - used + len;
1383}
1384
1385static void set_shortened_ref(struct strbuf *buf, const char *ref)
1386{
1387        char *s = shorten_unambiguous_ref(ref, 0);
1388        strbuf_reset(buf);
1389        strbuf_addstr(buf, s);
1390        free(s);
1391}
1392
1393static int branch_interpret_allowed(const char *refname, unsigned allowed)
1394{
1395        if (!allowed)
1396                return 1;
1397
1398        if ((allowed & INTERPRET_BRANCH_LOCAL) &&
1399            starts_with(refname, "refs/heads/"))
1400                return 1;
1401        if ((allowed & INTERPRET_BRANCH_REMOTE) &&
1402            starts_with(refname, "refs/remotes/"))
1403                return 1;
1404
1405        return 0;
1406}
1407
1408static int interpret_branch_mark(const char *name, int namelen,
1409                                 int at, struct strbuf *buf,
1410                                 int (*get_mark)(const char *, int),
1411                                 const char *(*get_data)(struct branch *,
1412                                                         struct strbuf *),
1413                                 unsigned allowed)
1414{
1415        int len;
1416        struct branch *branch;
1417        struct strbuf err = STRBUF_INIT;
1418        const char *value;
1419
1420        len = get_mark(name + at, namelen - at);
1421        if (!len)
1422                return -1;
1423
1424        if (memchr(name, ':', at))
1425                return -1;
1426
1427        if (at) {
1428                char *name_str = xmemdupz(name, at);
1429                branch = branch_get(name_str);
1430                free(name_str);
1431        } else
1432                branch = branch_get(NULL);
1433
1434        value = get_data(branch, &err);
1435        if (!value)
1436                die("%s", err.buf);
1437
1438        if (!branch_interpret_allowed(value, allowed))
1439                return -1;
1440
1441        set_shortened_ref(buf, value);
1442        return len + at;
1443}
1444
1445int repo_interpret_branch_name(struct repository *r,
1446                               const char *name, int namelen,
1447                               struct strbuf *buf,
1448                               unsigned allowed)
1449{
1450        char *at;
1451        const char *start;
1452        int len;
1453
1454        if (r != the_repository)
1455                BUG("interpret_branch_name() does not really use 'r' yet");
1456        if (!namelen)
1457                namelen = strlen(name);
1458
1459        if (!allowed || (allowed & INTERPRET_BRANCH_LOCAL)) {
1460                len = interpret_nth_prior_checkout(name, namelen, buf);
1461                if (!len) {
1462                        return len; /* syntax Ok, not enough switches */
1463                } else if (len > 0) {
1464                        if (len == namelen)
1465                                return len; /* consumed all */
1466                        else
1467                                return reinterpret(name, namelen, len, buf, allowed);
1468                }
1469        }
1470
1471        for (start = name;
1472             (at = memchr(start, '@', namelen - (start - name)));
1473             start = at + 1) {
1474
1475                if (!allowed || (allowed & INTERPRET_BRANCH_HEAD)) {
1476                        len = interpret_empty_at(name, namelen, at - name, buf);
1477                        if (len > 0)
1478                                return reinterpret(name, namelen, len, buf,
1479                                                   allowed);
1480                }
1481
1482                len = interpret_branch_mark(name, namelen, at - name, buf,
1483                                            upstream_mark, branch_get_upstream,
1484                                            allowed);
1485                if (len > 0)
1486                        return len;
1487
1488                len = interpret_branch_mark(name, namelen, at - name, buf,
1489                                            push_mark, branch_get_push,
1490                                            allowed);
1491                if (len > 0)
1492                        return len;
1493        }
1494
1495        return -1;
1496}
1497
1498void strbuf_branchname(struct strbuf *sb, const char *name, unsigned allowed)
1499{
1500        int len = strlen(name);
1501        int used = interpret_branch_name(name, len, sb, allowed);
1502
1503        if (used < 0)
1504                used = 0;
1505        strbuf_add(sb, name + used, len - used);
1506}
1507
1508int strbuf_check_branch_ref(struct strbuf *sb, const char *name)
1509{
1510        if (startup_info->have_repository)
1511                strbuf_branchname(sb, name, INTERPRET_BRANCH_LOCAL);
1512        else
1513                strbuf_addstr(sb, name);
1514
1515        /*
1516         * This splice must be done even if we end up rejecting the
1517         * name; builtin/branch.c::copy_or_rename_branch() still wants
1518         * to see what the name expanded to so that "branch -m" can be
1519         * used as a tool to correct earlier mistakes.
1520         */
1521        strbuf_splice(sb, 0, 0, "refs/heads/", 11);
1522
1523        if (*name == '-' ||
1524            !strcmp(sb->buf, "refs/heads/HEAD"))
1525                return -1;
1526
1527        return check_refname_format(sb->buf, 0);
1528}
1529
1530/*
1531 * This is like "get_oid_basic()", except it allows "object ID expressions",
1532 * notably "xyz^" for "parent of xyz"
1533 */
1534int get_oid(const char *name, struct object_id *oid)
1535{
1536        struct object_context unused;
1537        return get_oid_with_context(the_repository, name, 0, oid, &unused);
1538}
1539
1540
1541/*
1542 * Many callers know that the user meant to name a commit-ish by
1543 * syntactical positions where the object name appears.  Calling this
1544 * function allows the machinery to disambiguate shorter-than-unique
1545 * abbreviated object names between commit-ish and others.
1546 *
1547 * Note that this does NOT error out when the named object is not a
1548 * commit-ish. It is merely to give a hint to the disambiguation
1549 * machinery.
1550 */
1551int get_oid_committish(const char *name, struct object_id *oid)
1552{
1553        struct object_context unused;
1554        return get_oid_with_context(the_repository,
1555                                    name, GET_OID_COMMITTISH,
1556                                    oid, &unused);
1557}
1558
1559int get_oid_treeish(const char *name, struct object_id *oid)
1560{
1561        struct object_context unused;
1562        return get_oid_with_context(the_repository,
1563                                    name, GET_OID_TREEISH,
1564                                    oid, &unused);
1565}
1566
1567int get_oid_commit(const char *name, struct object_id *oid)
1568{
1569        struct object_context unused;
1570        return get_oid_with_context(the_repository,
1571                                    name, GET_OID_COMMIT,
1572                                    oid, &unused);
1573}
1574
1575int get_oid_tree(const char *name, struct object_id *oid)
1576{
1577        struct object_context unused;
1578        return get_oid_with_context(the_repository,
1579                                    name, GET_OID_TREE,
1580                                    oid, &unused);
1581}
1582
1583int get_oid_blob(const char *name, struct object_id *oid)
1584{
1585        struct object_context unused;
1586        return get_oid_with_context(the_repository,
1587                                    name, GET_OID_BLOB,
1588                                    oid, &unused);
1589}
1590
1591/* Must be called only when object_name:filename doesn't exist. */
1592static void diagnose_invalid_oid_path(const char *prefix,
1593                                      const char *filename,
1594                                      const struct object_id *tree_oid,
1595                                      const char *object_name,
1596                                      int object_name_len)
1597{
1598        struct object_id oid;
1599        unsigned mode;
1600
1601        if (!prefix)
1602                prefix = "";
1603
1604        if (file_exists(filename))
1605                die("Path '%s' exists on disk, but not in '%.*s'.",
1606                    filename, object_name_len, object_name);
1607        if (is_missing_file_error(errno)) {
1608                char *fullname = xstrfmt("%s%s", prefix, filename);
1609
1610                if (!get_tree_entry(tree_oid, fullname, &oid, &mode)) {
1611                        die("Path '%s' exists, but not '%s'.\n"
1612                            "Did you mean '%.*s:%s' aka '%.*s:./%s'?",
1613                            fullname,
1614                            filename,
1615                            object_name_len, object_name,
1616                            fullname,
1617                            object_name_len, object_name,
1618                            filename);
1619                }
1620                die("Path '%s' does not exist in '%.*s'",
1621                    filename, object_name_len, object_name);
1622        }
1623}
1624
1625/* Must be called only when :stage:filename doesn't exist. */
1626static void diagnose_invalid_index_path(struct index_state *istate,
1627                                        int stage,
1628                                        const char *prefix,
1629                                        const char *filename)
1630{
1631        const struct cache_entry *ce;
1632        int pos;
1633        unsigned namelen = strlen(filename);
1634        struct strbuf fullname = STRBUF_INIT;
1635
1636        if (!prefix)
1637                prefix = "";
1638
1639        /* Wrong stage number? */
1640        pos = index_name_pos(istate, filename, namelen);
1641        if (pos < 0)
1642                pos = -pos - 1;
1643        if (pos < istate->cache_nr) {
1644                ce = istate->cache[pos];
1645                if (ce_namelen(ce) == namelen &&
1646                    !memcmp(ce->name, filename, namelen))
1647                        die("Path '%s' is in the index, but not at stage %d.\n"
1648                            "Did you mean ':%d:%s'?",
1649                            filename, stage,
1650                            ce_stage(ce), filename);
1651        }
1652
1653        /* Confusion between relative and absolute filenames? */
1654        strbuf_addstr(&fullname, prefix);
1655        strbuf_addstr(&fullname, filename);
1656        pos = index_name_pos(istate, fullname.buf, fullname.len);
1657        if (pos < 0)
1658                pos = -pos - 1;
1659        if (pos < istate->cache_nr) {
1660                ce = istate->cache[pos];
1661                if (ce_namelen(ce) == fullname.len &&
1662                    !memcmp(ce->name, fullname.buf, fullname.len))
1663                        die("Path '%s' is in the index, but not '%s'.\n"
1664                            "Did you mean ':%d:%s' aka ':%d:./%s'?",
1665                            fullname.buf, filename,
1666                            ce_stage(ce), fullname.buf,
1667                            ce_stage(ce), filename);
1668        }
1669
1670        if (file_exists(filename))
1671                die("Path '%s' exists on disk, but not in the index.", filename);
1672        if (is_missing_file_error(errno))
1673                die("Path '%s' does not exist (neither on disk nor in the index).",
1674                    filename);
1675
1676        strbuf_release(&fullname);
1677}
1678
1679
1680static char *resolve_relative_path(const char *rel)
1681{
1682        if (!starts_with(rel, "./") && !starts_with(rel, "../"))
1683                return NULL;
1684
1685        if (!is_inside_work_tree())
1686                die("relative path syntax can't be used outside working tree.");
1687
1688        /* die() inside prefix_path() if resolved path is outside worktree */
1689        return prefix_path(startup_info->prefix,
1690                           startup_info->prefix ? strlen(startup_info->prefix) : 0,
1691                           rel);
1692}
1693
1694static enum get_oid_result get_oid_with_context_1(struct repository *repo,
1695                                  const char *name,
1696                                  unsigned flags,
1697                                  const char *prefix,
1698                                  struct object_id *oid,
1699                                  struct object_context *oc)
1700{
1701        int ret, bracket_depth;
1702        int namelen = strlen(name);
1703        const char *cp;
1704        int only_to_die = flags & GET_OID_ONLY_TO_DIE;
1705
1706        if (only_to_die)
1707                flags |= GET_OID_QUIETLY;
1708
1709        memset(oc, 0, sizeof(*oc));
1710        oc->mode = S_IFINVALID;
1711        strbuf_init(&oc->symlink_path, 0);
1712        ret = get_oid_1(name, namelen, oid, flags);
1713        if (!ret)
1714                return ret;
1715        /*
1716         * sha1:path --> object name of path in ent sha1
1717         * :path -> object name of absolute path in index
1718         * :./path -> object name of path relative to cwd in index
1719         * :[0-3]:path -> object name of path in index at stage
1720         * :/foo -> recent commit matching foo
1721         */
1722        if (name[0] == ':') {
1723                int stage = 0;
1724                const struct cache_entry *ce;
1725                char *new_path = NULL;
1726                int pos;
1727                if (!only_to_die && namelen > 2 && name[1] == '/') {
1728                        struct commit_list *list = NULL;
1729
1730                        for_each_ref(handle_one_ref, &list);
1731                        head_ref(handle_one_ref, &list);
1732                        commit_list_sort_by_date(&list);
1733                        return get_oid_oneline(name + 2, oid, list);
1734                }
1735                if (namelen < 3 ||
1736                    name[2] != ':' ||
1737                    name[1] < '0' || '3' < name[1])
1738                        cp = name + 1;
1739                else {
1740                        stage = name[1] - '0';
1741                        cp = name + 3;
1742                }
1743                new_path = resolve_relative_path(cp);
1744                if (!new_path) {
1745                        namelen = namelen - (cp - name);
1746                } else {
1747                        cp = new_path;
1748                        namelen = strlen(cp);
1749                }
1750
1751                if (flags & GET_OID_RECORD_PATH)
1752                        oc->path = xstrdup(cp);
1753
1754                if (!repo->index->cache)
1755                        repo_read_index(the_repository);
1756                pos = index_name_pos(repo->index, cp, namelen);
1757                if (pos < 0)
1758                        pos = -pos - 1;
1759                while (pos < repo->index->cache_nr) {
1760                        ce = repo->index->cache[pos];
1761                        if (ce_namelen(ce) != namelen ||
1762                            memcmp(ce->name, cp, namelen))
1763                                break;
1764                        if (ce_stage(ce) == stage) {
1765                                oidcpy(oid, &ce->oid);
1766                                oc->mode = ce->ce_mode;
1767                                free(new_path);
1768                                return 0;
1769                        }
1770                        pos++;
1771                }
1772                if (only_to_die && name[1] && name[1] != '/')
1773                        diagnose_invalid_index_path(repo->index, stage, prefix, cp);
1774                free(new_path);
1775                return -1;
1776        }
1777        for (cp = name, bracket_depth = 0; *cp; cp++) {
1778                if (*cp == '{')
1779                        bracket_depth++;
1780                else if (bracket_depth && *cp == '}')
1781                        bracket_depth--;
1782                else if (!bracket_depth && *cp == ':')
1783                        break;
1784        }
1785        if (*cp == ':') {
1786                struct object_id tree_oid;
1787                int len = cp - name;
1788                unsigned sub_flags = flags;
1789
1790                sub_flags &= ~GET_OID_DISAMBIGUATORS;
1791                sub_flags |= GET_OID_TREEISH;
1792
1793                if (!get_oid_1(name, len, &tree_oid, sub_flags)) {
1794                        const char *filename = cp+1;
1795                        char *new_filename = NULL;
1796
1797                        new_filename = resolve_relative_path(filename);
1798                        if (new_filename)
1799                                filename = new_filename;
1800                        if (flags & GET_OID_FOLLOW_SYMLINKS) {
1801                                ret = get_tree_entry_follow_symlinks(&tree_oid,
1802                                        filename, oid, &oc->symlink_path,
1803                                        &oc->mode);
1804                        } else {
1805                                ret = get_tree_entry(&tree_oid, filename, oid,
1806                                                     &oc->mode);
1807                                if (ret && only_to_die) {
1808                                        diagnose_invalid_oid_path(prefix,
1809                                                                   filename,
1810                                                                   &tree_oid,
1811                                                                   name, len);
1812                                }
1813                        }
1814                        if (flags & GET_OID_RECORD_PATH)
1815                                oc->path = xstrdup(filename);
1816
1817                        free(new_filename);
1818                        return ret;
1819                } else {
1820                        if (only_to_die)
1821                                die("Invalid object name '%.*s'.", len, name);
1822                }
1823        }
1824        return ret;
1825}
1826
1827/*
1828 * Call this function when you know "name" given by the end user must
1829 * name an object but it doesn't; the function _may_ die with a better
1830 * diagnostic message than "no such object 'name'", e.g. "Path 'doc' does not
1831 * exist in 'HEAD'" when given "HEAD:doc", or it may return in which case
1832 * you have a chance to diagnose the error further.
1833 */
1834void maybe_die_on_misspelt_object_name(const char *name, const char *prefix)
1835{
1836        struct object_context oc;
1837        struct object_id oid;
1838        get_oid_with_context_1(the_repository, name, GET_OID_ONLY_TO_DIE,
1839                               prefix, &oid, &oc);
1840}
1841
1842enum get_oid_result get_oid_with_context(struct repository *repo,
1843                                         const char *str,
1844                                         unsigned flags,
1845                                         struct object_id *oid,
1846                                         struct object_context *oc)
1847{
1848        if (flags & GET_OID_FOLLOW_SYMLINKS && flags & GET_OID_ONLY_TO_DIE)
1849                BUG("incompatible flags for get_sha1_with_context");
1850        return get_oid_with_context_1(repo, str, flags, NULL, oid, oc);
1851}