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