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 void init_submodule(const char *path
, const char *prefix
, int quiet
)
310 const struct submodule
*sub
;
311 struct strbuf sb
= STRBUF_INIT
;
312 char *upd
= NULL
, *url
= NULL
, *displaypath
;
314 /* Only loads from .gitmodules, no overlay with .git/config */
318 strbuf_addf(&sb
, "%s%s", prefix
, path
);
319 displaypath
= strbuf_detach(&sb
, NULL
);
321 displaypath
= xstrdup(path
);
323 sub
= submodule_from_path(null_sha1
, path
);
326 die(_("No url found for submodule path '%s' in .gitmodules"),
330 * Copy url setting when it is not set yet.
331 * To look up the url in .git/config, we must not fall back to
332 * .gitmodules, so look it up directly.
335 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
336 if (git_config_get_string(sb
.buf
, &url
)) {
337 url
= xstrdup(sub
->url
);
340 die(_("No url found for submodule path '%s' in .gitmodules"),
343 /* Possibly a url relative to parent */
344 if (starts_with_dot_dot_slash(url
) ||
345 starts_with_dot_slash(url
)) {
346 char *remoteurl
, *relurl
;
347 char *remote
= get_default_remote();
348 struct strbuf remotesb
= STRBUF_INIT
;
349 strbuf_addf(&remotesb
, "remote.%s.url", remote
);
352 if (git_config_get_string(remotesb
.buf
, &remoteurl
))
354 * The repository is its own
355 * authoritative upstream
357 remoteurl
= xgetcwd();
358 relurl
= relative_url(remoteurl
, url
, NULL
);
359 strbuf_release(&remotesb
);
365 if (git_config_set_gently(sb
.buf
, url
))
366 die(_("Failed to register url for submodule path '%s'"),
370 _("Submodule '%s' (%s) registered for path '%s'\n"),
371 sub
->name
, url
, displaypath
);
374 /* Copy "update" setting when it is not set yet */
376 strbuf_addf(&sb
, "submodule.%s.update", sub
->name
);
377 if (git_config_get_string(sb
.buf
, &upd
) &&
378 sub
->update_strategy
.type
!= SM_UPDATE_UNSPECIFIED
) {
379 if (sub
->update_strategy
.type
== SM_UPDATE_COMMAND
) {
380 fprintf(stderr
, _("warning: command update mode suggested for submodule '%s'\n"),
382 upd
= xstrdup("none");
384 upd
= xstrdup(submodule_strategy_to_string(&sub
->update_strategy
));
386 if (git_config_set_gently(sb
.buf
, upd
))
387 die(_("Failed to register update mode for submodule path '%s'"), displaypath
);
395 static int module_init(int argc
, const char **argv
, const char *prefix
)
397 struct pathspec pathspec
;
398 struct module_list list
= MODULE_LIST_INIT
;
402 struct option module_init_options
[] = {
403 OPT_STRING(0, "prefix", &prefix
,
405 N_("alternative anchor for relative paths")),
406 OPT__QUIET(&quiet
, N_("Suppress output for initializing a submodule")),
410 const char *const git_submodule_helper_usage
[] = {
411 N_("git submodule--helper init [<path>]"),
415 argc
= parse_options(argc
, argv
, prefix
, module_init_options
,
416 git_submodule_helper_usage
, 0);
418 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &list
) < 0)
421 for (i
= 0; i
< list
.nr
; i
++)
422 init_submodule(list
.entries
[i
]->name
, prefix
, quiet
);
427 static int module_name(int argc
, const char **argv
, const char *prefix
)
429 const struct submodule
*sub
;
432 usage(_("git submodule--helper name <path>"));
435 sub
= submodule_from_path(null_sha1
, argv
[1]);
438 die(_("no submodule mapping found in .gitmodules for path '%s'"),
441 printf("%s\n", sub
->name
);
446 static int clone_submodule(const char *path
, const char *gitdir
, const char *url
,
447 const char *depth
, const char *reference
, int quiet
)
449 struct child_process cp
;
450 child_process_init(&cp
);
452 argv_array_push(&cp
.args
, "clone");
453 argv_array_push(&cp
.args
, "--no-checkout");
455 argv_array_push(&cp
.args
, "--quiet");
457 argv_array_pushl(&cp
.args
, "--depth", depth
, NULL
);
458 if (reference
&& *reference
)
459 argv_array_pushl(&cp
.args
, "--reference", reference
, NULL
);
460 if (gitdir
&& *gitdir
)
461 argv_array_pushl(&cp
.args
, "--separate-git-dir", gitdir
, NULL
);
463 argv_array_push(&cp
.args
, url
);
464 argv_array_push(&cp
.args
, path
);
467 prepare_submodule_repo_env(&cp
.env_array
);
470 return run_command(&cp
);
473 static int module_clone(int argc
, const char **argv
, const char *prefix
)
475 const char *name
= NULL
, *url
= NULL
;
476 const char *reference
= NULL
, *depth
= NULL
;
478 FILE *submodule_dot_git
;
479 char *p
, *path
= NULL
, *sm_gitdir
;
480 struct strbuf rel_path
= STRBUF_INIT
;
481 struct strbuf sb
= STRBUF_INIT
;
483 struct option module_clone_options
[] = {
484 OPT_STRING(0, "prefix", &prefix
,
486 N_("alternative anchor for relative paths")),
487 OPT_STRING(0, "path", &path
,
489 N_("where the new submodule will be cloned to")),
490 OPT_STRING(0, "name", &name
,
492 N_("name of the new submodule")),
493 OPT_STRING(0, "url", &url
,
495 N_("url where to clone the submodule from")),
496 OPT_STRING(0, "reference", &reference
,
498 N_("reference repository")),
499 OPT_STRING(0, "depth", &depth
,
501 N_("depth for shallow clones")),
502 OPT__QUIET(&quiet
, "Suppress output for cloning a submodule"),
506 const char *const git_submodule_helper_usage
[] = {
507 N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
508 "[--reference <repository>] [--name <name>] [--depth <depth>] "
509 "--url <url> --path <path>"),
513 argc
= parse_options(argc
, argv
, prefix
, module_clone_options
,
514 git_submodule_helper_usage
, 0);
516 if (argc
|| !url
|| !path
|| !*path
)
517 usage_with_options(git_submodule_helper_usage
,
518 module_clone_options
);
520 strbuf_addf(&sb
, "%s/modules/%s", get_git_dir(), name
);
521 sm_gitdir
= xstrdup(absolute_path(sb
.buf
));
524 if (!is_absolute_path(path
)) {
525 strbuf_addf(&sb
, "%s/%s", get_git_work_tree(), path
);
526 path
= strbuf_detach(&sb
, NULL
);
528 path
= xstrdup(path
);
530 if (!file_exists(sm_gitdir
)) {
531 if (safe_create_leading_directories_const(sm_gitdir
) < 0)
532 die(_("could not create directory '%s'"), sm_gitdir
);
533 if (clone_submodule(path
, sm_gitdir
, url
, depth
, reference
, quiet
))
534 die(_("clone of '%s' into submodule path '%s' failed"),
537 if (safe_create_leading_directories_const(path
) < 0)
538 die(_("could not create directory '%s'"), path
);
539 strbuf_addf(&sb
, "%s/index", sm_gitdir
);
540 unlink_or_warn(sb
.buf
);
544 /* Write a .git file in the submodule to redirect to the superproject. */
545 strbuf_addf(&sb
, "%s/.git", path
);
546 if (safe_create_leading_directories_const(sb
.buf
) < 0)
547 die(_("could not create leading directories of '%s'"), sb
.buf
);
548 submodule_dot_git
= fopen(sb
.buf
, "w");
549 if (!submodule_dot_git
)
550 die_errno(_("cannot open file '%s'"), sb
.buf
);
552 fprintf_or_die(submodule_dot_git
, "gitdir: %s\n",
553 relative_path(sm_gitdir
, path
, &rel_path
));
554 if (fclose(submodule_dot_git
))
555 die(_("could not close file %s"), sb
.buf
);
557 strbuf_reset(&rel_path
);
559 /* Redirect the worktree of the submodule in the superproject's config */
560 p
= git_pathdup_submodule(path
, "config");
562 die(_("could not get submodule directory for '%s'"), path
);
563 git_config_set_in_file(p
, "core.worktree",
564 relative_path(path
, sm_gitdir
, &rel_path
));
566 strbuf_release(&rel_path
);
573 struct submodule_update_clone
{
574 /* index into 'list', the list of submodules to look into for cloning */
576 struct module_list list
;
577 unsigned warn_if_uninitialized
: 1;
579 /* update parameter passed via commandline */
580 struct submodule_update_strategy update
;
582 /* configuration parameters which are passed on to the children */
584 const char *reference
;
586 const char *recursive_prefix
;
589 /* Machine-readable status lines to be consumed by git-submodule.sh */
590 struct string_list projectlines
;
592 /* If we want to stop as fast as possible and return an error */
593 unsigned quickstop
: 1;
595 #define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
596 SUBMODULE_UPDATE_STRATEGY_INIT, 0, NULL, NULL, NULL, NULL, \
597 STRING_LIST_INIT_DUP, 0}
600 static void next_submodule_warn_missing(struct submodule_update_clone
*suc
,
601 struct strbuf
*out
, const char *displaypath
)
604 * Only mention uninitialized submodules when their
605 * paths have been specified.
607 if (suc
->warn_if_uninitialized
) {
609 _("Submodule path '%s' not initialized"),
611 strbuf_addch(out
, '\n');
613 _("Maybe you want to use 'update --init'?"));
614 strbuf_addch(out
, '\n');
619 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
620 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
622 static int prepare_to_clone_next_submodule(const struct cache_entry
*ce
,
623 struct child_process
*child
,
624 struct submodule_update_clone
*suc
,
627 const struct submodule
*sub
= NULL
;
628 struct strbuf displaypath_sb
= STRBUF_INIT
;
629 struct strbuf sb
= STRBUF_INIT
;
630 const char *displaypath
= NULL
;
632 int needs_cloning
= 0;
635 if (suc
->recursive_prefix
)
636 strbuf_addf(&sb
, "%s/%s", suc
->recursive_prefix
, ce
->name
);
638 strbuf_addf(&sb
, "%s", ce
->name
);
639 strbuf_addf(out
, _("Skipping unmerged submodule %s"), sb
.buf
);
640 strbuf_addch(out
, '\n');
644 sub
= submodule_from_path(null_sha1
, ce
->name
);
646 if (suc
->recursive_prefix
)
647 displaypath
= relative_path(suc
->recursive_prefix
,
648 ce
->name
, &displaypath_sb
);
650 displaypath
= ce
->name
;
653 next_submodule_warn_missing(suc
, out
, displaypath
);
657 if (suc
->update
.type
== SM_UPDATE_NONE
658 || (suc
->update
.type
== SM_UPDATE_UNSPECIFIED
659 && sub
->update_strategy
.type
== SM_UPDATE_NONE
)) {
660 strbuf_addf(out
, _("Skipping submodule '%s'"), displaypath
);
661 strbuf_addch(out
, '\n');
666 * Looking up the url in .git/config.
667 * We must not fall back to .gitmodules as we only want
668 * to process configured submodules.
671 strbuf_addf(&sb
, "submodule.%s.url", sub
->name
);
672 git_config_get_string(sb
.buf
, &url
);
674 next_submodule_warn_missing(suc
, out
, displaypath
);
679 strbuf_addf(&sb
, "%s/.git", ce
->name
);
680 needs_cloning
= !file_exists(sb
.buf
);
683 strbuf_addf(&sb
, "%06o %s %d %d\t%s\n", ce
->ce_mode
,
684 sha1_to_hex(ce
->sha1
), ce_stage(ce
),
685 needs_cloning
, ce
->name
);
686 string_list_append(&suc
->projectlines
, sb
.buf
);
693 child
->stdout_to_stderr
= 1;
695 argv_array_push(&child
->args
, "submodule--helper");
696 argv_array_push(&child
->args
, "clone");
698 argv_array_push(&child
->args
, "--quiet");
700 argv_array_pushl(&child
->args
, "--prefix", suc
->prefix
, NULL
);
701 argv_array_pushl(&child
->args
, "--path", sub
->path
, NULL
);
702 argv_array_pushl(&child
->args
, "--name", sub
->name
, NULL
);
703 argv_array_pushl(&child
->args
, "--url", url
, NULL
);
705 argv_array_push(&child
->args
, suc
->reference
);
707 argv_array_push(&child
->args
, suc
->depth
);
711 strbuf_reset(&displaypath_sb
);
714 return needs_cloning
;
717 static int update_clone_get_next_task(struct child_process
*child
,
722 struct submodule_update_clone
*suc
= suc_cb
;
724 for (; suc
->current
< suc
->list
.nr
; suc
->current
++) {
725 const struct cache_entry
*ce
= suc
->list
.entries
[suc
->current
];
726 if (prepare_to_clone_next_submodule(ce
, child
, suc
, err
)) {
734 static int update_clone_start_failure(struct strbuf
*err
,
738 struct submodule_update_clone
*suc
= suc_cb
;
743 static int update_clone_task_finished(int result
,
748 struct submodule_update_clone
*suc
= suc_cb
;
757 static int update_clone(int argc
, const char **argv
, const char *prefix
)
759 const char *update
= NULL
;
761 struct string_list_item
*item
;
762 struct pathspec pathspec
;
763 struct submodule_update_clone suc
= SUBMODULE_UPDATE_CLONE_INIT
;
765 struct option module_update_clone_options
[] = {
766 OPT_STRING(0, "prefix", &prefix
,
768 N_("path into the working tree")),
769 OPT_STRING(0, "recursive-prefix", &suc
.recursive_prefix
,
771 N_("path into the working tree, across nested "
772 "submodule boundaries")),
773 OPT_STRING(0, "update", &update
,
775 N_("rebase, merge, checkout or none")),
776 OPT_STRING(0, "reference", &suc
.reference
, N_("repo"),
777 N_("reference repository")),
778 OPT_STRING(0, "depth", &suc
.depth
, "<depth>",
779 N_("Create a shallow clone truncated to the "
780 "specified number of revisions")),
781 OPT_INTEGER('j', "jobs", &max_jobs
,
782 N_("parallel jobs")),
783 OPT__QUIET(&suc
.quiet
, N_("don't print cloning progress")),
787 const char *const git_submodule_helper_usage
[] = {
788 N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
793 argc
= parse_options(argc
, argv
, prefix
, module_update_clone_options
,
794 git_submodule_helper_usage
, 0);
797 if (parse_submodule_update_strategy(update
, &suc
.update
) < 0)
798 die(_("bad value for update parameter"));
800 if (module_list_compute(argc
, argv
, prefix
, &pathspec
, &suc
.list
) < 0)
804 suc
.warn_if_uninitialized
= 1;
806 /* Overlay the parsed .gitmodules file with .git/config */
808 git_config(submodule_config
, NULL
);
811 max_jobs
= parallel_submodules();
813 run_processes_parallel(max_jobs
,
814 update_clone_get_next_task
,
815 update_clone_start_failure
,
816 update_clone_task_finished
,
820 * We saved the output and put it out all at once now.
822 * - the listener does not have to interleave their (checkout)
823 * work with our fetching. The writes involved in a
824 * checkout involve more straightforward sequential I/O.
825 * - the listener can avoid doing any work if fetching failed.
830 for_each_string_list_item(item
, &suc
.projectlines
)
831 utf8_fprintf(stdout
, "%s", item
->string
);
838 int (*fn
)(int, const char **, const char *);
841 static struct cmd_struct commands
[] = {
842 {"list", module_list
},
843 {"name", module_name
},
844 {"clone", module_clone
},
845 {"update-clone", update_clone
},
846 {"resolve-relative-url", resolve_relative_url
},
847 {"resolve-relative-url-test", resolve_relative_url_test
},
848 {"init", module_init
}
851 int cmd_submodule__helper(int argc
, const char **argv
, const char *prefix
)
855 die(_("submodule--helper subcommand must be "
856 "called with a subcommand"));
858 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++)
859 if (!strcmp(argv
[1], commands
[i
].cmd
))
860 return commands
[i
].fn(argc
- 1, argv
+ 1, prefix
);
862 die(_("'%s' is not a valid submodule--helper "
863 "subcommand"), argv
[1]);