builtin-clone.c

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