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