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