refs.con commit read_loose_refs(): rename function from get_ref_dir() (1900b97)
   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        struct ref_entry *loose;
 611        struct ref_entry *packed;
 612        /* The submodule name, or "" for the main repo. */
 613        char name[FLEX_ARRAY];
 614} *ref_cache;
 615
 616static void clear_packed_ref_cache(struct ref_cache *refs)
 617{
 618        if (refs->packed) {
 619                free_ref_entry(refs->packed);
 620                refs->packed = NULL;
 621        }
 622}
 623
 624static void clear_loose_ref_cache(struct ref_cache *refs)
 625{
 626        if (refs->loose) {
 627                free_ref_entry(refs->loose);
 628                refs->loose = NULL;
 629        }
 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->packed) {
 744                const char *packed_refs_file;
 745                FILE *f;
 746
 747                refs->packed = create_dir_entry("");
 748                if (*refs->name)
 749                        packed_refs_file = git_path_submodule(refs->name, "packed-refs");
 750                else
 751                        packed_refs_file = git_path("packed-refs");
 752                f = fopen(packed_refs_file, "r");
 753                if (f) {
 754                        read_packed_refs(f, &refs->packed->u.subdir);
 755                        fclose(f);
 756                }
 757        }
 758        return &refs->packed->u.subdir;
 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 read_loose_refs(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                        read_loose_refs(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->loose) {
 837                refs->loose = create_dir_entry("");
 838                read_loose_refs(refs, "refs/",
 839                                &search_for_subdir(&refs->loose->u.subdir,
 840                                                   "refs/", 1)->u.subdir);
 841        }
 842        return &refs->loose->u.subdir;
 843}
 844
 845/* We allow "recursive" symbolic refs. Only within reason, though */
 846#define MAXDEPTH 5
 847#define MAXREFLEN (1024)
 848
 849/*
 850 * Called by resolve_gitlink_ref_recursive() after it failed to read
 851 * from the loose refs in ref_cache refs. Find <refname> in the
 852 * packed-refs file for the submodule.
 853 */
 854static int resolve_gitlink_packed_ref(struct ref_cache *refs,
 855                                      const char *refname, unsigned char *sha1)
 856{
 857        struct ref_entry *ref;
 858        struct ref_dir *dir = get_packed_refs(refs);
 859
 860        ref = find_ref(dir, refname);
 861        if (ref == NULL)
 862                return -1;
 863
 864        memcpy(sha1, ref->u.value.sha1, 20);
 865        return 0;
 866}
 867
 868static int resolve_gitlink_ref_recursive(struct ref_cache *refs,
 869                                         const char *refname, unsigned char *sha1,
 870                                         int recursion)
 871{
 872        int fd, len;
 873        char buffer[128], *p;
 874        char *path;
 875
 876        if (recursion > MAXDEPTH || strlen(refname) > MAXREFLEN)
 877                return -1;
 878        path = *refs->name
 879                ? git_path_submodule(refs->name, "%s", refname)
 880                : git_path("%s", refname);
 881        fd = open(path, O_RDONLY);
 882        if (fd < 0)
 883                return resolve_gitlink_packed_ref(refs, refname, sha1);
 884
 885        len = read(fd, buffer, sizeof(buffer)-1);
 886        close(fd);
 887        if (len < 0)
 888                return -1;
 889        while (len && isspace(buffer[len-1]))
 890                len--;
 891        buffer[len] = 0;
 892
 893        /* Was it a detached head or an old-fashioned symlink? */
 894        if (!get_sha1_hex(buffer, sha1))
 895                return 0;
 896
 897        /* Symref? */
 898        if (strncmp(buffer, "ref:", 4))
 899                return -1;
 900        p = buffer + 4;
 901        while (isspace(*p))
 902                p++;
 903
 904        return resolve_gitlink_ref_recursive(refs, p, sha1, recursion+1);
 905}
 906
 907int resolve_gitlink_ref(const char *path, const char *refname, unsigned char *sha1)
 908{
 909        int len = strlen(path), retval;
 910        char *submodule;
 911        struct ref_cache *refs;
 912
 913        while (len && path[len-1] == '/')
 914                len--;
 915        if (!len)
 916                return -1;
 917        submodule = xstrndup(path, len);
 918        refs = get_ref_cache(submodule);
 919        free(submodule);
 920
 921        retval = resolve_gitlink_ref_recursive(refs, refname, sha1, 0);
 922        return retval;
 923}
 924
 925/*
 926 * Try to read ref from the packed references.  On success, set sha1
 927 * and return 0; otherwise, return -1.
 928 */
 929static int get_packed_ref(const char *refname, unsigned char *sha1)
 930{
 931        struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
 932        struct ref_entry *entry = find_ref(packed, refname);
 933        if (entry) {
 934                hashcpy(sha1, entry->u.value.sha1);
 935                return 0;
 936        }
 937        return -1;
 938}
 939
 940const char *resolve_ref_unsafe(const char *refname, unsigned char *sha1, int reading, int *flag)
 941{
 942        int depth = MAXDEPTH;
 943        ssize_t len;
 944        char buffer[256];
 945        static char refname_buffer[256];
 946
 947        if (flag)
 948                *flag = 0;
 949
 950        if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
 951                return NULL;
 952
 953        for (;;) {
 954                char path[PATH_MAX];
 955                struct stat st;
 956                char *buf;
 957                int fd;
 958
 959                if (--depth < 0)
 960                        return NULL;
 961
 962                git_snpath(path, sizeof(path), "%s", refname);
 963
 964                if (lstat(path, &st) < 0) {
 965                        if (errno != ENOENT)
 966                                return NULL;
 967                        /*
 968                         * The loose reference file does not exist;
 969                         * check for a packed reference.
 970                         */
 971                        if (!get_packed_ref(refname, sha1)) {
 972                                if (flag)
 973                                        *flag |= REF_ISPACKED;
 974                                return refname;
 975                        }
 976                        /* The reference is not a packed reference, either. */
 977                        if (reading) {
 978                                return NULL;
 979                        } else {
 980                                hashclr(sha1);
 981                                return refname;
 982                        }
 983                }
 984
 985                /* Follow "normalized" - ie "refs/.." symlinks by hand */
 986                if (S_ISLNK(st.st_mode)) {
 987                        len = readlink(path, buffer, sizeof(buffer)-1);
 988                        if (len < 0)
 989                                return NULL;
 990                        buffer[len] = 0;
 991                        if (!prefixcmp(buffer, "refs/") &&
 992                                        !check_refname_format(buffer, 0)) {
 993                                strcpy(refname_buffer, buffer);
 994                                refname = refname_buffer;
 995                                if (flag)
 996                                        *flag |= REF_ISSYMREF;
 997                                continue;
 998                        }
 999                }
1000
1001                /* Is it a directory? */
1002                if (S_ISDIR(st.st_mode)) {
1003                        errno = EISDIR;
1004                        return NULL;
1005                }
1006
1007                /*
1008                 * Anything else, just open it and try to use it as
1009                 * a ref
1010                 */
1011                fd = open(path, O_RDONLY);
1012                if (fd < 0)
1013                        return NULL;
1014                len = read_in_full(fd, buffer, sizeof(buffer)-1);
1015                close(fd);
1016                if (len < 0)
1017                        return NULL;
1018                while (len && isspace(buffer[len-1]))
1019                        len--;
1020                buffer[len] = '\0';
1021
1022                /*
1023                 * Is it a symbolic ref?
1024                 */
1025                if (prefixcmp(buffer, "ref:"))
1026                        break;
1027                if (flag)
1028                        *flag |= REF_ISSYMREF;
1029                buf = buffer + 4;
1030                while (isspace(*buf))
1031                        buf++;
1032                if (check_refname_format(buf, REFNAME_ALLOW_ONELEVEL)) {
1033                        if (flag)
1034                                *flag |= REF_ISBROKEN;
1035                        return NULL;
1036                }
1037                refname = strcpy(refname_buffer, buf);
1038        }
1039        /* Please note that FETCH_HEAD has a second line containing other data. */
1040        if (get_sha1_hex(buffer, sha1) || (buffer[40] != '\0' && !isspace(buffer[40]))) {
1041                if (flag)
1042                        *flag |= REF_ISBROKEN;
1043                return NULL;
1044        }
1045        return refname;
1046}
1047
1048char *resolve_refdup(const char *ref, unsigned char *sha1, int reading, int *flag)
1049{
1050        const char *ret = resolve_ref_unsafe(ref, sha1, reading, flag);
1051        return ret ? xstrdup(ret) : NULL;
1052}
1053
1054/* The argument to filter_refs */
1055struct ref_filter {
1056        const char *pattern;
1057        each_ref_fn *fn;
1058        void *cb_data;
1059};
1060
1061int read_ref_full(const char *refname, unsigned char *sha1, int reading, int *flags)
1062{
1063        if (resolve_ref_unsafe(refname, sha1, reading, flags))
1064                return 0;
1065        return -1;
1066}
1067
1068int read_ref(const char *refname, unsigned char *sha1)
1069{
1070        return read_ref_full(refname, sha1, 1, NULL);
1071}
1072
1073int ref_exists(const char *refname)
1074{
1075        unsigned char sha1[20];
1076        return !!resolve_ref_unsafe(refname, sha1, 1, NULL);
1077}
1078
1079static int filter_refs(const char *refname, const unsigned char *sha1, int flags,
1080                       void *data)
1081{
1082        struct ref_filter *filter = (struct ref_filter *)data;
1083        if (fnmatch(filter->pattern, refname, 0))
1084                return 0;
1085        return filter->fn(refname, sha1, flags, filter->cb_data);
1086}
1087
1088int peel_ref(const char *refname, unsigned char *sha1)
1089{
1090        int flag;
1091        unsigned char base[20];
1092        struct object *o;
1093
1094        if (current_ref && (current_ref->name == refname
1095                || !strcmp(current_ref->name, refname))) {
1096                if (current_ref->flag & REF_KNOWS_PEELED) {
1097                        hashcpy(sha1, current_ref->u.value.peeled);
1098                        return 0;
1099                }
1100                hashcpy(base, current_ref->u.value.sha1);
1101                goto fallback;
1102        }
1103
1104        if (read_ref_full(refname, base, 1, &flag))
1105                return -1;
1106
1107        if ((flag & REF_ISPACKED)) {
1108                struct ref_dir *dir = get_packed_refs(get_ref_cache(NULL));
1109                struct ref_entry *r = find_ref(dir, refname);
1110
1111                if (r != NULL && r->flag & REF_KNOWS_PEELED) {
1112                        hashcpy(sha1, r->u.value.peeled);
1113                        return 0;
1114                }
1115        }
1116
1117fallback:
1118        o = parse_object(base);
1119        if (o && o->type == OBJ_TAG) {
1120                o = deref_tag(o, refname, 0);
1121                if (o) {
1122                        hashcpy(sha1, o->sha1);
1123                        return 0;
1124                }
1125        }
1126        return -1;
1127}
1128
1129struct warn_if_dangling_data {
1130        FILE *fp;
1131        const char *refname;
1132        const char *msg_fmt;
1133};
1134
1135static int warn_if_dangling_symref(const char *refname, const unsigned char *sha1,
1136                                   int flags, void *cb_data)
1137{
1138        struct warn_if_dangling_data *d = cb_data;
1139        const char *resolves_to;
1140        unsigned char junk[20];
1141
1142        if (!(flags & REF_ISSYMREF))
1143                return 0;
1144
1145        resolves_to = resolve_ref_unsafe(refname, junk, 0, NULL);
1146        if (!resolves_to || strcmp(resolves_to, d->refname))
1147                return 0;
1148
1149        fprintf(d->fp, d->msg_fmt, refname);
1150        return 0;
1151}
1152
1153void warn_dangling_symref(FILE *fp, const char *msg_fmt, const char *refname)
1154{
1155        struct warn_if_dangling_data data;
1156
1157        data.fp = fp;
1158        data.refname = refname;
1159        data.msg_fmt = msg_fmt;
1160        for_each_rawref(warn_if_dangling_symref, &data);
1161}
1162
1163static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,
1164                           int trim, int flags, void *cb_data)
1165{
1166        struct ref_cache *refs = get_ref_cache(submodule);
1167        struct ref_dir *packed_dir = get_packed_refs(refs);
1168        struct ref_dir *loose_dir = get_loose_refs(refs);
1169        int retval = 0;
1170
1171        if (base && *base) {
1172                packed_dir = find_containing_dir(packed_dir, base, 0);
1173                loose_dir = find_containing_dir(loose_dir, base, 0);
1174        }
1175
1176        if (packed_dir && loose_dir) {
1177                sort_ref_dir(packed_dir);
1178                sort_ref_dir(loose_dir);
1179                retval = do_for_each_ref_in_dirs(
1180                                packed_dir, loose_dir,
1181                                base, fn, trim, flags, cb_data);
1182        } else if (packed_dir) {
1183                sort_ref_dir(packed_dir);
1184                retval = do_for_each_ref_in_dir(
1185                                packed_dir, 0,
1186                                base, fn, trim, flags, cb_data);
1187        } else if (loose_dir) {
1188                sort_ref_dir(loose_dir);
1189                retval = do_for_each_ref_in_dir(
1190                                loose_dir, 0,
1191                                base, fn, trim, flags, cb_data);
1192        }
1193
1194        return retval;
1195}
1196
1197static int do_head_ref(const char *submodule, each_ref_fn fn, void *cb_data)
1198{
1199        unsigned char sha1[20];
1200        int flag;
1201
1202        if (submodule) {
1203                if (resolve_gitlink_ref(submodule, "HEAD", sha1) == 0)
1204                        return fn("HEAD", sha1, 0, cb_data);
1205
1206                return 0;
1207        }
1208
1209        if (!read_ref_full("HEAD", sha1, 1, &flag))
1210                return fn("HEAD", sha1, flag, cb_data);
1211
1212        return 0;
1213}
1214
1215int head_ref(each_ref_fn fn, void *cb_data)
1216{
1217        return do_head_ref(NULL, fn, cb_data);
1218}
1219
1220int head_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1221{
1222        return do_head_ref(submodule, fn, cb_data);
1223}
1224
1225int for_each_ref(each_ref_fn fn, void *cb_data)
1226{
1227        return do_for_each_ref(NULL, "", fn, 0, 0, cb_data);
1228}
1229
1230int for_each_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1231{
1232        return do_for_each_ref(submodule, "", fn, 0, 0, cb_data);
1233}
1234
1235int for_each_ref_in(const char *prefix, each_ref_fn fn, void *cb_data)
1236{
1237        return do_for_each_ref(NULL, prefix, fn, strlen(prefix), 0, cb_data);
1238}
1239
1240int for_each_ref_in_submodule(const char *submodule, const char *prefix,
1241                each_ref_fn fn, void *cb_data)
1242{
1243        return do_for_each_ref(submodule, prefix, fn, strlen(prefix), 0, cb_data);
1244}
1245
1246int for_each_tag_ref(each_ref_fn fn, void *cb_data)
1247{
1248        return for_each_ref_in("refs/tags/", fn, cb_data);
1249}
1250
1251int for_each_tag_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1252{
1253        return for_each_ref_in_submodule(submodule, "refs/tags/", fn, cb_data);
1254}
1255
1256int for_each_branch_ref(each_ref_fn fn, void *cb_data)
1257{
1258        return for_each_ref_in("refs/heads/", fn, cb_data);
1259}
1260
1261int for_each_branch_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1262{
1263        return for_each_ref_in_submodule(submodule, "refs/heads/", fn, cb_data);
1264}
1265
1266int for_each_remote_ref(each_ref_fn fn, void *cb_data)
1267{
1268        return for_each_ref_in("refs/remotes/", fn, cb_data);
1269}
1270
1271int for_each_remote_ref_submodule(const char *submodule, each_ref_fn fn, void *cb_data)
1272{
1273        return for_each_ref_in_submodule(submodule, "refs/remotes/", fn, cb_data);
1274}
1275
1276int for_each_replace_ref(each_ref_fn fn, void *cb_data)
1277{
1278        return do_for_each_ref(NULL, "refs/replace/", fn, 13, 0, cb_data);
1279}
1280
1281int head_ref_namespaced(each_ref_fn fn, void *cb_data)
1282{
1283        struct strbuf buf = STRBUF_INIT;
1284        int ret = 0;
1285        unsigned char sha1[20];
1286        int flag;
1287
1288        strbuf_addf(&buf, "%sHEAD", get_git_namespace());
1289        if (!read_ref_full(buf.buf, sha1, 1, &flag))
1290                ret = fn(buf.buf, sha1, flag, cb_data);
1291        strbuf_release(&buf);
1292
1293        return ret;
1294}
1295
1296int for_each_namespaced_ref(each_ref_fn fn, void *cb_data)
1297{
1298        struct strbuf buf = STRBUF_INIT;
1299        int ret;
1300        strbuf_addf(&buf, "%srefs/", get_git_namespace());
1301        ret = do_for_each_ref(NULL, buf.buf, fn, 0, 0, cb_data);
1302        strbuf_release(&buf);
1303        return ret;
1304}
1305
1306int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
1307        const char *prefix, void *cb_data)
1308{
1309        struct strbuf real_pattern = STRBUF_INIT;
1310        struct ref_filter filter;
1311        int ret;
1312
1313        if (!prefix && prefixcmp(pattern, "refs/"))
1314                strbuf_addstr(&real_pattern, "refs/");
1315        else if (prefix)
1316                strbuf_addstr(&real_pattern, prefix);
1317        strbuf_addstr(&real_pattern, pattern);
1318
1319        if (!has_glob_specials(pattern)) {
1320                /* Append implied '/' '*' if not present. */
1321                if (real_pattern.buf[real_pattern.len - 1] != '/')
1322                        strbuf_addch(&real_pattern, '/');
1323                /* No need to check for '*', there is none. */
1324                strbuf_addch(&real_pattern, '*');
1325        }
1326
1327        filter.pattern = real_pattern.buf;
1328        filter.fn = fn;
1329        filter.cb_data = cb_data;
1330        ret = for_each_ref(filter_refs, &filter);
1331
1332        strbuf_release(&real_pattern);
1333        return ret;
1334}
1335
1336int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data)
1337{
1338        return for_each_glob_ref_in(fn, pattern, NULL, cb_data);
1339}
1340
1341int for_each_rawref(each_ref_fn fn, void *cb_data)
1342{
1343        return do_for_each_ref(NULL, "", fn, 0,
1344                               DO_FOR_EACH_INCLUDE_BROKEN, cb_data);
1345}
1346
1347const char *prettify_refname(const char *name)
1348{
1349        return name + (
1350                !prefixcmp(name, "refs/heads/") ? 11 :
1351                !prefixcmp(name, "refs/tags/") ? 10 :
1352                !prefixcmp(name, "refs/remotes/") ? 13 :
1353                0);
1354}
1355
1356const char *ref_rev_parse_rules[] = {
1357        "%.*s",
1358        "refs/%.*s",
1359        "refs/tags/%.*s",
1360        "refs/heads/%.*s",
1361        "refs/remotes/%.*s",
1362        "refs/remotes/%.*s/HEAD",
1363        NULL
1364};
1365
1366int refname_match(const char *abbrev_name, const char *full_name, const char **rules)
1367{
1368        const char **p;
1369        const int abbrev_name_len = strlen(abbrev_name);
1370
1371        for (p = rules; *p; p++) {
1372                if (!strcmp(full_name, mkpath(*p, abbrev_name_len, abbrev_name))) {
1373                        return 1;
1374                }
1375        }
1376
1377        return 0;
1378}
1379
1380static struct ref_lock *verify_lock(struct ref_lock *lock,
1381        const unsigned char *old_sha1, int mustexist)
1382{
1383        if (read_ref_full(lock->ref_name, lock->old_sha1, mustexist, NULL)) {
1384                error("Can't verify ref %s", lock->ref_name);
1385                unlock_ref(lock);
1386                return NULL;
1387        }
1388        if (hashcmp(lock->old_sha1, old_sha1)) {
1389                error("Ref %s is at %s but expected %s", lock->ref_name,
1390                        sha1_to_hex(lock->old_sha1), sha1_to_hex(old_sha1));
1391                unlock_ref(lock);
1392                return NULL;
1393        }
1394        return lock;
1395}
1396
1397static int remove_empty_directories(const char *file)
1398{
1399        /* we want to create a file but there is a directory there;
1400         * if that is an empty directory (or a directory that contains
1401         * only empty directories), remove them.
1402         */
1403        struct strbuf path;
1404        int result;
1405
1406        strbuf_init(&path, 20);
1407        strbuf_addstr(&path, file);
1408
1409        result = remove_dir_recursively(&path, REMOVE_DIR_EMPTY_ONLY);
1410
1411        strbuf_release(&path);
1412
1413        return result;
1414}
1415
1416/*
1417 * *string and *len will only be substituted, and *string returned (for
1418 * later free()ing) if the string passed in is a magic short-hand form
1419 * to name a branch.
1420 */
1421static char *substitute_branch_name(const char **string, int *len)
1422{
1423        struct strbuf buf = STRBUF_INIT;
1424        int ret = interpret_branch_name(*string, &buf);
1425
1426        if (ret == *len) {
1427                size_t size;
1428                *string = strbuf_detach(&buf, &size);
1429                *len = size;
1430                return (char *)*string;
1431        }
1432
1433        return NULL;
1434}
1435
1436int dwim_ref(const char *str, int len, unsigned char *sha1, char **ref)
1437{
1438        char *last_branch = substitute_branch_name(&str, &len);
1439        const char **p, *r;
1440        int refs_found = 0;
1441
1442        *ref = NULL;
1443        for (p = ref_rev_parse_rules; *p; p++) {
1444                char fullref[PATH_MAX];
1445                unsigned char sha1_from_ref[20];
1446                unsigned char *this_result;
1447                int flag;
1448
1449                this_result = refs_found ? sha1_from_ref : sha1;
1450                mksnpath(fullref, sizeof(fullref), *p, len, str);
1451                r = resolve_ref_unsafe(fullref, this_result, 1, &flag);
1452                if (r) {
1453                        if (!refs_found++)
1454                                *ref = xstrdup(r);
1455                        if (!warn_ambiguous_refs)
1456                                break;
1457                } else if ((flag & REF_ISSYMREF) && strcmp(fullref, "HEAD")) {
1458                        warning("ignoring dangling symref %s.", fullref);
1459                } else if ((flag & REF_ISBROKEN) && strchr(fullref, '/')) {
1460                        warning("ignoring broken ref %s.", fullref);
1461                }
1462        }
1463        free(last_branch);
1464        return refs_found;
1465}
1466
1467int dwim_log(const char *str, int len, unsigned char *sha1, char **log)
1468{
1469        char *last_branch = substitute_branch_name(&str, &len);
1470        const char **p;
1471        int logs_found = 0;
1472
1473        *log = NULL;
1474        for (p = ref_rev_parse_rules; *p; p++) {
1475                struct stat st;
1476                unsigned char hash[20];
1477                char path[PATH_MAX];
1478                const char *ref, *it;
1479
1480                mksnpath(path, sizeof(path), *p, len, str);
1481                ref = resolve_ref_unsafe(path, hash, 1, NULL);
1482                if (!ref)
1483                        continue;
1484                if (!stat(git_path("logs/%s", path), &st) &&
1485                    S_ISREG(st.st_mode))
1486                        it = path;
1487                else if (strcmp(ref, path) &&
1488                         !stat(git_path("logs/%s", ref), &st) &&
1489                         S_ISREG(st.st_mode))
1490                        it = ref;
1491                else
1492                        continue;
1493                if (!logs_found++) {
1494                        *log = xstrdup(it);
1495                        hashcpy(sha1, hash);
1496                }
1497                if (!warn_ambiguous_refs)
1498                        break;
1499        }
1500        free(last_branch);
1501        return logs_found;
1502}
1503
1504static struct ref_lock *lock_ref_sha1_basic(const char *refname,
1505                                            const unsigned char *old_sha1,
1506                                            int flags, int *type_p)
1507{
1508        char *ref_file;
1509        const char *orig_refname = refname;
1510        struct ref_lock *lock;
1511        int last_errno = 0;
1512        int type, lflags;
1513        int mustexist = (old_sha1 && !is_null_sha1(old_sha1));
1514        int missing = 0;
1515
1516        lock = xcalloc(1, sizeof(struct ref_lock));
1517        lock->lock_fd = -1;
1518
1519        refname = resolve_ref_unsafe(refname, lock->old_sha1, mustexist, &type);
1520        if (!refname && errno == EISDIR) {
1521                /* we are trying to lock foo but we used to
1522                 * have foo/bar which now does not exist;
1523                 * it is normal for the empty directory 'foo'
1524                 * to remain.
1525                 */
1526                ref_file = git_path("%s", orig_refname);
1527                if (remove_empty_directories(ref_file)) {
1528                        last_errno = errno;
1529                        error("there are still refs under '%s'", orig_refname);
1530                        goto error_return;
1531                }
1532                refname = resolve_ref_unsafe(orig_refname, lock->old_sha1, mustexist, &type);
1533        }
1534        if (type_p)
1535            *type_p = type;
1536        if (!refname) {
1537                last_errno = errno;
1538                error("unable to resolve reference %s: %s",
1539                        orig_refname, strerror(errno));
1540                goto error_return;
1541        }
1542        missing = is_null_sha1(lock->old_sha1);
1543        /* When the ref did not exist and we are creating it,
1544         * make sure there is no existing ref that is packed
1545         * whose name begins with our refname, nor a ref whose
1546         * name is a proper prefix of our refname.
1547         */
1548        if (missing &&
1549             !is_refname_available(refname, NULL, get_packed_refs(get_ref_cache(NULL)))) {
1550                last_errno = ENOTDIR;
1551                goto error_return;
1552        }
1553
1554        lock->lk = xcalloc(1, sizeof(struct lock_file));
1555
1556        lflags = LOCK_DIE_ON_ERROR;
1557        if (flags & REF_NODEREF) {
1558                refname = orig_refname;
1559                lflags |= LOCK_NODEREF;
1560        }
1561        lock->ref_name = xstrdup(refname);
1562        lock->orig_ref_name = xstrdup(orig_refname);
1563        ref_file = git_path("%s", refname);
1564        if (missing)
1565                lock->force_write = 1;
1566        if ((flags & REF_NODEREF) && (type & REF_ISSYMREF))
1567                lock->force_write = 1;
1568
1569        if (safe_create_leading_directories(ref_file)) {
1570                last_errno = errno;
1571                error("unable to create directory for %s", ref_file);
1572                goto error_return;
1573        }
1574
1575        lock->lock_fd = hold_lock_file_for_update(lock->lk, ref_file, lflags);
1576        return old_sha1 ? verify_lock(lock, old_sha1, mustexist) : lock;
1577
1578 error_return:
1579        unlock_ref(lock);
1580        errno = last_errno;
1581        return NULL;
1582}
1583
1584struct ref_lock *lock_ref_sha1(const char *refname, const unsigned char *old_sha1)
1585{
1586        char refpath[PATH_MAX];
1587        if (check_refname_format(refname, 0))
1588                return NULL;
1589        strcpy(refpath, mkpath("refs/%s", refname));
1590        return lock_ref_sha1_basic(refpath, old_sha1, 0, NULL);
1591}
1592
1593struct ref_lock *lock_any_ref_for_update(const char *refname,
1594                                         const unsigned char *old_sha1, int flags)
1595{
1596        if (check_refname_format(refname, REFNAME_ALLOW_ONELEVEL))
1597                return NULL;
1598        return lock_ref_sha1_basic(refname, old_sha1, flags, NULL);
1599}
1600
1601struct repack_without_ref_sb {
1602        const char *refname;
1603        int fd;
1604};
1605
1606static int repack_without_ref_fn(const char *refname, const unsigned char *sha1,
1607                                 int flags, void *cb_data)
1608{
1609        struct repack_without_ref_sb *data = cb_data;
1610        char line[PATH_MAX + 100];
1611        int len;
1612
1613        if (!strcmp(data->refname, refname))
1614                return 0;
1615        len = snprintf(line, sizeof(line), "%s %s\n",
1616                       sha1_to_hex(sha1), refname);
1617        /* this should not happen but just being defensive */
1618        if (len > sizeof(line))
1619                die("too long a refname '%s'", refname);
1620        write_or_die(data->fd, line, len);
1621        return 0;
1622}
1623
1624static struct lock_file packlock;
1625
1626static int repack_without_ref(const char *refname)
1627{
1628        struct repack_without_ref_sb data;
1629        struct ref_dir *packed = get_packed_refs(get_ref_cache(NULL));
1630        if (find_ref(packed, refname) == NULL)
1631                return 0;
1632        data.refname = refname;
1633        data.fd = hold_lock_file_for_update(&packlock, git_path("packed-refs"), 0);
1634        if (data.fd < 0) {
1635                unable_to_lock_error(git_path("packed-refs"), errno);
1636                return error("cannot delete '%s' from packed refs", refname);
1637        }
1638        do_for_each_ref_in_dir(packed, 0, "", repack_without_ref_fn, 0, 0, &data);
1639        return commit_lock_file(&packlock);
1640}
1641
1642int delete_ref(const char *refname, const unsigned char *sha1, int delopt)
1643{
1644        struct ref_lock *lock;
1645        int err, i = 0, ret = 0, flag = 0;
1646
1647        lock = lock_ref_sha1_basic(refname, sha1, 0, &flag);
1648        if (!lock)
1649                return 1;
1650        if (!(flag & REF_ISPACKED) || flag & REF_ISSYMREF) {
1651                /* loose */
1652                const char *path;
1653
1654                if (!(delopt & REF_NODEREF)) {
1655                        i = strlen(lock->lk->filename) - 5; /* .lock */
1656                        lock->lk->filename[i] = 0;
1657                        path = lock->lk->filename;
1658                } else {
1659                        path = git_path("%s", refname);
1660                }
1661                err = unlink_or_warn(path);
1662                if (err && errno != ENOENT)
1663                        ret = 1;
1664
1665                if (!(delopt & REF_NODEREF))
1666                        lock->lk->filename[i] = '.';
1667        }
1668        /* removing the loose one could have resurrected an earlier
1669         * packed one.  Also, if it was not loose we need to repack
1670         * without it.
1671         */
1672        ret |= repack_without_ref(refname);
1673
1674        unlink_or_warn(git_path("logs/%s", lock->ref_name));
1675        invalidate_ref_cache(NULL);
1676        unlock_ref(lock);
1677        return ret;
1678}
1679
1680/*
1681 * People using contrib's git-new-workdir have .git/logs/refs ->
1682 * /some/other/path/.git/logs/refs, and that may live on another device.
1683 *
1684 * IOW, to avoid cross device rename errors, the temporary renamed log must
1685 * live into logs/refs.
1686 */
1687#define TMP_RENAMED_LOG  "logs/refs/.tmp-renamed-log"
1688
1689int rename_ref(const char *oldrefname, const char *newrefname, const char *logmsg)
1690{
1691        unsigned char sha1[20], orig_sha1[20];
1692        int flag = 0, logmoved = 0;
1693        struct ref_lock *lock;
1694        struct stat loginfo;
1695        int log = !lstat(git_path("logs/%s", oldrefname), &loginfo);
1696        const char *symref = NULL;
1697        struct ref_cache *refs = get_ref_cache(NULL);
1698
1699        if (log && S_ISLNK(loginfo.st_mode))
1700                return error("reflog for %s is a symlink", oldrefname);
1701
1702        symref = resolve_ref_unsafe(oldrefname, orig_sha1, 1, &flag);
1703        if (flag & REF_ISSYMREF)
1704                return error("refname %s is a symbolic ref, renaming it is not supported",
1705                        oldrefname);
1706        if (!symref)
1707                return error("refname %s not found", oldrefname);
1708
1709        if (!is_refname_available(newrefname, oldrefname, get_packed_refs(refs)))
1710                return 1;
1711
1712        if (!is_refname_available(newrefname, oldrefname, get_loose_refs(refs)))
1713                return 1;
1714
1715        if (log && rename(git_path("logs/%s", oldrefname), git_path(TMP_RENAMED_LOG)))
1716                return error("unable to move logfile logs/%s to "TMP_RENAMED_LOG": %s",
1717                        oldrefname, strerror(errno));
1718
1719        if (delete_ref(oldrefname, orig_sha1, REF_NODEREF)) {
1720                error("unable to delete old %s", oldrefname);
1721                goto rollback;
1722        }
1723
1724        if (!read_ref_full(newrefname, sha1, 1, &flag) &&
1725            delete_ref(newrefname, sha1, REF_NODEREF)) {
1726                if (errno==EISDIR) {
1727                        if (remove_empty_directories(git_path("%s", newrefname))) {
1728                                error("Directory not empty: %s", newrefname);
1729                                goto rollback;
1730                        }
1731                } else {
1732                        error("unable to delete existing %s", newrefname);
1733                        goto rollback;
1734                }
1735        }
1736
1737        if (log && safe_create_leading_directories(git_path("logs/%s", newrefname))) {
1738                error("unable to create directory for %s", newrefname);
1739                goto rollback;
1740        }
1741
1742 retry:
1743        if (log && rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", newrefname))) {
1744                if (errno==EISDIR || errno==ENOTDIR) {
1745                        /*
1746                         * rename(a, b) when b is an existing
1747                         * directory ought to result in ISDIR, but
1748                         * Solaris 5.8 gives ENOTDIR.  Sheesh.
1749                         */
1750                        if (remove_empty_directories(git_path("logs/%s", newrefname))) {
1751                                error("Directory not empty: logs/%s", newrefname);
1752                                goto rollback;
1753                        }
1754                        goto retry;
1755                } else {
1756                        error("unable to move logfile "TMP_RENAMED_LOG" to logs/%s: %s",
1757                                newrefname, strerror(errno));
1758                        goto rollback;
1759                }
1760        }
1761        logmoved = log;
1762
1763        lock = lock_ref_sha1_basic(newrefname, NULL, 0, NULL);
1764        if (!lock) {
1765                error("unable to lock %s for update", newrefname);
1766                goto rollback;
1767        }
1768        lock->force_write = 1;
1769        hashcpy(lock->old_sha1, orig_sha1);
1770        if (write_ref_sha1(lock, orig_sha1, logmsg)) {
1771                error("unable to write current sha1 into %s", newrefname);
1772                goto rollback;
1773        }
1774
1775        return 0;
1776
1777 rollback:
1778        lock = lock_ref_sha1_basic(oldrefname, NULL, 0, NULL);
1779        if (!lock) {
1780                error("unable to lock %s for rollback", oldrefname);
1781                goto rollbacklog;
1782        }
1783
1784        lock->force_write = 1;
1785        flag = log_all_ref_updates;
1786        log_all_ref_updates = 0;
1787        if (write_ref_sha1(lock, orig_sha1, NULL))
1788                error("unable to write current sha1 into %s", oldrefname);
1789        log_all_ref_updates = flag;
1790
1791 rollbacklog:
1792        if (logmoved && rename(git_path("logs/%s", newrefname), git_path("logs/%s", oldrefname)))
1793                error("unable to restore logfile %s from %s: %s",
1794                        oldrefname, newrefname, strerror(errno));
1795        if (!logmoved && log &&
1796            rename(git_path(TMP_RENAMED_LOG), git_path("logs/%s", oldrefname)))
1797                error("unable to restore logfile %s from "TMP_RENAMED_LOG": %s",
1798                        oldrefname, strerror(errno));
1799
1800        return 1;
1801}
1802
1803int close_ref(struct ref_lock *lock)
1804{
1805        if (close_lock_file(lock->lk))
1806                return -1;
1807        lock->lock_fd = -1;
1808        return 0;
1809}
1810
1811int commit_ref(struct ref_lock *lock)
1812{
1813        if (commit_lock_file(lock->lk))
1814                return -1;
1815        lock->lock_fd = -1;
1816        return 0;
1817}
1818
1819void unlock_ref(struct ref_lock *lock)
1820{
1821        /* Do not free lock->lk -- atexit() still looks at them */
1822        if (lock->lk)
1823                rollback_lock_file(lock->lk);
1824        free(lock->ref_name);
1825        free(lock->orig_ref_name);
1826        free(lock);
1827}
1828
1829/*
1830 * copy the reflog message msg to buf, which has been allocated sufficiently
1831 * large, while cleaning up the whitespaces.  Especially, convert LF to space,
1832 * because reflog file is one line per entry.
1833 */
1834static int copy_msg(char *buf, const char *msg)
1835{
1836        char *cp = buf;
1837        char c;
1838        int wasspace = 1;
1839
1840        *cp++ = '\t';
1841        while ((c = *msg++)) {
1842                if (wasspace && isspace(c))
1843                        continue;
1844                wasspace = isspace(c);
1845                if (wasspace)
1846                        c = ' ';
1847                *cp++ = c;
1848        }
1849        while (buf < cp && isspace(cp[-1]))
1850                cp--;
1851        *cp++ = '\n';
1852        return cp - buf;
1853}
1854
1855int log_ref_setup(const char *refname, char *logfile, int bufsize)
1856{
1857        int logfd, oflags = O_APPEND | O_WRONLY;
1858
1859        git_snpath(logfile, bufsize, "logs/%s", refname);
1860        if (log_all_ref_updates &&
1861            (!prefixcmp(refname, "refs/heads/") ||
1862             !prefixcmp(refname, "refs/remotes/") ||
1863             !prefixcmp(refname, "refs/notes/") ||
1864             !strcmp(refname, "HEAD"))) {
1865                if (safe_create_leading_directories(logfile) < 0)
1866                        return error("unable to create directory for %s",
1867                                     logfile);
1868                oflags |= O_CREAT;
1869        }
1870
1871        logfd = open(logfile, oflags, 0666);
1872        if (logfd < 0) {
1873                if (!(oflags & O_CREAT) && errno == ENOENT)
1874                        return 0;
1875
1876                if ((oflags & O_CREAT) && errno == EISDIR) {
1877                        if (remove_empty_directories(logfile)) {
1878                                return error("There are still logs under '%s'",
1879                                             logfile);
1880                        }
1881                        logfd = open(logfile, oflags, 0666);
1882                }
1883
1884                if (logfd < 0)
1885                        return error("Unable to append to %s: %s",
1886                                     logfile, strerror(errno));
1887        }
1888
1889        adjust_shared_perm(logfile);
1890        close(logfd);
1891        return 0;
1892}
1893
1894static int log_ref_write(const char *refname, const unsigned char *old_sha1,
1895                         const unsigned char *new_sha1, const char *msg)
1896{
1897        int logfd, result, written, oflags = O_APPEND | O_WRONLY;
1898        unsigned maxlen, len;
1899        int msglen;
1900        char log_file[PATH_MAX];
1901        char *logrec;
1902        const char *committer;
1903
1904        if (log_all_ref_updates < 0)
1905                log_all_ref_updates = !is_bare_repository();
1906
1907        result = log_ref_setup(refname, log_file, sizeof(log_file));
1908        if (result)
1909                return result;
1910
1911        logfd = open(log_file, oflags);
1912        if (logfd < 0)
1913                return 0;
1914        msglen = msg ? strlen(msg) : 0;
1915        committer = git_committer_info(0);
1916        maxlen = strlen(committer) + msglen + 100;
1917        logrec = xmalloc(maxlen);
1918        len = sprintf(logrec, "%s %s %s\n",
1919                      sha1_to_hex(old_sha1),
1920                      sha1_to_hex(new_sha1),
1921                      committer);
1922        if (msglen)
1923                len += copy_msg(logrec + len - 1, msg) - 1;
1924        written = len <= maxlen ? write_in_full(logfd, logrec, len) : -1;
1925        free(logrec);
1926        if (close(logfd) != 0 || written != len)
1927                return error("Unable to append to %s", log_file);
1928        return 0;
1929}
1930
1931static int is_branch(const char *refname)
1932{
1933        return !strcmp(refname, "HEAD") || !prefixcmp(refname, "refs/heads/");
1934}
1935
1936int write_ref_sha1(struct ref_lock *lock,
1937        const unsigned char *sha1, const char *logmsg)
1938{
1939        static char term = '\n';
1940        struct object *o;
1941
1942        if (!lock)
1943                return -1;
1944        if (!lock->force_write && !hashcmp(lock->old_sha1, sha1)) {
1945                unlock_ref(lock);
1946                return 0;
1947        }
1948        o = parse_object(sha1);
1949        if (!o) {
1950                error("Trying to write ref %s with nonexistent object %s",
1951                        lock->ref_name, sha1_to_hex(sha1));
1952                unlock_ref(lock);
1953                return -1;
1954        }
1955        if (o->type != OBJ_COMMIT && is_branch(lock->ref_name)) {
1956                error("Trying to write non-commit object %s to branch %s",
1957                        sha1_to_hex(sha1), lock->ref_name);
1958                unlock_ref(lock);
1959                return -1;
1960        }
1961        if (write_in_full(lock->lock_fd, sha1_to_hex(sha1), 40) != 40 ||
1962            write_in_full(lock->lock_fd, &term, 1) != 1
1963                || close_ref(lock) < 0) {
1964                error("Couldn't write %s", lock->lk->filename);
1965                unlock_ref(lock);
1966                return -1;
1967        }
1968        clear_loose_ref_cache(get_ref_cache(NULL));
1969        if (log_ref_write(lock->ref_name, lock->old_sha1, sha1, logmsg) < 0 ||
1970            (strcmp(lock->ref_name, lock->orig_ref_name) &&
1971             log_ref_write(lock->orig_ref_name, lock->old_sha1, sha1, logmsg) < 0)) {
1972                unlock_ref(lock);
1973                return -1;
1974        }
1975        if (strcmp(lock->orig_ref_name, "HEAD") != 0) {
1976                /*
1977                 * Special hack: If a branch is updated directly and HEAD
1978                 * points to it (may happen on the remote side of a push
1979                 * for example) then logically the HEAD reflog should be
1980                 * updated too.
1981                 * A generic solution implies reverse symref information,
1982                 * but finding all symrefs pointing to the given branch
1983                 * would be rather costly for this rare event (the direct
1984                 * update of a branch) to be worth it.  So let's cheat and
1985                 * check with HEAD only which should cover 99% of all usage
1986                 * scenarios (even 100% of the default ones).
1987                 */
1988                unsigned char head_sha1[20];
1989                int head_flag;
1990                const char *head_ref;
1991                head_ref = resolve_ref_unsafe("HEAD", head_sha1, 1, &head_flag);
1992                if (head_ref && (head_flag & REF_ISSYMREF) &&
1993                    !strcmp(head_ref, lock->ref_name))
1994                        log_ref_write("HEAD", lock->old_sha1, sha1, logmsg);
1995        }
1996        if (commit_ref(lock)) {
1997                error("Couldn't set %s", lock->ref_name);
1998                unlock_ref(lock);
1999                return -1;
2000        }
2001        unlock_ref(lock);
2002        return 0;
2003}
2004
2005int create_symref(const char *ref_target, const char *refs_heads_master,
2006                  const char *logmsg)
2007{
2008        const char *lockpath;
2009        char ref[1000];
2010        int fd, len, written;
2011        char *git_HEAD = git_pathdup("%s", ref_target);
2012        unsigned char old_sha1[20], new_sha1[20];
2013
2014        if (logmsg && read_ref(ref_target, old_sha1))
2015                hashclr(old_sha1);
2016
2017        if (safe_create_leading_directories(git_HEAD) < 0)
2018                return error("unable to create directory for %s", git_HEAD);
2019
2020#ifndef NO_SYMLINK_HEAD
2021        if (prefer_symlink_refs) {
2022                unlink(git_HEAD);
2023                if (!symlink(refs_heads_master, git_HEAD))
2024                        goto done;
2025                fprintf(stderr, "no symlink - falling back to symbolic ref\n");
2026        }
2027#endif
2028
2029        len = snprintf(ref, sizeof(ref), "ref: %s\n", refs_heads_master);
2030        if (sizeof(ref) <= len) {
2031                error("refname too long: %s", refs_heads_master);
2032                goto error_free_return;
2033        }
2034        lockpath = mkpath("%s.lock", git_HEAD);
2035        fd = open(lockpath, O_CREAT | O_EXCL | O_WRONLY, 0666);
2036        if (fd < 0) {
2037                error("Unable to open %s for writing", lockpath);
2038                goto error_free_return;
2039        }
2040        written = write_in_full(fd, ref, len);
2041        if (close(fd) != 0 || written != len) {
2042                error("Unable to write to %s", lockpath);
2043                goto error_unlink_return;
2044        }
2045        if (rename(lockpath, git_HEAD) < 0) {
2046                error("Unable to create %s", git_HEAD);
2047                goto error_unlink_return;
2048        }
2049        if (adjust_shared_perm(git_HEAD)) {
2050                error("Unable to fix permissions on %s", lockpath);
2051        error_unlink_return:
2052                unlink_or_warn(lockpath);
2053        error_free_return:
2054                free(git_HEAD);
2055                return -1;
2056        }
2057
2058#ifndef NO_SYMLINK_HEAD
2059        done:
2060#endif
2061        if (logmsg && !read_ref(refs_heads_master, new_sha1))
2062                log_ref_write(ref_target, old_sha1, new_sha1, logmsg);
2063
2064        free(git_HEAD);
2065        return 0;
2066}
2067
2068static char *ref_msg(const char *line, const char *endp)
2069{
2070        const char *ep;
2071        line += 82;
2072        ep = memchr(line, '\n', endp - line);
2073        if (!ep)
2074                ep = endp;
2075        return xmemdupz(line, ep - line);
2076}
2077
2078int read_ref_at(const char *refname, unsigned long at_time, int cnt,
2079                unsigned char *sha1, char **msg,
2080                unsigned long *cutoff_time, int *cutoff_tz, int *cutoff_cnt)
2081{
2082        const char *logfile, *logdata, *logend, *rec, *lastgt, *lastrec;
2083        char *tz_c;
2084        int logfd, tz, reccnt = 0;
2085        struct stat st;
2086        unsigned long date;
2087        unsigned char logged_sha1[20];
2088        void *log_mapped;
2089        size_t mapsz;
2090
2091        logfile = git_path("logs/%s", refname);
2092        logfd = open(logfile, O_RDONLY, 0);
2093        if (logfd < 0)
2094                die_errno("Unable to read log '%s'", logfile);
2095        fstat(logfd, &st);
2096        if (!st.st_size)
2097                die("Log %s is empty.", logfile);
2098        mapsz = xsize_t(st.st_size);
2099        log_mapped = xmmap(NULL, mapsz, PROT_READ, MAP_PRIVATE, logfd, 0);
2100        logdata = log_mapped;
2101        close(logfd);
2102
2103        lastrec = NULL;
2104        rec = logend = logdata + st.st_size;
2105        while (logdata < rec) {
2106                reccnt++;
2107                if (logdata < rec && *(rec-1) == '\n')
2108                        rec--;
2109                lastgt = NULL;
2110                while (logdata < rec && *(rec-1) != '\n') {
2111                        rec--;
2112                        if (*rec == '>')
2113                                lastgt = rec;
2114                }
2115                if (!lastgt)
2116                        die("Log %s is corrupt.", logfile);
2117                date = strtoul(lastgt + 1, &tz_c, 10);
2118                if (date <= at_time || cnt == 0) {
2119                        tz = strtoul(tz_c, NULL, 10);
2120                        if (msg)
2121                                *msg = ref_msg(rec, logend);
2122                        if (cutoff_time)
2123                                *cutoff_time = date;
2124                        if (cutoff_tz)
2125                                *cutoff_tz = tz;
2126                        if (cutoff_cnt)
2127                                *cutoff_cnt = reccnt - 1;
2128                        if (lastrec) {
2129                                if (get_sha1_hex(lastrec, logged_sha1))
2130                                        die("Log %s is corrupt.", logfile);
2131                                if (get_sha1_hex(rec + 41, sha1))
2132                                        die("Log %s is corrupt.", logfile);
2133                                if (hashcmp(logged_sha1, sha1)) {
2134                                        warning("Log %s has gap after %s.",
2135                                                logfile, show_date(date, tz, DATE_RFC2822));
2136                                }
2137                        }
2138                        else if (date == at_time) {
2139                                if (get_sha1_hex(rec + 41, sha1))
2140                                        die("Log %s is corrupt.", logfile);
2141                        }
2142                        else {
2143                                if (get_sha1_hex(rec + 41, logged_sha1))
2144                                        die("Log %s is corrupt.", logfile);
2145                                if (hashcmp(logged_sha1, sha1)) {
2146                                        warning("Log %s unexpectedly ended on %s.",
2147                                                logfile, show_date(date, tz, DATE_RFC2822));
2148                                }
2149                        }
2150                        munmap(log_mapped, mapsz);
2151                        return 0;
2152                }
2153                lastrec = rec;
2154                if (cnt > 0)
2155                        cnt--;
2156        }
2157
2158        rec = logdata;
2159        while (rec < logend && *rec != '>' && *rec != '\n')
2160                rec++;
2161        if (rec == logend || *rec == '\n')
2162                die("Log %s is corrupt.", logfile);
2163        date = strtoul(rec + 1, &tz_c, 10);
2164        tz = strtoul(tz_c, NULL, 10);
2165        if (get_sha1_hex(logdata, sha1))
2166                die("Log %s is corrupt.", logfile);
2167        if (is_null_sha1(sha1)) {
2168                if (get_sha1_hex(logdata + 41, sha1))
2169                        die("Log %s is corrupt.", logfile);
2170        }
2171        if (msg)
2172                *msg = ref_msg(logdata, logend);
2173        munmap(log_mapped, mapsz);
2174
2175        if (cutoff_time)
2176                *cutoff_time = date;
2177        if (cutoff_tz)
2178                *cutoff_tz = tz;
2179        if (cutoff_cnt)
2180                *cutoff_cnt = reccnt;
2181        return 1;
2182}
2183
2184int for_each_recent_reflog_ent(const char *refname, each_reflog_ent_fn fn, long ofs, void *cb_data)
2185{
2186        const char *logfile;
2187        FILE *logfp;
2188        struct strbuf sb = STRBUF_INIT;
2189        int ret = 0;
2190
2191        logfile = git_path("logs/%s", refname);
2192        logfp = fopen(logfile, "r");
2193        if (!logfp)
2194                return -1;
2195
2196        if (ofs) {
2197                struct stat statbuf;
2198                if (fstat(fileno(logfp), &statbuf) ||
2199                    statbuf.st_size < ofs ||
2200                    fseek(logfp, -ofs, SEEK_END) ||
2201                    strbuf_getwholeline(&sb, logfp, '\n')) {
2202                        fclose(logfp);
2203                        strbuf_release(&sb);
2204                        return -1;
2205                }
2206        }
2207
2208        while (!strbuf_getwholeline(&sb, logfp, '\n')) {
2209                unsigned char osha1[20], nsha1[20];
2210                char *email_end, *message;
2211                unsigned long timestamp;
2212                int tz;
2213
2214                /* old SP new SP name <email> SP time TAB msg LF */
2215                if (sb.len < 83 || sb.buf[sb.len - 1] != '\n' ||
2216                    get_sha1_hex(sb.buf, osha1) || sb.buf[40] != ' ' ||
2217                    get_sha1_hex(sb.buf + 41, nsha1) || sb.buf[81] != ' ' ||
2218                    !(email_end = strchr(sb.buf + 82, '>')) ||
2219                    email_end[1] != ' ' ||
2220                    !(timestamp = strtoul(email_end + 2, &message, 10)) ||
2221                    !message || message[0] != ' ' ||
2222                    (message[1] != '+' && message[1] != '-') ||
2223                    !isdigit(message[2]) || !isdigit(message[3]) ||
2224                    !isdigit(message[4]) || !isdigit(message[5]))
2225                        continue; /* corrupt? */
2226                email_end[1] = '\0';
2227                tz = strtol(message + 1, NULL, 10);
2228                if (message[6] != '\t')
2229                        message += 6;
2230                else
2231                        message += 7;
2232                ret = fn(osha1, nsha1, sb.buf + 82, timestamp, tz, message,
2233                         cb_data);
2234                if (ret)
2235                        break;
2236        }
2237        fclose(logfp);
2238        strbuf_release(&sb);
2239        return ret;
2240}
2241
2242int for_each_reflog_ent(const char *refname, each_reflog_ent_fn fn, void *cb_data)
2243{
2244        return for_each_recent_reflog_ent(refname, fn, 0, cb_data);
2245}
2246
2247/*
2248 * Call fn for each reflog in the namespace indicated by name.  name
2249 * must be empty or end with '/'.  Name will be used as a scratch
2250 * space, but its contents will be restored before return.
2251 */
2252static int do_for_each_reflog(struct strbuf *name, each_ref_fn fn, void *cb_data)
2253{
2254        DIR *d = opendir(git_path("logs/%s", name->buf));
2255        int retval = 0;
2256        struct dirent *de;
2257        int oldlen = name->len;
2258
2259        if (!d)
2260                return name->len ? errno : 0;
2261
2262        while ((de = readdir(d)) != NULL) {
2263                struct stat st;
2264
2265                if (de->d_name[0] == '.')
2266                        continue;
2267                if (has_extension(de->d_name, ".lock"))
2268                        continue;
2269                strbuf_addstr(name, de->d_name);
2270                if (stat(git_path("logs/%s", name->buf), &st) < 0) {
2271                        ; /* silently ignore */
2272                } else {
2273                        if (S_ISDIR(st.st_mode)) {
2274                                strbuf_addch(name, '/');
2275                                retval = do_for_each_reflog(name, fn, cb_data);
2276                        } else {
2277                                unsigned char sha1[20];
2278                                if (read_ref_full(name->buf, sha1, 0, NULL))
2279                                        retval = error("bad ref for %s", name->buf);
2280                                else
2281                                        retval = fn(name->buf, sha1, 0, cb_data);
2282                        }
2283                        if (retval)
2284                                break;
2285                }
2286                strbuf_setlen(name, oldlen);
2287        }
2288        closedir(d);
2289        return retval;
2290}
2291
2292int for_each_reflog(each_ref_fn fn, void *cb_data)
2293{
2294        int retval;
2295        struct strbuf name;
2296        strbuf_init(&name, PATH_MAX);
2297        retval = do_for_each_reflog(&name, fn, cb_data);
2298        strbuf_release(&name);
2299        return retval;
2300}
2301
2302int update_ref(const char *action, const char *refname,
2303                const unsigned char *sha1, const unsigned char *oldval,
2304                int flags, enum action_on_err onerr)
2305{
2306        static struct ref_lock *lock;
2307        lock = lock_any_ref_for_update(refname, oldval, flags);
2308        if (!lock) {
2309                const char *str = "Cannot lock the ref '%s'.";
2310                switch (onerr) {
2311                case MSG_ON_ERR: error(str, refname); break;
2312                case DIE_ON_ERR: die(str, refname); break;
2313                case QUIET_ON_ERR: break;
2314                }
2315                return 1;
2316        }
2317        if (write_ref_sha1(lock, sha1, action) < 0) {
2318                const char *str = "Cannot update the ref '%s'.";
2319                switch (onerr) {
2320                case MSG_ON_ERR: error(str, refname); break;
2321                case DIE_ON_ERR: die(str, refname); break;
2322                case QUIET_ON_ERR: break;
2323                }
2324                return 1;
2325        }
2326        return 0;
2327}
2328
2329struct ref *find_ref_by_name(const struct ref *list, const char *name)
2330{
2331        for ( ; list; list = list->next)
2332                if (!strcmp(list->name, name))
2333                        return (struct ref *)list;
2334        return NULL;
2335}
2336
2337/*
2338 * generate a format suitable for scanf from a ref_rev_parse_rules
2339 * rule, that is replace the "%.*s" spec with a "%s" spec
2340 */
2341static void gen_scanf_fmt(char *scanf_fmt, const char *rule)
2342{
2343        char *spec;
2344
2345        spec = strstr(rule, "%.*s");
2346        if (!spec || strstr(spec + 4, "%.*s"))
2347                die("invalid rule in ref_rev_parse_rules: %s", rule);
2348
2349        /* copy all until spec */
2350        strncpy(scanf_fmt, rule, spec - rule);
2351        scanf_fmt[spec - rule] = '\0';
2352        /* copy new spec */
2353        strcat(scanf_fmt, "%s");
2354        /* copy remaining rule */
2355        strcat(scanf_fmt, spec + 4);
2356
2357        return;
2358}
2359
2360char *shorten_unambiguous_ref(const char *refname, int strict)
2361{
2362        int i;
2363        static char **scanf_fmts;
2364        static int nr_rules;
2365        char *short_name;
2366
2367        /* pre generate scanf formats from ref_rev_parse_rules[] */
2368        if (!nr_rules) {
2369                size_t total_len = 0;
2370
2371                /* the rule list is NULL terminated, count them first */
2372                for (; ref_rev_parse_rules[nr_rules]; nr_rules++)
2373                        /* no +1 because strlen("%s") < strlen("%.*s") */
2374                        total_len += strlen(ref_rev_parse_rules[nr_rules]);
2375
2376                scanf_fmts = xmalloc(nr_rules * sizeof(char *) + total_len);
2377
2378                total_len = 0;
2379                for (i = 0; i < nr_rules; i++) {
2380                        scanf_fmts[i] = (char *)&scanf_fmts[nr_rules]
2381                                        + total_len;
2382                        gen_scanf_fmt(scanf_fmts[i], ref_rev_parse_rules[i]);
2383                        total_len += strlen(ref_rev_parse_rules[i]);
2384                }
2385        }
2386
2387        /* bail out if there are no rules */
2388        if (!nr_rules)
2389                return xstrdup(refname);
2390
2391        /* buffer for scanf result, at most refname must fit */
2392        short_name = xstrdup(refname);
2393
2394        /* skip first rule, it will always match */
2395        for (i = nr_rules - 1; i > 0 ; --i) {
2396                int j;
2397                int rules_to_fail = i;
2398                int short_name_len;
2399
2400                if (1 != sscanf(refname, scanf_fmts[i], short_name))
2401                        continue;
2402
2403                short_name_len = strlen(short_name);
2404
2405                /*
2406                 * in strict mode, all (except the matched one) rules
2407                 * must fail to resolve to a valid non-ambiguous ref
2408                 */
2409                if (strict)
2410                        rules_to_fail = nr_rules;
2411
2412                /*
2413                 * check if the short name resolves to a valid ref,
2414                 * but use only rules prior to the matched one
2415                 */
2416                for (j = 0; j < rules_to_fail; j++) {
2417                        const char *rule = ref_rev_parse_rules[j];
2418                        char refname[PATH_MAX];
2419
2420                        /* skip matched rule */
2421                        if (i == j)
2422                                continue;
2423
2424                        /*
2425                         * the short name is ambiguous, if it resolves
2426                         * (with this previous rule) to a valid ref
2427                         * read_ref() returns 0 on success
2428                         */
2429                        mksnpath(refname, sizeof(refname),
2430                                 rule, short_name_len, short_name);
2431                        if (ref_exists(refname))
2432                                break;
2433                }
2434
2435                /*
2436                 * short name is non-ambiguous if all previous rules
2437                 * haven't resolved to a valid ref
2438                 */
2439                if (j == rules_to_fail)
2440                        return short_name;
2441        }
2442
2443        free(short_name);
2444        return xstrdup(refname);
2445}