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