builtin-clone.con commit Merge branch 'jc/maint-1.6.0-read-tree-overlay' (7d4e3a7)
   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 "cache.h"
  12#include "parse-options.h"
  13#include "fetch-pack.h"
  14#include "refs.h"
  15#include "tree.h"
  16#include "tree-walk.h"
  17#include "unpack-trees.h"
  18#include "transport.h"
  19#include "strbuf.h"
  20#include "dir.h"
  21#include "pack-refs.h"
  22#include "sigchain.h"
  23#include "remote.h"
  24#include "run-command.h"
  25
  26/*
  27 * Overall FIXMEs:
  28 *  - respect DB_ENVIRONMENT for .git/objects.
  29 *
  30 * Implementation notes:
  31 *  - dropping use-separate-remote and no-separate-remote compatibility
  32 *
  33 */
  34static const char * const builtin_clone_usage[] = {
  35        "git clone [options] [--] <repo> [<dir>]",
  36        NULL
  37};
  38
  39static int option_quiet, option_no_checkout, option_bare, option_mirror;
  40static int option_local, option_no_hardlinks, option_shared;
  41static char *option_template, *option_reference, *option_depth;
  42static char *option_origin = NULL;
  43static char *option_upload_pack = "git-upload-pack";
  44static int option_verbose;
  45
  46static struct option builtin_clone_options[] = {
  47        OPT__QUIET(&option_quiet),
  48        OPT__VERBOSE(&option_verbose),
  49        OPT_BOOLEAN('n', "no-checkout", &option_no_checkout,
  50                    "don't create a checkout"),
  51        OPT_BOOLEAN(0, "bare", &option_bare, "create a bare repository"),
  52        OPT_BOOLEAN(0, "naked", &option_bare, "create a bare repository"),
  53        OPT_BOOLEAN(0, "mirror", &option_mirror,
  54                    "create a mirror repository (implies bare)"),
  55        OPT_BOOLEAN('l', "local", &option_local,
  56                    "to clone from a local repository"),
  57        OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks,
  58                    "don't use local hardlinks, always copy"),
  59        OPT_BOOLEAN('s', "shared", &option_shared,
  60                    "setup as shared repository"),
  61        OPT_STRING(0, "template", &option_template, "path",
  62                   "path the template repository"),
  63        OPT_STRING(0, "reference", &option_reference, "repo",
  64                   "reference repository"),
  65        OPT_STRING('o', "origin", &option_origin, "branch",
  66                   "use <branch> instead of 'origin' to track upstream"),
  67        OPT_STRING('u', "upload-pack", &option_upload_pack, "path",
  68                   "path to git-upload-pack on the remote"),
  69        OPT_STRING(0, "depth", &option_depth, "depth",
  70                    "create a shallow clone of that depth"),
  71
  72        OPT_END()
  73};
  74
  75static char *get_repo_path(const char *repo, int *is_bundle)
  76{
  77        static char *suffix[] = { "/.git", ".git", "" };
  78        static char *bundle_suffix[] = { ".bundle", "" };
  79        struct stat st;
  80        int i;
  81
  82        for (i = 0; i < ARRAY_SIZE(suffix); i++) {
  83                const char *path;
  84                path = mkpath("%s%s", repo, suffix[i]);
  85                if (is_directory(path)) {
  86                        *is_bundle = 0;
  87                        return xstrdup(make_nonrelative_path(path));
  88                }
  89        }
  90
  91        for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
  92                const char *path;
  93                path = mkpath("%s%s", repo, bundle_suffix[i]);
  94                if (!stat(path, &st) && S_ISREG(st.st_mode)) {
  95                        *is_bundle = 1;
  96                        return xstrdup(make_nonrelative_path(path));
  97                }
  98        }
  99
 100        return NULL;
 101}
 102
 103static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
 104{
 105        const char *end = repo + strlen(repo), *start;
 106
 107        /*
 108         * Strip trailing slashes and /.git
 109         */
 110        while (repo < end && is_dir_sep(end[-1]))
 111                end--;
 112        if (end - repo > 5 && is_dir_sep(end[-5]) &&
 113            !strncmp(end - 4, ".git", 4)) {
 114                end -= 5;
 115                while (repo < end && is_dir_sep(end[-1]))
 116                        end--;
 117        }
 118
 119        /*
 120         * Find last component, but be prepared that repo could have
 121         * the form  "remote.example.com:foo.git", i.e. no slash
 122         * in the directory part.
 123         */
 124        start = end;
 125        while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
 126                start--;
 127
 128        /*
 129         * Strip .{bundle,git}.
 130         */
 131        if (is_bundle) {
 132                if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
 133                        end -= 7;
 134        } else {
 135                if (end - start > 4 && !strncmp(end - 4, ".git", 4))
 136                        end -= 4;
 137        }
 138
 139        if (is_bare) {
 140                struct strbuf result = STRBUF_INIT;
 141                strbuf_addf(&result, "%.*s.git", (int)(end - start), start);
 142                return strbuf_detach(&result, 0);
 143        }
 144
 145        return xstrndup(start, end - start);
 146}
 147
 148static void strip_trailing_slashes(char *dir)
 149{
 150        char *end = dir + strlen(dir);
 151
 152        while (dir < end - 1 && is_dir_sep(end[-1]))
 153                end--;
 154        *end = '\0';
 155}
 156
 157static void setup_reference(const char *repo)
 158{
 159        const char *ref_git;
 160        char *ref_git_copy;
 161
 162        struct remote *remote;
 163        struct transport *transport;
 164        const struct ref *extra;
 165
 166        ref_git = make_absolute_path(option_reference);
 167
 168        if (is_directory(mkpath("%s/.git/objects", ref_git)))
 169                ref_git = mkpath("%s/.git", ref_git);
 170        else if (!is_directory(mkpath("%s/objects", ref_git)))
 171                die("reference repository '%s' is not a local directory.",
 172                    option_reference);
 173
 174        ref_git_copy = xstrdup(ref_git);
 175
 176        add_to_alternates_file(ref_git_copy);
 177
 178        remote = remote_get(ref_git_copy);
 179        transport = transport_get(remote, ref_git_copy);
 180        for (extra = transport_get_remote_refs(transport); extra;
 181             extra = extra->next)
 182                add_extra_ref(extra->name, extra->old_sha1, 0);
 183
 184        transport_disconnect(transport);
 185
 186        free(ref_git_copy);
 187}
 188
 189static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest)
 190{
 191        struct dirent *de;
 192        struct stat buf;
 193        int src_len, dest_len;
 194        DIR *dir;
 195
 196        dir = opendir(src->buf);
 197        if (!dir)
 198                die("failed to open %s", src->buf);
 199
 200        if (mkdir(dest->buf, 0777)) {
 201                if (errno != EEXIST)
 202                        die("failed to create directory %s", dest->buf);
 203                else if (stat(dest->buf, &buf))
 204                        die("failed to stat %s", dest->buf);
 205                else if (!S_ISDIR(buf.st_mode))
 206                        die("%s exists and is not a directory", dest->buf);
 207        }
 208
 209        strbuf_addch(src, '/');
 210        src_len = src->len;
 211        strbuf_addch(dest, '/');
 212        dest_len = dest->len;
 213
 214        while ((de = readdir(dir)) != NULL) {
 215                strbuf_setlen(src, src_len);
 216                strbuf_addstr(src, de->d_name);
 217                strbuf_setlen(dest, dest_len);
 218                strbuf_addstr(dest, de->d_name);
 219                if (stat(src->buf, &buf)) {
 220                        warning ("failed to stat %s\n", src->buf);
 221                        continue;
 222                }
 223                if (S_ISDIR(buf.st_mode)) {
 224                        if (de->d_name[0] != '.')
 225                                copy_or_link_directory(src, dest);
 226                        continue;
 227                }
 228
 229                if (unlink(dest->buf) && errno != ENOENT)
 230                        die("failed to unlink %s", dest->buf);
 231                if (!option_no_hardlinks) {
 232                        if (!link(src->buf, dest->buf))
 233                                continue;
 234                        if (option_local)
 235                                die("failed to create link %s", dest->buf);
 236                        option_no_hardlinks = 1;
 237                }
 238                if (copy_file(dest->buf, src->buf, 0666))
 239                        die("failed to copy file to %s", dest->buf);
 240        }
 241        closedir(dir);
 242}
 243
 244static const struct ref *clone_local(const char *src_repo,
 245                                     const char *dest_repo)
 246{
 247        const struct ref *ret;
 248        struct strbuf src = STRBUF_INIT;
 249        struct strbuf dest = STRBUF_INIT;
 250        struct remote *remote;
 251        struct transport *transport;
 252
 253        if (option_shared)
 254                add_to_alternates_file(src_repo);
 255        else {
 256                strbuf_addf(&src, "%s/objects", src_repo);
 257                strbuf_addf(&dest, "%s/objects", dest_repo);
 258                copy_or_link_directory(&src, &dest);
 259                strbuf_release(&src);
 260                strbuf_release(&dest);
 261        }
 262
 263        remote = remote_get(src_repo);
 264        transport = transport_get(remote, src_repo);
 265        ret = transport_get_remote_refs(transport);
 266        transport_disconnect(transport);
 267        return ret;
 268}
 269
 270static const char *junk_work_tree;
 271static const char *junk_git_dir;
 272pid_t junk_pid;
 273
 274static void remove_junk(void)
 275{
 276        struct strbuf sb = STRBUF_INIT;
 277        if (getpid() != junk_pid)
 278                return;
 279        if (junk_git_dir) {
 280                strbuf_addstr(&sb, junk_git_dir);
 281                remove_dir_recursively(&sb, 0);
 282                strbuf_reset(&sb);
 283        }
 284        if (junk_work_tree) {
 285                strbuf_addstr(&sb, junk_work_tree);
 286                remove_dir_recursively(&sb, 0);
 287                strbuf_reset(&sb);
 288        }
 289}
 290
 291static void remove_junk_on_signal(int signo)
 292{
 293        remove_junk();
 294        sigchain_pop(signo);
 295        raise(signo);
 296}
 297
 298static struct ref *write_remote_refs(const struct ref *refs,
 299                struct refspec *refspec, const char *reflog)
 300{
 301        struct ref *local_refs = NULL;
 302        struct ref **tail = &local_refs;
 303        struct ref *r;
 304
 305        get_fetch_map(refs, refspec, &tail, 0);
 306        if (!option_mirror)
 307                get_fetch_map(refs, tag_refspec, &tail, 0);
 308
 309        for (r = local_refs; r; r = r->next)
 310                add_extra_ref(r->peer_ref->name, r->old_sha1, 0);
 311
 312        pack_refs(PACK_REFS_ALL);
 313        clear_extra_refs();
 314
 315        return local_refs;
 316}
 317
 318static void install_branch_config(const char *local,
 319                                  const char *origin,
 320                                  const char *remote)
 321{
 322        struct strbuf key = STRBUF_INIT;
 323        strbuf_addf(&key, "branch.%s.remote", local);
 324        git_config_set(key.buf, origin);
 325        strbuf_reset(&key);
 326        strbuf_addf(&key, "branch.%s.merge", local);
 327        git_config_set(key.buf, remote);
 328        strbuf_release(&key);
 329}
 330
 331int cmd_clone(int argc, const char **argv, const char *prefix)
 332{
 333        int is_bundle = 0;
 334        struct stat buf;
 335        const char *repo_name, *repo, *work_tree, *git_dir;
 336        char *path, *dir;
 337        int dest_exists;
 338        const struct ref *refs, *head_points_at, *remote_head, *mapped_refs;
 339        struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
 340        struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
 341        struct transport *transport = NULL;
 342        char *src_ref_prefix = "refs/heads/";
 343        int err = 0;
 344
 345        struct refspec refspec;
 346
 347        junk_pid = getpid();
 348
 349        argc = parse_options(argc, argv, builtin_clone_options,
 350                             builtin_clone_usage, 0);
 351
 352        if (argc == 0)
 353                die("You must specify a repository to clone.");
 354
 355        if (option_mirror)
 356                option_bare = 1;
 357
 358        if (option_bare) {
 359                if (option_origin)
 360                        die("--bare and --origin %s options are incompatible.",
 361                            option_origin);
 362                option_no_checkout = 1;
 363        }
 364
 365        if (!option_origin)
 366                option_origin = "origin";
 367
 368        repo_name = argv[0];
 369
 370        path = get_repo_path(repo_name, &is_bundle);
 371        if (path)
 372                repo = xstrdup(make_nonrelative_path(repo_name));
 373        else if (!strchr(repo_name, ':'))
 374                repo = xstrdup(make_absolute_path(repo_name));
 375        else
 376                repo = repo_name;
 377
 378        if (argc == 2)
 379                dir = xstrdup(argv[1]);
 380        else
 381                dir = guess_dir_name(repo_name, is_bundle, option_bare);
 382        strip_trailing_slashes(dir);
 383
 384        dest_exists = !stat(dir, &buf);
 385        if (dest_exists && !is_empty_dir(dir))
 386                die("destination path '%s' already exists and is not "
 387                        "an empty directory.", dir);
 388
 389        strbuf_addf(&reflog_msg, "clone: from %s", repo);
 390
 391        if (option_bare)
 392                work_tree = NULL;
 393        else {
 394                work_tree = getenv("GIT_WORK_TREE");
 395                if (work_tree && !stat(work_tree, &buf))
 396                        die("working tree '%s' already exists.", work_tree);
 397        }
 398
 399        if (option_bare || work_tree)
 400                git_dir = xstrdup(dir);
 401        else {
 402                work_tree = dir;
 403                git_dir = xstrdup(mkpath("%s/.git", dir));
 404        }
 405
 406        if (!option_bare) {
 407                junk_work_tree = work_tree;
 408                if (safe_create_leading_directories_const(work_tree) < 0)
 409                        die("could not create leading directories of '%s': %s",
 410                                        work_tree, strerror(errno));
 411                if (!dest_exists && mkdir(work_tree, 0755))
 412                        die("could not create work tree dir '%s': %s.",
 413                                        work_tree, strerror(errno));
 414                set_git_work_tree(work_tree);
 415        }
 416        junk_git_dir = git_dir;
 417        atexit(remove_junk);
 418        sigchain_push_common(remove_junk_on_signal);
 419
 420        setenv(CONFIG_ENVIRONMENT, xstrdup(mkpath("%s/config", git_dir)), 1);
 421
 422        if (safe_create_leading_directories_const(git_dir) < 0)
 423                die("could not create leading directories of '%s'", git_dir);
 424        set_git_dir(make_absolute_path(git_dir));
 425
 426        init_db(option_template, option_quiet ? INIT_DB_QUIET : 0);
 427
 428        /*
 429         * At this point, the config exists, so we do not need the
 430         * environment variable.  We actually need to unset it, too, to
 431         * re-enable parsing of the global configs.
 432         */
 433        unsetenv(CONFIG_ENVIRONMENT);
 434
 435        if (option_reference)
 436                setup_reference(git_dir);
 437
 438        git_config(git_default_config, NULL);
 439
 440        if (option_bare) {
 441                if (option_mirror)
 442                        src_ref_prefix = "refs/";
 443                strbuf_addstr(&branch_top, src_ref_prefix);
 444
 445                git_config_set("core.bare", "true");
 446        } else {
 447                strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
 448        }
 449
 450        if (option_mirror || !option_bare) {
 451                /* Configure the remote */
 452                if (option_mirror) {
 453                        strbuf_addf(&key, "remote.%s.mirror", option_origin);
 454                        git_config_set(key.buf, "true");
 455                        strbuf_reset(&key);
 456                }
 457
 458                strbuf_addf(&key, "remote.%s.url", option_origin);
 459                git_config_set(key.buf, repo);
 460                        strbuf_reset(&key);
 461
 462                strbuf_addf(&key, "remote.%s.fetch", option_origin);
 463                strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
 464                git_config_set_multivar(key.buf, value.buf, "^$", 0);
 465                strbuf_reset(&key);
 466                strbuf_reset(&value);
 467        }
 468
 469        refspec.force = 0;
 470        refspec.pattern = 1;
 471        refspec.src = src_ref_prefix;
 472        refspec.dst = branch_top.buf;
 473
 474        if (path && !is_bundle)
 475                refs = clone_local(path, git_dir);
 476        else {
 477                struct remote *remote = remote_get(argv[0]);
 478                transport = transport_get(remote, remote->url[0]);
 479
 480                if (!transport->get_refs_list || !transport->fetch)
 481                        die("Don't know how to clone %s", transport->url);
 482
 483                transport_set_option(transport, TRANS_OPT_KEEP, "yes");
 484
 485                if (option_depth)
 486                        transport_set_option(transport, TRANS_OPT_DEPTH,
 487                                             option_depth);
 488
 489                if (option_quiet)
 490                        transport->verbose = -1;
 491                else if (option_verbose)
 492                        transport->progress = 1;
 493
 494                if (option_upload_pack)
 495                        transport_set_option(transport, TRANS_OPT_UPLOADPACK,
 496                                             option_upload_pack);
 497
 498                refs = transport_get_remote_refs(transport);
 499                if(refs)
 500                        transport_fetch_refs(transport, refs);
 501        }
 502
 503        if (refs) {
 504                clear_extra_refs();
 505
 506                mapped_refs = write_remote_refs(refs, &refspec, reflog_msg.buf);
 507
 508                remote_head = find_ref_by_name(refs, "HEAD");
 509                head_points_at = guess_remote_head(remote_head, mapped_refs, 0);
 510        }
 511        else {
 512                warning("You appear to have cloned an empty repository.");
 513                head_points_at = NULL;
 514                remote_head = NULL;
 515                option_no_checkout = 1;
 516                if (!option_bare)
 517                        install_branch_config("master", option_origin,
 518                                              "refs/heads/master");
 519        }
 520
 521        if (head_points_at) {
 522                /* Local default branch link */
 523                create_symref("HEAD", head_points_at->name, NULL);
 524
 525                if (!option_bare) {
 526                        struct strbuf head_ref = STRBUF_INIT;
 527                        const char *head = head_points_at->name;
 528
 529                        if (!prefixcmp(head, "refs/heads/"))
 530                                head += 11;
 531
 532                        /* Set up the initial local branch */
 533
 534                        /* Local branch initial value */
 535                        update_ref(reflog_msg.buf, "HEAD",
 536                                   head_points_at->old_sha1,
 537                                   NULL, 0, DIE_ON_ERR);
 538
 539                        strbuf_addstr(&head_ref, branch_top.buf);
 540                        strbuf_addstr(&head_ref, "HEAD");
 541
 542                        /* Remote branch link */
 543                        create_symref(head_ref.buf,
 544                                      head_points_at->peer_ref->name,
 545                                      reflog_msg.buf);
 546
 547                        install_branch_config(head, option_origin,
 548                                              head_points_at->name);
 549                }
 550        } else if (remote_head) {
 551                /* Source had detached HEAD pointing somewhere. */
 552                if (!option_bare)
 553                        update_ref(reflog_msg.buf, "HEAD",
 554                                   remote_head->old_sha1,
 555                                   NULL, REF_NODEREF, DIE_ON_ERR);
 556        } else {
 557                /* Nothing to checkout out */
 558                if (!option_no_checkout)
 559                        warning("remote HEAD refers to nonexistent ref, "
 560                                "unable to checkout.\n");
 561                option_no_checkout = 1;
 562        }
 563
 564        if (transport)
 565                transport_unlock_pack(transport);
 566
 567        if (!option_no_checkout) {
 568                struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
 569                struct unpack_trees_options opts;
 570                struct tree *tree;
 571                struct tree_desc t;
 572                int fd;
 573
 574                /* We need to be in the new work tree for the checkout */
 575                setup_work_tree();
 576
 577                fd = hold_locked_index(lock_file, 1);
 578
 579                memset(&opts, 0, sizeof opts);
 580                opts.update = 1;
 581                opts.merge = 1;
 582                opts.fn = oneway_merge;
 583                opts.verbose_update = !option_quiet;
 584                opts.src_index = &the_index;
 585                opts.dst_index = &the_index;
 586
 587                tree = parse_tree_indirect(remote_head->old_sha1);
 588                parse_tree(tree);
 589                init_tree_desc(&t, tree->buffer, tree->size);
 590                unpack_trees(1, &t, &opts);
 591
 592                if (write_cache(fd, active_cache, active_nr) ||
 593                    commit_locked_index(lock_file))
 594                        die("unable to write new index file");
 595
 596                err |= run_hook(NULL, "post-checkout", sha1_to_hex(null_sha1),
 597                                sha1_to_hex(remote_head->old_sha1), "1", NULL);
 598        }
 599
 600        strbuf_release(&reflog_msg);
 601        strbuf_release(&branch_top);
 602        strbuf_release(&key);
 603        strbuf_release(&value);
 604        junk_pid = 0;
 605        return err;
 606}