git-multimail: update to release 1.2.0
[git.git] / submodule-config.c
blob393de5357eb486d8fb9ee3be1d75c4b80771bd02
1 #include "cache.h"
2 #include "submodule-config.h"
3 #include "submodule.h"
4 #include "strbuf.h"
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
14 struct submodule_cache {
15 struct hashmap for_path;
16 struct hashmap for_name;
20 * thin wrapper struct needed to insert 'struct submodule' entries to
21 * the hashmap
23 struct submodule_entry {
24 struct hashmap_entry ent;
25 struct submodule *config;
28 enum lookup_type {
29 lookup_name,
30 lookup_path
33 static struct submodule_cache cache;
34 static int is_cache_init;
36 static int config_path_cmp(const struct submodule_entry *a,
37 const struct submodule_entry *b,
38 const void *unused)
40 return strcmp(a->config->path, b->config->path) ||
41 hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
44 static int config_name_cmp(const struct submodule_entry *a,
45 const struct submodule_entry *b,
46 const void *unused)
48 return strcmp(a->config->name, b->config->name) ||
49 hashcmp(a->config->gitmodules_sha1, b->config->gitmodules_sha1);
52 static void cache_init(struct submodule_cache *cache)
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);
58 static void free_one_config(struct submodule_entry *entry)
60 free((void *) entry->config->path);
61 free((void *) entry->config->name);
62 free(entry->config);
65 static void cache_free(struct submodule_cache *cache)
67 struct hashmap_iter iter;
68 struct submodule_entry *entry;
71 * We iterate over the name hash here to be symmetric with the
72 * allocation of struct submodule entries. Each is allocated by
73 * their .gitmodule blob sha1 and submodule name.
75 hashmap_iter_init(&cache->for_name, &iter);
76 while ((entry = hashmap_iter_next(&iter)))
77 free_one_config(entry);
79 hashmap_free(&cache->for_path, 1);
80 hashmap_free(&cache->for_name, 1);
83 static unsigned int hash_sha1_string(const unsigned char *sha1,
84 const char *string)
86 return memhash(sha1, 20) + strhash(string);
89 static void cache_put_path(struct submodule_cache *cache,
90 struct submodule *submodule)
92 unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
93 submodule->path);
94 struct submodule_entry *e = xmalloc(sizeof(*e));
95 hashmap_entry_init(e, hash);
96 e->config = submodule;
97 hashmap_put(&cache->for_path, e);
100 static void cache_remove_path(struct submodule_cache *cache,
101 struct submodule *submodule)
103 unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
104 submodule->path);
105 struct submodule_entry e;
106 struct submodule_entry *removed;
107 hashmap_entry_init(&e, hash);
108 e.config = submodule;
109 removed = hashmap_remove(&cache->for_path, &e, NULL);
110 free(removed);
113 static void cache_add(struct submodule_cache *cache,
114 struct submodule *submodule)
116 unsigned int hash = hash_sha1_string(submodule->gitmodules_sha1,
117 submodule->name);
118 struct submodule_entry *e = xmalloc(sizeof(*e));
119 hashmap_entry_init(e, hash);
120 e->config = submodule;
121 hashmap_add(&cache->for_name, e);
124 static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
125 const unsigned char *gitmodules_sha1, const char *path)
127 struct submodule_entry *entry;
128 unsigned int hash = hash_sha1_string(gitmodules_sha1, path);
129 struct submodule_entry key;
130 struct submodule key_config;
132 hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
133 key_config.path = path;
135 hashmap_entry_init(&key, hash);
136 key.config = &key_config;
138 entry = hashmap_get(&cache->for_path, &key, NULL);
139 if (entry)
140 return entry->config;
141 return NULL;
144 static struct submodule *cache_lookup_name(struct submodule_cache *cache,
145 const unsigned char *gitmodules_sha1, const char *name)
147 struct submodule_entry *entry;
148 unsigned int hash = hash_sha1_string(gitmodules_sha1, name);
149 struct submodule_entry key;
150 struct submodule key_config;
152 hashcpy(key_config.gitmodules_sha1, gitmodules_sha1);
153 key_config.name = name;
155 hashmap_entry_init(&key, hash);
156 key.config = &key_config;
158 entry = hashmap_get(&cache->for_name, &key, NULL);
159 if (entry)
160 return entry->config;
161 return NULL;
164 static int name_and_item_from_var(const char *var, struct strbuf *name,
165 struct strbuf *item)
167 const char *subsection, *key;
168 int subsection_len, parse;
169 parse = parse_config_key(var, "submodule", &subsection,
170 &subsection_len, &key);
171 if (parse < 0 || !subsection)
172 return 0;
174 strbuf_add(name, subsection, subsection_len);
175 strbuf_addstr(item, key);
177 return 1;
180 static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
181 const unsigned char *gitmodules_sha1, const char *name)
183 struct submodule *submodule;
184 struct strbuf name_buf = STRBUF_INIT;
186 submodule = cache_lookup_name(cache, gitmodules_sha1, name);
187 if (submodule)
188 return submodule;
190 submodule = xmalloc(sizeof(*submodule));
192 strbuf_addstr(&name_buf, name);
193 submodule->name = strbuf_detach(&name_buf, NULL);
195 submodule->path = NULL;
196 submodule->url = NULL;
197 submodule->fetch_recurse = RECURSE_SUBMODULES_NONE;
198 submodule->ignore = NULL;
200 hashcpy(submodule->gitmodules_sha1, gitmodules_sha1);
202 cache_add(cache, submodule);
204 return submodule;
207 static int parse_fetch_recurse(const char *opt, const char *arg,
208 int die_on_error)
210 switch (git_config_maybe_bool(opt, arg)) {
211 case 1:
212 return RECURSE_SUBMODULES_ON;
213 case 0:
214 return RECURSE_SUBMODULES_OFF;
215 default:
216 if (!strcmp(arg, "on-demand"))
217 return RECURSE_SUBMODULES_ON_DEMAND;
219 if (die_on_error)
220 die("bad %s argument: %s", opt, arg);
221 else
222 return RECURSE_SUBMODULES_ERROR;
226 int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
228 return parse_fetch_recurse(opt, arg, 1);
231 static void warn_multiple_config(const unsigned char *commit_sha1,
232 const char *name, const char *option)
234 const char *commit_string = "WORKTREE";
235 if (commit_sha1)
236 commit_string = sha1_to_hex(commit_sha1);
237 warning("%s:.gitmodules, multiple configurations found for "
238 "'submodule.%s.%s'. Skipping second one!",
239 commit_string, name, option);
242 struct parse_config_parameter {
243 struct submodule_cache *cache;
244 const unsigned char *commit_sha1;
245 const unsigned char *gitmodules_sha1;
246 int overwrite;
249 static int parse_config(const char *var, const char *value, void *data)
251 struct parse_config_parameter *me = data;
252 struct submodule *submodule;
253 struct strbuf name = STRBUF_INIT, item = STRBUF_INIT;
254 int ret = 0;
256 /* this also ensures that we only parse submodule entries */
257 if (!name_and_item_from_var(var, &name, &item))
258 return 0;
260 submodule = lookup_or_create_by_name(me->cache, me->gitmodules_sha1,
261 name.buf);
263 if (!strcmp(item.buf, "path")) {
264 struct strbuf path = STRBUF_INIT;
265 if (!value) {
266 ret = config_error_nonbool(var);
267 goto release_return;
269 if (!me->overwrite && submodule->path != NULL) {
270 warn_multiple_config(me->commit_sha1, submodule->name,
271 "path");
272 goto release_return;
275 if (submodule->path)
276 cache_remove_path(me->cache, submodule);
277 free((void *) submodule->path);
278 strbuf_addstr(&path, value);
279 submodule->path = strbuf_detach(&path, NULL);
280 cache_put_path(me->cache, submodule);
281 } else if (!strcmp(item.buf, "fetchrecursesubmodules")) {
282 /* when parsing worktree configurations we can die early */
283 int die_on_error = is_null_sha1(me->gitmodules_sha1);
284 if (!me->overwrite &&
285 submodule->fetch_recurse != RECURSE_SUBMODULES_NONE) {
286 warn_multiple_config(me->commit_sha1, submodule->name,
287 "fetchrecursesubmodules");
288 goto release_return;
291 submodule->fetch_recurse = parse_fetch_recurse(var, value,
292 die_on_error);
293 } else if (!strcmp(item.buf, "ignore")) {
294 struct strbuf ignore = STRBUF_INIT;
295 if (!me->overwrite && submodule->ignore != NULL) {
296 warn_multiple_config(me->commit_sha1, submodule->name,
297 "ignore");
298 goto release_return;
300 if (!value) {
301 ret = config_error_nonbool(var);
302 goto release_return;
304 if (strcmp(value, "untracked") && strcmp(value, "dirty") &&
305 strcmp(value, "all") && strcmp(value, "none")) {
306 warning("Invalid parameter '%s' for config option "
307 "'submodule.%s.ignore'", value, var);
308 goto release_return;
311 free((void *) submodule->ignore);
312 strbuf_addstr(&ignore, value);
313 submodule->ignore = strbuf_detach(&ignore, NULL);
314 } else if (!strcmp(item.buf, "url")) {
315 struct strbuf url = STRBUF_INIT;
316 if (!value) {
317 ret = config_error_nonbool(var);
318 goto release_return;
320 if (!me->overwrite && submodule->url != NULL) {
321 warn_multiple_config(me->commit_sha1, submodule->name,
322 "url");
323 goto release_return;
326 free((void *) submodule->url);
327 strbuf_addstr(&url, value);
328 submodule->url = strbuf_detach(&url, NULL);
331 release_return:
332 strbuf_release(&name);
333 strbuf_release(&item);
335 return ret;
338 static int gitmodule_sha1_from_commit(const unsigned char *commit_sha1,
339 unsigned char *gitmodules_sha1)
341 struct strbuf rev = STRBUF_INIT;
342 int ret = 0;
344 if (is_null_sha1(commit_sha1)) {
345 hashcpy(gitmodules_sha1, null_sha1);
346 return 1;
349 strbuf_addf(&rev, "%s:.gitmodules", sha1_to_hex(commit_sha1));
350 if (get_sha1(rev.buf, gitmodules_sha1) >= 0)
351 ret = 1;
353 strbuf_release(&rev);
354 return ret;
357 /* This does a lookup of a submodule configuration by name or by path
358 * (key) with on-demand reading of the appropriate .gitmodules from
359 * revisions.
361 static const struct submodule *config_from(struct submodule_cache *cache,
362 const unsigned char *commit_sha1, const char *key,
363 enum lookup_type lookup_type)
365 struct strbuf rev = STRBUF_INIT;
366 unsigned long config_size;
367 char *config;
368 unsigned char sha1[20];
369 enum object_type type;
370 const struct submodule *submodule = NULL;
371 struct parse_config_parameter parameter;
374 * If any parameter except the cache is a NULL pointer just
375 * return the first submodule. Can be used to check whether
376 * there are any submodules parsed.
378 if (!commit_sha1 || !key) {
379 struct hashmap_iter iter;
380 struct submodule_entry *entry;
382 hashmap_iter_init(&cache->for_name, &iter);
383 entry = hashmap_iter_next(&iter);
384 if (!entry)
385 return NULL;
386 return entry->config;
389 if (!gitmodule_sha1_from_commit(commit_sha1, sha1))
390 return NULL;
392 switch (lookup_type) {
393 case lookup_name:
394 submodule = cache_lookup_name(cache, sha1, key);
395 break;
396 case lookup_path:
397 submodule = cache_lookup_path(cache, sha1, key);
398 break;
400 if (submodule)
401 return submodule;
403 config = read_sha1_file(sha1, &type, &config_size);
404 if (!config)
405 return NULL;
407 if (type != OBJ_BLOB) {
408 free(config);
409 return NULL;
412 /* fill the submodule config into the cache */
413 parameter.cache = cache;
414 parameter.commit_sha1 = commit_sha1;
415 parameter.gitmodules_sha1 = sha1;
416 parameter.overwrite = 0;
417 git_config_from_buf(parse_config, rev.buf, config, config_size,
418 &parameter);
419 free(config);
421 switch (lookup_type) {
422 case lookup_name:
423 return cache_lookup_name(cache, sha1, key);
424 case lookup_path:
425 return cache_lookup_path(cache, sha1, key);
426 default:
427 return NULL;
431 static const struct submodule *config_from_path(struct submodule_cache *cache,
432 const unsigned char *commit_sha1, const char *path)
434 return config_from(cache, commit_sha1, path, lookup_path);
437 static const struct submodule *config_from_name(struct submodule_cache *cache,
438 const unsigned char *commit_sha1, const char *name)
440 return config_from(cache, commit_sha1, name, lookup_name);
443 static void ensure_cache_init(void)
445 if (is_cache_init)
446 return;
448 cache_init(&cache);
449 is_cache_init = 1;
452 int parse_submodule_config_option(const char *var, const char *value)
454 struct parse_config_parameter parameter;
455 parameter.cache = &cache;
456 parameter.commit_sha1 = NULL;
457 parameter.gitmodules_sha1 = null_sha1;
458 parameter.overwrite = 1;
460 ensure_cache_init();
461 return parse_config(var, value, &parameter);
464 const struct submodule *submodule_from_name(const unsigned char *commit_sha1,
465 const char *name)
467 ensure_cache_init();
468 return config_from_name(&cache, commit_sha1, name);
471 const struct submodule *submodule_from_path(const unsigned char *commit_sha1,
472 const char *path)
474 ensure_cache_init();
475 return config_from_path(&cache, commit_sha1, path);
478 void submodule_free(void)
480 cache_free(&cache);
481 is_cache_init = 0;