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