l10n: bg.po: Updated Bulgarian translation (5482t)
[git.git] / builtin / clone.c
blobe21d42dfee54338c4beba9431b469d1f285c0bdf
1 /*
2 * Builtin "git clone"
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
8 * Clone a repository into a different directory that does not yet exist.
9 */
11 #define USE_THE_INDEX_COMPATIBILITY_MACROS
12 #include "builtin.h"
13 #include "config.h"
14 #include "lockfile.h"
15 #include "parse-options.h"
16 #include "fetch-pack.h"
17 #include "refs.h"
18 #include "refspec.h"
19 #include "object-store.h"
20 #include "tree.h"
21 #include "tree-walk.h"
22 #include "unpack-trees.h"
23 #include "transport.h"
24 #include "strbuf.h"
25 #include "dir.h"
26 #include "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 "hook.h"
36 #include "bundle.h"
37 #include "bundle-uri.h"
40 * Overall FIXMEs:
41 * - respect DB_ENVIRONMENT for .git/objects.
43 * Implementation notes:
44 * - dropping use-separate-remote and no-separate-remote compatibility
47 static const char * const builtin_clone_usage[] = {
48 N_("git clone [<options>] [--] <repo> [<dir>]"),
49 NULL
52 static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
53 static int option_local = -1, option_no_hardlinks, option_shared;
54 static int option_no_tags;
55 static int option_shallow_submodules;
56 static int option_reject_shallow = -1; /* unspecified */
57 static int config_reject_shallow = -1; /* unspecified */
58 static int deepen;
59 static char *option_template, *option_depth, *option_since;
60 static char *option_origin = NULL;
61 static char *remote_name = NULL;
62 static char *option_branch = NULL;
63 static struct string_list option_not = STRING_LIST_INIT_NODUP;
64 static const char *real_git_dir;
65 static char *option_upload_pack = "git-upload-pack";
66 static int option_verbosity;
67 static int option_progress = -1;
68 static int option_sparse_checkout;
69 static enum transport_family family;
70 static struct string_list option_config = STRING_LIST_INIT_NODUP;
71 static struct string_list option_required_reference = STRING_LIST_INIT_NODUP;
72 static struct string_list option_optional_reference = STRING_LIST_INIT_NODUP;
73 static int option_dissociate;
74 static int max_jobs = -1;
75 static struct string_list option_recurse_submodules = STRING_LIST_INIT_NODUP;
76 static struct list_objects_filter_options filter_options;
77 static int option_filter_submodules = -1; /* unspecified */
78 static int config_filter_submodules = -1; /* unspecified */
79 static struct string_list server_options = STRING_LIST_INIT_NODUP;
80 static int option_remote_submodules;
81 static const char *bundle_uri;
83 static int recurse_submodules_cb(const struct option *opt,
84 const char *arg, int unset)
86 if (unset)
87 string_list_clear((struct string_list *)opt->value, 0);
88 else if (arg)
89 string_list_append((struct string_list *)opt->value, arg);
90 else
91 string_list_append((struct string_list *)opt->value,
92 (const char *)opt->defval);
94 return 0;
97 static struct option builtin_clone_options[] = {
98 OPT__VERBOSITY(&option_verbosity),
99 OPT_BOOL(0, "progress", &option_progress,
100 N_("force progress reporting")),
101 OPT_BOOL(0, "reject-shallow", &option_reject_shallow,
102 N_("don't clone shallow repository")),
103 OPT_BOOL('n', "no-checkout", &option_no_checkout,
104 N_("don't create a checkout")),
105 OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
106 OPT_HIDDEN_BOOL(0, "naked", &option_bare,
107 N_("create a bare repository")),
108 OPT_BOOL(0, "mirror", &option_mirror,
109 N_("create a mirror repository (implies bare)")),
110 OPT_BOOL('l', "local", &option_local,
111 N_("to clone from a local repository")),
112 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
113 N_("don't use local hardlinks, always copy")),
114 OPT_BOOL('s', "shared", &option_shared,
115 N_("setup as shared repository")),
116 { OPTION_CALLBACK, 0, "recurse-submodules", &option_recurse_submodules,
117 N_("pathspec"), N_("initialize submodules in the clone"),
118 PARSE_OPT_OPTARG, recurse_submodules_cb, (intptr_t)"." },
119 OPT_ALIAS(0, "recursive", "recurse-submodules"),
120 OPT_INTEGER('j', "jobs", &max_jobs,
121 N_("number of submodules cloned in parallel")),
122 OPT_STRING(0, "template", &option_template, N_("template-directory"),
123 N_("directory from which templates will be used")),
124 OPT_STRING_LIST(0, "reference", &option_required_reference, N_("repo"),
125 N_("reference repository")),
126 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference,
127 N_("repo"), N_("reference repository")),
128 OPT_BOOL(0, "dissociate", &option_dissociate,
129 N_("use --reference only while cloning")),
130 OPT_STRING('o', "origin", &option_origin, N_("name"),
131 N_("use <name> instead of 'origin' to track upstream")),
132 OPT_STRING('b', "branch", &option_branch, N_("branch"),
133 N_("checkout <branch> instead of the remote's HEAD")),
134 OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
135 N_("path to git-upload-pack on the remote")),
136 OPT_STRING(0, "depth", &option_depth, N_("depth"),
137 N_("create a shallow clone of that depth")),
138 OPT_STRING(0, "shallow-since", &option_since, N_("time"),
139 N_("create a shallow clone since a specific time")),
140 OPT_STRING_LIST(0, "shallow-exclude", &option_not, N_("revision"),
141 N_("deepen history of shallow clone, excluding rev")),
142 OPT_BOOL(0, "single-branch", &option_single_branch,
143 N_("clone only one branch, HEAD or --branch")),
144 OPT_BOOL(0, "no-tags", &option_no_tags,
145 N_("don't clone any tags, and make later fetches not to follow them")),
146 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules,
147 N_("any cloned submodules will be shallow")),
148 OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
149 N_("separate git dir from working tree")),
150 OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
151 N_("set config inside the new repository")),
152 OPT_STRING_LIST(0, "server-option", &server_options,
153 N_("server-specific"), N_("option to transmit")),
154 OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
155 TRANSPORT_FAMILY_IPV4),
156 OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
157 TRANSPORT_FAMILY_IPV6),
158 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
159 OPT_BOOL(0, "also-filter-submodules", &option_filter_submodules,
160 N_("apply partial clone filters to submodules")),
161 OPT_BOOL(0, "remote-submodules", &option_remote_submodules,
162 N_("any cloned submodules will use their remote-tracking branch")),
163 OPT_BOOL(0, "sparse", &option_sparse_checkout,
164 N_("initialize sparse-checkout file to include only files at root")),
165 OPT_STRING(0, "bundle-uri", &bundle_uri,
166 N_("uri"), N_("a URI for downloading bundles before fetching from origin remote")),
167 OPT_END()
170 static const char *get_repo_path_1(struct strbuf *path, int *is_bundle)
172 static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
173 static char *bundle_suffix[] = { ".bundle", "" };
174 size_t baselen = path->len;
175 struct stat st;
176 int i;
178 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
179 strbuf_setlen(path, baselen);
180 strbuf_addstr(path, suffix[i]);
181 if (stat(path->buf, &st))
182 continue;
183 if (S_ISDIR(st.st_mode) && is_git_directory(path->buf)) {
184 *is_bundle = 0;
185 return path->buf;
186 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
187 /* Is it a "gitfile"? */
188 char signature[8];
189 const char *dst;
190 int len, fd = open(path->buf, O_RDONLY);
191 if (fd < 0)
192 continue;
193 len = read_in_full(fd, signature, 8);
194 close(fd);
195 if (len != 8 || strncmp(signature, "gitdir: ", 8))
196 continue;
197 dst = read_gitfile(path->buf);
198 if (dst) {
199 *is_bundle = 0;
200 return dst;
205 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
206 strbuf_setlen(path, baselen);
207 strbuf_addstr(path, bundle_suffix[i]);
208 if (!stat(path->buf, &st) && S_ISREG(st.st_mode)) {
209 *is_bundle = 1;
210 return path->buf;
214 return NULL;
217 static char *get_repo_path(const char *repo, int *is_bundle)
219 struct strbuf path = STRBUF_INIT;
220 const char *raw;
221 char *canon;
223 strbuf_addstr(&path, repo);
224 raw = get_repo_path_1(&path, is_bundle);
225 canon = raw ? absolute_pathdup(raw) : NULL;
226 strbuf_release(&path);
227 return canon;
230 static int add_one_reference(struct string_list_item *item, void *cb_data)
232 struct strbuf err = STRBUF_INIT;
233 int *required = cb_data;
234 char *ref_git = compute_alternate_path(item->string, &err);
236 if (!ref_git) {
237 if (*required)
238 die("%s", err.buf);
239 else
240 fprintf(stderr,
241 _("info: Could not add alternate for '%s': %s\n"),
242 item->string, err.buf);
243 } else {
244 struct strbuf sb = STRBUF_INIT;
245 strbuf_addf(&sb, "%s/objects", ref_git);
246 add_to_alternates_file(sb.buf);
247 strbuf_release(&sb);
250 strbuf_release(&err);
251 free(ref_git);
252 return 0;
255 static void setup_reference(void)
257 int required = 1;
258 for_each_string_list(&option_required_reference,
259 add_one_reference, &required);
260 required = 0;
261 for_each_string_list(&option_optional_reference,
262 add_one_reference, &required);
265 static void copy_alternates(struct strbuf *src, const char *src_repo)
268 * Read from the source objects/info/alternates file
269 * and copy the entries to corresponding file in the
270 * destination repository with add_to_alternates_file().
271 * Both src and dst have "$path/objects/info/alternates".
273 * Instead of copying bit-for-bit from the original,
274 * we need to append to existing one so that the already
275 * created entry via "clone -s" is not lost, and also
276 * to turn entries with paths relative to the original
277 * absolute, so that they can be used in the new repository.
279 FILE *in = xfopen(src->buf, "r");
280 struct strbuf line = STRBUF_INIT;
282 while (strbuf_getline(&line, in) != EOF) {
283 char *abs_path;
284 if (!line.len || line.buf[0] == '#')
285 continue;
286 if (is_absolute_path(line.buf)) {
287 add_to_alternates_file(line.buf);
288 continue;
290 abs_path = mkpathdup("%s/objects/%s", src_repo, line.buf);
291 if (!normalize_path_copy(abs_path, abs_path))
292 add_to_alternates_file(abs_path);
293 else
294 warning("skipping invalid relative alternate: %s/%s",
295 src_repo, line.buf);
296 free(abs_path);
298 strbuf_release(&line);
299 fclose(in);
302 static void mkdir_if_missing(const char *pathname, mode_t mode)
304 struct stat st;
306 if (!mkdir(pathname, mode))
307 return;
309 if (errno != EEXIST)
310 die_errno(_("failed to create directory '%s'"), pathname);
311 else if (stat(pathname, &st))
312 die_errno(_("failed to stat '%s'"), pathname);
313 else if (!S_ISDIR(st.st_mode))
314 die(_("%s exists and is not a directory"), pathname);
317 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
318 const char *src_repo)
320 int src_len, dest_len;
321 struct dir_iterator *iter;
322 int iter_status;
323 unsigned int flags;
324 struct strbuf realpath = STRBUF_INIT;
326 mkdir_if_missing(dest->buf, 0777);
328 flags = DIR_ITERATOR_PEDANTIC | DIR_ITERATOR_FOLLOW_SYMLINKS;
329 iter = dir_iterator_begin(src->buf, flags);
331 if (!iter)
332 die_errno(_("failed to start iterator over '%s'"), src->buf);
334 strbuf_addch(src, '/');
335 src_len = src->len;
336 strbuf_addch(dest, '/');
337 dest_len = dest->len;
339 while ((iter_status = dir_iterator_advance(iter)) == ITER_OK) {
340 strbuf_setlen(src, src_len);
341 strbuf_addstr(src, iter->relative_path);
342 strbuf_setlen(dest, dest_len);
343 strbuf_addstr(dest, iter->relative_path);
345 if (S_ISDIR(iter->st.st_mode)) {
346 mkdir_if_missing(dest->buf, 0777);
347 continue;
350 /* Files that cannot be copied bit-for-bit... */
351 if (!fspathcmp(iter->relative_path, "info/alternates")) {
352 copy_alternates(src, src_repo);
353 continue;
356 if (unlink(dest->buf) && errno != ENOENT)
357 die_errno(_("failed to unlink '%s'"), dest->buf);
358 if (!option_no_hardlinks) {
359 strbuf_realpath(&realpath, src->buf, 1);
360 if (!link(realpath.buf, dest->buf))
361 continue;
362 if (option_local > 0)
363 die_errno(_("failed to create link '%s'"), dest->buf);
364 option_no_hardlinks = 1;
366 if (copy_file_with_time(dest->buf, src->buf, 0666))
367 die_errno(_("failed to copy file to '%s'"), dest->buf);
370 if (iter_status != ITER_DONE) {
371 strbuf_setlen(src, src_len);
372 die(_("failed to iterate over '%s'"), src->buf);
375 strbuf_release(&realpath);
378 static void clone_local(const char *src_repo, const char *dest_repo)
380 if (option_shared) {
381 struct strbuf alt = STRBUF_INIT;
382 get_common_dir(&alt, src_repo);
383 strbuf_addstr(&alt, "/objects");
384 add_to_alternates_file(alt.buf);
385 strbuf_release(&alt);
386 } else {
387 struct strbuf src = STRBUF_INIT;
388 struct strbuf dest = STRBUF_INIT;
389 get_common_dir(&src, src_repo);
390 get_common_dir(&dest, dest_repo);
391 strbuf_addstr(&src, "/objects");
392 strbuf_addstr(&dest, "/objects");
393 copy_or_link_directory(&src, &dest, src_repo);
394 strbuf_release(&src);
395 strbuf_release(&dest);
398 if (0 <= option_verbosity)
399 fprintf(stderr, _("done.\n"));
402 static const char *junk_work_tree;
403 static int junk_work_tree_flags;
404 static const char *junk_git_dir;
405 static int junk_git_dir_flags;
406 static enum {
407 JUNK_LEAVE_NONE,
408 JUNK_LEAVE_REPO,
409 JUNK_LEAVE_ALL
410 } junk_mode = JUNK_LEAVE_NONE;
412 static const char junk_leave_repo_msg[] =
413 N_("Clone succeeded, but checkout failed.\n"
414 "You can inspect what was checked out with 'git status'\n"
415 "and retry with 'git restore --source=HEAD :/'\n");
417 static void remove_junk(void)
419 struct strbuf sb = STRBUF_INIT;
421 switch (junk_mode) {
422 case JUNK_LEAVE_REPO:
423 warning("%s", _(junk_leave_repo_msg));
424 /* fall-through */
425 case JUNK_LEAVE_ALL:
426 return;
427 default:
428 /* proceed to removal */
429 break;
432 if (junk_git_dir) {
433 strbuf_addstr(&sb, junk_git_dir);
434 remove_dir_recursively(&sb, junk_git_dir_flags);
435 strbuf_reset(&sb);
437 if (junk_work_tree) {
438 strbuf_addstr(&sb, junk_work_tree);
439 remove_dir_recursively(&sb, junk_work_tree_flags);
441 strbuf_release(&sb);
444 static void remove_junk_on_signal(int signo)
446 remove_junk();
447 sigchain_pop(signo);
448 raise(signo);
451 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
453 struct ref *ref;
454 struct strbuf head = STRBUF_INIT;
455 strbuf_addstr(&head, "refs/heads/");
456 strbuf_addstr(&head, branch);
457 ref = find_ref_by_name(refs, head.buf);
458 strbuf_release(&head);
460 if (ref)
461 return ref;
463 strbuf_addstr(&head, "refs/tags/");
464 strbuf_addstr(&head, branch);
465 ref = find_ref_by_name(refs, head.buf);
466 strbuf_release(&head);
468 return ref;
471 static struct ref *wanted_peer_refs(const struct ref *refs,
472 struct refspec *refspec)
474 struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
475 struct ref *local_refs = head;
476 struct ref **tail = head ? &head->next : &local_refs;
478 if (option_single_branch) {
479 struct ref *remote_head = NULL;
481 if (!option_branch)
482 remote_head = guess_remote_head(head, refs, 0);
483 else {
484 local_refs = NULL;
485 tail = &local_refs;
486 remote_head = copy_ref(find_remote_branch(refs, option_branch));
489 if (!remote_head && option_branch)
490 warning(_("Could not find remote branch %s to clone."),
491 option_branch);
492 else {
493 int i;
494 for (i = 0; i < refspec->nr; i++)
495 get_fetch_map(remote_head, &refspec->items[i],
496 &tail, 0);
498 /* if --branch=tag, pull the requested tag explicitly */
499 get_fetch_map(remote_head, tag_refspec, &tail, 0);
501 free_refs(remote_head);
502 } else {
503 int i;
504 for (i = 0; i < refspec->nr; i++)
505 get_fetch_map(refs, &refspec->items[i], &tail, 0);
508 if (!option_mirror && !option_single_branch && !option_no_tags)
509 get_fetch_map(refs, tag_refspec, &tail, 0);
511 return local_refs;
514 static void write_remote_refs(const struct ref *local_refs)
516 const struct ref *r;
518 struct ref_transaction *t;
519 struct strbuf err = STRBUF_INIT;
521 t = ref_transaction_begin(&err);
522 if (!t)
523 die("%s", err.buf);
525 for (r = local_refs; r; r = r->next) {
526 if (!r->peer_ref)
527 continue;
528 if (ref_transaction_create(t, r->peer_ref->name, &r->old_oid,
529 0, NULL, &err))
530 die("%s", err.buf);
533 if (initial_ref_transaction_commit(t, &err))
534 die("%s", err.buf);
536 strbuf_release(&err);
537 ref_transaction_free(t);
540 static void write_followtags(const struct ref *refs, const char *msg)
542 const struct ref *ref;
543 for (ref = refs; ref; ref = ref->next) {
544 if (!starts_with(ref->name, "refs/tags/"))
545 continue;
546 if (ends_with(ref->name, "^{}"))
547 continue;
548 if (!has_object_file_with_flags(&ref->old_oid,
549 OBJECT_INFO_QUICK |
550 OBJECT_INFO_SKIP_FETCH_OBJECT))
551 continue;
552 update_ref(msg, ref->name, &ref->old_oid, NULL, 0,
553 UPDATE_REFS_DIE_ON_ERR);
557 static const struct object_id *iterate_ref_map(void *cb_data)
559 struct ref **rm = cb_data;
560 struct ref *ref = *rm;
563 * Skip anything missing a peer_ref, which we are not
564 * actually going to write a ref for.
566 while (ref && !ref->peer_ref)
567 ref = ref->next;
568 if (!ref)
569 return NULL;
571 *rm = ref->next;
572 return &ref->old_oid;
575 static void update_remote_refs(const struct ref *refs,
576 const struct ref *mapped_refs,
577 const struct ref *remote_head_points_at,
578 const char *branch_top,
579 const char *msg,
580 struct transport *transport,
581 int check_connectivity)
583 const struct ref *rm = mapped_refs;
585 if (check_connectivity) {
586 struct check_connected_options opt = CHECK_CONNECTED_INIT;
588 opt.transport = transport;
589 opt.progress = transport->progress;
591 if (check_connected(iterate_ref_map, &rm, &opt))
592 die(_("remote did not send all necessary objects"));
595 if (refs) {
596 write_remote_refs(mapped_refs);
597 if (option_single_branch && !option_no_tags)
598 write_followtags(refs, msg);
601 if (remote_head_points_at && !option_bare) {
602 struct strbuf head_ref = STRBUF_INIT;
603 strbuf_addstr(&head_ref, branch_top);
604 strbuf_addstr(&head_ref, "HEAD");
605 if (create_symref(head_ref.buf,
606 remote_head_points_at->peer_ref->name,
607 msg) < 0)
608 die(_("unable to update %s"), head_ref.buf);
609 strbuf_release(&head_ref);
613 static void update_head(const struct ref *our, const struct ref *remote,
614 const char *unborn, const char *msg)
616 const char *head;
617 if (our && skip_prefix(our->name, "refs/heads/", &head)) {
618 /* Local default branch link */
619 if (create_symref("HEAD", our->name, NULL) < 0)
620 die(_("unable to update HEAD"));
621 if (!option_bare) {
622 update_ref(msg, "HEAD", &our->old_oid, NULL, 0,
623 UPDATE_REFS_DIE_ON_ERR);
624 install_branch_config(0, head, remote_name, our->name);
626 } else if (our) {
627 struct commit *c = lookup_commit_reference(the_repository,
628 &our->old_oid);
629 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
630 update_ref(msg, "HEAD", &c->object.oid, NULL, REF_NO_DEREF,
631 UPDATE_REFS_DIE_ON_ERR);
632 } else if (remote) {
634 * We know remote HEAD points to a non-branch, or
635 * HEAD points to a branch but we don't know which one.
636 * Detach HEAD in all these cases.
638 update_ref(msg, "HEAD", &remote->old_oid, NULL, REF_NO_DEREF,
639 UPDATE_REFS_DIE_ON_ERR);
640 } else if (unborn && skip_prefix(unborn, "refs/heads/", &head)) {
642 * Unborn head from remote; same as "our" case above except
643 * that we have no ref to update.
645 if (create_symref("HEAD", unborn, NULL) < 0)
646 die(_("unable to update HEAD"));
647 if (!option_bare)
648 install_branch_config(0, head, remote_name, unborn);
652 static int git_sparse_checkout_init(const char *repo)
654 struct strvec argv = STRVEC_INIT;
655 int result = 0;
656 strvec_pushl(&argv, "-C", repo, "sparse-checkout", "set", NULL);
659 * We must apply the setting in the current process
660 * for the later checkout to use the sparse-checkout file.
662 core_apply_sparse_checkout = 1;
664 if (run_command_v_opt(argv.v, RUN_GIT_CMD)) {
665 error(_("failed to initialize sparse-checkout"));
666 result = 1;
669 strvec_clear(&argv);
670 return result;
673 static int checkout(int submodule_progress, int filter_submodules)
675 struct object_id oid;
676 char *head;
677 struct lock_file lock_file = LOCK_INIT;
678 struct unpack_trees_options opts;
679 struct tree *tree;
680 struct tree_desc t;
681 int err = 0;
683 if (option_no_checkout)
684 return 0;
686 head = resolve_refdup("HEAD", RESOLVE_REF_READING, &oid, NULL);
687 if (!head) {
688 warning(_("remote HEAD refers to nonexistent ref, "
689 "unable to checkout"));
690 return 0;
692 if (!strcmp(head, "HEAD")) {
693 if (advice_enabled(ADVICE_DETACHED_HEAD))
694 detach_advice(oid_to_hex(&oid));
695 FREE_AND_NULL(head);
696 } else {
697 if (!starts_with(head, "refs/heads/"))
698 die(_("HEAD not found below refs/heads!"));
701 /* We need to be in the new work tree for the checkout */
702 setup_work_tree();
704 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
706 memset(&opts, 0, sizeof opts);
707 opts.update = 1;
708 opts.merge = 1;
709 opts.clone = 1;
710 opts.preserve_ignored = 0;
711 opts.fn = oneway_merge;
712 opts.verbose_update = (option_verbosity >= 0);
713 opts.src_index = &the_index;
714 opts.dst_index = &the_index;
715 init_checkout_metadata(&opts.meta, head, &oid, NULL);
717 tree = parse_tree_indirect(&oid);
718 if (!tree)
719 die(_("unable to parse commit %s"), oid_to_hex(&oid));
720 parse_tree(tree);
721 init_tree_desc(&t, tree->buffer, tree->size);
722 if (unpack_trees(1, &t, &opts) < 0)
723 die(_("unable to checkout working tree"));
725 free(head);
727 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
728 die(_("unable to write new index file"));
730 err |= run_hooks_l("post-checkout", oid_to_hex(null_oid()),
731 oid_to_hex(&oid), "1", NULL);
733 if (!err && (option_recurse_submodules.nr > 0)) {
734 struct strvec args = STRVEC_INIT;
735 strvec_pushl(&args, "submodule", "update", "--require-init", "--recursive", NULL);
737 if (option_shallow_submodules == 1)
738 strvec_push(&args, "--depth=1");
740 if (max_jobs != -1)
741 strvec_pushf(&args, "--jobs=%d", max_jobs);
743 if (submodule_progress)
744 strvec_push(&args, "--progress");
746 if (option_verbosity < 0)
747 strvec_push(&args, "--quiet");
749 if (option_remote_submodules) {
750 strvec_push(&args, "--remote");
751 strvec_push(&args, "--no-fetch");
754 if (filter_submodules && filter_options.choice)
755 strvec_pushf(&args, "--filter=%s",
756 expand_list_objects_filter_spec(&filter_options));
758 if (option_single_branch >= 0)
759 strvec_push(&args, option_single_branch ?
760 "--single-branch" :
761 "--no-single-branch");
763 err = run_command_v_opt(args.v, RUN_GIT_CMD);
764 strvec_clear(&args);
767 return err;
770 static int git_clone_config(const char *k, const char *v, void *cb)
772 if (!strcmp(k, "clone.defaultremotename")) {
773 free(remote_name);
774 remote_name = xstrdup(v);
776 if (!strcmp(k, "clone.rejectshallow"))
777 config_reject_shallow = git_config_bool(k, v);
778 if (!strcmp(k, "clone.filtersubmodules"))
779 config_filter_submodules = git_config_bool(k, v);
781 return git_default_config(k, v, cb);
784 static int write_one_config(const char *key, const char *value, void *data)
787 * give git_clone_config a chance to write config values back to the
788 * environment, since git_config_set_multivar_gently only deals with
789 * config-file writes
791 int apply_failed = git_clone_config(key, value, data);
792 if (apply_failed)
793 return apply_failed;
795 return git_config_set_multivar_gently(key,
796 value ? value : "true",
797 CONFIG_REGEX_NONE, 0);
800 static void write_config(struct string_list *config)
802 int i;
804 for (i = 0; i < config->nr; i++) {
805 if (git_config_parse_parameter(config->items[i].string,
806 write_one_config, NULL) < 0)
807 die(_("unable to write parameters to config file"));
811 static void write_refspec_config(const char *src_ref_prefix,
812 const struct ref *our_head_points_at,
813 const struct ref *remote_head_points_at,
814 struct strbuf *branch_top)
816 struct strbuf key = STRBUF_INIT;
817 struct strbuf value = STRBUF_INIT;
819 if (option_mirror || !option_bare) {
820 if (option_single_branch && !option_mirror) {
821 if (option_branch) {
822 if (starts_with(our_head_points_at->name, "refs/tags/"))
823 strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
824 our_head_points_at->name);
825 else
826 strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
827 branch_top->buf, option_branch);
828 } else if (remote_head_points_at) {
829 const char *head = remote_head_points_at->name;
830 if (!skip_prefix(head, "refs/heads/", &head))
831 BUG("remote HEAD points at non-head?");
833 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
834 branch_top->buf, head);
837 * otherwise, the next "git fetch" will
838 * simply fetch from HEAD without updating
839 * any remote-tracking branch, which is what
840 * we want.
842 } else {
843 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
845 /* Configure the remote */
846 if (value.len) {
847 strbuf_addf(&key, "remote.%s.fetch", remote_name);
848 git_config_set_multivar(key.buf, value.buf, "^$", 0);
849 strbuf_reset(&key);
851 if (option_mirror) {
852 strbuf_addf(&key, "remote.%s.mirror", remote_name);
853 git_config_set(key.buf, "true");
854 strbuf_reset(&key);
859 strbuf_release(&key);
860 strbuf_release(&value);
863 static void dissociate_from_references(void)
865 static const char* argv[] = { "repack", "-a", "-d", NULL };
866 char *alternates = git_pathdup("objects/info/alternates");
868 if (!access(alternates, F_OK)) {
869 if (run_command_v_opt(argv, RUN_GIT_CMD|RUN_COMMAND_NO_STDIN))
870 die(_("cannot repack to clean up"));
871 if (unlink(alternates) && errno != ENOENT)
872 die_errno(_("cannot unlink temporary alternates file"));
874 free(alternates);
877 static int path_exists(const char *path)
879 struct stat sb;
880 return !stat(path, &sb);
883 int cmd_clone(int argc, const char **argv, const char *prefix)
885 int is_bundle = 0, is_local;
886 int reject_shallow = 0;
887 const char *repo_name, *repo, *work_tree, *git_dir;
888 char *path = NULL, *dir, *display_repo = NULL;
889 int dest_exists, real_dest_exists = 0;
890 const struct ref *refs, *remote_head;
891 struct ref *remote_head_points_at = NULL;
892 const struct ref *our_head_points_at;
893 char *unborn_head = NULL;
894 struct ref *mapped_refs = NULL;
895 const struct ref *ref;
896 struct strbuf key = STRBUF_INIT;
897 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
898 struct transport *transport = NULL;
899 const char *src_ref_prefix = "refs/heads/";
900 struct remote *remote;
901 int err = 0, complete_refs_before_fetch = 1;
902 int submodule_progress;
903 int filter_submodules = 0;
905 struct transport_ls_refs_options transport_ls_refs_options =
906 TRANSPORT_LS_REFS_OPTIONS_INIT;
908 packet_trace_identity("clone");
910 git_config(git_clone_config, NULL);
912 argc = parse_options(argc, argv, prefix, builtin_clone_options,
913 builtin_clone_usage, 0);
915 if (argc > 2)
916 usage_msg_opt(_("Too many arguments."),
917 builtin_clone_usage, builtin_clone_options);
919 if (argc == 0)
920 usage_msg_opt(_("You must specify a repository to clone."),
921 builtin_clone_usage, builtin_clone_options);
923 if (option_depth || option_since || option_not.nr)
924 deepen = 1;
925 if (option_single_branch == -1)
926 option_single_branch = deepen ? 1 : 0;
928 if (option_mirror)
929 option_bare = 1;
931 if (option_bare) {
932 if (option_origin)
933 die(_("options '%s' and '%s %s' cannot be used together"),
934 "--bare", "--origin", option_origin);
935 if (real_git_dir)
936 die(_("options '%s' and '%s' cannot be used together"), "--bare", "--separate-git-dir");
937 option_no_checkout = 1;
940 if (bundle_uri && deepen)
941 die(_("--bundle-uri is incompatible with --depth, --shallow-since, and --shallow-exclude"));
943 repo_name = argv[0];
945 path = get_repo_path(repo_name, &is_bundle);
946 if (path) {
947 FREE_AND_NULL(path);
948 repo = absolute_pathdup(repo_name);
949 } else if (strchr(repo_name, ':')) {
950 repo = repo_name;
951 display_repo = transport_anonymize_url(repo);
952 } else
953 die(_("repository '%s' does not exist"), repo_name);
955 /* no need to be strict, transport_set_option() will validate it again */
956 if (option_depth && atoi(option_depth) < 1)
957 die(_("depth %s is not a positive number"), option_depth);
959 if (argc == 2)
960 dir = xstrdup(argv[1]);
961 else
962 dir = git_url_basename(repo_name, is_bundle, option_bare);
963 strip_dir_trailing_slashes(dir);
965 dest_exists = path_exists(dir);
966 if (dest_exists && !is_empty_dir(dir))
967 die(_("destination path '%s' already exists and is not "
968 "an empty directory."), dir);
970 if (real_git_dir) {
971 real_dest_exists = path_exists(real_git_dir);
972 if (real_dest_exists && !is_empty_dir(real_git_dir))
973 die(_("repository path '%s' already exists and is not "
974 "an empty directory."), real_git_dir);
978 strbuf_addf(&reflog_msg, "clone: from %s",
979 display_repo ? display_repo : repo);
980 free(display_repo);
982 if (option_bare)
983 work_tree = NULL;
984 else {
985 work_tree = getenv("GIT_WORK_TREE");
986 if (work_tree && path_exists(work_tree))
987 die(_("working tree '%s' already exists."), work_tree);
990 if (option_bare || work_tree)
991 git_dir = xstrdup(dir);
992 else {
993 work_tree = dir;
994 git_dir = mkpathdup("%s/.git", dir);
997 atexit(remove_junk);
998 sigchain_push_common(remove_junk_on_signal);
1000 if (!option_bare) {
1001 if (safe_create_leading_directories_const(work_tree) < 0)
1002 die_errno(_("could not create leading directories of '%s'"),
1003 work_tree);
1004 if (dest_exists)
1005 junk_work_tree_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1006 else if (mkdir(work_tree, 0777))
1007 die_errno(_("could not create work tree dir '%s'"),
1008 work_tree);
1009 junk_work_tree = work_tree;
1010 set_git_work_tree(work_tree);
1013 if (real_git_dir) {
1014 if (real_dest_exists)
1015 junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1016 junk_git_dir = real_git_dir;
1017 } else {
1018 if (dest_exists)
1019 junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1020 junk_git_dir = git_dir;
1022 if (safe_create_leading_directories_const(git_dir) < 0)
1023 die(_("could not create leading directories of '%s'"), git_dir);
1025 if (0 <= option_verbosity) {
1026 if (option_bare)
1027 fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
1028 else
1029 fprintf(stderr, _("Cloning into '%s'...\n"), dir);
1032 if (option_recurse_submodules.nr > 0) {
1033 struct string_list_item *item;
1034 struct strbuf sb = STRBUF_INIT;
1035 int val;
1037 /* remove duplicates */
1038 string_list_sort(&option_recurse_submodules);
1039 string_list_remove_duplicates(&option_recurse_submodules, 0);
1042 * NEEDSWORK: In a multi-working-tree world, this needs to be
1043 * set in the per-worktree config.
1045 for_each_string_list_item(item, &option_recurse_submodules) {
1046 strbuf_addf(&sb, "submodule.active=%s",
1047 item->string);
1048 string_list_append(&option_config,
1049 strbuf_detach(&sb, NULL));
1052 if (!git_config_get_bool("submodule.stickyRecursiveClone", &val) &&
1053 val)
1054 string_list_append(&option_config, "submodule.recurse=true");
1056 if (option_required_reference.nr &&
1057 option_optional_reference.nr)
1058 die(_("clone --recursive is not compatible with "
1059 "both --reference and --reference-if-able"));
1060 else if (option_required_reference.nr) {
1061 string_list_append(&option_config,
1062 "submodule.alternateLocation=superproject");
1063 string_list_append(&option_config,
1064 "submodule.alternateErrorStrategy=die");
1065 } else if (option_optional_reference.nr) {
1066 string_list_append(&option_config,
1067 "submodule.alternateLocation=superproject");
1068 string_list_append(&option_config,
1069 "submodule.alternateErrorStrategy=info");
1073 init_db(git_dir, real_git_dir, option_template, GIT_HASH_UNKNOWN, NULL,
1074 INIT_DB_QUIET);
1076 if (real_git_dir) {
1077 free((char *)git_dir);
1078 git_dir = real_git_dir;
1082 * additional config can be injected with -c, make sure it's included
1083 * after init_db, which clears the entire config environment.
1085 write_config(&option_config);
1088 * re-read config after init_db and write_config to pick up any config
1089 * injected by --template and --config, respectively.
1091 git_config(git_clone_config, NULL);
1094 * If option_reject_shallow is specified from CLI option,
1095 * ignore config_reject_shallow from git_clone_config.
1097 if (config_reject_shallow != -1)
1098 reject_shallow = config_reject_shallow;
1099 if (option_reject_shallow != -1)
1100 reject_shallow = option_reject_shallow;
1103 * If option_filter_submodules is specified from CLI option,
1104 * ignore config_filter_submodules from git_clone_config.
1106 if (config_filter_submodules != -1)
1107 filter_submodules = config_filter_submodules;
1108 if (option_filter_submodules != -1)
1109 filter_submodules = option_filter_submodules;
1112 * Exit if the user seems to be doing something silly with submodule
1113 * filter flags (but not with filter configs, as those should be
1114 * set-and-forget).
1116 if (option_filter_submodules > 0 && !filter_options.choice)
1117 die(_("the option '%s' requires '%s'"),
1118 "--also-filter-submodules", "--filter");
1119 if (option_filter_submodules > 0 && !option_recurse_submodules.nr)
1120 die(_("the option '%s' requires '%s'"),
1121 "--also-filter-submodules", "--recurse-submodules");
1124 * apply the remote name provided by --origin only after this second
1125 * call to git_config, to ensure it overrides all config-based values.
1127 if (option_origin) {
1128 free(remote_name);
1129 remote_name = xstrdup(option_origin);
1132 if (!remote_name)
1133 remote_name = xstrdup("origin");
1135 if (!valid_remote_name(remote_name))
1136 die(_("'%s' is not a valid remote name"), remote_name);
1138 if (option_bare) {
1139 if (option_mirror)
1140 src_ref_prefix = "refs/";
1141 strbuf_addstr(&branch_top, src_ref_prefix);
1143 git_config_set("core.bare", "true");
1144 } else {
1145 strbuf_addf(&branch_top, "refs/remotes/%s/", remote_name);
1148 strbuf_addf(&key, "remote.%s.url", remote_name);
1149 git_config_set(key.buf, repo);
1150 strbuf_reset(&key);
1152 if (option_no_tags) {
1153 strbuf_addf(&key, "remote.%s.tagOpt", remote_name);
1154 git_config_set(key.buf, "--no-tags");
1155 strbuf_reset(&key);
1158 if (option_required_reference.nr || option_optional_reference.nr)
1159 setup_reference();
1161 if (option_sparse_checkout && git_sparse_checkout_init(dir))
1162 return 1;
1164 remote = remote_get(remote_name);
1166 refspec_appendf(&remote->fetch, "+%s*:%s*", src_ref_prefix,
1167 branch_top.buf);
1169 transport = transport_get(remote, remote->url[0]);
1170 transport_set_verbosity(transport, option_verbosity, option_progress);
1171 transport->family = family;
1173 path = get_repo_path(remote->url[0], &is_bundle);
1174 is_local = option_local != 0 && path && !is_bundle;
1175 if (is_local) {
1176 if (option_depth)
1177 warning(_("--depth is ignored in local clones; use file:// instead."));
1178 if (option_since)
1179 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1180 if (option_not.nr)
1181 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1182 if (filter_options.choice)
1183 warning(_("--filter is ignored in local clones; use file:// instead."));
1184 if (!access(mkpath("%s/shallow", path), F_OK)) {
1185 if (reject_shallow)
1186 die(_("source repository is shallow, reject to clone."));
1187 if (option_local > 0)
1188 warning(_("source repository is shallow, ignoring --local"));
1189 is_local = 0;
1192 if (option_local > 0 && !is_local)
1193 warning(_("--local is ignored"));
1194 transport->cloning = 1;
1196 if (is_bundle) {
1197 struct bundle_header header = BUNDLE_HEADER_INIT;
1198 int fd = read_bundle_header(path, &header);
1199 int has_filter = header.filter.choice != LOFC_DISABLED;
1201 if (fd > 0)
1202 close(fd);
1203 bundle_header_release(&header);
1204 if (has_filter)
1205 die(_("cannot clone from filtered bundle"));
1208 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
1210 if (reject_shallow)
1211 transport_set_option(transport, TRANS_OPT_REJECT_SHALLOW, "1");
1212 if (option_depth)
1213 transport_set_option(transport, TRANS_OPT_DEPTH,
1214 option_depth);
1215 if (option_since)
1216 transport_set_option(transport, TRANS_OPT_DEEPEN_SINCE,
1217 option_since);
1218 if (option_not.nr)
1219 transport_set_option(transport, TRANS_OPT_DEEPEN_NOT,
1220 (const char *)&option_not);
1221 if (option_single_branch)
1222 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1224 if (option_upload_pack)
1225 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
1226 option_upload_pack);
1228 if (server_options.nr)
1229 transport->server_options = &server_options;
1231 if (filter_options.choice) {
1232 const char *spec =
1233 expand_list_objects_filter_spec(&filter_options);
1234 transport_set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER,
1235 spec);
1236 transport_set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1239 if (transport->smart_options && !deepen && !filter_options.choice)
1240 transport->smart_options->check_self_contained_and_connected = 1;
1243 * Before fetching from the remote, download and install bundle
1244 * data from the --bundle-uri option.
1246 if (bundle_uri) {
1247 /* At this point, we need the_repository to match the cloned repo. */
1248 if (repo_init(the_repository, git_dir, work_tree))
1249 warning(_("failed to initialize the repo, skipping bundle URI"));
1250 else if (fetch_bundle_uri(the_repository, bundle_uri))
1251 warning(_("failed to fetch objects from bundle URI '%s'"),
1252 bundle_uri);
1255 strvec_push(&transport_ls_refs_options.ref_prefixes, "HEAD");
1256 refspec_ref_prefixes(&remote->fetch,
1257 &transport_ls_refs_options.ref_prefixes);
1258 if (option_branch)
1259 expand_ref_prefix(&transport_ls_refs_options.ref_prefixes,
1260 option_branch);
1261 if (!option_no_tags)
1262 strvec_push(&transport_ls_refs_options.ref_prefixes,
1263 "refs/tags/");
1265 refs = transport_get_remote_refs(transport, &transport_ls_refs_options);
1267 if (refs)
1268 mapped_refs = wanted_peer_refs(refs, &remote->fetch);
1270 if (mapped_refs) {
1271 int hash_algo = hash_algo_by_ptr(transport_get_hash_algo(transport));
1274 * Now that we know what algorithm the remote side is using,
1275 * let's set ours to the same thing.
1277 initialize_repository_version(hash_algo, 1);
1278 repo_set_hash_algo(the_repository, hash_algo);
1280 * transport_get_remote_refs() may return refs with null sha-1
1281 * in mapped_refs (see struct transport->get_refs_list
1282 * comment). In that case we need fetch it early because
1283 * remote_head code below relies on it.
1285 * for normal clones, transport_get_remote_refs() should
1286 * return reliable ref set, we can delay cloning until after
1287 * remote HEAD check.
1289 for (ref = refs; ref; ref = ref->next)
1290 if (is_null_oid(&ref->old_oid)) {
1291 complete_refs_before_fetch = 0;
1292 break;
1295 if (!is_local && !complete_refs_before_fetch) {
1296 if (transport_fetch_refs(transport, mapped_refs))
1297 die(_("remote transport reported error"));
1301 remote_head = find_ref_by_name(refs, "HEAD");
1302 remote_head_points_at = guess_remote_head(remote_head, mapped_refs, 0);
1304 if (option_branch) {
1305 our_head_points_at = find_remote_branch(mapped_refs, option_branch);
1306 if (!our_head_points_at)
1307 die(_("Remote branch %s not found in upstream %s"),
1308 option_branch, remote_name);
1309 } else if (remote_head_points_at) {
1310 our_head_points_at = remote_head_points_at;
1311 } else if (remote_head) {
1312 our_head_points_at = NULL;
1313 } else {
1314 const char *branch;
1316 if (!mapped_refs) {
1317 warning(_("You appear to have cloned an empty repository."));
1318 option_no_checkout = 1;
1321 if (transport_ls_refs_options.unborn_head_target &&
1322 skip_prefix(transport_ls_refs_options.unborn_head_target,
1323 "refs/heads/", &branch)) {
1324 unborn_head = xstrdup(transport_ls_refs_options.unborn_head_target);
1325 } else {
1326 branch = git_default_branch_name(0);
1327 unborn_head = xstrfmt("refs/heads/%s", branch);
1331 * We may have selected a local default branch name "foo",
1332 * and even though the remote's HEAD does not point there,
1333 * it may still have a "foo" branch. If so, set it up so
1334 * that we can follow the usual checkout code later.
1336 * Note that for an empty repo we'll already have set
1337 * option_no_checkout above, which would work against us here.
1338 * But for an empty repo, find_remote_branch() can never find
1339 * a match.
1341 our_head_points_at = find_remote_branch(mapped_refs, branch);
1344 write_refspec_config(src_ref_prefix, our_head_points_at,
1345 remote_head_points_at, &branch_top);
1347 if (filter_options.choice)
1348 partial_clone_register(remote_name, &filter_options);
1350 if (is_local)
1351 clone_local(path, git_dir);
1352 else if (mapped_refs && complete_refs_before_fetch) {
1353 if (transport_fetch_refs(transport, mapped_refs))
1354 die(_("remote transport reported error"));
1357 update_remote_refs(refs, mapped_refs, remote_head_points_at,
1358 branch_top.buf, reflog_msg.buf, transport,
1359 !is_local);
1361 update_head(our_head_points_at, remote_head, unborn_head, reflog_msg.buf);
1364 * We want to show progress for recursive submodule clones iff
1365 * we did so for the main clone. But only the transport knows
1366 * the final decision for this flag, so we need to rescue the value
1367 * before we free the transport.
1369 submodule_progress = transport->progress;
1371 transport_unlock_pack(transport, 0);
1372 transport_disconnect(transport);
1374 if (option_dissociate) {
1375 close_object_store(the_repository->objects);
1376 dissociate_from_references();
1379 junk_mode = JUNK_LEAVE_REPO;
1380 err = checkout(submodule_progress, filter_submodules);
1382 free(remote_name);
1383 strbuf_release(&reflog_msg);
1384 strbuf_release(&branch_top);
1385 strbuf_release(&key);
1386 free_refs(mapped_refs);
1387 free_refs(remote_head_points_at);
1388 free(unborn_head);
1389 free(dir);
1390 free(path);
1391 UNLEAK(repo);
1392 junk_mode = JUNK_LEAVE_ALL;
1394 transport_ls_refs_options_release(&transport_ls_refs_options);
1395 return err;