6aa286fd7be6cc7e6de8194c4c37c84a474be6a2
   1/*
   2 * Builtin "git clone"
   3 *
   4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
   5 *               2008 Daniel Barkalow <barkalow@iabervon.org>
   6 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
   7 *
   8 * Clone a repository into a different directory that does not yet exist.
   9 */
  10
  11#include "builtin.h"
  12#include "lockfile.h"
  13#include "parse-options.h"
  14#include "fetch-pack.h"
  15#include "refs.h"
  16#include "tree.h"
  17#include "tree-walk.h"
  18#include "unpack-trees.h"
  19#include "transport.h"
  20#include "strbuf.h"
  21#include "dir.h"
  22#include "sigchain.h"
  23#include "branch.h"
  24#include "remote.h"
  25#include "run-command.h"
  26#include "connected.h"
  27
  28/*
  29 * Overall FIXMEs:
  30 *  - respect DB_ENVIRONMENT for .git/objects.
  31 *
  32 * Implementation notes:
  33 *  - dropping use-separate-remote and no-separate-remote compatibility
  34 *
  35 */
  36static const char * const builtin_clone_usage[] = {
  37        N_("git clone [<options>] [--] <repo> [<dir>]"),
  38        NULL
  39};
  40
  41static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
  42static int option_local = -1, option_no_hardlinks, option_shared, option_recursive;
  43static char *option_template, *option_depth;
  44static char *option_origin = NULL;
  45static char *option_branch = NULL;
  46static const char *real_git_dir;
  47static char *option_upload_pack = "git-upload-pack";
  48static int option_verbosity;
  49static int option_progress = -1;
  50static struct string_list option_config;
  51static struct string_list option_reference;
  52static int option_dissociate;
  53
  54static struct option builtin_clone_options[] = {
  55        OPT__VERBOSITY(&option_verbosity),
  56        OPT_BOOL(0, "progress", &option_progress,
  57                 N_("force progress reporting")),
  58        OPT_BOOL('n', "no-checkout", &option_no_checkout,
  59                 N_("don't create a checkout")),
  60        OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
  61        OPT_HIDDEN_BOOL(0, "naked", &option_bare,
  62                        N_("create a bare repository")),
  63        OPT_BOOL(0, "mirror", &option_mirror,
  64                 N_("create a mirror repository (implies bare)")),
  65        OPT_BOOL('l', "local", &option_local,
  66                N_("to clone from a local repository")),
  67        OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
  68                    N_("don't use local hardlinks, always copy")),
  69        OPT_BOOL('s', "shared", &option_shared,
  70                    N_("setup as shared repository")),
  71        OPT_BOOL(0, "recursive", &option_recursive,
  72                    N_("initialize submodules in the clone")),
  73        OPT_BOOL(0, "recurse-submodules", &option_recursive,
  74                    N_("initialize submodules in the clone")),
  75        OPT_STRING(0, "template", &option_template, N_("template-directory"),
  76                   N_("directory from which templates will be used")),
  77        OPT_STRING_LIST(0, "reference", &option_reference, N_("repo"),
  78                        N_("reference repository")),
  79        OPT_BOOL(0, "dissociate", &option_dissociate,
  80                 N_("use --reference only while cloning")),
  81        OPT_STRING('o', "origin", &option_origin, N_("name"),
  82                   N_("use <name> instead of 'origin' to track upstream")),
  83        OPT_STRING('b', "branch", &option_branch, N_("branch"),
  84                   N_("checkout <branch> instead of the remote's HEAD")),
  85        OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
  86                   N_("path to git-upload-pack on the remote")),
  87        OPT_STRING(0, "depth", &option_depth, N_("depth"),
  88                    N_("create a shallow clone of that depth")),
  89        OPT_BOOL(0, "single-branch", &option_single_branch,
  90                    N_("clone only one branch, HEAD or --branch")),
  91        OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
  92                   N_("separate git dir from working tree")),
  93        OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
  94                        N_("set config inside the new repository")),
  95        OPT_END()
  96};
  97
  98static const char *argv_submodule[] = {
  99        "submodule", "update", "--init", "--recursive", NULL
 100};
 101
 102static char *get_repo_path(const char *repo, int *is_bundle)
 103{
 104        static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
 105        static char *bundle_suffix[] = { ".bundle", "" };
 106        struct stat st;
 107        int i;
 108
 109        for (i = 0; i < ARRAY_SIZE(suffix); i++) {
 110                const char *path;
 111                path = mkpath("%s%s", repo, suffix[i]);
 112                if (stat(path, &st))
 113                        continue;
 114                if (S_ISDIR(st.st_mode) && is_git_directory(path)) {
 115                        *is_bundle = 0;
 116                        return xstrdup(absolute_path(path));
 117                } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
 118                        /* Is it a "gitfile"? */
 119                        char signature[8];
 120                        int len, fd = open(path, O_RDONLY);
 121                        if (fd < 0)
 122                                continue;
 123                        len = read_in_full(fd, signature, 8);
 124                        close(fd);
 125                        if (len != 8 || strncmp(signature, "gitdir: ", 8))
 126                                continue;
 127                        path = read_gitfile(path);
 128                        if (path) {
 129                                *is_bundle = 0;
 130                                return xstrdup(absolute_path(path));
 131                        }
 132                }
 133        }
 134
 135        for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
 136                const char *path;
 137                path = mkpath("%s%s", repo, bundle_suffix[i]);
 138                if (!stat(path, &st) && S_ISREG(st.st_mode)) {
 139                        *is_bundle = 1;
 140                        return xstrdup(absolute_path(path));
 141                }
 142        }
 143
 144        return NULL;
 145}
 146
 147static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
 148{
 149        const char *end = repo + strlen(repo), *start, *ptr;
 150        size_t len;
 151        char *dir;
 152
 153        /*
 154         * Skip scheme.
 155         */
 156        start = strstr(repo, "://");
 157        if (start == NULL)
 158                start = repo;
 159        else
 160                start += 3;
 161
 162        /*
 163         * Skip authentication data. The stripping does happen
 164         * greedily, such that we strip up to the last '@' inside
 165         * the host part.
 166         */
 167        for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
 168                if (*ptr == '@')
 169                        start = ptr + 1;
 170        }
 171
 172        /*
 173         * Strip trailing spaces, slashes and /.git
 174         */
 175        while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
 176                end--;
 177        if (end - start > 5 && is_dir_sep(end[-5]) &&
 178            !strncmp(end - 4, ".git", 4)) {
 179                end -= 5;
 180                while (start < end && is_dir_sep(end[-1]))
 181                        end--;
 182        }
 183
 184        /*
 185         * Find last component. To remain backwards compatible we
 186         * also regard colons as path separators, such that
 187         * cloning a repository 'foo:bar.git' would result in a
 188         * directory 'bar' being guessed.
 189         */
 190        ptr = end;
 191        while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
 192                ptr--;
 193        start = ptr;
 194
 195        /*
 196         * Strip .{bundle,git}.
 197         */
 198        len = end - start;
 199        strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
 200
 201        if (is_bare)
 202                dir = xstrfmt("%.*s.git", (int)len, start);
 203        else
 204                dir = xstrndup(start, len);
 205        /*
 206         * Replace sequences of 'control' characters and whitespace
 207         * with one ascii space, remove leading and trailing spaces.
 208         */
 209        if (*dir) {
 210                char *out = dir;
 211                int prev_space = 1 /* strip leading whitespace */;
 212                for (end = dir; *end; ++end) {
 213                        char ch = *end;
 214                        if ((unsigned char)ch < '\x20')
 215                                ch = '\x20';
 216                        if (isspace(ch)) {
 217                                if (prev_space)
 218                                        continue;
 219                                prev_space = 1;
 220                        } else
 221                                prev_space = 0;
 222                        *out++ = ch;
 223                }
 224                *out = '\0';
 225                if (out > dir && prev_space)
 226                        out[-1] = '\0';
 227        }
 228        return dir;
 229}
 230
 231static void strip_trailing_slashes(char *dir)
 232{
 233        char *end = dir + strlen(dir);
 234
 235        while (dir < end - 1 && is_dir_sep(end[-1]))
 236                end--;
 237        *end = '\0';
 238}
 239
 240static int add_one_reference(struct string_list_item *item, void *cb_data)
 241{
 242        char *ref_git;
 243        const char *repo;
 244        struct strbuf alternate = STRBUF_INIT;
 245
 246        /* Beware: read_gitfile(), real_path() and mkpath() return static buffer */
 247        ref_git = xstrdup(real_path(item->string));
 248
 249        repo = read_gitfile(ref_git);
 250        if (!repo)
 251                repo = read_gitfile(mkpath("%s/.git", ref_git));
 252        if (repo) {
 253                free(ref_git);
 254                ref_git = xstrdup(repo);
 255        }
 256
 257        if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
 258                char *ref_git_git = mkpathdup("%s/.git", ref_git);
 259                free(ref_git);
 260                ref_git = ref_git_git;
 261        } else if (!is_directory(mkpath("%s/objects", ref_git)))
 262                die(_("reference repository '%s' is not a local repository."),
 263                    item->string);
 264
 265        if (!access(mkpath("%s/shallow", ref_git), F_OK))
 266                die(_("reference repository '%s' is shallow"), item->string);
 267
 268        if (!access(mkpath("%s/info/grafts", ref_git), F_OK))
 269                die(_("reference repository '%s' is grafted"), item->string);
 270
 271        strbuf_addf(&alternate, "%s/objects", ref_git);
 272        add_to_alternates_file(alternate.buf);
 273        strbuf_release(&alternate);
 274        free(ref_git);
 275        return 0;
 276}
 277
 278static void setup_reference(void)
 279{
 280        for_each_string_list(&option_reference, add_one_reference, NULL);
 281}
 282
 283static void copy_alternates(struct strbuf *src, struct strbuf *dst,
 284                            const char *src_repo)
 285{
 286        /*
 287         * Read from the source objects/info/alternates file
 288         * and copy the entries to corresponding file in the
 289         * destination repository with add_to_alternates_file().
 290         * Both src and dst have "$path/objects/info/alternates".
 291         *
 292         * Instead of copying bit-for-bit from the original,
 293         * we need to append to existing one so that the already
 294         * created entry via "clone -s" is not lost, and also
 295         * to turn entries with paths relative to the original
 296         * absolute, so that they can be used in the new repository.
 297         */
 298        FILE *in = fopen(src->buf, "r");
 299        struct strbuf line = STRBUF_INIT;
 300
 301        while (strbuf_getline(&line, in, '\n') != EOF) {
 302                char *abs_path, abs_buf[PATH_MAX];
 303                if (!line.len || line.buf[0] == '#')
 304                        continue;
 305                if (is_absolute_path(line.buf)) {
 306                        add_to_alternates_file(line.buf);
 307                        continue;
 308                }
 309                abs_path = mkpath("%s/objects/%s", src_repo, line.buf);
 310                normalize_path_copy(abs_buf, abs_path);
 311                add_to_alternates_file(abs_buf);
 312        }
 313        strbuf_release(&line);
 314        fclose(in);
 315}
 316
 317static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
 318                                   const char *src_repo, int src_baselen)
 319{
 320        struct dirent *de;
 321        struct stat buf;
 322        int src_len, dest_len;
 323        DIR *dir;
 324
 325        dir = opendir(src->buf);
 326        if (!dir)
 327                die_errno(_("failed to open '%s'"), src->buf);
 328
 329        if (mkdir(dest->buf, 0777)) {
 330                if (errno != EEXIST)
 331                        die_errno(_("failed to create directory '%s'"), dest->buf);
 332                else if (stat(dest->buf, &buf))
 333                        die_errno(_("failed to stat '%s'"), dest->buf);
 334                else if (!S_ISDIR(buf.st_mode))
 335                        die(_("%s exists and is not a directory"), dest->buf);
 336        }
 337
 338        strbuf_addch(src, '/');
 339        src_len = src->len;
 340        strbuf_addch(dest, '/');
 341        dest_len = dest->len;
 342
 343        while ((de = readdir(dir)) != NULL) {
 344                strbuf_setlen(src, src_len);
 345                strbuf_addstr(src, de->d_name);
 346                strbuf_setlen(dest, dest_len);
 347                strbuf_addstr(dest, de->d_name);
 348                if (stat(src->buf, &buf)) {
 349                        warning (_("failed to stat %s\n"), src->buf);
 350                        continue;
 351                }
 352                if (S_ISDIR(buf.st_mode)) {
 353                        if (de->d_name[0] != '.')
 354                                copy_or_link_directory(src, dest,
 355                                                       src_repo, src_baselen);
 356                        continue;
 357                }
 358
 359                /* Files that cannot be copied bit-for-bit... */
 360                if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
 361                        copy_alternates(src, dest, src_repo);
 362                        continue;
 363                }
 364
 365                if (unlink(dest->buf) && errno != ENOENT)
 366                        die_errno(_("failed to unlink '%s'"), dest->buf);
 367                if (!option_no_hardlinks) {
 368                        if (!link(src->buf, dest->buf))
 369                                continue;
 370                        if (option_local > 0)
 371                                die_errno(_("failed to create link '%s'"), dest->buf);
 372                        option_no_hardlinks = 1;
 373                }
 374                if (copy_file_with_time(dest->buf, src->buf, 0666))
 375                        die_errno(_("failed to copy file to '%s'"), dest->buf);
 376        }
 377        closedir(dir);
 378}
 379
 380static void clone_local(const char *src_repo, const char *dest_repo)
 381{
 382        if (option_shared) {
 383                struct strbuf alt = STRBUF_INIT;
 384                strbuf_addf(&alt, "%s/objects", src_repo);
 385                add_to_alternates_file(alt.buf);
 386                strbuf_release(&alt);
 387        } else {
 388                struct strbuf src = STRBUF_INIT;
 389                struct strbuf dest = STRBUF_INIT;
 390                strbuf_addf(&src, "%s/objects", src_repo);
 391                strbuf_addf(&dest, "%s/objects", dest_repo);
 392                copy_or_link_directory(&src, &dest, src_repo, src.len);
 393                strbuf_release(&src);
 394                strbuf_release(&dest);
 395        }
 396
 397        if (0 <= option_verbosity)
 398                fprintf(stderr, _("done.\n"));
 399}
 400
 401static const char *junk_work_tree;
 402static const char *junk_git_dir;
 403static enum {
 404        JUNK_LEAVE_NONE,
 405        JUNK_LEAVE_REPO,
 406        JUNK_LEAVE_ALL
 407} junk_mode = JUNK_LEAVE_NONE;
 408
 409static const char junk_leave_repo_msg[] =
 410N_("Clone succeeded, but checkout failed.\n"
 411   "You can inspect what was checked out with 'git status'\n"
 412   "and retry the checkout with 'git checkout -f HEAD'\n");
 413
 414static void remove_junk(void)
 415{
 416        struct strbuf sb = STRBUF_INIT;
 417
 418        switch (junk_mode) {
 419        case JUNK_LEAVE_REPO:
 420                warning("%s", _(junk_leave_repo_msg));
 421                /* fall-through */
 422        case JUNK_LEAVE_ALL:
 423                return;
 424        default:
 425                /* proceed to removal */
 426                break;
 427        }
 428
 429        if (junk_git_dir) {
 430                strbuf_addstr(&sb, junk_git_dir);
 431                remove_dir_recursively(&sb, 0);
 432                strbuf_reset(&sb);
 433        }
 434        if (junk_work_tree) {
 435                strbuf_addstr(&sb, junk_work_tree);
 436                remove_dir_recursively(&sb, 0);
 437                strbuf_reset(&sb);
 438        }
 439}
 440
 441static void remove_junk_on_signal(int signo)
 442{
 443        remove_junk();
 444        sigchain_pop(signo);
 445        raise(signo);
 446}
 447
 448static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
 449{
 450        struct ref *ref;
 451        struct strbuf head = STRBUF_INIT;
 452        strbuf_addstr(&head, "refs/heads/");
 453        strbuf_addstr(&head, branch);
 454        ref = find_ref_by_name(refs, head.buf);
 455        strbuf_release(&head);
 456
 457        if (ref)
 458                return ref;
 459
 460        strbuf_addstr(&head, "refs/tags/");
 461        strbuf_addstr(&head, branch);
 462        ref = find_ref_by_name(refs, head.buf);
 463        strbuf_release(&head);
 464
 465        return ref;
 466}
 467
 468static struct ref *wanted_peer_refs(const struct ref *refs,
 469                struct refspec *refspec)
 470{
 471        struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
 472        struct ref *local_refs = head;
 473        struct ref **tail = head ? &head->next : &local_refs;
 474
 475        if (option_single_branch) {
 476                struct ref *remote_head = NULL;
 477
 478                if (!option_branch)
 479                        remote_head = guess_remote_head(head, refs, 0);
 480                else {
 481                        local_refs = NULL;
 482                        tail = &local_refs;
 483                        remote_head = copy_ref(find_remote_branch(refs, option_branch));
 484                }
 485
 486                if (!remote_head && option_branch)
 487                        warning(_("Could not find remote branch %s to clone."),
 488                                option_branch);
 489                else {
 490                        get_fetch_map(remote_head, refspec, &tail, 0);
 491
 492                        /* if --branch=tag, pull the requested tag explicitly */
 493                        get_fetch_map(remote_head, tag_refspec, &tail, 0);
 494                }
 495        } else
 496                get_fetch_map(refs, refspec, &tail, 0);
 497
 498        if (!option_mirror && !option_single_branch)
 499                get_fetch_map(refs, tag_refspec, &tail, 0);
 500
 501        return local_refs;
 502}
 503
 504static void write_remote_refs(const struct ref *local_refs)
 505{
 506        const struct ref *r;
 507
 508        lock_packed_refs(LOCK_DIE_ON_ERROR);
 509
 510        for (r = local_refs; r; r = r->next) {
 511                if (!r->peer_ref)
 512                        continue;
 513                add_packed_ref(r->peer_ref->name, r->old_sha1);
 514        }
 515
 516        if (commit_packed_refs())
 517                die_errno("unable to overwrite old ref-pack file");
 518}
 519
 520static void write_followtags(const struct ref *refs, const char *msg)
 521{
 522        const struct ref *ref;
 523        for (ref = refs; ref; ref = ref->next) {
 524                if (!starts_with(ref->name, "refs/tags/"))
 525                        continue;
 526                if (ends_with(ref->name, "^{}"))
 527                        continue;
 528                if (!has_sha1_file(ref->old_sha1))
 529                        continue;
 530                update_ref(msg, ref->name, ref->old_sha1,
 531                           NULL, 0, UPDATE_REFS_DIE_ON_ERR);
 532        }
 533}
 534
 535static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
 536{
 537        struct ref **rm = cb_data;
 538        struct ref *ref = *rm;
 539
 540        /*
 541         * Skip anything missing a peer_ref, which we are not
 542         * actually going to write a ref for.
 543         */
 544        while (ref && !ref->peer_ref)
 545                ref = ref->next;
 546        /* Returning -1 notes "end of list" to the caller. */
 547        if (!ref)
 548                return -1;
 549
 550        hashcpy(sha1, ref->old_sha1);
 551        *rm = ref->next;
 552        return 0;
 553}
 554
 555static void update_remote_refs(const struct ref *refs,
 556                               const struct ref *mapped_refs,
 557                               const struct ref *remote_head_points_at,
 558                               const char *branch_top,
 559                               const char *msg,
 560                               struct transport *transport,
 561                               int check_connectivity)
 562{
 563        const struct ref *rm = mapped_refs;
 564
 565        if (check_connectivity) {
 566                if (transport->progress)
 567                        fprintf(stderr, _("Checking connectivity... "));
 568                if (check_everything_connected_with_transport(iterate_ref_map,
 569                                                              0, &rm, transport))
 570                        die(_("remote did not send all necessary objects"));
 571                if (transport->progress)
 572                        fprintf(stderr, _("done.\n"));
 573        }
 574
 575        if (refs) {
 576                write_remote_refs(mapped_refs);
 577                if (option_single_branch)
 578                        write_followtags(refs, msg);
 579        }
 580
 581        if (remote_head_points_at && !option_bare) {
 582                struct strbuf head_ref = STRBUF_INIT;
 583                strbuf_addstr(&head_ref, branch_top);
 584                strbuf_addstr(&head_ref, "HEAD");
 585                create_symref(head_ref.buf,
 586                              remote_head_points_at->peer_ref->name,
 587                              msg);
 588        }
 589}
 590
 591static void update_head(const struct ref *our, const struct ref *remote,
 592                        const char *msg)
 593{
 594        const char *head;
 595        if (our && skip_prefix(our->name, "refs/heads/", &head)) {
 596                /* Local default branch link */
 597                create_symref("HEAD", our->name, NULL);
 598                if (!option_bare) {
 599                        update_ref(msg, "HEAD", our->old_sha1, NULL, 0,
 600                                   UPDATE_REFS_DIE_ON_ERR);
 601                        install_branch_config(0, head, option_origin, our->name);
 602                }
 603        } else if (our) {
 604                struct commit *c = lookup_commit_reference(our->old_sha1);
 605                /* --branch specifies a non-branch (i.e. tags), detach HEAD */
 606                update_ref(msg, "HEAD", c->object.sha1,
 607                           NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
 608        } else if (remote) {
 609                /*
 610                 * We know remote HEAD points to a non-branch, or
 611                 * HEAD points to a branch but we don't know which one.
 612                 * Detach HEAD in all these cases.
 613                 */
 614                update_ref(msg, "HEAD", remote->old_sha1,
 615                           NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
 616        }
 617}
 618
 619static int checkout(void)
 620{
 621        unsigned char sha1[20];
 622        char *head;
 623        struct lock_file *lock_file;
 624        struct unpack_trees_options opts;
 625        struct tree *tree;
 626        struct tree_desc t;
 627        int err = 0;
 628
 629        if (option_no_checkout)
 630                return 0;
 631
 632        head = resolve_refdup("HEAD", RESOLVE_REF_READING, sha1, NULL);
 633        if (!head) {
 634                warning(_("remote HEAD refers to nonexistent ref, "
 635                          "unable to checkout.\n"));
 636                return 0;
 637        }
 638        if (!strcmp(head, "HEAD")) {
 639                if (advice_detached_head)
 640                        detach_advice(sha1_to_hex(sha1));
 641        } else {
 642                if (!starts_with(head, "refs/heads/"))
 643                        die(_("HEAD not found below refs/heads!"));
 644        }
 645        free(head);
 646
 647        /* We need to be in the new work tree for the checkout */
 648        setup_work_tree();
 649
 650        lock_file = xcalloc(1, sizeof(struct lock_file));
 651        hold_locked_index(lock_file, 1);
 652
 653        memset(&opts, 0, sizeof opts);
 654        opts.update = 1;
 655        opts.merge = 1;
 656        opts.fn = oneway_merge;
 657        opts.verbose_update = (option_verbosity >= 0);
 658        opts.src_index = &the_index;
 659        opts.dst_index = &the_index;
 660
 661        tree = parse_tree_indirect(sha1);
 662        parse_tree(tree);
 663        init_tree_desc(&t, tree->buffer, tree->size);
 664        if (unpack_trees(1, &t, &opts) < 0)
 665                die(_("unable to checkout working tree"));
 666
 667        if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
 668                die(_("unable to write new index file"));
 669
 670        err |= run_hook_le(NULL, "post-checkout", sha1_to_hex(null_sha1),
 671                           sha1_to_hex(sha1), "1", NULL);
 672
 673        if (!err && option_recursive)
 674                err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
 675
 676        return err;
 677}
 678
 679static int write_one_config(const char *key, const char *value, void *data)
 680{
 681        return git_config_set_multivar(key, value ? value : "true", "^$", 0);
 682}
 683
 684static void write_config(struct string_list *config)
 685{
 686        int i;
 687
 688        for (i = 0; i < config->nr; i++) {
 689                if (git_config_parse_parameter(config->items[i].string,
 690                                               write_one_config, NULL) < 0)
 691                        die("unable to write parameters to config file");
 692        }
 693}
 694
 695static void write_refspec_config(const char *src_ref_prefix,
 696                const struct ref *our_head_points_at,
 697                const struct ref *remote_head_points_at,
 698                struct strbuf *branch_top)
 699{
 700        struct strbuf key = STRBUF_INIT;
 701        struct strbuf value = STRBUF_INIT;
 702
 703        if (option_mirror || !option_bare) {
 704                if (option_single_branch && !option_mirror) {
 705                        if (option_branch) {
 706                                if (starts_with(our_head_points_at->name, "refs/tags/"))
 707                                        strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
 708                                                our_head_points_at->name);
 709                                else
 710                                        strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
 711                                                branch_top->buf, option_branch);
 712                        } else if (remote_head_points_at) {
 713                                const char *head = remote_head_points_at->name;
 714                                if (!skip_prefix(head, "refs/heads/", &head))
 715                                        die("BUG: remote HEAD points at non-head?");
 716
 717                                strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
 718                                                branch_top->buf, head);
 719                        }
 720                        /*
 721                         * otherwise, the next "git fetch" will
 722                         * simply fetch from HEAD without updating
 723                         * any remote-tracking branch, which is what
 724                         * we want.
 725                         */
 726                } else {
 727                        strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
 728                }
 729                /* Configure the remote */
 730                if (value.len) {
 731                        strbuf_addf(&key, "remote.%s.fetch", option_origin);
 732                        git_config_set_multivar(key.buf, value.buf, "^$", 0);
 733                        strbuf_reset(&key);
 734
 735                        if (option_mirror) {
 736                                strbuf_addf(&key, "remote.%s.mirror", option_origin);
 737                                git_config_set(key.buf, "true");
 738                                strbuf_reset(&key);
 739                        }
 740                }
 741        }
 742
 743        strbuf_release(&key);
 744        strbuf_release(&value);
 745}
 746
 747static void dissociate_from_references(void)
 748{
 749        static const char* argv[] = { "repack", "-a", "-d", NULL };
 750
 751        if (run_command_v_opt(argv, RUN_GIT_CMD|RUN_COMMAND_NO_STDIN))
 752                die(_("cannot repack to clean up"));
 753        if (unlink(git_path("objects/info/alternates")) && errno != ENOENT)
 754                die_errno(_("cannot unlink temporary alternates file"));
 755}
 756
 757int cmd_clone(int argc, const char **argv, const char *prefix)
 758{
 759        int is_bundle = 0, is_local;
 760        struct stat buf;
 761        const char *repo_name, *repo, *work_tree, *git_dir;
 762        char *path, *dir;
 763        int dest_exists;
 764        const struct ref *refs, *remote_head;
 765        const struct ref *remote_head_points_at;
 766        const struct ref *our_head_points_at;
 767        struct ref *mapped_refs;
 768        const struct ref *ref;
 769        struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
 770        struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
 771        struct transport *transport = NULL;
 772        const char *src_ref_prefix = "refs/heads/";
 773        struct remote *remote;
 774        int err = 0, complete_refs_before_fetch = 1;
 775
 776        struct refspec *refspec;
 777        const char *fetch_pattern;
 778
 779        packet_trace_identity("clone");
 780        argc = parse_options(argc, argv, prefix, builtin_clone_options,
 781                             builtin_clone_usage, 0);
 782
 783        if (argc > 2)
 784                usage_msg_opt(_("Too many arguments."),
 785                        builtin_clone_usage, builtin_clone_options);
 786
 787        if (argc == 0)
 788                usage_msg_opt(_("You must specify a repository to clone."),
 789                        builtin_clone_usage, builtin_clone_options);
 790
 791        if (option_single_branch == -1)
 792                option_single_branch = option_depth ? 1 : 0;
 793
 794        if (option_mirror)
 795                option_bare = 1;
 796
 797        if (option_bare) {
 798                if (option_origin)
 799                        die(_("--bare and --origin %s options are incompatible."),
 800                            option_origin);
 801                if (real_git_dir)
 802                        die(_("--bare and --separate-git-dir are incompatible."));
 803                option_no_checkout = 1;
 804        }
 805
 806        if (!option_origin)
 807                option_origin = "origin";
 808
 809        repo_name = argv[0];
 810
 811        path = get_repo_path(repo_name, &is_bundle);
 812        if (path)
 813                repo = xstrdup(absolute_path(repo_name));
 814        else if (!strchr(repo_name, ':'))
 815                die(_("repository '%s' does not exist"), repo_name);
 816        else
 817                repo = repo_name;
 818
 819        /* no need to be strict, transport_set_option() will validate it again */
 820        if (option_depth && atoi(option_depth) < 1)
 821                die(_("depth %s is not a positive number"), option_depth);
 822
 823        if (argc == 2)
 824                dir = xstrdup(argv[1]);
 825        else
 826                dir = guess_dir_name(repo_name, is_bundle, option_bare);
 827        strip_trailing_slashes(dir);
 828
 829        dest_exists = !stat(dir, &buf);
 830        if (dest_exists && !is_empty_dir(dir))
 831                die(_("destination path '%s' already exists and is not "
 832                        "an empty directory."), dir);
 833
 834        strbuf_addf(&reflog_msg, "clone: from %s", repo);
 835
 836        if (option_bare)
 837                work_tree = NULL;
 838        else {
 839                work_tree = getenv("GIT_WORK_TREE");
 840                if (work_tree && !stat(work_tree, &buf))
 841                        die(_("working tree '%s' already exists."), work_tree);
 842        }
 843
 844        if (option_bare || work_tree)
 845                git_dir = xstrdup(dir);
 846        else {
 847                work_tree = dir;
 848                git_dir = mkpathdup("%s/.git", dir);
 849        }
 850
 851        atexit(remove_junk);
 852        sigchain_push_common(remove_junk_on_signal);
 853
 854        if (!option_bare) {
 855                if (safe_create_leading_directories_const(work_tree) < 0)
 856                        die_errno(_("could not create leading directories of '%s'"),
 857                                  work_tree);
 858                if (!dest_exists && mkdir(work_tree, 0777))
 859                        die_errno(_("could not create work tree dir '%s'"),
 860                                  work_tree);
 861                junk_work_tree = work_tree;
 862                set_git_work_tree(work_tree);
 863        }
 864
 865        junk_git_dir = git_dir;
 866        if (safe_create_leading_directories_const(git_dir) < 0)
 867                die(_("could not create leading directories of '%s'"), git_dir);
 868
 869        set_git_dir_init(git_dir, real_git_dir, 0);
 870        if (real_git_dir) {
 871                git_dir = real_git_dir;
 872                junk_git_dir = real_git_dir;
 873        }
 874
 875        if (0 <= option_verbosity) {
 876                if (option_bare)
 877                        fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
 878                else
 879                        fprintf(stderr, _("Cloning into '%s'...\n"), dir);
 880        }
 881        init_db(option_template, INIT_DB_QUIET);
 882        write_config(&option_config);
 883
 884        git_config(git_default_config, NULL);
 885
 886        if (option_bare) {
 887                if (option_mirror)
 888                        src_ref_prefix = "refs/";
 889                strbuf_addstr(&branch_top, src_ref_prefix);
 890
 891                git_config_set("core.bare", "true");
 892        } else {
 893                strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
 894        }
 895
 896        strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
 897        strbuf_addf(&key, "remote.%s.url", option_origin);
 898        git_config_set(key.buf, repo);
 899        strbuf_reset(&key);
 900
 901        if (option_reference.nr)
 902                setup_reference();
 903        else if (option_dissociate) {
 904                warning(_("--dissociate given, but there is no --reference"));
 905                option_dissociate = 0;
 906        }
 907
 908        fetch_pattern = value.buf;
 909        refspec = parse_fetch_refspec(1, &fetch_pattern);
 910
 911        strbuf_reset(&value);
 912
 913        remote = remote_get(option_origin);
 914        transport = transport_get(remote, remote->url[0]);
 915        transport_set_verbosity(transport, option_verbosity, option_progress);
 916
 917        path = get_repo_path(remote->url[0], &is_bundle);
 918        is_local = option_local != 0 && path && !is_bundle;
 919        if (is_local) {
 920                if (option_depth)
 921                        warning(_("--depth is ignored in local clones; use file:// instead."));
 922                if (!access(mkpath("%s/shallow", path), F_OK)) {
 923                        if (option_local > 0)
 924                                warning(_("source repository is shallow, ignoring --local"));
 925                        is_local = 0;
 926                }
 927        }
 928        if (option_local > 0 && !is_local)
 929                warning(_("--local is ignored"));
 930        transport->cloning = 1;
 931
 932        if (!transport->get_refs_list || (!is_local && !transport->fetch))
 933                die(_("Don't know how to clone %s"), transport->url);
 934
 935        transport_set_option(transport, TRANS_OPT_KEEP, "yes");
 936
 937        if (option_depth)
 938                transport_set_option(transport, TRANS_OPT_DEPTH,
 939                                     option_depth);
 940        if (option_single_branch)
 941                transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
 942
 943        if (option_upload_pack)
 944                transport_set_option(transport, TRANS_OPT_UPLOADPACK,
 945                                     option_upload_pack);
 946
 947        if (transport->smart_options && !option_depth)
 948                transport->smart_options->check_self_contained_and_connected = 1;
 949
 950        refs = transport_get_remote_refs(transport);
 951
 952        if (refs) {
 953                mapped_refs = wanted_peer_refs(refs, refspec);
 954                /*
 955                 * transport_get_remote_refs() may return refs with null sha-1
 956                 * in mapped_refs (see struct transport->get_refs_list
 957                 * comment). In that case we need fetch it early because
 958                 * remote_head code below relies on it.
 959                 *
 960                 * for normal clones, transport_get_remote_refs() should
 961                 * return reliable ref set, we can delay cloning until after
 962                 * remote HEAD check.
 963                 */
 964                for (ref = refs; ref; ref = ref->next)
 965                        if (is_null_sha1(ref->old_sha1)) {
 966                                complete_refs_before_fetch = 0;
 967                                break;
 968                        }
 969
 970                if (!is_local && !complete_refs_before_fetch)
 971                        transport_fetch_refs(transport, mapped_refs);
 972
 973                remote_head = find_ref_by_name(refs, "HEAD");
 974                remote_head_points_at =
 975                        guess_remote_head(remote_head, mapped_refs, 0);
 976
 977                if (option_branch) {
 978                        our_head_points_at =
 979                                find_remote_branch(mapped_refs, option_branch);
 980
 981                        if (!our_head_points_at)
 982                                die(_("Remote branch %s not found in upstream %s"),
 983                                    option_branch, option_origin);
 984                }
 985                else
 986                        our_head_points_at = remote_head_points_at;
 987        }
 988        else {
 989                if (option_branch)
 990                        die(_("Remote branch %s not found in upstream %s"),
 991                                        option_branch, option_origin);
 992
 993                warning(_("You appear to have cloned an empty repository."));
 994                mapped_refs = NULL;
 995                our_head_points_at = NULL;
 996                remote_head_points_at = NULL;
 997                remote_head = NULL;
 998                option_no_checkout = 1;
 999                if (!option_bare)
1000                        install_branch_config(0, "master", option_origin,
1001                                              "refs/heads/master");
1002        }
1003
1004        write_refspec_config(src_ref_prefix, our_head_points_at,
1005                        remote_head_points_at, &branch_top);
1006
1007        if (is_local)
1008                clone_local(path, git_dir);
1009        else if (refs && complete_refs_before_fetch)
1010                transport_fetch_refs(transport, mapped_refs);
1011
1012        update_remote_refs(refs, mapped_refs, remote_head_points_at,
1013                           branch_top.buf, reflog_msg.buf, transport, !is_local);
1014
1015        update_head(our_head_points_at, remote_head, reflog_msg.buf);
1016
1017        transport_unlock_pack(transport);
1018        transport_disconnect(transport);
1019
1020        if (option_dissociate)
1021                dissociate_from_references();
1022
1023        junk_mode = JUNK_LEAVE_REPO;
1024        err = checkout();
1025
1026        strbuf_release(&reflog_msg);
1027        strbuf_release(&branch_top);
1028        strbuf_release(&key);
1029        strbuf_release(&value);
1030        junk_mode = JUNK_LEAVE_ALL;
1031
1032        free(refspec);
1033        return err;
1034}