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