[thirdparty/git.git] / submodule-config.c

#include "cache.h"
#include "submodule-config.h"
#include "submodule.h"
#include "strbuf.h"

/*
 * submodule cache lookup structure
 * There is one shared set of 'struct submodule' entries which can be
 * looked up by their sha1 blob id of the .gitmodule file and either
 * using path or name as key.
 * for_path stores submodule entries with path as key
 * for_name stores submodule entries with name as key
 */
struct submodule_cache {
	struct hashmap for_path;
	struct hashmap for_name;
};

/*
 * thin wrapper struct needed to insert 'struct submodule' entries to
 * the hashmap
 */
struct submodule_entry {
	struct hashmap_entry ent;
	struct submodule *config;
};

enum lookup_type {
	lookup_name,
	lookup_path
};

static struct submodule_cache the_submodule_cache;
static int is_cache_init;

static int config_path_cmp(const struct submodule_entry *a,
			   const struct submodule_entry *b,
			   const void *unused)
{
	return strcmp(a->config->path, b->config->path) ||
	       hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
}

static int config_name_cmp(const struct submodule_entry *a,
			   const struct submodule_entry *b,
			   const void *unused)
{
	return strcmp(a->config->name, b->config->name) ||
	       hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
}

static void cache_init(struct submodule_cache *cache)
{
	hashmap_init(&cache->for_path, (hashmap_cmp_fn) config_path_cmp, 0);
	hashmap_init(&cache->for_name, (hashmap_cmp_fn) config_name_cmp, 0);
}

static void free_one_config(struct submodule_entry *entry)
{
	free((void *) entry->config->path);
	free((void *) entry->config->name);
	free((void *) entry->config->branch);
	free((void *) entry->config->update_strategy.command);
	free(entry->config);
}

static void cache_free(struct submodule_cache *cache)
{
	struct hashmap_iter iter;
	struct submodule_entry *entry;

	/*
	 * We iterate over the name hash here to be symmetric with the
	 * allocation of struct submodule entries. Each is allocated by
	 * their .gitmodule blob sha1 and submodule name.
	 */
	hashmap_iter_init(&cache->for_name, &iter);
	while ((entry = hashmap_iter_next(&iter)))
		free_one_config(entry);

	hashmap_free(&cache->for_path, 1);
	hashmap_free(&cache->for_name, 1);
}

static unsigned int hash_sha1_string(const unsigned char *sha1,
				     const char *string)
{
	return memhash(sha1, 20) + strhash(string);
}

static void cache_put_path(struct submodule_cache *cache,
			   struct submodule *submodule)
{
	unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
					     submodule->path);
	struct submodule_entry *e = xmalloc(sizeof(*e));
	hashmap_entry_init(e, hash);
	e->config = submodule;
	hashmap_put(&cache->for_path, e);
}

static void cache_remove_path(struct submodule_cache *cache,
			      struct submodule *submodule)
{
	unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
					     submodule->path);
	struct submodule_entry e;
	struct submodule_entry *removed;
	hashmap_entry_init(&e, hash);
	e.config = submodule;
	removed = hashmap_remove(&cache->for_path, &e, NULL);
	free(removed);
}

static void cache_add(struct submodule_cache *cache,
		      struct submodule *submodule)
{
	unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
					     submodule->name);
	struct submodule_entry *e = xmalloc(sizeof(*e));
	hashmap_entry_init(e, hash);
	e->config = submodule;
	hashmap_add(&cache->for_name, e);
}

static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
		const unsigned char *gitmodules_sha1, const char *path)
{
	struct submodule_entry *entry;
	unsigned int hash = hash_sha1_string(gitmodules_sha1, path);
	struct submodule_entry key;
	struct submodule key_config;

	hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
	key_config.path = path;

	hashmap_entry_init(&key, hash);
	key.config = &key_config;

	entry = hashmap_get(&cache->for_path, &key, NULL);
	if (entry)
		return entry->config;
	return NULL;
}

static struct submodule *cache_lookup_name(struct submodule_cache *cache,
		const unsigned char *gitmodules_sha1, const char *name)
{
	struct submodule_entry *entry;
	unsigned int hash = hash_sha1_string(gitmodules_sha1, name);
	struct submodule_entry key;
	struct submodule key_config;

	hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
	key_config.name = name;

	hashmap_entry_init(&key, hash);
	key.config = &key_config;

	entry = hashmap_get(&cache->for_name, &key, NULL);
	if (entry)
		return entry->config;
	return NULL;
}

static int name_and_item_from_var(const char *var, struct strbuf *name,
				  struct strbuf *item)
{
	const char *subsection, *key;
	int subsection_len, parse;
	parse = parse_config_key(var, "submodule", &subsection,
			&subsection_len, &key);
	if (parse < 0 || !subsection)
		return 0;

	strbuf_add(name, subsection, subsection_len);
	strbuf_addstr(item, key);

	return 1;
}

static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
		const unsigned char *gitmodules_sha1, const char *name)
{
	struct submodule *submodule;
	struct strbuf name_buf = STRBUF_INIT;

	submodule = cache_lookup_name(cache, gitmodules_sha1, name);
	if (submodule)
		return submodule;

	submodule = xmalloc(sizeof(*submodule));

	strbuf_addstr(&name_buf, name);
	submodule->name = strbuf_detach(&name_buf, NULL);

	submodule->path = NULL;
	submodule->url = NULL;
	submodule->update_strategy.type = SM_UPDATE_UNSPECIFIED;
	submodule->update_strategy.command = NULL;
	submodule->fetch_recurse = RECURSE_SUBMODULES_NONE;
	submodule->ignore = NULL;
	submodule->branch = NULL;
	submodule->recommend_shallow = -1;

	hashcpy(submodule->gitmodules_sha1, gitmodules_sha1);

	cache_add(cache, submodule);

	return submodule;
}

static int parse_fetch_recurse(const char *opt, const char *arg,
			       int die_on_error)
{
	switch (git_config_maybe_bool(opt, arg)) {
	case 1:
		return RECURSE_SUBMODULES_ON;
	case 0:
		return RECURSE_SUBMODULES_OFF;
	default:
		if (!strcmp(arg, "on-demand"))
			return RECURSE_SUBMODULES_ON_DEMAND;

		if (die_on_error)
			die("bad %s argument: %s", opt, arg);
		else
			return RECURSE_SUBMODULES_ERROR;
	}
}

int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
{
	return parse_fetch_recurse(opt, arg, 1);
}

static int parse_push_recurse(const char *opt, const char *arg,
			       int die_on_error)
{
	switch (git_config_maybe_bool(opt, arg)) {
	case 1:
		/* There's no simple "on" value when pushing */
		if (die_on_error)
			die("bad %s argument: %s", opt, arg);
		else
			return RECURSE_SUBMODULES_ERROR;
	case 0:
		return RECURSE_SUBMODULES_OFF;
	default:
		if (!strcmp(arg, "on-demand"))
			return RECURSE_SUBMODULES_ON_DEMAND;
		else if (!strcmp(arg, "check"))
			return RECURSE_SUBMODULES_CHECK;
		else if (die_on_error)
			die("bad %s argument: %s", opt, arg);
		else
			return RECURSE_SUBMODULES_ERROR;
	}
}

int parse_push_recurse_submodules_arg(const char *opt, const char *arg)
{
	return parse_push_recurse(opt, arg, 1);
}

static void warn_multiple_config(const unsigned char *commit_sha1,
				 const char *name, const char *option)
{
	const char *commit_string = "WORKTREE";
	if (commit_sha1)
		commit_string = sha1_to_hex(commit_sha1);
	warning("%s:.gitmodules, multiple configurations found for "
			"'submodule.%s.%s'. Skipping second one!",
			commit_string, name, option);
}

struct parse_config_parameter {
	struct submodule_cache *cache;
	const unsigned char *commit_sha1;
	const unsigned char *gitmodules_sha1;
	int overwrite;
};

static int parse_config(const char *var, const char *value, void *data)
{
	struct parse_config_parameter *me = data;
	struct submodule *submodule;
	struct strbuf name = STRBUF_INIT, item = STRBUF_INIT;
	int ret = 0;

	/* this also ensures that we only parse submodule entries */
	if (!name_and_item_from_var(var, &name, &item))
		return 0;

	submodule = lookup_or_create_by_name(me->cache,
					     me->gitmodules_sha1,
					     name.buf);

	if (!strcmp(item.buf, "path")) {
		if (!value)
			ret = config_error_nonbool(var);
		else if (!me->overwrite && submodule->path)
			warn_multiple_config(me->commit_sha1, submodule->name,
					"path");
		else {
			if (submodule->path)
				cache_remove_path(me->cache, submodule);
			free((void *) submodule->path);
			submodule->path = xstrdup(value);
			cache_put_path(me->cache, submodule);
		}
	} else if (!strcmp(item.buf, "fetchrecursesubmodules")) {
		/* when parsing worktree configurations we can die early */
		int die_on_error = is_null_sha1(me->gitmodules_sha1);
		if (!me->overwrite &&
		    submodule->fetch_recurse != RECURSE_SUBMODULES_NONE)
			warn_multiple_config(me->commit_sha1, submodule->name,
					"fetchrecursesubmodules");
		else
			submodule->fetch_recurse = parse_fetch_recurse(
								var, value,
								die_on_error);
	} else if (!strcmp(item.buf, "ignore")) {
		if (!value)
			ret = config_error_nonbool(var);
		else if (!me->overwrite && submodule->ignore)
			warn_multiple_config(me->commit_sha1, submodule->name,
					"ignore");
		else if (strcmp(value, "untracked") &&
			 strcmp(value, "dirty") &&
			 strcmp(value, "all") &&
			 strcmp(value, "none"))
			warning("Invalid parameter '%s' for config option "
					"'submodule.%s.ignore'", value, var);
		else {
			free((void *) submodule->ignore);
			submodule->ignore = xstrdup(value);
		}
	} else if (!strcmp(item.buf, "url")) {
		if (!value) {
			ret = config_error_nonbool(var);
		} else if (!me->overwrite && submodule->url) {
			warn_multiple_config(me->commit_sha1, submodule->name,
					"url");
		} else {
			free((void *) submodule->url);
			submodule->url = xstrdup(value);
		}
	} else if (!strcmp(item.buf, "update")) {
		if (!value)
			ret = config_error_nonbool(var);
		else if (!me->overwrite &&
			 submodule->update_strategy.type != SM_UPDATE_UNSPECIFIED)
			warn_multiple_config(me->commit_sha1, submodule->name,
					     "update");
		else if (parse_submodule_update_strategy(value,
			 &submodule->update_strategy) < 0)
				die(_("invalid value for %s"), var);
	} else if (!strcmp(item.buf, "shallow")) {
		if (!me->overwrite && submodule->recommend_shallow != -1)
			warn_multiple_config(me->commit_sha1, submodule->name,
					     "shallow");
		else
			submodule->recommend_shallow =
				git_config_bool(var, value);
	} else if (!strcmp(item.buf, "branch")) {
		if (!me->overwrite && submodule->branch)
			warn_multiple_config(me->commit_sha1, submodule->name,
					     "branch");
		else {
			free((void *)submodule->branch);
			submodule->branch = xstrdup(value);
		}
	}

	strbuf_release(&name);
	strbuf_release(&item);

	return ret;
}

static int gitmodule_sha1_from_commit(const unsigned char *commit_sha1,
				      unsigned char *gitmodules_sha1,
				      struct strbuf *rev)
{
	int ret = 0;

	if (is_null_sha1(commit_sha1)) {
		hashclr(gitmodules_sha1);
		return 1;
	}

	strbuf_addf(rev, "%s:.gitmodules", sha1_to_hex(commit_sha1));
	if (get_sha1(rev->buf, gitmodules_sha1) >= 0)
		ret = 1;

	return ret;
}

/* This does a lookup of a submodule configuration by name or by path
 * (key) with on-demand reading of the appropriate .gitmodules from
 * revisions.
 */
static const struct submodule *config_from(struct submodule_cache *cache,
		const unsigned char *commit_sha1, const char *key,
		enum lookup_type lookup_type)
{
	struct strbuf rev = STRBUF_INIT;
	unsigned long config_size;
	char *config = NULL;
	unsigned char sha1[20];
	enum object_type type;
	const struct submodule *submodule = NULL;
	struct parse_config_parameter parameter;

	/*
	 * If any parameter except the cache is a NULL pointer just
	 * return the first submodule. Can be used to check whether
	 * there are any submodules parsed.
	 */
	if (!commit_sha1 || !key) {
		struct hashmap_iter iter;
		struct submodule_entry *entry;

		entry = hashmap_iter_first(&cache->for_name, &iter);
		if (!entry)
			return NULL;
		return entry->config;
	}

	if (!gitmodule_sha1_from_commit(commit_sha1, sha1, &rev))
		goto out;

	switch (lookup_type) {
	case lookup_name:
		submodule = cache_lookup_name(cache, sha1, key);
		break;
	case lookup_path:
		submodule = cache_lookup_path(cache, sha1, key);
		break;
	}
	if (submodule)
		goto out;

	config = read_sha1_file(sha1, &type, &config_size);
	if (!config || type != OBJ_BLOB)
		goto out;

	/* fill the submodule config into the cache */
	parameter.cache = cache;
	parameter.commit_sha1 = commit_sha1;
	parameter.gitmodules_sha1 = sha1;
	parameter.overwrite = 0;
	git_config_from_mem(parse_config, CONFIG_ORIGIN_SUBMODULE_BLOB, rev.buf,
			config, config_size, &parameter);
	strbuf_release(&rev);
	free(config);

	switch (lookup_type) {
	case lookup_name:
		return cache_lookup_name(cache, sha1, key);
	case lookup_path:
		return cache_lookup_path(cache, sha1, key);
	default:
		return NULL;
	}

out:
	strbuf_release(&rev);
	free(config);
	return submodule;
}

static const struct submodule *config_from_path(struct submodule_cache *cache,
		const unsigned char *commit_sha1, const char *path)
{
	return config_from(cache, commit_sha1, path, lookup_path);
}

static const struct submodule *config_from_name(struct submodule_cache *cache,
		const unsigned char *commit_sha1, const char *name)
{
	return config_from(cache, commit_sha1, name, lookup_name);
}

static void ensure_cache_init(void)
{
	if (is_cache_init)
		return;

	cache_init(&the_submodule_cache);
	is_cache_init = 1;
}

int parse_submodule_config_option(const char *var, const char *value)
{
	struct parse_config_parameter parameter;
	parameter.cache = &the_submodule_cache;
	parameter.commit_sha1 = NULL;
	parameter.gitmodules_sha1 = null_sha1;
	parameter.overwrite = 1;

	ensure_cache_init();
	return parse_config(var, value, &parameter);
}

const struct submodule *submodule_from_name(const unsigned char *commit_sha1,
		const char *name)
{
	ensure_cache_init();
	return config_from_name(&the_submodule_cache, commit_sha1, name);
}

const struct submodule *submodule_from_path(const unsigned char *commit_sha1,
		const char *path)
{
	ensure_cache_init();
	return config_from_path(&the_submodule_cache, commit_sha1, path);
}

void submodule_free(void)
{
	cache_free(&the_submodule_cache);
	is_cache_init = 0;
}
Commit	Line	Data
959b5455 HV	1	#include "cache.h"
	2	#include "submodule-config.h"
	3	#include "submodule.h"
	4	#include "strbuf.h"
	5
	6	/*
	7	* submodule cache lookup structure
	8	* There is one shared set of 'struct submodule' entries which can be
	9	* looked up by their sha1 blob id of the .gitmodule file and either
	10	* using path or name as key.
	11	* for_path stores submodule entries with path as key
	12	* for_name stores submodule entries with name as key
	13	*/
	14	struct submodule_cache {
	15	struct hashmap for_path;
	16	struct hashmap for_name;
	17	};
	18
	19	/*
	20	* thin wrapper struct needed to insert 'struct submodule' entries to
	21	* the hashmap
	22	*/
	23	struct submodule_entry {
	24	struct hashmap_entry ent;
	25	struct submodule *config;
	26	};
	27
	28	enum lookup_type {
	29	lookup_name,
	30	lookup_path
	31	};
	32
99dab168	33	static struct submodule_cache the_submodule_cache;
959b5455 HV	34	static int is_cache_init;
	35
	36	static int config_path_cmp(const struct submodule_entry *a,
	37	const struct submodule_entry *b,
	38	const void *unused)
	39	{
	40	return strcmp(a->config->path, b->config->path) \|\|
	41	hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
	42	}
	43
	44	static int config_name_cmp(const struct submodule_entry *a,
	45	const struct submodule_entry *b,
	46	const void *unused)
	47	{
	48	return strcmp(a->config->name, b->config->name) \|\|
	49	hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
	50	}
	51
	52	static void cache_init(struct submodule_cache *cache)
	53	{
	54	hashmap_init(&cache->for_path, (hashmap_cmp_fn) config_path_cmp, 0);
	55	hashmap_init(&cache->for_name, (hashmap_cmp_fn) config_name_cmp, 0);
	56	}
	57
	58	static void free_one_config(struct submodule_entry *entry)
	59	{
	60	free((void *) entry->config->path);
	61	free((void *) entry->config->name);
b5944f34	62	free((void *) entry->config->branch);
ea2fa5a3	63	free((void *) entry->config->update_strategy.command);
959b5455 HV	64	free(entry->config);
	65	}
	66
	67	static void cache_free(struct submodule_cache *cache)
	68	{
	69	struct hashmap_iter iter;
	70	struct submodule_entry *entry;
	71
	72	/*
	73	* We iterate over the name hash here to be symmetric with the
	74	* allocation of struct submodule entries. Each is allocated by
	75	* their .gitmodule blob sha1 and submodule name.
	76	*/
	77	hashmap_iter_init(&cache->for_name, &iter);
	78	while ((entry = hashmap_iter_next(&iter)))
	79	free_one_config(entry);
	80
	81	hashmap_free(&cache->for_path, 1);
	82	hashmap_free(&cache->for_name, 1);
	83	}
	84
	85	static unsigned int hash_sha1_string(const unsigned char *sha1,
	86	const char *string)
	87	{
	88	return memhash(sha1, 20) + strhash(string);
	89	}
	90
	91	static void cache_put_path(struct submodule_cache *cache,
	92	struct submodule *submodule)
	93	{
	94	unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
	95	submodule->path);
	96	struct submodule_entry e = xmalloc(sizeof(e));
	97	hashmap_entry_init(e, hash);
	98	e->config = submodule;
	99	hashmap_put(&cache->for_path, e);
	100	}
	101
	102	static void cache_remove_path(struct submodule_cache *cache,
	103	struct submodule *submodule)
	104	{
	105	unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
	106	submodule->path);
	107	struct submodule_entry e;
	108	struct submodule_entry *removed;
	109	hashmap_entry_init(&e, hash);
	110	e.config = submodule;
	111	removed = hashmap_remove(&cache->for_path, &e, NULL);
	112	free(removed);
	113	}
	114
	115	static void cache_add(struct submodule_cache *cache,
	116	struct submodule *submodule)
	117	{
	118	unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
	119	submodule->name);
	120	struct submodule_entry e = xmalloc(sizeof(e));
	121	hashmap_entry_init(e, hash);
	122	e->config = submodule;
	123	hashmap_add(&cache->for_name, e);
	124	}
	125
	126	static const struct submodule cache_lookup_path(struct submodule_cache cache,
	127	const unsigned char gitmodules_sha1, const char path)
128	{
129	struct submodule_entry *entry;
130	unsigned int hash = hash_sha1_string(gitmodules_sha1, path);
131	struct submodule_entry key;
132	struct submodule key_config;
133
134	hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
135	key_config.path = path;
136
137	hashmap_entry_init(&key, hash);
138	key.config = &key_config;
139
140	entry = hashmap_get(&cache->for_path, &key, NULL);
141	if (entry)
142	return entry->config;
143	return NULL;
144	}
145
146	static struct submodule cache_lookup_name(struct submodule_cache cache,
147	const unsigned char gitmodules_sha1, const char name)
148	{
149	struct submodule_entry *entry;
150	unsigned int hash = hash_sha1_string(gitmodules_sha1, name);
151	struct submodule_entry key;
152	struct submodule key_config;
153
154	hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
155	key_config.name = name;
156
157	hashmap_entry_init(&key, hash);
158	key.config = &key_config;
159
160	entry = hashmap_get(&cache->for_name, &key, NULL);
161	if (entry)
162	return entry->config;
163	return NULL;
164	}
165
166	static int name_and_item_from_var(const char var, struct strbuf name,
167	struct strbuf *item)
168	{
169	const char subsection, key;
170	int subsection_len, parse;
171	parse = parse_config_key(var, "submodule", &subsection,
172	&subsection_len, &key);
173	if (parse < 0 \|\| !subsection)
174	return 0;
175
176	strbuf_add(name, subsection, subsection_len);
177	strbuf_addstr(item, key);
178
179	return 1;
180	}
181
182	static struct submodule lookup_or_create_by_name(struct submodule_cache cache,
183	const unsigned char gitmodules_sha1, const char name)
184	{
185	struct submodule *submodule;
186	struct strbuf name_buf = STRBUF_INIT;
187
188	submodule = cache_lookup_name(cache, gitmodules_sha1, name);
189	if (submodule)
190	return submodule;
191
192	submodule = xmalloc(sizeof(*submodule));
193
194	strbuf_addstr(&name_buf, name);
195	submodule->name = strbuf_detach(&name_buf, NULL);
196
197	submodule->path = NULL;
198	submodule->url = NULL;
ea2fa5a3 SB	199	submodule->update_strategy.type = SM_UPDATE_UNSPECIFIED;
ea2fa5a3 SB	200	submodule->update_strategy.command = NULL;
959b5455 HV	201	submodule->fetch_recurse = RECURSE_SUBMODULES_NONE;
959b5455 HV	202	submodule->ignore = NULL;
b5944f34	203	submodule->branch = NULL;
37f52e93	204	submodule->recommend_shallow = -1;
959b5455 HV	205
	206	hashcpy(submodule->gitmodules_sha1, gitmodules_sha1);
	207
	208	cache_add(cache, submodule);
	209
	210	return submodule;
	211	}
	212
027771fc HV	213	static int parse_fetch_recurse(const char opt, const char arg,
	214	int die_on_error)
	215	{
	216	switch (git_config_maybe_bool(opt, arg)) {
	217	case 1:
	218	return RECURSE_SUBMODULES_ON;
	219	case 0:
	220	return RECURSE_SUBMODULES_OFF;
	221	default:
	222	if (!strcmp(arg, "on-demand"))
	223	return RECURSE_SUBMODULES_ON_DEMAND;
	224
	225	if (die_on_error)
	226	die("bad %s argument: %s", opt, arg);
	227	else
	228	return RECURSE_SUBMODULES_ERROR;
	229	}
	230	}
	231
	232	int parse_fetch_recurse_submodules_arg(const char opt, const char arg)
	233	{
	234	return parse_fetch_recurse(opt, arg, 1);
	235	}
	236
b33a15b0 MC	237	static int parse_push_recurse(const char opt, const char arg,
	238	int die_on_error)
	239	{
	240	switch (git_config_maybe_bool(opt, arg)) {
	241	case 1:
	242	/* There's no simple "on" value when pushing */
	243	if (die_on_error)
	244	die("bad %s argument: %s", opt, arg);
	245	else
	246	return RECURSE_SUBMODULES_ERROR;
	247	case 0:
	248	return RECURSE_SUBMODULES_OFF;
	249	default:
	250	if (!strcmp(arg, "on-demand"))
	251	return RECURSE_SUBMODULES_ON_DEMAND;
	252	else if (!strcmp(arg, "check"))
	253	return RECURSE_SUBMODULES_CHECK;
	254	else if (die_on_error)
	255	die("bad %s argument: %s", opt, arg);
	256	else
	257	return RECURSE_SUBMODULES_ERROR;
	258	}
	259	}
	260
	261	int parse_push_recurse_submodules_arg(const char opt, const char arg)
	262	{
	263	return parse_push_recurse(opt, arg, 1);
	264	}
	265
959b5455 HV	266	static void warn_multiple_config(const unsigned char *commit_sha1,
	267	const char name, const char option)
	268	{
	269	const char *commit_string = "WORKTREE";
	270	if (commit_sha1)
	271	commit_string = sha1_to_hex(commit_sha1);
	272	warning("%s:.gitmodules, multiple configurations found for "
	273	"'submodule.%s.%s'. Skipping second one!",
	274	commit_string, name, option);
	275	}
	276
	277	struct parse_config_parameter {
	278	struct submodule_cache *cache;
	279	const unsigned char *commit_sha1;
	280	const unsigned char *gitmodules_sha1;
	281	int overwrite;
	282	};
	283
	284	static int parse_config(const char var, const char value, void *data)
	285	{
	286	struct parse_config_parameter *me = data;
	287	struct submodule *submodule;
	288	struct strbuf name = STRBUF_INIT, item = STRBUF_INIT;
	289	int ret = 0;
	290
	291	/* this also ensures that we only parse submodule entries */
	292	if (!name_and_item_from_var(var, &name, &item))
	293	return 0;
	294
147875fd SB	295	submodule = lookup_or_create_by_name(me->cache,
	296	me->gitmodules_sha1,
	297	name.buf);
959b5455 HV	298
959b5455 HV	299	if (!strcmp(item.buf, "path")) {
147875fd	300	if (!value)
959b5455	301	ret = config_error_nonbool(var);
f73da110	302	else if (!me->overwrite && submodule->path)
959b5455 HV	303	warn_multiple_config(me->commit_sha1, submodule->name,
959b5455 HV	304	"path");
147875fd SB	305	else {
	306	if (submodule->path)
	307	cache_remove_path(me->cache, submodule);
	308	free((void *) submodule->path);
	309	submodule->path = xstrdup(value);
	310	cache_put_path(me->cache, submodule);
959b5455	311	}
959b5455	312	} else if (!strcmp(item.buf, "fetchrecursesubmodules")) {
027771fc HV	313	/* when parsing worktree configurations we can die early */
027771fc HV	314	int die_on_error = is_null_sha1(me->gitmodules_sha1);
959b5455	315	if (!me->overwrite &&
147875fd	316	submodule->fetch_recurse != RECURSE_SUBMODULES_NONE)
959b5455 HV	317	warn_multiple_config(me->commit_sha1, submodule->name,
959b5455 HV	318	"fetchrecursesubmodules");
147875fd SB	319	else
	320	submodule->fetch_recurse = parse_fetch_recurse(
	321	var, value,
027771fc	322	die_on_error);
959b5455	323	} else if (!strcmp(item.buf, "ignore")) {
147875fd SB	324	if (!value)
147875fd SB	325	ret = config_error_nonbool(var);
f73da110	326	else if (!me->overwrite && submodule->ignore)
959b5455 HV	327	warn_multiple_config(me->commit_sha1, submodule->name,
959b5455 HV	328	"ignore");
147875fd SB	329	else if (strcmp(value, "untracked") &&
	330	strcmp(value, "dirty") &&
	331	strcmp(value, "all") &&
	332	strcmp(value, "none"))
959b5455 HV	333	warning("Invalid parameter '%s' for config option "
959b5455 HV	334	"'submodule.%s.ignore'", value, var);
147875fd SB	335	else {
	336	free((void *) submodule->ignore);
	337	submodule->ignore = xstrdup(value);
959b5455	338	}
959b5455	339	} else if (!strcmp(item.buf, "url")) {
959b5455 HV	340	if (!value) {
959b5455 HV	341	ret = config_error_nonbool(var);
f73da110	342	} else if (!me->overwrite && submodule->url) {
959b5455 HV	343	warn_multiple_config(me->commit_sha1, submodule->name,
959b5455 HV	344	"url");
147875fd SB	345	} else {
	346	free((void *) submodule->url);
	347	submodule->url = xstrdup(value);
959b5455	348	}
ea2fa5a3 SB	349	} else if (!strcmp(item.buf, "update")) {
	350	if (!value)
	351	ret = config_error_nonbool(var);
	352	else if (!me->overwrite &&
	353	submodule->update_strategy.type != SM_UPDATE_UNSPECIFIED)
	354	warn_multiple_config(me->commit_sha1, submodule->name,
	355	"update");
	356	else if (parse_submodule_update_strategy(value,
	357	&submodule->update_strategy) < 0)
	358	die(_("invalid value for %s"), var);
37f52e93 SB	359	} else if (!strcmp(item.buf, "shallow")) {
	360	if (!me->overwrite && submodule->recommend_shallow != -1)
	361	warn_multiple_config(me->commit_sha1, submodule->name,
	362	"shallow");
b5944f34	363	else
37f52e93 SB	364	submodule->recommend_shallow =
37f52e93 SB	365	git_config_bool(var, value);
b5944f34 SB	366	} else if (!strcmp(item.buf, "branch")) {
	367	if (!me->overwrite && submodule->branch)
	368	warn_multiple_config(me->commit_sha1, submodule->name,
	369	"branch");
	370	else {
	371	free((void *)submodule->branch);
	372	submodule->branch = xstrdup(value);
37f52e93	373	}
959b5455 HV	374	}
959b5455 HV	375
959b5455 HV	376	strbuf_release(&name);
	377	strbuf_release(&item);
	378
	379	return ret;
	380	}
	381
	382	static int gitmodule_sha1_from_commit(const unsigned char *commit_sha1,
514dea90 HV	383	unsigned char *gitmodules_sha1,
514dea90 HV	384	struct strbuf *rev)
959b5455	385	{
959b5455 HV	386	int ret = 0;
	387
	388	if (is_null_sha1(commit_sha1)) {
f449198e	389	hashclr(gitmodules_sha1);
959b5455 HV	390	return 1;
	391	}
	392
514dea90 HV	393	strbuf_addf(rev, "%s:.gitmodules", sha1_to_hex(commit_sha1));
514dea90 HV	394	if (get_sha1(rev->buf, gitmodules_sha1) >= 0)
959b5455 HV	395	ret = 1;
959b5455 HV	396
959b5455 HV	397	return ret;
	398	}
	399
	400	/* This does a lookup of a submodule configuration by name or by path
	401	* (key) with on-demand reading of the appropriate .gitmodules from
	402	* revisions.
	403	*/
	404	static const struct submodule config_from(struct submodule_cache cache,
	405	const unsigned char commit_sha1, const char key,
	406	enum lookup_type lookup_type)
	407	{
	408	struct strbuf rev = STRBUF_INIT;
	409	unsigned long config_size;
0918e250	410	char *config = NULL;
959b5455 HV	411	unsigned char sha1[20];
	412	enum object_type type;
	413	const struct submodule *submodule = NULL;
	414	struct parse_config_parameter parameter;
	415
	416	/*
	417	* If any parameter except the cache is a NULL pointer just
	418	* return the first submodule. Can be used to check whether
	419	* there are any submodules parsed.
	420	*/
	421	if (!commit_sha1 \|\| !key) {
	422	struct hashmap_iter iter;
	423	struct submodule_entry *entry;
	424
01d98e8a	425	entry = hashmap_iter_first(&cache->for_name, &iter);
959b5455 HV	426	if (!entry)
	427	return NULL;
	428	return entry->config;
	429	}
	430
0918e250 HV	431	if (!gitmodule_sha1_from_commit(commit_sha1, sha1, &rev))
0918e250 HV	432	goto out;
959b5455 HV	433
	434	switch (lookup_type) {
	435	case lookup_name:
	436	submodule = cache_lookup_name(cache, sha1, key);
	437	break;
	438	case lookup_path:
	439	submodule = cache_lookup_path(cache, sha1, key);
	440	break;
	441	}
	442	if (submodule)
0918e250	443	goto out;
959b5455 HV	444
959b5455 HV	445	config = read_sha1_file(sha1, &type, &config_size);
0918e250 HV	446	if (!config \|\| type != OBJ_BLOB)
0918e250 HV	447	goto out;
959b5455 HV	448
	449	/* fill the submodule config into the cache */
	450	parameter.cache = cache;
	451	parameter.commit_sha1 = commit_sha1;
	452	parameter.gitmodules_sha1 = sha1;
	453	parameter.overwrite = 0;
1b8132d9	454	git_config_from_mem(parse_config, CONFIG_ORIGIN_SUBMODULE_BLOB, rev.buf,
473166b9	455	config, config_size, &parameter);
514dea90	456	strbuf_release(&rev);
959b5455 HV	457	free(config);
	458
	459	switch (lookup_type) {
	460	case lookup_name:
	461	return cache_lookup_name(cache, sha1, key);
	462	case lookup_path:
	463	return cache_lookup_path(cache, sha1, key);
	464	default:
	465	return NULL;
	466	}
0918e250 HV	467
	468	out:
	469	strbuf_release(&rev);
	470	free(config);
	471	return submodule;
959b5455 HV	472	}
	473
	474	static const struct submodule config_from_path(struct submodule_cache cache,
	475	const unsigned char commit_sha1, const char path)
	476	{
	477	return config_from(cache, commit_sha1, path, lookup_path);
	478	}
	479
	480	static const struct submodule config_from_name(struct submodule_cache cache,
	481	const unsigned char commit_sha1, const char name)
	482	{
	483	return config_from(cache, commit_sha1, name, lookup_name);
	484	}
	485
	486	static void ensure_cache_init(void)
	487	{
	488	if (is_cache_init)
	489	return;
	490
99dab168	491	cache_init(&the_submodule_cache);
959b5455 HV	492	is_cache_init = 1;
	493	}
	494
851e18c3 HV	495	int parse_submodule_config_option(const char var, const char value)
	496	{
	497	struct parse_config_parameter parameter;
99dab168	498	parameter.cache = &the_submodule_cache;
851e18c3 HV	499	parameter.commit_sha1 = NULL;
	500	parameter.gitmodules_sha1 = null_sha1;
	501	parameter.overwrite = 1;
	502
	503	ensure_cache_init();
	504	return parse_config(var, value, &parameter);
	505	}
	506
959b5455 HV	507	const struct submodule submodule_from_name(const unsigned char commit_sha1,
	508	const char *name)
	509	{
	510	ensure_cache_init();
99dab168	511	return config_from_name(&the_submodule_cache, commit_sha1, name);
959b5455 HV	512	}
	513
	514	const struct submodule submodule_from_path(const unsigned char commit_sha1,
	515	const char *path)
	516	{
	517	ensure_cache_init();
99dab168	518	return config_from_path(&the_submodule_cache, commit_sha1, path);
959b5455 HV	519	}
	520
	521	void submodule_free(void)
	522	{
99dab168	523	cache_free(&the_submodule_cache);
959b5455 HV	524	is_cache_init = 0;
959b5455 HV	525	}