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 option_remote_submodules;
71static int recurse_submodules_cb(const struct option *opt,
73 const char *arg, int unset)
74{
75 if (unset)
76 string_list_clear((struct string_list *)opt->value, 0);
77 else if (arg)
78 string_list_append((struct string_list *)opt->value, arg);
79 else
80 string_list_append((struct string_list *)opt->value,
81 (const char *)opt->defval);
82 return 0;
84}
85static struct option builtin_clone_options[] = {
87 OPT__VERBOSITY(&option_verbosity),
88 OPT_BOOL(0, "progress", &option_progress,
89 N_("force progress reporting")),
90 OPT_BOOL('n', "no-checkout", &option_no_checkout,
91 N_("don't create a checkout")),
92 OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
93 OPT_HIDDEN_BOOL(0, "naked", &option_bare,
94 N_("create a bare repository")),
95 OPT_BOOL(0, "mirror", &option_mirror,
96 N_("create a mirror repository (implies bare)")),
97 OPT_BOOL('l', "local", &option_local,
98 N_("to clone from a local repository")),
99 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
100 N_("don't use local hardlinks, always copy")),
101 OPT_BOOL('s', "shared", &option_shared,
102 N_("setup as shared repository")),
103 OPT_ALIAS(0, "recursive", "recurse-submodules"),
104 { OPTION_CALLBACK, 0, "recurse-submodules", &option_recurse_submodules,
105 N_("pathspec"), N_("initialize submodules in the clone"),
106 PARSE_OPT_OPTARG, recurse_submodules_cb, (intptr_t)"." },
107 OPT_INTEGER('j', "jobs", &max_jobs,
108 N_("number of submodules cloned in parallel")),
109 OPT_STRING(0, "template", &option_template, N_("template-directory"),
110 N_("directory from which templates will be used")),
111 OPT_STRING_LIST(0, "reference", &option_required_reference, N_("repo"),
112 N_("reference repository")),
113 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference,
114 N_("repo"), N_("reference repository")),
115 OPT_BOOL(0, "dissociate", &option_dissociate,
116 N_("use --reference only while cloning")),
117 OPT_STRING('o', "origin", &option_origin, N_("name"),
118 N_("use <name> instead of 'origin' to track upstream")),
119 OPT_STRING('b', "branch", &option_branch, N_("branch"),
120 N_("checkout <branch> instead of the remote's HEAD")),
121 OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
122 N_("path to git-upload-pack on the remote")),
123 OPT_STRING(0, "depth", &option_depth, N_("depth"),
124 N_("create a shallow clone of that depth")),
125 OPT_STRING(0, "shallow-since", &option_since, N_("time"),
126 N_("create a shallow clone since a specific time")),
127 OPT_STRING_LIST(0, "shallow-exclude", &option_not, N_("revision"),
128 N_("deepen history of shallow clone, excluding rev")),
129 OPT_BOOL(0, "single-branch", &option_single_branch,
130 N_("clone only one branch, HEAD or --branch")),
131 OPT_BOOL(0, "no-tags", &option_no_tags,
132 N_("don't clone any tags, and make later fetches not to follow them")),
133 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules,
134 N_("any cloned submodules will be shallow")),
135 OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
136 N_("separate git dir from working tree")),
137 OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
138 N_("set config inside the new repository")),
139 OPT_STRING_LIST(0, "server-option", &server_options,
140 N_("server-specific"), N_("option to transmit")),
141 OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
142 TRANSPORT_FAMILY_IPV4),
143 OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
144 TRANSPORT_FAMILY_IPV6),
145 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
146 OPT_BOOL(0, "remote-submodules", &option_remote_submodules,
147 N_("any cloned submodules will use their remote-tracking branch")),
148 OPT_END()
149};
150static const char *get_repo_path_1(struct strbuf *path, int *is_bundle)
152{
153 static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
154 static char *bundle_suffix[] = { ".bundle", "" };
155 size_t baselen = path->len;
156 struct stat st;
157 int i;
158 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
160 strbuf_setlen(path, baselen);
161 strbuf_addstr(path, suffix[i]);
162 if (stat(path->buf, &st))
163 continue;
164 if (S_ISDIR(st.st_mode) && is_git_directory(path->buf)) {
165 *is_bundle = 0;
166 return path->buf;
167 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
168 /* Is it a "gitfile"? */
169 char signature[8];
170 const char *dst;
171 int len, fd = open(path->buf, O_RDONLY);
172 if (fd < 0)
173 continue;
174 len = read_in_full(fd, signature, 8);
175 close(fd);
176 if (len != 8 || strncmp(signature, "gitdir: ", 8))
177 continue;
178 dst = read_gitfile(path->buf);
179 if (dst) {
180 *is_bundle = 0;
181 return dst;
182 }
183 }
184 }
185 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
187 strbuf_setlen(path, baselen);
188 strbuf_addstr(path, bundle_suffix[i]);
189 if (!stat(path->buf, &st) && S_ISREG(st.st_mode)) {
190 *is_bundle = 1;
191 return path->buf;
192 }
193 }
194 return NULL;
196}
197static char *get_repo_path(const char *repo, int *is_bundle)
199{
200 struct strbuf path = STRBUF_INIT;
201 const char *raw;
202 char *canon;
203 strbuf_addstr(&path, repo);
205 raw = get_repo_path_1(&path, is_bundle);
206 canon = raw ? absolute_pathdup(raw) : NULL;
207 strbuf_release(&path);
208 return canon;
209}
210static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
212{
213 const char *end = repo + strlen(repo), *start, *ptr;
214 size_t len;
215 char *dir;
216 /*
218 * Skip scheme.
219 */
220 start = strstr(repo, "://");
221 if (start == NULL)
222 start = repo;
223 else
224 start += 3;
225 /*
227 * Skip authentication data. The stripping does happen
228 * greedily, such that we strip up to the last '@' inside
229 * the host part.
230 */
231 for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
232 if (*ptr == '@')
233 start = ptr + 1;
234 }
235 /*
237 * Strip trailing spaces, slashes and /.git
238 */
239 while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
240 end--;
241 if (end - start > 5 && is_dir_sep(end[-5]) &&
242 !strncmp(end - 4, ".git", 4)) {
243 end -= 5;
244 while (start < end && is_dir_sep(end[-1]))
245 end--;
246 }
247 /*
249 * Strip trailing port number if we've got only a
250 * hostname (that is, there is no dir separator but a
251 * colon). This check is required such that we do not
252 * strip URI's like '/foo/bar:2222.git', which should
253 * result in a dir '2222' being guessed due to backwards
254 * compatibility.
255 */
256 if (memchr(start, '/', end - start) == NULL
257 && memchr(start, ':', end - start) != NULL) {
258 ptr = end;
259 while (start < ptr && isdigit(ptr[-1]) && ptr[-1] != ':')
260 ptr--;
261 if (start < ptr && ptr[-1] == ':')
262 end = ptr - 1;
263 }
264 /*
266 * Find last component. To remain backwards compatible we
267 * also regard colons as path separators, such that
268 * cloning a repository 'foo:bar.git' would result in a
269 * directory 'bar' being guessed.
270 */
271 ptr = end;
272 while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
273 ptr--;
274 start = ptr;
275 /*
277 * Strip .{bundle,git}.
278 */
279 len = end - start;
280 strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
281 if (!len || (len == 1 && *start == '/'))
283 die(_("No directory name could be guessed.\n"
284 "Please specify a directory on the command line"));
285 if (is_bare)
287 dir = xstrfmt("%.*s.git", (int)len, start);
288 else
289 dir = xstrndup(start, len);
290 /*
291 * Replace sequences of 'control' characters and whitespace
292 * with one ascii space, remove leading and trailing spaces.
293 */
294 if (*dir) {
295 char *out = dir;
296 int prev_space = 1 /* strip leading whitespace */;
297 for (end = dir; *end; ++end) {
298 char ch = *end;
299 if ((unsigned char)ch < '\x20')
300 ch = '\x20';
301 if (isspace(ch)) {
302 if (prev_space)
303 continue;
304 prev_space = 1;
305 } else
306 prev_space = 0;
307 *out++ = ch;
308 }
309 *out = '\0';
310 if (out > dir && prev_space)
311 out[-1] = '\0';
312 }
313 return dir;
314}
315static void strip_trailing_slashes(char *dir)
317{
318 char *end = dir + strlen(dir);
319 while (dir < end - 1 && is_dir_sep(end[-1]))
321 end--;
322 *end = '\0';
323}
324static int add_one_reference(struct string_list_item *item, void *cb_data)
326{
327 struct strbuf err = STRBUF_INIT;
328 int *required = cb_data;
329 char *ref_git = compute_alternate_path(item->string, &err);
330 if (!ref_git) {
332 if (*required)
333 die("%s", err.buf);
334 else
335 fprintf(stderr,
336 _("info: Could not add alternate for '%s': %s\n"),
337 item->string, err.buf);
338 } else {
339 struct strbuf sb = STRBUF_INIT;
340 strbuf_addf(&sb, "%s/objects", ref_git);
341 add_to_alternates_file(sb.buf);
342 strbuf_release(&sb);
343 }
344 strbuf_release(&err);
346 free(ref_git);
347 return 0;
348}
349static void setup_reference(void)
351{
352 int required = 1;
353 for_each_string_list(&option_required_reference,
354 add_one_reference, &required);
355 required = 0;
356 for_each_string_list(&option_optional_reference,
357 add_one_reference, &required);
358}
359static void copy_alternates(struct strbuf *src, const char *src_repo)
361{
362 /*
363 * Read from the source objects/info/alternates file
364 * and copy the entries to corresponding file in the
365 * destination repository with add_to_alternates_file().
366 * Both src and dst have "$path/objects/info/alternates".
367 *
368 * Instead of copying bit-for-bit from the original,
369 * we need to append to existing one so that the already
370 * created entry via "clone -s" is not lost, and also
371 * to turn entries with paths relative to the original
372 * absolute, so that they can be used in the new repository.
373 */
374 FILE *in = xfopen(src->buf, "r");
375 struct strbuf line = STRBUF_INIT;
376 while (strbuf_getline(&line, in) != EOF) {
378 char *abs_path;
379 if (!line.len || line.buf[0] == '#')
380 continue;
381 if (is_absolute_path(line.buf)) {
382 add_to_alternates_file(line.buf);
383 continue;
384 }
385 abs_path = mkpathdup("%s/objects/%s", src_repo, line.buf);
386 if (!normalize_path_copy(abs_path, abs_path))
387 add_to_alternates_file(abs_path);
388 else
389 warning("skipping invalid relative alternate: %s/%s",
390 src_repo, line.buf);
391 free(abs_path);
392 }
393 strbuf_release(&line);
394 fclose(in);
395}
396static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
398 const char *src_repo, int src_baselen)
399{
400 struct dirent *de;
401 struct stat buf;
402 int src_len, dest_len;
403 DIR *dir;
404 dir = opendir(src->buf);
406 if (!dir)
407 die_errno(_("failed to open '%s'"), src->buf);
408 if (mkdir(dest->buf, 0777)) {
410 if (errno != EEXIST)
411 die_errno(_("failed to create directory '%s'"), dest->buf);
412 else if (stat(dest->buf, &buf))
413 die_errno(_("failed to stat '%s'"), dest->buf);
414 else if (!S_ISDIR(buf.st_mode))
415 die(_("%s exists and is not a directory"), dest->buf);
416 }
417 strbuf_addch(src, '/');
419 src_len = src->len;
420 strbuf_addch(dest, '/');
421 dest_len = dest->len;
422 while ((de = readdir(dir)) != NULL) {
424 strbuf_setlen(src, src_len);
425 strbuf_addstr(src, de->d_name);
426 strbuf_setlen(dest, dest_len);
427 strbuf_addstr(dest, de->d_name);
428 if (stat(src->buf, &buf)) {
429 warning (_("failed to stat %s\n"), src->buf);
430 continue;
431 }
432 if (S_ISDIR(buf.st_mode)) {
433 if (de->d_name[0] != '.')
434 copy_or_link_directory(src, dest,
435 src_repo, src_baselen);
436 continue;
437 }
438 /* Files that cannot be copied bit-for-bit... */
440 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
441 copy_alternates(src, src_repo);
442 continue;
443 }
444 if (unlink(dest->buf) && errno != ENOENT)
446 die_errno(_("failed to unlink '%s'"), dest->buf);
447 if (!option_no_hardlinks) {
448 if (!link(src->buf, dest->buf))
449 continue;
450 if (option_local > 0)
451 die_errno(_("failed to create link '%s'"), dest->buf);
452 option_no_hardlinks = 1;
453 }
454 if (copy_file_with_time(dest->buf, src->buf, 0666))
455 die_errno(_("failed to copy file to '%s'"), dest->buf);
456 }
457 closedir(dir);
458}
459static void clone_local(const char *src_repo, const char *dest_repo)
461{
462 if (option_shared) {
463 struct strbuf alt = STRBUF_INIT;
464 get_common_dir(&alt, src_repo);
465 strbuf_addstr(&alt, "/objects");
466 add_to_alternates_file(alt.buf);
467 strbuf_release(&alt);
468 } else {
469 struct strbuf src = STRBUF_INIT;
470 struct strbuf dest = STRBUF_INIT;
471 get_common_dir(&src, src_repo);
472 get_common_dir(&dest, dest_repo);
473 strbuf_addstr(&src, "/objects");
474 strbuf_addstr(&dest, "/objects");
475 copy_or_link_directory(&src, &dest, src_repo, src.len);
476 strbuf_release(&src);
477 strbuf_release(&dest);
478 }
479 if (0 <= option_verbosity)
481 fprintf(stderr, _("done.\n"));
482}
483static const char *junk_work_tree;
485static int junk_work_tree_flags;
486static const char *junk_git_dir;
487static int junk_git_dir_flags;
488static enum {
489 JUNK_LEAVE_NONE,
490 JUNK_LEAVE_REPO,
491 JUNK_LEAVE_ALL
492} junk_mode = JUNK_LEAVE_NONE;
493static const char junk_leave_repo_msg[] =
495N_("Clone succeeded, but checkout failed.\n"
496 "You can inspect what was checked out with 'git status'\n"
497 "and retry the checkout with 'git checkout -f HEAD'\n");
498static void remove_junk(void)
500{
501 struct strbuf sb = STRBUF_INIT;
502 switch (junk_mode) {
504 case JUNK_LEAVE_REPO:
505 warning("%s", _(junk_leave_repo_msg));
506 /* fall-through */
507 case JUNK_LEAVE_ALL:
508 return;
509 default:
510 /* proceed to removal */
511 break;
512 }
513 if (junk_git_dir) {
515 strbuf_addstr(&sb, junk_git_dir);
516 remove_dir_recursively(&sb, junk_git_dir_flags);
517 strbuf_reset(&sb);
518 }
519 if (junk_work_tree) {
520 strbuf_addstr(&sb, junk_work_tree);
521 remove_dir_recursively(&sb, junk_work_tree_flags);
522 }
523 strbuf_release(&sb);
524}
525static void remove_junk_on_signal(int signo)
527{
528 remove_junk();
529 sigchain_pop(signo);
530 raise(signo);
531}
532static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
534{
535 struct ref *ref;
536 struct strbuf head = STRBUF_INIT;
537 strbuf_addstr(&head, "refs/heads/");
538 strbuf_addstr(&head, branch);
539 ref = find_ref_by_name(refs, head.buf);
540 strbuf_release(&head);
541 if (ref)
543 return ref;
544 strbuf_addstr(&head, "refs/tags/");
546 strbuf_addstr(&head, branch);
547 ref = find_ref_by_name(refs, head.buf);
548 strbuf_release(&head);
549 return ref;
551}
552static struct ref *wanted_peer_refs(const struct ref *refs,
554 struct refspec *refspec)
555{
556 struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
557 struct ref *local_refs = head;
558 struct ref **tail = head ? &head->next : &local_refs;
559 if (option_single_branch) {
561 struct ref *remote_head = NULL;
562 if (!option_branch)
564 remote_head = guess_remote_head(head, refs, 0);
565 else {
566 local_refs = NULL;
567 tail = &local_refs;
568 remote_head = copy_ref(find_remote_branch(refs, option_branch));
569 }
570 if (!remote_head && option_branch)
572 warning(_("Could not find remote branch %s to clone."),
573 option_branch);
574 else {
575 int i;
576 for (i = 0; i < refspec->nr; i++)
577 get_fetch_map(remote_head, &refspec->items[i],
578 &tail, 0);
579 /* if --branch=tag, pull the requested tag explicitly */
581 get_fetch_map(remote_head, tag_refspec, &tail, 0);
582 }
583 } else {
584 int i;
585 for (i = 0; i < refspec->nr; i++)
586 get_fetch_map(refs, &refspec->items[i], &tail, 0);
587 }
588 if (!option_mirror && !option_single_branch && !option_no_tags)
590 get_fetch_map(refs, tag_refspec, &tail, 0);
591 return local_refs;
593}
594static void write_remote_refs(const struct ref *local_refs)
596{
597 const struct ref *r;
598 struct ref_transaction *t;
600 struct strbuf err = STRBUF_INIT;
601 t = ref_transaction_begin(&err);
603 if (!t)
604 die("%s", err.buf);
605 for (r = local_refs; r; r = r->next) {
607 if (!r->peer_ref)
608 continue;
609 if (ref_transaction_create(t, r->peer_ref->name, &r->old_oid,
610 0, NULL, &err))
611 die("%s", err.buf);
612 }
613 if (initial_ref_transaction_commit(t, &err))
615 die("%s", err.buf);
616 strbuf_release(&err);
618 ref_transaction_free(t);
619}
620static void write_followtags(const struct ref *refs, const char *msg)
622{
623 const struct ref *ref;
624 for (ref = refs; ref; ref = ref->next) {
625 if (!starts_with(ref->name, "refs/tags/"))
626 continue;
627 if (ends_with(ref->name, "^{}"))
628 continue;
629 if (!has_object_file(&ref->old_oid))
630 continue;
631 update_ref(msg, ref->name, &ref->old_oid, NULL, 0,
632 UPDATE_REFS_DIE_ON_ERR);
633 }
634}
635static int iterate_ref_map(void *cb_data, struct object_id *oid)
637{
638 struct ref **rm = cb_data;
639 struct ref *ref = *rm;
640 /*
642 * Skip anything missing a peer_ref, which we are not
643 * actually going to write a ref for.
644 */
645 while (ref && !ref->peer_ref)
646 ref = ref->next;
647 /* Returning -1 notes "end of list" to the caller. */
648 if (!ref)
649 return -1;
650 oidcpy(oid, &ref->old_oid);
652 *rm = ref->next;
653 return 0;
654}
655static void update_remote_refs(const struct ref *refs,
657 const struct ref *mapped_refs,
658 const struct ref *remote_head_points_at,
659 const char *branch_top,
660 const char *msg,
661 struct transport *transport,
662 int check_connectivity,
663 int check_refs_only)
664{
665 const struct ref *rm = mapped_refs;
666 if (check_connectivity) {
668 struct check_connected_options opt = CHECK_CONNECTED_INIT;
669 opt.transport = transport;
671 opt.progress = transport->progress;
672 opt.check_refs_only = !!check_refs_only;
673 if (check_connected(iterate_ref_map, &rm, &opt))
675 die(_("remote did not send all necessary objects"));
676 }
677 if (refs) {
679 write_remote_refs(mapped_refs);
680 if (option_single_branch && !option_no_tags)
681 write_followtags(refs, msg);
682 }
683 if (remote_head_points_at && !option_bare) {
685 struct strbuf head_ref = STRBUF_INIT;
686 strbuf_addstr(&head_ref, branch_top);
687 strbuf_addstr(&head_ref, "HEAD");
688 if (create_symref(head_ref.buf,
689 remote_head_points_at->peer_ref->name,
690 msg) < 0)
691 die(_("unable to update %s"), head_ref.buf);
692 strbuf_release(&head_ref);
693 }
694}
695static void update_head(const struct ref *our, const struct ref *remote,
697 const char *msg)
698{
699 const char *head;
700 if (our && skip_prefix(our->name, "refs/heads/", &head)) {
701 /* Local default branch link */
702 if (create_symref("HEAD", our->name, NULL) < 0)
703 die(_("unable to update HEAD"));
704 if (!option_bare) {
705 update_ref(msg, "HEAD", &our->old_oid, NULL, 0,
706 UPDATE_REFS_DIE_ON_ERR);
707 install_branch_config(0, head, option_origin, our->name);
708 }
709 } else if (our) {
710 struct commit *c = lookup_commit_reference(the_repository,
711 &our->old_oid);
712 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
713 update_ref(msg, "HEAD", &c->object.oid, NULL, REF_NO_DEREF,
714 UPDATE_REFS_DIE_ON_ERR);
715 } else if (remote) {
716 /*
717 * We know remote HEAD points to a non-branch, or
718 * HEAD points to a branch but we don't know which one.
719 * Detach HEAD in all these cases.
720 */
721 update_ref(msg, "HEAD", &remote->old_oid, NULL, REF_NO_DEREF,
722 UPDATE_REFS_DIE_ON_ERR);
723 }
724}
725static int checkout(int submodule_progress)
727{
728 struct object_id oid;
729 char *head;
730 struct lock_file lock_file = LOCK_INIT;
731 struct unpack_trees_options opts;
732 struct tree *tree;
733 struct tree_desc t;
734 int err = 0;
735 if (option_no_checkout)
737 return 0;
738 head = resolve_refdup("HEAD", RESOLVE_REF_READING, &oid, NULL);
740 if (!head) {
741 warning(_("remote HEAD refers to nonexistent ref, "
742 "unable to checkout.\n"));
743 return 0;
744 }
745 if (!strcmp(head, "HEAD")) {
746 if (advice_detached_head)
747 detach_advice(oid_to_hex(&oid));
748 } else {
749 if (!starts_with(head, "refs/heads/"))
750 die(_("HEAD not found below refs/heads!"));
751 }
752 free(head);
753 /* We need to be in the new work tree for the checkout */
755 setup_work_tree();
756 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
758 memset(&opts, 0, sizeof opts);
760 opts.update = 1;
761 opts.merge = 1;
762 opts.clone = 1;
763 opts.fn = oneway_merge;
764 opts.verbose_update = (option_verbosity >= 0);
765 opts.src_index = &the_index;
766 opts.dst_index = &the_index;
767 tree = parse_tree_indirect(&oid);
769 parse_tree(tree);
770 init_tree_desc(&t, tree->buffer, tree->size);
771 if (unpack_trees(1, &t, &opts) < 0)
772 die(_("unable to checkout working tree"));
773 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
775 die(_("unable to write new index file"));
776 err |= run_hook_le(NULL, "post-checkout", sha1_to_hex(null_sha1),
778 oid_to_hex(&oid), "1", NULL);
779 if (!err && (option_recurse_submodules.nr > 0)) {
781 struct argv_array args = ARGV_ARRAY_INIT;
782 argv_array_pushl(&args, "submodule", "update", "--init", "--recursive", NULL);
783 if (option_shallow_submodules == 1)
785 argv_array_push(&args, "--depth=1");
786 if (max_jobs != -1)
788 argv_array_pushf(&args, "--jobs=%d", max_jobs);
789 if (submodule_progress)
791 argv_array_push(&args, "--progress");
792 if (option_verbosity < 0)
794 argv_array_push(&args, "--quiet");
795 if (option_remote_submodules) {
797 argv_array_push(&args, "--remote");
798 argv_array_push(&args, "--no-fetch");
799 }
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(option_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}