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