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