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

#include "cache.h"
#include "repository.h"
#include "config.h"
#include "submodule-config.h"
#include "submodule.h"
#include "strbuf.h"
#include "parse-options.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;
	unsigned initialized:1;
	unsigned gitmodules_read:1;
};

/*
 * 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 int config_path_cmp(const void *unused_cmp_data,
			   const void *entry,
			   const void *entry_or_key,
			   const void *unused_keydata)
{
	const struct submodule_entry *a = entry;
	const struct submodule_entry *b = entry_or_key;

	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 void *entry,
			   const void *entry_or_key,
			   const void *unused_keydata)
{
	const struct submodule_entry *a = entry;
	const struct submodule_entry *b = entry_or_key;

	return strcmp(a->config->name, b->config->name) ||
	       hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
}

static struct submodule_cache *submodule_cache_alloc(void)
{
	return xcalloc(1, sizeof(struct submodule_cache));
}

static void submodule_cache_init(struct submodule_cache *cache)
{
	hashmap_init(&cache->for_path, config_path_cmp, NULL, 0);
	hashmap_init(&cache->for_name, config_name_cmp, NULL, 0);
	cache->initialized = 1;
}

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 submodule_cache_clear(struct submodule_cache *cache)
{
	struct hashmap_iter iter;
	struct submodule_entry *entry;

	if (!cache->initialized)
		return;

	/*
	 * 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);
	cache->initialized = 0;
	cache->gitmodules_read = 0;
}

void submodule_cache_free(struct submodule_cache *cache)
{
	submodule_cache_clear(cache);
	free(cache);
}

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_parse_maybe_bool(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_submodule_fetchjobs(const char *var, const char *value)
{
	int fetchjobs = git_config_int(var, value);
	if (fetchjobs < 0)
		die(_("negative values not allowed for submodule.fetchjobs"));
	return fetchjobs;
}

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

int option_fetch_parse_recurse_submodules(const struct option *opt,
					  const char *arg, int unset)
{
	int *v;

	if (!opt->value)
		return -1;

	v = opt->value;

	if (unset) {
		*v = RECURSE_SUBMODULES_OFF;
	} else {
		if (arg)
			*v = parse_fetch_recurse_submodules_arg(opt->long_name, arg);
		else
			*v = RECURSE_SUBMODULES_ON;
	}
	return 0;
}

static int parse_update_recurse(const char *opt, const char *arg,
				int die_on_error)
{
	switch (git_parse_maybe_bool(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_parse_maybe_bool(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;
}

static int gitmodule_oid_from_commit(const struct object_id *treeish_name,
				     struct object_id *gitmodules_oid,
				     struct strbuf *rev)
{
	int ret = 0;

	if (is_null_oid(treeish_name)) {
		oidclr(gitmodules_oid);
		return 1;
	}

	strbuf_addf(rev, "%s:.gitmodules", oid_to_hex(treeish_name));
	if (get_oid(rev->buf, gitmodules_oid) >= 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 struct object_id *treeish_name, const char *key,
		enum lookup_type lookup_type)
{
	struct strbuf rev = STRBUF_INIT;
	unsigned long config_size;
	char *config = NULL;
	struct object_id oid;
	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_oid_from_commit(treeish_name, &oid, &rev))
		goto out;

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

	config = read_sha1_file(oid.hash, &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->hash;
	parameter.gitmodules_sha1 = oid.hash;
	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, oid.hash, key);
	case lookup_path:
		return cache_lookup_path(cache, oid.hash, key);
	default:
		return NULL;
	}

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

static void submodule_cache_check_init(struct repository *repo)
{
	if (repo->submodule_cache && repo->submodule_cache->initialized)
		return;

	if (!repo->submodule_cache)
		repo->submodule_cache = submodule_cache_alloc();

	submodule_cache_init(repo->submodule_cache);
}

static int gitmodules_cb(const char *var, const char *value, void *data)
{
	struct repository *repo = data;
	struct parse_config_parameter parameter;

	parameter.cache = repo->submodule_cache;
	parameter.treeish_name = NULL;
	parameter.gitmodules_sha1 = null_sha1;
	parameter.overwrite = 1;

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

void repo_read_gitmodules(struct repository *repo)
{
	submodule_cache_check_init(repo);

	if (repo->worktree) {
		char *gitmodules;

		if (repo_read_index(repo) < 0)
			return;

		gitmodules = repo_worktree_path(repo, GITMODULES_FILE);

		if (!is_gitmodules_unmerged(repo->index))
			git_config_from_file(gitmodules_cb, gitmodules, repo);

		free(gitmodules);
	}

	repo->submodule_cache->gitmodules_read = 1;
}

void gitmodules_config_oid(const struct object_id *commit_oid)
{
	struct strbuf rev = STRBUF_INIT;
	struct object_id oid;

	submodule_cache_check_init(the_repository);

	if (gitmodule_oid_from_commit(commit_oid, &oid, &rev)) {
		git_config_from_blob_oid(gitmodules_cb, rev.buf,
					 &oid, the_repository);
	}
	strbuf_release(&rev);

	the_repository->submodule_cache->gitmodules_read = 1;
}

static void gitmodules_read_check(struct repository *repo)
{
	submodule_cache_check_init(repo);

	/* read the repo's .gitmodules file if it hasn't been already */
	if (!repo->submodule_cache->gitmodules_read)
		repo_read_gitmodules(repo);
}

const struct submodule *submodule_from_name(const struct object_id *treeish_name,
		const char *name)
{
	gitmodules_read_check(the_repository);
	return config_from(the_repository->submodule_cache, treeish_name, name, lookup_name);
}

const struct submodule *submodule_from_path(const struct object_id *treeish_name,
		const char *path)
{
	gitmodules_read_check(the_repository);
	return config_from(the_repository->submodule_cache, treeish_name, path, lookup_path);
}

const struct submodule *submodule_from_cache(struct repository *repo,
					     const struct object_id *treeish_name,
					     const char *key)
{
	gitmodules_read_check(repo);
	return config_from(repo->submodule_cache, treeish_name,
			   key, lookup_path);
}

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