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