]> git.ipfire.org Git - thirdparty/git.git/blame - submodule-config.c
Merge branch 'bk/bisect-doc-fix'
[thirdparty/git.git] / submodule-config.c
CommitLineData
d812c3b6 1#include "git-compat-util.h"
76e9bdc4 2#include "dir.h"
32a8f510 3#include "environment.h"
f394e093 4#include "gettext.h"
41771fa4 5#include "hex.h"
c339932b 6#include "path.h"
bf12fcdf 7#include "repository.h"
b2141fc1 8#include "config.h"
959b5455
HV
9#include "submodule-config.h"
10#include "submodule.h"
11#include "strbuf.h"
dabab1d6 12#include "object-name.h"
a034e910 13#include "object-store-ll.h"
886dc154 14#include "parse-options.h"
e3d2f20e 15#include "thread-utils.h"
961b130d 16#include "tree-walk.h"
959b5455
HV
17
18/*
19 * submodule cache lookup structure
20 * There is one shared set of 'struct submodule' entries which can be
5aea9fe6 21 * looked up by their sha1 blob id of the .gitmodules file and either
959b5455
HV
22 * using path or name as key.
23 * for_path stores submodule entries with path as key
24 * for_name stores submodule entries with name as key
25 */
26struct submodule_cache {
27 struct hashmap for_path;
28 struct hashmap for_name;
bf12fcdf 29 unsigned initialized:1;
ff6f1f56 30 unsigned gitmodules_read:1;
959b5455
HV
31};
32
33/*
34 * thin wrapper struct needed to insert 'struct submodule' entries to
35 * the hashmap
36 */
37struct submodule_entry {
38 struct hashmap_entry ent;
39 struct submodule *config;
40};
41
42enum lookup_type {
43 lookup_name,
44 lookup_path
45};
46
5cf88fd8 47static int config_path_cmp(const void *cmp_data UNUSED,
939af16e
EW
48 const struct hashmap_entry *eptr,
49 const struct hashmap_entry *entry_or_key,
5cf88fd8 50 const void *keydata UNUSED)
959b5455 51{
939af16e
EW
52 const struct submodule_entry *a, *b;
53
54 a = container_of(eptr, const struct submodule_entry, ent);
55 b = container_of(entry_or_key, const struct submodule_entry, ent);
152cbdc6 56
959b5455 57 return strcmp(a->config->path, b->config->path) ||
9001dc2a 58 !oideq(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
959b5455
HV
59}
60
5cf88fd8 61static int config_name_cmp(const void *cmp_data UNUSED,
939af16e
EW
62 const struct hashmap_entry *eptr,
63 const struct hashmap_entry *entry_or_key,
5cf88fd8 64 const void *keydata UNUSED)
959b5455 65{
939af16e
EW
66 const struct submodule_entry *a, *b;
67
68 a = container_of(eptr, const struct submodule_entry, ent);
69 b = container_of(entry_or_key, const struct submodule_entry, ent);
152cbdc6 70
959b5455 71 return strcmp(a->config->name, b->config->name) ||
9001dc2a 72 !oideq(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
959b5455
HV
73}
74
bf12fcdf
BW
75static struct submodule_cache *submodule_cache_alloc(void)
76{
77 return xcalloc(1, sizeof(struct submodule_cache));
78}
79
80static void submodule_cache_init(struct submodule_cache *cache)
959b5455 81{
152cbdc6
SB
82 hashmap_init(&cache->for_path, config_path_cmp, NULL, 0);
83 hashmap_init(&cache->for_name, config_name_cmp, NULL, 0);
bf12fcdf 84 cache->initialized = 1;
959b5455
HV
85}
86
87static void free_one_config(struct submodule_entry *entry)
88{
89 free((void *) entry->config->path);
90 free((void *) entry->config->name);
b5944f34 91 free((void *) entry->config->branch);
ea2fa5a3 92 free((void *) entry->config->update_strategy.command);
959b5455
HV
93 free(entry->config);
94}
95
bf12fcdf 96static void submodule_cache_clear(struct submodule_cache *cache)
959b5455
HV
97{
98 struct hashmap_iter iter;
99 struct submodule_entry *entry;
100
bf12fcdf
BW
101 if (!cache->initialized)
102 return;
103
959b5455
HV
104 /*
105 * We iterate over the name hash here to be symmetric with the
106 * allocation of struct submodule entries. Each is allocated by
5aea9fe6 107 * their .gitmodules blob sha1 and submodule name.
959b5455 108 */
87571c3f 109 hashmap_for_each_entry(&cache->for_name, &iter, entry,
23dee69f 110 ent /* member name */)
959b5455
HV
111 free_one_config(entry);
112
6da1a258
EN
113 hashmap_clear_and_free(&cache->for_path, struct submodule_entry, ent);
114 hashmap_clear_and_free(&cache->for_name, struct submodule_entry, ent);
bf12fcdf 115 cache->initialized = 0;
ff6f1f56 116 cache->gitmodules_read = 0;
bf12fcdf
BW
117}
118
119void submodule_cache_free(struct submodule_cache *cache)
120{
121 submodule_cache_clear(cache);
122 free(cache);
959b5455
HV
123}
124
34caab02 125static unsigned int hash_oid_string(const struct object_id *oid,
126 const char *string)
959b5455 127{
34caab02 128 return memhash(oid->hash, the_hash_algo->rawsz) + strhash(string);
959b5455
HV
129}
130
131static void cache_put_path(struct submodule_cache *cache,
132 struct submodule *submodule)
133{
34caab02 134 unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
135 submodule->path);
959b5455 136 struct submodule_entry *e = xmalloc(sizeof(*e));
d22245a2 137 hashmap_entry_init(&e->ent, hash);
959b5455 138 e->config = submodule;
26b455f2 139 hashmap_put(&cache->for_path, &e->ent);
959b5455
HV
140}
141
142static void cache_remove_path(struct submodule_cache *cache,
143 struct submodule *submodule)
144{
34caab02 145 unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
146 submodule->path);
959b5455
HV
147 struct submodule_entry e;
148 struct submodule_entry *removed;
d22245a2 149 hashmap_entry_init(&e.ent, hash);
959b5455 150 e.config = submodule;
404ab78e 151 removed = hashmap_remove_entry(&cache->for_path, &e, ent, NULL);
959b5455
HV
152 free(removed);
153}
154
155static void cache_add(struct submodule_cache *cache,
156 struct submodule *submodule)
157{
34caab02 158 unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
159 submodule->name);
959b5455 160 struct submodule_entry *e = xmalloc(sizeof(*e));
d22245a2 161 hashmap_entry_init(&e->ent, hash);
959b5455 162 e->config = submodule;
b94e5c1d 163 hashmap_add(&cache->for_name, &e->ent);
959b5455
HV
164}
165
166static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
34caab02 167 const struct object_id *gitmodules_oid, const char *path)
959b5455
HV
168{
169 struct submodule_entry *entry;
34caab02 170 unsigned int hash = hash_oid_string(gitmodules_oid, path);
959b5455
HV
171 struct submodule_entry key;
172 struct submodule key_config;
173
34caab02 174 oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
959b5455
HV
175 key_config.path = path;
176
d22245a2 177 hashmap_entry_init(&key.ent, hash);
959b5455
HV
178 key.config = &key_config;
179
404ab78e 180 entry = hashmap_get_entry(&cache->for_path, &key, ent, NULL);
959b5455
HV
181 if (entry)
182 return entry->config;
183 return NULL;
184}
185
186static struct submodule *cache_lookup_name(struct submodule_cache *cache,
34caab02 187 const struct object_id *gitmodules_oid, const char *name)
959b5455
HV
188{
189 struct submodule_entry *entry;
34caab02 190 unsigned int hash = hash_oid_string(gitmodules_oid, name);
959b5455
HV
191 struct submodule_entry key;
192 struct submodule key_config;
193
34caab02 194 oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
959b5455
HV
195 key_config.name = name;
196
d22245a2 197 hashmap_entry_init(&key.ent, hash);
959b5455
HV
198 key.config = &key_config;
199
404ab78e 200 entry = hashmap_get_entry(&cache->for_name, &key, ent, NULL);
959b5455
HV
201 if (entry)
202 return entry->config;
203 return NULL;
204}
205
0383bbb9
JK
206int check_submodule_name(const char *name)
207{
208 /* Disallow empty names */
209 if (!*name)
210 return -1;
211
212 /*
9fd512c8 213 * Look for '..' as a path component. Check is_xplatform_dir_sep() as
0383bbb9
JK
214 * separators rather than is_dir_sep(), because we want the name rules
215 * to be consistent across platforms.
216 */
217 goto in_component; /* always start inside component */
218 while (*name) {
219 char c = *name++;
9fd512c8 220 if (is_xplatform_dir_sep(c)) {
0383bbb9
JK
221in_component:
222 if (name[0] == '.' && name[1] == '.' &&
9fd512c8 223 (!name[2] || is_xplatform_dir_sep(name[2])))
0383bbb9
JK
224 return -1;
225 }
226 }
227
228 return 0;
229}
230
959b5455
HV
231static int name_and_item_from_var(const char *var, struct strbuf *name,
232 struct strbuf *item)
233{
234 const char *subsection, *key;
f5914f4b
JK
235 size_t subsection_len;
236 int parse;
959b5455
HV
237 parse = parse_config_key(var, "submodule", &subsection,
238 &subsection_len, &key);
239 if (parse < 0 || !subsection)
240 return 0;
241
242 strbuf_add(name, subsection, subsection_len);
0383bbb9
JK
243 if (check_submodule_name(name->buf) < 0) {
244 warning(_("ignoring suspicious submodule name: %s"), name->buf);
245 strbuf_release(name);
246 return 0;
247 }
248
959b5455
HV
249 strbuf_addstr(item, key);
250
251 return 1;
252}
253
254static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
34caab02 255 const struct object_id *gitmodules_oid, const char *name)
959b5455
HV
256{
257 struct submodule *submodule;
258 struct strbuf name_buf = STRBUF_INIT;
259
34caab02 260 submodule = cache_lookup_name(cache, gitmodules_oid, name);
959b5455
HV
261 if (submodule)
262 return submodule;
263
264 submodule = xmalloc(sizeof(*submodule));
265
266 strbuf_addstr(&name_buf, name);
267 submodule->name = strbuf_detach(&name_buf, NULL);
268
269 submodule->path = NULL;
270 submodule->url = NULL;
ea2fa5a3
SB
271 submodule->update_strategy.type = SM_UPDATE_UNSPECIFIED;
272 submodule->update_strategy.command = NULL;
959b5455
HV
273 submodule->fetch_recurse = RECURSE_SUBMODULES_NONE;
274 submodule->ignore = NULL;
b5944f34 275 submodule->branch = NULL;
37f52e93 276 submodule->recommend_shallow = -1;
959b5455 277
34caab02 278 oidcpy(&submodule->gitmodules_oid, gitmodules_oid);
959b5455
HV
279
280 cache_add(cache, submodule);
281
282 return submodule;
283}
284
027771fc
HV
285static int parse_fetch_recurse(const char *opt, const char *arg,
286 int die_on_error)
287{
89576613 288 switch (git_parse_maybe_bool(arg)) {
027771fc
HV
289 case 1:
290 return RECURSE_SUBMODULES_ON;
291 case 0:
292 return RECURSE_SUBMODULES_OFF;
293 default:
294 if (!strcmp(arg, "on-demand"))
295 return RECURSE_SUBMODULES_ON_DEMAND;
5a59a230
NTND
296 /*
297 * Please update $__git_fetch_recurse_submodules in
298 * git-completion.bash when you add new options.
299 */
027771fc
HV
300 if (die_on_error)
301 die("bad %s argument: %s", opt, arg);
302 else
303 return RECURSE_SUBMODULES_ERROR;
304 }
305}
306
8868b1eb
GC
307int parse_submodule_fetchjobs(const char *var, const char *value,
308 const struct key_value_info *kvi)
f20e7c1e 309{
8868b1eb 310 int fetchjobs = git_config_int(var, value, kvi);
f20e7c1e 311 if (fetchjobs < 0)
b4eda05d 312 die(_("negative values not allowed for submodule.fetchJobs"));
51243f9f
ÆAB
313 if (!fetchjobs)
314 fetchjobs = online_cpus();
f20e7c1e
BW
315 return fetchjobs;
316}
317
027771fc
HV
318int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
319{
320 return parse_fetch_recurse(opt, arg, 1);
321}
322
886dc154
SB
323int option_fetch_parse_recurse_submodules(const struct option *opt,
324 const char *arg, int unset)
325{
326 int *v;
327
328 if (!opt->value)
329 return -1;
330
331 v = opt->value;
332
333 if (unset) {
334 *v = RECURSE_SUBMODULES_OFF;
335 } else {
336 if (arg)
337 *v = parse_fetch_recurse_submodules_arg(opt->long_name, arg);
338 else
339 *v = RECURSE_SUBMODULES_ON;
340 }
341 return 0;
342}
343
d601fd09
SB
344static int parse_update_recurse(const char *opt, const char *arg,
345 int die_on_error)
346{
bdfcdefd 347 switch (git_parse_maybe_bool(arg)) {
d601fd09
SB
348 case 1:
349 return RECURSE_SUBMODULES_ON;
350 case 0:
351 return RECURSE_SUBMODULES_OFF;
352 default:
353 if (die_on_error)
354 die("bad %s argument: %s", opt, arg);
355 return RECURSE_SUBMODULES_ERROR;
356 }
357}
358
359int parse_update_recurse_submodules_arg(const char *opt, const char *arg)
360{
361 return parse_update_recurse(opt, arg, 1);
362}
363
b33a15b0
MC
364static int parse_push_recurse(const char *opt, const char *arg,
365 int die_on_error)
366{
89576613 367 switch (git_parse_maybe_bool(arg)) {
b33a15b0
MC
368 case 1:
369 /* There's no simple "on" value when pushing */
370 if (die_on_error)
371 die("bad %s argument: %s", opt, arg);
372 else
373 return RECURSE_SUBMODULES_ERROR;
374 case 0:
375 return RECURSE_SUBMODULES_OFF;
376 default:
377 if (!strcmp(arg, "on-demand"))
378 return RECURSE_SUBMODULES_ON_DEMAND;
379 else if (!strcmp(arg, "check"))
380 return RECURSE_SUBMODULES_CHECK;
6c656c3f
BW
381 else if (!strcmp(arg, "only"))
382 return RECURSE_SUBMODULES_ONLY;
5a59a230
NTND
383 /*
384 * Please update $__git_push_recurse_submodules in
385 * git-completion.bash when you add new modes.
386 */
b33a15b0
MC
387 else if (die_on_error)
388 die("bad %s argument: %s", opt, arg);
389 else
390 return RECURSE_SUBMODULES_ERROR;
391 }
392}
393
394int parse_push_recurse_submodules_arg(const char *opt, const char *arg)
395{
396 return parse_push_recurse(opt, arg, 1);
397}
398
34caab02 399static void warn_multiple_config(const struct object_id *treeish_name,
959b5455
HV
400 const char *name, const char *option)
401{
402 const char *commit_string = "WORKTREE";
73c293bb 403 if (treeish_name)
34caab02 404 commit_string = oid_to_hex(treeish_name);
959b5455
HV
405 warning("%s:.gitmodules, multiple configurations found for "
406 "'submodule.%s.%s'. Skipping second one!",
407 commit_string, name, option);
408}
409
f6adec4e
JK
410static void warn_command_line_option(const char *var, const char *value)
411{
412 warning(_("ignoring '%s' which may be interpreted as"
413 " a command-line option: %s"), var, value);
414}
415
959b5455
HV
416struct parse_config_parameter {
417 struct submodule_cache *cache;
34caab02 418 const struct object_id *treeish_name;
419 const struct object_id *gitmodules_oid;
959b5455
HV
420 int overwrite;
421};
422
e904deb8
JN
423/*
424 * Parse a config item from .gitmodules.
425 *
426 * This does not handle submodule-related configuration from the main
427 * config store (.git/config, etc). Callers are responsible for
428 * checking for overrides in the main config store when appropriate.
429 */
a4e7e317
GC
430static int parse_config(const char *var, const char *value,
431 const struct config_context *ctx UNUSED, void *data)
959b5455
HV
432{
433 struct parse_config_parameter *me = data;
434 struct submodule *submodule;
435 struct strbuf name = STRBUF_INIT, item = STRBUF_INIT;
436 int ret = 0;
437
438 /* this also ensures that we only parse submodule entries */
439 if (!name_and_item_from_var(var, &name, &item))
440 return 0;
441
147875fd 442 submodule = lookup_or_create_by_name(me->cache,
34caab02 443 me->gitmodules_oid,
147875fd 444 name.buf);
959b5455
HV
445
446 if (!strcmp(item.buf, "path")) {
147875fd 447 if (!value)
959b5455 448 ret = config_error_nonbool(var);
273c6149
JK
449 else if (looks_like_command_line_option(value))
450 warn_command_line_option(var, value);
f73da110 451 else if (!me->overwrite && submodule->path)
73c293bb 452 warn_multiple_config(me->treeish_name, submodule->name,
959b5455 453 "path");
147875fd
SB
454 else {
455 if (submodule->path)
456 cache_remove_path(me->cache, submodule);
457 free((void *) submodule->path);
458 submodule->path = xstrdup(value);
459 cache_put_path(me->cache, submodule);
959b5455 460 }
959b5455 461 } else if (!strcmp(item.buf, "fetchrecursesubmodules")) {
027771fc 462 /* when parsing worktree configurations we can die early */
34caab02 463 int die_on_error = is_null_oid(me->gitmodules_oid);
959b5455 464 if (!me->overwrite &&
147875fd 465 submodule->fetch_recurse != RECURSE_SUBMODULES_NONE)
73c293bb 466 warn_multiple_config(me->treeish_name, submodule->name,
959b5455 467 "fetchrecursesubmodules");
147875fd
SB
468 else
469 submodule->fetch_recurse = parse_fetch_recurse(
470 var, value,
027771fc 471 die_on_error);
959b5455 472 } else if (!strcmp(item.buf, "ignore")) {
147875fd
SB
473 if (!value)
474 ret = config_error_nonbool(var);
f73da110 475 else if (!me->overwrite && submodule->ignore)
73c293bb 476 warn_multiple_config(me->treeish_name, submodule->name,
959b5455 477 "ignore");
147875fd
SB
478 else if (strcmp(value, "untracked") &&
479 strcmp(value, "dirty") &&
480 strcmp(value, "all") &&
481 strcmp(value, "none"))
959b5455 482 warning("Invalid parameter '%s' for config option "
5ea30489 483 "'submodule.%s.ignore'", value, name.buf);
147875fd
SB
484 else {
485 free((void *) submodule->ignore);
486 submodule->ignore = xstrdup(value);
959b5455 487 }
959b5455 488 } else if (!strcmp(item.buf, "url")) {
959b5455
HV
489 if (!value) {
490 ret = config_error_nonbool(var);
f6adec4e
JK
491 } else if (looks_like_command_line_option(value)) {
492 warn_command_line_option(var, value);
f73da110 493 } else if (!me->overwrite && submodule->url) {
73c293bb 494 warn_multiple_config(me->treeish_name, submodule->name,
959b5455 495 "url");
147875fd
SB
496 } else {
497 free((void *) submodule->url);
498 submodule->url = xstrdup(value);
959b5455 499 }
ea2fa5a3
SB
500 } else if (!strcmp(item.buf, "update")) {
501 if (!value)
502 ret = config_error_nonbool(var);
503 else if (!me->overwrite &&
504 submodule->update_strategy.type != SM_UPDATE_UNSPECIFIED)
73c293bb 505 warn_multiple_config(me->treeish_name, submodule->name,
ea2fa5a3
SB
506 "update");
507 else if (parse_submodule_update_strategy(value,
e904deb8
JN
508 &submodule->update_strategy) < 0 ||
509 submodule->update_strategy.type == SM_UPDATE_COMMAND)
1a8aea85 510 die(_("invalid value for '%s'"), var);
37f52e93
SB
511 } else if (!strcmp(item.buf, "shallow")) {
512 if (!me->overwrite && submodule->recommend_shallow != -1)
73c293bb 513 warn_multiple_config(me->treeish_name, submodule->name,
37f52e93 514 "shallow");
b5944f34 515 else
37f52e93
SB
516 submodule->recommend_shallow =
517 git_config_bool(var, value);
b5944f34 518 } else if (!strcmp(item.buf, "branch")) {
34b1a0d3
JK
519 if (!value)
520 ret = config_error_nonbool(var);
521 else if (!me->overwrite && submodule->branch)
73c293bb 522 warn_multiple_config(me->treeish_name, submodule->name,
b5944f34
SB
523 "branch");
524 else {
525 free((void *)submodule->branch);
526 submodule->branch = xstrdup(value);
37f52e93 527 }
959b5455
HV
528 }
529
959b5455
HV
530 strbuf_release(&name);
531 strbuf_release(&item);
532
533 return ret;
534}
535
1b796ace
BW
536static int gitmodule_oid_from_commit(const struct object_id *treeish_name,
537 struct object_id *gitmodules_oid,
538 struct strbuf *rev)
959b5455 539{
959b5455
HV
540 int ret = 0;
541
cd73de47 542 if (is_null_oid(treeish_name)) {
543 oidclr(gitmodules_oid);
959b5455
HV
544 return 1;
545 }
546
cd73de47 547 strbuf_addf(rev, "%s:.gitmodules", oid_to_hex(treeish_name));
d850b7a5 548 if (repo_get_oid(the_repository, rev->buf, gitmodules_oid) >= 0)
959b5455
HV
549 ret = 1;
550
959b5455
HV
551 return ret;
552}
553
554/* This does a lookup of a submodule configuration by name or by path
555 * (key) with on-demand reading of the appropriate .gitmodules from
556 * revisions.
557 */
558static const struct submodule *config_from(struct submodule_cache *cache,
cd73de47 559 const struct object_id *treeish_name, const char *key,
959b5455
HV
560 enum lookup_type lookup_type)
561{
562 struct strbuf rev = STRBUF_INIT;
563 unsigned long config_size;
0918e250 564 char *config = NULL;
cd73de47 565 struct object_id oid;
959b5455
HV
566 enum object_type type;
567 const struct submodule *submodule = NULL;
568 struct parse_config_parameter parameter;
569
570 /*
571 * If any parameter except the cache is a NULL pointer just
572 * return the first submodule. Can be used to check whether
573 * there are any submodules parsed.
574 */
73c293bb 575 if (!treeish_name || !key) {
959b5455
HV
576 struct hashmap_iter iter;
577 struct submodule_entry *entry;
578
87571c3f
EW
579 entry = hashmap_iter_first_entry(&cache->for_name, &iter,
580 struct submodule_entry,
581 ent /* member name */);
959b5455
HV
582 if (!entry)
583 return NULL;
584 return entry->config;
585 }
586
cd73de47 587 if (!gitmodule_oid_from_commit(treeish_name, &oid, &rev))
0918e250 588 goto out;
959b5455
HV
589
590 switch (lookup_type) {
591 case lookup_name:
34caab02 592 submodule = cache_lookup_name(cache, &oid, key);
959b5455
HV
593 break;
594 case lookup_path:
34caab02 595 submodule = cache_lookup_path(cache, &oid, key);
959b5455
HV
596 break;
597 }
598 if (submodule)
0918e250 599 goto out;
959b5455 600
bc726bd0
ÆAB
601 config = repo_read_object_file(the_repository, &oid, &type,
602 &config_size);
0918e250
HV
603 if (!config || type != OBJ_BLOB)
604 goto out;
959b5455
HV
605
606 /* fill the submodule config into the cache */
607 parameter.cache = cache;
34caab02 608 parameter.treeish_name = treeish_name;
609 parameter.gitmodules_oid = &oid;
959b5455 610 parameter.overwrite = 0;
1b8132d9 611 git_config_from_mem(parse_config, CONFIG_ORIGIN_SUBMODULE_BLOB, rev.buf,
809d8680 612 config, config_size, &parameter, CONFIG_SCOPE_UNKNOWN, NULL);
514dea90 613 strbuf_release(&rev);
959b5455
HV
614 free(config);
615
616 switch (lookup_type) {
617 case lookup_name:
34caab02 618 return cache_lookup_name(cache, &oid, key);
959b5455 619 case lookup_path:
34caab02 620 return cache_lookup_path(cache, &oid, key);
959b5455
HV
621 default:
622 return NULL;
623 }
0918e250
HV
624
625out:
626 strbuf_release(&rev);
627 free(config);
628 return submodule;
959b5455
HV
629}
630
bf12fcdf 631static void submodule_cache_check_init(struct repository *repo)
959b5455 632{
bf12fcdf 633 if (repo->submodule_cache && repo->submodule_cache->initialized)
959b5455
HV
634 return;
635
bf12fcdf
BW
636 if (!repo->submodule_cache)
637 repo->submodule_cache = submodule_cache_alloc();
638
639 submodule_cache_init(repo->submodule_cache);
959b5455
HV
640}
641
db64d112
AO
642/*
643 * Note: This function is private for a reason, the '.gitmodules' file should
571fb965 644 * not be used as a mechanism to retrieve arbitrary configuration stored in
db64d112
AO
645 * the repository.
646 *
647 * Runs the provided config function on the '.gitmodules' file found in the
648 * working directory.
649 */
650static void config_from_gitmodules(config_fn_t fn, struct repository *repo, void *data)
651{
652 if (repo->worktree) {
9a83d088
MR
653 struct git_config_source config_source = {
654 0, .scope = CONFIG_SCOPE_SUBMODULE
655 };
76e9bdc4
AO
656 const struct config_options opts = { 0 };
657 struct object_id oid;
658 char *file;
d9b8b8f8 659 char *oidstr = NULL;
76e9bdc4
AO
660
661 file = repo_worktree_path(repo, GITMODULES_FILE);
662 if (file_exists(file)) {
663 config_source.file = file;
d9b8b8f8
NTND
664 } else if (repo_get_oid(repo, GITMODULES_INDEX, &oid) >= 0 ||
665 repo_get_oid(repo, GITMODULES_HEAD, &oid) >= 0) {
666 config_source.blob = oidstr = xstrdup(oid_to_hex(&oid));
667 if (repo != the_repository)
e3e8bf04 668 add_submodule_odb_by_path(repo->objects->odb->path);
76e9bdc4
AO
669 } else {
670 goto out;
671 }
672
9b6b06c1 673 config_with_options(fn, data, &config_source, repo, &opts);
76e9bdc4
AO
674
675out:
d9b8b8f8 676 free(oidstr);
db64d112
AO
677 free(file);
678 }
679}
680
a4e7e317
GC
681static int gitmodules_cb(const char *var, const char *value,
682 const struct config_context *ctx, void *data)
851e18c3 683{
1b796ace 684 struct repository *repo = data;
851e18c3 685 struct parse_config_parameter parameter;
bf12fcdf 686
bf12fcdf 687 parameter.cache = repo->submodule_cache;
73c293bb 688 parameter.treeish_name = NULL;
14228447 689 parameter.gitmodules_oid = null_oid();
851e18c3
HV
690 parameter.overwrite = 1;
691
a4e7e317 692 return parse_config(var, value, ctx, &parameter);
851e18c3
HV
693}
694
d7992421 695void repo_read_gitmodules(struct repository *repo, int skip_if_read)
bf12fcdf 696{
ff6f1f56
BW
697 submodule_cache_check_init(repo);
698
d7992421
MT
699 if (repo->submodule_cache->gitmodules_read && skip_if_read)
700 return;
701
db64d112
AO
702 if (repo_read_index(repo) < 0)
703 return;
1b796ace 704
db64d112
AO
705 if (!is_gitmodules_unmerged(repo->index))
706 config_from_gitmodules(gitmodules_cb, repo, repo);
ff6f1f56
BW
707
708 repo->submodule_cache->gitmodules_read = 1;
1b796ace
BW
709}
710
711void gitmodules_config_oid(const struct object_id *commit_oid)
712{
713 struct strbuf rev = STRBUF_INIT;
714 struct object_id oid;
715
ff6f1f56
BW
716 submodule_cache_check_init(the_repository);
717
1b796ace
BW
718 if (gitmodule_oid_from_commit(commit_oid, &oid, &rev)) {
719 git_config_from_blob_oid(gitmodules_cb, rev.buf,
809d8680
GC
720 the_repository, &oid, the_repository,
721 CONFIG_SCOPE_UNKNOWN);
1b796ace
BW
722 }
723 strbuf_release(&rev);
ff6f1f56
BW
724
725 the_repository->submodule_cache->gitmodules_read = 1;
726}
727
3b8fb393
SB
728const struct submodule *submodule_from_name(struct repository *r,
729 const struct object_id *treeish_name,
959b5455
HV
730 const char *name)
731{
d7992421 732 repo_read_gitmodules(r, 1);
3b8fb393 733 return config_from(r->submodule_cache, treeish_name, name, lookup_name);
959b5455
HV
734}
735
3b8fb393
SB
736const struct submodule *submodule_from_path(struct repository *r,
737 const struct object_id *treeish_name,
959b5455
HV
738 const char *path)
739{
d7992421 740 repo_read_gitmodules(r, 1);
3b8fb393 741 return config_from(r->submodule_cache, treeish_name, path, lookup_path);
bf12fcdf
BW
742}
743
961b130d
GC
744/**
745 * Used internally by submodules_of_tree(). Recurses into 'treeish_name'
746 * and appends submodule entries to 'out'. The submodule_cache expects
747 * a root-level treeish_name and paths, so keep track of these values
748 * with 'root_tree' and 'prefix'.
749 */
750static void traverse_tree_submodules(struct repository *r,
751 const struct object_id *root_tree,
752 char *prefix,
753 const struct object_id *treeish_name,
754 struct submodule_entry_list *out)
755{
756 struct tree_desc tree;
757 struct submodule_tree_entry *st_entry;
758 struct name_entry *name_entry;
759 char *tree_path = NULL;
760
761 name_entry = xmalloc(sizeof(*name_entry));
762
763 fill_tree_descriptor(r, &tree, treeish_name);
764 while (tree_entry(&tree, name_entry)) {
765 if (prefix)
766 tree_path =
767 mkpathdup("%s/%s", prefix, name_entry->path);
768 else
769 tree_path = xstrdup(name_entry->path);
770
771 if (S_ISGITLINK(name_entry->mode) &&
772 is_tree_submodule_active(r, root_tree, tree_path)) {
f5355922
JS
773 ALLOC_GROW(out->entries, out->entry_nr + 1,
774 out->entry_alloc);
775 st_entry = &out->entries[out->entry_nr++];
776
961b130d
GC
777 st_entry->name_entry = xmalloc(sizeof(*st_entry->name_entry));
778 *st_entry->name_entry = *name_entry;
779 st_entry->submodule =
780 submodule_from_path(r, root_tree, tree_path);
781 st_entry->repo = xmalloc(sizeof(*st_entry->repo));
782 if (repo_submodule_init(st_entry->repo, r, tree_path,
783 root_tree))
784 FREE_AND_NULL(st_entry->repo);
785
961b130d
GC
786 } else if (S_ISDIR(name_entry->mode))
787 traverse_tree_submodules(r, root_tree, tree_path,
788 &name_entry->oid, out);
789 free(tree_path);
790 }
791}
792
793void submodules_of_tree(struct repository *r,
794 const struct object_id *treeish_name,
795 struct submodule_entry_list *out)
796{
797 CALLOC_ARRAY(out->entries, 0);
798 out->entry_nr = 0;
799 out->entry_alloc = 0;
800
801 traverse_tree_submodules(r, treeish_name, NULL, treeish_name, out);
802}
803
f793b895 804void submodule_free(struct repository *r)
bf12fcdf 805{
f793b895
SB
806 if (r->submodule_cache)
807 submodule_cache_clear(r->submodule_cache);
959b5455 808}
ad136370 809
a4e7e317
GC
810static int config_print_callback(const char *var, const char *value,
811 const struct config_context *ctx UNUSED,
812 void *cb_data)
bcbc780d
AO
813{
814 char *wanted_key = cb_data;
815
816 if (!strcmp(wanted_key, var))
817 printf("%s\n", value);
818
819 return 0;
820}
821
822int print_config_from_gitmodules(struct repository *repo, const char *key)
823{
824 int ret;
825 char *store_key;
826
827 ret = git_config_parse_key(key, &store_key, NULL);
828 if (ret < 0)
829 return CONFIG_INVALID_KEY;
830
831 config_from_gitmodules(config_print_callback, repo, store_key);
832
833 free(store_key);
834 return 0;
835}
836
45f5ef3d
AO
837int config_set_in_gitmodules_file_gently(const char *key, const char *value)
838{
839 int ret;
840
841 ret = git_config_set_in_file_gently(GITMODULES_FILE, key, value);
842 if (ret < 0)
843 /* Maybe the user already did that, don't error out here */
844 warning(_("Could not update .gitmodules entry %s"), key);
845
846 return ret;
847}
848
71a6953d
AO
849struct fetch_config {
850 int *max_children;
851 int *recurse_submodules;
852};
853
a4e7e317 854static int gitmodules_fetch_config(const char *var, const char *value,
8868b1eb 855 const struct config_context *ctx,
a4e7e317 856 void *cb)
71a6953d
AO
857{
858 struct fetch_config *config = cb;
859 if (!strcmp(var, "submodule.fetchjobs")) {
e5b94213
JT
860 if (config->max_children)
861 *(config->max_children) =
8868b1eb 862 parse_submodule_fetchjobs(var, value, ctx->kvi);
71a6953d
AO
863 return 0;
864 } else if (!strcmp(var, "fetch.recursesubmodules")) {
e5b94213
JT
865 if (config->recurse_submodules)
866 *(config->recurse_submodules) =
867 parse_fetch_recurse_submodules_arg(var, value);
71a6953d
AO
868 return 0;
869 }
870
871 return 0;
872}
873
874void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules)
875{
876 struct fetch_config config = {
877 .max_children = max_children,
878 .recurse_submodules = recurse_submodules
879 };
9a0fb3e7 880 config_from_gitmodules(gitmodules_fetch_config, the_repository, &config);
71a6953d 881}
05744997
AO
882
883static int gitmodules_update_clone_config(const char *var, const char *value,
8868b1eb 884 const struct config_context *ctx,
05744997
AO
885 void *cb)
886{
887 int *max_jobs = cb;
888 if (!strcmp(var, "submodule.fetchjobs"))
8868b1eb 889 *max_jobs = parse_submodule_fetchjobs(var, value, ctx->kvi);
05744997
AO
890 return 0;
891}
892
893void update_clone_config_from_gitmodules(int *max_jobs)
894{
9a0fb3e7 895 config_from_gitmodules(gitmodules_update_clone_config, the_repository, &max_jobs);
05744997 896}