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