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