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