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