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