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