refs.con commit add_ref(): take a (struct ref_entry *) parameter (dd73ecd)
   1#include "cache.h"
   2#include "refs.h"
   3#include "object.h"
   4#include "tag.h"
   5#include "dir.h"
   6
   7/* ISSYMREF=0x01, ISPACKED=0x02 and ISBROKEN=0x04 are public interfaces */
   8#define REF_KNOWS_PEELED 0x10
   9
  10struct ref_entry {
  11        unsigned char flag; /* ISSYMREF? ISPACKED? */
  12        unsigned char sha1[20];
  13        unsigned char peeled[20];
  14        /* The full name of the reference (e.g., "refs/heads/master"): */
  15        char name[FLEX_ARRAY];
  16};
  17
  18struct ref_array {
  19        int nr, alloc;
  20        struct ref_entry **refs;
  21};
  22
  23/*
  24 * Parse one line from a packed-refs file.  Write the SHA1 to sha1.
  25 * Return a pointer to the refname within the line (null-terminated),
  26 * or NULL if there was a problem.
  27 */
  28static const char *parse_ref_line(char *line, unsigned char *sha1)
  29{
  30        /*
  31         * 42: the answer to everything.
  32         *
  33         * In this case, it happens to be the answer to
  34         *  40 (length of sha1 hex representation)
  35         *  +1 (space in between hex and name)
  36         *  +1 (newline at the end of the line)
  37         */
  38        int len = strlen(line) - 42;
  39
  40        if (len <= 0)
  41                return NULL;
  42        if (get_sha1_hex(line, sha1) < 0)
  43                return NULL;
  44        if (!isspace(line[40]))
  45                return NULL;
  46        line += 41;
  47        if (isspace(*line))
  48                return NULL;
  49        if (line[len] != '\n')
  50                return NULL;
  51        line[len] = 0;
  52
  53        return line;
  54}
  55
  56static struct ref_entry *create_ref_entry(const char *refname,
  57                                          const unsigned char *sha1, int flag,
  58                                          int check_name)
  59{
  60        int len;
  61        struct ref_entry *ref;
  62
  63        if (check_name &&
  64            check_refname_format(refname, REFNAME_ALLOW_ONELEVEL|REFNAME_DOT_COMPONENT))
  65                die("Reference has invalid format: '%s'", refname);
  66        len = strlen(refname) + 1;
  67        ref = xmalloc(sizeof(struct ref_entry) + len);
  68        hashcpy(ref->sha1, sha1);
  69        hashclr(ref->peeled);
  70        memcpy(ref->name, refname, len);
  71        ref->flag = flag;
  72        return ref;
  73}
  74
  75/* Add a ref_entry to the end of the ref_array (unsorted). */
  76static void add_ref(struct ref_array *refs, struct ref_entry *ref)
  77{
  78        ALLOC_GROW(refs->refs, refs->nr + 1, refs->alloc);
  79        refs->refs[refs->nr++] = ref;
  80}
  81
  82static int ref_entry_cmp(const void *a, const void *b)
  83{
  84        struct ref_entry *one = *(struct ref_entry **)a;
  85        struct ref_entry *two = *(struct ref_entry **)b;
  86        return strcmp(one->name, two->name);
  87}
  88
  89/*
  90 * Emit a warning and return true iff ref1 and ref2 have the same name
  91 * and the same sha1.  Die if they have the same name but different
  92 * sha1s.
  93 */
  94static int is_dup_ref(const struct ref_entry *ref1, const struct ref_entry *ref2)
  95{
  96        if (!strcmp(ref1->name, ref2->name)) {
  97                /* Duplicate name; make sure that the SHA1s match: */
  98                if (hashcmp(ref1->sha1, ref2->sha1))
  99                        die("Duplicated ref, and SHA1s don't match: %s",
 100                            ref1->name);
 101                warning("Duplicated ref: %s", ref1->name);
 102                return 1;
 103        } else {
 104                return 0;
 105        }
 106}
 107
 108static void sort_ref_array(struct ref_array *array)
 109{
 110        int i, j;
 111
 112        /* Nothing to sort unless there are at least two entries */
 113        if (array->nr < 2)
 114                return;
 115
 116        qsort(array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
 117
 118        /* Remove any duplicates from the ref_array */
 119        i = 0;
 120        for (j = 1; j < array->nr; j++) {
 121                if (is_dup_ref(array->refs[i], array->refs[j])) {
 122                        free(array->refs[j]);
 123                        continue;
 124                }
 125                array->refs[++i] = array->refs[j];
 126        }
 127        array->nr = i + 1;
 128}
 129
 130static struct ref_entry *search_ref_array(struct ref_array *array, const char *refname)
 131{
 132        struct ref_entry *e, **r;
 133        int len;
 134
 135        if (refname == NULL)
 136                return NULL;
 137
 138        if (!array->nr)
 139                return NULL;
 140
 141        len = strlen(refname) + 1;
 142        e = xmalloc(sizeof(struct ref_entry) + len);
 143        memcpy(e->name, refname, len);
 144
 145        r = bsearch(&e, array->refs, array->nr, sizeof(*array->refs), ref_entry_cmp);
 146
 147        free(e);
 148
 149        if (r == NULL)
 150                return NULL;
 151
 152        return *r;
 153}
 154
 155/*
 156 * Future: need to be in "struct repository"
 157 * when doing a full libification.
 158 */
 159static struct ref_cache {
 160        struct ref_cache *next;
 161        char did_loose;
 162        char did_packed;
 163        struct ref_array loose;
 164        struct ref_array packed;
 165        /* The submodule name, or "" for the main repo. */
 166        char name[FLEX_ARRAY];
 167} *ref_cache;
 168
 169static struct ref_entry *current_ref;
 170
 171static struct ref_array extra_refs;
 172
 173static void clear_ref_array(struct ref_array *array)
 174{
 175        int i;
 176        for (i = 0; i < array->nr; i++)
 177                free(array->refs[i]);
 178        free(array->refs);
 179        array->nr = array->alloc = 0;
 180        array->refs = NULL;
 181}
 182
 183static void clear_packed_ref_cache(struct ref_cache *refs)
 184{
 185        if (refs->did_packed)
 186                clear_ref_array(&refs->packed);
 187        refs->did_packed = 0;
 188}
 189
 190static void clear_loose_ref_cache(struct ref_cache *refs)
 191{
 192        if (refs->did_loose)
 193                clear_ref_array(&refs->loose);
 194        refs->did_loose = 0;
 195}
 196
 197static struct ref_cache *create_ref_cache(const char *submodule)
 198{
 199        int len;
 200        struct ref_cache *refs;
 201        if (!submodule)
 202                submodule = "";
 203        len = strlen(submodule) + 1;
 204        refs = xcalloc(1, sizeof(struct ref_cache) + len);
 205        memcpy(refs->name, submodule, len);
 206        return refs;
 207}
 208
 209/*
 210 * Return a pointer to a ref_cache for the specified submodule. For
 211 * the main repository, use submodule==NULL. The returned structure
 212 * will be allocated and initialized but not necessarily populated; it
 213 * should not be freed.
 214 */
 215static struct ref_cache *get_ref_cache(const char *submodule)
 216{
 217        struct ref_cache *refs = ref_cache;
 218        if (!submodule)
 219                submodule = "";
 220        while (refs) {
 221                if (!strcmp(submodule, refs->name))
 222                        return refs;
 223                refs = refs->next;
 224        }
 225
 226        refs = create_ref_cache(submodule);
 227        refs->next = ref_cache;
 228        ref_cache = refs;
 229        return refs;
 230}
 231
 232void invalidate_ref_cache(const char *submodule)
 233{
 234        struct ref_cache *refs = get_ref_cache(submodule);
 235        clear_packed_ref_cache(refs);
 236        clear_loose_ref_cache(refs);
 237}
 238
 239static void read_packed_refs(FILE *f, struct ref_array *array)
 240{
 241        struct ref_entry *last = NULL;
 242        char refline[PATH_MAX];
 243        int flag = REF_ISPACKED;
 244
 245        while (fgets(refline, sizeof(refline), f)) {
 246                unsigned char sha1[20];
 247                const char *refname;
 248                static const char header[] = "# pack-refs with:";
 249
 250                if (!strncmp(refline, header, sizeof(header)-1)) {
 251                        const char *traits = refline + sizeof(header) - 1;
 252                        if (strstr(traits, " peeled "))
 253                                flag |= REF_KNOWS_PEELED;
 254                        /* perhaps other traits later as well */
 255                        continue;
 256                }
 257
 258                refname = parse_ref_line(refline, sha1);
 259                if (refname) {
 260                        last = create_ref_entry(refname, sha1, flag, 1);
 261                        add_ref(array, last);
 262                        continue;
 263                }
 264                if (last &&
 265                    refline[0] == '^' &&
 266                    strlen(refline) == 42 &&
 267                    refline[41] == '\n' &&
 268                    !get_sha1_hex(refline + 1, sha1))
 269                        hashcpy(last->peeled, sha1);
 270        }
 271        sort_ref_array(array);
 272}
 273
 274void add_extra_ref(const char *refname, const unsigned char *sha1, int flag)
 275{
 276        add_ref(&extra_refs, create_ref_entry(refname, sha1, flag, 0));
 277}
 278
 279void clear_extra_refs(void)
 280{
 281        clear_ref_array(&extra_refs);
 282}
 283
 284static struct ref_array *get_packed_refs(struct ref_cache *refs)
 285{
 286        if (!refs->did_packed) {
 287                const char *packed_refs_file;
 288                FILE *f;
 289
 290                if (*refs->name)
 291                        packed_refs_file = git_path_submodule(refs->name, "packed-refs");
 292                else
 293                        packed_refs_file = git_path("packed-refs");
 294                f = fopen(packed_refs_file, "r");
 295                if (f) {
 296                        read_packed_refs(f, &refs->packed);
 297                        fclose(f);
 298                }
 299                refs->did_packed = 1;
 300        }
 301        return &refs->packed;
 302}
 303
 304static void get_ref_dir(struct ref_cache *refs, const char *base,
 305                        struct ref_array *array)
 306{
 307        DIR *dir;
 308        const char *path;
 309
 310        if (*refs->name)
 311                path = git_path_submodule(refs->name, "%s", base);
 312        else
 313                path = git_path("%s", base);
 314
 315
 316        dir = opendir(path);
 317
 318        if (dir) {
 319                struct dirent *de;
 320                int baselen = strlen(base);
 321                char *refname = xmalloc(baselen + 257);
 322
 323                memcpy(refname, base, baselen);
 324                if (baselen && base[baselen-1] != '/')
 325                        refname[baselen++] = '/';
 326
 327                while ((de = readdir(dir)) != NULL) {
 328                        unsigned char sha1[20];
 329                        struct stat st;
 330                        int flag;
 331                        int namelen;
 332                        const char *refdir;
 333
 334                        if (de->d_name[0] == '.')
 335                                continue;
 336                        namelen = strlen(de->d_name);
 337                        if (namelen > 255)
 338                                continue;
 339                        if (has_extension(de->d_name, ".lock"))
 340                                continue;
 341                        memcpy(refname + baselen, de->d_name, namelen+1);
 342                        refdir = *refs->name
 343                                ? git_path_submodule(refs->name, "%s", refname)
 344                                : git_path("%s", refname);
 345                        if (stat(refdir, &st) < 0)
 346                                continue;
 347                        if (S_ISDIR(st.st_mode)) {
 348                                get_ref_dir(refs, refname, array);
 349                                continue;
 350                        }
 351                        if (*refs->name) {
 352                                hashclr(sha1);
 353                                flag = 0;
 354                                if (resolve_gitlink_ref(refs->name, refname, sha1) < 0) {
 355                                        hashclr(sha1);
 356                                        flag |= REF_ISBROKEN;
 357                                }
 358                        } else if (read_ref_full(refname, sha1, 1, &flag)) {
 359                                hashclr(sha1);
 360                                flag |= REF_ISBROKEN;
 361                        }
 362                        add_ref(array, create_ref_entry(refname, sha1, flag, 1));
 363                }
 364                free(refname);
 365                closedir(dir);
 366        }
 367}
 368
 369struct warn_if_dangling_data {
 370        FILE *fp;
 371        const char *refname;
 372        const char *msg_fmt;
 373};
 374
 375static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
 376                                   int flags, void *cb_data)
 377{
 378        struct warn_if_dangling_data *d = cb_data;
 379        const char *resolves_to;
 380        unsigned char junk[20];
 381
 382        if (!(flags & REF_ISSYMREF))
 383                return 0;
 384
 385        resolves_to = resolve_ref(refname, junk, 0, NULL);
 386        if (!resolves_to || strcmp(resolves_to, d->refname))
 387                return 0;
 388
 389        fprintf(d->fp, d->msg_fmt, refname);
 390        return 0;
 391}
 392
 393void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
 394{
 395        struct warn_if_dangling_data data;
 396
 397        data.fp = fp;
 398        data.refname = refname;
 399        data.msg_fmt = msg_fmt;
 400        for_each_rawref(warn_if_dangling_symref, &data);
 401}
 402
 403static struct ref_array *get_loose_refs(struct ref_cache *refs)
 404{
 405        if (!refs->did_loose) {
 406                get_ref_dir(refs, "refs", &refs->loose);
 407                sort_ref_array(&refs->loose);
 408                refs->did_loose = 1;
 409        }
 410        return &refs->loose;
 411}
 412
 413/* We allow "recursive" symbolic refs. Only within reason, though */
 414#define MAXDEPTH 5
 415#define MAXREFLEN (1024)
 416
 417/*
 418 * Called by resolve_gitlink_ref_recursive() after it failed to read
 419 * from the loose refs in ref_cache refs. Find <refname> in the
 420 * packed-refs file for the submodule.
 421 */
 422static int resolve_gitlink_packed_ref(struct ref_cache *refs,
 423                                      const char *refname, unsigned char *sha1)
 424{
 425        struct ref_entry *ref;
 426        struct ref_array *array = get_packed_refs(refs);
 427
 428        ref = search_ref_array(array, refname);
 429        if (ref == NULL)
 430                return -1;
 431
 432        memcpy(sha1, ref->sha1, 20);
 433        return 0;
 434}
 435
 436static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
 437                                         const char *refname, unsigned char *sha1,
 438                                         int recursion)
 439{
 440        int fd, len;
 441        char buffer[128], *p;
 442        char *path;
 443
 444        if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
 445                return -1;
 446        path = *refs->name
 447                ? git_path_submodule(refs->name, "%s", refname)
 448                : git_path("%s", refname);
 449        fd = open(path, O_RDONLY);
 450        if (fd < 0)
 451                return resolve_gitlink_packed_ref(refs, refname, sha1);
 452
 453        len = read(fd, buffer, sizeof(buffer)-1);
 454        close(fd);
 455        if (len < 0)
 456                return -1;
 457        while (len && isspace(buffer[len-1]))
 458                len--;
 459        buffer[len] = 0;
 460
 461        /* Was it a detached head or an old-fashioned symlink? */
 462        if (!get_sha1_hex(buffer, sha1))
 463                return 0;
 464
 465        /* Symref? */
 466        if (strncmp(buffer, "ref:", 4))
 467                return -1;
 468        p = buffer + 4;
 469        while (isspace(*p))
 470                p++;
 471
 472        return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
 473}
 474
 475int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
 476{
 477        int len = strlen(path), retval;
 478        char *submodule;
 479        struct ref_cache *refs;
 480
 481        while (len && path[len-1] == '/')
 482                len--;
 483        if (!len)
 484                return -1;
 485        submodule = xstrndup(path, len);
 486        refs = get_ref_cache(submodule);
 487        free(submodule);
 488
 489        retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
 490        return retval;
 491}
 492
 493/*
 494 * Try to read ref from the packed references.  On success, set sha1
 495 * and return 0; otherwise, return -1.
 496 */
 497static int get_packed_ref(const char *refname, unsigned char *sha1)
 498{
 499        struct ref_array *packed = get_packed_refs(get_ref_cache(NULL));
 500        struct ref_entry *entry = search_ref_array(packed, refname);
 501        if (entry) {
 502                hashcpy(sha1, entry->sha1);
 503                return 0;
 504        }
 505        return -1;
 506}
 507
 508const char *resolve_ref(const char *refname, unsigned char *sha1, int reading, int *flag)
 509{
 510        int depth = MAXDEPTH;
 511        ssize_t len;
 512        char buffer[256];
 513        static char refname_buffer[256];
 514
 515        if (flag)
 516                *flag = 0;
 517
 518        if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
 519                return NULL;
 520
 521        for (;;) {
 522                char path[PATH_MAX];
 523                struct stat st;
 524                char *buf;
 525                int fd;
 526
 527                if (--depth < 0)
 528                        return NULL;
 529
 530                git_snpath(path, sizeof(path), "%s", refname);
 531
 532                if (lstat(path, &st) < 0) {
 533                        if (errno != ENOENT)
 534                                return NULL;
 535                        /*
 536                         * The loose reference file does not exist;
 537                         * check for a packed reference.
 538                         */
 539                        if (!get_packed_ref(refname, sha1)) {
 540                                if (flag)
 541                                        *flag |= REF_ISPACKED;
 542                                return refname;
 543                        }
 544                        /* The reference is not a packed reference, either. */
 545                        if (reading) {
 546                                return NULL;
 547                        } else {
 548                                hashclr(sha1);
 549                                return refname;
 550                        }
 551                }
 552
 553                /* Follow "normalized" - ie "refs/.." symlinks by hand */
 554                if (S_ISLNK(st.st_mode)) {
 555                        len = readlink(path, buffer, sizeof(buffer)-1);
 556                        if (len < 0)
 557                                return NULL;
 558                        buffer[len] = 0;
 559                        if (!prefixcmp(buffer, "refs/") &&
 560                                        !check_refname_format(buffer, 0)) {
 561                                strcpy(refname_buffer, buffer);
 562                                refname = refname_buffer;
 563                                if (flag)
 564                                        *flag |= REF_ISSYMREF;
 565                                continue;
 566                        }
 567                }
 568
 569                /* Is it a directory? */
 570                if (S_ISDIR(st.st_mode)) {
 571                        errno = EISDIR;
 572                        return NULL;
 573                }
 574
 575                /*
 576                 * Anything else, just open it and try to use it as
 577                 * a ref
 578                 */
 579                fd = open(path, O_RDONLY);
 580                if (fd < 0)
 581                        return NULL;
 582                len = read_in_full(fd, buffer, sizeof(buffer)-1);
 583                close(fd);
 584                if (len < 0)
 585                        return NULL;
 586                while (len && isspace(buffer[len-1]))
 587                        len--;
 588                buffer[len] = '\0';
 589
 590                /*
 591                 * Is it a symbolic ref?
 592                 */
 593                if (prefixcmp(buffer, "ref:"))
 594                        break;
 595                if (flag)
 596                        *flag |= REF_ISSYMREF;
 597                buf = buffer + 4;
 598                while (isspace(*buf))
 599                        buf++;
 600                if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
 601                        if (flag)
 602                                *flag |= REF_ISBROKEN;
 603                        return NULL;
 604                }
 605                refname = strcpy(refname_buffer, buf);
 606        }
 607        /* Please note that FETCH_HEAD has a second line containing other data. */
 608        if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
 609                if (flag)
 610                        *flag |= REF_ISBROKEN;
 611                return NULL;
 612        }
 613        return refname;
 614}
 615
 616/* The argument to filter_refs */
 617struct ref_filter {
 618        const char *pattern;
 619        each_ref_fn *fn;
 620        void *cb_data;
 621};
 622
 623int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
 624{
 625        if (resolve_ref(refname, sha1, reading, flags))
 626                return 0;
 627        return -1;
 628}
 629
 630int read_ref(const char *refname, unsigned char *sha1)
 631{
 632        return read_ref_full(refname, sha1, 1, NULL);
 633}
 634
 635#define DO_FOR_EACH_INCLUDE_BROKEN 01
 636static int do_one_ref(const char *base, each_ref_fn fn, int trim,
 637                      int flags, void *cb_data, struct ref_entry *entry)
 638{
 639        if (prefixcmp(entry->name, base))
 640                return 0;
 641
 642        if (!(flags & DO_FOR_EACH_INCLUDE_BROKEN)) {
 643                if (entry->flag & REF_ISBROKEN)
 644                        return 0; /* ignore broken refs e.g. dangling symref */
 645                if (!has_sha1_file(entry->sha1)) {
 646                        error("%s does not point to a valid object!", entry->name);
 647                        return 0;
 648                }
 649        }
 650        current_ref = entry;
 651        return fn(entry->name + trim, entry->sha1, entry->flag, cb_data);
 652}
 653
 654static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
 655                       void *data)
 656{
 657        struct ref_filter *filter = (struct ref_filter *)data;
 658        if (fnmatch(filter->pattern, refname, 0))
 659                return 0;
 660        return filter->fn(refname, sha1, flags, filter->cb_data);
 661}
 662
 663int peel_ref(const char *refname, unsigned char *sha1)
 664{
 665        int flag;
 666        unsigned char base[20];
 667        struct object *o;
 668
 669        if (current_ref && (current_ref->name == refname
 670                || !strcmp(current_ref->name, refname))) {
 671                if (current_ref->flag & REF_KNOWS_PEELED) {
 672                        hashcpy(sha1, current_ref->peeled);
 673                        return 0;
 674                }
 675                hashcpy(base, current_ref->sha1);
 676                goto fallback;
 677        }
 678
 679        if (read_ref_full(refname, base, 1, &flag))
 680                return -1;
 681
 682        if ((flag & REF_ISPACKED)) {
 683                struct ref_array *array = get_packed_refs(get_ref_cache(NULL));
 684                struct ref_entry *r = search_ref_array(array, refname);
 685
 686                if (r != NULL && r->flag & REF_KNOWS_PEELED) {
 687                        hashcpy(sha1, r->peeled);
 688                        return 0;
 689                }
 690        }
 691
 692fallback:
 693        o = parse_object(base);
 694        if (o && o->type == OBJ_TAG) {
 695                o = deref_tag(o, refname, 0);
 696                if (o) {
 697                        hashcpy(sha1, o->sha1);
 698                        return 0;
 699                }
 700        }
 701        return -1;
 702}
 703
 704static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
 705                           int trim, int flags, void *cb_data)
 706{
 707        int retval = 0, i, p = 0, l = 0;
 708        struct ref_cache *refs = get_ref_cache(submodule);
 709        struct ref_array *packed = get_packed_refs(refs);
 710        struct ref_array *loose = get_loose_refs(refs);
 711
 712        struct ref_array *extra = &extra_refs;
 713
 714        for (i = 0; i < extra->nr; i++)
 715                retval = do_one_ref(base, fn, trim, flags, cb_data, extra->refs[i]);
 716
 717        while (p < packed->nr && l < loose->nr) {
 718                struct ref_entry *entry;
 719                int cmp = strcmp(packed->refs[p]->name, loose->refs[l]->name);
 720                if (!cmp) {
 721                        p++;
 722                        continue;
 723                }
 724                if (cmp > 0) {
 725                        entry = loose->refs[l++];
 726                } else {
 727                        entry = packed->refs[p++];
 728                }
 729                retval = do_one_ref(base, fn, trim, flags, cb_data, entry);
 730                if (retval)
 731                        goto end_each;
 732        }
 733
 734        if (l < loose->nr) {
 735                p = l;
 736                packed = loose;
 737        }
 738
 739        for (; p < packed->nr; p++) {
 740                retval = do_one_ref(base, fn, trim, flags, cb_data, packed->refs[p]);
 741                if (retval)
 742                        goto end_each;
 743        }
 744
 745end_each:
 746        current_ref = NULL;
 747        return retval;
 748}
 749
 750
 751static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
 752{
 753        unsigned char sha1[20];
 754        int flag;
 755
 756        if (submodule) {
 757                if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
 758                        return fn("HEAD", sha1, 0, cb_data);
 759
 760                return 0;
 761        }
 762
 763        if (!read_ref_full("HEAD", sha1, 1, &flag))
 764                return fn("HEAD", sha1, flag, cb_data);
 765
 766        return 0;
 767}
 768
 769int head_ref(each_ref_fn fn, void *cb_data)
 770{
 771        return do_head_ref(NULL, fn, cb_data);
 772}
 773
 774int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 775{
 776        return do_head_ref(submodule, fn, cb_data);
 777}
 778
 779int for_each_ref(each_ref_fn fn, void *cb_data)
 780{
 781        return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
 782}
 783
 784int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 785{
 786        return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
 787}
 788
 789int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
 790{
 791        return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
 792}
 793
 794int for_each_ref_in_submodule(const char *submodule, const char *prefix,
 795                each_ref_fn fn, void *cb_data)
 796{
 797        return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
 798}
 799
 800int for_each_tag_ref(each_ref_fn fn, void *cb_data)
 801{
 802        return for_each_ref_in("refs/tags/", fn, cb_data);
 803}
 804
 805int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 806{
 807        return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
 808}
 809
 810int for_each_branch_ref(each_ref_fn fn, void *cb_data)
 811{
 812        return for_each_ref_in("refs/heads/", fn, cb_data);
 813}
 814
 815int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 816{
 817        return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
 818}
 819
 820int for_each_remote_ref(each_ref_fn fn, void *cb_data)
 821{
 822        return for_each_ref_in("refs/remotes/", fn, cb_data);
 823}
 824
 825int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
 826{
 827        return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
 828}
 829
 830int for_each_replace_ref(each_ref_fn fn, void *cb_data)
 831{
 832        return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
 833}
 834
 835int head_ref_namespaced(each_ref_fn fn, void *cb_data)
 836{
 837        struct strbuf buf = STRBUF_INIT;
 838        int ret = 0;
 839        unsigned char sha1[20];
 840        int flag;
 841
 842        strbuf_addf(&buf, "%sHEAD", get_git_namespace());
 843        if (!read_ref_full(buf.buf, sha1, 1, &flag))
 844                ret = fn(buf.buf, sha1, flag, cb_data);
 845        strbuf_release(&buf);
 846
 847        return ret;
 848}
 849
 850int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
 851{
 852        struct strbuf buf = STRBUF_INIT;
 853        int ret;
 854        strbuf_addf(&buf, "%srefs/", get_git_namespace());
 855        ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
 856        strbuf_release(&buf);
 857        return ret;
 858}
 859
 860int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
 861        const char *prefix, void *cb_data)
 862{
 863        struct strbuf real_pattern = STRBUF_INIT;
 864        struct ref_filter filter;
 865        int ret;
 866
 867        if (!prefix && prefixcmp(pattern, "refs/"))
 868                strbuf_addstr(&real_pattern, "refs/");
 869        else if (prefix)
 870                strbuf_addstr(&real_pattern, prefix);
 871        strbuf_addstr(&real_pattern, pattern);
 872
 873        if (!has_glob_specials(pattern)) {
 874                /* Append implied '/' '*' if not present. */
 875                if (real_pattern.buf[real_pattern.len - 1] != '/')
 876                        strbuf_addch(&real_pattern, '/');
 877                /* No need to check for '*', there is none. */
 878                strbuf_addch(&real_pattern, '*');
 879        }
 880
 881        filter.pattern = real_pattern.buf;
 882        filter.fn = fn;
 883        filter.cb_data = cb_data;
 884        ret = for_each_ref(filter_refs, &filter);
 885
 886        strbuf_release(&real_pattern);
 887        return ret;
 888}
 889
 890int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
 891{
 892        return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
 893}
 894
 895int for_each_rawref(each_ref_fn fn, void *cb_data)
 896{
 897        return do_for_each_ref(NULL, "", fn, 0,
 898                               DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
 899}
 900
 901/*
 902 * Make sure "ref" is something reasonable to have under ".git/refs/";
 903 * We do not like it if:
 904 *
 905 * - any path component of it begins with ".", or
 906 * - it has double dots "..", or
 907 * - it has ASCII control character, "~", "^", ":" or SP, anywhere, or
 908 * - it ends with a "/".
 909 * - it ends with ".lock"
 910 * - it contains a "\" (backslash)
 911 */
 912
 913/* Return true iff ch is not allowed in reference names. */
 914static inline int bad_ref_char(int ch)
 915{
 916        if (((unsigned) ch) <= ' ' || ch == 0x7f ||
 917            ch == '~' || ch == '^' || ch == ':' || ch == '\\')
 918                return 1;
 919        /* 2.13 Pattern Matching Notation */
 920        if (ch == '*' || ch == '?' || ch == '[') /* Unsupported */
 921                return 1;
 922        return 0;
 923}
 924
 925/*
 926 * Try to read one refname component from the front of refname.  Return
 927 * the length of the component found, or -1 if the component is not
 928 * legal.
 929 */
 930static int check_refname_component(const char *refname, int flags)
 931{
 932        const char *cp;
 933        char last = '\0';
 934
 935        for (cp = refname; ; cp++) {
 936                char ch = *cp;
 937                if (ch == '\0' || ch == '/')
 938                        break;
 939                if (bad_ref_char(ch))
 940                        return -1; /* Illegal character in refname. */
 941                if (last == '.' && ch == '.')
 942                        return -1; /* Refname contains "..". */
 943                if (last == '@' && ch == '{')
 944                        return -1; /* Refname contains "@{". */
 945                last = ch;
 946        }
 947        if (cp == refname)
 948                return -1; /* Component has zero length. */
 949        if (refname[0] == '.') {
 950                if (!(flags & REFNAME_DOT_COMPONENT))
 951                        return -1; /* Component starts with '.'. */
 952                /*
 953                 * Even if leading dots are allowed, don't allow "."
 954                 * as a component (".." is prevented by a rule above).
 955                 */
 956                if (refname[1] == '\0')
 957                        return -1; /* Component equals ".". */
 958        }
 959        if (cp - refname >= 5 && !memcmp(cp - 5, ".lock", 5))
 960                return -1; /* Refname ends with ".lock". */
 961        return cp - refname;
 962}
 963
 964int check_refname_format(const char *refname, int flags)
 965{
 966        int component_len, component_count = 0;
 967
 968        while (1) {
 969                /* We are at the start of a path component. */
 970                component_len = check_refname_component(refname, flags);
 971                if (component_len < 0) {
 972                        if ((flags & REFNAME_REFSPEC_PATTERN) &&
 973                                        refname[0] == '*' &&
 974                                        (refname[1] == '\0' || refname[1] == '/')) {
 975                                /* Accept one wildcard as a full refname component. */
 976                                flags &= ~REFNAME_REFSPEC_PATTERN;
 977                                component_len = 1;
 978                        } else {
 979                                return -1;
 980                        }
 981                }
 982                component_count++;
 983                if (refname[component_len] == '\0')
 984                        break;
 985                /* Skip to next component. */
 986                refname += component_len + 1;
 987        }
 988
 989        if (refname[component_len - 1] == '.')
 990                return -1; /* Refname ends with '.'. */
 991        if (!(flags & REFNAME_ALLOW_ONELEVEL) && component_count < 2)
 992                return -1; /* Refname has only one component. */
 993        return 0;
 994}
 995
 996const char *prettify_refname(const char *name)
 997{
 998        return name + (
 999                !prefixcmp(name, "refs/heads/") ? 11 :
1000                !prefixcmp(name, "refs/tags/") ? 10 :
1001                !prefixcmp(name, "refs/remotes/") ? 13 :
1002                0);
1003}
1004
1005const char *ref_rev_parse_rules[] = {
1006        "%.*s",
1007        "refs/%.*s",
1008        "refs/tags/%.*s",
1009        "refs/heads/%.*s",
1010        "refs/remotes/%.*s",
1011        "refs/remotes/%.*s/HEAD",
1012        NULL
1013};
1014
1015int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
1016{
1017        const char **p;
1018        const int abbrev_name_len = strlen(abbrev_name);
1019
1020        for (p = rules; *p; p++) {
1021                if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1022                        return 1;
1023                }
1024        }
1025
1026        return 0;
1027}
1028
1029static struct ref_lock *verify_lock(struct ref_lock *lock,
1030        const unsigned char *old_sha1, int mustexist)
1031{
1032        if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1033                error("Can't verify ref %s", lock->ref_name);
1034                unlock_ref(lock);
1035                return NULL;
1036        }
1037        if (hashcmp(lock->old_sha1, old_sha1)) {
1038                error("Ref %s is at %s but expected %s", lock->ref_name,
1039                        sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1040                unlock_ref(lock);
1041                return NULL;
1042        }
1043        return lock;
1044}
1045
1046static int remove_empty_directories(const char *file)
1047{
1048        /* we want to create a file but there is a directory there;
1049         * if that is an empty directory (or a directory that contains
1050         * only empty directories), remove them.
1051         */
1052        struct strbuf path;
1053        int result;
1054
1055        strbuf_init(&path, 20);
1056        strbuf_addstr(&path, file);
1057
1058        result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1059
1060        strbuf_release(&path);
1061
1062        return result;
1063}
1064
1065/*
1066 * Return true iff a reference named refname could be created without
1067 * conflicting with the name of an existing reference.  If oldrefname
1068 * is non-NULL, ignore potential conflicts with oldrefname (e.g.,
1069 * because oldrefname is scheduled for deletion in the same
1070 * operation).
1071 */
1072static int is_refname_available(const char *refname, const char *oldrefname,
1073                                struct ref_array *array)
1074{
1075        int i, namlen = strlen(refname); /* e.g. 'foo/bar' */
1076        for (i = 0; i < array->nr; i++ ) {
1077                struct ref_entry *entry = array->refs[i];
1078                /* entry->name could be 'foo' or 'foo/bar/baz' */
1079                if (!oldrefname || strcmp(oldrefname, entry->name)) {
1080                        int len = strlen(entry->name);
1081                        int cmplen = (namlen < len) ? namlen : len;
1082                        const char *lead = (namlen < len) ? entry->name : refname;
1083                        if (!strncmp(refname, entry->name, cmplen) &&
1084                            lead[cmplen] == '/') {
1085                                error("'%s' exists; cannot create '%s'",
1086                                      entry->name, refname);
1087                                return 0;
1088                        }
1089                }
1090        }
1091        return 1;
1092}
1093
1094/*
1095 * *string and *len will only be substituted, and *string returned (for
1096 * later free()ing) if the string passed in is a magic short-hand form
1097 * to name a branch.
1098 */
1099static char *substitute_branch_name(const char **string, int *len)
1100{
1101        struct strbuf buf = STRBUF_INIT;
1102        int ret = interpret_branch_name(*string, &buf);
1103
1104        if (ret == *len) {
1105                size_t size;
1106                *string = strbuf_detach(&buf, &size);
1107                *len = size;
1108                return (char *)*string;
1109        }
1110
1111        return NULL;
1112}
1113
1114int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1115{
1116        char *last_branch = substitute_branch_name(&str, &len);
1117        const char **p, *r;
1118        int refs_found = 0;
1119
1120        *ref = NULL;
1121        for (p = ref_rev_parse_rules; *p; p++) {
1122                char fullref[PATH_MAX];
1123                unsigned char sha1_from_ref[20];
1124                unsigned char *this_result;
1125                int flag;
1126
1127                this_result = refs_found ? sha1_from_ref : sha1;
1128                mksnpath(fullref, sizeof(fullref), *p, len, str);
1129                r = resolve_ref(fullref, this_result, 1, &flag);
1130                if (r) {
1131                        if (!refs_found++)
1132                                *ref = xstrdup(r);
1133                        if (!warn_ambiguous_refs)
1134                                break;
1135                } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1136                        warning("ignoring dangling symref %s.", fullref);
1137                } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
1138                        warning("ignoring broken ref %s.", fullref);
1139                }
1140        }
1141        free(last_branch);
1142        return refs_found;
1143}
1144
1145int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
1146{
1147        char *last_branch = substitute_branch_name(&str, &len);
1148        const char **p;
1149        int logs_found = 0;
1150
1151        *log = NULL;
1152        for (p = ref_rev_parse_rules; *p; p++) {
1153                struct stat st;
1154                unsigned char hash[20];
1155                char path[PATH_MAX];
1156                const char *ref, *it;
1157
1158                mksnpath(path, sizeof(path), *p, len, str);
1159                ref = resolve_ref(path, hash, 1, NULL);
1160                if (!ref)
1161                        continue;
1162                if (!stat(git_path("logs/%s", path), &st) &&
1163                    S_ISREG(st.st_mode))
1164                        it = path;
1165                else if (strcmp(ref, path) &&
1166                         !stat(git_path("logs/%s", ref), &st) &&
1167                         S_ISREG(st.st_mode))
1168                        it = ref;
1169                else
1170                        continue;
1171                if (!logs_found++) {
1172                        *log = xstrdup(it);
1173                        hashcpy(sha1, hash);
1174                }
1175                if (!warn_ambiguous_refs)
1176                        break;
1177        }
1178        free(last_branch);
1179        return logs_found;
1180}
1181
1182static struct ref_lock *lock_ref_sha1_basic(const char *refname,
1183                                            const unsigned char *old_sha1,
1184                                            int flags, int *type_p)
1185{
1186        char *ref_file;
1187        const char *orig_refname = refname;
1188        struct ref_lock *lock;
1189        int last_errno = 0;
1190        int type, lflags;
1191        int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1192        int missing = 0;
1193
1194        lock = xcalloc(1, sizeof(struct ref_lock));
1195        lock->lock_fd = -1;
1196
1197        refname = resolve_ref(refname, lock->old_sha1, mustexist, &type);
1198        if (!refname && errno == EISDIR) {
1199                /* we are trying to lock foo but we used to
1200                 * have foo/bar which now does not exist;
1201                 * it is normal for the empty directory 'foo'
1202                 * to remain.
1203                 */
1204                ref_file = git_path("%s", orig_refname);
1205                if (remove_empty_directories(ref_file)) {
1206                        last_errno = errno;
1207                        error("there are still refs under '%s'", orig_refname);
1208                        goto error_return;
1209                }
1210                refname = resolve_ref(orig_refname, lock->old_sha1, mustexist, &type);
1211        }
1212        if (type_p)
1213            *type_p = type;
1214        if (!refname) {
1215                last_errno = errno;
1216                error("unable to resolve reference %s: %s",
1217                        orig_refname, strerror(errno));
1218                goto error_return;
1219        }
1220        missing = is_null_sha1(lock->old_sha1);
1221        /* When the ref did not exist and we are creating it,
1222         * make sure there is no existing ref that is packed
1223         * whose name begins with our refname, nor a ref whose
1224         * name is a proper prefix of our refname.
1225         */
1226        if (missing &&
1227             !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1228                last_errno = ENOTDIR;
1229                goto error_return;
1230        }
1231
1232        lock->lk = xcalloc(1, sizeof(struct lock_file));
1233
1234        lflags = LOCK_DIE_ON_ERROR;
1235        if (flags & REF_NODEREF) {
1236                refname = orig_refname;
1237                lflags |= LOCK_NODEREF;
1238        }
1239        lock->ref_name = xstrdup(refname);
1240        lock->orig_ref_name = xstrdup(orig_refname);
1241        ref_file = git_path("%s", refname);
1242        if (missing)
1243                lock->force_write = 1;
1244        if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1245                lock->force_write = 1;
1246
1247        if (safe_create_leading_directories(ref_file)) {
1248                last_errno = errno;
1249                error("unable to create directory for %s", ref_file);
1250                goto error_return;
1251        }
1252
1253        lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1254        return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1255
1256 error_return:
1257        unlock_ref(lock);
1258        errno = last_errno;
1259        return NULL;
1260}
1261
1262struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
1263{
1264        char refpath[PATH_MAX];
1265        if (check_refname_format(refname, 0))
1266                return NULL;
1267        strcpy(refpath, mkpath("refs/%s", refname));
1268        return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1269}
1270
1271struct ref_lock *lock_any_ref_for_update(const char *refname,
1272                                         const unsigned char *old_sha1, int flags)
1273{
1274        if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1275                return NULL;
1276        return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
1277}
1278
1279static struct lock_file packlock;
1280
1281static int repack_without_ref(const char *refname)
1282{
1283        struct ref_array *packed;
1284        int fd, i;
1285
1286        packed = get_packed_refs(get_ref_cache(NULL));
1287        if (search_ref_array(packed, refname) == NULL)
1288                return 0;
1289        fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1290        if (fd < 0) {
1291                unable_to_lock_error(git_path("packed-refs"), errno);
1292                return error("cannot delete '%s' from packed refs", refname);
1293        }
1294
1295        for (i = 0; i < packed->nr; i++) {
1296                char line[PATH_MAX + 100];
1297                int len;
1298                struct ref_entry *ref = packed->refs[i];
1299
1300                if (!strcmp(refname, ref->name))
1301                        continue;
1302                len = snprintf(line, sizeof(line), "%s %s\n",
1303                               sha1_to_hex(ref->sha1), ref->name);
1304                /* this should not happen but just being defensive */
1305                if (len > sizeof(line))
1306                        die("too long a refname '%s'", ref->name);
1307                write_or_die(fd, line, len);
1308        }
1309        return commit_lock_file(&packlock);
1310}
1311
1312int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1313{
1314        struct ref_lock *lock;
1315        int err, i = 0, ret = 0, flag = 0;
1316
1317        lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1318        if (!lock)
1319                return 1;
1320        if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1321                /* loose */
1322                const char *path;
1323
1324                if (!(delopt & REF_NODEREF)) {
1325                        i = strlen(lock->lk->filename) - 5; /* .lock */
1326                        lock->lk->filename[i] = 0;
1327                        path = lock->lk->filename;
1328                } else {
1329                        path = git_path("%s", refname);
1330                }
1331                err = unlink_or_warn(path);
1332                if (err && errno != ENOENT)
1333                        ret = 1;
1334
1335                if (!(delopt & REF_NODEREF))
1336                        lock->lk->filename[i] = '.';
1337        }
1338        /* removing the loose one could have resurrected an earlier
1339         * packed one.  Also, if it was not loose we need to repack
1340         * without it.
1341         */
1342        ret |= repack_without_ref(refname);
1343
1344        unlink_or_warn(git_path("logs/%s", lock->ref_name));
1345        invalidate_ref_cache(NULL);
1346        unlock_ref(lock);
1347        return ret;
1348}
1349
1350/*
1351 * People using contrib's git-new-workdir have .git/logs/refs ->
1352 * /some/other/path/.git/logs/refs, and that may live on another device.
1353 *
1354 * IOW, to avoid cross device rename errors, the temporary renamed log must
1355 * live into logs/refs.
1356 */
1357#define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
1358
1359int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1360{
1361        unsigned char sha1[20], orig_sha1[20];
1362        int flag = 0, logmoved = 0;
1363        struct ref_lock *lock;
1364        struct stat loginfo;
1365        int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
1366        const char *symref = NULL;
1367        struct ref_cache *refs = get_ref_cache(NULL);
1368
1369        if (log && S_ISLNK(loginfo.st_mode))
1370                return error("reflog for %s is a symlink", oldrefname);
1371
1372        symref = resolve_ref(oldrefname, orig_sha1, 1, &flag);
1373        if (flag & REF_ISSYMREF)
1374                return error("refname %s is a symbolic ref, renaming it is not supported",
1375                        oldrefname);
1376        if (!symref)
1377                return error("refname %s not found", oldrefname);
1378
1379        if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1380                return 1;
1381
1382        if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1383                return 1;
1384
1385        if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1386                return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1387                        oldrefname, strerror(errno));
1388
1389        if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
1390                error("unable to delete old %s", oldrefname);
1391                goto rollback;
1392        }
1393
1394        if (!read_ref_full(newrefname, sha1, 1, &flag) &&
1395            delete_ref(newrefname, sha1, REF_NODEREF)) {
1396                if (errno==EISDIR) {
1397                        if (remove_empty_directories(git_path("%s", newrefname))) {
1398                                error("Directory not empty: %s", newrefname);
1399                                goto rollback;
1400                        }
1401                } else {
1402                        error("unable to delete existing %s", newrefname);
1403                        goto rollback;
1404                }
1405        }
1406
1407        if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
1408                error("unable to create directory for %s", newrefname);
1409                goto rollback;
1410        }
1411
1412 retry:
1413        if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1414                if (errno==EISDIR || errno==ENOTDIR) {
1415                        /*
1416                         * rename(a, b) when b is an existing
1417                         * directory ought to result in ISDIR, but
1418                         * Solaris 5.8 gives ENOTDIR.  Sheesh.
1419                         */
1420                        if (remove_empty_directories(git_path("logs/%s", newrefname))) {
1421                                error("Directory not empty: logs/%s", newrefname);
1422                                goto rollback;
1423                        }
1424                        goto retry;
1425                } else {
1426                        error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1427                                newrefname, strerror(errno));
1428                        goto rollback;
1429                }
1430        }
1431        logmoved = log;
1432
1433        lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1434        if (!lock) {
1435                error("unable to lock %s for update", newrefname);
1436                goto rollback;
1437        }
1438        lock->force_write = 1;
1439        hashcpy(lock->old_sha1, orig_sha1);
1440        if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1441                error("unable to write current sha1 into %s", newrefname);
1442                goto rollback;
1443        }
1444
1445        return 0;
1446
1447 rollback:
1448        lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1449        if (!lock) {
1450                error("unable to lock %s for rollback", oldrefname);
1451                goto rollbacklog;
1452        }
1453
1454        lock->force_write = 1;
1455        flag = log_all_ref_updates;
1456        log_all_ref_updates = 0;
1457        if (write_ref_sha1(lock, orig_sha1, NULL))
1458                error("unable to write current sha1 into %s", oldrefname);
1459        log_all_ref_updates = flag;
1460
1461 rollbacklog:
1462        if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1463                error("unable to restore logfile %s from %s: %s",
1464                        oldrefname, newrefname, strerror(errno));
1465        if (!logmoved && log &&
1466            rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1467                error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1468                        oldrefname, strerror(errno));
1469
1470        return 1;
1471}
1472
1473int close_ref(struct ref_lock *lock)
1474{
1475        if (close_lock_file(lock->lk))
1476                return -1;
1477        lock->lock_fd = -1;
1478        return 0;
1479}
1480
1481int commit_ref(struct ref_lock *lock)
1482{
1483        if (commit_lock_file(lock->lk))
1484                return -1;
1485        lock->lock_fd = -1;
1486        return 0;
1487}
1488
1489void unlock_ref(struct ref_lock *lock)
1490{
1491        /* Do not free lock->lk -- atexit() still looks at them */
1492        if (lock->lk)
1493                rollback_lock_file(lock->lk);
1494        free(lock->ref_name);
1495        free(lock->orig_ref_name);
1496        free(lock);
1497}
1498
1499/*
1500 * copy the reflog message msg to buf, which has been allocated sufficiently
1501 * large, while cleaning up the whitespaces.  Especially, convert LF to space,
1502 * because reflog file is one line per entry.
1503 */
1504static int copy_msg(char *buf, const char *msg)
1505{
1506        char *cp = buf;
1507        char c;
1508        int wasspace = 1;
1509
1510        *cp++ = '\t';
1511        while ((c = *msg++)) {
1512                if (wasspace && isspace(c))
1513                        continue;
1514                wasspace = isspace(c);
1515                if (wasspace)
1516                        c = ' ';
1517                *cp++ = c;
1518        }
1519        while (buf < cp && isspace(cp[-1]))
1520                cp--;
1521        *cp++ = '\n';
1522        return cp - buf;
1523}
1524
1525int log_ref_setup(const char *refname, char *logfile, int bufsize)
1526{
1527        int logfd, oflags = O_APPEND | O_WRONLY;
1528
1529        git_snpath(logfile, bufsize, "logs/%s", refname);
1530        if (log_all_ref_updates &&
1531            (!prefixcmp(refname, "refs/heads/") ||
1532             !prefixcmp(refname, "refs/remotes/") ||
1533             !prefixcmp(refname, "refs/notes/") ||
1534             !strcmp(refname, "HEAD"))) {
1535                if (safe_create_leading_directories(logfile) < 0)
1536                        return error("unable to create directory for %s",
1537                                     logfile);
1538                oflags |= O_CREAT;
1539        }
1540
1541        logfd = open(logfile, oflags, 0666);
1542        if (logfd < 0) {
1543                if (!(oflags & O_CREAT) && errno == ENOENT)
1544                        return 0;
1545
1546                if ((oflags & O_CREAT) && errno == EISDIR) {
1547                        if (remove_empty_directories(logfile)) {
1548                                return error("There are still logs under '%s'",
1549                                             logfile);
1550                        }
1551                        logfd = open(logfile, oflags, 0666);
1552                }
1553
1554                if (logfd < 0)
1555                        return error("Unable to append to %s: %s",
1556                                     logfile, strerror(errno));
1557        }
1558
1559        adjust_shared_perm(logfile);
1560        close(logfd);
1561        return 0;
1562}
1563
1564static int log_ref_write(const char *refname, const unsigned char *old_sha1,
1565                         const unsigned char *new_sha1, const char *msg)
1566{
1567        int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1568        unsigned maxlen, len;
1569        int msglen;
1570        char log_file[PATH_MAX];
1571        char *logrec;
1572        const char *committer;
1573
1574        if (log_all_ref_updates < 0)
1575                log_all_ref_updates = !is_bare_repository();
1576
1577        result = log_ref_setup(refname, log_file, sizeof(log_file));
1578        if (result)
1579                return result;
1580
1581        logfd = open(log_file, oflags);
1582        if (logfd < 0)
1583                return 0;
1584        msglen = msg ? strlen(msg) : 0;
1585        committer = git_committer_info(0);
1586        maxlen = strlen(committer) + msglen + 100;
1587        logrec = xmalloc(maxlen);
1588        len = sprintf(logrec, "%s %s %s\n",
1589                      sha1_to_hex(old_sha1),
1590                      sha1_to_hex(new_sha1),
1591                      committer);
1592        if (msglen)
1593                len += copy_msg(logrec + len - 1, msg) - 1;
1594        written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1595        free(logrec);
1596        if (close(logfd) != 0 || written != len)
1597                return error("Unable to append to %s", log_file);
1598        return 0;
1599}
1600
1601static int is_branch(const char *refname)
1602{
1603        return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1604}
1605
1606int write_ref_sha1(struct ref_lock *lock,
1607        const unsigned char *sha1, const char *logmsg)
1608{
1609        static char term = '\n';
1610        struct object *o;
1611
1612        if (!lock)
1613                return -1;
1614        if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1615                unlock_ref(lock);
1616                return 0;
1617        }
1618        o = parse_object(sha1);
1619        if (!o) {
1620                error("Trying to write ref %s with nonexistent object %s",
1621                        lock->ref_name, sha1_to_hex(sha1));
1622                unlock_ref(lock);
1623                return -1;
1624        }
1625        if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1626                error("Trying to write non-commit object %s to branch %s",
1627                        sha1_to_hex(sha1), lock->ref_name);
1628                unlock_ref(lock);
1629                return -1;
1630        }
1631        if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1632            write_in_full(lock->lock_fd, &term, 1) != 1
1633                || close_ref(lock) < 0) {
1634                error("Couldn't write %s", lock->lk->filename);
1635                unlock_ref(lock);
1636                return -1;
1637        }
1638        clear_loose_ref_cache(get_ref_cache(NULL));
1639        if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1640            (strcmp(lock->ref_name, lock->orig_ref_name) &&
1641             log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1642                unlock_ref(lock);
1643                return -1;
1644        }
1645        if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1646                /*
1647                 * Special hack: If a branch is updated directly and HEAD
1648                 * points to it (may happen on the remote side of a push
1649                 * for example) then logically the HEAD reflog should be
1650                 * updated too.
1651                 * A generic solution implies reverse symref information,
1652                 * but finding all symrefs pointing to the given branch
1653                 * would be rather costly for this rare event (the direct
1654                 * update of a branch) to be worth it.  So let's cheat and
1655                 * check with HEAD only which should cover 99% of all usage
1656                 * scenarios (even 100% of the default ones).
1657                 */
1658                unsigned char head_sha1[20];
1659                int head_flag;
1660                const char *head_ref;
1661                head_ref = resolve_ref("HEAD", head_sha1, 1, &head_flag);
1662                if (head_ref && (head_flag & REF_ISSYMREF) &&
1663                    !strcmp(head_ref, lock->ref_name))
1664                        log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1665        }
1666        if (commit_ref(lock)) {
1667                error("Couldn't set %s", lock->ref_name);
1668                unlock_ref(lock);
1669                return -1;
1670        }
1671        unlock_ref(lock);
1672        return 0;
1673}
1674
1675int create_symref(const char *ref_target, const char *refs_heads_master,
1676                  const char *logmsg)
1677{
1678        const char *lockpath;
1679        char ref[1000];
1680        int fd, len, written;
1681        char *git_HEAD = git_pathdup("%s", ref_target);
1682        unsigned char old_sha1[20], new_sha1[20];
1683
1684        if (logmsg && read_ref(ref_target, old_sha1))
1685                hashclr(old_sha1);
1686
1687        if (safe_create_leading_directories(git_HEAD) < 0)
1688                return error("unable to create directory for %s", git_HEAD);
1689
1690#ifndef NO_SYMLINK_HEAD
1691        if (prefer_symlink_refs) {
1692                unlink(git_HEAD);
1693                if (!symlink(refs_heads_master, git_HEAD))
1694                        goto done;
1695                fprintf(stderr, "no symlink - falling back to symbolic ref\n");
1696        }
1697#endif
1698
1699        len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
1700        if (sizeof(ref) <= len) {
1701                error("refname too long: %s", refs_heads_master);
1702                goto error_free_return;
1703        }
1704        lockpath = mkpath("%s.lock", git_HEAD);
1705        fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
1706        if (fd < 0) {
1707                error("Unable to open %s for writing", lockpath);
1708                goto error_free_return;
1709        }
1710        written = write_in_full(fd, ref, len);
1711        if (close(fd) != 0 || written != len) {
1712                error("Unable to write to %s", lockpath);
1713                goto error_unlink_return;
1714        }
1715        if (rename(lockpath, git_HEAD) < 0) {
1716                error("Unable to create %s", git_HEAD);
1717                goto error_unlink_return;
1718        }
1719        if (adjust_shared_perm(git_HEAD)) {
1720                error("Unable to fix permissions on %s", lockpath);
1721        error_unlink_return:
1722                unlink_or_warn(lockpath);
1723        error_free_return:
1724                free(git_HEAD);
1725                return -1;
1726        }
1727
1728#ifndef NO_SYMLINK_HEAD
1729        done:
1730#endif
1731        if (logmsg && !read_ref(refs_heads_master, new_sha1))
1732                log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
1733
1734        free(git_HEAD);
1735        return 0;
1736}
1737
1738static char *ref_msg(const char *line, const char *endp)
1739{
1740        const char *ep;
1741        line += 82;
1742        ep = memchr(line, '\n', endp - line);
1743        if (!ep)
1744                ep = endp;
1745        return xmemdupz(line, ep - line);
1746}
1747
1748int read_ref_at(const char *refname, unsigned long at_time, int cnt,
1749                unsigned char *sha1, char **msg,
1750                unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
1751{
1752        const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
1753        char *tz_c;
1754        int logfd, tz, reccnt = 0;
1755        struct stat st;
1756        unsigned long date;
1757        unsigned char logged_sha1[20];
1758        void *log_mapped;
1759        size_t mapsz;
1760
1761        logfile = git_path("logs/%s", refname);
1762        logfd = open(logfile, O_RDONLY, 0);
1763        if (logfd < 0)
1764                die_errno("Unable to read log '%s'", logfile);
1765        fstat(logfd, &st);
1766        if (!st.st_size)
1767                die("Log %s is empty.", logfile);
1768        mapsz = xsize_t(st.st_size);
1769        log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
1770        logdata = log_mapped;
1771        close(logfd);
1772
1773        lastrec = NULL;
1774        rec = logend = logdata + st.st_size;
1775        while (logdata < rec) {
1776                reccnt++;
1777                if (logdata < rec && *(rec-1) == '\n')
1778                        rec--;
1779                lastgt = NULL;
1780                while (logdata < rec && *(rec-1) != '\n') {
1781                        rec--;
1782                        if (*rec == '>')
1783                                lastgt = rec;
1784                }
1785                if (!lastgt)
1786                        die("Log %s is corrupt.", logfile);
1787                date = strtoul(lastgt + 1, &tz_c, 10);
1788                if (date <= at_time || cnt == 0) {
1789                        tz = strtoul(tz_c, NULL, 10);
1790                        if (msg)
1791                                *msg = ref_msg(rec, logend);
1792                        if (cutoff_time)
1793                                *cutoff_time = date;
1794                        if (cutoff_tz)
1795                                *cutoff_tz = tz;
1796                        if (cutoff_cnt)
1797                                *cutoff_cnt = reccnt - 1;
1798                        if (lastrec) {
1799                                if (get_sha1_hex(lastrec, logged_sha1))
1800                                        die("Log %s is corrupt.", logfile);
1801                                if (get_sha1_hex(rec + 41, sha1))
1802                                        die("Log %s is corrupt.", logfile);
1803                                if (hashcmp(logged_sha1, sha1)) {
1804                                        warning("Log %s has gap after %s.",
1805                                                logfile, show_date(date, tz, DATE_RFC2822));
1806                                }
1807                        }
1808                        else if (date == at_time) {
1809                                if (get_sha1_hex(rec + 41, sha1))
1810                                        die("Log %s is corrupt.", logfile);
1811                        }
1812                        else {
1813                                if (get_sha1_hex(rec + 41, logged_sha1))
1814                                        die("Log %s is corrupt.", logfile);
1815                                if (hashcmp(logged_sha1, sha1)) {
1816                                        warning("Log %s unexpectedly ended on %s.",
1817                                                logfile, show_date(date, tz, DATE_RFC2822));
1818                                }
1819                        }
1820                        munmap(log_mapped, mapsz);
1821                        return 0;
1822                }
1823                lastrec = rec;
1824                if (cnt > 0)
1825                        cnt--;
1826        }
1827
1828        rec = logdata;
1829        while (rec < logend && *rec != '>' && *rec != '\n')
1830                rec++;
1831        if (rec == logend || *rec == '\n')
1832                die("Log %s is corrupt.", logfile);
1833        date = strtoul(rec + 1, &tz_c, 10);
1834        tz = strtoul(tz_c, NULL, 10);
1835        if (get_sha1_hex(logdata, sha1))
1836                die("Log %s is corrupt.", logfile);
1837        if (is_null_sha1(sha1)) {
1838                if (get_sha1_hex(logdata + 41, sha1))
1839                        die("Log %s is corrupt.", logfile);
1840        }
1841        if (msg)
1842                *msg = ref_msg(logdata, logend);
1843        munmap(log_mapped, mapsz);
1844
1845        if (cutoff_time)
1846                *cutoff_time = date;
1847        if (cutoff_tz)
1848                *cutoff_tz = tz;
1849        if (cutoff_cnt)
1850                *cutoff_cnt = reccnt;
1851        return 1;
1852}
1853
1854int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
1855{
1856        const char *logfile;
1857        FILE *logfp;
1858        struct strbuf sb = STRBUF_INIT;
1859        int ret = 0;
1860
1861        logfile = git_path("logs/%s", refname);
1862        logfp = fopen(logfile, "r");
1863        if (!logfp)
1864                return -1;
1865
1866        if (ofs) {
1867                struct stat statbuf;
1868                if (fstat(fileno(logfp), &statbuf) ||
1869                    statbuf.st_size < ofs ||
1870                    fseek(logfp, -ofs, SEEK_END) ||
1871                    strbuf_getwholeline(&sb, logfp, '\n')) {
1872                        fclose(logfp);
1873                        strbuf_release(&sb);
1874                        return -1;
1875                }
1876        }
1877
1878        while (!strbuf_getwholeline(&sb, logfp, '\n')) {
1879                unsigned char osha1[20], nsha1[20];
1880                char *email_end, *message;
1881                unsigned long timestamp;
1882                int tz;
1883
1884                /* old SP new SP name <email> SP time TAB msg LF */
1885                if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
1886                    get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
1887                    get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
1888                    !(email_end = strchr(sb.buf + 82, '>')) ||
1889                    email_end[1] != ' ' ||
1890                    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
1891                    !message || message[0] != ' ' ||
1892                    (message[1] != '+' && message[1] != '-') ||
1893                    !isdigit(message[2]) || !isdigit(message[3]) ||
1894                    !isdigit(message[4]) || !isdigit(message[5]))
1895                        continue; /* corrupt? */
1896                email_end[1] = '\0';
1897                tz = strtol(message + 1, NULL, 10);
1898                if (message[6] != '\t')
1899                        message += 6;
1900                else
1901                        message += 7;
1902                ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
1903                         cb_data);
1904                if (ret)
1905                        break;
1906        }
1907        fclose(logfp);
1908        strbuf_release(&sb);
1909        return ret;
1910}
1911
1912int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
1913{
1914        return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
1915}
1916
1917static int do_for_each_reflog(const char *base, each_ref_fn fn, void *cb_data)
1918{
1919        DIR *dir = opendir(git_path("logs/%s", base));
1920        int retval = 0;
1921
1922        if (dir) {
1923                struct dirent *de;
1924                int baselen = strlen(base);
1925                char *log = xmalloc(baselen + 257);
1926
1927                memcpy(log, base, baselen);
1928                if (baselen && base[baselen-1] != '/')
1929                        log[baselen++] = '/';
1930
1931                while ((de = readdir(dir)) != NULL) {
1932                        struct stat st;
1933                        int namelen;
1934
1935                        if (de->d_name[0] == '.')
1936                                continue;
1937                        namelen = strlen(de->d_name);
1938                        if (namelen > 255)
1939                                continue;
1940                        if (has_extension(de->d_name, ".lock"))
1941                                continue;
1942                        memcpy(log + baselen, de->d_name, namelen+1);
1943                        if (stat(git_path("logs/%s", log), &st) < 0)
1944                                continue;
1945                        if (S_ISDIR(st.st_mode)) {
1946                                retval = do_for_each_reflog(log, fn, cb_data);
1947                        } else {
1948                                unsigned char sha1[20];
1949                                if (read_ref_full(log, sha1, 0, NULL))
1950                                        retval = error("bad ref for %s", log);
1951                                else
1952                                        retval = fn(log, sha1, 0, cb_data);
1953                        }
1954                        if (retval)
1955                                break;
1956                }
1957                free(log);
1958                closedir(dir);
1959        }
1960        else if (*base)
1961                return errno;
1962        return retval;
1963}
1964
1965int for_each_reflog(each_ref_fn fn, void *cb_data)
1966{
1967        return do_for_each_reflog("", fn, cb_data);
1968}
1969
1970int update_ref(const char *action, const char *refname,
1971                const unsigned char *sha1, const unsigned char *oldval,
1972                int flags, enum action_on_err onerr)
1973{
1974        static struct ref_lock *lock;
1975        lock = lock_any_ref_for_update(refname, oldval, flags);
1976        if (!lock) {
1977                const char *str = "Cannot lock the ref '%s'.";
1978                switch (onerr) {
1979                case MSG_ON_ERR: error(str, refname); break;
1980                case DIE_ON_ERR: die(str, refname); break;
1981                case QUIET_ON_ERR: break;
1982                }
1983                return 1;
1984        }
1985        if (write_ref_sha1(lock, sha1, action) < 0) {
1986                const char *str = "Cannot update the ref '%s'.";
1987                switch (onerr) {
1988                case MSG_ON_ERR: error(str, refname); break;
1989                case DIE_ON_ERR: die(str, refname); break;
1990                case QUIET_ON_ERR: break;
1991                }
1992                return 1;
1993        }
1994        return 0;
1995}
1996
1997int ref_exists(const char *refname)
1998{
1999        unsigned char sha1[20];
2000        return !!resolve_ref(refname, sha1, 1, NULL);
2001}
2002
2003struct ref *find_ref_by_name(const struct ref *list, const char *name)
2004{
2005        for ( ; list; list = list->next)
2006                if (!strcmp(list->name, name))
2007                        return (struct ref *)list;
2008        return NULL;
2009}
2010
2011/*
2012 * generate a format suitable for scanf from a ref_rev_parse_rules
2013 * rule, that is replace the "%.*s" spec with a "%s" spec
2014 */
2015static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
2016{
2017        char *spec;
2018
2019        spec = strstr(rule, "%.*s");
2020        if (!spec || strstr(spec + 4, "%.*s"))
2021                die("invalid rule in ref_rev_parse_rules: %s", rule);
2022
2023        /* copy all until spec */
2024        strncpy(scanf_fmt, rule, spec - rule);
2025        scanf_fmt[spec - rule] = '\0';
2026        /* copy new spec */
2027        strcat(scanf_fmt, "%s");
2028        /* copy remaining rule */
2029        strcat(scanf_fmt, spec + 4);
2030
2031        return;
2032}
2033
2034char *shorten_unambiguous_ref(const char *refname, int strict)
2035{
2036        int i;
2037        static char **scanf_fmts;
2038        static int nr_rules;
2039        char *short_name;
2040
2041        /* pre generate scanf formats from ref_rev_parse_rules[] */
2042        if (!nr_rules) {
2043                size_t total_len = 0;
2044
2045                /* the rule list is NULL terminated, count them first */
2046                for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
2047                        /* no +1 because strlen("%s") < strlen("%.*s") */
2048                        total_len += strlen(ref_rev_parse_rules[nr_rules]);
2049
2050                scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
2051
2052                total_len = 0;
2053                for (i = 0; i < nr_rules; i++) {
2054                        scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
2055                                        + total_len;
2056                        gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
2057                        total_len += strlen(ref_rev_parse_rules[i]);
2058                }
2059        }
2060
2061        /* bail out if there are no rules */
2062        if (!nr_rules)
2063                return xstrdup(refname);
2064
2065        /* buffer for scanf result, at most refname must fit */
2066        short_name = xstrdup(refname);
2067
2068        /* skip first rule, it will always match */
2069        for (i = nr_rules - 1; i > 0 ; --i) {
2070                int j;
2071                int rules_to_fail = i;
2072                int short_name_len;
2073
2074                if (1 != sscanf(refname, scanf_fmts[i], short_name))
2075                        continue;
2076
2077                short_name_len = strlen(short_name);
2078
2079                /*
2080                 * in strict mode, all (except the matched one) rules
2081                 * must fail to resolve to a valid non-ambiguous ref
2082                 */
2083                if (strict)
2084                        rules_to_fail = nr_rules;
2085
2086                /*
2087                 * check if the short name resolves to a valid ref,
2088                 * but use only rules prior to the matched one
2089                 */
2090                for (j = 0; j < rules_to_fail; j++) {
2091                        const char *rule = ref_rev_parse_rules[j];
2092                        char refname[PATH_MAX];
2093
2094                        /* skip matched rule */
2095                        if (i == j)
2096                                continue;
2097
2098                        /*
2099                         * the short name is ambiguous, if it resolves
2100                         * (with this previous rule) to a valid ref
2101                         * read_ref() returns 0 on success
2102                         */
2103                        mksnpath(refname, sizeof(refname),
2104                                 rule, short_name_len, short_name);
2105                        if (ref_exists(refname))
2106                                break;
2107                }
2108
2109                /*
2110                 * short name is non-ambiguous if all previous rules
2111                 * haven't resolved to a valid ref
2112                 */
2113                if (j == rules_to_fail)
2114                        return short_name;
2115        }
2116
2117        free(short_name);
2118        return xstrdup(refname);
2119}