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