sha1_name.con commit remote-helpers: tests: general improvements (531594e)
   1#include "cache.h"
   2#include "tag.h"
   3#include "commit.h"
   4#include "tree.h"
   5#include "blob.h"
   6#include "tree-walk.h"
   7#include "refs.h"
   8#include "remote.h"
   9
  10static int get_sha1_oneline(const char *, unsigned char *, struct commit_list *);
  11
  12typedef int (*disambiguate_hint_fn)(const unsigned char *, void *);
  13
  14struct disambiguate_state {
  15        disambiguate_hint_fn fn;
  16        void *cb_data;
  17        unsigned char candidate[20];
  18        unsigned candidate_exists:1;
  19        unsigned candidate_checked:1;
  20        unsigned candidate_ok:1;
  21        unsigned disambiguate_fn_used:1;
  22        unsigned ambiguous:1;
  23        unsigned always_call_fn:1;
  24};
  25
  26static void update_candidates(struct disambiguate_state *ds, const unsigned char *current)
  27{
  28        if (ds->always_call_fn) {
  29                ds->ambiguous = ds->fn(current, ds->cb_data) ? 1 : 0;
  30                return;
  31        }
  32        if (!ds->candidate_exists) {
  33                /* this is the first candidate */
  34                hashcpy(ds->candidate, current);
  35                ds->candidate_exists = 1;
  36                return;
  37        } else if (!hashcmp(ds->candidate, current)) {
  38                /* the same as what we already have seen */
  39                return;
  40        }
  41
  42        if (!ds->fn) {
  43                /* cannot disambiguate between ds->candidate and current */
  44                ds->ambiguous = 1;
  45                return;
  46        }
  47
  48        if (!ds->candidate_checked) {
  49                ds->candidate_ok = ds->fn(ds->candidate, ds->cb_data);
  50                ds->disambiguate_fn_used = 1;
  51                ds->candidate_checked = 1;
  52        }
  53
  54        if (!ds->candidate_ok) {
  55                /* discard the candidate; we know it does not satisify fn */
  56                hashcpy(ds->candidate, current);
  57                ds->candidate_checked = 0;
  58                return;
  59        }
  60
  61        /* if we reach this point, we know ds->candidate satisfies fn */
  62        if (ds->fn(current, ds->cb_data)) {
  63                /*
  64                 * if both current and candidate satisfy fn, we cannot
  65                 * disambiguate.
  66                 */
  67                ds->candidate_ok = 0;
  68                ds->ambiguous = 1;
  69        }
  70
  71        /* otherwise, current can be discarded and candidate is still good */
  72}
  73
  74static void find_short_object_filename(int len, const char *hex_pfx, struct disambiguate_state *ds)
  75{
  76        struct alternate_object_database *alt;
  77        char hex[40];
  78        static struct alternate_object_database *fakeent;
  79
  80        if (!fakeent) {
  81                /*
  82                 * Create a "fake" alternate object database that
  83                 * points to our own object database, to make it
  84                 * easier to get a temporary working space in
  85                 * alt->name/alt->base while iterating over the
  86                 * object databases including our own.
  87                 */
  88                const char *objdir = get_object_directory();
  89                int objdir_len = strlen(objdir);
  90                int entlen = objdir_len + 43;
  91                fakeent = xmalloc(sizeof(*fakeent) + entlen);
  92                memcpy(fakeent->base, objdir, objdir_len);
  93                fakeent->name = fakeent->base + objdir_len + 1;
  94                fakeent->name[-1] = '/';
  95        }
  96        fakeent->next = alt_odb_list;
  97
  98        sprintf(hex, "%.2s", hex_pfx);
  99        for (alt = fakeent; alt && !ds->ambiguous; alt = alt->next) {
 100                struct dirent *de;
 101                DIR *dir;
 102                sprintf(alt->name, "%.2s/", hex_pfx);
 103                dir = opendir(alt->base);
 104                if (!dir)
 105                        continue;
 106
 107                while (!ds->ambiguous && (de = readdir(dir)) != NULL) {
 108                        unsigned char sha1[20];
 109
 110                        if (strlen(de->d_name) != 38)
 111                                continue;
 112                        if (memcmp(de->d_name, hex_pfx + 2, len - 2))
 113                                continue;
 114                        memcpy(hex + 2, de->d_name, 38);
 115                        if (!get_sha1_hex(hex, sha1))
 116                                update_candidates(ds, sha1);
 117                }
 118                closedir(dir);
 119        }
 120}
 121
 122static int match_sha(unsigned len, const unsigned char *a, const unsigned char *b)
 123{
 124        do {
 125                if (*a != *b)
 126                        return 0;
 127                a++;
 128                b++;
 129                len -= 2;
 130        } while (len > 1);
 131        if (len)
 132                if ((*a ^ *b) & 0xf0)
 133                        return 0;
 134        return 1;
 135}
 136
 137static void unique_in_pack(int len,
 138                          const unsigned char *bin_pfx,
 139                           struct packed_git *p,
 140                           struct disambiguate_state *ds)
 141{
 142        uint32_t num, last, i, first = 0;
 143        const unsigned char *current = NULL;
 144
 145        open_pack_index(p);
 146        num = p->num_objects;
 147        last = num;
 148        while (first < last) {
 149                uint32_t mid = (first + last) / 2;
 150                const unsigned char *current;
 151                int cmp;
 152
 153                current = nth_packed_object_sha1(p, mid);
 154                cmp = hashcmp(bin_pfx, current);
 155                if (!cmp) {
 156                        first = mid;
 157                        break;
 158                }
 159                if (cmp > 0) {
 160                        first = mid+1;
 161                        continue;
 162                }
 163                last = mid;
 164        }
 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                current = nth_packed_object_sha1(p, i);
 173                if (!match_sha(len, bin_pfx, current))
 174                        break;
 175                update_candidates(ds, current);
 176        }
 177}
 178
 179static void find_short_packed_object(int len, const unsigned char *bin_pfx,
 180                                     struct disambiguate_state *ds)
 181{
 182        struct packed_git *p;
 183
 184        prepare_packed_git();
 185        for (p = packed_git; p && !ds->ambiguous; p = p->next)
 186                unique_in_pack(len, bin_pfx, p, ds);
 187}
 188
 189#define SHORT_NAME_NOT_FOUND (-1)
 190#define SHORT_NAME_AMBIGUOUS (-2)
 191
 192static int finish_object_disambiguation(struct disambiguate_state *ds,
 193                                        unsigned char *sha1)
 194{
 195        if (ds->ambiguous)
 196                return SHORT_NAME_AMBIGUOUS;
 197
 198        if (!ds->candidate_exists)
 199                return SHORT_NAME_NOT_FOUND;
 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->candidate, ds->cb_data));
 218
 219        if (!ds->candidate_ok)
 220                return SHORT_NAME_AMBIGUOUS;
 221
 222        hashcpy(sha1, ds->candidate);
 223        return 0;
 224}
 225
 226static int disambiguate_commit_only(const unsigned char *sha1, void *cb_data_unused)
 227{
 228        int kind = sha1_object_info(sha1, NULL);
 229        return kind == OBJ_COMMIT;
 230}
 231
 232static int disambiguate_committish_only(const unsigned char *sha1, void *cb_data_unused)
 233{
 234        struct object *obj;
 235        int kind;
 236
 237        kind = sha1_object_info(sha1, NULL);
 238        if (kind == OBJ_COMMIT)
 239                return 1;
 240        if (kind != OBJ_TAG)
 241                return 0;
 242
 243        /* We need to do this the hard way... */
 244        obj = deref_tag(lookup_object(sha1), NULL, 0);
 245        if (obj && obj->type == OBJ_COMMIT)
 246                return 1;
 247        return 0;
 248}
 249
 250static int disambiguate_tree_only(const unsigned char *sha1, void *cb_data_unused)
 251{
 252        int kind = sha1_object_info(sha1, NULL);
 253        return kind == OBJ_TREE;
 254}
 255
 256static int disambiguate_treeish_only(const unsigned char *sha1, void *cb_data_unused)
 257{
 258        struct object *obj;
 259        int kind;
 260
 261        kind = sha1_object_info(sha1, NULL);
 262        if (kind == OBJ_TREE || kind == OBJ_COMMIT)
 263                return 1;
 264        if (kind != OBJ_TAG)
 265                return 0;
 266
 267        /* We need to do this the hard way... */
 268        obj = deref_tag(lookup_object(sha1), NULL, 0);
 269        if (obj && (obj->type == OBJ_TREE || obj->type == OBJ_COMMIT))
 270                return 1;
 271        return 0;
 272}
 273
 274static int disambiguate_blob_only(const unsigned char *sha1, void *cb_data_unused)
 275{
 276        int kind = sha1_object_info(sha1, NULL);
 277        return kind == OBJ_BLOB;
 278}
 279
 280static int prepare_prefixes(const char *name, int len,
 281                            unsigned char *bin_pfx,
 282                            char *hex_pfx)
 283{
 284        int i;
 285
 286        hashclr(bin_pfx);
 287        memset(hex_pfx, 'x', 40);
 288        for (i = 0; i < len ;i++) {
 289                unsigned char c = name[i];
 290                unsigned char val;
 291                if (c >= '0' && c <= '9')
 292                        val = c - '0';
 293                else if (c >= 'a' && c <= 'f')
 294                        val = c - 'a' + 10;
 295                else if (c >= 'A' && c <='F') {
 296                        val = c - 'A' + 10;
 297                        c -= 'A' - 'a';
 298                }
 299                else
 300                        return -1;
 301                hex_pfx[i] = c;
 302                if (!(i & 1))
 303                        val <<= 4;
 304                bin_pfx[i >> 1] |= val;
 305        }
 306        return 0;
 307}
 308
 309static int get_short_sha1(const char *name, int len, unsigned char *sha1,
 310                          unsigned flags)
 311{
 312        int status;
 313        char hex_pfx[40];
 314        unsigned char bin_pfx[20];
 315        struct disambiguate_state ds;
 316        int quietly = !!(flags & GET_SHA1_QUIETLY);
 317
 318        if (len < MINIMUM_ABBREV || len > 40)
 319                return -1;
 320        if (prepare_prefixes(name, len, bin_pfx, hex_pfx) < 0)
 321                return -1;
 322
 323        prepare_alt_odb();
 324
 325        memset(&ds, 0, sizeof(ds));
 326        if (flags & GET_SHA1_COMMIT)
 327                ds.fn = disambiguate_commit_only;
 328        else if (flags & GET_SHA1_COMMITTISH)
 329                ds.fn = disambiguate_committish_only;
 330        else if (flags & GET_SHA1_TREE)
 331                ds.fn = disambiguate_tree_only;
 332        else if (flags & GET_SHA1_TREEISH)
 333                ds.fn = disambiguate_treeish_only;
 334        else if (flags & GET_SHA1_BLOB)
 335                ds.fn = disambiguate_blob_only;
 336
 337        find_short_object_filename(len, hex_pfx, &ds);
 338        find_short_packed_object(len, bin_pfx, &ds);
 339        status = finish_object_disambiguation(&ds, sha1);
 340
 341        if (!quietly && (status == SHORT_NAME_AMBIGUOUS))
 342                return error("short SHA1 %.*s is ambiguous.", len, hex_pfx);
 343        return status;
 344}
 345
 346
 347int for_each_abbrev(const char *prefix, each_abbrev_fn fn, void *cb_data)
 348{
 349        char hex_pfx[40];
 350        unsigned char bin_pfx[20];
 351        struct disambiguate_state ds;
 352        int len = strlen(prefix);
 353
 354        if (len < MINIMUM_ABBREV || len > 40)
 355                return -1;
 356        if (prepare_prefixes(prefix, len, bin_pfx, hex_pfx) < 0)
 357                return -1;
 358
 359        prepare_alt_odb();
 360
 361        memset(&ds, 0, sizeof(ds));
 362        ds.always_call_fn = 1;
 363        ds.cb_data = cb_data;
 364        ds.fn = fn;
 365
 366        find_short_object_filename(len, hex_pfx, &ds);
 367        find_short_packed_object(len, bin_pfx, &ds);
 368        return ds.ambiguous;
 369}
 370
 371const char *find_unique_abbrev(const unsigned char *sha1, int len)
 372{
 373        int status, exists;
 374        static char hex[41];
 375
 376        exists = has_sha1_file(sha1);
 377        memcpy(hex, sha1_to_hex(sha1), 40);
 378        if (len == 40 || !len)
 379                return hex;
 380        while (len < 40) {
 381                unsigned char sha1_ret[20];
 382                status = get_short_sha1(hex, len, sha1_ret, GET_SHA1_QUIETLY);
 383                if (exists
 384                    ? !status
 385                    : status == SHORT_NAME_NOT_FOUND) {
 386                        hex[len] = 0;
 387                        return hex;
 388                }
 389                len++;
 390        }
 391        return hex;
 392}
 393
 394static int ambiguous_path(const char *path, int len)
 395{
 396        int slash = 1;
 397        int cnt;
 398
 399        for (cnt = 0; cnt < len; cnt++) {
 400                switch (*path++) {
 401                case '\0':
 402                        break;
 403                case '/':
 404                        if (slash)
 405                                break;
 406                        slash = 1;
 407                        continue;
 408                case '.':
 409                        continue;
 410                default:
 411                        slash = 0;
 412                        continue;
 413                }
 414                break;
 415        }
 416        return slash;
 417}
 418
 419static inline int upstream_mark(const char *string, int len)
 420{
 421        const char *suffix[] = { "@{upstream}", "@{u}" };
 422        int i;
 423
 424        for (i = 0; i < ARRAY_SIZE(suffix); i++) {
 425                int suffix_len = strlen(suffix[i]);
 426                if (suffix_len <= len
 427                    && !memcmp(string, suffix[i], suffix_len))
 428                        return suffix_len;
 429        }
 430        return 0;
 431}
 432
 433static int get_sha1_1(const char *name, int len, unsigned char *sha1, unsigned lookup_flags);
 434
 435static int get_sha1_basic(const char *str, int len, unsigned char *sha1)
 436{
 437        static const char *warn_msg = "refname '%.*s' is ambiguous.";
 438        char *real_ref = NULL;
 439        int refs_found = 0;
 440        int at, reflog_len;
 441
 442        if (len == 40 && !get_sha1_hex(str, sha1))
 443                return 0;
 444
 445        /* basic@{time or number or -number} format to query ref-log */
 446        reflog_len = at = 0;
 447        if (len && str[len-1] == '}') {
 448                for (at = len-2; at >= 0; at--) {
 449                        if (str[at] == '@' && str[at+1] == '{') {
 450                                if (!upstream_mark(str + at, len - at)) {
 451                                        reflog_len = (len-1) - (at+2);
 452                                        len = at;
 453                                }
 454                                break;
 455                        }
 456                }
 457        }
 458
 459        /* Accept only unambiguous ref paths. */
 460        if (len && ambiguous_path(str, len))
 461                return -1;
 462
 463        if (!len && reflog_len) {
 464                struct strbuf buf = STRBUF_INIT;
 465                int ret;
 466                /* try the @{-N} syntax for n-th checkout */
 467                ret = interpret_branch_name(str+at, &buf);
 468                if (ret > 0) {
 469                        /* substitute this branch name and restart */
 470                        return get_sha1_1(buf.buf, buf.len, sha1, 0);
 471                } else if (ret == 0) {
 472                        return -1;
 473                }
 474                /* allow "@{...}" to mean the current branch reflog */
 475                refs_found = dwim_ref("HEAD", 4, sha1, &real_ref);
 476        } else if (reflog_len)
 477                refs_found = dwim_log(str, len, sha1, &real_ref);
 478        else
 479                refs_found = dwim_ref(str, len, sha1, &real_ref);
 480
 481        if (!refs_found)
 482                return -1;
 483
 484        if (warn_ambiguous_refs && refs_found > 1)
 485                warning(warn_msg, len, str);
 486
 487        if (reflog_len) {
 488                int nth, i;
 489                unsigned long at_time;
 490                unsigned long co_time;
 491                int co_tz, co_cnt;
 492
 493                /* a @{-N} placed anywhere except the start is an error */
 494                if (str[at+2] == '-')
 495                        return -1;
 496
 497                /* Is it asking for N-th entry, or approxidate? */
 498                for (i = nth = 0; 0 <= nth && i < reflog_len; i++) {
 499                        char ch = str[at+2+i];
 500                        if ('0' <= ch && ch <= '9')
 501                                nth = nth * 10 + ch - '0';
 502                        else
 503                                nth = -1;
 504                }
 505                if (100000000 <= nth) {
 506                        at_time = nth;
 507                        nth = -1;
 508                } else if (0 <= nth)
 509                        at_time = 0;
 510                else {
 511                        int errors = 0;
 512                        char *tmp = xstrndup(str + at + 2, reflog_len);
 513                        at_time = approxidate_careful(tmp, &errors);
 514                        free(tmp);
 515                        if (errors)
 516                                return -1;
 517                }
 518                if (read_ref_at(real_ref, at_time, nth, sha1, NULL,
 519                                &co_time, &co_tz, &co_cnt)) {
 520                        if (at_time)
 521                                warning("Log for '%.*s' only goes "
 522                                        "back to %s.", len, str,
 523                                        show_date(co_time, co_tz, DATE_RFC2822));
 524                        else {
 525                                free(real_ref);
 526                                die("Log for '%.*s' only has %d entries.",
 527                                    len, str, co_cnt);
 528                        }
 529                }
 530        }
 531
 532        free(real_ref);
 533        return 0;
 534}
 535
 536static int get_parent(const char *name, int len,
 537                      unsigned char *result, int idx)
 538{
 539        unsigned char sha1[20];
 540        int ret = get_sha1_1(name, len, sha1, GET_SHA1_COMMITTISH);
 541        struct commit *commit;
 542        struct commit_list *p;
 543
 544        if (ret)
 545                return ret;
 546        commit = lookup_commit_reference(sha1);
 547        if (!commit)
 548                return -1;
 549        if (parse_commit(commit))
 550                return -1;
 551        if (!idx) {
 552                hashcpy(result, commit->object.sha1);
 553                return 0;
 554        }
 555        p = commit->parents;
 556        while (p) {
 557                if (!--idx) {
 558                        hashcpy(result, p->item->object.sha1);
 559                        return 0;
 560                }
 561                p = p->next;
 562        }
 563        return -1;
 564}
 565
 566static int get_nth_ancestor(const char *name, int len,
 567                            unsigned char *result, int generation)
 568{
 569        unsigned char sha1[20];
 570        struct commit *commit;
 571        int ret;
 572
 573        ret = get_sha1_1(name, len, sha1, GET_SHA1_COMMITTISH);
 574        if (ret)
 575                return ret;
 576        commit = lookup_commit_reference(sha1);
 577        if (!commit)
 578                return -1;
 579
 580        while (generation--) {
 581                if (parse_commit(commit) || !commit->parents)
 582                        return -1;
 583                commit = commit->parents->item;
 584        }
 585        hashcpy(result, commit->object.sha1);
 586        return 0;
 587}
 588
 589struct object *peel_to_type(const char *name, int namelen,
 590                            struct object *o, enum object_type expected_type)
 591{
 592        if (name && !namelen)
 593                namelen = strlen(name);
 594        while (1) {
 595                if (!o || (!o->parsed && !parse_object(o->sha1)))
 596                        return NULL;
 597                if (expected_type == OBJ_ANY || o->type == expected_type)
 598                        return o;
 599                if (o->type == OBJ_TAG)
 600                        o = ((struct tag*) o)->tagged;
 601                else if (o->type == OBJ_COMMIT)
 602                        o = &(((struct commit *) o)->tree->object);
 603                else {
 604                        if (name)
 605                                error("%.*s: expected %s type, but the object "
 606                                      "dereferences to %s type",
 607                                      namelen, name, typename(expected_type),
 608                                      typename(o->type));
 609                        return NULL;
 610                }
 611        }
 612}
 613
 614static int peel_onion(const char *name, int len, unsigned char *sha1)
 615{
 616        unsigned char outer[20];
 617        const char *sp;
 618        unsigned int expected_type = 0;
 619        unsigned lookup_flags = 0;
 620        struct object *o;
 621
 622        /*
 623         * "ref^{type}" dereferences ref repeatedly until you cannot
 624         * dereference anymore, or you get an object of given type,
 625         * whichever comes first.  "ref^{}" means just dereference
 626         * tags until you get a non-tag.  "ref^0" is a shorthand for
 627         * "ref^{commit}".  "commit^{tree}" could be used to find the
 628         * top-level tree of the given commit.
 629         */
 630        if (len < 4 || name[len-1] != '}')
 631                return -1;
 632
 633        for (sp = name + len - 1; name <= sp; sp--) {
 634                int ch = *sp;
 635                if (ch == '{' && name < sp && sp[-1] == '^')
 636                        break;
 637        }
 638        if (sp <= name)
 639                return -1;
 640
 641        sp++; /* beginning of type name, or closing brace for empty */
 642        if (!strncmp(commit_type, sp, 6) && sp[6] == '}')
 643                expected_type = OBJ_COMMIT;
 644        else if (!strncmp(tree_type, sp, 4) && sp[4] == '}')
 645                expected_type = OBJ_TREE;
 646        else if (!strncmp(blob_type, sp, 4) && sp[4] == '}')
 647                expected_type = OBJ_BLOB;
 648        else if (!prefixcmp(sp, "object}"))
 649                expected_type = OBJ_ANY;
 650        else if (sp[0] == '}')
 651                expected_type = OBJ_NONE;
 652        else if (sp[0] == '/')
 653                expected_type = OBJ_COMMIT;
 654        else
 655                return -1;
 656
 657        if (expected_type == OBJ_COMMIT)
 658                lookup_flags = GET_SHA1_COMMITTISH;
 659        else if (expected_type == OBJ_TREE)
 660                lookup_flags = GET_SHA1_TREEISH;
 661
 662        if (get_sha1_1(name, sp - name - 2, outer, lookup_flags))
 663                return -1;
 664
 665        o = parse_object(outer);
 666        if (!o)
 667                return -1;
 668        if (!expected_type) {
 669                o = deref_tag(o, name, sp - name - 2);
 670                if (!o || (!o->parsed && !parse_object(o->sha1)))
 671                        return -1;
 672                hashcpy(sha1, o->sha1);
 673                return 0;
 674        }
 675
 676        /*
 677         * At this point, the syntax look correct, so
 678         * if we do not get the needed object, we should
 679         * barf.
 680         */
 681        o = peel_to_type(name, len, o, expected_type);
 682        if (!o)
 683                return -1;
 684
 685        hashcpy(sha1, o->sha1);
 686        if (sp[0] == '/') {
 687                /* "$commit^{/foo}" */
 688                char *prefix;
 689                int ret;
 690                struct commit_list *list = NULL;
 691
 692                /*
 693                 * $commit^{/}. Some regex implementation may reject.
 694                 * We don't need regex anyway. '' pattern always matches.
 695                 */
 696                if (sp[1] == '}')
 697                        return 0;
 698
 699                prefix = xstrndup(sp + 1, name + len - 1 - (sp + 1));
 700                commit_list_insert((struct commit *)o, &list);
 701                ret = get_sha1_oneline(prefix, sha1, list);
 702                free(prefix);
 703                return ret;
 704        }
 705        return 0;
 706}
 707
 708static int get_describe_name(const char *name, int len, unsigned char *sha1)
 709{
 710        const char *cp;
 711        unsigned flags = GET_SHA1_QUIETLY | GET_SHA1_COMMIT;
 712
 713        for (cp = name + len - 1; name + 2 <= cp; cp--) {
 714                char ch = *cp;
 715                if (hexval(ch) & ~0377) {
 716                        /* We must be looking at g in "SOMETHING-g"
 717                         * for it to be describe output.
 718                         */
 719                        if (ch == 'g' && cp[-1] == '-') {
 720                                cp++;
 721                                len -= cp - name;
 722                                return get_short_sha1(cp, len, sha1, flags);
 723                        }
 724                }
 725        }
 726        return -1;
 727}
 728
 729static int get_sha1_1(const char *name, int len, unsigned char *sha1, unsigned lookup_flags)
 730{
 731        int ret, has_suffix;
 732        const char *cp;
 733
 734        /*
 735         * "name~3" is "name^^^", "name~" is "name~1", and "name^" is "name^1".
 736         */
 737        has_suffix = 0;
 738        for (cp = name + len - 1; name <= cp; cp--) {
 739                int ch = *cp;
 740                if ('0' <= ch && ch <= '9')
 741                        continue;
 742                if (ch == '~' || ch == '^')
 743                        has_suffix = ch;
 744                break;
 745        }
 746
 747        if (has_suffix) {
 748                int num = 0;
 749                int len1 = cp - name;
 750                cp++;
 751                while (cp < name + len)
 752                        num = num * 10 + *cp++ - '0';
 753                if (!num && len1 == len - 1)
 754                        num = 1;
 755                if (has_suffix == '^')
 756                        return get_parent(name, len1, sha1, num);
 757                /* else if (has_suffix == '~') -- goes without saying */
 758                return get_nth_ancestor(name, len1, sha1, num);
 759        }
 760
 761        ret = peel_onion(name, len, sha1);
 762        if (!ret)
 763                return 0;
 764
 765        ret = get_sha1_basic(name, len, sha1);
 766        if (!ret)
 767                return 0;
 768
 769        /* It could be describe output that is "SOMETHING-gXXXX" */
 770        ret = get_describe_name(name, len, sha1);
 771        if (!ret)
 772                return 0;
 773
 774        return get_short_sha1(name, len, sha1, lookup_flags);
 775}
 776
 777/*
 778 * This interprets names like ':/Initial revision of "git"' by searching
 779 * through history and returning the first commit whose message starts
 780 * the given regular expression.
 781 *
 782 * For future extension, ':/!' is reserved. If you want to match a message
 783 * beginning with a '!', you have to repeat the exclamation mark.
 784 */
 785#define ONELINE_SEEN (1u<<20)
 786
 787static int handle_one_ref(const char *path,
 788                const unsigned char *sha1, int flag, void *cb_data)
 789{
 790        struct commit_list **list = cb_data;
 791        struct object *object = parse_object(sha1);
 792        if (!object)
 793                return 0;
 794        if (object->type == OBJ_TAG) {
 795                object = deref_tag(object, path, strlen(path));
 796                if (!object)
 797                        return 0;
 798        }
 799        if (object->type != OBJ_COMMIT)
 800                return 0;
 801        commit_list_insert_by_date((struct commit *)object, list);
 802        return 0;
 803}
 804
 805static int get_sha1_oneline(const char *prefix, unsigned char *sha1,
 806                            struct commit_list *list)
 807{
 808        struct commit_list *backup = NULL, *l;
 809        int found = 0;
 810        regex_t regex;
 811
 812        if (prefix[0] == '!') {
 813                if (prefix[1] != '!')
 814                        die ("Invalid search pattern: %s", prefix);
 815                prefix++;
 816        }
 817
 818        if (regcomp(&regex, prefix, REG_EXTENDED))
 819                die("Invalid search pattern: %s", prefix);
 820
 821        for (l = list; l; l = l->next) {
 822                l->item->object.flags |= ONELINE_SEEN;
 823                commit_list_insert(l->item, &backup);
 824        }
 825        while (list) {
 826                char *p, *to_free = NULL;
 827                struct commit *commit;
 828                enum object_type type;
 829                unsigned long size;
 830                int matches;
 831
 832                commit = pop_most_recent_commit(&list, ONELINE_SEEN);
 833                if (!parse_object(commit->object.sha1))
 834                        continue;
 835                if (commit->buffer)
 836                        p = commit->buffer;
 837                else {
 838                        p = read_sha1_file(commit->object.sha1, &type, &size);
 839                        if (!p)
 840                                continue;
 841                        to_free = p;
 842                }
 843
 844                p = strstr(p, "\n\n");
 845                matches = p && !regexec(&regex, p + 2, 0, NULL, 0);
 846                free(to_free);
 847
 848                if (matches) {
 849                        hashcpy(sha1, commit->object.sha1);
 850                        found = 1;
 851                        break;
 852                }
 853        }
 854        regfree(&regex);
 855        free_commit_list(list);
 856        for (l = backup; l; l = l->next)
 857                clear_commit_marks(l->item, ONELINE_SEEN);
 858        free_commit_list(backup);
 859        return found ? 0 : -1;
 860}
 861
 862struct grab_nth_branch_switch_cbdata {
 863        int remaining;
 864        struct strbuf buf;
 865};
 866
 867static int grab_nth_branch_switch(unsigned char *osha1, unsigned char *nsha1,
 868                                  const char *email, unsigned long timestamp, int tz,
 869                                  const char *message, void *cb_data)
 870{
 871        struct grab_nth_branch_switch_cbdata *cb = cb_data;
 872        const char *match = NULL, *target = NULL;
 873        size_t len;
 874
 875        if (!prefixcmp(message, "checkout: moving from ")) {
 876                match = message + strlen("checkout: moving from ");
 877                target = strstr(match, " to ");
 878        }
 879
 880        if (!match || !target)
 881                return 0;
 882        if (--(cb->remaining) == 0) {
 883                len = target - match;
 884                strbuf_reset(&cb->buf);
 885                strbuf_add(&cb->buf, match, len);
 886                return 1; /* we are done */
 887        }
 888        return 0;
 889}
 890
 891/*
 892 * Parse @{-N} syntax, return the number of characters parsed
 893 * if successful; otherwise signal an error with negative value.
 894 */
 895static int interpret_nth_prior_checkout(const char *name, struct strbuf *buf)
 896{
 897        long nth;
 898        int retval;
 899        struct grab_nth_branch_switch_cbdata cb;
 900        const char *brace;
 901        char *num_end;
 902
 903        if (name[0] != '@' || name[1] != '{' || name[2] != '-')
 904                return -1;
 905        brace = strchr(name, '}');
 906        if (!brace)
 907                return -1;
 908        nth = strtol(name + 3, &num_end, 10);
 909        if (num_end != brace)
 910                return -1;
 911        if (nth <= 0)
 912                return -1;
 913        cb.remaining = nth;
 914        strbuf_init(&cb.buf, 20);
 915
 916        retval = 0;
 917        if (0 < for_each_reflog_ent_reverse("HEAD", grab_nth_branch_switch, &cb)) {
 918                strbuf_reset(buf);
 919                strbuf_add(buf, cb.buf.buf, cb.buf.len);
 920                retval = brace - name + 1;
 921        }
 922
 923        strbuf_release(&cb.buf);
 924        return retval;
 925}
 926
 927int get_sha1_mb(const char *name, unsigned char *sha1)
 928{
 929        struct commit *one, *two;
 930        struct commit_list *mbs;
 931        unsigned char sha1_tmp[20];
 932        const char *dots;
 933        int st;
 934
 935        dots = strstr(name, "...");
 936        if (!dots)
 937                return get_sha1(name, sha1);
 938        if (dots == name)
 939                st = get_sha1("HEAD", sha1_tmp);
 940        else {
 941                struct strbuf sb;
 942                strbuf_init(&sb, dots - name);
 943                strbuf_add(&sb, name, dots - name);
 944                st = get_sha1_committish(sb.buf, sha1_tmp);
 945                strbuf_release(&sb);
 946        }
 947        if (st)
 948                return st;
 949        one = lookup_commit_reference_gently(sha1_tmp, 0);
 950        if (!one)
 951                return -1;
 952
 953        if (get_sha1_committish(dots[3] ? (dots + 3) : "HEAD", sha1_tmp))
 954                return -1;
 955        two = lookup_commit_reference_gently(sha1_tmp, 0);
 956        if (!two)
 957                return -1;
 958        mbs = get_merge_bases(one, two, 1);
 959        if (!mbs || mbs->next)
 960                st = -1;
 961        else {
 962                st = 0;
 963                hashcpy(sha1, mbs->item->object.sha1);
 964        }
 965        free_commit_list(mbs);
 966        return st;
 967}
 968
 969/*
 970 * This reads short-hand syntax that not only evaluates to a commit
 971 * object name, but also can act as if the end user spelled the name
 972 * of the branch from the command line.
 973 *
 974 * - "@{-N}" finds the name of the Nth previous branch we were on, and
 975 *   places the name of the branch in the given buf and returns the
 976 *   number of characters parsed if successful.
 977 *
 978 * - "<branch>@{upstream}" finds the name of the other ref that
 979 *   <branch> is configured to merge with (missing <branch> defaults
 980 *   to the current branch), and places the name of the branch in the
 981 *   given buf and returns the number of characters parsed if
 982 *   successful.
 983 *
 984 * If the input is not of the accepted format, it returns a negative
 985 * number to signal an error.
 986 *
 987 * If the input was ok but there are not N branch switches in the
 988 * reflog, it returns 0.
 989 */
 990int interpret_branch_name(const char *name, struct strbuf *buf)
 991{
 992        char *cp;
 993        struct branch *upstream;
 994        int namelen = strlen(name);
 995        int len = interpret_nth_prior_checkout(name, buf);
 996        int tmp_len;
 997
 998        if (!len)
 999                return len; /* syntax Ok, not enough switches */
1000        if (0 < len && len == namelen)
1001                return len; /* consumed all */
1002        else if (0 < len) {
1003                /* we have extra data, which might need further processing */
1004                struct strbuf tmp = STRBUF_INIT;
1005                int used = buf->len;
1006                int ret;
1007
1008                strbuf_add(buf, name + len, namelen - len);
1009                ret = interpret_branch_name(buf->buf, &tmp);
1010                /* that data was not interpreted, remove our cruft */
1011                if (ret < 0) {
1012                        strbuf_setlen(buf, used);
1013                        return len;
1014                }
1015                strbuf_reset(buf);
1016                strbuf_addbuf(buf, &tmp);
1017                strbuf_release(&tmp);
1018                /* tweak for size of {-N} versus expanded ref name */
1019                return ret - used + len;
1020        }
1021
1022        cp = strchr(name, '@');
1023        if (!cp)
1024                return -1;
1025        tmp_len = upstream_mark(cp, namelen - (cp - name));
1026        if (!tmp_len)
1027                return -1;
1028        len = cp + tmp_len - name;
1029        cp = xstrndup(name, cp - name);
1030        upstream = branch_get(*cp ? cp : NULL);
1031        /*
1032         * Upstream can be NULL only if cp refers to HEAD and HEAD
1033         * points to something different than a branch.
1034         */
1035        if (!upstream)
1036                return error(_("HEAD does not point to a branch"));
1037        if (!upstream->merge || !upstream->merge[0]->dst) {
1038                if (!ref_exists(upstream->refname))
1039                        return error(_("No such branch: '%s'"), cp);
1040                if (!upstream->merge)
1041                        return error(_("No upstream configured for branch '%s'"),
1042                                     upstream->name);
1043                return error(
1044                        _("Upstream branch '%s' not stored as a remote-tracking branch"),
1045                        upstream->merge[0]->src);
1046        }
1047        free(cp);
1048        cp = shorten_unambiguous_ref(upstream->merge[0]->dst, 0);
1049        strbuf_reset(buf);
1050        strbuf_addstr(buf, cp);
1051        free(cp);
1052        return len;
1053}
1054
1055int strbuf_branchname(struct strbuf *sb, const char *name)
1056{
1057        int len = strlen(name);
1058        if (interpret_branch_name(name, sb) == len)
1059                return 0;
1060        strbuf_add(sb, name, len);
1061        return len;
1062}
1063
1064int strbuf_check_branch_ref(struct strbuf *sb, const char *name)
1065{
1066        strbuf_branchname(sb, name);
1067        if (name[0] == '-')
1068                return -1;
1069        strbuf_splice(sb, 0, 0, "refs/heads/", 11);
1070        return check_refname_format(sb->buf, 0);
1071}
1072
1073/*
1074 * This is like "get_sha1_basic()", except it allows "sha1 expressions",
1075 * notably "xyz^" for "parent of xyz"
1076 */
1077int get_sha1(const char *name, unsigned char *sha1)
1078{
1079        struct object_context unused;
1080        return get_sha1_with_context(name, 0, sha1, &unused);
1081}
1082
1083/*
1084 * Many callers know that the user meant to name a committish by
1085 * syntactical positions where the object name appears.  Calling this
1086 * function allows the machinery to disambiguate shorter-than-unique
1087 * abbreviated object names between committish and others.
1088 *
1089 * Note that this does NOT error out when the named object is not a
1090 * committish. It is merely to give a hint to the disambiguation
1091 * machinery.
1092 */
1093int get_sha1_committish(const char *name, unsigned char *sha1)
1094{
1095        struct object_context unused;
1096        return get_sha1_with_context(name, GET_SHA1_COMMITTISH,
1097                                     sha1, &unused);
1098}
1099
1100int get_sha1_treeish(const char *name, unsigned char *sha1)
1101{
1102        struct object_context unused;
1103        return get_sha1_with_context(name, GET_SHA1_TREEISH,
1104                                     sha1, &unused);
1105}
1106
1107int get_sha1_commit(const char *name, unsigned char *sha1)
1108{
1109        struct object_context unused;
1110        return get_sha1_with_context(name, GET_SHA1_COMMIT,
1111                                     sha1, &unused);
1112}
1113
1114int get_sha1_tree(const char *name, unsigned char *sha1)
1115{
1116        struct object_context unused;
1117        return get_sha1_with_context(name, GET_SHA1_TREE,
1118                                     sha1, &unused);
1119}
1120
1121int get_sha1_blob(const char *name, unsigned char *sha1)
1122{
1123        struct object_context unused;
1124        return get_sha1_with_context(name, GET_SHA1_BLOB,
1125                                     sha1, &unused);
1126}
1127
1128/* Must be called only when object_name:filename doesn't exist. */
1129static void diagnose_invalid_sha1_path(const char *prefix,
1130                                       const char *filename,
1131                                       const unsigned char *tree_sha1,
1132                                       const char *object_name,
1133                                       int object_name_len)
1134{
1135        struct stat st;
1136        unsigned char sha1[20];
1137        unsigned mode;
1138
1139        if (!prefix)
1140                prefix = "";
1141
1142        if (!lstat(filename, &st))
1143                die("Path '%s' exists on disk, but not in '%.*s'.",
1144                    filename, object_name_len, object_name);
1145        if (errno == ENOENT || errno == ENOTDIR) {
1146                char *fullname = xmalloc(strlen(filename)
1147                                             + strlen(prefix) + 1);
1148                strcpy(fullname, prefix);
1149                strcat(fullname, filename);
1150
1151                if (!get_tree_entry(tree_sha1, fullname,
1152                                    sha1, &mode)) {
1153                        die("Path '%s' exists, but not '%s'.\n"
1154                            "Did you mean '%.*s:%s' aka '%.*s:./%s'?",
1155                            fullname,
1156                            filename,
1157                            object_name_len, object_name,
1158                            fullname,
1159                            object_name_len, object_name,
1160                            filename);
1161                }
1162                die("Path '%s' does not exist in '%.*s'",
1163                    filename, object_name_len, object_name);
1164        }
1165}
1166
1167/* Must be called only when :stage:filename doesn't exist. */
1168static void diagnose_invalid_index_path(int stage,
1169                                        const char *prefix,
1170                                        const char *filename)
1171{
1172        struct stat st;
1173        struct cache_entry *ce;
1174        int pos;
1175        unsigned namelen = strlen(filename);
1176        unsigned fullnamelen;
1177        char *fullname;
1178
1179        if (!prefix)
1180                prefix = "";
1181
1182        /* Wrong stage number? */
1183        pos = cache_name_pos(filename, namelen);
1184        if (pos < 0)
1185                pos = -pos - 1;
1186        if (pos < active_nr) {
1187                ce = active_cache[pos];
1188                if (ce_namelen(ce) == namelen &&
1189                    !memcmp(ce->name, filename, namelen))
1190                        die("Path '%s' is in the index, but not at stage %d.\n"
1191                            "Did you mean ':%d:%s'?",
1192                            filename, stage,
1193                            ce_stage(ce), filename);
1194        }
1195
1196        /* Confusion between relative and absolute filenames? */
1197        fullnamelen = namelen + strlen(prefix);
1198        fullname = xmalloc(fullnamelen + 1);
1199        strcpy(fullname, prefix);
1200        strcat(fullname, filename);
1201        pos = cache_name_pos(fullname, fullnamelen);
1202        if (pos < 0)
1203                pos = -pos - 1;
1204        if (pos < active_nr) {
1205                ce = active_cache[pos];
1206                if (ce_namelen(ce) == fullnamelen &&
1207                    !memcmp(ce->name, fullname, fullnamelen))
1208                        die("Path '%s' is in the index, but not '%s'.\n"
1209                            "Did you mean ':%d:%s' aka ':%d:./%s'?",
1210                            fullname, filename,
1211                            ce_stage(ce), fullname,
1212                            ce_stage(ce), filename);
1213        }
1214
1215        if (!lstat(filename, &st))
1216                die("Path '%s' exists on disk, but not in the index.", filename);
1217        if (errno == ENOENT || errno == ENOTDIR)
1218                die("Path '%s' does not exist (neither on disk nor in the index).",
1219                    filename);
1220
1221        free(fullname);
1222}
1223
1224
1225static char *resolve_relative_path(const char *rel)
1226{
1227        if (prefixcmp(rel, "./") && prefixcmp(rel, "../"))
1228                return NULL;
1229
1230        if (!startup_info)
1231                die("BUG: startup_info struct is not initialized.");
1232
1233        if (!is_inside_work_tree())
1234                die("relative path syntax can't be used outside working tree.");
1235
1236        /* die() inside prefix_path() if resolved path is outside worktree */
1237        return prefix_path(startup_info->prefix,
1238                           startup_info->prefix ? strlen(startup_info->prefix) : 0,
1239                           rel);
1240}
1241
1242static int get_sha1_with_context_1(const char *name,
1243                                   unsigned flags,
1244                                   const char *prefix,
1245                                   unsigned char *sha1,
1246                                   struct object_context *oc)
1247{
1248        int ret, bracket_depth;
1249        int namelen = strlen(name);
1250        const char *cp;
1251        int only_to_die = flags & GET_SHA1_ONLY_TO_DIE;
1252
1253        memset(oc, 0, sizeof(*oc));
1254        oc->mode = S_IFINVALID;
1255        ret = get_sha1_1(name, namelen, sha1, flags);
1256        if (!ret)
1257                return ret;
1258        /*
1259         * sha1:path --> object name of path in ent sha1
1260         * :path -> object name of absolute path in index
1261         * :./path -> object name of path relative to cwd in index
1262         * :[0-3]:path -> object name of path in index at stage
1263         * :/foo -> recent commit matching foo
1264         */
1265        if (name[0] == ':') {
1266                int stage = 0;
1267                struct cache_entry *ce;
1268                char *new_path = NULL;
1269                int pos;
1270                if (!only_to_die && namelen > 2 && name[1] == '/') {
1271                        struct commit_list *list = NULL;
1272                        for_each_ref(handle_one_ref, &list);
1273                        return get_sha1_oneline(name + 2, sha1, list);
1274                }
1275                if (namelen < 3 ||
1276                    name[2] != ':' ||
1277                    name[1] < '0' || '3' < name[1])
1278                        cp = name + 1;
1279                else {
1280                        stage = name[1] - '0';
1281                        cp = name + 3;
1282                }
1283                new_path = resolve_relative_path(cp);
1284                if (!new_path) {
1285                        namelen = namelen - (cp - name);
1286                } else {
1287                        cp = new_path;
1288                        namelen = strlen(cp);
1289                }
1290
1291                strncpy(oc->path, cp,
1292                        sizeof(oc->path));
1293                oc->path[sizeof(oc->path)-1] = '\0';
1294
1295                if (!active_cache)
1296                        read_cache();
1297                pos = cache_name_pos(cp, namelen);
1298                if (pos < 0)
1299                        pos = -pos - 1;
1300                while (pos < active_nr) {
1301                        ce = active_cache[pos];
1302                        if (ce_namelen(ce) != namelen ||
1303                            memcmp(ce->name, cp, namelen))
1304                                break;
1305                        if (ce_stage(ce) == stage) {
1306                                hashcpy(sha1, ce->sha1);
1307                                oc->mode = ce->ce_mode;
1308                                free(new_path);
1309                                return 0;
1310                        }
1311                        pos++;
1312                }
1313                if (only_to_die && name[1] && name[1] != '/')
1314                        diagnose_invalid_index_path(stage, prefix, cp);
1315                free(new_path);
1316                return -1;
1317        }
1318        for (cp = name, bracket_depth = 0; *cp; cp++) {
1319                if (*cp == '{')
1320                        bracket_depth++;
1321                else if (bracket_depth && *cp == '}')
1322                        bracket_depth--;
1323                else if (!bracket_depth && *cp == ':')
1324                        break;
1325        }
1326        if (*cp == ':') {
1327                unsigned char tree_sha1[20];
1328                int len = cp - name;
1329                if (!get_sha1_1(name, len, tree_sha1, GET_SHA1_TREEISH)) {
1330                        const char *filename = cp+1;
1331                        char *new_filename = NULL;
1332
1333                        new_filename = resolve_relative_path(filename);
1334                        if (new_filename)
1335                                filename = new_filename;
1336                        ret = get_tree_entry(tree_sha1, filename, sha1, &oc->mode);
1337                        if (ret && only_to_die) {
1338                                diagnose_invalid_sha1_path(prefix, filename,
1339                                                           tree_sha1,
1340                                                           name, len);
1341                        }
1342                        hashcpy(oc->tree, tree_sha1);
1343                        strncpy(oc->path, filename,
1344                                sizeof(oc->path));
1345                        oc->path[sizeof(oc->path)-1] = '\0';
1346
1347                        free(new_filename);
1348                        return ret;
1349                } else {
1350                        if (only_to_die)
1351                                die("Invalid object name '%.*s'.", len, name);
1352                }
1353        }
1354        return ret;
1355}
1356
1357/*
1358 * Call this function when you know "name" given by the end user must
1359 * name an object but it doesn't; the function _may_ die with a better
1360 * diagnostic message than "no such object 'name'", e.g. "Path 'doc' does not
1361 * exist in 'HEAD'" when given "HEAD:doc", or it may return in which case
1362 * you have a chance to diagnose the error further.
1363 */
1364void maybe_die_on_misspelt_object_name(const char *name, const char *prefix)
1365{
1366        struct object_context oc;
1367        unsigned char sha1[20];
1368        get_sha1_with_context_1(name, GET_SHA1_ONLY_TO_DIE, prefix, sha1, &oc);
1369}
1370
1371int get_sha1_with_context(const char *str, unsigned flags, unsigned char *sha1, struct object_context *orc)
1372{
1373        return get_sha1_with_context_1(str, flags, NULL, sha1, orc);
1374}