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