Andrew's git - gitweb.git/blob

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