3 #include "parse-options.h"
9 #include "submodule-config.h"
10 #include "string-list.h"
11 #include "run-command.h"
16 static char *get_default_remote(void)
18 char *dest = NULL, *ret;
19 unsigned char sha1[20];
20 struct strbuf sb = STRBUF_INIT;
21 const char *refname = resolve_ref_unsafe("HEAD", 0, sha1, NULL);
24 die(_("No such ref: %s"), "HEAD");
27 if (!strcmp(refname, "HEAD"))
28 return xstrdup("origin");
30 if (!skip_prefix(refname, "refs/heads/", &refname))
31 die(_("Expecting a full ref name, got %s"), refname);
33 strbuf_addf(&sb, "branch.%s.remote", refname);
34 if (git_config_get_string(sb.buf, &dest))
35 ret = xstrdup("origin");
43 static int starts_with_dot_slash(const char *str)
45 return str[0] == '.' && is_dir_sep(str[1]);
48 static int starts_with_dot_dot_slash(const char *str)
50 return str[0] == '.' && str[1] == '.' && is_dir_sep(str[2]);
54 * Returns 1 if it was the last chop before ':'.
56 static int chop_last_dir(char **remoteurl, int is_relative)
58 char *rfind = find_last_dir_sep(*remoteurl);
64 rfind = strrchr(*remoteurl, ':');
70 if (is_relative || !strcmp(".", *remoteurl))
71 die(_("cannot strip one component off url '%s'"),
75 *remoteurl = xstrdup(".");
80 * The `url` argument is the URL that navigates to the submodule origin
81 * repo. When relative, this URL is relative to the superproject origin
82 * URL repo. The `up_path` argument, if specified, is the relative
83 * path that navigates from the submodule working tree to the superproject
84 * working tree. Returns the origin URL of the submodule.
86 * Return either an absolute URL or filesystem path (if the superproject
87 * origin URL is an absolute URL or filesystem path, respectively) or a
88 * relative file system path (if the superproject origin URL is a relative
91 * When the output is a relative file system path, the path is either
92 * relative to the submodule working tree, if up_path is specified, or to
93 * the superproject working tree otherwise.
95 * NEEDSWORK: This works incorrectly on the domain and protocol part.
96 * remote_url url outcome expectation
97 * http://a.com/b ../c http://a.com/c as is
98 * http://a.com/b ../../c http://c error out
99 * http://a.com/b ../../../c http:/c error out
100 * http://a.com/b ../../../../c http:c error out
101 * http://a.com/b ../../../../../c .:c error out
102 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
103 * when a local part has a colon in its path component, too.
105 static char *relative_url(const char *remote_url,
112 char *remoteurl = xstrdup(remote_url);
113 struct strbuf sb = STRBUF_INIT;
114 size_t len = strlen(remoteurl);
116 if (is_dir_sep(remoteurl[len]))
117 remoteurl[len] = '\0';
119 if (!url_is_local_not_ssh(remoteurl) || is_absolute_path(remoteurl))
124 * Prepend a './' to ensure all relative
125 * remoteurls start with './' or '../'
127 if (!starts_with_dot_slash(remoteurl) &&
128 !starts_with_dot_dot_slash(remoteurl)) {
130 strbuf_addf(&sb, "./%s", remoteurl);
132 remoteurl = strbuf_detach(&sb, NULL);
136 * When the url starts with '../', remove that and the
137 * last directory in remoteurl.
140 if (starts_with_dot_dot_slash(url)) {
142 colonsep |= chop_last_dir(&remoteurl, is_relative);
143 } else if (starts_with_dot_slash(url))
149 strbuf_addf(&sb, "%s%s%s", remoteurl, colonsep ? ":" : "/", url);
152 if (starts_with_dot_slash(sb.buf))
153 out = xstrdup(sb.buf + 2);
155 out = xstrdup(sb.buf);
158 if (!up_path || !is_relative)
161 strbuf_addf(&sb, "%s%s", up_path, out);
163 return strbuf_detach(&sb, NULL);
166 static int resolve_relative_url(int argc, const char **argv, const char *prefix)
168 char *remoteurl = NULL;
169 char *remote = get_default_remote();
170 const char *up_path = NULL;
173 struct strbuf sb = STRBUF_INIT;
175 if (argc != 2 && argc != 3)
176 die("resolve-relative-url only accepts one or two arguments");
179 strbuf_addf(&sb, "remote.%s.url", remote);
182 if (git_config_get_string(sb.buf, &remoteurl))
183 /* the repository is its own authoritative upstream */
184 remoteurl = xgetcwd();
189 res = relative_url(remoteurl, url, up_path);
196 static int resolve_relative_url_test(int argc, const char **argv, const char *prefix)
198 char *remoteurl, *res;
199 const char *up_path, *url;
202 die("resolve-relative-url-test only accepts three arguments: <up_path> <remoteurl> <url>");
205 remoteurl = xstrdup(argv[2]);
208 if (!strcmp(up_path, "(null)"))
211 res = relative_url(remoteurl, url, up_path);
219 const struct cache_entry **entries;
222 #define MODULE_LIST_INIT { NULL, 0, 0 }
224 static int module_list_compute(int argc, const char **argv,
226 struct pathspec *pathspec,
227 struct module_list *list)
230 char *ps_matched = NULL;
231 parse_pathspec(pathspec, 0,
232 PATHSPEC_PREFER_FULL |
233 PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
237 ps_matched = xcalloc(pathspec->nr, 1);
239 if (read_cache() < 0)
240 die(_("index file corrupt"));
242 for (i = 0; i < active_nr; i++) {
243 const struct cache_entry *ce = active_cache[i];
245 if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
247 !S_ISGITLINK(ce->ce_mode))
250 ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
251 list->entries[list->nr++] = ce;
252 while (i + 1 < active_nr &&
253 !strcmp(ce->name, active_cache[i + 1]->name))
255 * Skip entries with the same name in different stages
256 * to make sure an entry is returned only once.
261 if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
269 static int module_list(int argc, const char **argv, const char *prefix)
272 struct pathspec pathspec;
273 struct module_list list = MODULE_LIST_INIT;
275 struct option module_list_options[] = {
276 OPT_STRING(0, "prefix", &prefix,
278 N_("alternative anchor for relative paths")),
282 const char *const git_submodule_helper_usage[] = {
283 N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
287 argc = parse_options(argc, argv, prefix, module_list_options,
288 git_submodule_helper_usage, 0);
290 if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0) {
291 printf("#unmatched\n");
295 for (i = 0; i < list.nr; i++) {
296 const struct cache_entry *ce = list.entries[i];
299 printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
301 printf("%06o %s %d\t", ce->ce_mode, sha1_to_hex(ce->sha1), ce_stage(ce));
303 utf8_fprintf(stdout, "%s\n", ce->name);
308 static int module_name(int argc, const char **argv, const char *prefix)
310 const struct submodule *sub;
313 usage(_("git submodule--helper name <path>"));
316 sub = submodule_from_path(null_sha1, argv[1]);
319 die(_("no submodule mapping found in .gitmodules for path '%s'"),
322 printf("%s\n", sub->name);
326 static int clone_submodule(const char *path, const char *gitdir, const char *url,
327 const char *depth, const char *reference, int quiet)
329 struct child_process cp;
330 child_process_init(&cp);
332 argv_array_push(&cp.args, "clone");
333 argv_array_push(&cp.args, "--no-checkout");
335 argv_array_push(&cp.args, "--quiet");
337 argv_array_pushl(&cp.args, "--depth", depth, NULL);
338 if (reference && *reference)
339 argv_array_pushl(&cp.args, "--reference", reference, NULL);
340 if (gitdir && *gitdir)
341 argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
343 argv_array_push(&cp.args, url);
344 argv_array_push(&cp.args, path);
347 cp.env = local_repo_env;
350 return run_command(&cp);
353 static int module_clone(int argc, const char **argv, const char *prefix)
355 const char *name = NULL, *url = NULL;
356 const char *reference = NULL, *depth = NULL;
358 FILE *submodule_dot_git;
359 char *p, *path = NULL, *sm_gitdir;
360 struct strbuf rel_path = STRBUF_INIT;
361 struct strbuf sb = STRBUF_INIT;
363 struct option module_clone_options[] = {
364 OPT_STRING(0, "prefix", &prefix,
366 N_("alternative anchor for relative paths")),
367 OPT_STRING(0, "path", &path,
369 N_("where the new submodule will be cloned to")),
370 OPT_STRING(0, "name", &name,
372 N_("name of the new submodule")),
373 OPT_STRING(0, "url", &url,
375 N_("url where to clone the submodule from")),
376 OPT_STRING(0, "reference", &reference,
378 N_("reference repository")),
379 OPT_STRING(0, "depth", &depth,
381 N_("depth for shallow clones")),
382 OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
386 const char *const git_submodule_helper_usage[] = {
387 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
388 "[--reference <repository>] [--name <name>] [--url <url>]"
389 "[--depth <depth>] [--] [<path>...]"),
393 argc = parse_options(argc, argv, prefix, module_clone_options,
394 git_submodule_helper_usage, 0);
397 die(_("submodule--helper: unspecified or empty --path"));
399 strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
400 sm_gitdir = xstrdup(absolute_path(sb.buf));
403 if (!is_absolute_path(path)) {
404 strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
405 path = strbuf_detach(&sb, NULL);
407 path = xstrdup(path);
409 if (!file_exists(sm_gitdir)) {
410 if (safe_create_leading_directories_const(sm_gitdir) < 0)
411 die(_("could not create directory '%s'"), sm_gitdir);
412 if (clone_submodule(path, sm_gitdir, url, depth, reference, quiet))
413 die(_("clone of '%s' into submodule path '%s' failed"),
416 if (safe_create_leading_directories_const(path) < 0)
417 die(_("could not create directory '%s'"), path);
418 strbuf_addf(&sb, "%s/index", sm_gitdir);
419 unlink_or_warn(sb.buf);
423 /* Write a .git file in the submodule to redirect to the superproject. */
424 strbuf_addf(&sb, "%s/.git", path);
425 if (safe_create_leading_directories_const(sb.buf) < 0)
426 die(_("could not create leading directories of '%s'"), sb.buf);
427 submodule_dot_git = fopen(sb.buf, "w");
428 if (!submodule_dot_git)
429 die_errno(_("cannot open file '%s'"), sb.buf);
431 fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
432 relative_path(sm_gitdir, path, &rel_path));
433 if (fclose(submodule_dot_git))
434 die(_("could not close file %s"), sb.buf);
436 strbuf_reset(&rel_path);
438 /* Redirect the worktree of the submodule in the superproject's config */
439 p = git_pathdup_submodule(path, "config");
441 die(_("could not get submodule directory for '%s'"), path);
442 git_config_set_in_file(p, "core.worktree",
443 relative_path(path, sm_gitdir, &rel_path));
445 strbuf_release(&rel_path);
452 struct submodule_update_clone {
453 /* index into 'list', the list of submodules to look into for cloning */
455 struct module_list list;
456 unsigned warn_if_uninitialized : 1;
458 /* update parameter passed via commandline */
459 struct submodule_update_strategy update;
461 /* configuration parameters which are passed on to the children */
463 const char *reference;
465 const char *recursive_prefix;
468 /* Machine-readable status lines to be consumed by git-submodule.sh */
469 struct string_list projectlines;
471 /* If we want to stop as fast as possible and return an error */
472 unsigned quickstop : 1;
474 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
475 SUBMODULE_UPDATE_STRATEGY_INIT, 0, NULL, NULL, NULL, NULL, \
476 STRING_LIST_INIT_DUP, 0}
479 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
480 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
482 static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
483 struct child_process *child,
484 struct submodule_update_clone *suc,
487 const struct submodule *sub = NULL;
488 struct strbuf displaypath_sb = STRBUF_INIT;
489 struct strbuf sb = STRBUF_INIT;
490 const char *displaypath = NULL;
492 int needs_cloning = 0;
495 if (suc->recursive_prefix)
496 strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
498 strbuf_addf(&sb, "%s", ce->name);
499 strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
500 strbuf_addch(out, '\n');
504 sub = submodule_from_path(null_sha1, ce->name);
506 if (suc->recursive_prefix)
507 displaypath = relative_path(suc->recursive_prefix,
508 ce->name, &displaypath_sb);
510 displaypath = ce->name;
512 if (suc->update.type == SM_UPDATE_NONE
513 || (suc->update.type == SM_UPDATE_UNSPECIFIED
514 && sub->update_strategy.type == SM_UPDATE_NONE)) {
515 strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
516 strbuf_addch(out, '\n');
521 * Looking up the url in .git/config.
522 * We must not fall back to .gitmodules as we only want
523 * to process configured submodules.
526 strbuf_addf(&sb, "submodule.%s.url", sub->name);
527 git_config_get_string(sb.buf, &url);
530 * Only mention uninitialized submodules when their
531 * path have been specified
533 if (suc->warn_if_uninitialized) {
535 _("Submodule path '%s' not initialized"),
537 strbuf_addch(out, '\n');
539 _("Maybe you want to use 'update --init'?"));
540 strbuf_addch(out, '\n');
546 strbuf_addf(&sb, "%s/.git", ce->name);
547 needs_cloning = !file_exists(sb.buf);
550 strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
551 sha1_to_hex(ce->sha1), ce_stage(ce),
552 needs_cloning, ce->name);
553 string_list_append(&suc->projectlines, sb.buf);
560 child->stdout_to_stderr = 1;
562 argv_array_push(&child->args, "submodule--helper");
563 argv_array_push(&child->args, "clone");
565 argv_array_push(&child->args, "--quiet");
567 argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
568 argv_array_pushl(&child->args, "--path", sub->path, NULL);
569 argv_array_pushl(&child->args, "--name", sub->name, NULL);
570 argv_array_pushl(&child->args, "--url", url, NULL);
572 argv_array_push(&child->args, suc->reference);
574 argv_array_push(&child->args, suc->depth);
578 strbuf_reset(&displaypath_sb);
581 return needs_cloning;
584 static int update_clone_get_next_task(struct child_process *child,
589 struct submodule_update_clone *suc = suc_cb;
591 for (; suc->current < suc->list.nr; suc->current++) {
592 const struct cache_entry *ce = suc->list.entries[suc->current];
593 if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
601 static int update_clone_start_failure(struct strbuf *err,
605 struct submodule_update_clone *suc = suc_cb;
610 static int update_clone_task_finished(int result,
615 struct submodule_update_clone *suc = suc_cb;
624 static int update_clone(int argc, const char **argv, const char *prefix)
626 const char *update = NULL;
628 struct string_list_item *item;
629 struct pathspec pathspec;
630 struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
632 struct option module_update_clone_options[] = {
633 OPT_STRING(0, "prefix", &prefix,
635 N_("path into the working tree")),
636 OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
638 N_("path into the working tree, across nested "
639 "submodule boundaries")),
640 OPT_STRING(0, "update", &update,
642 N_("rebase, merge, checkout or none")),
643 OPT_STRING(0, "reference", &suc.reference, N_("repo"),
644 N_("reference repository")),
645 OPT_STRING(0, "depth", &suc.depth, "<depth>",
646 N_("Create a shallow clone truncated to the "
647 "specified number of revisions")),
648 OPT_INTEGER('j', "jobs", &max_jobs,
649 N_("parallel jobs")),
650 OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
654 const char *const git_submodule_helper_usage[] = {
655 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
660 argc = parse_options(argc, argv, prefix, module_update_clone_options,
661 git_submodule_helper_usage, 0);
664 if (parse_submodule_update_strategy(update, &suc.update) < 0)
665 die(_("bad value for update parameter"));
667 if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
671 suc.warn_if_uninitialized = 1;
673 /* Overlay the parsed .gitmodules file with .git/config */
675 git_config(submodule_config, NULL);
678 max_jobs = parallel_submodules();
680 run_processes_parallel(max_jobs,
681 update_clone_get_next_task,
682 update_clone_start_failure,
683 update_clone_task_finished,
687 * We saved the output and put it out all at once now.
689 * - the listener does not have to interleave their (checkout)
690 * work with our fetching. The writes involved in a
691 * checkout involve more straightforward sequential I/O.
692 * - the listener can avoid doing any work if fetching failed.
697 for_each_string_list_item(item, &suc.projectlines)
698 utf8_fprintf(stdout, "%s", item->string);
705 int (*fn)(int, const char **, const char *);
708 static struct cmd_struct commands[] = {
709 {"list", module_list},
710 {"name", module_name},
711 {"clone", module_clone},
712 {"update-clone", update_clone},
713 {"resolve-relative-url", resolve_relative_url},
714 {"resolve-relative-url-test", resolve_relative_url_test},
717 int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
721 die(_("submodule--helper subcommand must be "
722 "called with a subcommand"));
724 for (i = 0; i < ARRAY_SIZE(commands); i++)
725 if (!strcmp(argv[1], commands[i].cmd))
726 return commands[i].fn(argc - 1, argv + 1, prefix);
728 die(_("'%s' is not a valid submodule--helper "
729 "subcommand"), argv[1]);