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