Sync with 2.15.3
[git/git.git] / builtin / submodule--helper.c
1 #include "builtin.h"
2 #include "repository.h"
3 #include "cache.h"
4 #include "config.h"
5 #include "parse-options.h"
6 #include "quote.h"
7 #include "pathspec.h"
8 #include "dir.h"
9 #include "submodule.h"
10 #include "submodule-config.h"
11 #include "string-list.h"
12 #include "run-command.h"
13 #include "remote.h"
14 #include "refs.h"
15 #include "connect.h"
16 #include "revision.h"
17 #include "diffcore.h"
18 #include "diff.h"
19
20 #define OPT_QUIET (1 << 0)
21 #define OPT_CACHED (1 << 1)
22 #define OPT_RECURSIVE (1 << 2)
23
24 typedef void (*each_submodule_fn)(const struct cache_entry *list_item,
25 void *cb_data);
26
27 static char *get_default_remote(void)
28 {
29 char *dest = NULL, *ret;
30 struct strbuf sb = STRBUF_INIT;
31 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
32
33 if (!refname)
34 die(_("No such ref: %s"), "HEAD");
35
36 /* detached HEAD */
37 if (!strcmp(refname, "HEAD"))
38 return xstrdup("origin");
39
40 if (!skip_prefix(refname, "refs/heads/", &refname))
41 die(_("Expecting a full ref name, got %s"), refname);
42
43 strbuf_addf(&sb, "branch.%s.remote", refname);
44 if (git_config_get_string(sb.buf, &dest))
45 ret = xstrdup("origin");
46 else
47 ret = dest;
48
49 strbuf_release(&sb);
50 return ret;
51 }
52
53 static int starts_with_dot_slash(const char *str)
54 {
55 return str[0] == '.' && is_dir_sep(str[1]);
56 }
57
58 static int starts_with_dot_dot_slash(const char *str)
59 {
60 return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
61 }
62
63 /*
64 * Returns 1 if it was the last chop before ':'.
65 */
66 static int chop_last_dir(char **remoteurl, int is_relative)
67 {
68 char *rfind = find_last_dir_sep(*remoteurl);
69 if (rfind) {
70 *rfind = '\0';
71 return 0;
72 }
73
74 rfind = strrchr(*remoteurl, ':');
75 if (rfind) {
76 *rfind = '\0';
77 return 1;
78 }
79
80 if (is_relative || !strcmp(".", *remoteurl))
81 die(_("cannot strip one component off url '%s'"),
82 *remoteurl);
83
84 free(*remoteurl);
85 *remoteurl = xstrdup(".");
86 return 0;
87 }
88
89 /*
90 * The `url` argument is the URL that navigates to the submodule origin
91 * repo. When relative, this URL is relative to the superproject origin
92 * URL repo. The `up_path` argument, if specified, is the relative
93 * path that navigates from the submodule working tree to the superproject
94 * working tree. Returns the origin URL of the submodule.
95 *
96 * Return either an absolute URL or filesystem path (if the superproject
97 * origin URL is an absolute URL or filesystem path, respectively) or a
98 * relative file system path (if the superproject origin URL is a relative
99 * file system path).
100 *
101 * When the output is a relative file system path, the path is either
102 * relative to the submodule working tree, if up_path is specified, or to
103 * the superproject working tree otherwise.
104 *
105 * NEEDSWORK: This works incorrectly on the domain and protocol part.
106 * remote_url url outcome expectation
107 * http://a.com/b ../c http://a.com/c as is
108 * http://a.com/b/ ../c http://a.com/c same as previous line, but
109 * ignore trailing slash in url
110 * http://a.com/b ../../c http://c error out
111 * http://a.com/b ../../../c http:/c error out
112 * http://a.com/b ../../../../c http:c error out
113 * http://a.com/b ../../../../../c .:c error out
114 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
115 * when a local part has a colon in its path component, too.
116 */
117 static char *relative_url(const char *remote_url,
118 const char *url,
119 const char *up_path)
120 {
121 int is_relative = 0;
122 int colonsep = 0;
123 char *out;
124 char *remoteurl = xstrdup(remote_url);
125 struct strbuf sb = STRBUF_INIT;
126 size_t len = strlen(remoteurl);
127
128 if (is_dir_sep(remoteurl[len-1]))
129 remoteurl[len-1] = '\0';
130
131 if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
132 is_relative = 0;
133 else {
134 is_relative = 1;
135 /*
136 * Prepend a './' to ensure all relative
137 * remoteurls start with './' or '../'
138 */
139 if (!starts_with_dot_slash(remoteurl) &&
140 !starts_with_dot_dot_slash(remoteurl)) {
141 strbuf_reset(&sb);
142 strbuf_addf(&sb, "./%s", remoteurl);
143 free(remoteurl);
144 remoteurl = strbuf_detach(&sb, NULL);
145 }
146 }
147 /*
148 * When the url starts with '../', remove that and the
149 * last directory in remoteurl.
150 */
151 while (url) {
152 if (starts_with_dot_dot_slash(url)) {
153 url += 3;
154 colonsep |= chop_last_dir(&remoteurl, is_relative);
155 } else if (starts_with_dot_slash(url))
156 url += 2;
157 else
158 break;
159 }
160 strbuf_reset(&sb);
161 strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
162 if (ends_with(url, "/"))
163 strbuf_setlen(&sb, sb.len - 1);
164 free(remoteurl);
165
166 if (starts_with_dot_slash(sb.buf))
167 out = xstrdup(sb.buf + 2);
168 else
169 out = xstrdup(sb.buf);
170 strbuf_reset(&sb);
171
172 if (!up_path || !is_relative)
173 return out;
174
175 strbuf_addf(&sb, "%s%s", up_path, out);
176 free(out);
177 return strbuf_detach(&sb, NULL);
178 }
179
180 static int resolve_relative_url(int argc, const char **argv, const char *prefix)
181 {
182 char *remoteurl = NULL;
183 char *remote = get_default_remote();
184 const char *up_path = NULL;
185 char *res;
186 const char *url;
187 struct strbuf sb = STRBUF_INIT;
188
189 if (argc != 2 && argc != 3)
190 die("resolve-relative-url only accepts one or two arguments");
191
192 url = argv[1];
193 strbuf_addf(&sb, "remote.%s.url", remote);
194 free(remote);
195
196 if (git_config_get_string(sb.buf, &remoteurl))
197 /* the repository is its own authoritative upstream */
198 remoteurl = xgetcwd();
199
200 if (argc == 3)
201 up_path = argv[2];
202
203 res = relative_url(remoteurl, url, up_path);
204 puts(res);
205 free(res);
206 free(remoteurl);
207 return 0;
208 }
209
210 static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
211 {
212 char *remoteurl, *res;
213 const char *up_path, *url;
214
215 if (argc != 4)
216 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
217
218 up_path = argv[1];
219 remoteurl = xstrdup(argv[2]);
220 url = argv[3];
221
222 if (!strcmp(up_path, "(null)"))
223 up_path = NULL;
224
225 res = relative_url(remoteurl, url, up_path);
226 puts(res);
227 free(res);
228 free(remoteurl);
229 return 0;
230 }
231
232 /* the result should be freed by the caller. */
233 static char *get_submodule_displaypath(const char *path, const char *prefix)
234 {
235 const char *super_prefix = get_super_prefix();
236
237 if (prefix && super_prefix) {
238 BUG("cannot have prefix '%s' and superprefix '%s'",
239 prefix, super_prefix);
240 } else if (prefix) {
241 struct strbuf sb = STRBUF_INIT;
242 char *displaypath = xstrdup(relative_path(path, prefix, &sb));
243 strbuf_release(&sb);
244 return displaypath;
245 } else if (super_prefix) {
246 return xstrfmt("%s%s", super_prefix, path);
247 } else {
248 return xstrdup(path);
249 }
250 }
251
252 static char *compute_rev_name(const char *sub_path, const char* object_id)
253 {
254 struct strbuf sb = STRBUF_INIT;
255 const char ***d;
256
257 static const char *describe_bare[] = { NULL };
258
259 static const char *describe_tags[] = { "--tags", NULL };
260
261 static const char *describe_contains[] = { "--contains", NULL };
262
263 static const char *describe_all_always[] = { "--all", "--always", NULL };
264
265 static const char **describe_argv[] = { describe_bare, describe_tags,
266 describe_contains,
267 describe_all_always, NULL };
268
269 for (d = describe_argv; *d; d++) {
270 struct child_process cp = CHILD_PROCESS_INIT;
271 prepare_submodule_repo_env(&cp.env_array);
272 cp.dir = sub_path;
273 cp.git_cmd = 1;
274 cp.no_stderr = 1;
275
276 argv_array_push(&cp.args, "describe");
277 argv_array_pushv(&cp.args, *d);
278 argv_array_push(&cp.args, object_id);
279
280 if (!capture_command(&cp, &sb, 0)) {
281 strbuf_strip_suffix(&sb, "\n");
282 return strbuf_detach(&sb, NULL);
283 }
284 }
285
286 strbuf_release(&sb);
287 return NULL;
288 }
289
290 struct module_list {
291 const struct cache_entry **entries;
292 int alloc, nr;
293 };
294 #define MODULE_LIST_INIT { NULL, 0, 0 }
295
296 static int module_list_compute(int argc, const char **argv,
297 const char *prefix,
298 struct pathspec *pathspec,
299 struct module_list *list)
300 {
301 int i, result = 0;
302 char *ps_matched = NULL;
303 parse_pathspec(pathspec, 0,
304 PATHSPEC_PREFER_FULL,
305 prefix, argv);
306
307 if (pathspec->nr)
308 ps_matched = xcalloc(pathspec->nr, 1);
309
310 if (read_cache() < 0)
311 die(_("index file corrupt"));
312
313 for (i = 0; i < active_nr; i++) {
314 const struct cache_entry *ce = active_cache[i];
315
316 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
317 0, ps_matched, 1) ||
318 !S_ISGITLINK(ce->ce_mode))
319 continue;
320
321 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
322 list->entries[list->nr++] = ce;
323 while (i + 1 < active_nr &&
324 !strcmp(ce->name, active_cache[i + 1]->name))
325 /*
326 * Skip entries with the same name in different stages
327 * to make sure an entry is returned only once.
328 */
329 i++;
330 }
331
332 if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
333 result = -1;
334
335 free(ps_matched);
336
337 return result;
338 }
339
340 static void module_list_active(struct module_list *list)
341 {
342 int i;
343 struct module_list active_modules = MODULE_LIST_INIT;
344
345 for (i = 0; i < list->nr; i++) {
346 const struct cache_entry *ce = list->entries[i];
347
348 if (!is_submodule_active(the_repository, ce->name))
349 continue;
350
351 ALLOC_GROW(active_modules.entries,
352 active_modules.nr + 1,
353 active_modules.alloc);
354 active_modules.entries[active_modules.nr++] = ce;
355 }
356
357 free(list->entries);
358 *list = active_modules;
359 }
360
361 static int module_list(int argc, const char **argv, const char *prefix)
362 {
363 int i;
364 struct pathspec pathspec;
365 struct module_list list = MODULE_LIST_INIT;
366
367 struct option module_list_options[] = {
368 OPT_STRING(0, "prefix", &prefix,
369 N_("path"),
370 N_("alternative anchor for relative paths")),
371 OPT_END()
372 };
373
374 const char *const git_submodule_helper_usage[] = {
375 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
376 NULL
377 };
378
379 argc = parse_options(argc, argv, prefix, module_list_options,
380 git_submodule_helper_usage, 0);
381
382 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
383 return 1;
384
385 for (i = 0; i < list.nr; i++) {
386 const struct cache_entry *ce = list.entries[i];
387
388 if (ce_stage(ce))
389 printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
390 else
391 printf("%06o %s %d\t", ce->ce_mode,
392 oid_to_hex(&ce->oid), ce_stage(ce));
393
394 fprintf(stdout, "%s\n", ce->name);
395 }
396 return 0;
397 }
398
399 static void for_each_listed_submodule(const struct module_list *list,
400 each_submodule_fn fn, void *cb_data)
401 {
402 int i;
403 for (i = 0; i < list->nr; i++)
404 fn(list->entries[i], cb_data);
405 }
406
407 struct init_cb {
408 const char *prefix;
409 unsigned int flags;
410 };
411
412 #define INIT_CB_INIT { NULL, 0 }
413
414 static void init_submodule(const char *path, const char *prefix,
415 unsigned int flags)
416 {
417 const struct submodule *sub;
418 struct strbuf sb = STRBUF_INIT;
419 char *upd = NULL, *url = NULL, *displaypath;
420
421 displaypath = get_submodule_displaypath(path, prefix);
422
423 sub = submodule_from_path(&null_oid, path);
424
425 if (!sub)
426 die(_("No url found for submodule path '%s' in .gitmodules"),
427 displaypath);
428
429 /*
430 * NEEDSWORK: In a multi-working-tree world, this needs to be
431 * set in the per-worktree config.
432 *
433 * Set active flag for the submodule being initialized
434 */
435 if (!is_submodule_active(the_repository, path)) {
436 strbuf_addf(&sb, "submodule.%s.active", sub->name);
437 git_config_set_gently(sb.buf, "true");
438 strbuf_reset(&sb);
439 }
440
441 /*
442 * Copy url setting when it is not set yet.
443 * To look up the url in .git/config, we must not fall back to
444 * .gitmodules, so look it up directly.
445 */
446 strbuf_addf(&sb, "submodule.%s.url", sub->name);
447 if (git_config_get_string(sb.buf, &url)) {
448 if (!sub->url)
449 die(_("No url found for submodule path '%s' in .gitmodules"),
450 displaypath);
451
452 url = xstrdup(sub->url);
453
454 /* Possibly a url relative to parent */
455 if (starts_with_dot_dot_slash(url) ||
456 starts_with_dot_slash(url)) {
457 char *remoteurl, *relurl;
458 char *remote = get_default_remote();
459 struct strbuf remotesb = STRBUF_INIT;
460 strbuf_addf(&remotesb, "remote.%s.url", remote);
461 free(remote);
462
463 if (git_config_get_string(remotesb.buf, &remoteurl)) {
464 warning(_("could not lookup configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb.buf);
465 remoteurl = xgetcwd();
466 }
467 relurl = relative_url(remoteurl, url, NULL);
468 strbuf_release(&remotesb);
469 free(remoteurl);
470 free(url);
471 url = relurl;
472 }
473
474 if (git_config_set_gently(sb.buf, url))
475 die(_("Failed to register url for submodule path '%s'"),
476 displaypath);
477 if (!(flags & OPT_QUIET))
478 fprintf(stderr,
479 _("Submodule '%s' (%s) registered for path '%s'\n"),
480 sub->name, url, displaypath);
481 }
482 strbuf_reset(&sb);
483
484 /* Copy "update" setting when it is not set yet */
485 strbuf_addf(&sb, "submodule.%s.update", sub->name);
486 if (git_config_get_string(sb.buf, &upd) &&
487 sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
488 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
489 fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
490 sub->name);
491 upd = xstrdup("none");
492 } else
493 upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
494
495 if (git_config_set_gently(sb.buf, upd))
496 die(_("Failed to register update mode for submodule path '%s'"), displaypath);
497 }
498 strbuf_release(&sb);
499 free(displaypath);
500 free(url);
501 free(upd);
502 }
503
504 static void init_submodule_cb(const struct cache_entry *list_item, void *cb_data)
505 {
506 struct init_cb *info = cb_data;
507 init_submodule(list_item->name, info->prefix, info->flags);
508 }
509
510 static int module_init(int argc, const char **argv, const char *prefix)
511 {
512 struct init_cb info = INIT_CB_INIT;
513 struct pathspec pathspec;
514 struct module_list list = MODULE_LIST_INIT;
515 int quiet = 0;
516
517 struct option module_init_options[] = {
518 OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
519 OPT_END()
520 };
521
522 const char *const git_submodule_helper_usage[] = {
523 N_("git submodule--helper init [<path>]"),
524 NULL
525 };
526
527 argc = parse_options(argc, argv, prefix, module_init_options,
528 git_submodule_helper_usage, 0);
529
530 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
531 return 1;
532
533 /*
534 * If there are no path args and submodule.active is set then,
535 * by default, only initialize 'active' modules.
536 */
537 if (!argc && git_config_get_value_multi("submodule.active"))
538 module_list_active(&list);
539
540 info.prefix = prefix;
541 if (quiet)
542 info.flags |= OPT_QUIET;
543
544 for_each_listed_submodule(&list, init_submodule_cb, &info);
545
546 return 0;
547 }
548
549 struct status_cb {
550 const char *prefix;
551 unsigned int flags;
552 };
553
554 #define STATUS_CB_INIT { NULL, 0 }
555
556 static void print_status(unsigned int flags, char state, const char *path,
557 const struct object_id *oid, const char *displaypath)
558 {
559 if (flags & OPT_QUIET)
560 return;
561
562 printf("%c%s %s", state, oid_to_hex(oid), displaypath);
563
564 if (state == ' ' || state == '+')
565 printf(" (%s)", compute_rev_name(path, oid_to_hex(oid)));
566
567 printf("\n");
568 }
569
570 static int handle_submodule_head_ref(const char *refname,
571 const struct object_id *oid, int flags,
572 void *cb_data)
573 {
574 struct object_id *output = cb_data;
575 if (oid)
576 oidcpy(output, oid);
577
578 return 0;
579 }
580
581 static void status_submodule(const char *path, const struct object_id *ce_oid,
582 unsigned int ce_flags, const char *prefix,
583 unsigned int flags)
584 {
585 char *displaypath;
586 struct argv_array diff_files_args = ARGV_ARRAY_INIT;
587 struct rev_info rev;
588 int diff_files_result;
589
590 if (!submodule_from_path(&null_oid, path))
591 die(_("no submodule mapping found in .gitmodules for path '%s'"),
592 path);
593
594 displaypath = get_submodule_displaypath(path, prefix);
595
596 if ((CE_STAGEMASK & ce_flags) >> CE_STAGESHIFT) {
597 print_status(flags, 'U', path, &null_oid, displaypath);
598 goto cleanup;
599 }
600
601 if (!is_submodule_active(the_repository, path)) {
602 print_status(flags, '-', path, ce_oid, displaypath);
603 goto cleanup;
604 }
605
606 argv_array_pushl(&diff_files_args, "diff-files",
607 "--ignore-submodules=dirty", "--quiet", "--",
608 path, NULL);
609
610 git_config(git_diff_basic_config, NULL);
611 init_revisions(&rev, prefix);
612 rev.abbrev = 0;
613 diff_files_args.argc = setup_revisions(diff_files_args.argc,
614 diff_files_args.argv,
615 &rev, NULL);
616 diff_files_result = run_diff_files(&rev, 0);
617
618 if (!diff_result_code(&rev.diffopt, diff_files_result)) {
619 print_status(flags, ' ', path, ce_oid,
620 displaypath);
621 } else if (!(flags & OPT_CACHED)) {
622 struct object_id oid;
623
624 if (refs_head_ref(get_submodule_ref_store(path),
625 handle_submodule_head_ref, &oid))
626 die(_("could not resolve HEAD ref inside the "
627 "submodule '%s'"), path);
628
629 print_status(flags, '+', path, &oid, displaypath);
630 } else {
631 print_status(flags, '+', path, ce_oid, displaypath);
632 }
633
634 if (flags & OPT_RECURSIVE) {
635 struct child_process cpr = CHILD_PROCESS_INIT;
636
637 cpr.git_cmd = 1;
638 cpr.dir = path;
639 prepare_submodule_repo_env(&cpr.env_array);
640
641 argv_array_push(&cpr.args, "--super-prefix");
642 argv_array_pushf(&cpr.args, "%s/", displaypath);
643 argv_array_pushl(&cpr.args, "submodule--helper", "status",
644 "--recursive", NULL);
645
646 if (flags & OPT_CACHED)
647 argv_array_push(&cpr.args, "--cached");
648
649 if (flags & OPT_QUIET)
650 argv_array_push(&cpr.args, "--quiet");
651
652 if (run_command(&cpr))
653 die(_("failed to recurse into submodule '%s'"), path);
654 }
655
656 cleanup:
657 argv_array_clear(&diff_files_args);
658 free(displaypath);
659 }
660
661 static void status_submodule_cb(const struct cache_entry *list_item,
662 void *cb_data)
663 {
664 struct status_cb *info = cb_data;
665 status_submodule(list_item->name, &list_item->oid, list_item->ce_flags,
666 info->prefix, info->flags);
667 }
668
669 static int module_status(int argc, const char **argv, const char *prefix)
670 {
671 struct status_cb info = STATUS_CB_INIT;
672 struct pathspec pathspec;
673 struct module_list list = MODULE_LIST_INIT;
674 int quiet = 0;
675
676 struct option module_status_options[] = {
677 OPT__QUIET(&quiet, N_("Suppress submodule status output")),
678 OPT_BIT(0, "cached", &info.flags, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED),
679 OPT_BIT(0, "recursive", &info.flags, N_("recurse into nested submodules"), OPT_RECURSIVE),
680 OPT_END()
681 };
682
683 const char *const git_submodule_helper_usage[] = {
684 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
685 NULL
686 };
687
688 argc = parse_options(argc, argv, prefix, module_status_options,
689 git_submodule_helper_usage, 0);
690
691 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
692 return 1;
693
694 info.prefix = prefix;
695 if (quiet)
696 info.flags |= OPT_QUIET;
697
698 for_each_listed_submodule(&list, status_submodule_cb, &info);
699
700 return 0;
701 }
702
703 static int module_name(int argc, const char **argv, const char *prefix)
704 {
705 const struct submodule *sub;
706
707 if (argc != 2)
708 usage(_("git submodule--helper name <path>"));
709
710 sub = submodule_from_path(&null_oid, argv[1]);
711
712 if (!sub)
713 die(_("no submodule mapping found in .gitmodules for path '%s'"),
714 argv[1]);
715
716 printf("%s\n", sub->name);
717
718 return 0;
719 }
720
721 static int clone_submodule(const char *path, const char *gitdir, const char *url,
722 const char *depth, struct string_list *reference,
723 int quiet, int progress)
724 {
725 struct child_process cp = CHILD_PROCESS_INIT;
726
727 argv_array_push(&cp.args, "clone");
728 argv_array_push(&cp.args, "--no-checkout");
729 if (quiet)
730 argv_array_push(&cp.args, "--quiet");
731 if (progress)
732 argv_array_push(&cp.args, "--progress");
733 if (depth && *depth)
734 argv_array_pushl(&cp.args, "--depth", depth, NULL);
735 if (reference->nr) {
736 struct string_list_item *item;
737 for_each_string_list_item(item, reference)
738 argv_array_pushl(&cp.args, "--reference",
739 item->string, NULL);
740 }
741 if (gitdir && *gitdir)
742 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
743
744 argv_array_push(&cp.args, "--");
745 argv_array_push(&cp.args, url);
746 argv_array_push(&cp.args, path);
747
748 cp.git_cmd = 1;
749 prepare_submodule_repo_env(&cp.env_array);
750 cp.no_stdin = 1;
751
752 return run_command(&cp);
753 }
754
755 struct submodule_alternate_setup {
756 const char *submodule_name;
757 enum SUBMODULE_ALTERNATE_ERROR_MODE {
758 SUBMODULE_ALTERNATE_ERROR_DIE,
759 SUBMODULE_ALTERNATE_ERROR_INFO,
760 SUBMODULE_ALTERNATE_ERROR_IGNORE
761 } error_mode;
762 struct string_list *reference;
763 };
764 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
765 SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
766
767 static int add_possible_reference_from_superproject(
768 struct alternate_object_database *alt, void *sas_cb)
769 {
770 struct submodule_alternate_setup *sas = sas_cb;
771
772 /*
773 * If the alternate object store is another repository, try the
774 * standard layout with .git/(modules/<name>)+/objects
775 */
776 if (ends_with(alt->path, "/objects")) {
777 char *sm_alternate;
778 struct strbuf sb = STRBUF_INIT;
779 struct strbuf err = STRBUF_INIT;
780 strbuf_add(&sb, alt->path, strlen(alt->path) - strlen("objects"));
781
782 /*
783 * We need to end the new path with '/' to mark it as a dir,
784 * otherwise a submodule name containing '/' will be broken
785 * as the last part of a missing submodule reference would
786 * be taken as a file name.
787 */
788 strbuf_addf(&sb, "modules/%s/", sas->submodule_name);
789
790 sm_alternate = compute_alternate_path(sb.buf, &err);
791 if (sm_alternate) {
792 string_list_append(sas->reference, xstrdup(sb.buf));
793 free(sm_alternate);
794 } else {
795 switch (sas->error_mode) {
796 case SUBMODULE_ALTERNATE_ERROR_DIE:
797 die(_("submodule '%s' cannot add alternate: %s"),
798 sas->submodule_name, err.buf);
799 case SUBMODULE_ALTERNATE_ERROR_INFO:
800 fprintf(stderr, _("submodule '%s' cannot add alternate: %s"),
801 sas->submodule_name, err.buf);
802 case SUBMODULE_ALTERNATE_ERROR_IGNORE:
803 ; /* nothing */
804 }
805 }
806 strbuf_release(&sb);
807 }
808
809 return 0;
810 }
811
812 static void prepare_possible_alternates(const char *sm_name,
813 struct string_list *reference)
814 {
815 char *sm_alternate = NULL, *error_strategy = NULL;
816 struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
817
818 git_config_get_string("submodule.alternateLocation", &sm_alternate);
819 if (!sm_alternate)
820 return;
821
822 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
823
824 if (!error_strategy)
825 error_strategy = xstrdup("die");
826
827 sas.submodule_name = sm_name;
828 sas.reference = reference;
829 if (!strcmp(error_strategy, "die"))
830 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
831 else if (!strcmp(error_strategy, "info"))
832 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
833 else if (!strcmp(error_strategy, "ignore"))
834 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
835 else
836 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
837
838 if (!strcmp(sm_alternate, "superproject"))
839 foreach_alt_odb(add_possible_reference_from_superproject, &sas);
840 else if (!strcmp(sm_alternate, "no"))
841 ; /* do nothing */
842 else
843 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
844
845 free(sm_alternate);
846 free(error_strategy);
847 }
848
849 static int module_clone(int argc, const char **argv, const char *prefix)
850 {
851 const char *name = NULL, *url = NULL, *depth = NULL;
852 int quiet = 0;
853 int progress = 0;
854 char *p, *path = NULL, *sm_gitdir;
855 struct strbuf sb = STRBUF_INIT;
856 struct string_list reference = STRING_LIST_INIT_NODUP;
857 char *sm_alternate = NULL, *error_strategy = NULL;
858
859 struct option module_clone_options[] = {
860 OPT_STRING(0, "prefix", &prefix,
861 N_("path"),
862 N_("alternative anchor for relative paths")),
863 OPT_STRING(0, "path", &path,
864 N_("path"),
865 N_("where the new submodule will be cloned to")),
866 OPT_STRING(0, "name", &name,
867 N_("string"),
868 N_("name of the new submodule")),
869 OPT_STRING(0, "url", &url,
870 N_("string"),
871 N_("url where to clone the submodule from")),
872 OPT_STRING_LIST(0, "reference", &reference,
873 N_("repo"),
874 N_("reference repository")),
875 OPT_STRING(0, "depth", &depth,
876 N_("string"),
877 N_("depth for shallow clones")),
878 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
879 OPT_BOOL(0, "progress", &progress,
880 N_("force cloning progress")),
881 OPT_END()
882 };
883
884 const char *const git_submodule_helper_usage[] = {
885 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
886 "[--reference <repository>] [--name <name>] [--depth <depth>] "
887 "--url <url> --path <path>"),
888 NULL
889 };
890
891 argc = parse_options(argc, argv, prefix, module_clone_options,
892 git_submodule_helper_usage, 0);
893
894 if (argc || !url || !path || !*path)
895 usage_with_options(git_submodule_helper_usage,
896 module_clone_options);
897
898 strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
899 sm_gitdir = absolute_pathdup(sb.buf);
900 strbuf_reset(&sb);
901
902 if (!is_absolute_path(path)) {
903 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
904 path = strbuf_detach(&sb, NULL);
905 } else
906 path = xstrdup(path);
907
908 if (!file_exists(sm_gitdir)) {
909 if (safe_create_leading_directories_const(sm_gitdir) < 0)
910 die(_("could not create directory '%s'"), sm_gitdir);
911
912 prepare_possible_alternates(name, &reference);
913
914 if (clone_submodule(path, sm_gitdir, url, depth, &reference,
915 quiet, progress))
916 die(_("clone of '%s' into submodule path '%s' failed"),
917 url, path);
918 } else {
919 if (safe_create_leading_directories_const(path) < 0)
920 die(_("could not create directory '%s'"), path);
921 strbuf_addf(&sb, "%s/index", sm_gitdir);
922 unlink_or_warn(sb.buf);
923 strbuf_reset(&sb);
924 }
925
926 /* Connect module worktree and git dir */
927 connect_work_tree_and_git_dir(path, sm_gitdir);
928
929 p = git_pathdup_submodule(path, "config");
930 if (!p)
931 die(_("could not get submodule directory for '%s'"), path);
932
933 /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
934 git_config_get_string("submodule.alternateLocation", &sm_alternate);
935 if (sm_alternate)
936 git_config_set_in_file(p, "submodule.alternateLocation",
937 sm_alternate);
938 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
939 if (error_strategy)
940 git_config_set_in_file(p, "submodule.alternateErrorStrategy",
941 error_strategy);
942
943 free(sm_alternate);
944 free(error_strategy);
945
946 strbuf_release(&sb);
947 free(sm_gitdir);
948 free(path);
949 free(p);
950 return 0;
951 }
952
953 struct submodule_update_clone {
954 /* index into 'list', the list of submodules to look into for cloning */
955 int current;
956 struct module_list list;
957 unsigned warn_if_uninitialized : 1;
958
959 /* update parameter passed via commandline */
960 struct submodule_update_strategy update;
961
962 /* configuration parameters which are passed on to the children */
963 int progress;
964 int quiet;
965 int recommend_shallow;
966 struct string_list references;
967 const char *depth;
968 const char *recursive_prefix;
969 const char *prefix;
970
971 /* Machine-readable status lines to be consumed by git-submodule.sh */
972 struct string_list projectlines;
973
974 /* If we want to stop as fast as possible and return an error */
975 unsigned quickstop : 1;
976
977 /* failed clones to be retried again */
978 const struct cache_entry **failed_clones;
979 int failed_clones_nr, failed_clones_alloc;
980 };
981 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
982 SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, \
983 NULL, NULL, NULL, \
984 STRING_LIST_INIT_DUP, 0, NULL, 0, 0}
985
986
987 static void next_submodule_warn_missing(struct submodule_update_clone *suc,
988 struct strbuf *out, const char *displaypath)
989 {
990 /*
991 * Only mention uninitialized submodules when their
992 * paths have been specified.
993 */
994 if (suc->warn_if_uninitialized) {
995 strbuf_addf(out,
996 _("Submodule path '%s' not initialized"),
997 displaypath);
998 strbuf_addch(out, '\n');
999 strbuf_addstr(out,
1000 _("Maybe you want to use 'update --init'?"));
1001 strbuf_addch(out, '\n');
1002 }
1003 }
1004
1005 /**
1006 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1007 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1008 */
1009 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
1010 struct child_process *child,
1011 struct submodule_update_clone *suc,
1012 struct strbuf *out)
1013 {
1014 const struct submodule *sub = NULL;
1015 const char *url = NULL;
1016 const char *update_string;
1017 enum submodule_update_type update_type;
1018 char *key;
1019 struct strbuf displaypath_sb = STRBUF_INIT;
1020 struct strbuf sb = STRBUF_INIT;
1021 const char *displaypath = NULL;
1022 int needs_cloning = 0;
1023
1024 if (ce_stage(ce)) {
1025 if (suc->recursive_prefix)
1026 strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
1027 else
1028 strbuf_addstr(&sb, ce->name);
1029 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
1030 strbuf_addch(out, '\n');
1031 goto cleanup;
1032 }
1033
1034 sub = submodule_from_path(&null_oid, ce->name);
1035
1036 if (suc->recursive_prefix)
1037 displaypath = relative_path(suc->recursive_prefix,
1038 ce->name, &displaypath_sb);
1039 else
1040 displaypath = ce->name;
1041
1042 if (!sub) {
1043 next_submodule_warn_missing(suc, out, displaypath);
1044 goto cleanup;
1045 }
1046
1047 key = xstrfmt("submodule.%s.update", sub->name);
1048 if (!repo_config_get_string_const(the_repository, key, &update_string)) {
1049 update_type = parse_submodule_update_type(update_string);
1050 } else {
1051 update_type = sub->update_strategy.type;
1052 }
1053 free(key);
1054
1055 if (suc->update.type == SM_UPDATE_NONE
1056 || (suc->update.type == SM_UPDATE_UNSPECIFIED
1057 && update_type == SM_UPDATE_NONE)) {
1058 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
1059 strbuf_addch(out, '\n');
1060 goto cleanup;
1061 }
1062
1063 /* Check if the submodule has been initialized. */
1064 if (!is_submodule_active(the_repository, ce->name)) {
1065 next_submodule_warn_missing(suc, out, displaypath);
1066 goto cleanup;
1067 }
1068
1069 strbuf_reset(&sb);
1070 strbuf_addf(&sb, "submodule.%s.url", sub->name);
1071 if (repo_config_get_string_const(the_repository, sb.buf, &url))
1072 url = sub->url;
1073
1074 strbuf_reset(&sb);
1075 strbuf_addf(&sb, "%s/.git", ce->name);
1076 needs_cloning = !file_exists(sb.buf);
1077
1078 strbuf_reset(&sb);
1079 strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
1080 oid_to_hex(&ce->oid), ce_stage(ce),
1081 needs_cloning, ce->name);
1082 string_list_append(&suc->projectlines, sb.buf);
1083
1084 if (!needs_cloning)
1085 goto cleanup;
1086
1087 child->git_cmd = 1;
1088 child->no_stdin = 1;
1089 child->stdout_to_stderr = 1;
1090 child->err = -1;
1091 argv_array_push(&child->args, "submodule--helper");
1092 argv_array_push(&child->args, "clone");
1093 if (suc->progress)
1094 argv_array_push(&child->args, "--progress");
1095 if (suc->quiet)
1096 argv_array_push(&child->args, "--quiet");
1097 if (suc->prefix)
1098 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
1099 if (suc->recommend_shallow && sub->recommend_shallow == 1)
1100 argv_array_push(&child->args, "--depth=1");
1101 argv_array_pushl(&child->args, "--path", sub->path, NULL);
1102 argv_array_pushl(&child->args, "--name", sub->name, NULL);
1103 argv_array_pushl(&child->args, "--url", url, NULL);
1104 if (suc->references.nr) {
1105 struct string_list_item *item;
1106 for_each_string_list_item(item, &suc->references)
1107 argv_array_pushl(&child->args, "--reference", item->string, NULL);
1108 }
1109 if (suc->depth)
1110 argv_array_push(&child->args, suc->depth);
1111
1112 cleanup:
1113 strbuf_reset(&displaypath_sb);
1114 strbuf_reset(&sb);
1115
1116 return needs_cloning;
1117 }
1118
1119 static int update_clone_get_next_task(struct child_process *child,
1120 struct strbuf *err,
1121 void *suc_cb,
1122 void **idx_task_cb)
1123 {
1124 struct submodule_update_clone *suc = suc_cb;
1125 const struct cache_entry *ce;
1126 int index;
1127
1128 for (; suc->current < suc->list.nr; suc->current++) {
1129 ce = suc->list.entries[suc->current];
1130 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
1131 int *p = xmalloc(sizeof(*p));
1132 *p = suc->current;
1133 *idx_task_cb = p;
1134 suc->current++;
1135 return 1;
1136 }
1137 }
1138
1139 /*
1140 * The loop above tried cloning each submodule once, now try the
1141 * stragglers again, which we can imagine as an extension of the
1142 * entry list.
1143 */
1144 index = suc->current - suc->list.nr;
1145 if (index < suc->failed_clones_nr) {
1146 int *p;
1147 ce = suc->failed_clones[index];
1148 if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
1149 suc->current ++;
1150 strbuf_addstr(err, "BUG: submodule considered for "
1151 "cloning, doesn't need cloning "
1152 "any more?\n");
1153 return 0;
1154 }
1155 p = xmalloc(sizeof(*p));
1156 *p = suc->current;
1157 *idx_task_cb = p;
1158 suc->current ++;
1159 return 1;
1160 }
1161
1162 return 0;
1163 }
1164
1165 static int update_clone_start_failure(struct strbuf *err,
1166 void *suc_cb,
1167 void *idx_task_cb)
1168 {
1169 struct submodule_update_clone *suc = suc_cb;
1170 suc->quickstop = 1;
1171 return 1;
1172 }
1173
1174 static int update_clone_task_finished(int result,
1175 struct strbuf *err,
1176 void *suc_cb,
1177 void *idx_task_cb)
1178 {
1179 const struct cache_entry *ce;
1180 struct submodule_update_clone *suc = suc_cb;
1181
1182 int *idxP = idx_task_cb;
1183 int idx = *idxP;
1184 free(idxP);
1185
1186 if (!result)
1187 return 0;
1188
1189 if (idx < suc->list.nr) {
1190 ce = suc->list.entries[idx];
1191 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
1192 ce->name);
1193 strbuf_addch(err, '\n');
1194 ALLOC_GROW(suc->failed_clones,
1195 suc->failed_clones_nr + 1,
1196 suc->failed_clones_alloc);
1197 suc->failed_clones[suc->failed_clones_nr++] = ce;
1198 return 0;
1199 } else {
1200 idx -= suc->list.nr;
1201 ce = suc->failed_clones[idx];
1202 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
1203 ce->name);
1204 strbuf_addch(err, '\n');
1205 suc->quickstop = 1;
1206 return 1;
1207 }
1208
1209 return 0;
1210 }
1211
1212 static int gitmodules_update_clone_config(const char *var, const char *value,
1213 void *cb)
1214 {
1215 int *max_jobs = cb;
1216 if (!strcmp(var, "submodule.fetchjobs"))
1217 *max_jobs = parse_submodule_fetchjobs(var, value);
1218 return 0;
1219 }
1220
1221 static int update_clone(int argc, const char **argv, const char *prefix)
1222 {
1223 const char *update = NULL;
1224 int max_jobs = 1;
1225 struct string_list_item *item;
1226 struct pathspec pathspec;
1227 struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
1228
1229 struct option module_update_clone_options[] = {
1230 OPT_STRING(0, "prefix", &prefix,
1231 N_("path"),
1232 N_("path into the working tree")),
1233 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
1234 N_("path"),
1235 N_("path into the working tree, across nested "
1236 "submodule boundaries")),
1237 OPT_STRING(0, "update", &update,
1238 N_("string"),
1239 N_("rebase, merge, checkout or none")),
1240 OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
1241 N_("reference repository")),
1242 OPT_STRING(0, "depth", &suc.depth, "<depth>",
1243 N_("Create a shallow clone truncated to the "
1244 "specified number of revisions")),
1245 OPT_INTEGER('j', "jobs", &max_jobs,
1246 N_("parallel jobs")),
1247 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
1248 N_("whether the initial clone should follow the shallow recommendation")),
1249 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
1250 OPT_BOOL(0, "progress", &suc.progress,
1251 N_("force cloning progress")),
1252 OPT_END()
1253 };
1254
1255 const char *const git_submodule_helper_usage[] = {
1256 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
1257 NULL
1258 };
1259 suc.prefix = prefix;
1260
1261 config_from_gitmodules(gitmodules_update_clone_config, &max_jobs);
1262 git_config(gitmodules_update_clone_config, &max_jobs);
1263
1264 argc = parse_options(argc, argv, prefix, module_update_clone_options,
1265 git_submodule_helper_usage, 0);
1266
1267 if (update)
1268 if (parse_submodule_update_strategy(update, &suc.update) < 0)
1269 die(_("bad value for update parameter"));
1270
1271 if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
1272 return 1;
1273
1274 if (pathspec.nr)
1275 suc.warn_if_uninitialized = 1;
1276
1277 run_processes_parallel(max_jobs,
1278 update_clone_get_next_task,
1279 update_clone_start_failure,
1280 update_clone_task_finished,
1281 &suc);
1282
1283 /*
1284 * We saved the output and put it out all at once now.
1285 * That means:
1286 * - the listener does not have to interleave their (checkout)
1287 * work with our fetching. The writes involved in a
1288 * checkout involve more straightforward sequential I/O.
1289 * - the listener can avoid doing any work if fetching failed.
1290 */
1291 if (suc.quickstop)
1292 return 1;
1293
1294 for_each_string_list_item(item, &suc.projectlines)
1295 fprintf(stdout, "%s", item->string);
1296
1297 return 0;
1298 }
1299
1300 static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1301 {
1302 struct strbuf sb = STRBUF_INIT;
1303 if (argc != 3)
1304 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1305
1306 printf("%s", relative_path(argv[1], argv[2], &sb));
1307 strbuf_release(&sb);
1308 return 0;
1309 }
1310
1311 static const char *remote_submodule_branch(const char *path)
1312 {
1313 const struct submodule *sub;
1314 const char *branch = NULL;
1315 char *key;
1316
1317 sub = submodule_from_path(&null_oid, path);
1318 if (!sub)
1319 return NULL;
1320
1321 key = xstrfmt("submodule.%s.branch", sub->name);
1322 if (repo_config_get_string_const(the_repository, key, &branch))
1323 branch = sub->branch;
1324 free(key);
1325
1326 if (!branch)
1327 return "master";
1328
1329 if (!strcmp(branch, ".")) {
1330 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1331
1332 if (!refname)
1333 die(_("No such ref: %s"), "HEAD");
1334
1335 /* detached HEAD */
1336 if (!strcmp(refname, "HEAD"))
1337 die(_("Submodule (%s) branch configured to inherit "
1338 "branch from superproject, but the superproject "
1339 "is not on any branch"), sub->name);
1340
1341 if (!skip_prefix(refname, "refs/heads/", &refname))
1342 die(_("Expecting a full ref name, got %s"), refname);
1343 return refname;
1344 }
1345
1346 return branch;
1347 }
1348
1349 static int resolve_remote_submodule_branch(int argc, const char **argv,
1350 const char *prefix)
1351 {
1352 const char *ret;
1353 struct strbuf sb = STRBUF_INIT;
1354 if (argc != 2)
1355 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1356
1357 ret = remote_submodule_branch(argv[1]);
1358 if (!ret)
1359 die("submodule %s doesn't exist", argv[1]);
1360
1361 printf("%s", ret);
1362 strbuf_release(&sb);
1363 return 0;
1364 }
1365
1366 static int push_check(int argc, const char **argv, const char *prefix)
1367 {
1368 struct remote *remote;
1369 const char *superproject_head;
1370 char *head;
1371 int detached_head = 0;
1372 struct object_id head_oid;
1373
1374 if (argc < 3)
1375 die("submodule--helper push-check requires at least 2 arguments");
1376
1377 /*
1378 * superproject's resolved head ref.
1379 * if HEAD then the superproject is in a detached head state, otherwise
1380 * it will be the resolved head ref.
1381 */
1382 superproject_head = argv[1];
1383 argv++;
1384 argc--;
1385 /* Get the submodule's head ref and determine if it is detached */
1386 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1387 if (!head)
1388 die(_("Failed to resolve HEAD as a valid ref."));
1389 if (!strcmp(head, "HEAD"))
1390 detached_head = 1;
1391
1392 /*
1393 * The remote must be configured.
1394 * This is to avoid pushing to the exact same URL as the parent.
1395 */
1396 remote = pushremote_get(argv[1]);
1397 if (!remote || remote->origin == REMOTE_UNCONFIGURED)
1398 die("remote '%s' not configured", argv[1]);
1399
1400 /* Check the refspec */
1401 if (argc > 2) {
1402 int i, refspec_nr = argc - 2;
1403 struct ref *local_refs = get_local_heads();
1404 struct refspec *refspec = parse_push_refspec(refspec_nr,
1405 argv + 2);
1406
1407 for (i = 0; i < refspec_nr; i++) {
1408 struct refspec *rs = refspec + i;
1409
1410 if (rs->pattern || rs->matching)
1411 continue;
1412
1413 /* LHS must match a single ref */
1414 switch (count_refspec_match(rs->src, local_refs, NULL)) {
1415 case 1:
1416 break;
1417 case 0:
1418 /*
1419 * If LHS matches 'HEAD' then we need to ensure
1420 * that it matches the same named branch
1421 * checked out in the superproject.
1422 */
1423 if (!strcmp(rs->src, "HEAD")) {
1424 if (!detached_head &&
1425 !strcmp(head, superproject_head))
1426 break;
1427 die("HEAD does not match the named branch in the superproject");
1428 }
1429 /* fallthrough */
1430 default:
1431 die("src refspec '%s' must name a ref",
1432 rs->src);
1433 }
1434 }
1435 free_refspec(refspec_nr, refspec);
1436 }
1437 free(head);
1438
1439 return 0;
1440 }
1441
1442 static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
1443 {
1444 int i;
1445 struct pathspec pathspec;
1446 struct module_list list = MODULE_LIST_INIT;
1447 unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
1448
1449 struct option embed_gitdir_options[] = {
1450 OPT_STRING(0, "prefix", &prefix,
1451 N_("path"),
1452 N_("path into the working tree")),
1453 OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
1454 ABSORB_GITDIR_RECURSE_SUBMODULES),
1455 OPT_END()
1456 };
1457
1458 const char *const git_submodule_helper_usage[] = {
1459 N_("git submodule--helper embed-git-dir [<path>...]"),
1460 NULL
1461 };
1462
1463 argc = parse_options(argc, argv, prefix, embed_gitdir_options,
1464 git_submodule_helper_usage, 0);
1465
1466 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1467 return 1;
1468
1469 for (i = 0; i < list.nr; i++)
1470 absorb_git_dir_into_superproject(prefix,
1471 list.entries[i]->name, flags);
1472
1473 return 0;
1474 }
1475
1476 static int is_active(int argc, const char **argv, const char *prefix)
1477 {
1478 if (argc != 2)
1479 die("submodule--helper is-active takes exactly 1 argument");
1480
1481 return !is_submodule_active(the_repository, argv[1]);
1482 }
1483
1484 /*
1485 * Exit non-zero if any of the submodule names given on the command line is
1486 * invalid. If no names are given, filter stdin to print only valid names
1487 * (which is primarily intended for testing).
1488 */
1489 static int check_name(int argc, const char **argv, const char *prefix)
1490 {
1491 if (argc > 1) {
1492 while (*++argv) {
1493 if (check_submodule_name(*argv) < 0)
1494 return 1;
1495 }
1496 } else {
1497 struct strbuf buf = STRBUF_INIT;
1498 while (strbuf_getline(&buf, stdin) != EOF) {
1499 if (!check_submodule_name(buf.buf))
1500 printf("%s\n", buf.buf);
1501 }
1502 strbuf_release(&buf);
1503 }
1504 return 0;
1505 }
1506
1507 #define SUPPORT_SUPER_PREFIX (1<<0)
1508
1509 struct cmd_struct {
1510 const char *cmd;
1511 int (*fn)(int, const char **, const char *);
1512 unsigned option;
1513 };
1514
1515 static struct cmd_struct commands[] = {
1516 {"list", module_list, 0},
1517 {"name", module_name, 0},
1518 {"clone", module_clone, 0},
1519 {"update-clone", update_clone, 0},
1520 {"relative-path", resolve_relative_path, 0},
1521 {"resolve-relative-url", resolve_relative_url, 0},
1522 {"resolve-relative-url-test", resolve_relative_url_test, 0},
1523 {"init", module_init, SUPPORT_SUPER_PREFIX},
1524 {"status", module_status, SUPPORT_SUPER_PREFIX},
1525 {"remote-branch", resolve_remote_submodule_branch, 0},
1526 {"push-check", push_check, 0},
1527 {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
1528 {"is-active", is_active, 0},
1529 {"check-name", check_name, 0},
1530 };
1531
1532 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
1533 {
1534 int i;
1535 if (argc < 2 || !strcmp(argv[1], "-h"))
1536 usage("git submodule--helper <command>");
1537
1538 for (i = 0; i < ARRAY_SIZE(commands); i++) {
1539 if (!strcmp(argv[1], commands[i].cmd)) {
1540 if (get_super_prefix() &&
1541 !(commands[i].option & SUPPORT_SUPER_PREFIX))
1542 die(_("%s doesn't support --super-prefix"),
1543 commands[i].cmd);
1544 return commands[i].fn(argc - 1, argv + 1, prefix);
1545 }
1546 }
1547
1548 die(_("'%s' is not a valid submodule--helper "
1549 "subcommand"), argv[1]);
1550 }