]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/clone.c
Merge branch 'dk/zsh-git-repo-path-fix'
[thirdparty/git.git] / builtin / clone.c
CommitLineData
8434c2f1
DB
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
c2e86add 11#include "builtin.h"
0b027f6c 12#include "abspath.h"
6c6ddf92 13#include "advice.h"
b2141fc1 14#include "config.h"
d5fff46f 15#include "copy.h"
32a8f510 16#include "environment.h"
f394e093 17#include "gettext.h"
41771fa4 18#include "hex.h"
697cc8ef 19#include "lockfile.h"
8434c2f1 20#include "parse-options.h"
8434c2f1 21#include "refs.h"
ec0cb496 22#include "refspec.h"
87bed179 23#include "object-file.h"
a034e910 24#include "object-store-ll.h"
8434c2f1
DB
25#include "tree.h"
26#include "tree-walk.h"
27#include "unpack-trees.h"
28#include "transport.h"
29#include "strbuf.h"
30#include "dir.h"
ff7ccc8c
MT
31#include "dir-iterator.h"
32#include "iterator.h"
4a16d072 33#include "sigchain.h"
a9f2c136 34#include "branch.h"
8ef51733 35#include "remote.h"
dfa7a6c5 36#include "run-command.h"
e38da487 37#include "setup.h"
0433ad12 38#include "connected.h"
3836d88a 39#include "packfile.h"
c339932b 40#include "path.h"
b388633c 41#include "pkt-line.h"
548719fb 42#include "list-objects-filter-options.h"
72ddf34d 43#include "hook.h"
86fdd94d 44#include "bundle.h"
55568919 45#include "bundle-uri.h"
8434c2f1
DB
46
47/*
48 * Overall FIXMEs:
49 * - respect DB_ENVIRONMENT for .git/objects.
50 *
51 * Implementation notes:
52 * - dropping use-separate-remote and no-separate-remote compatibility
53 *
54 */
55static const char * const builtin_clone_usage[] = {
9c9b4f2f 56 N_("git clone [<options>] [--] <repo> [<dir>]"),
8434c2f1
DB
57 NULL
58};
59
3e6e0edd 60static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
bb62e0a9 61static int option_local = -1, option_no_hardlinks, option_shared;
0dab2468 62static int option_no_tags;
18a74a09 63static int option_shallow_submodules;
4fe788b1
LL
64static int option_reject_shallow = -1; /* unspecified */
65static int config_reject_shallow = -1; /* unspecified */
994c2aaf
NTND
66static int deepen;
67static char *option_template, *option_depth, *option_since;
8434c2f1 68static char *option_origin = NULL;
de9ed3ef 69static char *remote_name = NULL;
7a4ee28f 70static char *option_branch = NULL;
859e5df9 71static struct string_list option_not = STRING_LIST_INIT_NODUP;
b57fb80a 72static const char *real_git_dir;
5ed860f5 73static const char *ref_format;
8434c2f1 74static char *option_upload_pack = "git-upload-pack";
5bd631b3 75static int option_verbosity;
01fdc21f 76static int option_progress = -1;
d89f09c8 77static int option_sparse_checkout;
c915f11e 78static enum transport_family family;
2721ce21 79static struct string_list option_config = STRING_LIST_INIT_NODUP;
5e40800d 80static struct string_list option_required_reference = STRING_LIST_INIT_NODUP;
f7415b4d 81static struct string_list option_optional_reference = STRING_LIST_INIT_NODUP;
fb1d6dab 82static int option_dissociate;
72290d6a 83static int max_jobs = -1;
bb62e0a9 84static struct string_list option_recurse_submodules = STRING_LIST_INIT_NODUP;
2a01bded 85static struct list_objects_filter_options filter_options = LIST_OBJECTS_FILTER_INIT;
f05da2b4
JS
86static int option_filter_submodules = -1; /* unspecified */
87static int config_filter_submodules = -1; /* unspecified */
6e983059 88static struct string_list server_options = STRING_LIST_INIT_NODUP;
4c691016 89static int option_remote_submodules;
55568919 90static const char *bundle_uri;
bb62e0a9
BW
91
92static int recurse_submodules_cb(const struct option *opt,
93 const char *arg, int unset)
94{
95 if (unset)
96 string_list_clear((struct string_list *)opt->value, 0);
97 else if (arg)
98 string_list_append((struct string_list *)opt->value, arg);
99 else
100 string_list_append((struct string_list *)opt->value,
101 (const char *)opt->defval);
102
103 return 0;
104}
dbc92b07 105
8434c2f1 106static struct option builtin_clone_options[] = {
5bd631b3 107 OPT__VERBOSITY(&option_verbosity),
01fdc21f 108 OPT_BOOL(0, "progress", &option_progress,
32b77add 109 N_("force progress reporting")),
4fe788b1
LL
110 OPT_BOOL(0, "reject-shallow", &option_reject_shallow,
111 N_("don't clone shallow repository")),
d5d09d47
SB
112 OPT_BOOL('n', "no-checkout", &option_no_checkout,
113 N_("don't create a checkout")),
4741edd5
SB
114 OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
115 OPT_HIDDEN_BOOL(0, "naked", &option_bare,
116 N_("create a bare repository")),
d5d09d47 117 OPT_BOOL(0, "mirror", &option_mirror,
6567eed9 118 N_("create a mirror repository (implies --bare)")),
189260b1 119 OPT_BOOL('l', "local", &option_local,
32b77add 120 N_("to clone from a local repository")),
d5d09d47 121 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
32b77add 122 N_("don't use local hardlinks, always copy")),
d5d09d47 123 OPT_BOOL('s', "shared", &option_shared,
32b77add 124 N_("setup as shared repository")),
bb62e0a9
BW
125 { OPTION_CALLBACK, 0, "recurse-submodules", &option_recurse_submodules,
126 N_("pathspec"), N_("initialize submodules in the clone"),
127 PARSE_OPT_OPTARG, recurse_submodules_cb, (intptr_t)"." },
c28b036f 128 OPT_ALIAS(0, "recursive", "recurse-submodules"),
72290d6a
SB
129 OPT_INTEGER('j', "jobs", &max_jobs,
130 N_("number of submodules cloned in parallel")),
32b77add
NTND
131 OPT_STRING(0, "template", &option_template, N_("template-directory"),
132 N_("directory from which templates will be used")),
5e40800d 133 OPT_STRING_LIST(0, "reference", &option_required_reference, N_("repo"),
8ade009c 134 N_("reference repository")),
f7415b4d
SB
135 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference,
136 N_("repo"), N_("reference repository")),
14f8b9b4
JK
137 OPT_BOOL(0, "dissociate", &option_dissociate,
138 N_("use --reference only while cloning")),
32b77add
NTND
139 OPT_STRING('o', "origin", &option_origin, N_("name"),
140 N_("use <name> instead of 'origin' to track upstream")),
141 OPT_STRING('b', "branch", &option_branch, N_("branch"),
142 N_("checkout <branch> instead of the remote's HEAD")),
143 OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
144 N_("path to git-upload-pack on the remote")),
145 OPT_STRING(0, "depth", &option_depth, N_("depth"),
146 N_("create a shallow clone of that depth")),
994c2aaf
NTND
147 OPT_STRING(0, "shallow-since", &option_since, N_("time"),
148 N_("create a shallow clone since a specific time")),
859e5df9 149 OPT_STRING_LIST(0, "shallow-exclude", &option_not, N_("revision"),
6d873865 150 N_("deepen history of shallow clone, excluding rev")),
3e6e0edd 151 OPT_BOOL(0, "single-branch", &option_single_branch,
32b77add 152 N_("clone only one branch, HEAD or --branch")),
0dab2468
ÆAB
153 OPT_BOOL(0, "no-tags", &option_no_tags,
154 N_("don't clone any tags, and make later fetches not to follow them")),
d22eb044
SB
155 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules,
156 N_("any cloned submodules will be shallow")),
32b77add
NTND
157 OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
158 N_("separate git dir from working tree")),
5ed860f5
PS
159 OPT_STRING(0, "ref-format", &ref_format, N_("format"),
160 N_("specify the reference format to use")),
32b77add
NTND
161 OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
162 N_("set config inside the new repository")),
6e983059
JT
163 OPT_STRING_LIST(0, "server-option", &server_options,
164 N_("server-specific"), N_("option to transmit")),
ae2c912c 165 OPT_IPVERSION(&family),
548719fb 166 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
f05da2b4
JS
167 OPT_BOOL(0, "also-filter-submodules", &option_filter_submodules,
168 N_("apply partial clone filters to submodules")),
4c691016
BA
169 OPT_BOOL(0, "remote-submodules", &option_remote_submodules,
170 N_("any cloned submodules will use their remote-tracking branch")),
d89f09c8
DS
171 OPT_BOOL(0, "sparse", &option_sparse_checkout,
172 N_("initialize sparse-checkout file to include only files at root")),
55568919
DS
173 OPT_STRING(0, "bundle-uri", &bundle_uri,
174 N_("uri"), N_("a URI for downloading bundles before fetching from origin remote")),
8434c2f1
DB
175 OPT_END()
176};
177
0ea68e42 178static const char *get_repo_path_1(struct strbuf *path, int *is_bundle)
8434c2f1 179{
b3256eb8 180 static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
8434c2f1 181 static char *bundle_suffix[] = { ".bundle", "" };
0ea68e42 182 size_t baselen = path->len;
8434c2f1
DB
183 struct stat st;
184 int i;
185
186 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
0ea68e42
JK
187 strbuf_setlen(path, baselen);
188 strbuf_addstr(path, suffix[i]);
189 if (stat(path->buf, &st))
9b0ebc72 190 continue;
0ea68e42 191 if (S_ISDIR(st.st_mode) && is_git_directory(path->buf)) {
8434c2f1 192 *is_bundle = 0;
0ea68e42 193 return path->buf;
9b0ebc72
NTND
194 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
195 /* Is it a "gitfile"? */
196 char signature[8];
0ea68e42
JK
197 const char *dst;
198 int len, fd = open(path->buf, O_RDONLY);
9b0ebc72
NTND
199 if (fd < 0)
200 continue;
201 len = read_in_full(fd, signature, 8);
202 close(fd);
203 if (len != 8 || strncmp(signature, "gitdir: ", 8))
204 continue;
0ea68e42
JK
205 dst = read_gitfile(path->buf);
206 if (dst) {
9b0ebc72 207 *is_bundle = 0;
0ea68e42 208 return dst;
9b0ebc72 209 }
8434c2f1
DB
210 }
211 }
212
213 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
0ea68e42
JK
214 strbuf_setlen(path, baselen);
215 strbuf_addstr(path, bundle_suffix[i]);
216 if (!stat(path->buf, &st) && S_ISREG(st.st_mode)) {
8434c2f1 217 *is_bundle = 1;
0ea68e42 218 return path->buf;
8434c2f1
DB
219 }
220 }
221
222 return NULL;
223}
224
0ea68e42
JK
225static char *get_repo_path(const char *repo, int *is_bundle)
226{
227 struct strbuf path = STRBUF_INIT;
228 const char *raw;
229 char *canon;
230
231 strbuf_addstr(&path, repo);
232 raw = get_repo_path_1(&path, is_bundle);
0aaad415 233 canon = raw ? absolute_pathdup(raw) : NULL;
0ea68e42
JK
234 strbuf_release(&path);
235 return canon;
236}
237
dbc92b07 238static int add_one_reference(struct string_list_item *item, void *cb_data)
8434c2f1 239{
9eeea7d2 240 struct strbuf err = STRBUF_INIT;
f7415b4d 241 int *required = cb_data;
9eeea7d2 242 char *ref_git = compute_alternate_path(item->string, &err);
8434c2f1 243
f7415b4d
SB
244 if (!ref_git) {
245 if (*required)
246 die("%s", err.buf);
247 else
248 fprintf(stderr,
249 _("info: Could not add alternate for '%s': %s\n"),
250 item->string, err.buf);
251 } else {
252 struct strbuf sb = STRBUF_INIT;
253 strbuf_addf(&sb, "%s/objects", ref_git);
254 add_to_alternates_file(sb.buf);
255 strbuf_release(&sb);
256 }
606e435a 257
9eeea7d2 258 strbuf_release(&err);
f7415b4d 259 free(ref_git);
dbc92b07
JH
260 return 0;
261}
8434c2f1 262
dbc92b07
JH
263static void setup_reference(void)
264{
f7415b4d
SB
265 int required = 1;
266 for_each_string_list(&option_required_reference,
267 add_one_reference, &required);
268 required = 0;
269 for_each_string_list(&option_optional_reference,
270 add_one_reference, &required);
8434c2f1
DB
271}
272
3c1dce88 273static void copy_alternates(struct strbuf *src, const char *src_repo)
e6baf4a1
JH
274{
275 /*
276 * Read from the source objects/info/alternates file
277 * and copy the entries to corresponding file in the
278 * destination repository with add_to_alternates_file().
279 * Both src and dst have "$path/objects/info/alternates".
280 *
281 * Instead of copying bit-for-bit from the original,
282 * we need to append to existing one so that the already
283 * created entry via "clone -s" is not lost, and also
284 * to turn entries with paths relative to the original
285 * absolute, so that they can be used in the new repository.
286 */
02912f47 287 FILE *in = xfopen(src->buf, "r");
e6baf4a1
JH
288 struct strbuf line = STRBUF_INIT;
289
3f163962 290 while (strbuf_getline(&line, in) != EOF) {
dcf69262 291 char *abs_path;
e6baf4a1
JH
292 if (!line.len || line.buf[0] == '#')
293 continue;
294 if (is_absolute_path(line.buf)) {
295 add_to_alternates_file(line.buf);
296 continue;
297 }
dcf69262 298 abs_path = mkpathdup("%s/objects/%s", src_repo, line.buf);
22d3b8de
JK
299 if (!normalize_path_copy(abs_path, abs_path))
300 add_to_alternates_file(abs_path);
301 else
302 warning("skipping invalid relative alternate: %s/%s",
303 src_repo, line.buf);
dcf69262 304 free(abs_path);
e6baf4a1
JH
305 }
306 strbuf_release(&line);
307 fclose(in);
308}
309
14954b79
MT
310static void mkdir_if_missing(const char *pathname, mode_t mode)
311{
312 struct stat st;
313
314 if (!mkdir(pathname, mode))
315 return;
316
317 if (errno != EEXIST)
318 die_errno(_("failed to create directory '%s'"), pathname);
319 else if (stat(pathname, &st))
320 die_errno(_("failed to stat '%s'"), pathname);
321 else if (!S_ISDIR(st.st_mode))
322 die(_("%s exists and is not a directory"), pathname);
323}
324
e6baf4a1 325static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
ff7ccc8c 326 const char *src_repo)
8434c2f1 327{
8434c2f1 328 int src_len, dest_len;
ff7ccc8c
MT
329 struct dir_iterator *iter;
330 int iter_status;
3d7747e3 331 struct strbuf realpath = STRBUF_INIT;
8434c2f1 332
14954b79 333 mkdir_if_missing(dest->buf, 0777);
8434c2f1 334
6f054f9f 335 iter = dir_iterator_begin(src->buf, DIR_ITERATOR_PEDANTIC);
ff7ccc8c 336
4e33535e
GC
337 if (!iter) {
338 if (errno == ENOTDIR) {
339 int saved_errno = errno;
340 struct stat st;
341
342 if (!lstat(src->buf, &st) && S_ISLNK(st.st_mode))
343 die(_("'%s' is a symlink, refusing to clone with --local"),
344 src->buf);
345 errno = saved_errno;
346 }
ff7ccc8c 347 die_errno(_("failed to start iterator over '%s'"), src->buf);
4e33535e 348 }
8434c2f1 349
b9e125e0
MV
350 strbuf_addch(src, '/');
351 src_len = src->len;
352 strbuf_addch(dest, '/');
353 dest_len = dest->len;
8434c2f1 354
ff7ccc8c 355 while ((iter_status = dir_iterator_advance(iter)) == ITER_OK) {
b9e125e0 356 strbuf_setlen(src, src_len);
ff7ccc8c 357 strbuf_addstr(src, iter->relative_path);
b9e125e0 358 strbuf_setlen(dest, dest_len);
ff7ccc8c
MT
359 strbuf_addstr(dest, iter->relative_path);
360
6f054f9f
TB
361 if (S_ISLNK(iter->st.st_mode))
362 die(_("symlink '%s' exists, refusing to clone with --local"),
363 iter->relative_path);
ff7ccc8c
MT
364
365 if (S_ISDIR(iter->st.st_mode)) {
366 mkdir_if_missing(dest->buf, 0777);
e6baf4a1
JH
367 continue;
368 }
369
370 /* Files that cannot be copied bit-for-bit... */
c4d9c506 371 if (!fspathcmp(iter->relative_path, "info/alternates")) {
3c1dce88 372 copy_alternates(src, src_repo);
8434c2f1
DB
373 continue;
374 }
375
b9e125e0 376 if (unlink(dest->buf) && errno != ENOENT)
e84d7b74 377 die_errno(_("failed to unlink '%s'"), dest->buf);
fdabc242 378 if (!option_no_hardlinks) {
3d7747e3
AM
379 strbuf_realpath(&realpath, src->buf, 1);
380 if (!link(realpath.buf, dest->buf))
fdabc242 381 continue;
189260b1 382 if (option_local > 0)
e84d7b74 383 die_errno(_("failed to create link '%s'"), dest->buf);
fdabc242 384 option_no_hardlinks = 1;
8434c2f1 385 }
f7835a25 386 if (copy_file_with_time(dest->buf, src->buf, 0666))
e84d7b74 387 die_errno(_("failed to copy file to '%s'"), dest->buf);
8434c2f1 388 }
ff7ccc8c
MT
389
390 if (iter_status != ITER_DONE) {
391 strbuf_setlen(src, src_len);
392 die(_("failed to iterate over '%s'"), src->buf);
393 }
3d7747e3
AM
394
395 strbuf_release(&realpath);
8434c2f1
DB
396}
397
6f48d39f 398static void clone_local(const char *src_repo, const char *dest_repo)
8434c2f1 399{
e6baf4a1
JH
400 if (option_shared) {
401 struct strbuf alt = STRBUF_INIT;
b3b05971
ES
402 get_common_dir(&alt, src_repo);
403 strbuf_addstr(&alt, "/objects");
e6baf4a1
JH
404 add_to_alternates_file(alt.buf);
405 strbuf_release(&alt);
406 } else {
407 struct strbuf src = STRBUF_INIT;
408 struct strbuf dest = STRBUF_INIT;
744e4697
NTND
409 get_common_dir(&src, src_repo);
410 get_common_dir(&dest, dest_repo);
411 strbuf_addstr(&src, "/objects");
412 strbuf_addstr(&dest, "/objects");
ff7ccc8c 413 copy_or_link_directory(&src, &dest, src_repo);
b9e125e0
MV
414 strbuf_release(&src);
415 strbuf_release(&dest);
8434c2f1
DB
416 }
417
28ba96ab 418 if (0 <= option_verbosity)
68b939b2 419 fprintf(stderr, _("done.\n"));
8434c2f1
DB
420}
421
422static const char *junk_work_tree;
d45420c1 423static int junk_work_tree_flags;
8434c2f1 424static const char *junk_git_dir;
d45420c1 425static int junk_git_dir_flags;
85064630 426static enum {
d3b34622
JK
427 JUNK_LEAVE_NONE,
428 JUNK_LEAVE_REPO,
429 JUNK_LEAVE_ALL
430} junk_mode = JUNK_LEAVE_NONE;
431
432static const char junk_leave_repo_msg[] =
433N_("Clone succeeded, but checkout failed.\n"
434 "You can inspect what was checked out with 'git status'\n"
80f537f7 435 "and retry with 'git restore --source=HEAD :/'\n");
8434c2f1
DB
436
437static void remove_junk(void)
438{
f285a2d7 439 struct strbuf sb = STRBUF_INIT;
d3b34622
JK
440
441 switch (junk_mode) {
442 case JUNK_LEAVE_REPO:
443 warning("%s", _(junk_leave_repo_msg));
444 /* fall-through */
445 case JUNK_LEAVE_ALL:
446 return;
447 default:
448 /* proceed to removal */
449 break;
450 }
451
8434c2f1
DB
452 if (junk_git_dir) {
453 strbuf_addstr(&sb, junk_git_dir);
d45420c1 454 remove_dir_recursively(&sb, junk_git_dir_flags);
8434c2f1
DB
455 strbuf_reset(&sb);
456 }
457 if (junk_work_tree) {
458 strbuf_addstr(&sb, junk_work_tree);
d45420c1 459 remove_dir_recursively(&sb, junk_work_tree_flags);
8434c2f1 460 }
9c18b548 461 strbuf_release(&sb);
8434c2f1
DB
462}
463
464static void remove_junk_on_signal(int signo)
465{
466 remove_junk();
4a16d072 467 sigchain_pop(signo);
8434c2f1
DB
468 raise(signo);
469}
470
9e585046
NTND
471static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
472{
473 struct ref *ref;
474 struct strbuf head = STRBUF_INIT;
475 strbuf_addstr(&head, "refs/heads/");
476 strbuf_addstr(&head, branch);
477 ref = find_ref_by_name(refs, head.buf);
478 strbuf_release(&head);
5a7d5b68
NTND
479
480 if (ref)
481 return ref;
482
483 strbuf_addstr(&head, "refs/tags/");
484 strbuf_addstr(&head, branch);
485 ref = find_ref_by_name(refs, head.buf);
486 strbuf_release(&head);
487
9e585046
NTND
488 return ref;
489}
490
5bdc32d3 491static struct ref *wanted_peer_refs(const struct ref *refs,
515be833 492 struct refspec *refspec)
8434c2f1 493{
c1921c18
JK
494 struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
495 struct ref *local_refs = head;
496 struct ref **tail = head ? &head->next : &local_refs;
8434c2f1 497
3e6e0edd
NTND
498 if (option_single_branch) {
499 struct ref *remote_head = NULL;
500
501 if (!option_branch)
502 remote_head = guess_remote_head(head, refs, 0);
0ec4b165
NTND
503 else {
504 local_refs = NULL;
505 tail = &local_refs;
506 remote_head = copy_ref(find_remote_branch(refs, option_branch));
507 }
3e6e0edd
NTND
508
509 if (!remote_head && option_branch)
510 warning(_("Could not find remote branch %s to clone."),
511 option_branch);
5a7d5b68 512 else {
515be833
SG
513 int i;
514 for (i = 0; i < refspec->nr; i++)
515 get_fetch_map(remote_head, &refspec->items[i],
516 &tail, 0);
5a7d5b68
NTND
517
518 /* if --branch=tag, pull the requested tag explicitly */
519 get_fetch_map(remote_head, tag_refspec, &tail, 0);
520 }
74a06a9f 521 free_refs(remote_head);
515be833
SG
522 } else {
523 int i;
524 for (i = 0; i < refspec->nr; i++)
525 get_fetch_map(refs, &refspec->items[i], &tail, 0);
526 }
3e6e0edd 527
0dab2468 528 if (!option_mirror && !option_single_branch && !option_no_tags)
468386a9 529 get_fetch_map(refs, tag_refspec, &tail, 0);
8434c2f1 530
5bdc32d3
NP
531 return local_refs;
532}
533
534static void write_remote_refs(const struct ref *local_refs)
535{
536 const struct ref *r;
537
58f233ce
MH
538 struct ref_transaction *t;
539 struct strbuf err = STRBUF_INIT;
540
541 t = ref_transaction_begin(&err);
542 if (!t)
543 die("%s", err.buf);
9f69d297 544
c1921c18
JK
545 for (r = local_refs; r; r = r->next) {
546 if (!r->peer_ref)
547 continue;
89f3bbdd 548 if (ref_transaction_create(t, r->peer_ref->name, &r->old_oid,
58f233ce
MH
549 0, NULL, &err))
550 die("%s", err.buf);
c1921c18 551 }
3e8aded2 552
58f233ce
MH
553 if (initial_ref_transaction_commit(t, &err))
554 die("%s", err.buf);
555
556 strbuf_release(&err);
557 ref_transaction_free(t);
8434c2f1
DB
558}
559
3e6e0edd
NTND
560static void write_followtags(const struct ref *refs, const char *msg)
561{
562 const struct ref *ref;
563 for (ref = refs; ref; ref = ref->next) {
59556548 564 if (!starts_with(ref->name, "refs/tags/"))
3e6e0edd 565 continue;
59556548 566 if (ends_with(ref->name, "^{}"))
3e6e0edd 567 continue;
bc726bd0
ÆAB
568 if (!repo_has_object_file_with_flags(the_repository, &ref->old_oid,
569 OBJECT_INFO_QUICK |
570 OBJECT_INFO_SKIP_FETCH_OBJECT))
3e6e0edd 571 continue;
ae077771 572 update_ref(msg, ref->name, &ref->old_oid, NULL, 0,
573 UPDATE_REFS_DIE_ON_ERR);
3e6e0edd
NTND
574 }
575}
576
9fec7b21 577static const struct object_id *iterate_ref_map(void *cb_data)
0433ad12
JK
578{
579 struct ref **rm = cb_data;
580 struct ref *ref = *rm;
581
582 /*
583 * Skip anything missing a peer_ref, which we are not
584 * actually going to write a ref for.
585 */
586 while (ref && !ref->peer_ref)
587 ref = ref->next;
0433ad12 588 if (!ref)
9fec7b21 589 return NULL;
0433ad12 590
0433ad12 591 *rm = ref->next;
9fec7b21 592 return &ref->old_oid;
0433ad12
JK
593}
594
960b7d1c
NTND
595static void update_remote_refs(const struct ref *refs,
596 const struct ref *mapped_refs,
597 const struct ref *remote_head_points_at,
598 const char *branch_top,
c6807a40 599 const char *msg,
45ed4afa 600 struct transport *transport,
2b98478c 601 int check_connectivity)
960b7d1c 602{
0433ad12
JK
603 const struct ref *rm = mapped_refs;
604
125a05fd 605 if (check_connectivity) {
7043c707
JK
606 struct check_connected_options opt = CHECK_CONNECTED_INIT;
607
608 opt.transport = transport;
38e590ea 609 opt.progress = transport->progress;
7043c707 610
7043c707 611 if (check_connected(iterate_ref_map, &rm, &opt))
125a05fd
JK
612 die(_("remote did not send all necessary objects"));
613 }
0433ad12 614
960b7d1c 615 if (refs) {
960b7d1c 616 write_remote_refs(mapped_refs);
0dab2468 617 if (option_single_branch && !option_no_tags)
960b7d1c
NTND
618 write_followtags(refs, msg);
619 }
620
621 if (remote_head_points_at && !option_bare) {
622 struct strbuf head_ref = STRBUF_INIT;
623 strbuf_addstr(&head_ref, branch_top);
624 strbuf_addstr(&head_ref, "HEAD");
4be49d75
JK
625 if (create_symref(head_ref.buf,
626 remote_head_points_at->peer_ref->name,
627 msg) < 0)
39ad4f39 628 die(_("unable to update %s"), head_ref.buf);
4be49d75 629 strbuf_release(&head_ref);
960b7d1c
NTND
630 }
631}
632
f034d354 633static void update_head(const struct ref *our, const struct ref *remote,
daf7898a 634 const char *unborn, const char *msg)
f034d354 635{
cf4fff57
JK
636 const char *head;
637 if (our && skip_prefix(our->name, "refs/heads/", &head)) {
f034d354 638 /* Local default branch link */
4be49d75 639 if (create_symref("HEAD", our->name, NULL) < 0)
39ad4f39 640 die(_("unable to update HEAD"));
f034d354 641 if (!option_bare) {
ae077771 642 update_ref(msg, "HEAD", &our->old_oid, NULL, 0,
f4124112 643 UPDATE_REFS_DIE_ON_ERR);
75ca3906 644 install_branch_config(0, head, remote_name, our->name);
f034d354 645 }
5a7d5b68 646 } else if (our) {
2122f675
SB
647 struct commit *c = lookup_commit_reference(the_repository,
648 &our->old_oid);
5a7d5b68 649 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
91774afc 650 update_ref(msg, "HEAD", &c->object.oid, NULL, REF_NO_DEREF,
ae077771 651 UPDATE_REFS_DIE_ON_ERR);
f034d354
NTND
652 } else if (remote) {
653 /*
654 * We know remote HEAD points to a non-branch, or
920b691f 655 * HEAD points to a branch but we don't know which one.
f034d354
NTND
656 * Detach HEAD in all these cases.
657 */
91774afc 658 update_ref(msg, "HEAD", &remote->old_oid, NULL, REF_NO_DEREF,
ae077771 659 UPDATE_REFS_DIE_ON_ERR);
daf7898a
JK
660 } else if (unborn && skip_prefix(unborn, "refs/heads/", &head)) {
661 /*
662 * Unborn head from remote; same as "our" case above except
663 * that we have no ref to update.
664 */
665 if (create_symref("HEAD", unborn, NULL) < 0)
666 die(_("unable to update HEAD"));
667 if (!option_bare)
668 install_branch_config(0, head, remote_name, unborn);
f034d354
NTND
669 }
670}
671
d89f09c8
DS
672static int git_sparse_checkout_init(const char *repo)
673{
0e906739 674 struct child_process cmd = CHILD_PROCESS_INIT;
d89f09c8 675 int result = 0;
0e906739 676 strvec_pushl(&cmd.args, "-C", repo, "sparse-checkout", "set", NULL);
d89f09c8
DS
677
678 /*
679 * We must apply the setting in the current process
680 * for the later checkout to use the sparse-checkout file.
681 */
682 core_apply_sparse_checkout = 1;
683
0e906739
RS
684 cmd.git_cmd = 1;
685 if (run_command(&cmd)) {
d89f09c8
DS
686 error(_("failed to initialize sparse-checkout"));
687 result = 1;
688 }
689
d89f09c8
DS
690 return result;
691}
692
f05da2b4 693static int checkout(int submodule_progress, int filter_submodules)
c39852c1 694{
ddc2cc64 695 struct object_id oid;
c39852c1 696 char *head;
837e34eb 697 struct lock_file lock_file = LOCK_INIT;
c39852c1
NTND
698 struct unpack_trees_options opts;
699 struct tree *tree;
700 struct tree_desc t;
03b86647 701 int err = 0;
c39852c1
NTND
702
703 if (option_no_checkout)
704 return 0;
705
0f2dc722 706 head = resolve_refdup("HEAD", RESOLVE_REF_READING, &oid, NULL);
c39852c1
NTND
707 if (!head) {
708 warning(_("remote HEAD refers to nonexistent ref, "
f77710c5 709 "unable to checkout"));
c39852c1
NTND
710 return 0;
711 }
2857093b 712 if (!strcmp(head, "HEAD")) {
ed9bff08 713 if (advice_enabled(ADVICE_DETACHED_HEAD))
ddc2cc64 714 detach_advice(oid_to_hex(&oid));
dfc8cdc6 715 FREE_AND_NULL(head);
2857093b 716 } else {
59556548 717 if (!starts_with(head, "refs/heads/"))
c39852c1
NTND
718 die(_("HEAD not found below refs/heads!"));
719 }
c39852c1
NTND
720
721 /* We need to be in the new work tree for the checkout */
722 setup_work_tree();
723
07047d68 724 repo_hold_locked_index(the_repository, &lock_file, LOCK_DIE_ON_ERROR);
c39852c1
NTND
725
726 memset(&opts, 0, sizeof opts);
727 opts.update = 1;
728 opts.merge = 1;
b878579a 729 opts.clone = 1;
1b5f3733 730 opts.preserve_ignored = 0;
c39852c1 731 opts.fn = oneway_merge;
8f63da13 732 opts.verbose_update = (option_verbosity >= 0);
9ee6d63b
PS
733 opts.src_index = the_repository->index;
734 opts.dst_index = the_repository->index;
dfc8cdc6 735 init_checkout_metadata(&opts.meta, head, &oid, NULL);
c39852c1 736
a9dbc179 737 tree = parse_tree_indirect(&oid);
8d2eaf64
GC
738 if (!tree)
739 die(_("unable to parse commit %s"), oid_to_hex(&oid));
aa9f6189
JS
740 if (parse_tree(tree) < 0)
741 exit(128);
efed687e 742 init_tree_desc(&t, &tree->object.oid, tree->buffer, tree->size);
0aac7bb2
JK
743 if (unpack_trees(1, &t, &opts) < 0)
744 die(_("unable to checkout working tree"));
c39852c1 745
dfc8cdc6 746 free(head);
747
9ee6d63b 748 if (write_locked_index(the_repository->index, &lock_file, COMMIT_LOCK))
c39852c1
NTND
749 die(_("unable to write new index file"));
750
72ddf34d 751 err |= run_hooks_l("post-checkout", oid_to_hex(null_oid()),
ddc2cc64 752 oid_to_hex(&oid), "1", NULL);
c39852c1 753
bb62e0a9 754 if (!err && (option_recurse_submodules.nr > 0)) {
0e906739
RS
755 struct child_process cmd = CHILD_PROCESS_INIT;
756 strvec_pushl(&cmd.args, "submodule", "update", "--require-init",
757 "--recursive", NULL);
72290d6a 758
18a74a09 759 if (option_shallow_submodules == 1)
0e906739 760 strvec_push(&cmd.args, "--depth=1");
d22eb044 761
72290d6a 762 if (max_jobs != -1)
0e906739 763 strvec_pushf(&cmd.args, "--jobs=%d", max_jobs);
72290d6a 764
72c5f883 765 if (submodule_progress)
0e906739 766 strvec_push(&cmd.args, "--progress");
72c5f883 767
03c004c5 768 if (option_verbosity < 0)
0e906739 769 strvec_push(&cmd.args, "--quiet");
03c004c5 770
4c691016 771 if (option_remote_submodules) {
0e906739
RS
772 strvec_push(&cmd.args, "--remote");
773 strvec_push(&cmd.args, "--no-fetch");
4c691016
BA
774 }
775
f05da2b4 776 if (filter_submodules && filter_options.choice)
0e906739 777 strvec_pushf(&cmd.args, "--filter=%s",
f05da2b4
JS
778 expand_list_objects_filter_spec(&filter_options));
779
132f600b 780 if (option_single_branch >= 0)
0e906739 781 strvec_push(&cmd.args, option_single_branch ?
132f600b
ES
782 "--single-branch" :
783 "--no-single-branch");
784
0e906739
RS
785 cmd.git_cmd = 1;
786 err = run_command(&cmd);
72290d6a 787 }
c39852c1
NTND
788
789 return err;
790}
791
a4e7e317
GC
792static int git_clone_config(const char *k, const char *v,
793 const struct config_context *ctx, void *cb)
552955ed 794{
de9ed3ef 795 if (!strcmp(k, "clone.defaultremotename")) {
ba176db5
JK
796 if (!v)
797 return config_error_nonbool(k);
de9ed3ef
SB
798 free(remote_name);
799 remote_name = xstrdup(v);
800 }
4fe788b1
LL
801 if (!strcmp(k, "clone.rejectshallow"))
802 config_reject_shallow = git_config_bool(k, v);
f05da2b4
JS
803 if (!strcmp(k, "clone.filtersubmodules"))
804 config_filter_submodules = git_config_bool(k, v);
4fe788b1 805
a4e7e317 806 return git_default_config(k, v, ctx, cb);
552955ed
SB
807}
808
a4e7e317
GC
809static int write_one_config(const char *key, const char *value,
810 const struct config_context *ctx,
811 void *data)
84054f79 812{
552955ed
SB
813 /*
814 * give git_clone_config a chance to write config values back to the
815 * environment, since git_config_set_multivar_gently only deals with
816 * config-file writes
817 */
a4e7e317 818 int apply_failed = git_clone_config(key, value, ctx, data);
552955ed
SB
819 if (apply_failed)
820 return apply_failed;
821
db4eca1f
JN
822 return git_config_set_multivar_gently(key,
823 value ? value : "true",
824 CONFIG_REGEX_NONE, 0);
84054f79
JK
825}
826
827static void write_config(struct string_list *config)
828{
829 int i;
830
831 for (i = 0; i < config->nr; i++) {
832 if (git_config_parse_parameter(config->items[i].string,
833 write_one_config, NULL) < 0)
39ad4f39 834 die(_("unable to write parameters to config file"));
84054f79
JK
835 }
836}
837
24d36f14
DA
838static void write_refspec_config(const char *src_ref_prefix,
839 const struct ref *our_head_points_at,
840 const struct ref *remote_head_points_at,
841 struct strbuf *branch_top)
31b808a0
RT
842{
843 struct strbuf key = STRBUF_INIT;
844 struct strbuf value = STRBUF_INIT;
845
846 if (option_mirror || !option_bare) {
847 if (option_single_branch && !option_mirror) {
848 if (option_branch) {
60a5f5fc 849 if (starts_with(our_head_points_at->name, "refs/tags/"))
31b808a0
RT
850 strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
851 our_head_points_at->name);
852 else
853 strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
854 branch_top->buf, option_branch);
855 } else if (remote_head_points_at) {
cf4fff57
JK
856 const char *head = remote_head_points_at->name;
857 if (!skip_prefix(head, "refs/heads/", &head))
033abf97 858 BUG("remote HEAD points at non-head?");
cf4fff57 859
31b808a0 860 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
cf4fff57 861 branch_top->buf, head);
31b808a0
RT
862 }
863 /*
864 * otherwise, the next "git fetch" will
865 * simply fetch from HEAD without updating
d6ac1d21 866 * any remote-tracking branch, which is what
31b808a0
RT
867 * we want.
868 */
869 } else {
870 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
871 }
872 /* Configure the remote */
873 if (value.len) {
75ca3906 874 strbuf_addf(&key, "remote.%s.fetch", remote_name);
31b808a0
RT
875 git_config_set_multivar(key.buf, value.buf, "^$", 0);
876 strbuf_reset(&key);
877
878 if (option_mirror) {
75ca3906 879 strbuf_addf(&key, "remote.%s.mirror", remote_name);
31b808a0
RT
880 git_config_set(key.buf, "true");
881 strbuf_reset(&key);
882 }
883 }
884 }
885
886 strbuf_release(&key);
887 strbuf_release(&value);
888}
889
fb1d6dab
JH
890static void dissociate_from_references(void)
891{
0181681e 892 char *alternates = git_pathdup("objects/info/alternates");
fb1d6dab 893
0181681e 894 if (!access(alternates, F_OK)) {
ddbb47fd
RS
895 struct child_process cmd = CHILD_PROCESS_INIT;
896
897 cmd.git_cmd = 1;
898 cmd.no_stdin = 1;
899 strvec_pushl(&cmd.args, "repack", "-a", "-d", NULL);
900 if (run_command(&cmd))
0181681e
AR
901 die(_("cannot repack to clean up"));
902 if (unlink(alternates) && errno != ENOENT)
903 die_errno(_("cannot unlink temporary alternates file"));
904 }
905 free(alternates);
fb1d6dab
JH
906}
907
6c020421 908static int path_exists(const char *path)
f9e377ad
JK
909{
910 struct stat sb;
911 return !stat(path, &sb);
912}
913
8434c2f1
DB
914int cmd_clone(int argc, const char **argv, const char *prefix)
915{
24c61c44 916 int is_bundle = 0, is_local;
4fe788b1 917 int reject_shallow = 0;
8434c2f1 918 const char *repo_name, *repo, *work_tree, *git_dir;
81e5c39c 919 char *repo_to_free = NULL;
0c454273 920 char *path = NULL, *dir, *display_repo = NULL;
dfaa209a 921 int dest_exists, real_dest_exists = 0;
37148311 922 const struct ref *refs, *remote_head;
0c454273 923 struct ref *remote_head_points_at = NULL;
7a4ee28f 924 const struct ref *our_head_points_at;
daf7898a 925 char *unborn_head = NULL;
dccea605 926 struct ref *mapped_refs = NULL;
90498161 927 const struct ref *ref;
3e42cb3b 928 struct strbuf key = STRBUF_INIT;
199f44cb 929 struct strbuf buf = STRBUF_INIT;
b5ff37ac 930 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
1db4a75c 931 struct transport *transport = NULL;
9e585046 932 const char *src_ref_prefix = "refs/heads/";
6f48d39f 933 struct remote *remote;
90498161 934 int err = 0, complete_refs_before_fetch = 1;
72c5f883 935 int submodule_progress;
f05da2b4 936 int filter_submodules = 0;
8b214c2e 937 int hash_algo;
5ed860f5 938 unsigned int ref_storage_format = REF_STORAGE_FORMAT_UNKNOWN;
fc817350 939 const int do_not_override_repo_unix_permissions = -1;
8434c2f1 940
39835409
JT
941 struct transport_ls_refs_options transport_ls_refs_options =
942 TRANSPORT_LS_REFS_OPTIONS_INIT;
8434c2f1 943
bbc30f99 944 packet_trace_identity("clone");
552955ed
SB
945
946 git_config(git_clone_config, NULL);
947
37782920 948 argc = parse_options(argc, argv, prefix, builtin_clone_options,
8434c2f1
DB
949 builtin_clone_usage, 0);
950
d52dc4b1 951 if (argc > 2)
e84d7b74 952 usage_msg_opt(_("Too many arguments."),
d52dc4b1
JN
953 builtin_clone_usage, builtin_clone_options);
954
8434c2f1 955 if (argc == 0)
e84d7b74 956 usage_msg_opt(_("You must specify a repository to clone."),
d52dc4b1 957 builtin_clone_usage, builtin_clone_options);
8434c2f1 958
859e5df9 959 if (option_depth || option_since || option_not.nr)
994c2aaf 960 deepen = 1;
3e6e0edd 961 if (option_single_branch == -1)
994c2aaf 962 option_single_branch = deepen ? 1 : 0;
3e6e0edd 963
5ed860f5
PS
964 if (ref_format) {
965 ref_storage_format = ref_storage_format_by_name(ref_format);
966 if (ref_storage_format == REF_STORAGE_FORMAT_UNKNOWN)
967 die(_("unknown ref storage format '%s'"), ref_format);
968 }
969
bc699afc
JS
970 if (option_mirror)
971 option_bare = 1;
972
8434c2f1 973 if (option_bare) {
95b63f1e 974 if (real_git_dir)
12909b6b 975 die(_("options '%s' and '%s' cannot be used together"), "--bare", "--separate-git-dir");
8434c2f1 976 option_no_checkout = 1;
8434c2f1
DB
977 }
978
e21e663c 979 if (bundle_uri && deepen)
7854bf49
RS
980 die(_("options '%s' and '%s' cannot be used together"),
981 "--bundle-uri",
982 "--depth/--shallow-since/--shallow-exclude");
e21e663c 983
8434c2f1
DB
984 repo_name = argv[0];
985
986 path = get_repo_path(repo_name, &is_bundle);
0c454273
AH
987 if (path) {
988 FREE_AND_NULL(path);
81e5c39c 989 repo = repo_to_free = absolute_pathdup(repo_name);
0c454273 990 } else if (strchr(repo_name, ':')) {
8434c2f1 991 repo = repo_name;
46da295a
JS
992 display_repo = transport_anonymize_url(repo);
993 } else
994 die(_("repository '%s' does not exist"), repo_name);
8434c2f1 995
5594bcad
NTND
996 /* no need to be strict, transport_set_option() will validate it again */
997 if (option_depth && atoi(option_depth) < 1)
998 die(_("depth %s is not a positive number"), option_depth);
999
8434c2f1
DB
1000 if (argc == 2)
1001 dir = xstrdup(argv[1]);
1002 else
ed86301f
AR
1003 dir = git_url_basename(repo_name, is_bundle, option_bare);
1004 strip_dir_trailing_slashes(dir);
8434c2f1 1005
6c020421 1006 dest_exists = path_exists(dir);
55892d23 1007 if (dest_exists && !is_empty_dir(dir))
e84d7b74
ÆAB
1008 die(_("destination path '%s' already exists and is not "
1009 "an empty directory."), dir);
8434c2f1 1010
dfaa209a
BW
1011 if (real_git_dir) {
1012 real_dest_exists = path_exists(real_git_dir);
1013 if (real_dest_exists && !is_empty_dir(real_git_dir))
1014 die(_("repository path '%s' already exists and is not "
1015 "an empty directory."), real_git_dir);
1016 }
1017
1018
46da295a
JS
1019 strbuf_addf(&reflog_msg, "clone: from %s",
1020 display_repo ? display_repo : repo);
1021 free(display_repo);
8434c2f1
DB
1022
1023 if (option_bare)
1024 work_tree = NULL;
1025 else {
1026 work_tree = getenv("GIT_WORK_TREE");
6c020421 1027 if (work_tree && path_exists(work_tree))
e84d7b74 1028 die(_("working tree '%s' already exists."), work_tree);
8434c2f1
DB
1029 }
1030
1031 if (option_bare || work_tree)
1032 git_dir = xstrdup(dir);
1033 else {
1034 work_tree = dir;
4e2d094d 1035 git_dir = mkpathdup("%s/.git", dir);
8434c2f1
DB
1036 }
1037
ee0e3872
JK
1038 atexit(remove_junk);
1039 sigchain_push_common(remove_junk_on_signal);
1040
8434c2f1 1041 if (!option_bare) {
8e21d63b 1042 if (safe_create_leading_directories_const(work_tree) < 0)
e84d7b74 1043 die_errno(_("could not create leading directories of '%s'"),
d824cbba 1044 work_tree);
d45420c1
JK
1045 if (dest_exists)
1046 junk_work_tree_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1047 else if (mkdir(work_tree, 0777))
16eff6c0 1048 die_errno(_("could not create work tree dir '%s'"),
d824cbba 1049 work_tree);
ee0e3872 1050 junk_work_tree = work_tree;
8434c2f1
DB
1051 set_git_work_tree(work_tree);
1052 }
8434c2f1 1053
d45420c1 1054 if (real_git_dir) {
dfaa209a 1055 if (real_dest_exists)
d45420c1
JK
1056 junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1057 junk_git_dir = real_git_dir;
1058 } else {
1059 if (dest_exists)
1060 junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1061 junk_git_dir = git_dir;
1062 }
8e21d63b 1063 if (safe_create_leading_directories_const(git_dir) < 0)
e84d7b74 1064 die(_("could not create leading directories of '%s'"), git_dir);
b57fb80a 1065
3781fcce
ÆAB
1066 if (0 <= option_verbosity) {
1067 if (option_bare)
68b939b2 1068 fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
3781fcce 1069 else
68b939b2 1070 fprintf(stderr, _("Cloning into '%s'...\n"), dir);
3781fcce 1071 }
31224cbd 1072
bb62e0a9
BW
1073 if (option_recurse_submodules.nr > 0) {
1074 struct string_list_item *item;
1075 struct strbuf sb = STRBUF_INIT;
48072e3d 1076 int val;
bb62e0a9
BW
1077
1078 /* remove duplicates */
1079 string_list_sort(&option_recurse_submodules);
1080 string_list_remove_duplicates(&option_recurse_submodules, 0);
1081
1082 /*
1083 * NEEDSWORK: In a multi-working-tree world, this needs to be
1084 * set in the per-worktree config.
1085 */
1086 for_each_string_list_item(item, &option_recurse_submodules) {
1087 strbuf_addf(&sb, "submodule.active=%s",
1088 item->string);
1089 string_list_append(&option_config,
1090 strbuf_detach(&sb, NULL));
1091 }
1092
48072e3d
MK
1093 if (!git_config_get_bool("submodule.stickyRecursiveClone", &val) &&
1094 val)
1095 string_list_append(&option_config, "submodule.recurse=true");
1096
31224cbd
SB
1097 if (option_required_reference.nr &&
1098 option_optional_reference.nr)
1099 die(_("clone --recursive is not compatible with "
1100 "both --reference and --reference-if-able"));
1101 else if (option_required_reference.nr) {
1102 string_list_append(&option_config,
1103 "submodule.alternateLocation=superproject");
1104 string_list_append(&option_config,
1105 "submodule.alternateErrorStrategy=die");
1106 } else if (option_optional_reference.nr) {
1107 string_list_append(&option_config,
1108 "submodule.alternateLocation=superproject");
1109 string_list_append(&option_config,
1110 "submodule.alternateErrorStrategy=info");
1111 }
1112 }
1113
18c9cb75
PS
1114 /*
1115 * Initialize the repository, but skip initializing the reference
1116 * database. We do not yet know about the object format of the
1117 * repository, and reference backends may persist that information into
1118 * their on-disk data structures.
1119 */
173761e2 1120 init_db(git_dir, real_git_dir, option_template, GIT_HASH_UNKNOWN,
5ed860f5 1121 ref_storage_format, NULL,
18c9cb75 1122 do_not_override_repo_unix_permissions, INIT_DB_QUIET | INIT_DB_SKIP_REFDB);
33158701 1123
27ff1fbc
ÆAB
1124 if (real_git_dir) {
1125 free((char *)git_dir);
33158701 1126 git_dir = real_git_dir;
27ff1fbc 1127 }
33158701 1128
199f44cb
PS
1129 /*
1130 * We have a chicken-and-egg situation between initializing the refdb
1131 * and spawning transport helpers:
1132 *
1133 * - Initializing the refdb requires us to know about the object
1134 * format. We thus have to spawn the transport helper to learn
1135 * about it.
1136 *
1137 * - The transport helper may want to access the Git repository. But
1138 * because the refdb has not been initialized, we don't have "HEAD"
1139 * or "refs/". Thus, the helper cannot find the Git repository.
1140 *
1141 * Ideally, we would have structured the helper protocol such that it's
1142 * mandatory for the helper to first announce its capabilities without
1143 * yet assuming a fully initialized repository. Like that, we could
1144 * have added a "lazy-refdb-init" capability that announces whether the
1145 * helper is ready to handle not-yet-initialized refdbs. If any helper
1146 * didn't support them, we would have fully initialized the refdb with
1147 * the SHA1 object format, but later on bailed out if we found out that
1148 * the remote repository used a different object format.
1149 *
1150 * But we didn't, and thus we use the following workaround to partially
1151 * initialize the repository's refdb such that it can be discovered by
1152 * Git commands. To do so, we:
1153 *
1154 * - Create an invalid HEAD ref pointing at "refs/heads/.invalid".
1155 *
1156 * - Create the "refs/" directory.
1157 *
1158 * - Set up the ref storage format and repository version as
1159 * required.
1160 *
1161 * This is sufficient for Git commands to discover the Git directory.
1162 */
1163 initialize_repository_version(GIT_HASH_UNKNOWN,
1164 the_repository->ref_storage_format, 1);
1165
1166 strbuf_addf(&buf, "%s/HEAD", git_dir);
1167 write_file(buf.buf, "ref: refs/heads/.invalid");
1168
1169 strbuf_reset(&buf);
1170 strbuf_addf(&buf, "%s/refs", git_dir);
1171 safe_create_dir(buf.buf, 1);
1172
552955ed
SB
1173 /*
1174 * additional config can be injected with -c, make sure it's included
1175 * after init_db, which clears the entire config environment.
1176 */
84054f79 1177 write_config(&option_config);
8434c2f1 1178
552955ed
SB
1179 /*
1180 * re-read config after init_db and write_config to pick up any config
1181 * injected by --template and --config, respectively.
1182 */
1183 git_config(git_clone_config, NULL);
8434c2f1 1184
4fe788b1
LL
1185 /*
1186 * If option_reject_shallow is specified from CLI option,
1187 * ignore config_reject_shallow from git_clone_config.
1188 */
1189 if (config_reject_shallow != -1)
1190 reject_shallow = config_reject_shallow;
1191 if (option_reject_shallow != -1)
1192 reject_shallow = option_reject_shallow;
1193
f05da2b4
JS
1194 /*
1195 * If option_filter_submodules is specified from CLI option,
1196 * ignore config_filter_submodules from git_clone_config.
1197 */
1198 if (config_filter_submodules != -1)
1199 filter_submodules = config_filter_submodules;
1200 if (option_filter_submodules != -1)
1201 filter_submodules = option_filter_submodules;
1202
1203 /*
1204 * Exit if the user seems to be doing something silly with submodule
1205 * filter flags (but not with filter configs, as those should be
1206 * set-and-forget).
1207 */
1208 if (option_filter_submodules > 0 && !filter_options.choice)
1209 die(_("the option '%s' requires '%s'"),
1210 "--also-filter-submodules", "--filter");
1211 if (option_filter_submodules > 0 && !option_recurse_submodules.nr)
1212 die(_("the option '%s' requires '%s'"),
1213 "--also-filter-submodules", "--recurse-submodules");
1214
de9ed3ef
SB
1215 /*
1216 * apply the remote name provided by --origin only after this second
1217 * call to git_config, to ensure it overrides all config-based values.
1218 */
538dc459 1219 if (option_origin) {
6dfadc89 1220 free(remote_name);
de9ed3ef 1221 remote_name = xstrdup(option_origin);
6dfadc89 1222 }
de9ed3ef 1223
afe8a907 1224 if (!remote_name)
de9ed3ef
SB
1225 remote_name = xstrdup("origin");
1226
1227 if (!valid_remote_name(remote_name))
1228 die(_("'%s' is not a valid remote name"), remote_name);
8434c2f1
DB
1229
1230 if (option_bare) {
bc699afc
JS
1231 if (option_mirror)
1232 src_ref_prefix = "refs/";
b5ff37ac 1233 strbuf_addstr(&branch_top, src_ref_prefix);
8434c2f1
DB
1234
1235 git_config_set("core.bare", "true");
1236 } else {
75ca3906 1237 strbuf_addf(&branch_top, "refs/remotes/%s/", remote_name);
bc699afc 1238 }
8434c2f1 1239
75ca3906 1240 strbuf_addf(&key, "remote.%s.url", remote_name);
df61c889
SR
1241 git_config_set(key.buf, repo);
1242 strbuf_reset(&key);
1243
0dab2468 1244 if (option_no_tags) {
75ca3906 1245 strbuf_addf(&key, "remote.%s.tagOpt", remote_name);
0dab2468
ÆAB
1246 git_config_set(key.buf, "--no-tags");
1247 strbuf_reset(&key);
1248 }
1249
f7415b4d 1250 if (option_required_reference.nr || option_optional_reference.nr)
dbc92b07 1251 setup_reference();
766ac6a6 1252
3c8f60c6 1253 remote = remote_get_early(remote_name);
689f0396 1254
1af8b8c0
RS
1255 refspec_appendf(&remote->fetch, "+%s*:%s*", src_ref_prefix,
1256 branch_top.buf);
8434c2f1 1257
f38aa83f
MB
1258 path = get_repo_path(remote->url[0], &is_bundle);
1259 is_local = option_local != 0 && path && !is_bundle;
1260 if (is_local) {
1261 if (option_depth)
1262 warning(_("--depth is ignored in local clones; use file:// instead."));
994c2aaf
NTND
1263 if (option_since)
1264 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
859e5df9
NTND
1265 if (option_not.nr)
1266 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
548719fb
JT
1267 if (filter_options.choice)
1268 warning(_("--filter is ignored in local clones; use file:// instead."));
f38aa83f 1269 if (!access(mkpath("%s/shallow", path), F_OK)) {
4fe788b1
LL
1270 if (reject_shallow)
1271 die(_("source repository is shallow, reject to clone."));
f38aa83f
MB
1272 if (option_local > 0)
1273 warning(_("source repository is shallow, ignoring --local"));
1274 is_local = 0;
1275 }
1276 }
1277 if (option_local > 0 && !is_local)
1278 warning(_("--local is ignored"));
cf8f6ce0
TB
1279
1280 transport = transport_get(remote, path ? path : remote->url[0]);
1281 transport_set_verbosity(transport, option_verbosity, option_progress);
1282 transport->family = family;
beea4152 1283 transport->cloning = 1;
8434c2f1 1284
86fdd94d
DS
1285 if (is_bundle) {
1286 struct bundle_header header = BUNDLE_HEADER_INIT;
1287 int fd = read_bundle_header(path, &header);
1288 int has_filter = header.filter.choice != LOFC_DISABLED;
1289
1290 if (fd > 0)
1291 close(fd);
1292 bundle_header_release(&header);
1293 if (has_filter)
1294 die(_("cannot clone from filtered bundle"));
1295 }
1296
643f918d 1297 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
8434c2f1 1298
4fe788b1
LL
1299 if (reject_shallow)
1300 transport_set_option(transport, TRANS_OPT_REJECT_SHALLOW, "1");
643f918d
JK
1301 if (option_depth)
1302 transport_set_option(transport, TRANS_OPT_DEPTH,
1303 option_depth);
994c2aaf
NTND
1304 if (option_since)
1305 transport_set_option(transport, TRANS_OPT_DEEPEN_SINCE,
1306 option_since);
859e5df9
NTND
1307 if (option_not.nr)
1308 transport_set_option(transport, TRANS_OPT_DEEPEN_NOT,
1309 (const char *)&option_not);
643f918d
JK
1310 if (option_single_branch)
1311 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
8434c2f1 1312
643f918d
JK
1313 if (option_upload_pack)
1314 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
1315 option_upload_pack);
c6807a40 1316
6e983059
JT
1317 if (server_options.nr)
1318 transport->server_options = &server_options;
1319
548719fb 1320 if (filter_options.choice) {
cf9ceb5a
MD
1321 const char *spec =
1322 expand_list_objects_filter_spec(&filter_options);
548719fb 1323 transport_set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER,
cf9ceb5a 1324 spec);
548719fb
JT
1325 transport_set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1326 }
1327
1328 if (transport->smart_options && !deepen && !filter_options.choice)
643f918d 1329 transport->smart_options->check_self_contained_and_connected = 1;
8434c2f1 1330
91590293
PS
1331 strvec_push(&transport_ls_refs_options.ref_prefixes, "HEAD");
1332 refspec_ref_prefixes(&remote->fetch,
1333 &transport_ls_refs_options.ref_prefixes);
1334 if (option_branch)
1335 expand_ref_prefix(&transport_ls_refs_options.ref_prefixes,
1336 option_branch);
1337 if (!option_no_tags)
1338 strvec_push(&transport_ls_refs_options.ref_prefixes,
1339 "refs/tags/");
1340
1341 refs = transport_get_remote_refs(transport, &transport_ls_refs_options);
1342
1343 /*
1344 * Now that we know what algorithm the remote side is using, let's set
1345 * ours to the same thing.
1346 */
1347 hash_algo = hash_algo_by_ptr(transport_get_hash_algo(transport));
d7497a42 1348 initialize_repository_version(hash_algo, the_repository->ref_storage_format, 1);
91590293 1349 repo_set_hash_algo(the_repository, hash_algo);
173761e2 1350 create_reference_database(the_repository->ref_storage_format, NULL, 1);
91590293 1351
55568919
DS
1352 /*
1353 * Before fetching from the remote, download and install bundle
1354 * data from the --bundle-uri option.
1355 */
1356 if (bundle_uri) {
4074d3c7
DS
1357 int has_heuristic = 0;
1358
55568919 1359 /* At this point, we need the_repository to match the cloned repo. */
65da9389
DS
1360 if (repo_init(the_repository, git_dir, work_tree))
1361 warning(_("failed to initialize the repo, skipping bundle URI"));
4074d3c7 1362 else if (fetch_bundle_uri(the_repository, bundle_uri, &has_heuristic))
55568919
DS
1363 warning(_("failed to fetch objects from bundle URI '%s'"),
1364 bundle_uri);
4074d3c7
DS
1365 else if (has_heuristic)
1366 git_config_set_gently("fetch.bundleuri", bundle_uri);
91590293 1367 } else {
876094ac
DS
1368 /*
1369 * Populate transport->got_remote_bundle_uri and
1370 * transport->bundle_uri. We might get nothing.
1371 */
1372 transport_get_remote_bundle_uri(transport);
1373
1374 if (transport->bundles &&
1375 hashmap_get_size(&transport->bundles->bundles)) {
1376 /* At this point, we need the_repository to match the cloned repo. */
1377 if (repo_init(the_repository, git_dir, work_tree))
1378 warning(_("failed to initialize the repo, skipping bundle URI"));
1379 else if (fetch_bundle_list(the_repository,
1380 transport->bundles))
1381 warning(_("failed to fetch advertised bundles"));
1382 } else {
1383 clear_bundle_list(transport->bundles);
1384 FREE_AND_NULL(transport->bundles);
1385 }
1386 }
0cfde740 1387
91590293
PS
1388 if (refs)
1389 mapped_refs = wanted_peer_refs(refs, &remote->fetch);
8b214c2e
JH
1390
1391 if (mapped_refs) {
5b05795c
MH
1392 /*
1393 * transport_get_remote_refs() may return refs with null sha-1
1394 * in mapped_refs (see struct transport->get_refs_list
1395 * comment). In that case we need fetch it early because
1396 * remote_head code below relies on it.
1397 *
1398 * for normal clones, transport_get_remote_refs() should
1399 * return reliable ref set, we can delay cloning until after
1400 * remote HEAD check.
1401 */
1402 for (ref = refs; ref; ref = ref->next)
f4e54d02 1403 if (is_null_oid(&ref->old_oid)) {
5b05795c
MH
1404 complete_refs_before_fetch = 0;
1405 break;
1406 }
90498161 1407
aab179d9 1408 if (!is_local && !complete_refs_before_fetch) {
6aacb7d8
JK
1409 if (transport_fetch_refs(transport, mapped_refs))
1410 die(_("remote transport reported error"));
aab179d9 1411 }
86ac7518 1412 }
6b58df54 1413
3d8314f8
JK
1414 remote_head = find_ref_by_name(refs, "HEAD");
1415 remote_head_points_at = guess_remote_head(remote_head, mapped_refs, 0);
a3552aba 1416
3d8314f8
JK
1417 if (option_branch) {
1418 our_head_points_at = find_remote_branch(mapped_refs, option_branch);
1419 if (!our_head_points_at)
1420 die(_("Remote branch %s not found in upstream %s"),
1421 option_branch, remote_name);
1422 } else if (remote_head_points_at) {
1423 our_head_points_at = remote_head_points_at;
1424 } else if (remote_head) {
7a4ee28f 1425 our_head_points_at = NULL;
3d8314f8 1426 } else {
6b58df54 1427 const char *branch;
6b58df54 1428
3d8314f8
JK
1429 if (!mapped_refs) {
1430 warning(_("You appear to have cloned an empty repository."));
1431 option_no_checkout = 1;
1432 }
0cc1b475 1433
6b58df54
JK
1434 if (transport_ls_refs_options.unborn_head_target &&
1435 skip_prefix(transport_ls_refs_options.unborn_head_target,
1436 "refs/heads/", &branch)) {
daf7898a 1437 unborn_head = xstrdup(transport_ls_refs_options.unborn_head_target);
6b58df54
JK
1438 } else {
1439 branch = git_default_branch_name(0);
daf7898a 1440 unborn_head = xstrfmt("refs/heads/%s", branch);
0cc1b475 1441 }
6b58df54 1442
cc8fcd1e
JK
1443 /*
1444 * We may have selected a local default branch name "foo",
1445 * and even though the remote's HEAD does not point there,
1446 * it may still have a "foo" branch. If so, set it up so
1447 * that we can follow the usual checkout code later.
1448 *
1449 * Note that for an empty repo we'll already have set
1450 * option_no_checkout above, which would work against us here.
1451 * But for an empty repo, find_remote_branch() can never find
1452 * a match.
1453 */
1454 our_head_points_at = find_remote_branch(mapped_refs, branch);
86ac7518 1455 }
8434c2f1 1456
31b808a0
RT
1457 write_refspec_config(src_ref_prefix, our_head_points_at,
1458 remote_head_points_at, &branch_top);
1459
548719fb 1460 if (filter_options.choice)
75ca3906 1461 partial_clone_register(remote_name, &filter_options);
548719fb 1462
6f48d39f
NTND
1463 if (is_local)
1464 clone_local(path, git_dir);
dccea605 1465 else if (mapped_refs && complete_refs_before_fetch) {
6aacb7d8
JK
1466 if (transport_fetch_refs(transport, mapped_refs))
1467 die(_("remote transport reported error"));
aab179d9 1468 }
8434c2f1 1469
960b7d1c 1470 update_remote_refs(refs, mapped_refs, remote_head_points_at,
548719fb 1471 branch_top.buf, reflog_msg.buf, transport,
2b98478c 1472 !is_local);
8434c2f1 1473
daf7898a 1474 update_head(our_head_points_at, remote_head, unborn_head, reflog_msg.buf);
1db4a75c 1475
72c5f883
JK
1476 /*
1477 * We want to show progress for recursive submodule clones iff
1478 * we did so for the main clone. But only the transport knows
1479 * the final decision for this flag, so we need to rescue the value
1480 * before we free the transport.
1481 */
1482 submodule_progress = transport->progress;
1483
58d4d7f1 1484 transport_unlock_pack(transport, 0);
6f48d39f 1485 transport_disconnect(transport);
1db4a75c 1486
786b150c 1487 if (option_dissociate) {
2d511cfc 1488 close_object_store(the_repository->objects);
fb1d6dab 1489 dissociate_from_references();
786b150c 1490 }
fb1d6dab 1491
360822a3
PS
1492 if (option_sparse_checkout && git_sparse_checkout_init(dir))
1493 return 1;
1494
d3b34622 1495 junk_mode = JUNK_LEAVE_REPO;
f05da2b4 1496 err = checkout(submodule_progress, filter_submodules);
8434c2f1 1497
de9ed3ef 1498 free(remote_name);
8434c2f1 1499 strbuf_release(&reflog_msg);
b5ff37ac 1500 strbuf_release(&branch_top);
199f44cb 1501 strbuf_release(&buf);
b5ff37ac 1502 strbuf_release(&key);
0c454273
AH
1503 free_refs(mapped_refs);
1504 free_refs(remote_head_points_at);
daf7898a 1505 free(unborn_head);
0c454273
AH
1506 free(dir);
1507 free(path);
81e5c39c 1508 free(repo_to_free);
d3b34622 1509 junk_mode = JUNK_LEAVE_ALL;
50b67732 1510
f36d4f83 1511 transport_ls_refs_options_release(&transport_ls_refs_options);
dfa7a6c5 1512 return err;
8434c2f1 1513}