]> git.ipfire.org Git - thirdparty/git.git/blob - builtin/submodule--helper.c
projects / thirdparty / git.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge branch 'cb/skip-utf8-check-with-pcre1'
[thirdparty/git.git] / builtin / submodule--helper.c
1 #define USE_THE_INDEX_COMPATIBILITY_MACROS
2 #include "builtin.h"
3 #include "repository.h"
4 #include "cache.h"
5 #include "config.h"
6 #include "parse-options.h"
7 #include "quote.h"
8 #include "pathspec.h"
9 #include "dir.h"
10 #include "submodule.h"
11 #include "submodule-config.h"
12 #include "string-list.h"
13 #include "run-command.h"
14 #include "remote.h"
15 #include "refs.h"
16 #include "refspec.h"
17 #include "connect.h"
18 #include "revision.h"
19 #include "diffcore.h"
20 #include "diff.h"
21 #include "object-store.h"
22
23 #define OPT_QUIET (1 << 0)
24 #define OPT_CACHED (1 << 1)
25 #define OPT_RECURSIVE (1 << 2)
26 #define OPT_FORCE (1 << 3)
27
28 typedef void (*each_submodule_fn)(const struct cache_entry *list_item,
29 void *cb_data);
30
31 static char *get_default_remote(void)
32 {
33 char *dest = NULL, *ret;
34 struct strbuf sb = STRBUF_INIT;
35 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
36
37 if (!refname)
38 die(_("No such ref: %s"), "HEAD");
39
40 /* detached HEAD */
41 if (!strcmp(refname, "HEAD"))
42 return xstrdup("origin");
43
44 if (!skip_prefix(refname, "refs/heads/", &refname))
45 die(_("Expecting a full ref name, got %s"), refname);
46
47 strbuf_addf(&sb, "branch.%s.remote", refname);
48 if (git_config_get_string(sb.buf, &dest))
49 ret = xstrdup("origin");
50 else
51 ret = dest;
52
53 strbuf_release(&sb);
54 return ret;
55 }
56
57 static int print_default_remote(int argc, const char **argv, const char *prefix)
58 {
59 char *remote;
60
61 if (argc != 1)
62 die(_("submodule--helper print-default-remote takes no arguments"));
63
64 remote = get_default_remote();
65 if (remote)
66 printf("%s\n", remote);
67
68 free(remote);
69 return 0;
70 }
71
72 static int starts_with_dot_slash(const char *str)
73 {
74 return str[0] == '.' && is_dir_sep(str[1]);
75 }
76
77 static int starts_with_dot_dot_slash(const char *str)
78 {
79 return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
80 }
81
82 /*
83 * Returns 1 if it was the last chop before ':'.
84 */
85 static int chop_last_dir(char **remoteurl, int is_relative)
86 {
87 char *rfind = find_last_dir_sep(*remoteurl);
88 if (rfind) {
89 *rfind = '\0';
90 return 0;
91 }
92
93 rfind = strrchr(*remoteurl, ':');
94 if (rfind) {
95 *rfind = '\0';
96 return 1;
97 }
98
99 if (is_relative || !strcmp(".", *remoteurl))
100 die(_("cannot strip one component off url '%s'"),
101 *remoteurl);
102
103 free(*remoteurl);
104 *remoteurl = xstrdup(".");
105 return 0;
106 }
107
108 /*
109 * The `url` argument is the URL that navigates to the submodule origin
110 * repo. When relative, this URL is relative to the superproject origin
111 * URL repo. The `up_path` argument, if specified, is the relative
112 * path that navigates from the submodule working tree to the superproject
113 * working tree. Returns the origin URL of the submodule.
114 *
115 * Return either an absolute URL or filesystem path (if the superproject
116 * origin URL is an absolute URL or filesystem path, respectively) or a
117 * relative file system path (if the superproject origin URL is a relative
118 * file system path).
119 *
120 * When the output is a relative file system path, the path is either
121 * relative to the submodule working tree, if up_path is specified, or to
122 * the superproject working tree otherwise.
123 *
124 * NEEDSWORK: This works incorrectly on the domain and protocol part.
125 * remote_url url outcome expectation
126 * http://a.com/b ../c http://a.com/c as is
127 * http://a.com/b/ ../c http://a.com/c same as previous line, but
128 * ignore trailing slash in url
129 * http://a.com/b ../../c http://c error out
130 * http://a.com/b ../../../c http:/c error out
131 * http://a.com/b ../../../../c http:c error out
132 * http://a.com/b ../../../../../c .:c error out
133 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
134 * when a local part has a colon in its path component, too.
135 */
136 static char *relative_url(const char *remote_url,
137 const char *url,
138 const char *up_path)
139 {
140 int is_relative = 0;
141 int colonsep = 0;
142 char *out;
143 char *remoteurl = xstrdup(remote_url);
144 struct strbuf sb = STRBUF_INIT;
145 size_t len = strlen(remoteurl);
146
147 if (is_dir_sep(remoteurl[len-1]))
148 remoteurl[len-1] = '\0';
149
150 if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
151 is_relative = 0;
152 else {
153 is_relative = 1;
154 /*
155 * Prepend a './' to ensure all relative
156 * remoteurls start with './' or '../'
157 */
158 if (!starts_with_dot_slash(remoteurl) &&
159 !starts_with_dot_dot_slash(remoteurl)) {
160 strbuf_reset(&sb);
161 strbuf_addf(&sb, "./%s", remoteurl);
162 free(remoteurl);
163 remoteurl = strbuf_detach(&sb, NULL);
164 }
165 }
166 /*
167 * When the url starts with '../', remove that and the
168 * last directory in remoteurl.
169 */
170 while (url) {
171 if (starts_with_dot_dot_slash(url)) {
172 url += 3;
173 colonsep |= chop_last_dir(&remoteurl, is_relative);
174 } else if (starts_with_dot_slash(url))
175 url += 2;
176 else
177 break;
178 }
179 strbuf_reset(&sb);
180 strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
181 if (ends_with(url, "/"))
182 strbuf_setlen(&sb, sb.len - 1);
183 free(remoteurl);
184
185 if (starts_with_dot_slash(sb.buf))
186 out = xstrdup(sb.buf + 2);
187 else
188 out = xstrdup(sb.buf);
189 strbuf_reset(&sb);
190
191 if (!up_path || !is_relative)
192 return out;
193
194 strbuf_addf(&sb, "%s%s", up_path, out);
195 free(out);
196 return strbuf_detach(&sb, NULL);
197 }
198
199 static int resolve_relative_url(int argc, const char **argv, const char *prefix)
200 {
201 char *remoteurl = NULL;
202 char *remote = get_default_remote();
203 const char *up_path = NULL;
204 char *res;
205 const char *url;
206 struct strbuf sb = STRBUF_INIT;
207
208 if (argc != 2 && argc != 3)
209 die("resolve-relative-url only accepts one or two arguments");
210
211 url = argv[1];
212 strbuf_addf(&sb, "remote.%s.url", remote);
213 free(remote);
214
215 if (git_config_get_string(sb.buf, &remoteurl))
216 /* the repository is its own authoritative upstream */
217 remoteurl = xgetcwd();
218
219 if (argc == 3)
220 up_path = argv[2];
221
222 res = relative_url(remoteurl, url, up_path);
223 puts(res);
224 free(res);
225 free(remoteurl);
226 return 0;
227 }
228
229 static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
230 {
231 char *remoteurl, *res;
232 const char *up_path, *url;
233
234 if (argc != 4)
235 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
236
237 up_path = argv[1];
238 remoteurl = xstrdup(argv[2]);
239 url = argv[3];
240
241 if (!strcmp(up_path, "(null)"))
242 up_path = NULL;
243
244 res = relative_url(remoteurl, url, up_path);
245 puts(res);
246 free(res);
247 free(remoteurl);
248 return 0;
249 }
250
251 /* the result should be freed by the caller. */
252 static char *get_submodule_displaypath(const char *path, const char *prefix)
253 {
254 const char *super_prefix = get_super_prefix();
255
256 if (prefix && super_prefix) {
257 BUG("cannot have prefix '%s' and superprefix '%s'",
258 prefix, super_prefix);
259 } else if (prefix) {
260 struct strbuf sb = STRBUF_INIT;
261 char *displaypath = xstrdup(relative_path(path, prefix, &sb));
262 strbuf_release(&sb);
263 return displaypath;
264 } else if (super_prefix) {
265 return xstrfmt("%s%s", super_prefix, path);
266 } else {
267 return xstrdup(path);
268 }
269 }
270
271 static char *compute_rev_name(const char *sub_path, const char* object_id)
272 {
273 struct strbuf sb = STRBUF_INIT;
274 const char ***d;
275
276 static const char *describe_bare[] = { NULL };
277
278 static const char *describe_tags[] = { "--tags", NULL };
279
280 static const char *describe_contains[] = { "--contains", NULL };
281
282 static const char *describe_all_always[] = { "--all", "--always", NULL };
283
284 static const char **describe_argv[] = { describe_bare, describe_tags,
285 describe_contains,
286 describe_all_always, NULL };
287
288 for (d = describe_argv; *d; d++) {
289 struct child_process cp = CHILD_PROCESS_INIT;
290 prepare_submodule_repo_env(&cp.env_array);
291 cp.dir = sub_path;
292 cp.git_cmd = 1;
293 cp.no_stderr = 1;
294
295 argv_array_push(&cp.args, "describe");
296 argv_array_pushv(&cp.args, *d);
297 argv_array_push(&cp.args, object_id);
298
299 if (!capture_command(&cp, &sb, 0)) {
300 strbuf_strip_suffix(&sb, "\n");
301 return strbuf_detach(&sb, NULL);
302 }
303 }
304
305 strbuf_release(&sb);
306 return NULL;
307 }
308
309 struct module_list {
310 const struct cache_entry **entries;
311 int alloc, nr;
312 };
313 #define MODULE_LIST_INIT { NULL, 0, 0 }
314
315 static int module_list_compute(int argc, const char **argv,
316 const char *prefix,
317 struct pathspec *pathspec,
318 struct module_list *list)
319 {
320 int i, result = 0;
321 char *ps_matched = NULL;
322 parse_pathspec(pathspec, 0,
323 PATHSPEC_PREFER_FULL,
324 prefix, argv);
325
326 if (pathspec->nr)
327 ps_matched = xcalloc(pathspec->nr, 1);
328
329 if (read_cache() < 0)
330 die(_("index file corrupt"));
331
332 for (i = 0; i < active_nr; i++) {
333 const struct cache_entry *ce = active_cache[i];
334
335 if (!match_pathspec(&the_index, pathspec, ce->name, ce_namelen(ce),
336 0, ps_matched, 1) ||
337 !S_ISGITLINK(ce->ce_mode))
338 continue;
339
340 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
341 list->entries[list->nr++] = ce;
342 while (i + 1 < active_nr &&
343 !strcmp(ce->name, active_cache[i + 1]->name))
344 /*
345 * Skip entries with the same name in different stages
346 * to make sure an entry is returned only once.
347 */
348 i++;
349 }
350
351 if (ps_matched && report_path_error(ps_matched, pathspec))
352 result = -1;
353
354 free(ps_matched);
355
356 return result;
357 }
358
359 static void module_list_active(struct module_list *list)
360 {
361 int i;
362 struct module_list active_modules = MODULE_LIST_INIT;
363
364 for (i = 0; i < list->nr; i++) {
365 const struct cache_entry *ce = list->entries[i];
366
367 if (!is_submodule_active(the_repository, ce->name))
368 continue;
369
370 ALLOC_GROW(active_modules.entries,
371 active_modules.nr + 1,
372 active_modules.alloc);
373 active_modules.entries[active_modules.nr++] = ce;
374 }
375
376 free(list->entries);
377 *list = active_modules;
378 }
379
380 static char *get_up_path(const char *path)
381 {
382 int i;
383 struct strbuf sb = STRBUF_INIT;
384
385 for (i = count_slashes(path); i; i--)
386 strbuf_addstr(&sb, "../");
387
388 /*
389 * Check if 'path' ends with slash or not
390 * for having the same output for dir/sub_dir
391 * and dir/sub_dir/
392 */
393 if (!is_dir_sep(path[strlen(path) - 1]))
394 strbuf_addstr(&sb, "../");
395
396 return strbuf_detach(&sb, NULL);
397 }
398
399 static int module_list(int argc, const char **argv, const char *prefix)
400 {
401 int i;
402 struct pathspec pathspec;
403 struct module_list list = MODULE_LIST_INIT;
404
405 struct option module_list_options[] = {
406 OPT_STRING(0, "prefix", &prefix,
407 N_("path"),
408 N_("alternative anchor for relative paths")),
409 OPT_END()
410 };
411
412 const char *const git_submodule_helper_usage[] = {
413 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
414 NULL
415 };
416
417 argc = parse_options(argc, argv, prefix, module_list_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 const struct cache_entry *ce = list.entries[i];
425
426 if (ce_stage(ce))
427 printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
428 else
429 printf("%06o %s %d\t", ce->ce_mode,
430 oid_to_hex(&ce->oid), ce_stage(ce));
431
432 fprintf(stdout, "%s\n", ce->name);
433 }
434 return 0;
435 }
436
437 static void for_each_listed_submodule(const struct module_list *list,
438 each_submodule_fn fn, void *cb_data)
439 {
440 int i;
441 for (i = 0; i < list->nr; i++)
442 fn(list->entries[i], cb_data);
443 }
444
445 struct cb_foreach {
446 int argc;
447 const char **argv;
448 const char *prefix;
449 int quiet;
450 int recursive;
451 };
452 #define CB_FOREACH_INIT { 0 }
453
454 static void runcommand_in_submodule_cb(const struct cache_entry *list_item,
455 void *cb_data)
456 {
457 struct cb_foreach *info = cb_data;
458 const char *path = list_item->name;
459 const struct object_id *ce_oid = &list_item->oid;
460
461 const struct submodule *sub;
462 struct child_process cp = CHILD_PROCESS_INIT;
463 char *displaypath;
464
465 displaypath = get_submodule_displaypath(path, info->prefix);
466
467 sub = submodule_from_path(the_repository, &null_oid, path);
468
469 if (!sub)
470 die(_("No url found for submodule path '%s' in .gitmodules"),
471 displaypath);
472
473 if (!is_submodule_populated_gently(path, NULL))
474 goto cleanup;
475
476 prepare_submodule_repo_env(&cp.env_array);
477
478 /*
479 * For the purpose of executing <command> in the submodule,
480 * separate shell is used for the purpose of running the
481 * child process.
482 */
483 cp.use_shell = 1;
484 cp.dir = path;
485
486 /*
487 * NEEDSWORK: the command currently has access to the variables $name,
488 * $sm_path, $displaypath, $sha1 and $toplevel only when the command
489 * contains a single argument. This is done for maintaining a faithful
490 * translation from shell script.
491 */
492 if (info->argc == 1) {
493 char *toplevel = xgetcwd();
494 struct strbuf sb = STRBUF_INIT;
495
496 argv_array_pushf(&cp.env_array, "name=%s", sub->name);
497 argv_array_pushf(&cp.env_array, "sm_path=%s", path);
498 argv_array_pushf(&cp.env_array, "displaypath=%s", displaypath);
499 argv_array_pushf(&cp.env_array, "sha1=%s",
500 oid_to_hex(ce_oid));
501 argv_array_pushf(&cp.env_array, "toplevel=%s", toplevel);
502
503 /*
504 * Since the path variable was accessible from the script
505 * before porting, it is also made available after porting.
506 * The environment variable "PATH" has a very special purpose
507 * on windows. And since environment variables are
508 * case-insensitive in windows, it interferes with the
509 * existing PATH variable. Hence, to avoid that, we expose
510 * path via the args argv_array and not via env_array.
511 */
512 sq_quote_buf(&sb, path);
513 argv_array_pushf(&cp.args, "path=%s; %s",
514 sb.buf, info->argv[0]);
515 strbuf_release(&sb);
516 free(toplevel);
517 } else {
518 argv_array_pushv(&cp.args, info->argv);
519 }
520
521 if (!info->quiet)
522 printf(_("Entering '%s'\n"), displaypath);
523
524 if (info->argv[0] && run_command(&cp))
525 die(_("run_command returned non-zero status for %s\n."),
526 displaypath);
527
528 if (info->recursive) {
529 struct child_process cpr = CHILD_PROCESS_INIT;
530
531 cpr.git_cmd = 1;
532 cpr.dir = path;
533 prepare_submodule_repo_env(&cpr.env_array);
534
535 argv_array_pushl(&cpr.args, "--super-prefix", NULL);
536 argv_array_pushf(&cpr.args, "%s/", displaypath);
537 argv_array_pushl(&cpr.args, "submodule--helper", "foreach", "--recursive",
538 NULL);
539
540 if (info->quiet)
541 argv_array_push(&cpr.args, "--quiet");
542
543 argv_array_push(&cpr.args, "--");
544 argv_array_pushv(&cpr.args, info->argv);
545
546 if (run_command(&cpr))
547 die(_("run_command returned non-zero status while "
548 "recursing in the nested submodules of %s\n."),
549 displaypath);
550 }
551
552 cleanup:
553 free(displaypath);
554 }
555
556 static int module_foreach(int argc, const char **argv, const char *prefix)
557 {
558 struct cb_foreach info = CB_FOREACH_INIT;
559 struct pathspec pathspec;
560 struct module_list list = MODULE_LIST_INIT;
561
562 struct option module_foreach_options[] = {
563 OPT__QUIET(&info.quiet, N_("Suppress output of entering each submodule command")),
564 OPT_BOOL(0, "recursive", &info.recursive,
565 N_("Recurse into nested submodules")),
566 OPT_END()
567 };
568
569 const char *const git_submodule_helper_usage[] = {
570 N_("git submodule--helper foreach [--quiet] [--recursive] [--] <command>"),
571 NULL
572 };
573
574 argc = parse_options(argc, argv, prefix, module_foreach_options,
575 git_submodule_helper_usage, 0);
576
577 if (module_list_compute(0, NULL, prefix, &pathspec, &list) < 0)
578 return 1;
579
580 info.argc = argc;
581 info.argv = argv;
582 info.prefix = prefix;
583
584 for_each_listed_submodule(&list, runcommand_in_submodule_cb, &info);
585
586 return 0;
587 }
588
589 static char *compute_submodule_clone_url(const char *rel_url)
590 {
591 char *remoteurl, *relurl;
592 char *remote = get_default_remote();
593 struct strbuf remotesb = STRBUF_INIT;
594
595 strbuf_addf(&remotesb, "remote.%s.url", remote);
596 if (git_config_get_string(remotesb.buf, &remoteurl)) {
597 warning(_("could not look up configuration '%s'. Assuming this repository is its own authoritative upstream."), remotesb.buf);
598 remoteurl = xgetcwd();
599 }
600 relurl = relative_url(remoteurl, rel_url, NULL);
601
602 free(remote);
603 free(remoteurl);
604 strbuf_release(&remotesb);
605
606 return relurl;
607 }
608
609 struct init_cb {
610 const char *prefix;
611 unsigned int flags;
612 };
613
614 #define INIT_CB_INIT { NULL, 0 }
615
616 static void init_submodule(const char *path, const char *prefix,
617 unsigned int flags)
618 {
619 const struct submodule *sub;
620 struct strbuf sb = STRBUF_INIT;
621 char *upd = NULL, *url = NULL, *displaypath;
622
623 displaypath = get_submodule_displaypath(path, prefix);
624
625 sub = submodule_from_path(the_repository, &null_oid, path);
626
627 if (!sub)
628 die(_("No url found for submodule path '%s' in .gitmodules"),
629 displaypath);
630
631 /*
632 * NEEDSWORK: In a multi-working-tree world, this needs to be
633 * set in the per-worktree config.
634 *
635 * Set active flag for the submodule being initialized
636 */
637 if (!is_submodule_active(the_repository, path)) {
638 strbuf_addf(&sb, "submodule.%s.active", sub->name);
639 git_config_set_gently(sb.buf, "true");
640 strbuf_reset(&sb);
641 }
642
643 /*
644 * Copy url setting when it is not set yet.
645 * To look up the url in .git/config, we must not fall back to
646 * .gitmodules, so look it up directly.
647 */
648 strbuf_addf(&sb, "submodule.%s.url", sub->name);
649 if (git_config_get_string(sb.buf, &url)) {
650 if (!sub->url)
651 die(_("No url found for submodule path '%s' in .gitmodules"),
652 displaypath);
653
654 url = xstrdup(sub->url);
655
656 /* Possibly a url relative to parent */
657 if (starts_with_dot_dot_slash(url) ||
658 starts_with_dot_slash(url)) {
659 char *oldurl = url;
660 url = compute_submodule_clone_url(oldurl);
661 free(oldurl);
662 }
663
664 if (git_config_set_gently(sb.buf, url))
665 die(_("Failed to register url for submodule path '%s'"),
666 displaypath);
667 if (!(flags & OPT_QUIET))
668 fprintf(stderr,
669 _("Submodule '%s' (%s) registered for path '%s'\n"),
670 sub->name, url, displaypath);
671 }
672 strbuf_reset(&sb);
673
674 /* Copy "update" setting when it is not set yet */
675 strbuf_addf(&sb, "submodule.%s.update", sub->name);
676 if (git_config_get_string(sb.buf, &upd) &&
677 sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
678 if (sub->update_strategy.type == SM_UPDATE_COMMAND) {
679 fprintf(stderr, _("warning: command update mode suggested for submodule '%s'\n"),
680 sub->name);
681 upd = xstrdup("none");
682 } else
683 upd = xstrdup(submodule_strategy_to_string(&sub->update_strategy));
684
685 if (git_config_set_gently(sb.buf, upd))
686 die(_("Failed to register update mode for submodule path '%s'"), displaypath);
687 }
688 strbuf_release(&sb);
689 free(displaypath);
690 free(url);
691 free(upd);
692 }
693
694 static void init_submodule_cb(const struct cache_entry *list_item, void *cb_data)
695 {
696 struct init_cb *info = cb_data;
697 init_submodule(list_item->name, info->prefix, info->flags);
698 }
699
700 static int module_init(int argc, const char **argv, const char *prefix)
701 {
702 struct init_cb info = INIT_CB_INIT;
703 struct pathspec pathspec;
704 struct module_list list = MODULE_LIST_INIT;
705 int quiet = 0;
706
707 struct option module_init_options[] = {
708 OPT__QUIET(&quiet, N_("Suppress output for initializing a submodule")),
709 OPT_END()
710 };
711
712 const char *const git_submodule_helper_usage[] = {
713 N_("git submodule--helper init [<options>] [<path>]"),
714 NULL
715 };
716
717 argc = parse_options(argc, argv, prefix, module_init_options,
718 git_submodule_helper_usage, 0);
719
720 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
721 return 1;
722
723 /*
724 * If there are no path args and submodule.active is set then,
725 * by default, only initialize 'active' modules.
726 */
727 if (!argc && git_config_get_value_multi("submodule.active"))
728 module_list_active(&list);
729
730 info.prefix = prefix;
731 if (quiet)
732 info.flags |= OPT_QUIET;
733
734 for_each_listed_submodule(&list, init_submodule_cb, &info);
735
736 return 0;
737 }
738
739 struct status_cb {
740 const char *prefix;
741 unsigned int flags;
742 };
743
744 #define STATUS_CB_INIT { NULL, 0 }
745
746 static void print_status(unsigned int flags, char state, const char *path,
747 const struct object_id *oid, const char *displaypath)
748 {
749 if (flags & OPT_QUIET)
750 return;
751
752 printf("%c%s %s", state, oid_to_hex(oid), displaypath);
753
754 if (state == ' ' || state == '+') {
755 const char *name = compute_rev_name(path, oid_to_hex(oid));
756
757 if (name)
758 printf(" (%s)", name);
759 }
760
761 printf("\n");
762 }
763
764 static int handle_submodule_head_ref(const char *refname,
765 const struct object_id *oid, int flags,
766 void *cb_data)
767 {
768 struct object_id *output = cb_data;
769 if (oid)
770 oidcpy(output, oid);
771
772 return 0;
773 }
774
775 static void status_submodule(const char *path, const struct object_id *ce_oid,
776 unsigned int ce_flags, const char *prefix,
777 unsigned int flags)
778 {
779 char *displaypath;
780 struct argv_array diff_files_args = ARGV_ARRAY_INIT;
781 struct rev_info rev;
782 int diff_files_result;
783
784 if (!submodule_from_path(the_repository, &null_oid, path))
785 die(_("no submodule mapping found in .gitmodules for path '%s'"),
786 path);
787
788 displaypath = get_submodule_displaypath(path, prefix);
789
790 if ((CE_STAGEMASK & ce_flags) >> CE_STAGESHIFT) {
791 print_status(flags, 'U', path, &null_oid, displaypath);
792 goto cleanup;
793 }
794
795 if (!is_submodule_active(the_repository, path)) {
796 print_status(flags, '-', path, ce_oid, displaypath);
797 goto cleanup;
798 }
799
800 argv_array_pushl(&diff_files_args, "diff-files",
801 "--ignore-submodules=dirty", "--quiet", "--",
802 path, NULL);
803
804 git_config(git_diff_basic_config, NULL);
805 repo_init_revisions(the_repository, &rev, prefix);
806 rev.abbrev = 0;
807 diff_files_args.argc = setup_revisions(diff_files_args.argc,
808 diff_files_args.argv,
809 &rev, NULL);
810 diff_files_result = run_diff_files(&rev, 0);
811
812 if (!diff_result_code(&rev.diffopt, diff_files_result)) {
813 print_status(flags, ' ', path, ce_oid,
814 displaypath);
815 } else if (!(flags & OPT_CACHED)) {
816 struct object_id oid;
817 struct ref_store *refs = get_submodule_ref_store(path);
818
819 if (!refs) {
820 print_status(flags, '-', path, ce_oid, displaypath);
821 goto cleanup;
822 }
823 if (refs_head_ref(refs, handle_submodule_head_ref, &oid))
824 die(_("could not resolve HEAD ref inside the "
825 "submodule '%s'"), path);
826
827 print_status(flags, '+', path, &oid, displaypath);
828 } else {
829 print_status(flags, '+', path, ce_oid, displaypath);
830 }
831
832 if (flags & OPT_RECURSIVE) {
833 struct child_process cpr = CHILD_PROCESS_INIT;
834
835 cpr.git_cmd = 1;
836 cpr.dir = path;
837 prepare_submodule_repo_env(&cpr.env_array);
838
839 argv_array_push(&cpr.args, "--super-prefix");
840 argv_array_pushf(&cpr.args, "%s/", displaypath);
841 argv_array_pushl(&cpr.args, "submodule--helper", "status",
842 "--recursive", NULL);
843
844 if (flags & OPT_CACHED)
845 argv_array_push(&cpr.args, "--cached");
846
847 if (flags & OPT_QUIET)
848 argv_array_push(&cpr.args, "--quiet");
849
850 if (run_command(&cpr))
851 die(_("failed to recurse into submodule '%s'"), path);
852 }
853
854 cleanup:
855 argv_array_clear(&diff_files_args);
856 free(displaypath);
857 }
858
859 static void status_submodule_cb(const struct cache_entry *list_item,
860 void *cb_data)
861 {
862 struct status_cb *info = cb_data;
863 status_submodule(list_item->name, &list_item->oid, list_item->ce_flags,
864 info->prefix, info->flags);
865 }
866
867 static int module_status(int argc, const char **argv, const char *prefix)
868 {
869 struct status_cb info = STATUS_CB_INIT;
870 struct pathspec pathspec;
871 struct module_list list = MODULE_LIST_INIT;
872 int quiet = 0;
873
874 struct option module_status_options[] = {
875 OPT__QUIET(&quiet, N_("Suppress submodule status output")),
876 OPT_BIT(0, "cached", &info.flags, N_("Use commit stored in the index instead of the one stored in the submodule HEAD"), OPT_CACHED),
877 OPT_BIT(0, "recursive", &info.flags, N_("recurse into nested submodules"), OPT_RECURSIVE),
878 OPT_END()
879 };
880
881 const char *const git_submodule_helper_usage[] = {
882 N_("git submodule status [--quiet] [--cached] [--recursive] [<path>...]"),
883 NULL
884 };
885
886 argc = parse_options(argc, argv, prefix, module_status_options,
887 git_submodule_helper_usage, 0);
888
889 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
890 return 1;
891
892 info.prefix = prefix;
893 if (quiet)
894 info.flags |= OPT_QUIET;
895
896 for_each_listed_submodule(&list, status_submodule_cb, &info);
897
898 return 0;
899 }
900
901 static int module_name(int argc, const char **argv, const char *prefix)
902 {
903 const struct submodule *sub;
904
905 if (argc != 2)
906 usage(_("git submodule--helper name <path>"));
907
908 sub = submodule_from_path(the_repository, &null_oid, argv[1]);
909
910 if (!sub)
911 die(_("no submodule mapping found in .gitmodules for path '%s'"),
912 argv[1]);
913
914 printf("%s\n", sub->name);
915
916 return 0;
917 }
918
919 struct sync_cb {
920 const char *prefix;
921 unsigned int flags;
922 };
923
924 #define SYNC_CB_INIT { NULL, 0 }
925
926 static void sync_submodule(const char *path, const char *prefix,
927 unsigned int flags)
928 {
929 const struct submodule *sub;
930 char *remote_key = NULL;
931 char *sub_origin_url, *super_config_url, *displaypath;
932 struct strbuf sb = STRBUF_INIT;
933 struct child_process cp = CHILD_PROCESS_INIT;
934 char *sub_config_path = NULL;
935
936 if (!is_submodule_active(the_repository, path))
937 return;
938
939 sub = submodule_from_path(the_repository, &null_oid, path);
940
941 if (sub && sub->url) {
942 if (starts_with_dot_dot_slash(sub->url) ||
943 starts_with_dot_slash(sub->url)) {
944 char *remote_url, *up_path;
945 char *remote = get_default_remote();
946 strbuf_addf(&sb, "remote.%s.url", remote);
947
948 if (git_config_get_string(sb.buf, &remote_url))
949 remote_url = xgetcwd();
950
951 up_path = get_up_path(path);
952 sub_origin_url = relative_url(remote_url, sub->url, up_path);
953 super_config_url = relative_url(remote_url, sub->url, NULL);
954
955 free(remote);
956 free(up_path);
957 free(remote_url);
958 } else {
959 sub_origin_url = xstrdup(sub->url);
960 super_config_url = xstrdup(sub->url);
961 }
962 } else {
963 sub_origin_url = xstrdup("");
964 super_config_url = xstrdup("");
965 }
966
967 displaypath = get_submodule_displaypath(path, prefix);
968
969 if (!(flags & OPT_QUIET))
970 printf(_("Synchronizing submodule url for '%s'\n"),
971 displaypath);
972
973 strbuf_reset(&sb);
974 strbuf_addf(&sb, "submodule.%s.url", sub->name);
975 if (git_config_set_gently(sb.buf, super_config_url))
976 die(_("failed to register url for submodule path '%s'"),
977 displaypath);
978
979 if (!is_submodule_populated_gently(path, NULL))
980 goto cleanup;
981
982 prepare_submodule_repo_env(&cp.env_array);
983 cp.git_cmd = 1;
984 cp.dir = path;
985 argv_array_pushl(&cp.args, "submodule--helper",
986 "print-default-remote", NULL);
987
988 strbuf_reset(&sb);
989 if (capture_command(&cp, &sb, 0))
990 die(_("failed to get the default remote for submodule '%s'"),
991 path);
992
993 strbuf_strip_suffix(&sb, "\n");
994 remote_key = xstrfmt("remote.%s.url", sb.buf);
995
996 strbuf_reset(&sb);
997 submodule_to_gitdir(&sb, path);
998 strbuf_addstr(&sb, "/config");
999
1000 if (git_config_set_in_file_gently(sb.buf, remote_key, sub_origin_url))
1001 die(_("failed to update remote for submodule '%s'"),
1002 path);
1003
1004 if (flags & OPT_RECURSIVE) {
1005 struct child_process cpr = CHILD_PROCESS_INIT;
1006
1007 cpr.git_cmd = 1;
1008 cpr.dir = path;
1009 prepare_submodule_repo_env(&cpr.env_array);
1010
1011 argv_array_push(&cpr.args, "--super-prefix");
1012 argv_array_pushf(&cpr.args, "%s/", displaypath);
1013 argv_array_pushl(&cpr.args, "submodule--helper", "sync",
1014 "--recursive", NULL);
1015
1016 if (flags & OPT_QUIET)
1017 argv_array_push(&cpr.args, "--quiet");
1018
1019 if (run_command(&cpr))
1020 die(_("failed to recurse into submodule '%s'"),
1021 path);
1022 }
1023
1024 cleanup:
1025 free(super_config_url);
1026 free(sub_origin_url);
1027 strbuf_release(&sb);
1028 free(remote_key);
1029 free(displaypath);
1030 free(sub_config_path);
1031 }
1032
1033 static void sync_submodule_cb(const struct cache_entry *list_item, void *cb_data)
1034 {
1035 struct sync_cb *info = cb_data;
1036 sync_submodule(list_item->name, info->prefix, info->flags);
1037 }
1038
1039 static int module_sync(int argc, const char **argv, const char *prefix)
1040 {
1041 struct sync_cb info = SYNC_CB_INIT;
1042 struct pathspec pathspec;
1043 struct module_list list = MODULE_LIST_INIT;
1044 int quiet = 0;
1045 int recursive = 0;
1046
1047 struct option module_sync_options[] = {
1048 OPT__QUIET(&quiet, N_("Suppress output of synchronizing submodule url")),
1049 OPT_BOOL(0, "recursive", &recursive,
1050 N_("Recurse into nested submodules")),
1051 OPT_END()
1052 };
1053
1054 const char *const git_submodule_helper_usage[] = {
1055 N_("git submodule--helper sync [--quiet] [--recursive] [<path>]"),
1056 NULL
1057 };
1058
1059 argc = parse_options(argc, argv, prefix, module_sync_options,
1060 git_submodule_helper_usage, 0);
1061
1062 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1063 return 1;
1064
1065 info.prefix = prefix;
1066 if (quiet)
1067 info.flags |= OPT_QUIET;
1068 if (recursive)
1069 info.flags |= OPT_RECURSIVE;
1070
1071 for_each_listed_submodule(&list, sync_submodule_cb, &info);
1072
1073 return 0;
1074 }
1075
1076 struct deinit_cb {
1077 const char *prefix;
1078 unsigned int flags;
1079 };
1080 #define DEINIT_CB_INIT { NULL, 0 }
1081
1082 static void deinit_submodule(const char *path, const char *prefix,
1083 unsigned int flags)
1084 {
1085 const struct submodule *sub;
1086 char *displaypath = NULL;
1087 struct child_process cp_config = CHILD_PROCESS_INIT;
1088 struct strbuf sb_config = STRBUF_INIT;
1089 char *sub_git_dir = xstrfmt("%s/.git", path);
1090
1091 sub = submodule_from_path(the_repository, &null_oid, path);
1092
1093 if (!sub || !sub->name)
1094 goto cleanup;
1095
1096 displaypath = get_submodule_displaypath(path, prefix);
1097
1098 /* remove the submodule work tree (unless the user already did it) */
1099 if (is_directory(path)) {
1100 struct strbuf sb_rm = STRBUF_INIT;
1101 const char *format;
1102
1103 /*
1104 * protect submodules containing a .git directory
1105 * NEEDSWORK: instead of dying, automatically call
1106 * absorbgitdirs and (possibly) warn.
1107 */
1108 if (is_directory(sub_git_dir))
1109 die(_("Submodule work tree '%s' contains a .git "
1110 "directory (use 'rm -rf' if you really want "
1111 "to remove it including all of its history)"),
1112 displaypath);
1113
1114 if (!(flags & OPT_FORCE)) {
1115 struct child_process cp_rm = CHILD_PROCESS_INIT;
1116 cp_rm.git_cmd = 1;
1117 argv_array_pushl(&cp_rm.args, "rm", "-qn",
1118 path, NULL);
1119
1120 if (run_command(&cp_rm))
1121 die(_("Submodule work tree '%s' contains local "
1122 "modifications; use '-f' to discard them"),
1123 displaypath);
1124 }
1125
1126 strbuf_addstr(&sb_rm, path);
1127
1128 if (!remove_dir_recursively(&sb_rm, 0))
1129 format = _("Cleared directory '%s'\n");
1130 else
1131 format = _("Could not remove submodule work tree '%s'\n");
1132
1133 if (!(flags & OPT_QUIET))
1134 printf(format, displaypath);
1135
1136 submodule_unset_core_worktree(sub);
1137
1138 strbuf_release(&sb_rm);
1139 }
1140
1141 if (mkdir(path, 0777))
1142 printf(_("could not create empty submodule directory %s"),
1143 displaypath);
1144
1145 cp_config.git_cmd = 1;
1146 argv_array_pushl(&cp_config.args, "config", "--get-regexp", NULL);
1147 argv_array_pushf(&cp_config.args, "submodule.%s\\.", sub->name);
1148
1149 /* remove the .git/config entries (unless the user already did it) */
1150 if (!capture_command(&cp_config, &sb_config, 0) && sb_config.len) {
1151 char *sub_key = xstrfmt("submodule.%s", sub->name);
1152 /*
1153 * remove the whole section so we have a clean state when
1154 * the user later decides to init this submodule again
1155 */
1156 git_config_rename_section_in_file(NULL, sub_key, NULL);
1157 if (!(flags & OPT_QUIET))
1158 printf(_("Submodule '%s' (%s) unregistered for path '%s'\n"),
1159 sub->name, sub->url, displaypath);
1160 free(sub_key);
1161 }
1162
1163 cleanup:
1164 free(displaypath);
1165 free(sub_git_dir);
1166 strbuf_release(&sb_config);
1167 }
1168
1169 static void deinit_submodule_cb(const struct cache_entry *list_item,
1170 void *cb_data)
1171 {
1172 struct deinit_cb *info = cb_data;
1173 deinit_submodule(list_item->name, info->prefix, info->flags);
1174 }
1175
1176 static int module_deinit(int argc, const char **argv, const char *prefix)
1177 {
1178 struct deinit_cb info = DEINIT_CB_INIT;
1179 struct pathspec pathspec;
1180 struct module_list list = MODULE_LIST_INIT;
1181 int quiet = 0;
1182 int force = 0;
1183 int all = 0;
1184
1185 struct option module_deinit_options[] = {
1186 OPT__QUIET(&quiet, N_("Suppress submodule status output")),
1187 OPT__FORCE(&force, N_("Remove submodule working trees even if they contain local changes"), 0),
1188 OPT_BOOL(0, "all", &all, N_("Unregister all submodules")),
1189 OPT_END()
1190 };
1191
1192 const char *const git_submodule_helper_usage[] = {
1193 N_("git submodule deinit [--quiet] [-f | --force] [--all | [--] [<path>...]]"),
1194 NULL
1195 };
1196
1197 argc = parse_options(argc, argv, prefix, module_deinit_options,
1198 git_submodule_helper_usage, 0);
1199
1200 if (all && argc) {
1201 error("pathspec and --all are incompatible");
1202 usage_with_options(git_submodule_helper_usage,
1203 module_deinit_options);
1204 }
1205
1206 if (!argc && !all)
1207 die(_("Use '--all' if you really want to deinitialize all submodules"));
1208
1209 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
1210 return 1;
1211
1212 info.prefix = prefix;
1213 if (quiet)
1214 info.flags |= OPT_QUIET;
1215 if (force)
1216 info.flags |= OPT_FORCE;
1217
1218 for_each_listed_submodule(&list, deinit_submodule_cb, &info);
1219
1220 return 0;
1221 }
1222
1223 static int clone_submodule(const char *path, const char *gitdir, const char *url,
1224 const char *depth, struct string_list *reference, int dissociate,
1225 int quiet, int progress)
1226 {
1227 struct child_process cp = CHILD_PROCESS_INIT;
1228
1229 argv_array_push(&cp.args, "clone");
1230 argv_array_push(&cp.args, "--no-checkout");
1231 if (quiet)
1232 argv_array_push(&cp.args, "--quiet");
1233 if (progress)
1234 argv_array_push(&cp.args, "--progress");
1235 if (depth && *depth)
1236 argv_array_pushl(&cp.args, "--depth", depth, NULL);
1237 if (reference->nr) {
1238 struct string_list_item *item;
1239 for_each_string_list_item(item, reference)
1240 argv_array_pushl(&cp.args, "--reference",
1241 item->string, NULL);
1242 }
1243 if (dissociate)
1244 argv_array_push(&cp.args, "--dissociate");
1245 if (gitdir && *gitdir)
1246 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
1247
1248 argv_array_push(&cp.args, "--");
1249 argv_array_push(&cp.args, url);
1250 argv_array_push(&cp.args, path);
1251
1252 cp.git_cmd = 1;
1253 prepare_submodule_repo_env(&cp.env_array);
1254 cp.no_stdin = 1;
1255
1256 return run_command(&cp);
1257 }
1258
1259 struct submodule_alternate_setup {
1260 const char *submodule_name;
1261 enum SUBMODULE_ALTERNATE_ERROR_MODE {
1262 SUBMODULE_ALTERNATE_ERROR_DIE,
1263 SUBMODULE_ALTERNATE_ERROR_INFO,
1264 SUBMODULE_ALTERNATE_ERROR_IGNORE
1265 } error_mode;
1266 struct string_list *reference;
1267 };
1268 #define SUBMODULE_ALTERNATE_SETUP_INIT { NULL, \
1269 SUBMODULE_ALTERNATE_ERROR_IGNORE, NULL }
1270
1271 static int add_possible_reference_from_superproject(
1272 struct object_directory *odb, void *sas_cb)
1273 {
1274 struct submodule_alternate_setup *sas = sas_cb;
1275 size_t len;
1276
1277 /*
1278 * If the alternate object store is another repository, try the
1279 * standard layout with .git/(modules/<name>)+/objects
1280 */
1281 if (strip_suffix(odb->path, "/objects", &len)) {
1282 char *sm_alternate;
1283 struct strbuf sb = STRBUF_INIT;
1284 struct strbuf err = STRBUF_INIT;
1285 strbuf_add(&sb, odb->path, len);
1286
1287 /*
1288 * We need to end the new path with '/' to mark it as a dir,
1289 * otherwise a submodule name containing '/' will be broken
1290 * as the last part of a missing submodule reference would
1291 * be taken as a file name.
1292 */
1293 strbuf_addf(&sb, "/modules/%s/", sas->submodule_name);
1294
1295 sm_alternate = compute_alternate_path(sb.buf, &err);
1296 if (sm_alternate) {
1297 string_list_append(sas->reference, xstrdup(sb.buf));
1298 free(sm_alternate);
1299 } else {
1300 switch (sas->error_mode) {
1301 case SUBMODULE_ALTERNATE_ERROR_DIE:
1302 die(_("submodule '%s' cannot add alternate: %s"),
1303 sas->submodule_name, err.buf);
1304 case SUBMODULE_ALTERNATE_ERROR_INFO:
1305 fprintf_ln(stderr, _("submodule '%s' cannot add alternate: %s"),
1306 sas->submodule_name, err.buf);
1307 case SUBMODULE_ALTERNATE_ERROR_IGNORE:
1308 ; /* nothing */
1309 }
1310 }
1311 strbuf_release(&sb);
1312 }
1313
1314 return 0;
1315 }
1316
1317 static void prepare_possible_alternates(const char *sm_name,
1318 struct string_list *reference)
1319 {
1320 char *sm_alternate = NULL, *error_strategy = NULL;
1321 struct submodule_alternate_setup sas = SUBMODULE_ALTERNATE_SETUP_INIT;
1322
1323 git_config_get_string("submodule.alternateLocation", &sm_alternate);
1324 if (!sm_alternate)
1325 return;
1326
1327 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1328
1329 if (!error_strategy)
1330 error_strategy = xstrdup("die");
1331
1332 sas.submodule_name = sm_name;
1333 sas.reference = reference;
1334 if (!strcmp(error_strategy, "die"))
1335 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_DIE;
1336 else if (!strcmp(error_strategy, "info"))
1337 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_INFO;
1338 else if (!strcmp(error_strategy, "ignore"))
1339 sas.error_mode = SUBMODULE_ALTERNATE_ERROR_IGNORE;
1340 else
1341 die(_("Value '%s' for submodule.alternateErrorStrategy is not recognized"), error_strategy);
1342
1343 if (!strcmp(sm_alternate, "superproject"))
1344 foreach_alt_odb(add_possible_reference_from_superproject, &sas);
1345 else if (!strcmp(sm_alternate, "no"))
1346 ; /* do nothing */
1347 else
1348 die(_("Value '%s' for submodule.alternateLocation is not recognized"), sm_alternate);
1349
1350 free(sm_alternate);
1351 free(error_strategy);
1352 }
1353
1354 static int module_clone(int argc, const char **argv, const char *prefix)
1355 {
1356 const char *name = NULL, *url = NULL, *depth = NULL;
1357 int quiet = 0;
1358 int progress = 0;
1359 char *p, *path = NULL, *sm_gitdir;
1360 struct strbuf sb = STRBUF_INIT;
1361 struct string_list reference = STRING_LIST_INIT_NODUP;
1362 int dissociate = 0;
1363 char *sm_alternate = NULL, *error_strategy = NULL;
1364
1365 struct option module_clone_options[] = {
1366 OPT_STRING(0, "prefix", &prefix,
1367 N_("path"),
1368 N_("alternative anchor for relative paths")),
1369 OPT_STRING(0, "path", &path,
1370 N_("path"),
1371 N_("where the new submodule will be cloned to")),
1372 OPT_STRING(0, "name", &name,
1373 N_("string"),
1374 N_("name of the new submodule")),
1375 OPT_STRING(0, "url", &url,
1376 N_("string"),
1377 N_("url where to clone the submodule from")),
1378 OPT_STRING_LIST(0, "reference", &reference,
1379 N_("repo"),
1380 N_("reference repository")),
1381 OPT_BOOL(0, "dissociate", &dissociate,
1382 N_("use --reference only while cloning")),
1383 OPT_STRING(0, "depth", &depth,
1384 N_("string"),
1385 N_("depth for shallow clones")),
1386 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
1387 OPT_BOOL(0, "progress", &progress,
1388 N_("force cloning progress")),
1389 OPT_END()
1390 };
1391
1392 const char *const git_submodule_helper_usage[] = {
1393 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
1394 "[--reference <repository>] [--name <name>] [--depth <depth>] "
1395 "--url <url> --path <path>"),
1396 NULL
1397 };
1398
1399 argc = parse_options(argc, argv, prefix, module_clone_options,
1400 git_submodule_helper_usage, 0);
1401
1402 if (argc || !url || !path || !*path)
1403 usage_with_options(git_submodule_helper_usage,
1404 module_clone_options);
1405
1406 strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
1407 sm_gitdir = absolute_pathdup(sb.buf);
1408 strbuf_reset(&sb);
1409
1410 if (!is_absolute_path(path)) {
1411 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
1412 path = strbuf_detach(&sb, NULL);
1413 } else
1414 path = xstrdup(path);
1415
1416 if (!file_exists(sm_gitdir)) {
1417 if (safe_create_leading_directories_const(sm_gitdir) < 0)
1418 die(_("could not create directory '%s'"), sm_gitdir);
1419
1420 prepare_possible_alternates(name, &reference);
1421
1422 if (clone_submodule(path, sm_gitdir, url, depth, &reference, dissociate,
1423 quiet, progress))
1424 die(_("clone of '%s' into submodule path '%s' failed"),
1425 url, path);
1426 } else {
1427 if (safe_create_leading_directories_const(path) < 0)
1428 die(_("could not create directory '%s'"), path);
1429 strbuf_addf(&sb, "%s/index", sm_gitdir);
1430 unlink_or_warn(sb.buf);
1431 strbuf_reset(&sb);
1432 }
1433
1434 connect_work_tree_and_git_dir(path, sm_gitdir, 0);
1435
1436 p = git_pathdup_submodule(path, "config");
1437 if (!p)
1438 die(_("could not get submodule directory for '%s'"), path);
1439
1440 /* setup alternateLocation and alternateErrorStrategy in the cloned submodule if needed */
1441 git_config_get_string("submodule.alternateLocation", &sm_alternate);
1442 if (sm_alternate)
1443 git_config_set_in_file(p, "submodule.alternateLocation",
1444 sm_alternate);
1445 git_config_get_string("submodule.alternateErrorStrategy", &error_strategy);
1446 if (error_strategy)
1447 git_config_set_in_file(p, "submodule.alternateErrorStrategy",
1448 error_strategy);
1449
1450 free(sm_alternate);
1451 free(error_strategy);
1452
1453 strbuf_release(&sb);
1454 free(sm_gitdir);
1455 free(path);
1456 free(p);
1457 return 0;
1458 }
1459
1460 static void determine_submodule_update_strategy(struct repository *r,
1461 int just_cloned,
1462 const char *path,
1463 const char *update,
1464 struct submodule_update_strategy *out)
1465 {
1466 const struct submodule *sub = submodule_from_path(r, &null_oid, path);
1467 char *key;
1468 const char *val;
1469
1470 key = xstrfmt("submodule.%s.update", sub->name);
1471
1472 if (update) {
1473 if (parse_submodule_update_strategy(update, out) < 0)
1474 die(_("Invalid update mode '%s' for submodule path '%s'"),
1475 update, path);
1476 } else if (!repo_config_get_string_const(r, key, &val)) {
1477 if (parse_submodule_update_strategy(val, out) < 0)
1478 die(_("Invalid update mode '%s' configured for submodule path '%s'"),
1479 val, path);
1480 } else if (sub->update_strategy.type != SM_UPDATE_UNSPECIFIED) {
1481 out->type = sub->update_strategy.type;
1482 out->command = sub->update_strategy.command;
1483 } else
1484 out->type = SM_UPDATE_CHECKOUT;
1485
1486 if (just_cloned &&
1487 (out->type == SM_UPDATE_MERGE ||
1488 out->type == SM_UPDATE_REBASE ||
1489 out->type == SM_UPDATE_NONE))
1490 out->type = SM_UPDATE_CHECKOUT;
1491
1492 free(key);
1493 }
1494
1495 static int module_update_module_mode(int argc, const char **argv, const char *prefix)
1496 {
1497 const char *path, *update = NULL;
1498 int just_cloned;
1499 struct submodule_update_strategy update_strategy = { .type = SM_UPDATE_CHECKOUT };
1500
1501 if (argc < 3 || argc > 4)
1502 die("submodule--helper update-module-clone expects <just-cloned> <path> [<update>]");
1503
1504 just_cloned = git_config_int("just_cloned", argv[1]);
1505 path = argv[2];
1506
1507 if (argc == 4)
1508 update = argv[3];
1509
1510 determine_submodule_update_strategy(the_repository,
1511 just_cloned, path, update,
1512 &update_strategy);
1513 fputs(submodule_strategy_to_string(&update_strategy), stdout);
1514
1515 return 0;
1516 }
1517
1518 struct update_clone_data {
1519 const struct submodule *sub;
1520 struct object_id oid;
1521 unsigned just_cloned;
1522 };
1523
1524 struct submodule_update_clone {
1525 /* index into 'list', the list of submodules to look into for cloning */
1526 int current;
1527 struct module_list list;
1528 unsigned warn_if_uninitialized : 1;
1529
1530 /* update parameter passed via commandline */
1531 struct submodule_update_strategy update;
1532
1533 /* configuration parameters which are passed on to the children */
1534 int progress;
1535 int quiet;
1536 int recommend_shallow;
1537 struct string_list references;
1538 int dissociate;
1539 const char *depth;
1540 const char *recursive_prefix;
1541 const char *prefix;
1542
1543 /* to be consumed by git-submodule.sh */
1544 struct update_clone_data *update_clone;
1545 int update_clone_nr; int update_clone_alloc;
1546
1547 /* If we want to stop as fast as possible and return an error */
1548 unsigned quickstop : 1;
1549
1550 /* failed clones to be retried again */
1551 const struct cache_entry **failed_clones;
1552 int failed_clones_nr, failed_clones_alloc;
1553
1554 int max_jobs;
1555 };
1556 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
1557 SUBMODULE_UPDATE_STRATEGY_INIT, 0, 0, -1, STRING_LIST_INIT_DUP, 0, \
1558 NULL, NULL, NULL, \
1559 NULL, 0, 0, 0, NULL, 0, 0, 1}
1560
1561
1562 static void next_submodule_warn_missing(struct submodule_update_clone *suc,
1563 struct strbuf *out, const char *displaypath)
1564 {
1565 /*
1566 * Only mention uninitialized submodules when their
1567 * paths have been specified.
1568 */
1569 if (suc->warn_if_uninitialized) {
1570 strbuf_addf(out,
1571 _("Submodule path '%s' not initialized"),
1572 displaypath);
1573 strbuf_addch(out, '\n');
1574 strbuf_addstr(out,
1575 _("Maybe you want to use 'update --init'?"));
1576 strbuf_addch(out, '\n');
1577 }
1578 }
1579
1580 /**
1581 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
1582 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
1583 */
1584 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
1585 struct child_process *child,
1586 struct submodule_update_clone *suc,
1587 struct strbuf *out)
1588 {
1589 const struct submodule *sub = NULL;
1590 const char *url = NULL;
1591 const char *update_string;
1592 enum submodule_update_type update_type;
1593 char *key;
1594 struct strbuf displaypath_sb = STRBUF_INIT;
1595 struct strbuf sb = STRBUF_INIT;
1596 const char *displaypath = NULL;
1597 int needs_cloning = 0;
1598 int need_free_url = 0;
1599
1600 if (ce_stage(ce)) {
1601 if (suc->recursive_prefix)
1602 strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
1603 else
1604 strbuf_addstr(&sb, ce->name);
1605 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
1606 strbuf_addch(out, '\n');
1607 goto cleanup;
1608 }
1609
1610 sub = submodule_from_path(the_repository, &null_oid, ce->name);
1611
1612 if (suc->recursive_prefix)
1613 displaypath = relative_path(suc->recursive_prefix,
1614 ce->name, &displaypath_sb);
1615 else
1616 displaypath = ce->name;
1617
1618 if (!sub) {
1619 next_submodule_warn_missing(suc, out, displaypath);
1620 goto cleanup;
1621 }
1622
1623 key = xstrfmt("submodule.%s.update", sub->name);
1624 if (!repo_config_get_string_const(the_repository, key, &update_string)) {
1625 update_type = parse_submodule_update_type(update_string);
1626 } else {
1627 update_type = sub->update_strategy.type;
1628 }
1629 free(key);
1630
1631 if (suc->update.type == SM_UPDATE_NONE
1632 || (suc->update.type == SM_UPDATE_UNSPECIFIED
1633 && update_type == SM_UPDATE_NONE)) {
1634 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
1635 strbuf_addch(out, '\n');
1636 goto cleanup;
1637 }
1638
1639 /* Check if the submodule has been initialized. */
1640 if (!is_submodule_active(the_repository, ce->name)) {
1641 next_submodule_warn_missing(suc, out, displaypath);
1642 goto cleanup;
1643 }
1644
1645 strbuf_reset(&sb);
1646 strbuf_addf(&sb, "submodule.%s.url", sub->name);
1647 if (repo_config_get_string_const(the_repository, sb.buf, &url)) {
1648 if (starts_with_dot_slash(sub->url) ||
1649 starts_with_dot_dot_slash(sub->url)) {
1650 url = compute_submodule_clone_url(sub->url);
1651 need_free_url = 1;
1652 } else
1653 url = sub->url;
1654 }
1655
1656 strbuf_reset(&sb);
1657 strbuf_addf(&sb, "%s/.git", ce->name);
1658 needs_cloning = !file_exists(sb.buf);
1659
1660 ALLOC_GROW(suc->update_clone, suc->update_clone_nr + 1,
1661 suc->update_clone_alloc);
1662 oidcpy(&suc->update_clone[suc->update_clone_nr].oid, &ce->oid);
1663 suc->update_clone[suc->update_clone_nr].just_cloned = needs_cloning;
1664 suc->update_clone[suc->update_clone_nr].sub = sub;
1665 suc->update_clone_nr++;
1666
1667 if (!needs_cloning)
1668 goto cleanup;
1669
1670 child->git_cmd = 1;
1671 child->no_stdin = 1;
1672 child->stdout_to_stderr = 1;
1673 child->err = -1;
1674 argv_array_push(&child->args, "submodule--helper");
1675 argv_array_push(&child->args, "clone");
1676 if (suc->progress)
1677 argv_array_push(&child->args, "--progress");
1678 if (suc->quiet)
1679 argv_array_push(&child->args, "--quiet");
1680 if (suc->prefix)
1681 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
1682 if (suc->recommend_shallow && sub->recommend_shallow == 1)
1683 argv_array_push(&child->args, "--depth=1");
1684 argv_array_pushl(&child->args, "--path", sub->path, NULL);
1685 argv_array_pushl(&child->args, "--name", sub->name, NULL);
1686 argv_array_pushl(&child->args, "--url", url, NULL);
1687 if (suc->references.nr) {
1688 struct string_list_item *item;
1689 for_each_string_list_item(item, &suc->references)
1690 argv_array_pushl(&child->args, "--reference", item->string, NULL);
1691 }
1692 if (suc->dissociate)
1693 argv_array_push(&child->args, "--dissociate");
1694 if (suc->depth)
1695 argv_array_push(&child->args, suc->depth);
1696
1697 cleanup:
1698 strbuf_reset(&displaypath_sb);
1699 strbuf_reset(&sb);
1700 if (need_free_url)
1701 free((void*)url);
1702
1703 return needs_cloning;
1704 }
1705
1706 static int update_clone_get_next_task(struct child_process *child,
1707 struct strbuf *err,
1708 void *suc_cb,
1709 void **idx_task_cb)
1710 {
1711 struct submodule_update_clone *suc = suc_cb;
1712 const struct cache_entry *ce;
1713 int index;
1714
1715 for (; suc->current < suc->list.nr; suc->current++) {
1716 ce = suc->list.entries[suc->current];
1717 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
1718 int *p = xmalloc(sizeof(*p));
1719 *p = suc->current;
1720 *idx_task_cb = p;
1721 suc->current++;
1722 return 1;
1723 }
1724 }
1725
1726 /*
1727 * The loop above tried cloning each submodule once, now try the
1728 * stragglers again, which we can imagine as an extension of the
1729 * entry list.
1730 */
1731 index = suc->current - suc->list.nr;
1732 if (index < suc->failed_clones_nr) {
1733 int *p;
1734 ce = suc->failed_clones[index];
1735 if (!prepare_to_clone_next_submodule(ce, child, suc, err)) {
1736 suc->current ++;
1737 strbuf_addstr(err, "BUG: submodule considered for "
1738 "cloning, doesn't need cloning "
1739 "any more?\n");
1740 return 0;
1741 }
1742 p = xmalloc(sizeof(*p));
1743 *p = suc->current;
1744 *idx_task_cb = p;
1745 suc->current ++;
1746 return 1;
1747 }
1748
1749 return 0;
1750 }
1751
1752 static int update_clone_start_failure(struct strbuf *err,
1753 void *suc_cb,
1754 void *idx_task_cb)
1755 {
1756 struct submodule_update_clone *suc = suc_cb;
1757 suc->quickstop = 1;
1758 return 1;
1759 }
1760
1761 static int update_clone_task_finished(int result,
1762 struct strbuf *err,
1763 void *suc_cb,
1764 void *idx_task_cb)
1765 {
1766 const struct cache_entry *ce;
1767 struct submodule_update_clone *suc = suc_cb;
1768
1769 int *idxP = idx_task_cb;
1770 int idx = *idxP;
1771 free(idxP);
1772
1773 if (!result)
1774 return 0;
1775
1776 if (idx < suc->list.nr) {
1777 ce = suc->list.entries[idx];
1778 strbuf_addf(err, _("Failed to clone '%s'. Retry scheduled"),
1779 ce->name);
1780 strbuf_addch(err, '\n');
1781 ALLOC_GROW(suc->failed_clones,
1782 suc->failed_clones_nr + 1,
1783 suc->failed_clones_alloc);
1784 suc->failed_clones[suc->failed_clones_nr++] = ce;
1785 return 0;
1786 } else {
1787 idx -= suc->list.nr;
1788 ce = suc->failed_clones[idx];
1789 strbuf_addf(err, _("Failed to clone '%s' a second time, aborting"),
1790 ce->name);
1791 strbuf_addch(err, '\n');
1792 suc->quickstop = 1;
1793 return 1;
1794 }
1795
1796 return 0;
1797 }
1798
1799 static int git_update_clone_config(const char *var, const char *value,
1800 void *cb)
1801 {
1802 int *max_jobs = cb;
1803 if (!strcmp(var, "submodule.fetchjobs"))
1804 *max_jobs = parse_submodule_fetchjobs(var, value);
1805 return 0;
1806 }
1807
1808 static void update_submodule(struct update_clone_data *ucd)
1809 {
1810 fprintf(stdout, "dummy %s %d\t%s\n",
1811 oid_to_hex(&ucd->oid),
1812 ucd->just_cloned,
1813 ucd->sub->path);
1814 }
1815
1816 static int update_submodules(struct submodule_update_clone *suc)
1817 {
1818 int i;
1819
1820 run_processes_parallel_tr2(suc->max_jobs, update_clone_get_next_task,
1821 update_clone_start_failure,
1822 update_clone_task_finished, suc, "submodule",
1823 "parallel/update");
1824
1825 /*
1826 * We saved the output and put it out all at once now.
1827 * That means:
1828 * - the listener does not have to interleave their (checkout)
1829 * work with our fetching. The writes involved in a
1830 * checkout involve more straightforward sequential I/O.
1831 * - the listener can avoid doing any work if fetching failed.
1832 */
1833 if (suc->quickstop)
1834 return 1;
1835
1836 for (i = 0; i < suc->update_clone_nr; i++)
1837 update_submodule(&suc->update_clone[i]);
1838
1839 return 0;
1840 }
1841
1842 static int update_clone(int argc, const char **argv, const char *prefix)
1843 {
1844 const char *update = NULL;
1845 struct pathspec pathspec;
1846 struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
1847
1848 struct option module_update_clone_options[] = {
1849 OPT_STRING(0, "prefix", &prefix,
1850 N_("path"),
1851 N_("path into the working tree")),
1852 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
1853 N_("path"),
1854 N_("path into the working tree, across nested "
1855 "submodule boundaries")),
1856 OPT_STRING(0, "update", &update,
1857 N_("string"),
1858 N_("rebase, merge, checkout or none")),
1859 OPT_STRING_LIST(0, "reference", &suc.references, N_("repo"),
1860 N_("reference repository")),
1861 OPT_BOOL(0, "dissociate", &suc.dissociate,
1862 N_("use --reference only while cloning")),
1863 OPT_STRING(0, "depth", &suc.depth, "<depth>",
1864 N_("Create a shallow clone truncated to the "
1865 "specified number of revisions")),
1866 OPT_INTEGER('j', "jobs", &suc.max_jobs,
1867 N_("parallel jobs")),
1868 OPT_BOOL(0, "recommend-shallow", &suc.recommend_shallow,
1869 N_("whether the initial clone should follow the shallow recommendation")),
1870 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
1871 OPT_BOOL(0, "progress", &suc.progress,
1872 N_("force cloning progress")),
1873 OPT_END()
1874 };
1875
1876 const char *const git_submodule_helper_usage[] = {
1877 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
1878 NULL
1879 };
1880 suc.prefix = prefix;
1881
1882 update_clone_config_from_gitmodules(&suc.max_jobs);
1883 git_config(git_update_clone_config, &suc.max_jobs);
1884
1885 argc = parse_options(argc, argv, prefix, module_update_clone_options,
1886 git_submodule_helper_usage, 0);
1887
1888 if (update)
1889 if (parse_submodule_update_strategy(update, &suc.update) < 0)
1890 die(_("bad value for update parameter"));
1891
1892 if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
1893 return 1;
1894
1895 if (pathspec.nr)
1896 suc.warn_if_uninitialized = 1;
1897
1898 return update_submodules(&suc);
1899 }
1900
1901 static int resolve_relative_path(int argc, const char **argv, const char *prefix)
1902 {
1903 struct strbuf sb = STRBUF_INIT;
1904 if (argc != 3)
1905 die("submodule--helper relative-path takes exactly 2 arguments, got %d", argc);
1906
1907 printf("%s", relative_path(argv[1], argv[2], &sb));
1908 strbuf_release(&sb);
1909 return 0;
1910 }
1911
1912 static const char *remote_submodule_branch(const char *path)
1913 {
1914 const struct submodule *sub;
1915 const char *branch = NULL;
1916 char *key;
1917
1918 sub = submodule_from_path(the_repository, &null_oid, path);
1919 if (!sub)
1920 return NULL;
1921
1922 key = xstrfmt("submodule.%s.branch", sub->name);
1923 if (repo_config_get_string_const(the_repository, key, &branch))
1924 branch = sub->branch;
1925 free(key);
1926
1927 if (!branch)
1928 return "master";
1929
1930 if (!strcmp(branch, ".")) {
1931 const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1932
1933 if (!refname)
1934 die(_("No such ref: %s"), "HEAD");
1935
1936 /* detached HEAD */
1937 if (!strcmp(refname, "HEAD"))
1938 die(_("Submodule (%s) branch configured to inherit "
1939 "branch from superproject, but the superproject "
1940 "is not on any branch"), sub->name);
1941
1942 if (!skip_prefix(refname, "refs/heads/", &refname))
1943 die(_("Expecting a full ref name, got %s"), refname);
1944 return refname;
1945 }
1946
1947 return branch;
1948 }
1949
1950 static int resolve_remote_submodule_branch(int argc, const char **argv,
1951 const char *prefix)
1952 {
1953 const char *ret;
1954 struct strbuf sb = STRBUF_INIT;
1955 if (argc != 2)
1956 die("submodule--helper remote-branch takes exactly one arguments, got %d", argc);
1957
1958 ret = remote_submodule_branch(argv[1]);
1959 if (!ret)
1960 die("submodule %s doesn't exist", argv[1]);
1961
1962 printf("%s", ret);
1963 strbuf_release(&sb);
1964 return 0;
1965 }
1966
1967 static int push_check(int argc, const char **argv, const char *prefix)
1968 {
1969 struct remote *remote;
1970 const char *superproject_head;
1971 char *head;
1972 int detached_head = 0;
1973 struct object_id head_oid;
1974
1975 if (argc < 3)
1976 die("submodule--helper push-check requires at least 2 arguments");
1977
1978 /*
1979 * superproject's resolved head ref.
1980 * if HEAD then the superproject is in a detached head state, otherwise
1981 * it will be the resolved head ref.
1982 */
1983 superproject_head = argv[1];
1984 argv++;
1985 argc--;
1986 /* Get the submodule's head ref and determine if it is detached */
1987 head = resolve_refdup("HEAD", 0, &head_oid, NULL);
1988 if (!head)
1989 die(_("Failed to resolve HEAD as a valid ref."));
1990 if (!strcmp(head, "HEAD"))
1991 detached_head = 1;
1992
1993 /*
1994 * The remote must be configured.
1995 * This is to avoid pushing to the exact same URL as the parent.
1996 */
1997 remote = pushremote_get(argv[1]);
1998 if (!remote || remote->origin == REMOTE_UNCONFIGURED)
1999 die("remote '%s' not configured", argv[1]);
2000
2001 /* Check the refspec */
2002 if (argc > 2) {
2003 int i;
2004 struct ref *local_refs = get_local_heads();
2005 struct refspec refspec = REFSPEC_INIT_PUSH;
2006
2007 refspec_appendn(&refspec, argv + 2, argc - 2);
2008
2009 for (i = 0; i < refspec.nr; i++) {
2010 const struct refspec_item *rs = &refspec.items[i];
2011
2012 if (rs->pattern || rs->matching)
2013 continue;
2014
2015 /* LHS must match a single ref */
2016 switch (count_refspec_match(rs->src, local_refs, NULL)) {
2017 case 1:
2018 break;
2019 case 0:
2020 /*
2021 * If LHS matches 'HEAD' then we need to ensure
2022 * that it matches the same named branch
2023 * checked out in the superproject.
2024 */
2025 if (!strcmp(rs->src, "HEAD")) {
2026 if (!detached_head &&
2027 !strcmp(head, superproject_head))
2028 break;
2029 die("HEAD does not match the named branch in the superproject");
2030 }
2031 /* fallthrough */
2032 default:
2033 die("src refspec '%s' must name a ref",
2034 rs->src);
2035 }
2036 }
2037 refspec_clear(&refspec);
2038 }
2039 free(head);
2040
2041 return 0;
2042 }
2043
2044 static int ensure_core_worktree(int argc, const char **argv, const char *prefix)
2045 {
2046 const struct submodule *sub;
2047 const char *path;
2048 char *cw;
2049 struct repository subrepo;
2050
2051 if (argc != 2)
2052 BUG("submodule--helper ensure-core-worktree <path>");
2053
2054 path = argv[1];
2055
2056 sub = submodule_from_path(the_repository, &null_oid, path);
2057 if (!sub)
2058 BUG("We could get the submodule handle before?");
2059
2060 if (repo_submodule_init(&subrepo, the_repository, sub))
2061 die(_("could not get a repository handle for submodule '%s'"), path);
2062
2063 if (!repo_config_get_string(&subrepo, "core.worktree", &cw)) {
2064 char *cfg_file, *abs_path;
2065 const char *rel_path;
2066 struct strbuf sb = STRBUF_INIT;
2067
2068 cfg_file = repo_git_path(&subrepo, "config");
2069
2070 abs_path = absolute_pathdup(path);
2071 rel_path = relative_path(abs_path, subrepo.gitdir, &sb);
2072
2073 git_config_set_in_file(cfg_file, "core.worktree", rel_path);
2074
2075 free(cfg_file);
2076 free(abs_path);
2077 strbuf_release(&sb);
2078 }
2079
2080 return 0;
2081 }
2082
2083 static int absorb_git_dirs(int argc, const char **argv, const char *prefix)
2084 {
2085 int i;
2086 struct pathspec pathspec;
2087 struct module_list list = MODULE_LIST_INIT;
2088 unsigned flags = ABSORB_GITDIR_RECURSE_SUBMODULES;
2089
2090 struct option embed_gitdir_options[] = {
2091 OPT_STRING(0, "prefix", &prefix,
2092 N_("path"),
2093 N_("path into the working tree")),
2094 OPT_BIT(0, "--recursive", &flags, N_("recurse into submodules"),
2095 ABSORB_GITDIR_RECURSE_SUBMODULES),
2096 OPT_END()
2097 };
2098
2099 const char *const git_submodule_helper_usage[] = {
2100 N_("git submodule--helper absorb-git-dirs [<options>] [<path>...]"),
2101 NULL
2102 };
2103
2104 argc = parse_options(argc, argv, prefix, embed_gitdir_options,
2105 git_submodule_helper_usage, 0);
2106
2107 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0)
2108 return 1;
2109
2110 for (i = 0; i < list.nr; i++)
2111 absorb_git_dir_into_superproject(list.entries[i]->name, flags);
2112
2113 return 0;
2114 }
2115
2116 static int is_active(int argc, const char **argv, const char *prefix)
2117 {
2118 if (argc != 2)
2119 die("submodule--helper is-active takes exactly 1 argument");
2120
2121 return !is_submodule_active(the_repository, argv[1]);
2122 }
2123
2124 /*
2125 * Exit non-zero if any of the submodule names given on the command line is
2126 * invalid. If no names are given, filter stdin to print only valid names
2127 * (which is primarily intended for testing).
2128 */
2129 static int check_name(int argc, const char **argv, const char *prefix)
2130 {
2131 if (argc > 1) {
2132 while (*++argv) {
2133 if (check_submodule_name(*argv) < 0)
2134 return 1;
2135 }
2136 } else {
2137 struct strbuf buf = STRBUF_INIT;
2138 while (strbuf_getline(&buf, stdin) != EOF) {
2139 if (!check_submodule_name(buf.buf))
2140 printf("%s\n", buf.buf);
2141 }
2142 strbuf_release(&buf);
2143 }
2144 return 0;
2145 }
2146
2147 static int module_config(int argc, const char **argv, const char *prefix)
2148 {
2149 enum {
2150 CHECK_WRITEABLE = 1,
2151 DO_UNSET = 2
2152 } command = 0;
2153
2154 struct option module_config_options[] = {
2155 OPT_CMDMODE(0, "check-writeable", &command,
2156 N_("check if it is safe to write to the .gitmodules file"),
2157 CHECK_WRITEABLE),
2158 OPT_CMDMODE(0, "unset", &command,
2159 N_("unset the config in the .gitmodules file"),
2160 DO_UNSET),
2161 OPT_END()
2162 };
2163 const char *const git_submodule_helper_usage[] = {
2164 N_("git submodule--helper config <name> [<value>]"),
2165 N_("git submodule--helper config --unset <name>"),
2166 N_("git submodule--helper config --check-writeable"),
2167 NULL
2168 };
2169
2170 argc = parse_options(argc, argv, prefix, module_config_options,
2171 git_submodule_helper_usage, PARSE_OPT_KEEP_ARGV0);
2172
2173 if (argc == 1 && command == CHECK_WRITEABLE)
2174 return is_writing_gitmodules_ok() ? 0 : -1;
2175
2176 /* Equivalent to ACTION_GET in builtin/config.c */
2177 if (argc == 2 && command != DO_UNSET)
2178 return print_config_from_gitmodules(the_repository, argv[1]);
2179
2180 /* Equivalent to ACTION_SET in builtin/config.c */
2181 if (argc == 3 || (argc == 2 && command == DO_UNSET)) {
2182 const char *value = (argc == 3) ? argv[2] : NULL;
2183
2184 if (!is_writing_gitmodules_ok())
2185 die(_("please make sure that the .gitmodules file is in the working tree"));
2186
2187 return config_set_in_gitmodules_file_gently(argv[1], value);
2188 }
2189
2190 usage_with_options(git_submodule_helper_usage, module_config_options);
2191 }
2192
2193 #define SUPPORT_SUPER_PREFIX (1<<0)
2194
2195 struct cmd_struct {
2196 const char *cmd;
2197 int (*fn)(int, const char **, const char *);
2198 unsigned option;
2199 };
2200
2201 static struct cmd_struct commands[] = {
2202 {"list", module_list, 0},
2203 {"name", module_name, 0},
2204 {"clone", module_clone, 0},
2205 {"update-module-mode", module_update_module_mode, 0},
2206 {"update-clone", update_clone, 0},
2207 {"ensure-core-worktree", ensure_core_worktree, 0},
2208 {"relative-path", resolve_relative_path, 0},
2209 {"resolve-relative-url", resolve_relative_url, 0},
2210 {"resolve-relative-url-test", resolve_relative_url_test, 0},
2211 {"foreach", module_foreach, SUPPORT_SUPER_PREFIX},
2212 {"init", module_init, SUPPORT_SUPER_PREFIX},
2213 {"status", module_status, SUPPORT_SUPER_PREFIX},
2214 {"print-default-remote", print_default_remote, 0},
2215 {"sync", module_sync, SUPPORT_SUPER_PREFIX},
2216 {"deinit", module_deinit, 0},
2217 {"remote-branch", resolve_remote_submodule_branch, 0},
2218 {"push-check", push_check, 0},
2219 {"absorb-git-dirs", absorb_git_dirs, SUPPORT_SUPER_PREFIX},
2220 {"is-active", is_active, 0},
2221 {"check-name", check_name, 0},
2222 {"config", module_config, 0},
2223 };
2224
2225 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
2226 {
2227 int i;
2228 if (argc < 2 || !strcmp(argv[1], "-h"))
2229 usage("git submodule--helper <command>");
2230
2231 for (i = 0; i < ARRAY_SIZE(commands); i++) {
2232 if (!strcmp(argv[1], commands[i].cmd)) {
2233 if (get_super_prefix() &&
2234 !(commands[i].option & SUPPORT_SUPER_PREFIX))
2235 die(_("%s doesn't support --super-prefix"),
2236 commands[i].cmd);
2237 return commands[i].fn(argc - 1, argv + 1, prefix);
2238 }
2239 }
2240
2241 die(_("'%s' is not a valid submodule--helper "
2242 "subcommand"), argv[1]);
2243 }
Unnamed repository; edit this file 'description' to name the repository.