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