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