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