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

#include "cache.h"
#include "config.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 void *unused_cmp_data,
			   const struct submodule_entry *a,
			   const struct submodule_entry *b,
			   const void *unused_keydata)
{
	return strcmp(a->config->path, b->config->path) ||
	       hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
}

static int config_name_cmp(const void *unused_cmp_data,
			   const struct submodule_entry *a,
			   const struct submodule_entry *b,
			   const void *unused_keydata)
{
	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, NULL, 0);
	hashmap_init(&cache->for_name, (hashmap_cmp_fn) config_name_cmp, NULL, 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_update_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 (die_on_error)
			die("bad %s argument: %s", opt, arg);
		return RECURSE_SUBMODULES_ERROR;
	}
}

int parse_update_recurse_submodules_arg(const char *opt, const char *arg)
{
	return parse_update_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 (!strcmp(arg, "only"))
			return RECURSE_SUBMODULES_ONLY;
		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 *treeish_name,
				 const char *name, const char *option)
{
	const char *commit_string = "WORKTREE";
	if (treeish_name)
		commit_string = sha1_to_hex(treeish_name);
	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 *treeish_name;
	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->treeish_name, 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->treeish_name, 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->treeish_name, 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, name.buf);
		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->treeish_name, 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->treeish_name, 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->treeish_name, 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->treeish_name, submodule->name,
					     "branch");
		else {
			free((void *)submodule->branch);
			submodule->branch = xstrdup(value);
		}
	}

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

	return ret;
}

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

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

	strbuf_addf(rev, "%s:.gitmodules", sha1_to_hex(treeish_name));
	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 *treeish_name, 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 (!treeish_name || !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(treeish_name, 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.treeish_name = treeish_name;
	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 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.treeish_name = 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 *treeish_name,
		const char *name)
{
	ensure_cache_init();
	return config_from(&the_submodule_cache, treeish_name, name, lookup_name);
}

const struct submodule *submodule_from_path(const unsigned char *treeish_name,
		const char *path)
{
	ensure_cache_init();
	return config_from(&the_submodule_cache, treeish_name, path, lookup_path);
}

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