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