Merge branch 'sb/submodule-clone-retry'
[git/git.git] / builtin / submodule--helper.c
CommitLineData
74703a1e
SB
1#include "builtin.h"
2#include "cache.h"
3#include "parse-options.h"
4#include "quote.h"
5#include "pathspec.h"
6#include "dir.h"
7#include "utf8.h"
0ea306ef
SB
8#include "submodule.h"
9#include "submodule-config.h"
10#include "string-list.h"
ee8838d1 11#include "run-command.h"
63e95beb
SB
12#include "remote.h"
13#include "refs.h"
14#include "connect.h"
15
16static char *get_default_remote(void)
17{
18 char *dest = NULL, *ret;
19 unsigned char sha1[20];
20 struct strbuf sb = STRBUF_INIT;
21 const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
22
23 if (!refname)
24 die(_("No such ref: %s"), "HEAD");
25
26 /* detached HEAD */
27 if (!strcmp(refname, "HEAD"))
28 return xstrdup("origin");
29
30 if (!skip_prefix(refname, "refs/heads/", &refname))
31 die(_("Expecting a full ref name, got %s"), refname);
32
33 strbuf_addf(&sb, "branch.%s.remote", refname);
34 if (git_config_get_string(sb.buf, &dest))
35 ret = xstrdup("origin");
36 else
37 ret = dest;
38
39 strbuf_release(&sb);
40 return ret;
41}
42
43static int starts_with_dot_slash(const char *str)
44{
45 return str[0] == '.' && is_dir_sep(str[1]);
46}
47
48static int starts_with_dot_dot_slash(const char *str)
49{
50 return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
51}
52
53/*
54 * Returns 1 if it was the last chop before ':'.
55 */
56static int chop_last_dir(char **remoteurl, int is_relative)
57{
58 char *rfind = find_last_dir_sep(*remoteurl);
59 if (rfind) {
60 *rfind = '\0';
61 return 0;
62 }
63
64 rfind = strrchr(*remoteurl, ':');
65 if (rfind) {
66 *rfind = '\0';
67 return 1;
68 }
69
70 if (is_relative || !strcmp(".", *remoteurl))
71 die(_("cannot strip one component off url '%s'"),
72 *remoteurl);
73
74 free(*remoteurl);
75 *remoteurl = xstrdup(".");
76 return 0;
77}
78
79/*
80 * The `url` argument is the URL that navigates to the submodule origin
81 * repo. When relative, this URL is relative to the superproject origin
82 * URL repo. The `up_path` argument, if specified, is the relative
83 * path that navigates from the submodule working tree to the superproject
84 * working tree. Returns the origin URL of the submodule.
85 *
86 * Return either an absolute URL or filesystem path (if the superproject
87 * origin URL is an absolute URL or filesystem path, respectively) or a
88 * relative file system path (if the superproject origin URL is a relative
89 * file system path).
90 *
91 * When the output is a relative file system path, the path is either
92 * relative to the submodule working tree, if up_path is specified, or to
93 * the superproject working tree otherwise.
94 *
95 * NEEDSWORK: This works incorrectly on the domain and protocol part.
96 * remote_url url outcome expectation
97 * http://a.com/b ../c http://a.com/c as is
98 * http://a.com/b ../../c http://c error out
99 * http://a.com/b ../../../c http:/c error out
100 * http://a.com/b ../../../../c http:c error out
101 * http://a.com/b ../../../../../c .:c error out
102 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
103 * when a local part has a colon in its path component, too.
104 */
105static char *relative_url(const char *remote_url,
106 const char *url,
107 const char *up_path)
108{
109 int is_relative = 0;
110 int colonsep = 0;
111 char *out;
112 char *remoteurl = xstrdup(remote_url);
113 struct strbuf sb = STRBUF_INIT;
114 size_t len = strlen(remoteurl);
115
116 if (is_dir_sep(remoteurl[len]))
117 remoteurl[len] = '\0';
118
119 if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
120 is_relative = 0;
121 else {
122 is_relative = 1;
123 /*
124 * Prepend a './' to ensure all relative
125 * remoteurls start with './' or '../'
126 */
127 if (!starts_with_dot_slash(remoteurl) &&
128 !starts_with_dot_dot_slash(remoteurl)) {
129 strbuf_reset(&sb);
130 strbuf_addf(&sb, "./%s", remoteurl);
131 free(remoteurl);
132 remoteurl = strbuf_detach(&sb, NULL);
133 }
134 }
135 /*
136 * When the url starts with '../', remove that and the
137 * last directory in remoteurl.
138 */
139 while (url) {
140 if (starts_with_dot_dot_slash(url)) {
141 url += 3;
142 colonsep |= chop_last_dir(&remoteurl, is_relative);
143 } else if (starts_with_dot_slash(url))
144 url += 2;
145 else
146 break;
147 }
148 strbuf_reset(&sb);
149 strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
150 free(remoteurl);
151
152 if (starts_with_dot_slash(sb.buf))
153 out = xstrdup(sb.buf + 2);
154 else
155 out = xstrdup(sb.buf);
156 strbuf_reset(&sb);
157
158 if (!up_path || !is_relative)
159 return out;
160
161 strbuf_addf(&sb, "%s%s", up_path, out);
162 free(out);
163 return strbuf_detach(&sb, NULL);
164}
165
166static int resolve_relative_url(int argc, const char **argv, const char *prefix)
167{
168 char *remoteurl = NULL;
169 char *remote = get_default_remote();
170 const char *up_path = NULL;
171 char *res;
172 const char *url;
173 struct strbuf sb = STRBUF_INIT;
174
175 if (argc != 2 && argc != 3)
176 die("resolve-relative-url only accepts one or two arguments");
177
178 url = argv[1];
179 strbuf_addf(&sb, "remote.%s.url", remote);
180 free(remote);
181
182 if (git_config_get_string(sb.buf, &remoteurl))
183 /* the repository is its own authoritative upstream */
184 remoteurl = xgetcwd();
185
186 if (argc == 3)
187 up_path = argv[2];
188
189 res = relative_url(remoteurl, url, up_path);
190 puts(res);
191 free(res);
192 free(remoteurl);
193 return 0;
194}
195
196static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
197{
198 char *remoteurl, *res;
199 const char *up_path, *url;
200
201 if (argc != 4)
202 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
203
204 up_path = argv[1];
205 remoteurl = xstrdup(argv[2]);
206 url = argv[3];
207
208 if (!strcmp(up_path, "(null)"))
209 up_path = NULL;
210
211 res = relative_url(remoteurl, url, up_path);
212 puts(res);
213 free(res);
214 free(remoteurl);
215 return 0;
216}
74703a1e
SB
217
218struct module_list {
219 const struct cache_entry **entries;
220 int alloc, nr;
221};
222#define MODULE_LIST_INIT { NULL, 0, 0 }
223
224static int module_list_compute(int argc, const char **argv,
225 const char *prefix,
226 struct pathspec *pathspec,
227 struct module_list *list)
228{
229 int i, result = 0;
2b56bb7a 230 char *ps_matched = NULL;
74703a1e
SB
231 parse_pathspec(pathspec, 0,
232 PATHSPEC_PREFER_FULL |
233 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
234 prefix, argv);
235
74703a1e
SB
236 if (pathspec->nr)
237 ps_matched = xcalloc(pathspec->nr, 1);
238
239 if (read_cache() < 0)
240 die(_("index file corrupt"));
241
242 for (i = 0; i < active_nr; i++) {
243 const struct cache_entry *ce = active_cache[i];
244
84ba959b
SB
245 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
246 0, ps_matched, 1) ||
247 !S_ISGITLINK(ce->ce_mode))
74703a1e
SB
248 continue;
249
250 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
251 list->entries[list->nr++] = ce;
252 while (i + 1 < active_nr &&
253 !strcmp(ce->name, active_cache[i + 1]->name))
254 /*
255 * Skip entries with the same name in different stages
256 * to make sure an entry is returned only once.
257 */
258 i++;
259 }
74703a1e
SB
260
261 if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
262 result = -1;
263
264 free(ps_matched);
265
266 return result;
267}
268
269static int module_list(int argc, const char **argv, const char *prefix)
270{
271 int i;
272 struct pathspec pathspec;
273 struct module_list list = MODULE_LIST_INIT;
274
275 struct option module_list_options[] = {
276 OPT_STRING(0, "prefix", &prefix,
277 N_("path"),
278 N_("alternative anchor for relative paths")),
279 OPT_END()
280 };
281
282 const char *const git_submodule_helper_usage[] = {
283 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
284 NULL
285 };
286
287 argc = parse_options(argc, argv, prefix, module_list_options,
288 git_submodule_helper_usage, 0);
289
b0f4b408 290 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
74703a1e 291 return 1;
74703a1e
SB
292
293 for (i = 0; i < list.nr; i++) {
294 const struct cache_entry *ce = list.entries[i];
295
296 if (ce_stage(ce))
297 printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
298 else
299 printf("%06o %s %d\t", ce->ce_mode, sha1_to_hex(ce->sha1), ce_stage(ce));
300
301 utf8_fprintf(stdout, "%s\n", ce->name);
302 }
303 return 0;
304}
305
3604242f
SB
306static void init_submodule(const char *path, const char *prefix, int quiet)
307{
308 const struct submodule *sub;
309 struct strbuf sb = STRBUF_INIT;
310 char *upd = NULL, *url = NULL, *displaypath;
311
312 /* Only loads from .gitmodules, no overlay with .git/config */
313 gitmodules_config();
314
3604242f
SB
315 if (prefix) {
316 strbuf_addf(&sb, "%s%s", prefix, path);
317 displaypath = strbuf_detach(&sb, NULL);
318 } else
d92028a5
SB
319 displaypath = xstrdup(path);
320
321 sub = submodule_from_path(null_sha1, path);
322
323 if (!sub)
324 die(_("No url found for submodule path '%s' in .gitmodules"),
325 displaypath);
3604242f
SB
326
327 /*
328 * Copy url setting when it is not set yet.
329 * To look up the url in .git/config, we must not fall back to
330 * .gitmodules, so look it up directly.
331 */
332 strbuf_reset(&sb);
333 strbuf_addf(&sb, "submodule.%s.url", sub->name);
334 if (git_config_get_string(sb.buf, &url)) {
335 url = xstrdup(sub->url);
336
337 if (!url)
338 die(_("No url found for submodule path '%s' in .gitmodules"),
339 displaypath);
340
341 /* Possibly a url relative to parent */
342 if (starts_with_dot_dot_slash(url) ||
343 starts_with_dot_slash(url)) {
344 char *remoteurl, *relurl;
345 char *remote = get_default_remote();
346 struct strbuf remotesb = STRBUF_INIT;
347 strbuf_addf(&remotesb, "remote.%s.url", remote);
348 free(remote);
349
350 if (git_config_get_string(remotesb.buf, &remoteurl))
351 /*
352 * The repository is its own
353 * authoritative upstream
354 */
355 remoteurl = xgetcwd();
356 relurl = relative_url(remoteurl, url, NULL);
357 strbuf_release(&remotesb);
358 free(remoteurl);
359 free(url);
360 url = relurl;
361 }
362
363 if (git_config_set_gently(sb.buf, url))
364 die(_("Failed to register url for submodule path '%s'"),
365 displaypath);
366 if (!quiet)
c66410ed
SB
367 fprintf(stderr,
368 _("Submodule '%s' (%s) registered for path '%s'\n"),
3604242f
SB
369 sub->name, url, displaypath);
370 }
371
372 /* Copy "update" setting when it is not set yet */
373 strbuf_reset(&sb);
374 strbuf_addf(&sb, "submodule.%s.update", sub->name);
375 if (git_config_get_string(sb.buf, &upd) &&
376 sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
377 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
378 fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
379 sub->name);
380 upd = xstrdup("none");
381 } else
382 upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
383
384 if (git_config_set_gently(sb.buf, upd))
385 die(_("Failed to register update mode for submodule path '%s'"), displaypath);
386 }
387 strbuf_release(&sb);
388 free(displaypath);
389 free(url);
390 free(upd);
391}
392
393static int module_init(int argc, const char **argv, const char *prefix)
394{
395 struct pathspec pathspec;
396 struct module_list list = MODULE_LIST_INIT;
397 int quiet = 0;
398 int i;
399
400 struct option module_init_options[] = {
401 OPT_STRING(0, "prefix", &prefix,
402 N_("path"),
403 N_("alternative anchor for relative paths")),
404 OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
405 OPT_END()
406 };
407
408 const char *const git_submodule_helper_usage[] = {
409 N_("git submodule--helper init [<path>]"),
410 NULL
411 };
412
413 argc = parse_options(argc, argv, prefix, module_init_options,
414 git_submodule_helper_usage, 0);
415
416 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
417 return 1;
418
419 for (i = 0; i < list.nr; i++)
420 init_submodule(list.entries[i]->name, prefix, quiet);
421
422 return 0;
423}
424
0ea306ef
SB
425static int module_name(int argc, const char **argv, const char *prefix)
426{
427 const struct submodule *sub;
428
429 if (argc != 2)
430 usage(_("git submodule--helper name <path>"));
431
432 gitmodules_config();
433 sub = submodule_from_path(null_sha1, argv[1]);
434
435 if (!sub)
436 die(_("no submodule mapping found in .gitmodules for path '%s'"),
437 argv[1]);
438
439 printf("%s\n", sub->name);
440
441 return 0;
442}
14111fc4 443
ee8838d1
SB
444static int clone_submodule(const char *path, const char *gitdir, const char *url,
445 const char *depth, const char *reference, int quiet)
446{
447 struct child_process cp;
448 child_process_init(&cp);
449
450 argv_array_push(&cp.args, "clone");
451 argv_array_push(&cp.args, "--no-checkout");
452 if (quiet)
453 argv_array_push(&cp.args, "--quiet");
454 if (depth && *depth)
455 argv_array_pushl(&cp.args, "--depth", depth, NULL);
456 if (reference && *reference)
457 argv_array_pushl(&cp.args, "--reference", reference, NULL);
458 if (gitdir && *gitdir)
459 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
460
461 argv_array_push(&cp.args, url);
462 argv_array_push(&cp.args, path);
463
464 cp.git_cmd = 1;
14111fc4 465 prepare_submodule_repo_env(&cp.env_array);
ee8838d1
SB
466 cp.no_stdin = 1;
467
468 return run_command(&cp);
469}
470
471static int module_clone(int argc, const char **argv, const char *prefix)
472{
f8eaa0ba 473 const char *name = NULL, *url = NULL;
ee8838d1
SB
474 const char *reference = NULL, *depth = NULL;
475 int quiet = 0;
476 FILE *submodule_dot_git;
1ea4d9b7 477 char *p, *path = NULL, *sm_gitdir;
ee8838d1
SB
478 struct strbuf rel_path = STRBUF_INIT;
479 struct strbuf sb = STRBUF_INIT;
480
481 struct option module_clone_options[] = {
482 OPT_STRING(0, "prefix", &prefix,
483 N_("path"),
484 N_("alternative anchor for relative paths")),
485 OPT_STRING(0, "path", &path,
486 N_("path"),
487 N_("where the new submodule will be cloned to")),
488 OPT_STRING(0, "name", &name,
489 N_("string"),
490 N_("name of the new submodule")),
491 OPT_STRING(0, "url", &url,
492 N_("string"),
493 N_("url where to clone the submodule from")),
494 OPT_STRING(0, "reference", &reference,
495 N_("string"),
496 N_("reference repository")),
497 OPT_STRING(0, "depth", &depth,
498 N_("string"),
499 N_("depth for shallow clones")),
500 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
501 OPT_END()
502 };
503
504 const char *const git_submodule_helper_usage[] = {
505 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
7dad2633
JK
506 "[--reference <repository>] [--name <name>] [--depth <depth>] "
507 "--url <url> --path <path>"),
ee8838d1
SB
508 NULL
509 };
510
511 argc = parse_options(argc, argv, prefix, module_clone_options,
512 git_submodule_helper_usage, 0);
513
deef3cdc 514 if (argc || !url || !path || !*path)
08e0970a
JK
515 usage_with_options(git_submodule_helper_usage,
516 module_clone_options);
517
ee8838d1 518 strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
1ea4d9b7
JH
519 sm_gitdir = xstrdup(absolute_path(sb.buf));
520 strbuf_reset(&sb);
f8eaa0ba
SB
521
522 if (!is_absolute_path(path)) {
523 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
524 path = strbuf_detach(&sb, NULL);
525 } else
526 path = xstrdup(path);
ee8838d1
SB
527
528 if (!file_exists(sm_gitdir)) {
529 if (safe_create_leading_directories_const(sm_gitdir) < 0)
530 die(_("could not create directory '%s'"), sm_gitdir);
531 if (clone_submodule(path, sm_gitdir, url, depth, reference, quiet))
532 die(_("clone of '%s' into submodule path '%s' failed"),
533 url, path);
534 } else {
535 if (safe_create_leading_directories_const(path) < 0)
536 die(_("could not create directory '%s'"), path);
537 strbuf_addf(&sb, "%s/index", sm_gitdir);
538 unlink_or_warn(sb.buf);
539 strbuf_reset(&sb);
540 }
541
542 /* Write a .git file in the submodule to redirect to the superproject. */
3c0663e1 543 strbuf_addf(&sb, "%s/.git", path);
ee8838d1
SB
544 if (safe_create_leading_directories_const(sb.buf) < 0)
545 die(_("could not create leading directories of '%s'"), sb.buf);
546 submodule_dot_git = fopen(sb.buf, "w");
547 if (!submodule_dot_git)
548 die_errno(_("cannot open file '%s'"), sb.buf);
549
1f15ba1f
SB
550 fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
551 relative_path(sm_gitdir, path, &rel_path));
ee8838d1
SB
552 if (fclose(submodule_dot_git))
553 die(_("could not close file %s"), sb.buf);
554 strbuf_reset(&sb);
555 strbuf_reset(&rel_path);
556
ee8838d1 557 /* Redirect the worktree of the submodule in the superproject's config */
ee8838d1
SB
558 p = git_pathdup_submodule(path, "config");
559 if (!p)
560 die(_("could not get submodule directory for '%s'"), path);
561 git_config_set_in_file(p, "core.worktree",
f8eaa0ba 562 relative_path(path, sm_gitdir, &rel_path));
ee8838d1
SB
563 strbuf_release(&sb);
564 strbuf_release(&rel_path);
565 free(sm_gitdir);
f8eaa0ba 566 free(path);
ee8838d1
SB
567 free(p);
568 return 0;
569}
74703a1e 570
48308681
SB
571struct submodule_update_clone {
572 /* index into 'list', the list of submodules to look into for cloning */
573 int current;
574 struct module_list list;
575 unsigned warn_if_uninitialized : 1;
576
577 /* update parameter passed via commandline */
578 struct submodule_update_strategy update;
579
580 /* configuration parameters which are passed on to the children */
581 int quiet;
abed000a 582 int recommend_shallow;
48308681
SB
583 const char *reference;
584 const char *depth;
585 const char *recursive_prefix;
586 const char *prefix;
587
588 /* Machine-readable status lines to be consumed by git-submodule.sh */
589 struct string_list projectlines;
590
591 /* If we want to stop as fast as possible and return an error */
592 unsigned quickstop : 1;
665b35ec
SB
593
594 /* failed clones to be retried again */
595 const struct cache_entry **failed_clones;
596 int failed_clones_nr, failed_clones_alloc;
48308681
SB
597};
598#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
abed000a 599 SUBMODULE_UPDATE_STRATEGY_INIT, 0, -1, NULL, NULL, NULL, NULL, \
665b35ec 600 STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
48308681 601
08fdbdb1
SB
602
603static void next_submodule_warn_missing(struct submodule_update_clone *suc,
604 struct strbuf *out, const char *displaypath)
605{
606 /*
607 * Only mention uninitialized submodules when their
608 * paths have been specified.
609 */
610 if (suc->warn_if_uninitialized) {
611 strbuf_addf(out,
612 _("Submodule path '%s' not initialized"),
613 displaypath);
614 strbuf_addch(out, '\n');
615 strbuf_addstr(out,
616 _("Maybe you want to use 'update --init'?"));
617 strbuf_addch(out, '\n');
618 }
619}
620
48308681
SB
621/**
622 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
623 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
624 */
625static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
626 struct child_process *child,
627 struct submodule_update_clone *suc,
628 struct strbuf *out)
629{
630 const struct submodule *sub = NULL;
631 struct strbuf displaypath_sb = STRBUF_INIT;
632 struct strbuf sb = STRBUF_INIT;
633 const char *displaypath = NULL;
634 char *url = NULL;
635 int needs_cloning = 0;
636
637 if (ce_stage(ce)) {
638 if (suc->recursive_prefix)
639 strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
640 else
641 strbuf_addf(&sb, "%s", ce->name);
642 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
643 strbuf_addch(out, '\n');
644 goto cleanup;
645 }
646
647 sub = submodule_from_path(null_sha1, ce->name);
648
649 if (suc->recursive_prefix)
650 displaypath = relative_path(suc->recursive_prefix,
651 ce->name, &displaypath_sb);
652 else
653 displaypath = ce->name;
654
08fdbdb1
SB
655 if (!sub) {
656 next_submodule_warn_missing(suc, out, displaypath);
657 goto cleanup;
658 }
659
48308681
SB
660 if (suc->update.type == SM_UPDATE_NONE
661 || (suc->update.type == SM_UPDATE_UNSPECIFIED
662 && sub->update_strategy.type == SM_UPDATE_NONE)) {
663 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
664 strbuf_addch(out, '\n');
665 goto cleanup;
666 }
667
668 /*
669 * Looking up the url in .git/config.
670 * We must not fall back to .gitmodules as we only want
671 * to process configured submodules.
672 */
673 strbuf_reset(&sb);
674 strbuf_addf(&sb, "submodule.%s.url", sub->name);
675 git_config_get_string(sb.buf, &url);
676 if (!url) {
08fdbdb1 677 next_submodule_warn_missing(suc, out, displaypath);
48308681
SB
678 goto cleanup;
679 }
680
681 strbuf_reset(&sb);
682 strbuf_addf(&sb, "%s/.git", ce->name);
683 needs_cloning = !file_exists(sb.buf);
684
685 strbuf_reset(&sb);
686 strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
687 sha1_to_hex(ce->sha1), ce_stage(ce),
688 needs_cloning, ce->name);
689 string_list_append(&suc->projectlines, sb.buf);
690
691 if (!needs_cloning)
692 goto cleanup;
693
694 child->git_cmd = 1;
695 child->no_stdin = 1;
696 child->stdout_to_stderr = 1;
697 child->err = -1;
698 argv_array_push(&child->args, "submodule--helper");
699 argv_array_push(&child->args, "clone");
700 if (suc->quiet)
701 argv_array_push(&child->args, "--quiet");
702 if (suc->prefix)
703 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
abed000a
SB
704 if (suc->recommend_shallow && sub->recommend_shallow == 1)
705 argv_array_push(&child->args, "--depth=1");
48308681
SB
706 argv_array_pushl(&child->args, "--path", sub->path, NULL);
707 argv_array_pushl(&child->args, "--name", sub->name, NULL);
708 argv_array_pushl(&child->args, "--url", url, NULL);
709 if (suc->reference)
710 argv_array_push(&child->args, suc->reference);
711 if (suc->depth)
712 argv_array_push(&child->args, suc->depth);
713
714cleanup:
715 free(url);
716 strbuf_reset(&displaypath_sb);
717 strbuf_reset(&sb);
718
719 return needs_cloning;
720}
721
722static int update_clone_get_next_task(struct child_process *child,
723 struct strbuf *err,
724 void *suc_cb,
665b35ec 725 void **idx_task_cb)
48308681
SB
726{
727 struct submodule_update_clone *suc = suc_cb;
665b35ec
SB
728 const struct cache_entry *ce;
729 int index;
48308681
SB
730
731 for (; suc->current < suc->list.nr; suc->current++) {
665b35ec 732 ce = suc->list.entries[suc->current];
48308681 733 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
665b35ec
SB
734 int *p = xmalloc(sizeof(*p));
735 *p = suc->current;
736 *idx_task_cb = p;
48308681
SB
737 suc->current++;
738 return 1;
739 }
740 }
665b35ec
SB
741
742 /*
743 * The loop above tried cloning each submodule once, now try the
744 * stragglers again, which we can imagine as an extension of the
745 * entry list.
746 */
747 index = suc->current - suc->list.nr;
748 if (index < suc->failed_clones_nr) {
749 int *p;
750 ce = suc->failed_clones[index];
751 if (!prepare_to_clone_next_submodule(ce, child, suc, err))
752 die("BUG: ce was a submodule before?");
753 p = xmalloc(sizeof(*p));
754 *p = suc->current;
755 *idx_task_cb = p;
756 suc->current ++;
757 return 1;
758 }
759
48308681
SB
760 return 0;
761}
762
763static int update_clone_start_failure(struct strbuf *err,
764 void *suc_cb,
665b35ec 765 void *idx_task_cb)
48308681
SB
766{
767 struct submodule_update_clone *suc = suc_cb;
768 suc->quickstop = 1;
769 return 1;
770}
771
772static int update_clone_task_finished(int result,
773 struct strbuf *err,
774 void *suc_cb,
665b35ec 775 void *idx_task_cb)
48308681 776{
665b35ec 777 const struct cache_entry *ce;
48308681
SB
778 struct submodule_update_clone *suc = suc_cb;
779
665b35ec
SB
780 int *idxP = *(int**)idx_task_cb;
781 int idx = *idxP;
782 free(idxP);
783
48308681
SB
784 if (!result)
785 return 0;
786
665b35ec
SB
787 if (idx < suc->list.nr) {
788 ce = suc->list.entries[idx];
789 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
790 ce->name);
791 strbuf_addch(err, '\n');
792 ALLOC_GROW(suc->failed_clones,
793 suc->failed_clones_nr + 1,
794 suc->failed_clones_alloc);
795 suc->failed_clones[suc->failed_clones_nr++] = ce;
796 return 0;
797 } else {
798 idx = suc->current - suc->list.nr;
799 ce = suc->failed_clones[idx];
800 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
801 ce->name);
802 strbuf_addch(err, '\n');
803 suc->quickstop = 1;
804 return 1;
805 }
806
807 return 0;
48308681
SB
808}
809
810static int update_clone(int argc, const char **argv, const char *prefix)
811{
812 const char *update = NULL;
2335b870 813 int max_jobs = -1;
48308681
SB
814 struct string_list_item *item;
815 struct pathspec pathspec;
816 struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
817
818 struct option module_update_clone_options[] = {
819 OPT_STRING(0, "prefix", &prefix,
820 N_("path"),
821 N_("path into the working tree")),
822 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
823 N_("path"),
824 N_("path into the working tree, across nested "
825 "submodule boundaries")),
826 OPT_STRING(0, "update", &update,
827 N_("string"),
828 N_("rebase, merge, checkout or none")),
829 OPT_STRING(0, "reference", &suc.reference, N_("repo"),
830 N_("reference repository")),
831 OPT_STRING(0, "depth", &suc.depth, "<depth>",
832 N_("Create a shallow clone truncated to the "
833 "specified number of revisions")),
2335b870
SB
834 OPT_INTEGER('j', "jobs", &max_jobs,
835 N_("parallel jobs")),
abed000a
SB
836 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
837 N_("whether the initial clone should follow the shallow recommendation")),
48308681
SB
838 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
839 OPT_END()
840 };
841
842 const char *const git_submodule_helper_usage[] = {
843 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
844 NULL
845 };
846 suc.prefix = prefix;
847
848 argc = parse_options(argc, argv, prefix, module_update_clone_options,
849 git_submodule_helper_usage, 0);
850
851 if (update)
852 if (parse_submodule_update_strategy(update, &suc.update) < 0)
853 die(_("bad value for update parameter"));
854
855 if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
856 return 1;
857
858 if (pathspec.nr)
859 suc.warn_if_uninitialized = 1;
860
861 /* Overlay the parsed .gitmodules file with .git/config */
862 gitmodules_config();
863 git_config(submodule_config, NULL);
864
2335b870
SB
865 if (max_jobs < 0)
866 max_jobs = parallel_submodules();
867
868 run_processes_parallel(max_jobs,
48308681
SB
869 update_clone_get_next_task,
870 update_clone_start_failure,
871 update_clone_task_finished,
872 &suc);
873
874 /*
875 * We saved the output and put it out all at once now.
876 * That means:
877 * - the listener does not have to interleave their (checkout)
878 * work with our fetching. The writes involved in a
879 * checkout involve more straightforward sequential I/O.
880 * - the listener can avoid doing any work if fetching failed.
881 */
882 if (suc.quickstop)
883 return 1;
884
885 for_each_string_list_item(item, &suc.projectlines)
886 utf8_fprintf(stdout, "%s", item->string);
887
888 return 0;
889}
890
44431df0
SB
891static int resolve_relative_path(int argc, const char **argv, const char *prefix)
892{
893 struct strbuf sb = STRBUF_INIT;
894 if (argc != 3)
895 die("submodule--helper relative_path takes exactly 2 arguments, got %d", argc);
896
897 printf("%s", relative_path(argv[1], argv[2], &sb));
898 strbuf_release(&sb);
899 return 0;
900}
901
74703a1e
SB
902struct cmd_struct {
903 const char *cmd;
904 int (*fn)(int, const char **, const char *);
905};
906
907static struct cmd_struct commands[] = {
908 {"list", module_list},
0ea306ef 909 {"name", module_name},
ee8838d1 910 {"clone", module_clone},
63e95beb 911 {"update-clone", update_clone},
44431df0 912 {"relative-path", resolve_relative_path},
63e95beb
SB
913 {"resolve-relative-url", resolve_relative_url},
914 {"resolve-relative-url-test", resolve_relative_url_test},
3604242f 915 {"init", module_init}
74703a1e
SB
916};
917
918int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
919{
920 int i;
921 if (argc < 2)
cdc04b65 922 die(_("submodule--helper subcommand must be "
74703a1e
SB
923 "called with a subcommand"));
924
925 for (i = 0; i < ARRAY_SIZE(commands); i++)
926 if (!strcmp(argv[1], commands[i].cmd))
927 return commands[i].fn(argc - 1, argv + 1, prefix);
928
cdc04b65 929 die(_("'%s' is not a valid submodule--helper "
74703a1e
SB
930 "subcommand"), argv[1]);
931}