[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 *max_prefix, *ps_matched = NULL;
	int max_prefix_len;
	parse_pathspec(pathspec, 0,
		       PATHSPEC_PREFER_FULL |
		       PATHSPEC_STRIP_SUBMODULE_SLASH_CHEAP,
		       prefix, argv);

	/* Find common prefix for all pathspec's */
	max_prefix = common_prefix(pathspec);
	max_prefix_len = max_prefix ? strlen(max_prefix) : 0;

	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 (!S_ISGITLINK(ce->ce_mode) ||
		    !match_pathspec(pathspec, ce->name, ce_namelen(ce),
				    max_prefix_len, ps_matched, 1))
			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++;
	}
	free(max_prefix);

	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 *path = NULL, *name = NULL, *url = NULL;
	const char *reference = NULL, *depth = NULL;
	int quiet = 0;
	FILE *submodule_dot_git;
	char *sm_gitdir, *cwd, *p;
	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);

	strbuf_addf(&sb, "%s/modules/%s", get_git_dir(), name);
	sm_gitdir = strbuf_detach(&sb, NULL);

	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. */
	if (safe_create_leading_directories_const(path) < 0)
		die(_("could not create directory '%s'"), path);

	if (path && *path)
		strbuf_addf(&sb, "%s/.git", path);
	else
		strbuf_addstr(&sb, ".git");

	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(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);

	cwd = xgetcwd();
	/* Redirect the worktree of the submodule in the superproject's config */
	if (!is_absolute_path(sm_gitdir)) {
		strbuf_addf(&sb, "%s/%s", cwd, sm_gitdir);
		free(sm_gitdir);
		sm_gitdir = strbuf_detach(&sb, NULL);
	}

	strbuf_addf(&sb, "%s/%s", cwd, path);
	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(sb.buf, sm_gitdir, &rel_path));
	strbuf_release(&sb);
	strbuf_release(&rel_path);
	free(sm_gitdir);
	free(cwd);
	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;
	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__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);

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