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