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