t1400: use consistent style for test_expect_success calls
[git/git.git] / builtin / submodule--helper.c
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"
8 #include "submodule.h"
9 #include "submodule-config.h"
10 #include "string-list.h"
11 #include "run-command.h"
12 #include "remote.h"
13 #include "refs.h"
14 #include "connect.h"
15
16 static 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
43 static int starts_with_dot_slash(const char *str)
44 {
45 return str[0] == '.' && is_dir_sep(str[1]);
46 }
47
48 static 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 */
56 static 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://a.com/c same as previous line, but
99 * ignore trailing slash in url
100 * http://a.com/b ../../c http://c error out
101 * http://a.com/b ../../../c http:/c error out
102 * http://a.com/b ../../../../c http:c error out
103 * http://a.com/b ../../../../../c .:c error out
104 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
105 * when a local part has a colon in its path component, too.
106 */
107 static char *relative_url(const char *remote_url,
108 const char *url,
109 const char *up_path)
110 {
111 int is_relative = 0;
112 int colonsep = 0;
113 char *out;
114 char *remoteurl = xstrdup(remote_url);
115 struct strbuf sb = STRBUF_INIT;
116 size_t len = strlen(remoteurl);
117
118 if (is_dir_sep(remoteurl[len-1]))
119 remoteurl[len-1] = '\0';
120
121 if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
122 is_relative = 0;
123 else {
124 is_relative = 1;
125 /*
126 * Prepend a './' to ensure all relative
127 * remoteurls start with './' or '../'
128 */
129 if (!starts_with_dot_slash(remoteurl) &&
130 !starts_with_dot_dot_slash(remoteurl)) {
131 strbuf_reset(&sb);
132 strbuf_addf(&sb, "./%s", remoteurl);
133 free(remoteurl);
134 remoteurl = strbuf_detach(&sb, NULL);
135 }
136 }
137 /*
138 * When the url starts with '../', remove that and the
139 * last directory in remoteurl.
140 */
141 while (url) {
142 if (starts_with_dot_dot_slash(url)) {
143 url += 3;
144 colonsep |= chop_last_dir(&remoteurl, is_relative);
145 } else if (starts_with_dot_slash(url))
146 url += 2;
147 else
148 break;
149 }
150 strbuf_reset(&sb);
151 strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
152 if (ends_with(url, "/"))
153 strbuf_setlen(&sb, sb.len - 1);
154 free(remoteurl);
155
156 if (starts_with_dot_slash(sb.buf))
157 out = xstrdup(sb.buf + 2);
158 else
159 out = xstrdup(sb.buf);
160 strbuf_reset(&sb);
161
162 if (!up_path || !is_relative)
163 return out;
164
165 strbuf_addf(&sb, "%s%s", up_path, out);
166 free(out);
167 return strbuf_detach(&sb, NULL);
168 }
169
170 static int resolve_relative_url(int argc, const char **argv, const char *prefix)
171 {
172 char *remoteurl = NULL;
173 char *remote = get_default_remote();
174 const char *up_path = NULL;
175 char *res;
176 const char *url;
177 struct strbuf sb = STRBUF_INIT;
178
179 if (argc != 2 && argc != 3)
180 die("resolve-relative-url only accepts one or two arguments");
181
182 url = argv[1];
183 strbuf_addf(&sb, "remote.%s.url", remote);
184 free(remote);
185
186 if (git_config_get_string(sb.buf, &remoteurl))
187 /* the repository is its own authoritative upstream */
188 remoteurl = xgetcwd();
189
190 if (argc == 3)
191 up_path = argv[2];
192
193 res = relative_url(remoteurl, url, up_path);
194 puts(res);
195 free(res);
196 free(remoteurl);
197 return 0;
198 }
199
200 static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
201 {
202 char *remoteurl, *res;
203 const char *up_path, *url;
204
205 if (argc != 4)
206 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
207
208 up_path = argv[1];
209 remoteurl = xstrdup(argv[2]);
210 url = argv[3];
211
212 if (!strcmp(up_path, "(null)"))
213 up_path = NULL;
214
215 res = relative_url(remoteurl, url, up_path);
216 puts(res);
217 free(res);
218 free(remoteurl);
219 return 0;
220 }
221
222 struct module_list {
223 const struct cache_entry **entries;
224 int alloc, nr;
225 };
226 #define MODULE_LIST_INIT { NULL, 0, 0 }
227
228 static int module_list_compute(int argc, const char **argv,
229 const char *prefix,
230 struct pathspec *pathspec,
231 struct module_list *list)
232 {
233 int i, result = 0;
234 char *ps_matched = NULL;
235 parse_pathspec(pathspec, 0,
236 PATHSPEC_PREFER_FULL |
237 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
238 prefix, argv);
239
240 if (pathspec->nr)
241 ps_matched = xcalloc(pathspec->nr, 1);
242
243 if (read_cache() < 0)
244 die(_("index file corrupt"));
245
246 for (i = 0; i < active_nr; i++) {
247 const struct cache_entry *ce = active_cache[i];
248
249 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
250 0, ps_matched, 1) ||
251 !S_ISGITLINK(ce->ce_mode))
252 continue;
253
254 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
255 list->entries[list->nr++] = ce;
256 while (i + 1 < active_nr &&
257 !strcmp(ce->name, active_cache[i + 1]->name))
258 /*
259 * Skip entries with the same name in different stages
260 * to make sure an entry is returned only once.
261 */
262 i++;
263 }
264
265 if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
266 result = -1;
267
268 free(ps_matched);
269
270 return result;
271 }
272
273 static int module_list(int argc, const char **argv, const char *prefix)
274 {
275 int i;
276 struct pathspec pathspec;
277 struct module_list list = MODULE_LIST_INIT;
278
279 struct option module_list_options[] = {
280 OPT_STRING(0, "prefix", &prefix,
281 N_("path"),
282 N_("alternative anchor for relative paths")),
283 OPT_END()
284 };
285
286 const char *const git_submodule_helper_usage[] = {
287 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
288 NULL
289 };
290
291 argc = parse_options(argc, argv, prefix, module_list_options,
292 git_submodule_helper_usage, 0);
293
294 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
295 return 1;
296
297 for (i = 0; i < list.nr; i++) {
298 const struct cache_entry *ce = list.entries[i];
299
300 if (ce_stage(ce))
301 printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
302 else
303 printf("%06o %s %d\t", ce->ce_mode,
304 oid_to_hex(&ce->oid), ce_stage(ce));
305
306 utf8_fprintf(stdout, "%s\n", ce->name);
307 }
308 return 0;
309 }
310
311 static void init_submodule(const char *path, const char *prefix, int quiet)
312 {
313 const struct submodule *sub;
314 struct strbuf sb = STRBUF_INIT;
315 char *upd = NULL, *url = NULL, *displaypath;
316
317 /* Only loads from .gitmodules, no overlay with .git/config */
318 gitmodules_config();
319
320 if (prefix && get_super_prefix())
321 die("BUG: cannot have prefix and superprefix");
322 else if (prefix)
323 displaypath = xstrdup(relative_path(path, prefix, &sb));
324 else if (get_super_prefix()) {
325 strbuf_addf(&sb, "%s%s", get_super_prefix(), path);
326 displaypath = strbuf_detach(&sb, NULL);
327 } else
328 displaypath = xstrdup(path);
329
330 sub = submodule_from_path(null_sha1, path);
331
332 if (!sub)
333 die(_("No url found for submodule path '%s' in .gitmodules"),
334 displaypath);
335
336 /*
337 * Copy url setting when it is not set yet.
338 * To look up the url in .git/config, we must not fall back to
339 * .gitmodules, so look it up directly.
340 */
341 strbuf_reset(&sb);
342 strbuf_addf(&sb, "submodule.%s.url", sub->name);
343 if (git_config_get_string(sb.buf, &url)) {
344 url = xstrdup(sub->url);
345
346 if (!url)
347 die(_("No url found for submodule path '%s' in .gitmodules"),
348 displaypath);
349
350 /* Possibly a url relative to parent */
351 if (starts_with_dot_dot_slash(url) ||
352 starts_with_dot_slash(url)) {
353 char *remoteurl, *relurl;
354 char *remote = get_default_remote();
355 struct strbuf remotesb = STRBUF_INIT;
356 strbuf_addf(&remotesb, "remote.%s.url", remote);
357 free(remote);
358
359 if (git_config_get_string(remotesb.buf, &remoteurl)) {
360 warning(_("could not lookup configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb.buf);
361 remoteurl = xgetcwd();
362 }
363 relurl = relative_url(remoteurl, url, NULL);
364 strbuf_release(&remotesb);
365 free(remoteurl);
366 free(url);
367 url = relurl;
368 }
369
370 if (git_config_set_gently(sb.buf, url))
371 die(_("Failed to register url for submodule path '%s'"),
372 displaypath);
373 if (!quiet)
374 fprintf(stderr,
375 _("Submodule '%s' (%s) registered for path '%s'\n"),
376 sub->name, url, displaypath);
377 }
378
379 /* Copy "update" setting when it is not set yet */
380 strbuf_reset(&sb);
381 strbuf_addf(&sb, "submodule.%s.update", sub->name);
382 if (git_config_get_string(sb.buf, &upd) &&
383 sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
384 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
385 fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
386 sub->name);
387 upd = xstrdup("none");
388 } else
389 upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
390
391 if (git_config_set_gently(sb.buf, upd))
392 die(_("Failed to register update mode for submodule path '%s'"), displaypath);
393 }
394 strbuf_release(&sb);
395 free(displaypath);
396 free(url);
397 free(upd);
398 }
399
400 static int module_init(int argc, const char **argv, const char *prefix)
401 {
402 struct pathspec pathspec;
403 struct module_list list = MODULE_LIST_INIT;
404 int quiet = 0;
405 int i;
406
407 struct option module_init_options[] = {
408 OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
409 OPT_END()
410 };
411
412 const char *const git_submodule_helper_usage[] = {
413 N_("git submodule--helper init [<path>]"),
414 NULL
415 };
416
417 argc = parse_options(argc, argv, prefix, module_init_options,
418 git_submodule_helper_usage, 0);
419
420 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
421 return 1;
422
423 for (i = 0; i < list.nr; i++)
424 init_submodule(list.entries[i]->name, prefix, quiet);
425
426 return 0;
427 }
428
429 static int module_name(int argc, const char **argv, const char *prefix)
430 {
431 const struct submodule *sub;
432
433 if (argc != 2)
434 usage(_("git submodule--helper name <path>"));
435
436 gitmodules_config();
437 sub = submodule_from_path(null_sha1, argv[1]);
438
439 if (!sub)
440 die(_("no submodule mapping found in .gitmodules for path '%s'"),
441 argv[1]);
442
443 printf("%s\n", sub->name);
444
445 return 0;
446 }
447
448 static int clone_submodule(const char *path, const char *gitdir, const char *url,
449 const char *depth, struct string_list *reference,
450 int quiet, int progress)
451 {
452 struct child_process cp = CHILD_PROCESS_INIT;
453
454 argv_array_push(&cp.args, "clone");
455 argv_array_push(&cp.args, "--no-checkout");
456 if (quiet)
457 argv_array_push(&cp.args, "--quiet");
458 if (progress)
459 argv_array_push(&cp.args, "--progress");
460 if (depth && *depth)
461 argv_array_pushl(&cp.args, "--depth", depth, NULL);
462 if (reference->nr) {
463 struct string_list_item *item;
464 for_each_string_list_item(item, reference)
465 argv_array_pushl(&cp.args, "--reference",
466 item->string, NULL);
467 }
468 if (gitdir && *gitdir)
469 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
470
471 argv_array_push(&cp.args, url);
472 argv_array_push(&cp.args, path);
473
474 cp.git_cmd = 1;
475 prepare_submodule_repo_env(&cp.env_array);
476 cp.no_stdin = 1;
477
478 return run_command(&cp);
479 }
480
481 struct submodule_alternate_setup {
482 const char *submodule_name;
483 enum SUBMODULE_ALTERNATE_ERROR_MODE {
484 SUBMODULE_ALTERNATE_ERROR_DIE,
485 SUBMODULE_ALTERNATE_ERROR_INFO,
486 SUBMODULE_ALTERNATE_ERROR_IGNORE
487 } error_mode;
488 struct string_list *reference;
489 };
490 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
491 SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
492
493 static int add_possible_reference_from_superproject(
494 struct alternate_object_database *alt, void *sas_cb)
495 {
496 struct submodule_alternate_setup *sas = sas_cb;
497
498 /*
499 * If the alternate object store is another repository, try the
500 * standard layout with .git/(modules/<name>)+/objects
501 */
502 if (ends_with(alt->path, "/objects")) {
503 char *sm_alternate;
504 struct strbuf sb = STRBUF_INIT;
505 struct strbuf err = STRBUF_INIT;
506 strbuf_add(&sb, alt->path, strlen(alt->path) - strlen("objects"));
507
508 /*
509 * We need to end the new path with '/' to mark it as a dir,
510 * otherwise a submodule name containing '/' will be broken
511 * as the last part of a missing submodule reference would
512 * be taken as a file name.
513 */
514 strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
515
516 sm_alternate = compute_alternate_path(sb.buf, &err);
517 if (sm_alternate) {
518 string_list_append(sas->reference, xstrdup(sb.buf));
519 free(sm_alternate);
520 } else {
521 switch (sas->error_mode) {
522 case SUBMODULE_ALTERNATE_ERROR_DIE:
523 die(_("submodule '%s' cannot add alternate: %s"),
524 sas->submodule_name, err.buf);
525 case SUBMODULE_ALTERNATE_ERROR_INFO:
526 fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
527 sas->submodule_name, err.buf);
528 case SUBMODULE_ALTERNATE_ERROR_IGNORE:
529 ; /* nothing */
530 }
531 }
532 strbuf_release(&sb);
533 }
534
535 return 0;
536 }
537
538 static void prepare_possible_alternates(const char *sm_name,
539 struct string_list *reference)
540 {
541 char *sm_alternate = NULL, *error_strategy = NULL;
542 struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
543
544 git_config_get_string("submodule.alternateLocation", &sm_alternate);
545 if (!sm_alternate)
546 return;
547
548 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
549
550 if (!error_strategy)
551 error_strategy = xstrdup("die");
552
553 sas.submodule_name = sm_name;
554 sas.reference = reference;
555 if (!strcmp(error_strategy, "die"))
556 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
557 else if (!strcmp(error_strategy, "info"))
558 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
559 else if (!strcmp(error_strategy, "ignore"))
560 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
561 else
562 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
563
564 if (!strcmp(sm_alternate, "superproject"))
565 foreach_alt_odb(add_possible_reference_from_superproject, &sas);
566 else if (!strcmp(sm_alternate, "no"))
567 ; /* do nothing */
568 else
569 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
570
571 free(sm_alternate);
572 free(error_strategy);
573 }
574
575 static int module_clone(int argc, const char **argv, const char *prefix)
576 {
577 const char *name = NULL, *url = NULL, *depth = NULL;
578 int quiet = 0;
579 int progress = 0;
580 FILE *submodule_dot_git;
581 char *p, *path = NULL, *sm_gitdir;
582 struct strbuf rel_path = STRBUF_INIT;
583 struct strbuf sb = STRBUF_INIT;
584 struct string_list reference = STRING_LIST_INIT_NODUP;
585 char *sm_alternate = NULL, *error_strategy = NULL;
586
587 struct option module_clone_options[] = {
588 OPT_STRING(0, "prefix", &prefix,
589 N_("path"),
590 N_("alternative anchor for relative paths")),
591 OPT_STRING(0, "path", &path,
592 N_("path"),
593 N_("where the new submodule will be cloned to")),
594 OPT_STRING(0, "name", &name,
595 N_("string"),
596 N_("name of the new submodule")),
597 OPT_STRING(0, "url", &url,
598 N_("string"),
599 N_("url where to clone the submodule from")),
600 OPT_STRING_LIST(0, "reference", &reference,
601 N_("repo"),
602 N_("reference repository")),
603 OPT_STRING(0, "depth", &depth,
604 N_("string"),
605 N_("depth for shallow clones")),
606 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
607 OPT_BOOL(0, "progress", &progress,
608 N_("force cloning progress")),
609 OPT_END()
610 };
611
612 const char *const git_submodule_helper_usage[] = {
613 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
614 "[--reference <repository>] [--name <name>] [--depth <depth>] "
615 "--url <url> --path <path>"),
616 NULL
617 };
618
619 argc = parse_options(argc, argv, prefix, module_clone_options,
620 git_submodule_helper_usage, 0);
621
622 if (argc || !url || !path || !*path)
623 usage_with_options(git_submodule_helper_usage,
624 module_clone_options);
625
626 strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
627 sm_gitdir = absolute_pathdup(sb.buf);
628 strbuf_reset(&sb);
629
630 if (!is_absolute_path(path)) {
631 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
632 path = strbuf_detach(&sb, NULL);
633 } else
634 path = xstrdup(path);
635
636 if (!file_exists(sm_gitdir)) {
637 if (safe_create_leading_directories_const(sm_gitdir) < 0)
638 die(_("could not create directory '%s'"), sm_gitdir);
639
640 prepare_possible_alternates(name, &reference);
641
642 if (clone_submodule(path, sm_gitdir, url, depth, &reference,
643 quiet, progress))
644 die(_("clone of '%s' into submodule path '%s' failed"),
645 url, path);
646 } else {
647 if (safe_create_leading_directories_const(path) < 0)
648 die(_("could not create directory '%s'"), path);
649 strbuf_addf(&sb, "%s/index", sm_gitdir);
650 unlink_or_warn(sb.buf);
651 strbuf_reset(&sb);
652 }
653
654 /* Write a .git file in the submodule to redirect to the superproject. */
655 strbuf_addf(&sb, "%s/.git", path);
656 if (safe_create_leading_directories_const(sb.buf) < 0)
657 die(_("could not create leading directories of '%s'"), sb.buf);
658 submodule_dot_git = fopen(sb.buf, "w");
659 if (!submodule_dot_git)
660 die_errno(_("cannot open file '%s'"), sb.buf);
661
662 fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
663 relative_path(sm_gitdir, path, &rel_path));
664 if (fclose(submodule_dot_git))
665 die(_("could not close file %s"), sb.buf);
666 strbuf_reset(&sb);
667 strbuf_reset(&rel_path);
668
669 /* Redirect the worktree of the submodule in the superproject's config */
670 p = git_pathdup_submodule(path, "config");
671 if (!p)
672 die(_("could not get submodule directory for '%s'"), path);
673 git_config_set_in_file(p, "core.worktree",
674 relative_path(path, sm_gitdir, &rel_path));
675
676 /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
677 git_config_get_string("submodule.alternateLocation", &sm_alternate);
678 if (sm_alternate)
679 git_config_set_in_file(p, "submodule.alternateLocation",
680 sm_alternate);
681 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
682 if (error_strategy)
683 git_config_set_in_file(p, "submodule.alternateErrorStrategy",
684 error_strategy);
685
686 free(sm_alternate);
687 free(error_strategy);
688
689 strbuf_release(&sb);
690 strbuf_release(&rel_path);
691 free(sm_gitdir);
692 free(path);
693 free(p);
694 return 0;
695 }
696
697 struct submodule_update_clone {
698 /* index into 'list', the list of submodules to look into for cloning */
699 int current;
700 struct module_list list;
701 unsigned warn_if_uninitialized : 1;
702
703 /* update parameter passed via commandline */
704 struct submodule_update_strategy update;
705
706 /* configuration parameters which are passed on to the children */
707 int progress;
708 int quiet;
709 int recommend_shallow;
710 struct string_list references;
711 const char *depth;
712 const char *recursive_prefix;
713 const char *prefix;
714
715 /* Machine-readable status lines to be consumed by git-submodule.sh */
716 struct string_list projectlines;
717
718 /* If we want to stop as fast as possible and return an error */
719 unsigned quickstop : 1;
720
721 /* failed clones to be retried again */
722 const struct cache_entry **failed_clones;
723 int failed_clones_nr, failed_clones_alloc;
724 };
725 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
726 SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, \
727 NULL, NULL, NULL, \
728 STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
729
730
731 static void next_submodule_warn_missing(struct submodule_update_clone *suc,
732 struct strbuf *out, const char *displaypath)
733 {
734 /*
735 * Only mention uninitialized submodules when their
736 * paths have been specified.
737 */
738 if (suc->warn_if_uninitialized) {
739 strbuf_addf(out,
740 _("Submodule path '%s' not initialized"),
741 displaypath);
742 strbuf_addch(out, '\n');
743 strbuf_addstr(out,
744 _("Maybe you want to use 'update --init'?"));
745 strbuf_addch(out, '\n');
746 }
747 }
748
749 /**
750 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
751 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
752 */
753 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
754 struct child_process *child,
755 struct submodule_update_clone *suc,
756 struct strbuf *out)
757 {
758 const struct submodule *sub = NULL;
759 struct strbuf displaypath_sb = STRBUF_INIT;
760 struct strbuf sb = STRBUF_INIT;
761 const char *displaypath = NULL;
762 char *url = NULL;
763 int needs_cloning = 0;
764
765 if (ce_stage(ce)) {
766 if (suc->recursive_prefix)
767 strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
768 else
769 strbuf_addstr(&sb, ce->name);
770 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
771 strbuf_addch(out, '\n');
772 goto cleanup;
773 }
774
775 sub = submodule_from_path(null_sha1, ce->name);
776
777 if (suc->recursive_prefix)
778 displaypath = relative_path(suc->recursive_prefix,
779 ce->name, &displaypath_sb);
780 else
781 displaypath = ce->name;
782
783 if (!sub) {
784 next_submodule_warn_missing(suc, out, displaypath);
785 goto cleanup;
786 }
787
788 if (suc->update.type == SM_UPDATE_NONE
789 || (suc->update.type == SM_UPDATE_UNSPECIFIED
790 && sub->update_strategy.type == SM_UPDATE_NONE)) {
791 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
792 strbuf_addch(out, '\n');
793 goto cleanup;
794 }
795
796 /*
797 * Looking up the url in .git/config.
798 * We must not fall back to .gitmodules as we only want
799 * to process configured submodules.
800 */
801 strbuf_reset(&sb);
802 strbuf_addf(&sb, "submodule.%s.url", sub->name);
803 git_config_get_string(sb.buf, &url);
804 if (!url) {
805 next_submodule_warn_missing(suc, out, displaypath);
806 goto cleanup;
807 }
808
809 strbuf_reset(&sb);
810 strbuf_addf(&sb, "%s/.git", ce->name);
811 needs_cloning = !file_exists(sb.buf);
812
813 strbuf_reset(&sb);
814 strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
815 oid_to_hex(&ce->oid), ce_stage(ce),
816 needs_cloning, ce->name);
817 string_list_append(&suc->projectlines, sb.buf);
818
819 if (!needs_cloning)
820 goto cleanup;
821
822 child->git_cmd = 1;
823 child->no_stdin = 1;
824 child->stdout_to_stderr = 1;
825 child->err = -1;
826 argv_array_push(&child->args, "submodule--helper");
827 argv_array_push(&child->args, "clone");
828 if (suc->progress)
829 argv_array_push(&child->args, "--progress");
830 if (suc->quiet)
831 argv_array_push(&child->args, "--quiet");
832 if (suc->prefix)
833 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
834 if (suc->recommend_shallow && sub->recommend_shallow == 1)
835 argv_array_push(&child->args, "--depth=1");
836 argv_array_pushl(&child->args, "--path", sub->path, NULL);
837 argv_array_pushl(&child->args, "--name", sub->name, NULL);
838 argv_array_pushl(&child->args, "--url", url, NULL);
839 if (suc->references.nr) {
840 struct string_list_item *item;
841 for_each_string_list_item(item, &suc->references)
842 argv_array_pushl(&child->args, "--reference", item->string, NULL);
843 }
844 if (suc->depth)
845 argv_array_push(&child->args, suc->depth);
846
847 cleanup:
848 free(url);
849 strbuf_reset(&displaypath_sb);
850 strbuf_reset(&sb);
851
852 return needs_cloning;
853 }
854
855 static int update_clone_get_next_task(struct child_process *child,
856 struct strbuf *err,
857 void *suc_cb,
858 void **idx_task_cb)
859 {
860 struct submodule_update_clone *suc = suc_cb;
861 const struct cache_entry *ce;
862 int index;
863
864 for (; suc->current < suc->list.nr; suc->current++) {
865 ce = suc->list.entries[suc->current];
866 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
867 int *p = xmalloc(sizeof(*p));
868 *p = suc->current;
869 *idx_task_cb = p;
870 suc->current++;
871 return 1;
872 }
873 }
874
875 /*
876 * The loop above tried cloning each submodule once, now try the
877 * stragglers again, which we can imagine as an extension of the
878 * entry list.
879 */
880 index = suc->current - suc->list.nr;
881 if (index < suc->failed_clones_nr) {
882 int *p;
883 ce = suc->failed_clones[index];
884 if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
885 suc->current ++;
886 strbuf_addstr(err, "BUG: submodule considered for "
887 "cloning, doesn't need cloning "
888 "any more?\n");
889 return 0;
890 }
891 p = xmalloc(sizeof(*p));
892 *p = suc->current;
893 *idx_task_cb = p;
894 suc->current ++;
895 return 1;
896 }
897
898 return 0;
899 }
900
901 static int update_clone_start_failure(struct strbuf *err,
902 void *suc_cb,
903 void *idx_task_cb)
904 {
905 struct submodule_update_clone *suc = suc_cb;
906 suc->quickstop = 1;
907 return 1;
908 }
909
910 static int update_clone_task_finished(int result,
911 struct strbuf *err,
912 void *suc_cb,
913 void *idx_task_cb)
914 {
915 const struct cache_entry *ce;
916 struct submodule_update_clone *suc = suc_cb;
917
918 int *idxP = *(int**)idx_task_cb;
919 int idx = *idxP;
920 free(idxP);
921
922 if (!result)
923 return 0;
924
925 if (idx < suc->list.nr) {
926 ce = suc->list.entries[idx];
927 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
928 ce->name);
929 strbuf_addch(err, '\n');
930 ALLOC_GROW(suc->failed_clones,
931 suc->failed_clones_nr + 1,
932 suc->failed_clones_alloc);
933 suc->failed_clones[suc->failed_clones_nr++] = ce;
934 return 0;
935 } else {
936 idx -= suc->list.nr;
937 ce = suc->failed_clones[idx];
938 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
939 ce->name);
940 strbuf_addch(err, '\n');
941 suc->quickstop = 1;
942 return 1;
943 }
944
945 return 0;
946 }
947
948 static int update_clone(int argc, const char **argv, const char *prefix)
949 {
950 const char *update = NULL;
951 int max_jobs = -1;
952 struct string_list_item *item;
953 struct pathspec pathspec;
954 struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
955
956 struct option module_update_clone_options[] = {
957 OPT_STRING(0, "prefix", &prefix,
958 N_("path"),
959 N_("path into the working tree")),
960 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
961 N_("path"),
962 N_("path into the working tree, across nested "
963 "submodule boundaries")),
964 OPT_STRING(0, "update", &update,
965 N_("string"),
966 N_("rebase, merge, checkout or none")),
967 OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
968 N_("reference repository")),
969 OPT_STRING(0, "depth", &suc.depth, "<depth>",
970 N_("Create a shallow clone truncated to the "
971 "specified number of revisions")),
972 OPT_INTEGER('j', "jobs", &max_jobs,
973 N_("parallel jobs")),
974 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
975 N_("whether the initial clone should follow the shallow recommendation")),
976 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
977 OPT_BOOL(0, "progress", &suc.progress,
978 N_("force cloning progress")),
979 OPT_END()
980 };
981
982 const char *const git_submodule_helper_usage[] = {
983 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
984 NULL
985 };
986 suc.prefix = prefix;
987
988 argc = parse_options(argc, argv, prefix, module_update_clone_options,
989 git_submodule_helper_usage, 0);
990
991 if (update)
992 if (parse_submodule_update_strategy(update, &suc.update) < 0)
993 die(_("bad value for update parameter"));
994
995 if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
996 return 1;
997
998 if (pathspec.nr)
999 suc.warn_if_uninitialized = 1;
1000
1001 /* Overlay the parsed .gitmodules file with .git/config */
1002 gitmodules_config();
1003 git_config(submodule_config, NULL);
1004
1005 if (max_jobs < 0)
1006 max_jobs = parallel_submodules();
1007
1008 run_processes_parallel(max_jobs,
1009 update_clone_get_next_task,
1010 update_clone_start_failure,
1011 update_clone_task_finished,
1012 &suc);
1013
1014 /*
1015 * We saved the output and put it out all at once now.
1016 * That means:
1017 * - the listener does not have to interleave their (checkout)
1018 * work with our fetching. The writes involved in a
1019 * checkout involve more straightforward sequential I/O.
1020 * - the listener can avoid doing any work if fetching failed.
1021 */
1022 if (suc.quickstop)
1023 return 1;
1024
1025 for_each_string_list_item(item, &suc.projectlines)
1026 utf8_fprintf(stdout, "%s", item->string);
1027
1028 return 0;
1029 }
1030
1031 static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1032 {
1033 struct strbuf sb = STRBUF_INIT;
1034 if (argc != 3)
1035 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1036
1037 printf("%s", relative_path(argv[1], argv[2], &sb));
1038 strbuf_release(&sb);
1039 return 0;
1040 }
1041
1042 static const char *remote_submodule_branch(const char *path)
1043 {
1044 const struct submodule *sub;
1045 gitmodules_config();
1046 git_config(submodule_config, NULL);
1047
1048 sub = submodule_from_path(null_sha1, path);
1049 if (!sub)
1050 return NULL;
1051
1052 if (!sub->branch)
1053 return "master";
1054
1055 if (!strcmp(sub->branch, ".")) {
1056 unsigned char sha1[20];
1057 const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
1058
1059 if (!refname)
1060 die(_("No such ref: %s"), "HEAD");
1061
1062 /* detached HEAD */
1063 if (!strcmp(refname, "HEAD"))
1064 die(_("Submodule (%s) branch configured to inherit "
1065 "branch from superproject, but the superproject "
1066 "is not on any branch"), sub->name);
1067
1068 if (!skip_prefix(refname, "refs/heads/", &refname))
1069 die(_("Expecting a full ref name, got %s"), refname);
1070 return refname;
1071 }
1072
1073 return sub->branch;
1074 }
1075
1076 static int resolve_remote_submodule_branch(int argc, const char **argv,
1077 const char *prefix)
1078 {
1079 const char *ret;
1080 struct strbuf sb = STRBUF_INIT;
1081 if (argc != 2)
1082 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1083
1084 ret = remote_submodule_branch(argv[1]);
1085 if (!ret)
1086 die("submodule %s doesn't exist", argv[1]);
1087
1088 printf("%s", ret);
1089 strbuf_release(&sb);
1090 return 0;
1091 }
1092
1093 static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
1094 {
1095 int i;
1096 struct pathspec pathspec;
1097 struct module_list list = MODULE_LIST_INIT;
1098 unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
1099
1100 struct option embed_gitdir_options[] = {
1101 OPT_STRING(0, "prefix", &prefix,
1102 N_("path"),
1103 N_("path into the working tree")),
1104 OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
1105 ABSORB_GITDIR_RECURSE_SUBMODULES),
1106 OPT_END()
1107 };
1108
1109 const char *const git_submodule_helper_usage[] = {
1110 N_("git submodule--helper embed-git-dir [<path>...]"),
1111 NULL
1112 };
1113
1114 argc = parse_options(argc, argv, prefix, embed_gitdir_options,
1115 git_submodule_helper_usage, 0);
1116
1117 gitmodules_config();
1118 git_config(submodule_config, NULL);
1119
1120 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1121 return 1;
1122
1123 for (i = 0; i < list.nr; i++)
1124 absorb_git_dir_into_superproject(prefix,
1125 list.entries[i]->name, flags);
1126
1127 return 0;
1128 }
1129
1130 #define SUPPORT_SUPER_PREFIX (1<<0)
1131
1132 struct cmd_struct {
1133 const char *cmd;
1134 int (*fn)(int, const char **, const char *);
1135 unsigned option;
1136 };
1137
1138 static struct cmd_struct commands[] = {
1139 {"list", module_list, 0},
1140 {"name", module_name, 0},
1141 {"clone", module_clone, 0},
1142 {"update-clone", update_clone, 0},
1143 {"relative-path", resolve_relative_path, 0},
1144 {"resolve-relative-url", resolve_relative_url, 0},
1145 {"resolve-relative-url-test", resolve_relative_url_test, 0},
1146 {"init", module_init, SUPPORT_SUPER_PREFIX},
1147 {"remote-branch", resolve_remote_submodule_branch, 0},
1148 {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
1149 };
1150
1151 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
1152 {
1153 int i;
1154 if (argc < 2)
1155 die(_("submodule--helper subcommand must be "
1156 "called with a subcommand"));
1157
1158 for (i = 0; i < ARRAY_SIZE(commands); i++) {
1159 if (!strcmp(argv[1], commands[i].cmd)) {
1160 if (get_super_prefix() &&
1161 !(commands[i].option & SUPPORT_SUPER_PREFIX))
1162 die(_("%s doesn't support --super-prefix"),
1163 commands[i].cmd);
1164 return commands[i].fn(argc - 1, argv + 1, prefix);
1165 }
1166 }
1167
1168 die(_("'%s' is not a valid submodule--helper "
1169 "subcommand"), argv[1]);
1170 }