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