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