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