[thirdparty/git.git] / builtin / submodule--helper.c

#include "builtin.h"
#include "cache.h"
#include "parse-options.h"
#include "quote.h"
#include "pathspec.h"
#include "dir.h"
#include "utf8.h"
#include "submodule.h"
#include "submodule-config.h"
#include "string-list.h"
#include "run-command.h"

struct module_list {
	const struct cache_entry **entries;
	int alloc, nr;
};
#define MODULE_LIST_INIT { NULL, 0, 0 }

static int module_list_compute(int argc, const char **argv,
			       const char *prefix,
			       struct pathspec *pathspec,
			       struct module_list *list)
{
	int i, result = 0;
	char *ps_matched = NULL;
	parse_pathspec(pathspec, 0,
		       PATHSPEC_PREFER_FULL |
		       PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
		       prefix, argv);

	if (pathspec->nr)
		ps_matched = xcalloc(pathspec->nr, 1);

	if (read_cache() < 0)
		die(_("index file corrupt"));

	for (i = 0; i < active_nr; i++) {
		const struct cache_entry *ce = active_cache[i];

		if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
				    0, ps_matched, 1) ||
		    !S_ISGITLINK(ce->ce_mode))
			continue;

		ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
		list->entries[list->nr++] = ce;
		while (i + 1 < active_nr &&
		       !strcmp(ce->name, active_cache[i + 1]->name))
			/*
			 * Skip entries with the same name in different stages
			 * to make sure an entry is returned only once.
			 */
			i++;
	}

	if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
		result = -1;

	free(ps_matched);

	return result;
}

static int module_list(int argc, const char **argv, const char *prefix)
{
	int i;
	struct pathspec pathspec;
	struct module_list list = MODULE_LIST_INIT;

	struct option module_list_options[] = {
		OPT_STRING(0, "prefix", &prefix,
			   N_("path"),
			   N_("alternative anchor for relative paths")),
		OPT_END()
	};

	const char *const git_submodule_helper_usage[] = {
		N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
		NULL
	};

	argc = parse_options(argc, argv, prefix, module_list_options,
			     git_submodule_helper_usage, 0);

	if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0) {
		printf("#unmatched\n");
		return 1;
	}

	for (i = 0; i < list.nr; i++) {
		const struct cache_entry *ce = list.entries[i];

		if (ce_stage(ce))
			printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
		else
			printf("%06o %s %d\t", ce->ce_mode, sha1_to_hex(ce->sha1), ce_stage(ce));

		utf8_fprintf(stdout, "%s\n", ce->name);
	}
	return 0;
}

static int module_name(int argc, const char **argv, const char *prefix)
{
	const struct submodule *sub;

	if (argc != 2)
		usage(_("git submodule--helper name <path>"));

	gitmodules_config();
	sub = submodule_from_path(null_sha1, argv[1]);

	if (!sub)
		die(_("no submodule mapping found in .gitmodules for path '%s'"),
		    argv[1]);

	printf("%s\n", sub->name);

	return 0;
}
static int clone_submodule(const char *path, const char *gitdir, const char *url,
			   const char *depth, const char *reference, int quiet)
{
	struct child_process cp;
	child_process_init(&cp);

	argv_array_push(&cp.args, "clone");
	argv_array_push(&cp.args, "--no-checkout");
	if (quiet)
		argv_array_push(&cp.args, "--quiet");
	if (depth && *depth)
		argv_array_pushl(&cp.args, "--depth", depth, NULL);
	if (reference && *reference)
		argv_array_pushl(&cp.args, "--reference", reference, NULL);
	if (gitdir && *gitdir)
		argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);

	argv_array_push(&cp.args, url);
	argv_array_push(&cp.args, path);

	cp.git_cmd = 1;
	cp.env = local_repo_env;
	cp.no_stdin = 1;

	return run_command(&cp);
}

static int module_clone(int argc, const char **argv, const char *prefix)
{
	const char *name = NULL, *url = NULL;
	const char *reference = NULL, *depth = NULL;
	int quiet = 0;
	FILE *submodule_dot_git;
	char *p, *path = NULL, *sm_gitdir;
	struct strbuf rel_path = STRBUF_INIT;
	struct strbuf sb = STRBUF_INIT;

	struct option module_clone_options[] = {
		OPT_STRING(0, "prefix", &prefix,
			   N_("path"),
			   N_("alternative anchor for relative paths")),
		OPT_STRING(0, "path", &path,
			   N_("path"),
			   N_("where the new submodule will be cloned to")),
		OPT_STRING(0, "name", &name,
			   N_("string"),
			   N_("name of the new submodule")),
		OPT_STRING(0, "url", &url,
			   N_("string"),
			   N_("url where to clone the submodule from")),
		OPT_STRING(0, "reference", &reference,
			   N_("string"),
			   N_("reference repository")),
		OPT_STRING(0, "depth", &depth,
			   N_("string"),
			   N_("depth for shallow clones")),
		OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
		OPT_END()
	};

	const char *const git_submodule_helper_usage[] = {
		N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
		   "[--reference <repository>] [--name <name>] [--url <url>]"
		   "[--depth <depth>] [--] [<path>...]"),
		NULL
	};

	argc = parse_options(argc, argv, prefix, module_clone_options,
			     git_submodule_helper_usage, 0);

	if (!path || !*path)
		die(_("submodule--helper: unspecified or empty --path"));

	strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
	sm_gitdir = xstrdup(absolute_path(sb.buf));
	strbuf_reset(&sb);

	if (!is_absolute_path(path)) {
		strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
		path = strbuf_detach(&sb, NULL);
	} else
		path = xstrdup(path);

	if (!file_exists(sm_gitdir)) {
		if (safe_create_leading_directories_const(sm_gitdir) < 0)
			die(_("could not create directory '%s'"), sm_gitdir);
		if (clone_submodule(path, sm_gitdir, url, depth, reference, quiet))
			die(_("clone of '%s' into submodule path '%s' failed"),
			    url, path);
	} else {
		if (safe_create_leading_directories_const(path) < 0)
			die(_("could not create directory '%s'"), path);
		strbuf_addf(&sb, "%s/index", sm_gitdir);
		unlink_or_warn(sb.buf);
		strbuf_reset(&sb);
	}

	/* Write a .git file in the submodule to redirect to the superproject. */
	strbuf_addf(&sb, "%s/.git", path);
	if (safe_create_leading_directories_const(sb.buf) < 0)
		die(_("could not create leading directories of '%s'"), sb.buf);
	submodule_dot_git = fopen(sb.buf, "w");
	if (!submodule_dot_git)
		die_errno(_("cannot open file '%s'"), sb.buf);

	fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
		       relative_path(sm_gitdir, path, &rel_path));
	if (fclose(submodule_dot_git))
		die(_("could not close file %s"), sb.buf);
	strbuf_reset(&sb);
	strbuf_reset(&rel_path);

	/* Redirect the worktree of the submodule in the superproject's config */
	p = git_pathdup_submodule(path, "config");
	if (!p)
		die(_("could not get submodule directory for '%s'"), path);
	git_config_set_in_file(p, "core.worktree",
			       relative_path(path, sm_gitdir, &rel_path));
	strbuf_release(&sb);
	strbuf_release(&rel_path);
	free(sm_gitdir);
	free(path);
	free(p);
	return 0;
}

struct submodule_update_clone {
	/* index into 'list', the list of submodules to look into for cloning */
	int current;
	struct module_list list;
	unsigned warn_if_uninitialized : 1;

	/* update parameter passed via commandline */
	struct submodule_update_strategy update;

	/* configuration parameters which are passed on to the children */
	int quiet;
	const char *reference;
	const char *depth;
	const char *recursive_prefix;
	const char *prefix;

	/* Machine-readable status lines to be consumed by git-submodule.sh */
	struct string_list projectlines;

	/* If we want to stop as fast as possible and return an error */
	unsigned quickstop : 1;
};
#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
	SUBMODULE_UPDATE_STRATEGY_INIT, 0, NULL, NULL, NULL, NULL, \
	STRING_LIST_INIT_DUP, 0}

/**
 * Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
 * run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
 */
static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
					   struct child_process *child,
					   struct submodule_update_clone *suc,
					   struct strbuf *out)
{
	const struct submodule *sub = NULL;
	struct strbuf displaypath_sb = STRBUF_INIT;
	struct strbuf sb = STRBUF_INIT;
	const char *displaypath = NULL;
	char *url = NULL;
	int needs_cloning = 0;

	if (ce_stage(ce)) {
		if (suc->recursive_prefix)
			strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
		else
			strbuf_addf(&sb, "%s", ce->name);
		strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
		strbuf_addch(out, '\n');
		goto cleanup;
	}

	sub = submodule_from_path(null_sha1, ce->name);

	if (suc->recursive_prefix)
		displaypath = relative_path(suc->recursive_prefix,
					    ce->name, &displaypath_sb);
	else
		displaypath = ce->name;

	if (suc->update.type == SM_UPDATE_NONE
	    || (suc->update.type == SM_UPDATE_UNSPECIFIED
		&& sub->update_strategy.type == SM_UPDATE_NONE)) {
		strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
		strbuf_addch(out, '\n');
		goto cleanup;
	}

	/*
	 * Looking up the url in .git/config.
	 * We must not fall back to .gitmodules as we only want
	 * to process configured submodules.
	 */
	strbuf_reset(&sb);
	strbuf_addf(&sb, "submodule.%s.url", sub->name);
	git_config_get_string(sb.buf, &url);
	if (!url) {
		/*
		 * Only mention uninitialized submodules when their
		 * path have been specified
		 */
		if (suc->warn_if_uninitialized) {
			strbuf_addf(out,
				_("Submodule path '%s' not initialized"),
				displaypath);
			strbuf_addch(out, '\n');
			strbuf_addstr(out,
				_("Maybe you want to use 'update --init'?"));
			strbuf_addch(out, '\n');
		}
		goto cleanup;
	}

	strbuf_reset(&sb);
	strbuf_addf(&sb, "%s/.git", ce->name);
	needs_cloning = !file_exists(sb.buf);

	strbuf_reset(&sb);
	strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
			sha1_to_hex(ce->sha1), ce_stage(ce),
			needs_cloning, ce->name);
	string_list_append(&suc->projectlines, sb.buf);

	if (!needs_cloning)
		goto cleanup;

	child->git_cmd = 1;
	child->no_stdin = 1;
	child->stdout_to_stderr = 1;
	child->err = -1;
	argv_array_push(&child->args, "submodule--helper");
	argv_array_push(&child->args, "clone");
	if (suc->quiet)
		argv_array_push(&child->args, "--quiet");
	if (suc->prefix)
		argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
	argv_array_pushl(&child->args, "--path", sub->path, NULL);
	argv_array_pushl(&child->args, "--name", sub->name, NULL);
	argv_array_pushl(&child->args, "--url", url, NULL);
	if (suc->reference)
		argv_array_push(&child->args, suc->reference);
	if (suc->depth)
		argv_array_push(&child->args, suc->depth);

cleanup:
	free(url);
	strbuf_reset(&displaypath_sb);
	strbuf_reset(&sb);

	return needs_cloning;
}

static int update_clone_get_next_task(struct child_process *child,
				      struct strbuf *err,
				      void *suc_cb,
				      void **void_task_cb)
{
	struct submodule_update_clone *suc = suc_cb;

	for (; suc->current < suc->list.nr; suc->current++) {
		const struct cache_entry *ce = suc->list.entries[suc->current];
		if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
			suc->current++;
			return 1;
		}
	}
	return 0;
}

static int update_clone_start_failure(struct strbuf *err,
				      void *suc_cb,
				      void *void_task_cb)
{
	struct submodule_update_clone *suc = suc_cb;
	suc->quickstop = 1;
	return 1;
}

static int update_clone_task_finished(int result,
				      struct strbuf *err,
				      void *suc_cb,
				      void *void_task_cb)
{
	struct submodule_update_clone *suc = suc_cb;

	if (!result)
		return 0;

	suc->quickstop = 1;
	return 1;
}

static int update_clone(int argc, const char **argv, const char *prefix)
{
	const char *update = NULL;
	int max_jobs = -1;
	struct string_list_item *item;
	struct pathspec pathspec;
	struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;

	struct option module_update_clone_options[] = {
		OPT_STRING(0, "prefix", &prefix,
			   N_("path"),
			   N_("path into the working tree")),
		OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
			   N_("path"),
			   N_("path into the working tree, across nested "
			      "submodule boundaries")),
		OPT_STRING(0, "update", &update,
			   N_("string"),
			   N_("rebase, merge, checkout or none")),
		OPT_STRING(0, "reference", &suc.reference, N_("repo"),
			   N_("reference repository")),
		OPT_STRING(0, "depth", &suc.depth, "<depth>",
			   N_("Create a shallow clone truncated to the "
			      "specified number of revisions")),
		OPT_INTEGER('j', "jobs", &max_jobs,
			    N_("parallel jobs")),
		OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
		OPT_END()
	};

	const char *const git_submodule_helper_usage[] = {
		N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
		NULL
	};
	suc.prefix = prefix;

	argc = parse_options(argc, argv, prefix, module_update_clone_options,
			     git_submodule_helper_usage, 0);

	if (update)
		if (parse_submodule_update_strategy(update, &suc.update) < 0)
			die(_("bad value for update parameter"));

	if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
		return 1;

	if (pathspec.nr)
		suc.warn_if_uninitialized = 1;

	/* Overlay the parsed .gitmodules file with .git/config */
	gitmodules_config();
	git_config(submodule_config, NULL);

	if (max_jobs < 0)
		max_jobs = parallel_submodules();

	run_processes_parallel(max_jobs,
			       update_clone_get_next_task,
			       update_clone_start_failure,
			       update_clone_task_finished,
			       &suc);

	/*
	 * We saved the output and put it out all at once now.
	 * That means:
	 * - the listener does not have to interleave their (checkout)
	 *   work with our fetching.  The writes involved in a
	 *   checkout involve more straightforward sequential I/O.
	 * - the listener can avoid doing any work if fetching failed.
	 */
	if (suc.quickstop)
		return 1;

	for_each_string_list_item(item, &suc.projectlines)
		utf8_fprintf(stdout, "%s", item->string);

	return 0;
}

struct cmd_struct {
	const char *cmd;
	int (*fn)(int, const char **, const char *);
};

static struct cmd_struct commands[] = {
	{"list", module_list},
	{"name", module_name},
	{"clone", module_clone},
	{"update-clone", update_clone}
};

int cmd_submodule__helper(int argc, const char **argv, const char *prefix)
{
	int i;
	if (argc < 2)
		die(_("submodule--helper subcommand must be "
		      "called with a subcommand"));

	for (i = 0; i < ARRAY_SIZE(commands); i++)
		if (!strcmp(argv[1], commands[i].cmd))
			return commands[i].fn(argc - 1, argv + 1, prefix);

	die(_("'%s' is not a valid submodule--helper "
	      "subcommand"), argv[1]);
}
Commit	Line	Data
74703a1e SB	1	#include "builtin.h"
	2	#include "cache.h"
	3	#include "parse-options.h"
	4	#include "quote.h"
	5	#include "pathspec.h"
	6	#include "dir.h"
	7	#include "utf8.h"
0ea306ef SB	8	#include "submodule.h"
	9	#include "submodule-config.h"
	10	#include "string-list.h"
ee8838d1	11	#include "run-command.h"
74703a1e SB	12
	13	struct module_list {
	14	const struct cache_entry **entries;
	15	int alloc, nr;
	16	};
	17	#define MODULE_LIST_INIT { NULL, 0, 0 }
	18
	19	static int module_list_compute(int argc, const char **argv,
	20	const char *prefix,
	21	struct pathspec *pathspec,
	22	struct module_list *list)
	23	{
	24	int i, result = 0;
2b56bb7a	25	char *ps_matched = NULL;
74703a1e SB	26	parse_pathspec(pathspec, 0,
	27	PATHSPEC_PREFER_FULL \|
	28	PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
	29	prefix, argv);
	30
74703a1e SB	31	if (pathspec->nr)
	32	ps_matched = xcalloc(pathspec->nr, 1);
	33
	34	if (read_cache() < 0)
	35	die(_("index file corrupt"));
	36
	37	for (i = 0; i < active_nr; i++) {
	38	const struct cache_entry *ce = active_cache[i];
	39
84ba959b SB	40	if (!match_pathspec(pathspec, ce->name, ce_namelen(ce),
	41	0, ps_matched, 1) \|\|
	42	!S_ISGITLINK(ce->ce_mode))
74703a1e SB	43	continue;
	44
	45	ALLOC_GROW(list->entries, list->nr + 1, list->alloc);
	46	list->entries[list->nr++] = ce;
	47	while (i + 1 < active_nr &&
	48	!strcmp(ce->name, active_cache[i + 1]->name))
	49	/*
	50	* Skip entries with the same name in different stages
	51	* to make sure an entry is returned only once.
	52	*/
	53	i++;
	54	}
74703a1e SB	55
	56	if (ps_matched && report_path_error(ps_matched, pathspec, prefix))
	57	result = -1;
	58
	59	free(ps_matched);
	60
	61	return result;
	62	}
	63
	64	static int module_list(int argc, const char *argv, const char prefix)
	65	{
	66	int i;
	67	struct pathspec pathspec;
	68	struct module_list list = MODULE_LIST_INIT;
	69
	70	struct option module_list_options[] = {
	71	OPT_STRING(0, "prefix", &prefix,
	72	N_("path"),
	73	N_("alternative anchor for relative paths")),
	74	OPT_END()
	75	};
	76
	77	const char *const git_submodule_helper_usage[] = {
	78	N_("git submodule--helper list [--prefix=<path>] [<path>...]"),
	79	NULL
	80	};
	81
	82	argc = parse_options(argc, argv, prefix, module_list_options,
	83	git_submodule_helper_usage, 0);
	84
	85	if (module_list_compute(argc, argv, prefix, &pathspec, &list) < 0) {
	86	printf("#unmatched\n");
	87	return 1;
	88	}
	89
	90	for (i = 0; i < list.nr; i++) {
	91	const struct cache_entry *ce = list.entries[i];
	92
	93	if (ce_stage(ce))
	94	printf("%06o %s U\t", ce->ce_mode, sha1_to_hex(null_sha1));
	95	else
	96	printf("%06o %s %d\t", ce->ce_mode, sha1_to_hex(ce->sha1), ce_stage(ce));
	97
	98	utf8_fprintf(stdout, "%s\n", ce->name);
	99	}
	100	return 0;
	101	}
	102
0ea306ef SB	103	static int module_name(int argc, const char *argv, const char prefix)
	104	{
	105	const struct submodule *sub;
	106
	107	if (argc != 2)
	108	usage(_("git submodule--helper name <path>"));
	109
	110	gitmodules_config();
	111	sub = submodule_from_path(null_sha1, argv[1]);
	112
	113	if (!sub)
	114	die(_("no submodule mapping found in .gitmodules for path '%s'"),
	115	argv[1]);
	116
	117	printf("%s\n", sub->name);
	118
	119	return 0;
	120	}
ee8838d1 SB	121	static int clone_submodule(const char path, const char gitdir, const char *url,
	122	const char depth, const char reference, int quiet)
	123	{
	124	struct child_process cp;
	125	child_process_init(&cp);
	126
	127	argv_array_push(&cp.args, "clone");
	128	argv_array_push(&cp.args, "--no-checkout");
	129	if (quiet)
	130	argv_array_push(&cp.args, "--quiet");
	131	if (depth && *depth)
	132	argv_array_pushl(&cp.args, "--depth", depth, NULL);
	133	if (reference && *reference)
	134	argv_array_pushl(&cp.args, "--reference", reference, NULL);
	135	if (gitdir && *gitdir)
	136	argv_array_pushl(&cp.args, "--separate-git-dir", gitdir, NULL);
	137
	138	argv_array_push(&cp.args, url);
	139	argv_array_push(&cp.args, path);
	140
	141	cp.git_cmd = 1;
	142	cp.env = local_repo_env;
	143	cp.no_stdin = 1;
	144
	145	return run_command(&cp);
	146	}
	147
	148	static int module_clone(int argc, const char *argv, const char prefix)
	149	{
f8eaa0ba	150	const char name = NULL, url = NULL;
ee8838d1 SB	151	const char reference = NULL, depth = NULL;
	152	int quiet = 0;
	153	FILE *submodule_dot_git;
1ea4d9b7	154	char p, path = NULL, *sm_gitdir;
ee8838d1 SB	155	struct strbuf rel_path = STRBUF_INIT;
	156	struct strbuf sb = STRBUF_INIT;
	157
	158	struct option module_clone_options[] = {
	159	OPT_STRING(0, "prefix", &prefix,
	160	N_("path"),
	161	N_("alternative anchor for relative paths")),
	162	OPT_STRING(0, "path", &path,
	163	N_("path"),
	164	N_("where the new submodule will be cloned to")),
	165	OPT_STRING(0, "name", &name,
	166	N_("string"),
	167	N_("name of the new submodule")),
	168	OPT_STRING(0, "url", &url,
	169	N_("string"),
	170	N_("url where to clone the submodule from")),
	171	OPT_STRING(0, "reference", &reference,
	172	N_("string"),
	173	N_("reference repository")),
	174	OPT_STRING(0, "depth", &depth,
	175	N_("string"),
	176	N_("depth for shallow clones")),
	177	OPT__QUIET(&quiet, "Suppress output for cloning a submodule"),
	178	OPT_END()
	179	};
	180
	181	const char *const git_submodule_helper_usage[] = {
	182	N_("git submodule--helper clone [--prefix=<path>] [--quiet] "
	183	"[--reference <repository>] [--name <name>] [--url <url>]"
	184	"[--depth <depth>] [--] [<path>...]"),
	185	NULL
	186	};
	187
	188	argc = parse_options(argc, argv, prefix, module_clone_options,
	189	git_submodule_helper_usage, 0);
	190
3c0663e1 SB	191	if (!path \|\| !*path)
	192	die(_("submodule--helper: unspecified or empty --path"));
	193
ee8838d1	194	strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
1ea4d9b7 JH	195	sm_gitdir = xstrdup(absolute_path(sb.buf));
1ea4d9b7 JH	196	strbuf_reset(&sb);
f8eaa0ba SB	197
	198	if (!is_absolute_path(path)) {
	199	strbuf_addf(&sb, "%s/%s", get_git_work_tree(), path);
	200	path = strbuf_detach(&sb, NULL);
	201	} else
	202	path = xstrdup(path);
ee8838d1 SB	203
	204	if (!file_exists(sm_gitdir)) {
	205	if (safe_create_leading_directories_const(sm_gitdir) < 0)
	206	die(_("could not create directory '%s'"), sm_gitdir);
	207	if (clone_submodule(path, sm_gitdir, url, depth, reference, quiet))
	208	die(_("clone of '%s' into submodule path '%s' failed"),
	209	url, path);
	210	} else {
	211	if (safe_create_leading_directories_const(path) < 0)
	212	die(_("could not create directory '%s'"), path);
	213	strbuf_addf(&sb, "%s/index", sm_gitdir);
	214	unlink_or_warn(sb.buf);
	215	strbuf_reset(&sb);
	216	}
	217
	218	/* Write a .git file in the submodule to redirect to the superproject. */
3c0663e1	219	strbuf_addf(&sb, "%s/.git", path);
ee8838d1 SB	220	if (safe_create_leading_directories_const(sb.buf) < 0)
	221	die(_("could not create leading directories of '%s'"), sb.buf);
	222	submodule_dot_git = fopen(sb.buf, "w");
	223	if (!submodule_dot_git)
	224	die_errno(_("cannot open file '%s'"), sb.buf);
	225
1f15ba1f SB	226	fprintf_or_die(submodule_dot_git, "gitdir: %s\n",
1f15ba1f SB	227	relative_path(sm_gitdir, path, &rel_path));
ee8838d1 SB	228	if (fclose(submodule_dot_git))
	229	die(_("could not close file %s"), sb.buf);
	230	strbuf_reset(&sb);
	231	strbuf_reset(&rel_path);
	232
ee8838d1	233	/* Redirect the worktree of the submodule in the superproject's config */
ee8838d1 SB	234	p = git_pathdup_submodule(path, "config");
	235	if (!p)
	236	die(_("could not get submodule directory for '%s'"), path);
	237	git_config_set_in_file(p, "core.worktree",
f8eaa0ba	238	relative_path(path, sm_gitdir, &rel_path));
ee8838d1 SB	239	strbuf_release(&sb);
	240	strbuf_release(&rel_path);
	241	free(sm_gitdir);
f8eaa0ba	242	free(path);
ee8838d1 SB	243	free(p);
	244	return 0;
	245	}
74703a1e	246
48308681 SB	247	struct submodule_update_clone {
	248	/* index into 'list', the list of submodules to look into for cloning */
	249	int current;
	250	struct module_list list;
	251	unsigned warn_if_uninitialized : 1;
	252
	253	/* update parameter passed via commandline */
	254	struct submodule_update_strategy update;
	255
	256	/* configuration parameters which are passed on to the children */
	257	int quiet;
	258	const char *reference;
	259	const char *depth;
	260	const char *recursive_prefix;
	261	const char *prefix;
	262
	263	/* Machine-readable status lines to be consumed by git-submodule.sh */
	264	struct string_list projectlines;
	265
	266	/* If we want to stop as fast as possible and return an error */
	267	unsigned quickstop : 1;
	268	};
	269	#define SUBMODULE_UPDATE_CLONE_INIT {0, MODULE_LIST_INIT, 0, \
	270	SUBMODULE_UPDATE_STRATEGY_INIT, 0, NULL, NULL, NULL, NULL, \
	271	STRING_LIST_INIT_DUP, 0}
	272
	273	/**
	274	* Determine whether 'ce' needs to be cloned. If so, prepare the 'child' to
	275	* run the clone. Returns 1 if 'ce' needs to be cloned, 0 otherwise.
	276	*/
	277	static int prepare_to_clone_next_submodule(const struct cache_entry *ce,
	278	struct child_process *child,
	279	struct submodule_update_clone *suc,
	280	struct strbuf *out)
	281	{
	282	const struct submodule *sub = NULL;
	283	struct strbuf displaypath_sb = STRBUF_INIT;
	284	struct strbuf sb = STRBUF_INIT;
	285	const char *displaypath = NULL;
	286	char *url = NULL;
	287	int needs_cloning = 0;
	288
	289	if (ce_stage(ce)) {
	290	if (suc->recursive_prefix)
	291	strbuf_addf(&sb, "%s/%s", suc->recursive_prefix, ce->name);
	292	else
	293	strbuf_addf(&sb, "%s", ce->name);
	294	strbuf_addf(out, _("Skipping unmerged submodule %s"), sb.buf);
	295	strbuf_addch(out, '\n');
	296	goto cleanup;
	297	}
	298
	299	sub = submodule_from_path(null_sha1, ce->name);
	300
	301	if (suc->recursive_prefix)
	302	displaypath = relative_path(suc->recursive_prefix,
	303	ce->name, &displaypath_sb);
	304	else
	305	displaypath = ce->name;
	306
	307	if (suc->update.type == SM_UPDATE_NONE
	308	\|\| (suc->update.type == SM_UPDATE_UNSPECIFIED
	309	&& sub->update_strategy.type == SM_UPDATE_NONE)) {
	310	strbuf_addf(out, _("Skipping submodule '%s'"), displaypath);
311	strbuf_addch(out, '\n');
312	goto cleanup;
313	}
314
315	/*
316	* Looking up the url in .git/config.
317	* We must not fall back to .gitmodules as we only want
318	* to process configured submodules.
319	*/
320	strbuf_reset(&sb);
321	strbuf_addf(&sb, "submodule.%s.url", sub->name);
322	git_config_get_string(sb.buf, &url);
323	if (!url) {
324	/*
325	* Only mention uninitialized submodules when their
326	* path have been specified
327	*/
328	if (suc->warn_if_uninitialized) {
329	strbuf_addf(out,
330	_("Submodule path '%s' not initialized"),
331	displaypath);
332	strbuf_addch(out, '\n');
333	strbuf_addstr(out,
334	_("Maybe you want to use 'update --init'?"));
335	strbuf_addch(out, '\n');
336	}
337	goto cleanup;
338	}
339
340	strbuf_reset(&sb);
341	strbuf_addf(&sb, "%s/.git", ce->name);
342	needs_cloning = !file_exists(sb.buf);
343
344	strbuf_reset(&sb);
345	strbuf_addf(&sb, "%06o %s %d %d\t%s\n", ce->ce_mode,
346	sha1_to_hex(ce->sha1), ce_stage(ce),
347	needs_cloning, ce->name);
348	string_list_append(&suc->projectlines, sb.buf);
349
350	if (!needs_cloning)
351	goto cleanup;
352
353	child->git_cmd = 1;
354	child->no_stdin = 1;
355	child->stdout_to_stderr = 1;
356	child->err = -1;
357	argv_array_push(&child->args, "submodule--helper");
358	argv_array_push(&child->args, "clone");
359	if (suc->quiet)
360	argv_array_push(&child->args, "--quiet");
361	if (suc->prefix)
362	argv_array_pushl(&child->args, "--prefix", suc->prefix, NULL);
363	argv_array_pushl(&child->args, "--path", sub->path, NULL);
364	argv_array_pushl(&child->args, "--name", sub->name, NULL);
365	argv_array_pushl(&child->args, "--url", url, NULL);
366	if (suc->reference)
367	argv_array_push(&child->args, suc->reference);
368	if (suc->depth)
369	argv_array_push(&child->args, suc->depth);
370
371	cleanup:
372	free(url);
373	strbuf_reset(&displaypath_sb);
374	strbuf_reset(&sb);
375
376	return needs_cloning;
377	}
378
379	static int update_clone_get_next_task(struct child_process *child,
380	struct strbuf *err,
381	void *suc_cb,
382	void **void_task_cb)
383	{
384	struct submodule_update_clone *suc = suc_cb;
385
386	for (; suc->current < suc->list.nr; suc->current++) {
387	const struct cache_entry *ce = suc->list.entries[suc->current];
388	if (prepare_to_clone_next_submodule(ce, child, suc, err)) {
389	suc->current++;
390	return 1;
391	}
392	}
393	return 0;
394	}
395
396	static int update_clone_start_failure(struct strbuf *err,
397	void *suc_cb,
398	void *void_task_cb)
399	{
400	struct submodule_update_clone *suc = suc_cb;
401	suc->quickstop = 1;
402	return 1;
403	}
404
405	static int update_clone_task_finished(int result,
406	struct strbuf *err,
407	void *suc_cb,
408	void *void_task_cb)
409	{
410	struct submodule_update_clone *suc = suc_cb;
411
412	if (!result)
413	return 0;
414
415	suc->quickstop = 1;
416	return 1;
417	}
418
419	static int update_clone(int argc, const char *argv, const char prefix)
420	{
421	const char *update = NULL;
2335b870	422	int max_jobs = -1;
48308681 SB	423	struct string_list_item *item;
	424	struct pathspec pathspec;
	425	struct submodule_update_clone suc = SUBMODULE_UPDATE_CLONE_INIT;
	426
	427	struct option module_update_clone_options[] = {
	428	OPT_STRING(0, "prefix", &prefix,
	429	N_("path"),
	430	N_("path into the working tree")),
	431	OPT_STRING(0, "recursive-prefix", &suc.recursive_prefix,
	432	N_("path"),
	433	N_("path into the working tree, across nested "
	434	"submodule boundaries")),
	435	OPT_STRING(0, "update", &update,
	436	N_("string"),
	437	N_("rebase, merge, checkout or none")),
	438	OPT_STRING(0, "reference", &suc.reference, N_("repo"),
	439	N_("reference repository")),
	440	OPT_STRING(0, "depth", &suc.depth, "<depth>",
	441	N_("Create a shallow clone truncated to the "
	442	"specified number of revisions")),
2335b870 SB	443	OPT_INTEGER('j', "jobs", &max_jobs,
2335b870 SB	444	N_("parallel jobs")),
48308681 SB	445	OPT__QUIET(&suc.quiet, N_("don't print cloning progress")),
	446	OPT_END()
	447	};
	448
	449	const char *const git_submodule_helper_usage[] = {
	450	N_("git submodule--helper update_clone [--prefix=<path>] [<path>...]"),
	451	NULL
	452	};
	453	suc.prefix = prefix;
	454
	455	argc = parse_options(argc, argv, prefix, module_update_clone_options,
	456	git_submodule_helper_usage, 0);
	457
	458	if (update)
	459	if (parse_submodule_update_strategy(update, &suc.update) < 0)
	460	die(_("bad value for update parameter"));
	461
	462	if (module_list_compute(argc, argv, prefix, &pathspec, &suc.list) < 0)
	463	return 1;
	464
	465	if (pathspec.nr)
	466	suc.warn_if_uninitialized = 1;
	467
	468	/* Overlay the parsed .gitmodules file with .git/config */
	469	gitmodules_config();
	470	git_config(submodule_config, NULL);
	471
2335b870 SB	472	if (max_jobs < 0)
	473	max_jobs = parallel_submodules();
	474
	475	run_processes_parallel(max_jobs,
48308681 SB	476	update_clone_get_next_task,
	477	update_clone_start_failure,
	478	update_clone_task_finished,
	479	&suc);
	480
	481	/*
	482	* We saved the output and put it out all at once now.
	483	* That means:
	484	* - the listener does not have to interleave their (checkout)
	485	* work with our fetching. The writes involved in a
	486	* checkout involve more straightforward sequential I/O.
	487	* - the listener can avoid doing any work if fetching failed.
	488	*/
	489	if (suc.quickstop)
	490	return 1;
	491
	492	for_each_string_list_item(item, &suc.projectlines)
	493	utf8_fprintf(stdout, "%s", item->string);
	494
	495	return 0;
	496	}
	497
74703a1e SB	498	struct cmd_struct {
	499	const char *cmd;
	500	int (fn)(int, const char , const char );
	501	};
	502
	503	static struct cmd_struct commands[] = {
	504	{"list", module_list},
0ea306ef	505	{"name", module_name},
ee8838d1	506	{"clone", module_clone},
48308681	507	{"update-clone", update_clone}
74703a1e SB	508	};
	509
	510	int cmd_submodule__helper(int argc, const char *argv, const char prefix)
	511	{
	512	int i;
	513	if (argc < 2)
cdc04b65	514	die(_("submodule--helper subcommand must be "
74703a1e SB	515	"called with a subcommand"));
	516
	517	for (i = 0; i < ARRAY_SIZE(commands); i++)
	518	if (!strcmp(argv[1], commands[i].cmd))
	519	return commands[i].fn(argc - 1, argv + 1, prefix);
	520
cdc04b65	521	die(_("'%s' is not a valid submodule--helper "
74703a1e SB	522	"subcommand"), argv[1]);
74703a1e SB	523	}