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