3 #include "repository.h"
5 #include "submodule-config.h"
8 #include "object-store.h"
9 #include "parse-options.h"
12 * submodule cache lookup structure
13 * There is one shared set of 'struct submodule' entries which can be
14 * looked up by their sha1 blob id of the .gitmodules file and either
15 * using path or name as key.
16 * for_path stores submodule entries with path as key
17 * for_name stores submodule entries with name as key
19 struct submodule_cache {
20 struct hashmap for_path;
21 struct hashmap for_name;
22 unsigned initialized:1;
23 unsigned gitmodules_read:1;
27 * thin wrapper struct needed to insert 'struct submodule' entries to
30 struct submodule_entry {
31 struct hashmap_entry ent;
32 struct submodule *config;
40 static int config_path_cmp(const void *unused_cmp_data,
42 const void *entry_or_key,
43 const void *unused_keydata)
45 const struct submodule_entry *a = entry;
46 const struct submodule_entry *b = entry_or_key;
48 return strcmp(a->config->path, b->config->path) ||
49 !oideq(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
52 static int config_name_cmp(const void *unused_cmp_data,
54 const void *entry_or_key,
55 const void *unused_keydata)
57 const struct submodule_entry *a = entry;
58 const struct submodule_entry *b = entry_or_key;
60 return strcmp(a->config->name, b->config->name) ||
61 !oideq(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
64 static struct submodule_cache *submodule_cache_alloc(void)
66 return xcalloc(1, sizeof(struct submodule_cache));
69 static void submodule_cache_init(struct submodule_cache *cache)
71 hashmap_init(&cache->for_path, config_path_cmp, NULL, 0);
72 hashmap_init(&cache->for_name, config_name_cmp, NULL, 0);
73 cache->initialized = 1;
76 static void free_one_config(struct submodule_entry *entry)
78 free((void *) entry->config->path);
79 free((void *) entry->config->name);
80 free((void *) entry->config->branch);
81 free((void *) entry->config->update_strategy.command);
85 static void submodule_cache_clear(struct submodule_cache *cache)
87 struct hashmap_iter iter;
88 struct submodule_entry *entry;
90 if (!cache->initialized)
94 * We iterate over the name hash here to be symmetric with the
95 * allocation of struct submodule entries. Each is allocated by
96 * their .gitmodules blob sha1 and submodule name.
98 hashmap_iter_init(&cache->for_name, &iter);
99 while ((entry = hashmap_iter_next(&iter)))
100 free_one_config(entry);
102 hashmap_free(&cache->for_path, 1);
103 hashmap_free(&cache->for_name, 1);
104 cache->initialized = 0;
105 cache->gitmodules_read = 0;
108 void submodule_cache_free(struct submodule_cache *cache)
110 submodule_cache_clear(cache);
114 static unsigned int hash_oid_string(const struct object_id *oid,
117 return memhash(oid->hash, the_hash_algo->rawsz) + strhash(string);
120 static void cache_put_path(struct submodule_cache *cache,
121 struct submodule *submodule)
123 unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
125 struct submodule_entry *e = xmalloc(sizeof(*e));
126 hashmap_entry_init(e, hash);
127 e->config = submodule;
128 hashmap_put(&cache->for_path, e);
131 static void cache_remove_path(struct submodule_cache *cache,
132 struct submodule *submodule)
134 unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
136 struct submodule_entry e;
137 struct submodule_entry *removed;
138 hashmap_entry_init(&e, hash);
139 e.config = submodule;
140 removed = hashmap_remove(&cache->for_path, &e, NULL);
144 static void cache_add(struct submodule_cache *cache,
145 struct submodule *submodule)
147 unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
149 struct submodule_entry *e = xmalloc(sizeof(*e));
150 hashmap_entry_init(e, hash);
151 e->config = submodule;
152 hashmap_add(&cache->for_name, e);
155 static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
156 const struct object_id *gitmodules_oid, const char *path)
158 struct submodule_entry *entry;
159 unsigned int hash = hash_oid_string(gitmodules_oid, path);
160 struct submodule_entry key;
161 struct submodule key_config;
163 oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
164 key_config.path = path;
166 hashmap_entry_init(&key, hash);
167 key.config = &key_config;
169 entry = hashmap_get(&cache->for_path, &key, NULL);
171 return entry->config;
175 static struct submodule *cache_lookup_name(struct submodule_cache *cache,
176 const struct object_id *gitmodules_oid, const char *name)
178 struct submodule_entry *entry;
179 unsigned int hash = hash_oid_string(gitmodules_oid, name);
180 struct submodule_entry key;
181 struct submodule key_config;
183 oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
184 key_config.name = name;
186 hashmap_entry_init(&key, hash);
187 key.config = &key_config;
189 entry = hashmap_get(&cache->for_name, &key, NULL);
191 return entry->config;
195 int check_submodule_name(const char *name)
197 /* Disallow empty names */
202 * Look for '..' as a path component. Check both '/' and '\\' as
203 * separators rather than is_dir_sep(), because we want the name rules
204 * to be consistent across platforms.
206 goto in_component; /* always start inside component */
209 if (c == '/' || c == '\\') {
211 if (name[0] == '.' && name[1] == '.' &&
212 (!name[2] || name[2] == '/' || name[2] == '\\'))
220 static int name_and_item_from_var(const char *var, struct strbuf *name,
223 const char *subsection, *key;
224 int subsection_len, parse;
225 parse = parse_config_key(var, "submodule", &subsection,
226 &subsection_len, &key);
227 if (parse < 0 || !subsection)
230 strbuf_add(name, subsection, subsection_len);
231 if (check_submodule_name(name->buf) < 0) {
232 warning(_("ignoring suspicious submodule name: %s"), name->buf);
233 strbuf_release(name);
237 strbuf_addstr(item, key);
242 static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
243 const struct object_id *gitmodules_oid, const char *name)
245 struct submodule *submodule;
246 struct strbuf name_buf = STRBUF_INIT;
248 submodule = cache_lookup_name(cache, gitmodules_oid, name);
252 submodule = xmalloc(sizeof(*submodule));
254 strbuf_addstr(&name_buf, name);
255 submodule->name = strbuf_detach(&name_buf, NULL);
257 submodule->path = NULL;
258 submodule->url = NULL;
259 submodule->update_strategy.type = SM_UPDATE_UNSPECIFIED;
260 submodule->update_strategy.command = NULL;
261 submodule->fetch_recurse = RECURSE_SUBMODULES_NONE;
262 submodule->ignore = NULL;
263 submodule->branch = NULL;
264 submodule->recommend_shallow = -1;
266 oidcpy(&submodule->gitmodules_oid, gitmodules_oid);
268 cache_add(cache, submodule);
273 static int parse_fetch_recurse(const char *opt, const char *arg,
276 switch (git_parse_maybe_bool(arg)) {
278 return RECURSE_SUBMODULES_ON;
280 return RECURSE_SUBMODULES_OFF;
282 if (!strcmp(arg, "on-demand"))
283 return RECURSE_SUBMODULES_ON_DEMAND;
285 * Please update $__git_fetch_recurse_submodules in
286 * git-completion.bash when you add new options.
289 die("bad %s argument: %s", opt, arg);
291 return RECURSE_SUBMODULES_ERROR;
295 int parse_submodule_fetchjobs(const char *var, const char *value)
297 int fetchjobs = git_config_int(var, value);
299 die(_("negative values not allowed for submodule.fetchjobs"));
303 int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
305 return parse_fetch_recurse(opt, arg, 1);
308 int option_fetch_parse_recurse_submodules(const struct option *opt,
309 const char *arg, int unset)
319 *v = RECURSE_SUBMODULES_OFF;
322 *v = parse_fetch_recurse_submodules_arg(opt->long_name, arg);
324 *v = RECURSE_SUBMODULES_ON;
329 static int parse_update_recurse(const char *opt, const char *arg,
332 switch (git_parse_maybe_bool(arg)) {
334 return RECURSE_SUBMODULES_ON;
336 return RECURSE_SUBMODULES_OFF;
339 die("bad %s argument: %s", opt, arg);
340 return RECURSE_SUBMODULES_ERROR;
344 int parse_update_recurse_submodules_arg(const char *opt, const char *arg)
346 return parse_update_recurse(opt, arg, 1);
349 static int parse_push_recurse(const char *opt, const char *arg,
352 switch (git_parse_maybe_bool(arg)) {
354 /* There's no simple "on" value when pushing */
356 die("bad %s argument: %s", opt, arg);
358 return RECURSE_SUBMODULES_ERROR;
360 return RECURSE_SUBMODULES_OFF;
362 if (!strcmp(arg, "on-demand"))
363 return RECURSE_SUBMODULES_ON_DEMAND;
364 else if (!strcmp(arg, "check"))
365 return RECURSE_SUBMODULES_CHECK;
366 else if (!strcmp(arg, "only"))
367 return RECURSE_SUBMODULES_ONLY;
369 * Please update $__git_push_recurse_submodules in
370 * git-completion.bash when you add new modes.
372 else if (die_on_error)
373 die("bad %s argument: %s", opt, arg);
375 return RECURSE_SUBMODULES_ERROR;
379 int parse_push_recurse_submodules_arg(const char *opt, const char *arg)
381 return parse_push_recurse(opt, arg, 1);
384 static void warn_multiple_config(const struct object_id *treeish_name,
385 const char *name, const char *option)
387 const char *commit_string = "WORKTREE";
389 commit_string = oid_to_hex(treeish_name);
390 warning("%s:.gitmodules, multiple configurations found for "
391 "'submodule.%s.%s'. Skipping second one!",
392 commit_string, name, option);
395 static void warn_command_line_option(const char *var, const char *value)
397 warning(_("ignoring '%s' which may be interpreted as"
398 " a command-line option: %s"), var, value);
401 struct parse_config_parameter {
402 struct submodule_cache *cache;
403 const struct object_id *treeish_name;
404 const struct object_id *gitmodules_oid;
409 * Parse a config item from .gitmodules.
411 * This does not handle submodule-related configuration from the main
412 * config store (.git/config, etc). Callers are responsible for
413 * checking for overrides in the main config store when appropriate.
415 static int parse_config(const char *var, const char *value, void *data)
417 struct parse_config_parameter *me = data;
418 struct submodule *submodule;
419 struct strbuf name = STRBUF_INIT, item = STRBUF_INIT;
422 /* this also ensures that we only parse submodule entries */
423 if (!name_and_item_from_var(var, &name, &item))
426 submodule = lookup_or_create_by_name(me->cache,
430 if (!strcmp(item.buf, "path")) {
432 ret = config_error_nonbool(var);
433 else if (looks_like_command_line_option(value))
434 warn_command_line_option(var, value);
435 else if (!me->overwrite && submodule->path)
436 warn_multiple_config(me->treeish_name, submodule->name,
440 cache_remove_path(me->cache, submodule);
441 free((void *) submodule->path);
442 submodule->path = xstrdup(value);
443 cache_put_path(me->cache, submodule);
445 } else if (!strcmp(item.buf, "fetchrecursesubmodules")) {
446 /* when parsing worktree configurations we can die early */
447 int die_on_error = is_null_oid(me->gitmodules_oid);
448 if (!me->overwrite &&
449 submodule->fetch_recurse != RECURSE_SUBMODULES_NONE)
450 warn_multiple_config(me->treeish_name, submodule->name,
451 "fetchrecursesubmodules");
453 submodule->fetch_recurse = parse_fetch_recurse(
456 } else if (!strcmp(item.buf, "ignore")) {
458 ret = config_error_nonbool(var);
459 else if (!me->overwrite && submodule->ignore)
460 warn_multiple_config(me->treeish_name, submodule->name,
462 else if (strcmp(value, "untracked") &&
463 strcmp(value, "dirty") &&
464 strcmp(value, "all") &&
465 strcmp(value, "none"))
466 warning("Invalid parameter '%s' for config option "
467 "'submodule.%s.ignore'", value, name.buf);
469 free((void *) submodule->ignore);
470 submodule->ignore = xstrdup(value);
472 } else if (!strcmp(item.buf, "url")) {
474 ret = config_error_nonbool(var);
475 } else if (looks_like_command_line_option(value)) {
476 warn_command_line_option(var, value);
477 } else if (!me->overwrite && submodule->url) {
478 warn_multiple_config(me->treeish_name, submodule->name,
481 free((void *) submodule->url);
482 submodule->url = xstrdup(value);
484 } else if (!strcmp(item.buf, "update")) {
486 ret = config_error_nonbool(var);
487 else if (!me->overwrite &&
488 submodule->update_strategy.type != SM_UPDATE_UNSPECIFIED)
489 warn_multiple_config(me->treeish_name, submodule->name,
491 else if (parse_submodule_update_strategy(value,
492 &submodule->update_strategy) < 0 ||
493 submodule->update_strategy.type == SM_UPDATE_COMMAND)
494 die(_("invalid value for %s"), var);
495 } else if (!strcmp(item.buf, "shallow")) {
496 if (!me->overwrite && submodule->recommend_shallow != -1)
497 warn_multiple_config(me->treeish_name, submodule->name,
500 submodule->recommend_shallow =
501 git_config_bool(var, value);
502 } else if (!strcmp(item.buf, "branch")) {
503 if (!me->overwrite && submodule->branch)
504 warn_multiple_config(me->treeish_name, submodule->name,
507 free((void *)submodule->branch);
508 submodule->branch = xstrdup(value);
512 strbuf_release(&name);
513 strbuf_release(&item);
518 static int gitmodule_oid_from_commit(const struct object_id *treeish_name,
519 struct object_id *gitmodules_oid,
524 if (is_null_oid(treeish_name)) {
525 oidclr(gitmodules_oid);
529 strbuf_addf(rev, "%s:.gitmodules", oid_to_hex(treeish_name));
530 if (get_oid(rev->buf, gitmodules_oid) >= 0)
536 /* This does a lookup of a submodule configuration by name or by path
537 * (key) with on-demand reading of the appropriate .gitmodules from
540 static const struct submodule *config_from(struct submodule_cache *cache,
541 const struct object_id *treeish_name, const char *key,
542 enum lookup_type lookup_type)
544 struct strbuf rev = STRBUF_INIT;
545 unsigned long config_size;
547 struct object_id oid;
548 enum object_type type;
549 const struct submodule *submodule = NULL;
550 struct parse_config_parameter parameter;
553 * If any parameter except the cache is a NULL pointer just
554 * return the first submodule. Can be used to check whether
555 * there are any submodules parsed.
557 if (!treeish_name || !key) {
558 struct hashmap_iter iter;
559 struct submodule_entry *entry;
561 entry = hashmap_iter_first(&cache->for_name, &iter);
564 return entry->config;
567 if (!gitmodule_oid_from_commit(treeish_name, &oid, &rev))
570 switch (lookup_type) {
572 submodule = cache_lookup_name(cache, &oid, key);
575 submodule = cache_lookup_path(cache, &oid, key);
581 config = read_object_file(&oid, &type, &config_size);
582 if (!config || type != OBJ_BLOB)
585 /* fill the submodule config into the cache */
586 parameter.cache = cache;
587 parameter.treeish_name = treeish_name;
588 parameter.gitmodules_oid = &oid;
589 parameter.overwrite = 0;
590 git_config_from_mem(parse_config, CONFIG_ORIGIN_SUBMODULE_BLOB, rev.buf,
591 config, config_size, ¶meter, NULL);
592 strbuf_release(&rev);
595 switch (lookup_type) {
597 return cache_lookup_name(cache, &oid, key);
599 return cache_lookup_path(cache, &oid, key);
605 strbuf_release(&rev);
610 static void submodule_cache_check_init(struct repository *repo)
612 if (repo->submodule_cache && repo->submodule_cache->initialized)
615 if (!repo->submodule_cache)
616 repo->submodule_cache = submodule_cache_alloc();
618 submodule_cache_init(repo->submodule_cache);
622 * Note: This function is private for a reason, the '.gitmodules' file should
623 * not be used as as a mechanism to retrieve arbitrary configuration stored in
626 * Runs the provided config function on the '.gitmodules' file found in the
629 static void config_from_gitmodules(config_fn_t fn, struct repository *repo, void *data)
631 if (repo->worktree) {
632 struct git_config_source config_source = { 0 };
633 const struct config_options opts = { 0 };
634 struct object_id oid;
638 file = repo_worktree_path(repo, GITMODULES_FILE);
639 if (file_exists(file)) {
640 config_source.file = file;
641 } else if (repo_get_oid(repo, GITMODULES_INDEX, &oid) >= 0 ||
642 repo_get_oid(repo, GITMODULES_HEAD, &oid) >= 0) {
643 config_source.blob = oidstr = xstrdup(oid_to_hex(&oid));
644 if (repo != the_repository)
645 add_to_alternates_memory(repo->objects->odb->path);
650 config_with_options(fn, data, &config_source, &opts);
658 static int gitmodules_cb(const char *var, const char *value, void *data)
660 struct repository *repo = data;
661 struct parse_config_parameter parameter;
663 parameter.cache = repo->submodule_cache;
664 parameter.treeish_name = NULL;
665 parameter.gitmodules_oid = &null_oid;
666 parameter.overwrite = 1;
668 return parse_config(var, value, ¶meter);
671 void repo_read_gitmodules(struct repository *repo)
673 submodule_cache_check_init(repo);
675 if (repo_read_index(repo) < 0)
678 if (!is_gitmodules_unmerged(repo->index))
679 config_from_gitmodules(gitmodules_cb, repo, repo);
681 repo->submodule_cache->gitmodules_read = 1;
684 void gitmodules_config_oid(const struct object_id *commit_oid)
686 struct strbuf rev = STRBUF_INIT;
687 struct object_id oid;
689 submodule_cache_check_init(the_repository);
691 if (gitmodule_oid_from_commit(commit_oid, &oid, &rev)) {
692 git_config_from_blob_oid(gitmodules_cb, rev.buf,
693 &oid, the_repository);
695 strbuf_release(&rev);
697 the_repository->submodule_cache->gitmodules_read = 1;
700 static void gitmodules_read_check(struct repository *repo)
702 submodule_cache_check_init(repo);
704 /* read the repo's .gitmodules file if it hasn't been already */
705 if (!repo->submodule_cache->gitmodules_read)
706 repo_read_gitmodules(repo);
709 const struct submodule *submodule_from_name(struct repository *r,
710 const struct object_id *treeish_name,
713 gitmodules_read_check(r);
714 return config_from(r->submodule_cache, treeish_name, name, lookup_name);
717 const struct submodule *submodule_from_path(struct repository *r,
718 const struct object_id *treeish_name,
721 gitmodules_read_check(r);
722 return config_from(r->submodule_cache, treeish_name, path, lookup_path);
725 void submodule_free(struct repository *r)
727 if (r->submodule_cache)
728 submodule_cache_clear(r->submodule_cache);
731 static int config_print_callback(const char *var, const char *value, void *cb_data)
733 char *wanted_key = cb_data;
735 if (!strcmp(wanted_key, var))
736 printf("%s\n", value);
741 int print_config_from_gitmodules(struct repository *repo, const char *key)
746 ret = git_config_parse_key(key, &store_key, NULL);
748 return CONFIG_INVALID_KEY;
750 config_from_gitmodules(config_print_callback, repo, store_key);
756 int config_set_in_gitmodules_file_gently(const char *key, const char *value)
760 ret = git_config_set_in_file_gently(GITMODULES_FILE, key, value);
762 /* Maybe the user already did that, don't error out here */
763 warning(_("Could not update .gitmodules entry %s"), key);
768 struct fetch_config {
770 int *recurse_submodules;
773 static int gitmodules_fetch_config(const char *var, const char *value, void *cb)
775 struct fetch_config *config = cb;
776 if (!strcmp(var, "submodule.fetchjobs")) {
777 *(config->max_children) = parse_submodule_fetchjobs(var, value);
779 } else if (!strcmp(var, "fetch.recursesubmodules")) {
780 *(config->recurse_submodules) = parse_fetch_recurse_submodules_arg(var, value);
787 void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules)
789 struct fetch_config config = {
790 .max_children = max_children,
791 .recurse_submodules = recurse_submodules
793 config_from_gitmodules(gitmodules_fetch_config, the_repository, &config);
796 static int gitmodules_update_clone_config(const char *var, const char *value,
800 if (!strcmp(var, "submodule.fetchjobs"))
801 *max_jobs = parse_submodule_fetchjobs(var, value);
805 void update_clone_config_from_gitmodules(int *max_jobs)
807 config_from_gitmodules(gitmodules_update_clone_config, the_repository, &max_jobs);