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