]> git.ipfire.org Git - thirdparty/git.git/blame - builtin/clone.c
Merge branch 'jk/parseopt-string-list' into jk/string-list-static-init
[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"
697cc8ef 12#include "lockfile.h"
8434c2f1
DB
13#include "parse-options.h"
14#include "fetch-pack.h"
15#include "refs.h"
16#include "tree.h"
17#include "tree-walk.h"
18#include "unpack-trees.h"
19#include "transport.h"
20#include "strbuf.h"
21#include "dir.h"
4a16d072 22#include "sigchain.h"
a9f2c136 23#include "branch.h"
8ef51733 24#include "remote.h"
dfa7a6c5 25#include "run-command.h"
0433ad12 26#include "connected.h"
8434c2f1
DB
27
28/*
29 * Overall FIXMEs:
30 * - respect DB_ENVIRONMENT for .git/objects.
31 *
32 * Implementation notes:
33 * - dropping use-separate-remote and no-separate-remote compatibility
34 *
35 */
36static const char * const builtin_clone_usage[] = {
9c9b4f2f 37 N_("git clone [<options>] [--] <repo> [<dir>]"),
8434c2f1
DB
38 NULL
39};
40
3e6e0edd 41static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
189260b1 42static int option_local = -1, option_no_hardlinks, option_shared, option_recursive;
d22eb044 43static int option_shallow_submodules = -1;
dbc92b07 44static char *option_template, *option_depth;
8434c2f1 45static char *option_origin = NULL;
7a4ee28f 46static char *option_branch = NULL;
b57fb80a 47static const char *real_git_dir;
8434c2f1 48static char *option_upload_pack = "git-upload-pack";
5bd631b3 49static int option_verbosity;
01fdc21f 50static int option_progress = -1;
c915f11e 51static enum transport_family family;
84054f79 52static struct string_list option_config;
dbc92b07 53static struct string_list option_reference;
fb1d6dab 54static int option_dissociate;
72290d6a 55static int max_jobs = -1;
dbc92b07 56
8434c2f1 57static struct option builtin_clone_options[] = {
5bd631b3 58 OPT__VERBOSITY(&option_verbosity),
01fdc21f 59 OPT_BOOL(0, "progress", &option_progress,
32b77add 60 N_("force progress reporting")),
d5d09d47
SB
61 OPT_BOOL('n', "no-checkout", &option_no_checkout,
62 N_("don't create a checkout")),
4741edd5
SB
63 OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
64 OPT_HIDDEN_BOOL(0, "naked", &option_bare,
65 N_("create a bare repository")),
d5d09d47
SB
66 OPT_BOOL(0, "mirror", &option_mirror,
67 N_("create a mirror repository (implies bare)")),
189260b1 68 OPT_BOOL('l', "local", &option_local,
32b77add 69 N_("to clone from a local repository")),
d5d09d47 70 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
32b77add 71 N_("don't use local hardlinks, always copy")),
d5d09d47 72 OPT_BOOL('s', "shared", &option_shared,
32b77add 73 N_("setup as shared repository")),
d5d09d47 74 OPT_BOOL(0, "recursive", &option_recursive,
32b77add 75 N_("initialize submodules in the clone")),
d5d09d47 76 OPT_BOOL(0, "recurse-submodules", &option_recursive,
32b77add 77 N_("initialize submodules in the clone")),
72290d6a
SB
78 OPT_INTEGER('j', "jobs", &max_jobs,
79 N_("number of submodules cloned in parallel")),
32b77add
NTND
80 OPT_STRING(0, "template", &option_template, N_("template-directory"),
81 N_("directory from which templates will be used")),
8ade009c
JK
82 OPT_STRING_LIST(0, "reference", &option_reference, N_("repo"),
83 N_("reference repository")),
14f8b9b4
JK
84 OPT_BOOL(0, "dissociate", &option_dissociate,
85 N_("use --reference only while cloning")),
32b77add
NTND
86 OPT_STRING('o', "origin", &option_origin, N_("name"),
87 N_("use <name> instead of 'origin' to track upstream")),
88 OPT_STRING('b', "branch", &option_branch, N_("branch"),
89 N_("checkout <branch> instead of the remote's HEAD")),
90 OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
91 N_("path to git-upload-pack on the remote")),
92 OPT_STRING(0, "depth", &option_depth, N_("depth"),
93 N_("create a shallow clone of that depth")),
3e6e0edd 94 OPT_BOOL(0, "single-branch", &option_single_branch,
32b77add 95 N_("clone only one branch, HEAD or --branch")),
d22eb044
SB
96 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules,
97 N_("any cloned submodules will be shallow")),
32b77add
NTND
98 OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
99 N_("separate git dir from working tree")),
100 OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
101 N_("set config inside the new repository")),
c915f11e
EW
102 OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
103 TRANSPORT_FAMILY_IPV4),
104 OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
105 TRANSPORT_FAMILY_IPV6),
8434c2f1
DB
106 OPT_END()
107};
108
0ea68e42 109static const char *get_repo_path_1(struct strbuf *path, int *is_bundle)
8434c2f1 110{
b3256eb8 111 static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
8434c2f1 112 static char *bundle_suffix[] = { ".bundle", "" };
0ea68e42 113 size_t baselen = path->len;
8434c2f1
DB
114 struct stat st;
115 int i;
116
117 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
0ea68e42
JK
118 strbuf_setlen(path, baselen);
119 strbuf_addstr(path, suffix[i]);
120 if (stat(path->buf, &st))
9b0ebc72 121 continue;
0ea68e42 122 if (S_ISDIR(st.st_mode) && is_git_directory(path->buf)) {
8434c2f1 123 *is_bundle = 0;
0ea68e42 124 return path->buf;
9b0ebc72
NTND
125 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
126 /* Is it a "gitfile"? */
127 char signature[8];
0ea68e42
JK
128 const char *dst;
129 int len, fd = open(path->buf, O_RDONLY);
9b0ebc72
NTND
130 if (fd < 0)
131 continue;
132 len = read_in_full(fd, signature, 8);
133 close(fd);
134 if (len != 8 || strncmp(signature, "gitdir: ", 8))
135 continue;
0ea68e42
JK
136 dst = read_gitfile(path->buf);
137 if (dst) {
9b0ebc72 138 *is_bundle = 0;
0ea68e42 139 return dst;
9b0ebc72 140 }
8434c2f1
DB
141 }
142 }
143
144 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
0ea68e42
JK
145 strbuf_setlen(path, baselen);
146 strbuf_addstr(path, bundle_suffix[i]);
147 if (!stat(path->buf, &st) && S_ISREG(st.st_mode)) {
8434c2f1 148 *is_bundle = 1;
0ea68e42 149 return path->buf;
8434c2f1
DB
150 }
151 }
152
153 return NULL;
154}
155
0ea68e42
JK
156static char *get_repo_path(const char *repo, int *is_bundle)
157{
158 struct strbuf path = STRBUF_INIT;
159 const char *raw;
160 char *canon;
161
162 strbuf_addstr(&path, repo);
163 raw = get_repo_path_1(&path, is_bundle);
164 canon = raw ? xstrdup(absolute_path(raw)) : NULL;
165 strbuf_release(&path);
166 return canon;
167}
168
6612f877 169static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
8434c2f1 170{
e8959867 171 const char *end = repo + strlen(repo), *start, *ptr;
7e837c64 172 size_t len;
8a94bc7b 173 char *dir;
b8c5db35 174
e8959867
PS
175 /*
176 * Skip scheme.
177 */
178 start = strstr(repo, "://");
179 if (start == NULL)
180 start = repo;
181 else
182 start += 3;
183
184 /*
185 * Skip authentication data. The stripping does happen
186 * greedily, such that we strip up to the last '@' inside
187 * the host part.
188 */
189 for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
190 if (*ptr == '@')
191 start = ptr + 1;
192 }
193
b8c5db35 194 /*
8a94bc7b 195 * Strip trailing spaces, slashes and /.git
b8c5db35 196 */
e8959867 197 while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
b8c5db35 198 end--;
e8959867 199 if (end - start > 5 && is_dir_sep(end[-5]) &&
b8c5db35
JS
200 !strncmp(end - 4, ".git", 4)) {
201 end -= 5;
e8959867 202 while (start < end && is_dir_sep(end[-1]))
b8c5db35
JS
203 end--;
204 }
205
206 /*
92722efe
PS
207 * Strip trailing port number if we've got only a
208 * hostname (that is, there is no dir separator but a
209 * colon). This check is required such that we do not
210 * strip URI's like '/foo/bar:2222.git', which should
211 * result in a dir '2222' being guessed due to backwards
212 * compatibility.
213 */
214 if (memchr(start, '/', end - start) == NULL
215 && memchr(start, ':', end - start) != NULL) {
216 ptr = end;
217 while (start < ptr && isdigit(ptr[-1]) && ptr[-1] != ':')
218 ptr--;
219 if (start < ptr && ptr[-1] == ':')
220 end = ptr - 1;
221 }
222
b8c5db35 223 /*
e8959867
PS
224 * Find last component. To remain backwards compatible we
225 * also regard colons as path separators, such that
226 * cloning a repository 'foo:bar.git' would result in a
227 * directory 'bar' being guessed.
b8c5db35 228 */
e8959867
PS
229 ptr = end;
230 while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
231 ptr--;
232 start = ptr;
b8c5db35
JS
233
234 /*
235 * Strip .{bundle,git}.
236 */
db2e2204
JK
237 len = end - start;
238 strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
8434c2f1 239
adef9561 240 if (!len || (len == 1 && *start == '/'))
39ad4f39
NTND
241 die(_("No directory name could be guessed.\n"
242 "Please specify a directory on the command line"));
adef9561 243
7e837c64
SS
244 if (is_bare)
245 dir = xstrfmt("%.*s.git", (int)len, start);
246 else
247 dir = xstrndup(start, len);
8a94bc7b
AR
248 /*
249 * Replace sequences of 'control' characters and whitespace
250 * with one ascii space, remove leading and trailing spaces.
251 */
252 if (*dir) {
253 char *out = dir;
254 int prev_space = 1 /* strip leading whitespace */;
255 for (end = dir; *end; ++end) {
256 char ch = *end;
257 if ((unsigned char)ch < '\x20')
258 ch = '\x20';
259 if (isspace(ch)) {
260 if (prev_space)
261 continue;
262 prev_space = 1;
263 } else
264 prev_space = 0;
265 *out++ = ch;
266 }
267 *out = '\0';
268 if (out > dir && prev_space)
269 out[-1] = '\0';
6612f877 270 }
8a94bc7b 271 return dir;
8434c2f1
DB
272}
273
44a68fd5
CB
274static void strip_trailing_slashes(char *dir)
275{
276 char *end = dir + strlen(dir);
277
278 while (dir < end - 1 && is_dir_sep(end[-1]))
279 end--;
280 *end = '\0';
281}
282
dbc92b07 283static int add_one_reference(struct string_list_item *item, void *cb_data)
8434c2f1 284{
e6baf4a1 285 char *ref_git;
b552b56d 286 const char *repo;
e6baf4a1 287 struct strbuf alternate = STRBUF_INIT;
8434c2f1 288
b552b56d 289 /* Beware: read_gitfile(), real_path() and mkpath() return static buffer */
e6baf4a1 290 ref_git = xstrdup(real_path(item->string));
b552b56d
AS
291
292 repo = read_gitfile(ref_git);
293 if (!repo)
294 repo = read_gitfile(mkpath("%s/.git", ref_git));
295 if (repo) {
296 free(ref_git);
297 ref_git = xstrdup(repo);
298 }
299
300 if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
4e2d094d 301 char *ref_git_git = mkpathdup("%s/.git", ref_git);
e6baf4a1
JH
302 free(ref_git);
303 ref_git = ref_git_git;
d78db842
NTND
304 } else if (!is_directory(mkpath("%s/objects", ref_git))) {
305 struct strbuf sb = STRBUF_INIT;
306 if (get_common_dir(&sb, ref_git))
307 die(_("reference repository '%s' as a linked checkout is not supported yet."),
308 item->string);
0658569e 309 die(_("reference repository '%s' is not a local repository."),
dbc92b07 310 item->string);
d78db842 311 }
8434c2f1 312
606e435a
NTND
313 if (!access(mkpath("%s/shallow", ref_git), F_OK))
314 die(_("reference repository '%s' is shallow"), item->string);
315
316 if (!access(mkpath("%s/info/grafts", ref_git), F_OK))
317 die(_("reference repository '%s' is grafted"), item->string);
318
e6baf4a1
JH
319 strbuf_addf(&alternate, "%s/objects", ref_git);
320 add_to_alternates_file(alternate.buf);
321 strbuf_release(&alternate);
e6baf4a1 322 free(ref_git);
dbc92b07
JH
323 return 0;
324}
8434c2f1 325
dbc92b07
JH
326static void setup_reference(void)
327{
328 for_each_string_list(&option_reference, add_one_reference, NULL);
8434c2f1
DB
329}
330
e6baf4a1
JH
331static void copy_alternates(struct strbuf *src, struct strbuf *dst,
332 const char *src_repo)
333{
334 /*
335 * Read from the source objects/info/alternates file
336 * and copy the entries to corresponding file in the
337 * destination repository with add_to_alternates_file().
338 * Both src and dst have "$path/objects/info/alternates".
339 *
340 * Instead of copying bit-for-bit from the original,
341 * we need to append to existing one so that the already
342 * created entry via "clone -s" is not lost, and also
343 * to turn entries with paths relative to the original
344 * absolute, so that they can be used in the new repository.
345 */
346 FILE *in = fopen(src->buf, "r");
347 struct strbuf line = STRBUF_INIT;
348
3f163962 349 while (strbuf_getline(&line, in) != EOF) {
dcf69262 350 char *abs_path;
e6baf4a1
JH
351 if (!line.len || line.buf[0] == '#')
352 continue;
353 if (is_absolute_path(line.buf)) {
354 add_to_alternates_file(line.buf);
355 continue;
356 }
dcf69262
NTND
357 abs_path = mkpathdup("%s/objects/%s", src_repo, line.buf);
358 normalize_path_copy(abs_path, abs_path);
359 add_to_alternates_file(abs_path);
360 free(abs_path);
e6baf4a1
JH
361 }
362 strbuf_release(&line);
363 fclose(in);
364}
365
366static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
367 const char *src_repo, int src_baselen)
8434c2f1
DB
368{
369 struct dirent *de;
370 struct stat buf;
371 int src_len, dest_len;
372 DIR *dir;
373
b9e125e0 374 dir = opendir(src->buf);
8434c2f1 375 if (!dir)
e84d7b74 376 die_errno(_("failed to open '%s'"), src->buf);
8434c2f1 377
b9e125e0 378 if (mkdir(dest->buf, 0777)) {
8434c2f1 379 if (errno != EEXIST)
e84d7b74 380 die_errno(_("failed to create directory '%s'"), dest->buf);
b9e125e0 381 else if (stat(dest->buf, &buf))
e84d7b74 382 die_errno(_("failed to stat '%s'"), dest->buf);
8434c2f1 383 else if (!S_ISDIR(buf.st_mode))
e84d7b74 384 die(_("%s exists and is not a directory"), dest->buf);
8434c2f1
DB
385 }
386
b9e125e0
MV
387 strbuf_addch(src, '/');
388 src_len = src->len;
389 strbuf_addch(dest, '/');
390 dest_len = dest->len;
8434c2f1
DB
391
392 while ((de = readdir(dir)) != NULL) {
b9e125e0
MV
393 strbuf_setlen(src, src_len);
394 strbuf_addstr(src, de->d_name);
395 strbuf_setlen(dest, dest_len);
396 strbuf_addstr(dest, de->d_name);
397 if (stat(src->buf, &buf)) {
e84d7b74 398 warning (_("failed to stat %s\n"), src->buf);
8434c2f1
DB
399 continue;
400 }
401 if (S_ISDIR(buf.st_mode)) {
402 if (de->d_name[0] != '.')
e6baf4a1
JH
403 copy_or_link_directory(src, dest,
404 src_repo, src_baselen);
405 continue;
406 }
407
408 /* Files that cannot be copied bit-for-bit... */
409 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
410 copy_alternates(src, dest, src_repo);
8434c2f1
DB
411 continue;
412 }
413
b9e125e0 414 if (unlink(dest->buf) && errno != ENOENT)
e84d7b74 415 die_errno(_("failed to unlink '%s'"), dest->buf);
fdabc242 416 if (!option_no_hardlinks) {
b9e125e0 417 if (!link(src->buf, dest->buf))
fdabc242 418 continue;
189260b1 419 if (option_local > 0)
e84d7b74 420 die_errno(_("failed to create link '%s'"), dest->buf);
fdabc242 421 option_no_hardlinks = 1;
8434c2f1 422 }
f7835a25 423 if (copy_file_with_time(dest->buf, src->buf, 0666))
e84d7b74 424 die_errno(_("failed to copy file to '%s'"), dest->buf);
8434c2f1 425 }
689ef4d4 426 closedir(dir);
8434c2f1
DB
427}
428
6f48d39f 429static void clone_local(const char *src_repo, const char *dest_repo)
8434c2f1 430{
e6baf4a1
JH
431 if (option_shared) {
432 struct strbuf alt = STRBUF_INIT;
433 strbuf_addf(&alt, "%s/objects", src_repo);
434 add_to_alternates_file(alt.buf);
435 strbuf_release(&alt);
436 } else {
437 struct strbuf src = STRBUF_INIT;
438 struct strbuf dest = STRBUF_INIT;
744e4697
NTND
439 get_common_dir(&src, src_repo);
440 get_common_dir(&dest, dest_repo);
441 strbuf_addstr(&src, "/objects");
442 strbuf_addstr(&dest, "/objects");
e6baf4a1 443 copy_or_link_directory(&src, &dest, src_repo, src.len);
b9e125e0
MV
444 strbuf_release(&src);
445 strbuf_release(&dest);
8434c2f1
DB
446 }
447
28ba96ab 448 if (0 <= option_verbosity)
68b939b2 449 fprintf(stderr, _("done.\n"));
8434c2f1
DB
450}
451
452static const char *junk_work_tree;
453static const char *junk_git_dir;
85064630 454static enum {
d3b34622
JK
455 JUNK_LEAVE_NONE,
456 JUNK_LEAVE_REPO,
457 JUNK_LEAVE_ALL
458} junk_mode = JUNK_LEAVE_NONE;
459
460static const char junk_leave_repo_msg[] =
461N_("Clone succeeded, but checkout failed.\n"
462 "You can inspect what was checked out with 'git status'\n"
463 "and retry the checkout with 'git checkout -f HEAD'\n");
8434c2f1
DB
464
465static void remove_junk(void)
466{
f285a2d7 467 struct strbuf sb = STRBUF_INIT;
d3b34622
JK
468
469 switch (junk_mode) {
470 case JUNK_LEAVE_REPO:
471 warning("%s", _(junk_leave_repo_msg));
472 /* fall-through */
473 case JUNK_LEAVE_ALL:
474 return;
475 default:
476 /* proceed to removal */
477 break;
478 }
479
8434c2f1
DB
480 if (junk_git_dir) {
481 strbuf_addstr(&sb, junk_git_dir);
482 remove_dir_recursively(&sb, 0);
483 strbuf_reset(&sb);
484 }
485 if (junk_work_tree) {
486 strbuf_addstr(&sb, junk_work_tree);
487 remove_dir_recursively(&sb, 0);
488 strbuf_reset(&sb);
489 }
490}
491
492static void remove_junk_on_signal(int signo)
493{
494 remove_junk();
4a16d072 495 sigchain_pop(signo);
8434c2f1
DB
496 raise(signo);
497}
498
9e585046
NTND
499static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
500{
501 struct ref *ref;
502 struct strbuf head = STRBUF_INIT;
503 strbuf_addstr(&head, "refs/heads/");
504 strbuf_addstr(&head, branch);
505 ref = find_ref_by_name(refs, head.buf);
506 strbuf_release(&head);
5a7d5b68
NTND
507
508 if (ref)
509 return ref;
510
511 strbuf_addstr(&head, "refs/tags/");
512 strbuf_addstr(&head, branch);
513 ref = find_ref_by_name(refs, head.buf);
514 strbuf_release(&head);
515
9e585046
NTND
516 return ref;
517}
518
5bdc32d3
NP
519static struct ref *wanted_peer_refs(const struct ref *refs,
520 struct refspec *refspec)
8434c2f1 521{
c1921c18
JK
522 struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
523 struct ref *local_refs = head;
524 struct ref **tail = head ? &head->next : &local_refs;
8434c2f1 525
3e6e0edd
NTND
526 if (option_single_branch) {
527 struct ref *remote_head = NULL;
528
529 if (!option_branch)
530 remote_head = guess_remote_head(head, refs, 0);
0ec4b165
NTND
531 else {
532 local_refs = NULL;
533 tail = &local_refs;
534 remote_head = copy_ref(find_remote_branch(refs, option_branch));
535 }
3e6e0edd
NTND
536
537 if (!remote_head && option_branch)
538 warning(_("Could not find remote branch %s to clone."),
539 option_branch);
5a7d5b68 540 else {
3e6e0edd 541 get_fetch_map(remote_head, refspec, &tail, 0);
5a7d5b68
NTND
542
543 /* if --branch=tag, pull the requested tag explicitly */
544 get_fetch_map(remote_head, tag_refspec, &tail, 0);
545 }
3e6e0edd
NTND
546 } else
547 get_fetch_map(refs, refspec, &tail, 0);
548
549 if (!option_mirror && !option_single_branch)
468386a9 550 get_fetch_map(refs, tag_refspec, &tail, 0);
8434c2f1 551
5bdc32d3
NP
552 return local_refs;
553}
554
555static void write_remote_refs(const struct ref *local_refs)
556{
557 const struct ref *r;
558
58f233ce
MH
559 struct ref_transaction *t;
560 struct strbuf err = STRBUF_INIT;
561
562 t = ref_transaction_begin(&err);
563 if (!t)
564 die("%s", err.buf);
9f69d297 565
c1921c18
JK
566 for (r = local_refs; r; r = r->next) {
567 if (!r->peer_ref)
568 continue;
f4e54d02 569 if (ref_transaction_create(t, r->peer_ref->name, r->old_oid.hash,
58f233ce
MH
570 0, NULL, &err))
571 die("%s", err.buf);
c1921c18 572 }
3e8aded2 573
58f233ce
MH
574 if (initial_ref_transaction_commit(t, &err))
575 die("%s", err.buf);
576
577 strbuf_release(&err);
578 ref_transaction_free(t);
8434c2f1
DB
579}
580
3e6e0edd
NTND
581static void write_followtags(const struct ref *refs, const char *msg)
582{
583 const struct ref *ref;
584 for (ref = refs; ref; ref = ref->next) {
59556548 585 if (!starts_with(ref->name, "refs/tags/"))
3e6e0edd 586 continue;
59556548 587 if (ends_with(ref->name, "^{}"))
3e6e0edd 588 continue;
f4e54d02 589 if (!has_object_file(&ref->old_oid))
3e6e0edd 590 continue;
f4e54d02 591 update_ref(msg, ref->name, ref->old_oid.hash,
f4124112 592 NULL, 0, UPDATE_REFS_DIE_ON_ERR);
3e6e0edd
NTND
593 }
594}
595
0433ad12
JK
596static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
597{
598 struct ref **rm = cb_data;
599 struct ref *ref = *rm;
600
601 /*
602 * Skip anything missing a peer_ref, which we are not
603 * actually going to write a ref for.
604 */
605 while (ref && !ref->peer_ref)
606 ref = ref->next;
607 /* Returning -1 notes "end of list" to the caller. */
608 if (!ref)
609 return -1;
610
f4e54d02 611 hashcpy(sha1, ref->old_oid.hash);
0433ad12
JK
612 *rm = ref->next;
613 return 0;
614}
615
960b7d1c
NTND
616static void update_remote_refs(const struct ref *refs,
617 const struct ref *mapped_refs,
618 const struct ref *remote_head_points_at,
619 const char *branch_top,
c6807a40 620 const char *msg,
45ed4afa 621 struct transport *transport,
125a05fd 622 int check_connectivity)
960b7d1c 623{
0433ad12
JK
624 const struct ref *rm = mapped_refs;
625
125a05fd 626 if (check_connectivity) {
2856cbf0 627 if (transport->progress)
68b939b2 628 fprintf(stderr, _("Checking connectivity... "));
45ed4afa
JH
629 if (check_everything_connected_with_transport(iterate_ref_map,
630 0, &rm, transport))
125a05fd 631 die(_("remote did not send all necessary objects"));
2856cbf0 632 if (transport->progress)
f94a84c4 633 fprintf(stderr, _("done.\n"));
125a05fd 634 }
0433ad12 635
960b7d1c 636 if (refs) {
960b7d1c
NTND
637 write_remote_refs(mapped_refs);
638 if (option_single_branch)
639 write_followtags(refs, msg);
640 }
641
642 if (remote_head_points_at && !option_bare) {
643 struct strbuf head_ref = STRBUF_INIT;
644 strbuf_addstr(&head_ref, branch_top);
645 strbuf_addstr(&head_ref, "HEAD");
4be49d75
JK
646 if (create_symref(head_ref.buf,
647 remote_head_points_at->peer_ref->name,
648 msg) < 0)
39ad4f39 649 die(_("unable to update %s"), head_ref.buf);
4be49d75 650 strbuf_release(&head_ref);
960b7d1c
NTND
651 }
652}
653
f034d354
NTND
654static void update_head(const struct ref *our, const struct ref *remote,
655 const char *msg)
656{
cf4fff57
JK
657 const char *head;
658 if (our && skip_prefix(our->name, "refs/heads/", &head)) {
f034d354 659 /* Local default branch link */
4be49d75 660 if (create_symref("HEAD", our->name, NULL) < 0)
39ad4f39 661 die(_("unable to update HEAD"));
f034d354 662 if (!option_bare) {
f4e54d02 663 update_ref(msg, "HEAD", our->old_oid.hash, NULL, 0,
f4124112 664 UPDATE_REFS_DIE_ON_ERR);
f034d354
NTND
665 install_branch_config(0, head, option_origin, our->name);
666 }
5a7d5b68 667 } else if (our) {
f4e54d02 668 struct commit *c = lookup_commit_reference(our->old_oid.hash);
5a7d5b68 669 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
ed1c9977 670 update_ref(msg, "HEAD", c->object.oid.hash,
f4124112 671 NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
f034d354
NTND
672 } else if (remote) {
673 /*
674 * We know remote HEAD points to a non-branch, or
920b691f 675 * HEAD points to a branch but we don't know which one.
f034d354
NTND
676 * Detach HEAD in all these cases.
677 */
f4e54d02 678 update_ref(msg, "HEAD", remote->old_oid.hash,
f4124112 679 NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
f034d354
NTND
680 }
681}
682
c39852c1
NTND
683static int checkout(void)
684{
685 unsigned char sha1[20];
686 char *head;
687 struct lock_file *lock_file;
688 struct unpack_trees_options opts;
689 struct tree *tree;
690 struct tree_desc t;
03b86647 691 int err = 0;
c39852c1
NTND
692
693 if (option_no_checkout)
694 return 0;
695
7695d118 696 head = resolve_refdup("HEAD", RESOLVE_REF_READING, sha1, NULL);
c39852c1
NTND
697 if (!head) {
698 warning(_("remote HEAD refers to nonexistent ref, "
699 "unable to checkout.\n"));
700 return 0;
701 }
2857093b
NTND
702 if (!strcmp(head, "HEAD")) {
703 if (advice_detached_head)
704 detach_advice(sha1_to_hex(sha1));
705 } else {
59556548 706 if (!starts_with(head, "refs/heads/"))
c39852c1
NTND
707 die(_("HEAD not found below refs/heads!"));
708 }
709 free(head);
710
711 /* We need to be in the new work tree for the checkout */
712 setup_work_tree();
713
714 lock_file = xcalloc(1, sizeof(struct lock_file));
03b86647 715 hold_locked_index(lock_file, 1);
c39852c1
NTND
716
717 memset(&opts, 0, sizeof opts);
718 opts.update = 1;
719 opts.merge = 1;
720 opts.fn = oneway_merge;
8f63da13 721 opts.verbose_update = (option_verbosity >= 0);
c39852c1
NTND
722 opts.src_index = &the_index;
723 opts.dst_index = &the_index;
724
725 tree = parse_tree_indirect(sha1);
726 parse_tree(tree);
727 init_tree_desc(&t, tree->buffer, tree->size);
0aac7bb2
JK
728 if (unpack_trees(1, &t, &opts) < 0)
729 die(_("unable to checkout working tree"));
c39852c1 730
03b86647 731 if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
c39852c1
NTND
732 die(_("unable to write new index file"));
733
15048f8a
BP
734 err |= run_hook_le(NULL, "post-checkout", sha1_to_hex(null_sha1),
735 sha1_to_hex(sha1), "1", NULL);
c39852c1 736
72290d6a
SB
737 if (!err && option_recursive) {
738 struct argv_array args = ARGV_ARRAY_INIT;
739 argv_array_pushl(&args, "submodule", "update", "--init", "--recursive", NULL);
740
d22eb044
SB
741 if (option_shallow_submodules == 1
742 || (option_shallow_submodules == -1 && option_depth))
743 argv_array_push(&args, "--depth=1");
744
72290d6a
SB
745 if (max_jobs != -1)
746 argv_array_pushf(&args, "--jobs=%d", max_jobs);
747
748 err = run_command_v_opt(args.argv, RUN_GIT_CMD);
749 argv_array_clear(&args);
750 }
c39852c1
NTND
751
752 return err;
753}
754
84054f79
JK
755static int write_one_config(const char *key, const char *value, void *data)
756{
30598ad0 757 return git_config_set_multivar_gently(key, value ? value : "true", "^$", 0);
84054f79
JK
758}
759
760static void write_config(struct string_list *config)
761{
762 int i;
763
764 for (i = 0; i < config->nr; i++) {
765 if (git_config_parse_parameter(config->items[i].string,
766 write_one_config, NULL) < 0)
39ad4f39 767 die(_("unable to write parameters to config file"));
84054f79
JK
768 }
769}
770
24d36f14
DA
771static void write_refspec_config(const char *src_ref_prefix,
772 const struct ref *our_head_points_at,
773 const struct ref *remote_head_points_at,
774 struct strbuf *branch_top)
31b808a0
RT
775{
776 struct strbuf key = STRBUF_INIT;
777 struct strbuf value = STRBUF_INIT;
778
779 if (option_mirror || !option_bare) {
780 if (option_single_branch && !option_mirror) {
781 if (option_branch) {
60a5f5fc 782 if (starts_with(our_head_points_at->name, "refs/tags/"))
31b808a0
RT
783 strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
784 our_head_points_at->name);
785 else
786 strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
787 branch_top->buf, option_branch);
788 } else if (remote_head_points_at) {
cf4fff57
JK
789 const char *head = remote_head_points_at->name;
790 if (!skip_prefix(head, "refs/heads/", &head))
791 die("BUG: remote HEAD points at non-head?");
792
31b808a0 793 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
cf4fff57 794 branch_top->buf, head);
31b808a0
RT
795 }
796 /*
797 * otherwise, the next "git fetch" will
798 * simply fetch from HEAD without updating
d6ac1d21 799 * any remote-tracking branch, which is what
31b808a0
RT
800 * we want.
801 */
802 } else {
803 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
804 }
805 /* Configure the remote */
806 if (value.len) {
807 strbuf_addf(&key, "remote.%s.fetch", option_origin);
808 git_config_set_multivar(key.buf, value.buf, "^$", 0);
809 strbuf_reset(&key);
810
811 if (option_mirror) {
812 strbuf_addf(&key, "remote.%s.mirror", option_origin);
813 git_config_set(key.buf, "true");
814 strbuf_reset(&key);
815 }
816 }
817 }
818
819 strbuf_release(&key);
820 strbuf_release(&value);
821}
822
fb1d6dab
JH
823static void dissociate_from_references(void)
824{
825 static const char* argv[] = { "repack", "-a", "-d", NULL };
0181681e 826 char *alternates = git_pathdup("objects/info/alternates");
fb1d6dab 827
0181681e
AR
828 if (!access(alternates, F_OK)) {
829 if (run_command_v_opt(argv, RUN_GIT_CMD|RUN_COMMAND_NO_STDIN))
830 die(_("cannot repack to clean up"));
831 if (unlink(alternates) && errno != ENOENT)
832 die_errno(_("cannot unlink temporary alternates file"));
833 }
834 free(alternates);
fb1d6dab
JH
835}
836
8434c2f1
DB
837int cmd_clone(int argc, const char **argv, const char *prefix)
838{
24c61c44 839 int is_bundle = 0, is_local;
8434c2f1
DB
840 struct stat buf;
841 const char *repo_name, *repo, *work_tree, *git_dir;
842 char *path, *dir;
55892d23 843 int dest_exists;
37148311 844 const struct ref *refs, *remote_head;
7a4ee28f
JK
845 const struct ref *remote_head_points_at;
846 const struct ref *our_head_points_at;
37148311 847 struct ref *mapped_refs;
90498161 848 const struct ref *ref;
b5ff37ac
MV
849 struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
850 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
1db4a75c 851 struct transport *transport = NULL;
9e585046 852 const char *src_ref_prefix = "refs/heads/";
6f48d39f 853 struct remote *remote;
90498161 854 int err = 0, complete_refs_before_fetch = 1;
8434c2f1 855
689f0396
DB
856 struct refspec *refspec;
857 const char *fetch_pattern;
8434c2f1 858
bbc30f99 859 packet_trace_identity("clone");
37782920 860 argc = parse_options(argc, argv, prefix, builtin_clone_options,
8434c2f1
DB
861 builtin_clone_usage, 0);
862
d52dc4b1 863 if (argc > 2)
e84d7b74 864 usage_msg_opt(_("Too many arguments."),
d52dc4b1
JN
865 builtin_clone_usage, builtin_clone_options);
866
8434c2f1 867 if (argc == 0)
e84d7b74 868 usage_msg_opt(_("You must specify a repository to clone."),
d52dc4b1 869 builtin_clone_usage, builtin_clone_options);
8434c2f1 870
3e6e0edd
NTND
871 if (option_single_branch == -1)
872 option_single_branch = option_depth ? 1 : 0;
873
bc699afc
JS
874 if (option_mirror)
875 option_bare = 1;
876
8434c2f1
DB
877 if (option_bare) {
878 if (option_origin)
e84d7b74 879 die(_("--bare and --origin %s options are incompatible."),
8434c2f1 880 option_origin);
95b63f1e
NTND
881 if (real_git_dir)
882 die(_("--bare and --separate-git-dir are incompatible."));
8434c2f1 883 option_no_checkout = 1;
8434c2f1
DB
884 }
885
886 if (!option_origin)
887 option_origin = "origin";
888
889 repo_name = argv[0];
890
891 path = get_repo_path(repo_name, &is_bundle);
892 if (path)
e2a57aac 893 repo = xstrdup(absolute_path(repo_name));
8434c2f1 894 else if (!strchr(repo_name, ':'))
d3e1ddfd 895 die(_("repository '%s' does not exist"), repo_name);
8434c2f1
DB
896 else
897 repo = repo_name;
898
5594bcad
NTND
899 /* no need to be strict, transport_set_option() will validate it again */
900 if (option_depth && atoi(option_depth) < 1)
901 die(_("depth %s is not a positive number"), option_depth);
902
8434c2f1
DB
903 if (argc == 2)
904 dir = xstrdup(argv[1]);
905 else
6612f877 906 dir = guess_dir_name(repo_name, is_bundle, option_bare);
44a68fd5 907 strip_trailing_slashes(dir);
8434c2f1 908
55892d23
AP
909 dest_exists = !stat(dir, &buf);
910 if (dest_exists && !is_empty_dir(dir))
e84d7b74
ÆAB
911 die(_("destination path '%s' already exists and is not "
912 "an empty directory."), dir);
8434c2f1 913
8434c2f1
DB
914 strbuf_addf(&reflog_msg, "clone: from %s", repo);
915
916 if (option_bare)
917 work_tree = NULL;
918 else {
919 work_tree = getenv("GIT_WORK_TREE");
920 if (work_tree && !stat(work_tree, &buf))
e84d7b74 921 die(_("working tree '%s' already exists."), work_tree);
8434c2f1
DB
922 }
923
924 if (option_bare || work_tree)
925 git_dir = xstrdup(dir);
926 else {
927 work_tree = dir;
4e2d094d 928 git_dir = mkpathdup("%s/.git", dir);
8434c2f1
DB
929 }
930
ee0e3872
JK
931 atexit(remove_junk);
932 sigchain_push_common(remove_junk_on_signal);
933
8434c2f1 934 if (!option_bare) {
8e21d63b 935 if (safe_create_leading_directories_const(work_tree) < 0)
e84d7b74 936 die_errno(_("could not create leading directories of '%s'"),
d824cbba 937 work_tree);
45d4fdc2 938 if (!dest_exists && mkdir(work_tree, 0777))
16eff6c0 939 die_errno(_("could not create work tree dir '%s'"),
d824cbba 940 work_tree);
ee0e3872 941 junk_work_tree = work_tree;
8434c2f1
DB
942 set_git_work_tree(work_tree);
943 }
8434c2f1 944
ee0e3872 945 junk_git_dir = git_dir;
8e21d63b 946 if (safe_create_leading_directories_const(git_dir) < 0)
e84d7b74 947 die(_("could not create leading directories of '%s'"), git_dir);
b57fb80a
NTND
948
949 set_git_dir_init(git_dir, real_git_dir, 0);
9be1980b 950 if (real_git_dir) {
b57fb80a 951 git_dir = real_git_dir;
9be1980b
JL
952 junk_git_dir = real_git_dir;
953 }
8434c2f1 954
3781fcce
ÆAB
955 if (0 <= option_verbosity) {
956 if (option_bare)
68b939b2 957 fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
3781fcce 958 else
68b939b2 959 fprintf(stderr, _("Cloning into '%s'...\n"), dir);
3781fcce 960 }
28ba96ab 961 init_db(option_template, INIT_DB_QUIET);
84054f79 962 write_config(&option_config);
8434c2f1 963
9bd81e42 964 git_config(git_default_config, NULL);
8434c2f1
DB
965
966 if (option_bare) {
bc699afc
JS
967 if (option_mirror)
968 src_ref_prefix = "refs/";
b5ff37ac 969 strbuf_addstr(&branch_top, src_ref_prefix);
8434c2f1
DB
970
971 git_config_set("core.bare", "true");
972 } else {
b5ff37ac 973 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
bc699afc 974 }
8434c2f1 975
689f0396 976 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
df61c889
SR
977 strbuf_addf(&key, "remote.%s.url", option_origin);
978 git_config_set(key.buf, repo);
979 strbuf_reset(&key);
980
dbc92b07
JH
981 if (option_reference.nr)
982 setup_reference();
766ac6a6 983
689f0396
DB
984 fetch_pattern = value.buf;
985 refspec = parse_fetch_refspec(1, &fetch_pattern);
986
987 strbuf_reset(&value);
8434c2f1 988
6f48d39f
NTND
989 remote = remote_get(option_origin);
990 transport = transport_get(remote, remote->url[0]);
822f0c4f 991 transport_set_verbosity(transport, option_verbosity, option_progress);
c915f11e 992 transport->family = family;
822f0c4f 993
f38aa83f
MB
994 path = get_repo_path(remote->url[0], &is_bundle);
995 is_local = option_local != 0 && path && !is_bundle;
996 if (is_local) {
997 if (option_depth)
998 warning(_("--depth is ignored in local clones; use file:// instead."));
999 if (!access(mkpath("%s/shallow", path), F_OK)) {
1000 if (option_local > 0)
1001 warning(_("source repository is shallow, ignoring --local"));
1002 is_local = 0;
1003 }
1004 }
1005 if (option_local > 0 && !is_local)
1006 warning(_("--local is ignored"));
beea4152 1007 transport->cloning = 1;
8434c2f1 1008
643f918d
JK
1009 if (!transport->get_refs_list || (!is_local && !transport->fetch))
1010 die(_("Don't know how to clone %s"), transport->url);
37b78c25 1011
643f918d 1012 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
8434c2f1 1013
643f918d
JK
1014 if (option_depth)
1015 transport_set_option(transport, TRANS_OPT_DEPTH,
1016 option_depth);
1017 if (option_single_branch)
1018 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
8434c2f1 1019
643f918d
JK
1020 if (option_upload_pack)
1021 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
1022 option_upload_pack);
c6807a40 1023
643f918d
JK
1024 if (transport->smart_options && !option_depth)
1025 transport->smart_options->check_self_contained_and_connected = 1;
8434c2f1 1026
6f48d39f 1027 refs = transport_get_remote_refs(transport);
8434c2f1 1028
5b05795c
MH
1029 if (refs) {
1030 mapped_refs = wanted_peer_refs(refs, refspec);
1031 /*
1032 * transport_get_remote_refs() may return refs with null sha-1
1033 * in mapped_refs (see struct transport->get_refs_list
1034 * comment). In that case we need fetch it early because
1035 * remote_head code below relies on it.
1036 *
1037 * for normal clones, transport_get_remote_refs() should
1038 * return reliable ref set, we can delay cloning until after
1039 * remote HEAD check.
1040 */
1041 for (ref = refs; ref; ref = ref->next)
f4e54d02 1042 if (is_null_oid(&ref->old_oid)) {
5b05795c
MH
1043 complete_refs_before_fetch = 0;
1044 break;
1045 }
90498161 1046
5b05795c
MH
1047 if (!is_local && !complete_refs_before_fetch)
1048 transport_fetch_refs(transport, mapped_refs);
8434c2f1 1049
6cb4e6cc 1050 remote_head = find_ref_by_name(refs, "HEAD");
7a4ee28f
JK
1051 remote_head_points_at =
1052 guess_remote_head(remote_head, mapped_refs, 0);
1053
1054 if (option_branch) {
7a4ee28f 1055 our_head_points_at =
9e585046 1056 find_remote_branch(mapped_refs, option_branch);
7a4ee28f 1057
920b691f
NTND
1058 if (!our_head_points_at)
1059 die(_("Remote branch %s not found in upstream %s"),
1060 option_branch, option_origin);
7a4ee28f
JK
1061 }
1062 else
1063 our_head_points_at = remote_head_points_at;
86ac7518
SR
1064 }
1065 else {
a3552aba
RT
1066 if (option_branch)
1067 die(_("Remote branch %s not found in upstream %s"),
1068 option_branch, option_origin);
1069
e84d7b74 1070 warning(_("You appear to have cloned an empty repository."));
5b05795c 1071 mapped_refs = NULL;
7a4ee28f
JK
1072 our_head_points_at = NULL;
1073 remote_head_points_at = NULL;
86ac7518
SR
1074 remote_head = NULL;
1075 option_no_checkout = 1;
5cd12b85 1076 if (!option_bare)
a9f2c136 1077 install_branch_config(0, "master", option_origin,
5cd12b85 1078 "refs/heads/master");
86ac7518 1079 }
8434c2f1 1080
31b808a0
RT
1081 write_refspec_config(src_ref_prefix, our_head_points_at,
1082 remote_head_points_at, &branch_top);
1083
6f48d39f
NTND
1084 if (is_local)
1085 clone_local(path, git_dir);
90498161 1086 else if (refs && complete_refs_before_fetch)
6f48d39f 1087 transport_fetch_refs(transport, mapped_refs);
8434c2f1 1088
960b7d1c 1089 update_remote_refs(refs, mapped_refs, remote_head_points_at,
45ed4afa 1090 branch_top.buf, reflog_msg.buf, transport, !is_local);
8434c2f1 1091
f034d354 1092 update_head(our_head_points_at, remote_head, reflog_msg.buf);
1db4a75c 1093
6f48d39f
NTND
1094 transport_unlock_pack(transport);
1095 transport_disconnect(transport);
1db4a75c 1096
786b150c
JS
1097 if (option_dissociate) {
1098 close_all_packs();
fb1d6dab 1099 dissociate_from_references();
786b150c 1100 }
fb1d6dab 1101
d3b34622 1102 junk_mode = JUNK_LEAVE_REPO;
c39852c1 1103 err = checkout();
8434c2f1
DB
1104
1105 strbuf_release(&reflog_msg);
b5ff37ac
MV
1106 strbuf_release(&branch_top);
1107 strbuf_release(&key);
1108 strbuf_release(&value);
d3b34622 1109 junk_mode = JUNK_LEAVE_ALL;
50b67732
SB
1110
1111 free(refspec);
dfa7a6c5 1112 return err;
8434c2f1 1113}