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