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