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 "builtin.h"
  12 #include "lockfile.h"
  13 #include "parse-options.h"
  14 #include "fetch-pack.h"
  15 #include "refs.h"
  16 #include "tree.h"
  17 #include "tree-walk.h"
  18 #include "unpack-trees.h"
  19 #include "transport.h"
  20 #include "strbuf.h"
  21 #include "dir.h"
  22 #include "sigchain.h"
  23 #include "branch.h"
  24 #include "remote.h"
  25 #include "run-command.h"
  26 #include "connected.h"
  27
  28 /*
  29  * Overall FIXMEs:
  30  *  - respect DB_ENVIRONMENT for .git/objects.
  31  *
  32  * Implementation notes:
  33  *  - dropping use-separate-remote and no-separate-remote compatibility
  34  *
  35  */
  36 static const char * const builtin_clone_usage[] = {
  37         N_("git clone [<options>] [--] <repo> [<dir>]"),
  38         NULL
  39 };
  40
  41 static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
  42 static int option_local = -1, option_no_hardlinks, option_shared, option_recursive;
  43 static char *option_template, *option_depth;
  44 static char *option_origin = NULL;
  45 static char *option_branch = NULL;
  46 static const char *real_git_dir;
  47 static char *option_upload_pack = "git-upload-pack";
  48 static int option_verbosity;
  49 static int option_progress = -1;
  50 static struct string_list option_config;
  51 static struct string_list option_reference;
  52 static int option_dissociate;
  53
  54 static struct option builtin_clone_options[] = {
  55         OPT__VERBOSITY(&option_verbosity),
  56         OPT_BOOL(0, "progress", &option_progress,
  57                  N_("force progress reporting")),
  58         OPT_BOOL('n', "no-checkout", &option_no_checkout,
  59                  N_("don't create a checkout")),
  60         OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
  61         OPT_HIDDEN_BOOL(0, "naked", &option_bare,
  62                         N_("create a bare repository")),
  63         OPT_BOOL(0, "mirror", &option_mirror,
  64                  N_("create a mirror repository (implies bare)")),
  65         OPT_BOOL('l', "local", &option_local,
  66                 N_("to clone from a local repository")),
  67         OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
  68                     N_("don't use local hardlinks, always copy")),
  69         OPT_BOOL('s', "shared", &option_shared,
  70                     N_("setup as shared repository")),
  71         OPT_BOOL(0, "recursive", &option_recursive,
  72                     N_("initialize submodules in the clone")),
  73         OPT_BOOL(0, "recurse-submodules", &option_recursive,
  74                     N_("initialize submodules in the clone")),
  75         OPT_STRING(0, "template", &option_template, N_("template-directory"),
  76                    N_("directory from which templates will be used")),
  77         OPT_STRING_LIST(0, "reference", &option_reference, N_("repo"),
  78                         N_("reference repository")),
  79         OPT_BOOL(0, "dissociate", &option_dissociate,
  80                  N_("use --reference only while cloning")),
  81         OPT_STRING('o', "origin", &option_origin, N_("name"),
  82                    N_("use <name> instead of 'origin' to track upstream")),
  83         OPT_STRING('b', "branch", &option_branch, N_("branch"),
  84                    N_("checkout <branch> instead of the remote's HEAD")),
  85         OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
  86                    N_("path to git-upload-pack on the remote")),
  87         OPT_STRING(0, "depth", &option_depth, N_("depth"),
  88                     N_("create a shallow clone of that depth")),
  89         OPT_BOOL(0, "single-branch", &option_single_branch,
  90                     N_("clone only one branch, HEAD or --branch")),
  91         OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
  92                    N_("separate git dir from working tree")),
  93         OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
  94                         N_("set config inside the new repository")),
  95         OPT_END()
  96 };
  97
  98 static const char *argv_submodule[] = {
  99         "submodule", "update", "--init", "--recursive", NULL
 100 };
 101
 102 static char *get_repo_path(const char *repo, int *is_bundle)
 103 {
 104         static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
 105         static char *bundle_suffix[] = { ".bundle", "" };
 106         struct stat st;
 107         int i;
 108
 109         for (i = 0; i < ARRAY_SIZE(suffix); i++) {
 110                 const char *path;
 111                 path = mkpath("%s%s", repo, suffix[i]);
 112                 if (stat(path, &st))
 113                         continue;
 114                 if (S_ISDIR(st.st_mode) && is_git_directory(path)) {
 115                         *is_bundle = 0;
 116                         return xstrdup(absolute_path(path));
 117                 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
 118                         /* Is it a "gitfile"? */
 119                         char signature[8];
 120                         int len, fd = open(path, O_RDONLY);
 121                         if (fd < 0)
 122                                 continue;
 123                         len = read_in_full(fd, signature, 8);
 124                         close(fd);
 125                         if (len != 8 || strncmp(signature, "gitdir: ", 8))
 126                                 continue;
 127                         path = read_gitfile(path);
 128                         if (path) {
 129                                 *is_bundle = 0;
 130                                 return xstrdup(absolute_path(path));
 131                         }
 132                 }
 133         }
 134
 135         for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
 136                 const char *path;
 137                 path = mkpath("%s%s", repo, bundle_suffix[i]);
 138                 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
 139                         *is_bundle = 1;
 140                         return xstrdup(absolute_path(path));
 141                 }
 142         }
 143
 144         return NULL;
 145 }
 146
 147 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
 148 {
 149         const char *end = repo + strlen(repo), *start, *ptr;
 150         size_t len;
 151         char *dir;
 152
 153         /*
 154          * Skip scheme.
 155          */
 156         start = strstr(repo, "://");
 157         if (start == NULL)
 158                 start = repo;
 159         else
 160                 start += 3;
 161
 162         /*
 163          * Skip authentication data. The stripping does happen
 164          * greedily, such that we strip up to the last '@' inside
 165          * the host part.
 166          */
 167         for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
 168                 if (*ptr == '@')
 169                         start = ptr + 1;
 170         }
 171
 172         /*
 173          * Strip trailing spaces, slashes and /.git
 174          */
 175         while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
 176                 end--;
 177         if (end - start > 5 && is_dir_sep(end[-5]) &&
 178             !strncmp(end - 4, ".git", 4)) {
 179                 end -= 5;
 180                 while (start < end && is_dir_sep(end[-1]))
 181                         end--;
 182         }
 183
 184         /*
 185          * Strip trailing port number if we've got only a
 186          * hostname (that is, there is no dir separator but a
 187          * colon). This check is required such that we do not
 188          * strip URI's like '/foo/bar:2222.git', which should
 189          * result in a dir '2222' being guessed due to backwards
 190          * compatibility.
 191          */
 192         if (memchr(start, '/', end - start) == NULL
 193             && memchr(start, ':', end - start) != NULL) {
 194                 ptr = end;
 195                 while (start < ptr && isdigit(ptr[-1]) && ptr[-1] != ':')
 196                         ptr--;
 197                 if (start < ptr && ptr[-1] == ':')
 198                         end = ptr - 1;
 199         }
 200
 201         /*
 202          * Find last component. To remain backwards compatible we
 203          * also regard colons as path separators, such that
 204          * cloning a repository 'foo:bar.git' would result in a
 205          * directory 'bar' being guessed.
 206          */
 207         ptr = end;
 208         while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
 209                 ptr--;
 210         start = ptr;
 211
 212         /*
 213          * Strip .{bundle,git}.
 214          */
 215         len = end - start;
 216         strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
 217
 218         if (is_bare)
 219                 dir = xstrfmt("%.*s.git", (int)len, start);
 220         else
 221                 dir = xstrndup(start, len);
 222         /*
 223          * Replace sequences of 'control' characters and whitespace
 224          * with one ascii space, remove leading and trailing spaces.
 225          */
 226         if (*dir) {
 227                 char *out = dir;
 228                 int prev_space = 1 /* strip leading whitespace */;
 229                 for (end = dir; *end; ++end) {
 230                         char ch = *end;
 231                         if ((unsigned char)ch < '\x20')
 232                                 ch = '\x20';
 233                         if (isspace(ch)) {
 234                                 if (prev_space)
 235                                         continue;
 236                                 prev_space = 1;
 237                         } else
 238                                 prev_space = 0;
 239                         *out++ = ch;
 240                 }
 241                 *out = '\0';
 242                 if (out > dir && prev_space)
 243                         out[-1] = '\0';
 244         }
 245         return dir;
 246 }
 247
 248 static void strip_trailing_slashes(char *dir)
 249 {
 250         char *end = dir + strlen(dir);
 251
 252         while (dir < end - 1 && is_dir_sep(end[-1]))
 253                 end--;
 254         *end = '\0';
 255 }
 256
 257 static int add_one_reference(struct string_list_item *item, void *cb_data)
 258 {
 259         char *ref_git;
 260         const char *repo;
 261         struct strbuf alternate = STRBUF_INIT;
 262
 263         /* Beware: read_gitfile(), real_path() and mkpath() return static buffer */
 264         ref_git = xstrdup(real_path(item->string));
 265
 266         repo = read_gitfile(ref_git);
 267         if (!repo)
 268                 repo = read_gitfile(mkpath("%s/.git", ref_git));
 269         if (repo) {
 270                 free(ref_git);
 271                 ref_git = xstrdup(repo);
 272         }
 273
 274         if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
 275                 char *ref_git_git = mkpathdup("%s/.git", ref_git);
 276                 free(ref_git);
 277                 ref_git = ref_git_git;
 278         } else if (!is_directory(mkpath("%s/objects", ref_git)))
 279                 die(_("reference repository '%s' is not a local repository."),
 280                     item->string);
 281
 282         if (!access(mkpath("%s/shallow", ref_git), F_OK))
 283                 die(_("reference repository '%s' is shallow"), item->string);
 284
 285         if (!access(mkpath("%s/info/grafts", ref_git), F_OK))
 286                 die(_("reference repository '%s' is grafted"), item->string);
 287
 288         strbuf_addf(&alternate, "%s/objects", ref_git);
 289         add_to_alternates_file(alternate.buf);
 290         strbuf_release(&alternate);
 291         free(ref_git);
 292         return 0;
 293 }
 294
 295 static void setup_reference(void)
 296 {
 297         for_each_string_list(&option_reference, add_one_reference, NULL);
 298 }
 299
 300 static void copy_alternates(struct strbuf *src, struct strbuf *dst,
 301                             const char *src_repo)
 302 {
 303         /*
 304          * Read from the source objects/info/alternates file
 305          * and copy the entries to corresponding file in the
 306          * destination repository with add_to_alternates_file().
 307          * Both src and dst have "$path/objects/info/alternates".
 308          *
 309          * Instead of copying bit-for-bit from the original,
 310          * we need to append to existing one so that the already
 311          * created entry via "clone -s" is not lost, and also
 312          * to turn entries with paths relative to the original
 313          * absolute, so that they can be used in the new repository.
 314          */
 315         FILE *in = fopen(src->buf, "r");
 316         struct strbuf line = STRBUF_INIT;
 317
 318         while (strbuf_getline(&line, in, '\n') != EOF) {
 319                 char *abs_path, abs_buf[PATH_MAX];
 320                 if (!line.len || line.buf[0] == '#')
 321                         continue;
 322                 if (is_absolute_path(line.buf)) {
 323                         add_to_alternates_file(line.buf);
 324                         continue;
 325                 }
 326                 abs_path = mkpath("%s/objects/%s", src_repo, line.buf);
 327                 normalize_path_copy(abs_buf, abs_path);
 328                 add_to_alternates_file(abs_buf);
 329         }
 330         strbuf_release(&line);
 331         fclose(in);
 332 }
 333
 334 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
 335                                    const char *src_repo, int src_baselen)
 336 {
 337         struct dirent *de;
 338         struct stat buf;
 339         int src_len, dest_len;
 340         DIR *dir;
 341
 342         dir = opendir(src->buf);
 343         if (!dir)
 344                 die_errno(_("failed to open '%s'"), src->buf);
 345
 346         if (mkdir(dest->buf, 0777)) {
 347                 if (errno != EEXIST)
 348                         die_errno(_("failed to create directory '%s'"), dest->buf);
 349                 else if (stat(dest->buf, &buf))
 350                         die_errno(_("failed to stat '%s'"), dest->buf);
 351                 else if (!S_ISDIR(buf.st_mode))
 352                         die(_("%s exists and is not a directory"), dest->buf);
 353         }
 354
 355         strbuf_addch(src, '/');
 356         src_len = src->len;
 357         strbuf_addch(dest, '/');
 358         dest_len = dest->len;
 359
 360         while ((de = readdir(dir)) != NULL) {
 361                 strbuf_setlen(src, src_len);
 362                 strbuf_addstr(src, de->d_name);
 363                 strbuf_setlen(dest, dest_len);
 364                 strbuf_addstr(dest, de->d_name);
 365                 if (stat(src->buf, &buf)) {
 366                         warning (_("failed to stat %s\n"), src->buf);
 367                         continue;
 368                 }
 369                 if (S_ISDIR(buf.st_mode)) {
 370                         if (de->d_name[0] != '.')
 371                                 copy_or_link_directory(src, dest,
 372                                                        src_repo, src_baselen);
 373                         continue;
 374                 }
 375
 376                 /* Files that cannot be copied bit-for-bit... */
 377                 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
 378                         copy_alternates(src, dest, src_repo);
 379                         continue;
 380                 }
 381
 382                 if (unlink(dest->buf) && errno != ENOENT)
 383                         die_errno(_("failed to unlink '%s'"), dest->buf);
 384                 if (!option_no_hardlinks) {
 385                         if (!link(src->buf, dest->buf))
 386                                 continue;
 387                         if (option_local > 0)
 388                                 die_errno(_("failed to create link '%s'"), dest->buf);
 389                         option_no_hardlinks = 1;
 390                 }
 391                 if (copy_file_with_time(dest->buf, src->buf, 0666))
 392                         die_errno(_("failed to copy file to '%s'"), dest->buf);
 393         }
 394         closedir(dir);
 395 }
 396
 397 static void clone_local(const char *src_repo, const char *dest_repo)
 398 {
 399         if (option_shared) {
 400                 struct strbuf alt = STRBUF_INIT;
 401                 strbuf_addf(&alt, "%s/objects", src_repo);
 402                 add_to_alternates_file(alt.buf);
 403                 strbuf_release(&alt);
 404         } else {
 405                 struct strbuf src = STRBUF_INIT;
 406                 struct strbuf dest = STRBUF_INIT;
 407                 strbuf_addf(&src, "%s/objects", src_repo);
 408                 strbuf_addf(&dest, "%s/objects", dest_repo);
 409                 copy_or_link_directory(&src, &dest, src_repo, src.len);
 410                 strbuf_release(&src);
 411                 strbuf_release(&dest);
 412         }
 413
 414         if (0 <= option_verbosity)
 415                 fprintf(stderr, _("done.\n"));
 416 }
 417
 418 static const char *junk_work_tree;
 419 static const char *junk_git_dir;
 420 static enum {
 421         JUNK_LEAVE_NONE,
 422         JUNK_LEAVE_REPO,
 423         JUNK_LEAVE_ALL
 424 } junk_mode = JUNK_LEAVE_NONE;
 425
 426 static const char junk_leave_repo_msg[] =
 427 N_("Clone succeeded, but checkout failed.\n"
 428    "You can inspect what was checked out with 'git status'\n"
 429    "and retry the checkout with 'git checkout -f HEAD'\n");
 430
 431 static void remove_junk(void)
 432 {
 433         struct strbuf sb = STRBUF_INIT;
 434
 435         switch (junk_mode) {
 436         case JUNK_LEAVE_REPO:
 437                 warning("%s", _(junk_leave_repo_msg));
 438                 /* fall-through */
 439         case JUNK_LEAVE_ALL:
 440                 return;
 441         default:
 442                 /* proceed to removal */
 443                 break;
 444         }
 445
 446         if (junk_git_dir) {
 447                 strbuf_addstr(&sb, junk_git_dir);
 448                 remove_dir_recursively(&sb, 0);
 449                 strbuf_reset(&sb);
 450         }
 451         if (junk_work_tree) {
 452                 strbuf_addstr(&sb, junk_work_tree);
 453                 remove_dir_recursively(&sb, 0);
 454                 strbuf_reset(&sb);
 455         }
 456 }
 457
 458 static void remove_junk_on_signal(int signo)
 459 {
 460         remove_junk();
 461         sigchain_pop(signo);
 462         raise(signo);
 463 }
 464
 465 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
 466 {
 467         struct ref *ref;
 468         struct strbuf head = STRBUF_INIT;
 469         strbuf_addstr(&head, "refs/heads/");
 470         strbuf_addstr(&head, branch);
 471         ref = find_ref_by_name(refs, head.buf);
 472         strbuf_release(&head);
 473
 474         if (ref)
 475                 return ref;
 476
 477         strbuf_addstr(&head, "refs/tags/");
 478         strbuf_addstr(&head, branch);
 479         ref = find_ref_by_name(refs, head.buf);
 480         strbuf_release(&head);
 481
 482         return ref;
 483 }
 484
 485 static struct ref *wanted_peer_refs(const struct ref *refs,
 486                 struct refspec *refspec)
 487 {
 488         struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
 489         struct ref *local_refs = head;
 490         struct ref **tail = head ? &head->next : &local_refs;
 491
 492         if (option_single_branch) {
 493                 struct ref *remote_head = NULL;
 494
 495                 if (!option_branch)
 496                         remote_head = guess_remote_head(head, refs, 0);
 497                 else {
 498                         local_refs = NULL;
 499                         tail = &local_refs;
 500                         remote_head = copy_ref(find_remote_branch(refs, option_branch));
 501                 }
 502
 503                 if (!remote_head && option_branch)
 504                         warning(_("Could not find remote branch %s to clone."),
 505                                 option_branch);
 506                 else {
 507                         get_fetch_map(remote_head, refspec, &tail, 0);
 508
 509                         /* if --branch=tag, pull the requested tag explicitly */
 510                         get_fetch_map(remote_head, tag_refspec, &tail, 0);
 511                 }
 512         } else
 513                 get_fetch_map(refs, refspec, &tail, 0);
 514
 515         if (!option_mirror && !option_single_branch)
 516                 get_fetch_map(refs, tag_refspec, &tail, 0);
 517
 518         return local_refs;
 519 }
 520
 521 static void write_remote_refs(const struct ref *local_refs)
 522 {
 523         const struct ref *r;
 524
 525         lock_packed_refs(LOCK_DIE_ON_ERROR);
 526
 527         for (r = local_refs; r; r = r->next) {
 528                 if (!r->peer_ref)
 529                         continue;
 530                 add_packed_ref(r->peer_ref->name, r->old_sha1);
 531         }
 532
 533         if (commit_packed_refs())
 534                 die_errno("unable to overwrite old ref-pack file");
 535 }
 536
 537 static void write_followtags(const struct ref *refs, const char *msg)
 538 {
 539         const struct ref *ref;
 540         for (ref = refs; ref; ref = ref->next) {
 541                 if (!starts_with(ref->name, "refs/tags/"))
 542                         continue;
 543                 if (ends_with(ref->name, "^{}"))
 544                         continue;
 545                 if (!has_sha1_file(ref->old_sha1))
 546                         continue;
 547                 update_ref(msg, ref->name, ref->old_sha1,
 548                            NULL, 0, UPDATE_REFS_DIE_ON_ERR);
 549         }
 550 }
 551
 552 static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
 553 {
 554         struct ref **rm = cb_data;
 555         struct ref *ref = *rm;
 556
 557         /*
 558          * Skip anything missing a peer_ref, which we are not
 559          * actually going to write a ref for.
 560          */
 561         while (ref && !ref->peer_ref)
 562                 ref = ref->next;
 563         /* Returning -1 notes "end of list" to the caller. */
 564         if (!ref)
 565                 return -1;
 566
 567         hashcpy(sha1, ref->old_sha1);
 568         *rm = ref->next;
 569         return 0;
 570 }
 571
 572 static void update_remote_refs(const struct ref *refs,
 573                                const struct ref *mapped_refs,
 574                                const struct ref *remote_head_points_at,
 575                                const char *branch_top,
 576                                const char *msg,
 577                                struct transport *transport,
 578                                int check_connectivity)
 579 {
 580         const struct ref *rm = mapped_refs;
 581
 582         if (check_connectivity) {
 583                 if (transport->progress)
 584                         fprintf(stderr, _("Checking connectivity... "));
 585                 if (check_everything_connected_with_transport(iterate_ref_map,
 586                                                               0, &rm, transport))
 587                         die(_("remote did not send all necessary objects"));
 588                 if (transport->progress)
 589                         fprintf(stderr, _("done.\n"));
 590         }
 591
 592         if (refs) {
 593                 write_remote_refs(mapped_refs);
 594                 if (option_single_branch)
 595                         write_followtags(refs, msg);
 596         }
 597
 598         if (remote_head_points_at && !option_bare) {
 599                 struct strbuf head_ref = STRBUF_INIT;
 600                 strbuf_addstr(&head_ref, branch_top);
 601                 strbuf_addstr(&head_ref, "HEAD");
 602                 create_symref(head_ref.buf,
 603                               remote_head_points_at->peer_ref->name,
 604                               msg);
 605         }
 606 }
 607
 608 static void update_head(const struct ref *our, const struct ref *remote,
 609                         const char *msg)
 610 {
 611         const char *head;
 612         if (our && skip_prefix(our->name, "refs/heads/", &head)) {
 613                 /* Local default branch link */
 614                 create_symref("HEAD", our->name, NULL);
 615                 if (!option_bare) {
 616                         update_ref(msg, "HEAD", our->old_sha1, NULL, 0,
 617                                    UPDATE_REFS_DIE_ON_ERR);
 618                         install_branch_config(0, head, option_origin, our->name);
 619                 }
 620         } else if (our) {
 621                 struct commit *c = lookup_commit_reference(our->old_sha1);
 622                 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
 623                 update_ref(msg, "HEAD", c->object.sha1,
 624                            NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
 625         } else if (remote) {
 626                 /*
 627                  * We know remote HEAD points to a non-branch, or
 628                  * HEAD points to a branch but we don't know which one.
 629                  * Detach HEAD in all these cases.
 630                  */
 631                 update_ref(msg, "HEAD", remote->old_sha1,
 632                            NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
 633         }
 634 }
 635
 636 static int checkout(void)
 637 {
 638         unsigned char sha1[20];
 639         char *head;
 640         struct lock_file *lock_file;
 641         struct unpack_trees_options opts;
 642         struct tree *tree;
 643         struct tree_desc t;
 644         int err = 0;
 645
 646         if (option_no_checkout)
 647                 return 0;
 648
 649         head = resolve_refdup("HEAD", RESOLVE_REF_READING, sha1, NULL);
 650         if (!head) {
 651                 warning(_("remote HEAD refers to nonexistent ref, "
 652                           "unable to checkout.\n"));
 653                 return 0;
 654         }
 655         if (!strcmp(head, "HEAD")) {
 656                 if (advice_detached_head)
 657                         detach_advice(sha1_to_hex(sha1));
 658         } else {
 659                 if (!starts_with(head, "refs/heads/"))
 660                         die(_("HEAD not found below refs/heads!"));
 661         }
 662         free(head);
 663
 664         /* We need to be in the new work tree for the checkout */
 665         setup_work_tree();
 666
 667         lock_file = xcalloc(1, sizeof(struct lock_file));
 668         hold_locked_index(lock_file, 1);
 669
 670         memset(&opts, 0, sizeof opts);
 671         opts.update = 1;
 672         opts.merge = 1;
 673         opts.fn = oneway_merge;
 674         opts.verbose_update = (option_verbosity >= 0);
 675         opts.src_index = &the_index;
 676         opts.dst_index = &the_index;
 677
 678         tree = parse_tree_indirect(sha1);
 679         parse_tree(tree);
 680         init_tree_desc(&t, tree->buffer, tree->size);
 681         if (unpack_trees(1, &t, &opts) < 0)
 682                 die(_("unable to checkout working tree"));
 683
 684         if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
 685                 die(_("unable to write new index file"));
 686
 687         err |= run_hook_le(NULL, "post-checkout", sha1_to_hex(null_sha1),
 688                            sha1_to_hex(sha1), "1", NULL);
 689
 690         if (!err && option_recursive)
 691                 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
 692
 693         return err;
 694 }
 695
 696 static int write_one_config(const char *key, const char *value, void *data)
 697 {
 698         return git_config_set_multivar(key, value ? value : "true", "^$", 0);
 699 }
 700
 701 static void write_config(struct string_list *config)
 702 {
 703         int i;
 704
 705         for (i = 0; i < config->nr; i++) {
 706                 if (git_config_parse_parameter(config->items[i].string,
 707                                                write_one_config, NULL) < 0)
 708                         die("unable to write parameters to config file");
 709         }
 710 }
 711
 712 static void write_refspec_config(const char *src_ref_prefix,
 713                 const struct ref *our_head_points_at,
 714                 const struct ref *remote_head_points_at,
 715                 struct strbuf *branch_top)
 716 {
 717         struct strbuf key = STRBUF_INIT;
 718         struct strbuf value = STRBUF_INIT;
 719
 720         if (option_mirror || !option_bare) {
 721                 if (option_single_branch && !option_mirror) {
 722                         if (option_branch) {
 723                                 if (starts_with(our_head_points_at->name, "refs/tags/"))
 724                                         strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
 725                                                 our_head_points_at->name);
 726                                 else
 727                                         strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
 728                                                 branch_top->buf, option_branch);
 729                         } else if (remote_head_points_at) {
 730                                 const char *head = remote_head_points_at->name;
 731                                 if (!skip_prefix(head, "refs/heads/", &head))
 732                                         die("BUG: remote HEAD points at non-head?");
 733
 734                                 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
 735                                                 branch_top->buf, head);
 736                         }
 737                         /*
 738                          * otherwise, the next "git fetch" will
 739                          * simply fetch from HEAD without updating
 740                          * any remote-tracking branch, which is what
 741                          * we want.
 742                          */
 743                 } else {
 744                         strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
 745                 }
 746                 /* Configure the remote */
 747                 if (value.len) {
 748                         strbuf_addf(&key, "remote.%s.fetch", option_origin);
 749                         git_config_set_multivar(key.buf, value.buf, "^$", 0);
 750                         strbuf_reset(&key);
 751
 752                         if (option_mirror) {
 753                                 strbuf_addf(&key, "remote.%s.mirror", option_origin);
 754                                 git_config_set(key.buf, "true");
 755                                 strbuf_reset(&key);
 756                         }
 757                 }
 758         }
 759
 760         strbuf_release(&key);
 761         strbuf_release(&value);
 762 }
 763
 764 static void dissociate_from_references(void)
 765 {
 766         static const char* argv[] = { "repack", "-a", "-d", NULL };
 767
 768         if (run_command_v_opt(argv, RUN_GIT_CMD|RUN_COMMAND_NO_STDIN))
 769                 die(_("cannot repack to clean up"));
 770         if (unlink(git_path("objects/info/alternates")) && errno != ENOENT)
 771                 die_errno(_("cannot unlink temporary alternates file"));
 772 }
 773
 774 int cmd_clone(int argc, const char **argv, const char *prefix)
 775 {
 776         int is_bundle = 0, is_local;
 777         struct stat buf;
 778         const char *repo_name, *repo, *work_tree, *git_dir;
 779         char *path, *dir;
 780         int dest_exists;
 781         const struct ref *refs, *remote_head;
 782         const struct ref *remote_head_points_at;
 783         const struct ref *our_head_points_at;
 784         struct ref *mapped_refs;
 785         const struct ref *ref;
 786         struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
 787         struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
 788         struct transport *transport = NULL;
 789         const char *src_ref_prefix = "refs/heads/";
 790         struct remote *remote;
 791         int err = 0, complete_refs_before_fetch = 1;
 792
 793         struct refspec *refspec;
 794         const char *fetch_pattern;
 795
 796         packet_trace_identity("clone");
 797         argc = parse_options(argc, argv, prefix, builtin_clone_options,
 798                              builtin_clone_usage, 0);
 799
 800         if (argc > 2)
 801                 usage_msg_opt(_("Too many arguments."),
 802                         builtin_clone_usage, builtin_clone_options);
 803
 804         if (argc == 0)
 805                 usage_msg_opt(_("You must specify a repository to clone."),
 806                         builtin_clone_usage, builtin_clone_options);
 807
 808         if (option_single_branch == -1)
 809                 option_single_branch = option_depth ? 1 : 0;
 810
 811         if (option_mirror)
 812                 option_bare = 1;
 813
 814         if (option_bare) {
 815                 if (option_origin)
 816                         die(_("--bare and --origin %s options are incompatible."),
 817                             option_origin);
 818                 if (real_git_dir)
 819                         die(_("--bare and --separate-git-dir are incompatible."));
 820                 option_no_checkout = 1;
 821         }
 822
 823         if (!option_origin)
 824                 option_origin = "origin";
 825
 826         repo_name = argv[0];
 827
 828         path = get_repo_path(repo_name, &is_bundle);
 829         if (path)
 830                 repo = xstrdup(absolute_path(repo_name));
 831         else if (!strchr(repo_name, ':'))
 832                 die(_("repository '%s' does not exist"), repo_name);
 833         else
 834                 repo = repo_name;
 835
 836         /* no need to be strict, transport_set_option() will validate it again */
 837         if (option_depth && atoi(option_depth) < 1)
 838                 die(_("depth %s is not a positive number"), option_depth);
 839
 840         if (argc == 2)
 841                 dir = xstrdup(argv[1]);
 842         else
 843                 dir = guess_dir_name(repo_name, is_bundle, option_bare);
 844         strip_trailing_slashes(dir);
 845
 846         dest_exists = !stat(dir, &buf);
 847         if (dest_exists && !is_empty_dir(dir))
 848                 die(_("destination path '%s' already exists and is not "
 849                         "an empty directory."), dir);
 850
 851         strbuf_addf(&reflog_msg, "clone: from %s", repo);
 852
 853         if (option_bare)
 854                 work_tree = NULL;
 855         else {
 856                 work_tree = getenv("GIT_WORK_TREE");
 857                 if (work_tree && !stat(work_tree, &buf))
 858                         die(_("working tree '%s' already exists."), work_tree);
 859         }
 860
 861         if (option_bare || work_tree)
 862                 git_dir = xstrdup(dir);
 863         else {
 864                 work_tree = dir;
 865                 git_dir = mkpathdup("%s/.git", dir);
 866         }
 867
 868         atexit(remove_junk);
 869         sigchain_push_common(remove_junk_on_signal);
 870
 871         if (!option_bare) {
 872                 if (safe_create_leading_directories_const(work_tree) < 0)
 873                         die_errno(_("could not create leading directories of '%s'"),
 874                                   work_tree);
 875                 if (!dest_exists && mkdir(work_tree, 0777))
 876                         die_errno(_("could not create work tree dir '%s'"),
 877                                   work_tree);
 878                 junk_work_tree = work_tree;
 879                 set_git_work_tree(work_tree);
 880         }
 881
 882         junk_git_dir = git_dir;
 883         if (safe_create_leading_directories_const(git_dir) < 0)
 884                 die(_("could not create leading directories of '%s'"), git_dir);
 885
 886         set_git_dir_init(git_dir, real_git_dir, 0);
 887         if (real_git_dir) {
 888                 git_dir = real_git_dir;
 889                 junk_git_dir = real_git_dir;
 890         }
 891
 892         if (0 <= option_verbosity) {
 893                 if (option_bare)
 894                         fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
 895                 else
 896                         fprintf(stderr, _("Cloning into '%s'...\n"), dir);
 897         }
 898         init_db(option_template, INIT_DB_QUIET);
 899         write_config(&option_config);
 900
 901         git_config(git_default_config, NULL);
 902
 903         if (option_bare) {
 904                 if (option_mirror)
 905                         src_ref_prefix = "refs/";
 906                 strbuf_addstr(&branch_top, src_ref_prefix);
 907
 908                 git_config_set("core.bare", "true");
 909         } else {
 910                 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
 911         }
 912
 913         strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
 914         strbuf_addf(&key, "remote.%s.url", option_origin);
 915         git_config_set(key.buf, repo);
 916         strbuf_reset(&key);
 917
 918         if (option_reference.nr)
 919                 setup_reference();
 920         else if (option_dissociate) {
 921                 warning(_("--dissociate given, but there is no --reference"));
 922                 option_dissociate = 0;
 923         }
 924
 925         fetch_pattern = value.buf;
 926         refspec = parse_fetch_refspec(1, &fetch_pattern);
 927
 928         strbuf_reset(&value);
 929
 930         remote = remote_get(option_origin);
 931         transport = transport_get(remote, remote->url[0]);
 932         transport_set_verbosity(transport, option_verbosity, option_progress);
 933
 934         path = get_repo_path(remote->url[0], &is_bundle);
 935         is_local = option_local != 0 && path && !is_bundle;
 936         if (is_local) {
 937                 if (option_depth)
 938                         warning(_("--depth is ignored in local clones; use file:// instead."));
 939                 if (!access(mkpath("%s/shallow", path), F_OK)) {
 940                         if (option_local > 0)
 941                                 warning(_("source repository is shallow, ignoring --local"));
 942                         is_local = 0;
 943                 }
 944         }
 945         if (option_local > 0 && !is_local)
 946                 warning(_("--local is ignored"));
 947         transport->cloning = 1;
 948
 949         if (!transport->get_refs_list || (!is_local && !transport->fetch))
 950                 die(_("Don't know how to clone %s"), transport->url);
 951
 952         transport_set_option(transport, TRANS_OPT_KEEP, "yes");
 953
 954         if (option_depth)
 955                 transport_set_option(transport, TRANS_OPT_DEPTH,
 956                                      option_depth);
 957         if (option_single_branch)
 958                 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
 959
 960         if (option_upload_pack)
 961                 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
 962                                      option_upload_pack);
 963
 964         if (transport->smart_options && !option_depth)
 965                 transport->smart_options->check_self_contained_and_connected = 1;
 966
 967         refs = transport_get_remote_refs(transport);
 968
 969         if (refs) {
 970                 mapped_refs = wanted_peer_refs(refs, refspec);
 971                 /*
 972                  * transport_get_remote_refs() may return refs with null sha-1
 973                  * in mapped_refs (see struct transport->get_refs_list
 974                  * comment). In that case we need fetch it early because
 975                  * remote_head code below relies on it.
 976                  *
 977                  * for normal clones, transport_get_remote_refs() should
 978                  * return reliable ref set, we can delay cloning until after
 979                  * remote HEAD check.
 980                  */
 981                 for (ref = refs; ref; ref = ref->next)
 982                         if (is_null_sha1(ref->old_sha1)) {
 983                                 complete_refs_before_fetch = 0;
 984                                 break;
 985                         }
 986
 987                 if (!is_local && !complete_refs_before_fetch)
 988                         transport_fetch_refs(transport, mapped_refs);
 989
 990                 remote_head = find_ref_by_name(refs, "HEAD");
 991                 remote_head_points_at =
 992                         guess_remote_head(remote_head, mapped_refs, 0);
 993
 994                 if (option_branch) {
 995                         our_head_points_at =
 996                                 find_remote_branch(mapped_refs, option_branch);
 997
 998                         if (!our_head_points_at)
 999                                 die(_("Remote branch %s not found in upstream %s"),
1000                                     option_branch, option_origin);
1001                 }
1002                 else
1003                         our_head_points_at = remote_head_points_at;
1004         }
1005         else {
1006                 if (option_branch)
1007                         die(_("Remote branch %s not found in upstream %s"),
1008                                         option_branch, option_origin);
1009
1010                 warning(_("You appear to have cloned an empty repository."));
1011                 mapped_refs = NULL;
1012                 our_head_points_at = NULL;
1013                 remote_head_points_at = NULL;
1014                 remote_head = NULL;
1015                 option_no_checkout = 1;
1016                 if (!option_bare)
1017                         install_branch_config(0, "master", option_origin,
1018                                               "refs/heads/master");
1019         }
1020
1021         write_refspec_config(src_ref_prefix, our_head_points_at,
1022                         remote_head_points_at, &branch_top);
1023
1024         if (is_local)
1025                 clone_local(path, git_dir);
1026         else if (refs && complete_refs_before_fetch)
1027                 transport_fetch_refs(transport, mapped_refs);
1028
1029         update_remote_refs(refs, mapped_refs, remote_head_points_at,
1030                            branch_top.buf, reflog_msg.buf, transport, !is_local);
1031
1032         update_head(our_head_points_at, remote_head, reflog_msg.buf);
1033
1034         transport_unlock_pack(transport);
1035         transport_disconnect(transport);
1036
1037         if (option_dissociate)
1038                 dissociate_from_references();
1039
1040         junk_mode = JUNK_LEAVE_REPO;
1041         err = checkout();
1042
1043         strbuf_release(&reflog_msg);
1044         strbuf_release(&branch_top);
1045         strbuf_release(&key);
1046         strbuf_release(&value);
1047         junk_mode = JUNK_LEAVE_ALL;
1048
1049         free(refspec);
1050         return err;
1051 }