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