submodule-config.c

   1 #include "cache.h"
   2 #include "dir.h"
   3 #include "repository.h"
   4 #include "config.h"
   5 #include "submodule-config.h"
   6 #include "submodule.h"
   7 #include "strbuf.h"
   8 #include "object-store.h"
   9 #include "parse-options.h"
  10
  11 /*
  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
  18  */
  19 struct submodule_cache {
  20         struct hashmap for_path;
  21         struct hashmap for_name;
  22         unsigned initialized:1;
  23         unsigned gitmodules_read:1;
  24 };
  25
  26 /*
  27  * thin wrapper struct needed to insert 'struct submodule' entries to
  28  * the hashmap
  29  */
  30 struct submodule_entry {
  31         struct hashmap_entry ent;
  32         struct submodule *config;
  33 };
  34
  35 enum lookup_type {
  36         lookup_name,
  37         lookup_path
  38 };
  39
  40 static int config_path_cmp(const void *unused_cmp_data,
  41                            const void *entry,
  42                            const void *entry_or_key,
  43                            const void *unused_keydata)
  44 {
  45         const struct submodule_entry *a = entry;
  46         const struct submodule_entry *b = entry_or_key;
  47
  48         return strcmp(a->config->path, b->config->path) ||
  49                !oideq(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
  50 }
  51
  52 static int config_name_cmp(const void *unused_cmp_data,
  53                            const void *entry,
  54                            const void *entry_or_key,
  55                            const void *unused_keydata)
  56 {
  57         const struct submodule_entry *a = entry;
  58         const struct submodule_entry *b = entry_or_key;
  59
  60         return strcmp(a->config->name, b->config->name) ||
  61                !oideq(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
  62 }
  63
  64 static struct submodule_cache *submodule_cache_alloc(void)
  65 {
  66         return xcalloc(1, sizeof(struct submodule_cache));
  67 }
  68
  69 static void submodule_cache_init(struct submodule_cache *cache)
  70 {
  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;
  74 }
  75
  76 static void free_one_config(struct submodule_entry *entry)
  77 {
  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);
  82         free(entry->config);
  83 }
  84
  85 static void submodule_cache_clear(struct submodule_cache *cache)
  86 {
  87         struct hashmap_iter iter;
  88         struct submodule_entry *entry;
  89
  90         if (!cache->initialized)
  91                 return;
  92
  93         /*
  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.
  97          */
  98         hashmap_iter_init(&cache->for_name, &iter);
  99         while ((entry = hashmap_iter_next(&iter)))
 100                 free_one_config(entry);
 101
 102         hashmap_free(&cache->for_path, 1);
 103         hashmap_free(&cache->for_name, 1);
 104         cache->initialized = 0;
 105         cache->gitmodules_read = 0;
 106 }
 107
 108 void submodule_cache_free(struct submodule_cache *cache)
 109 {
 110         submodule_cache_clear(cache);
 111         free(cache);
 112 }
 113
 114 static unsigned int hash_oid_string(const struct object_id *oid,
 115                                     const char *string)
 116 {
 117         return memhash(oid->hash, the_hash_algo->rawsz) + strhash(string);
 118 }
 119
 120 static void cache_put_path(struct submodule_cache *cache,
 121                            struct submodule *submodule)
 122 {
 123         unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
 124                                             submodule->path);
 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);
 129 }
 130
 131 static void cache_remove_path(struct submodule_cache *cache,
 132                               struct submodule *submodule)
 133 {
 134         unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
 135                                             submodule->path);
 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);
 141         free(removed);
 142 }
 143
 144 static void cache_add(struct submodule_cache *cache,
 145                       struct submodule *submodule)
 146 {
 147         unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
 148                                             submodule->name);
 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);
 153 }
 154
 155 static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
 156                 const struct object_id *gitmodules_oid, const char *path)
 157 {
 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;
 162
 163         oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
 164         key_config.path = path;
 165
 166         hashmap_entry_init(&key, hash);
 167         key.config = &key_config;
 168
 169         entry = hashmap_get(&cache->for_path, &key, NULL);
 170         if (entry)
 171                 return entry->config;
 172         return NULL;
 173 }
 174
 175 static struct submodule *cache_lookup_name(struct submodule_cache *cache,
 176                 const struct object_id *gitmodules_oid, const char *name)
 177 {
 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;
 182
 183         oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
 184         key_config.name = name;
 185
 186         hashmap_entry_init(&key, hash);
 187         key.config = &key_config;
 188
 189         entry = hashmap_get(&cache->for_name, &key, NULL);
 190         if (entry)
 191                 return entry->config;
 192         return NULL;
 193 }
 194
 195 int check_submodule_name(const char *name)
 196 {
 197         /* Disallow empty names */
 198         if (!*name)
 199                 return -1;
 200
 201         /*
 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.
 205          */
 206         goto in_component; /* always start inside component */
 207         while (*name) {
 208                 char c = *name++;
 209                 if (c == '/' || c == '\\') {
 210 in_component:
 211                         if (name[0] == '.' && name[1] == '.' &&
 212                             (!name[2] || name[2] == '/' || name[2] == '\\'))
 213                                 return -1;
 214                 }
 215         }
 216
 217         return 0;
 218 }
 219
 220 static int name_and_item_from_var(const char *var, struct strbuf *name,
 221                                   struct strbuf *item)
 222 {
 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)
 228                 return 0;
 229
 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);
 234                 return 0;
 235         }
 236
 237         strbuf_addstr(item, key);
 238
 239         return 1;
 240 }
 241
 242 static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
 243                 const struct object_id *gitmodules_oid, const char *name)
 244 {
 245         struct submodule *submodule;
 246         struct strbuf name_buf = STRBUF_INIT;
 247
 248         submodule = cache_lookup_name(cache, gitmodules_oid, name);
 249         if (submodule)
 250                 return submodule;
 251
 252         submodule = xmalloc(sizeof(*submodule));
 253
 254         strbuf_addstr(&name_buf, name);
 255         submodule->name = strbuf_detach(&name_buf, NULL);
 256
 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;
 265
 266         oidcpy(&submodule->gitmodules_oid, gitmodules_oid);
 267
 268         cache_add(cache, submodule);
 269
 270         return submodule;
 271 }
 272
 273 static int parse_fetch_recurse(const char *opt, const char *arg,
 274                                int die_on_error)
 275 {
 276         switch (git_parse_maybe_bool(arg)) {
 277         case 1:
 278                 return RECURSE_SUBMODULES_ON;
 279         case 0:
 280                 return RECURSE_SUBMODULES_OFF;
 281         default:
 282                 if (!strcmp(arg, "on-demand"))
 283                         return RECURSE_SUBMODULES_ON_DEMAND;
 284                 /*
 285                  * Please update $__git_fetch_recurse_submodules in
 286                  * git-completion.bash when you add new options.
 287                  */
 288                 if (die_on_error)
 289                         die("bad %s argument: %s", opt, arg);
 290                 else
 291                         return RECURSE_SUBMODULES_ERROR;
 292         }
 293 }
 294
 295 int parse_submodule_fetchjobs(const char *var, const char *value)
 296 {
 297         int fetchjobs = git_config_int(var, value);
 298         if (fetchjobs < 0)
 299                 die(_("negative values not allowed for submodule.fetchjobs"));
 300         return fetchjobs;
 301 }
 302
 303 int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
 304 {
 305         return parse_fetch_recurse(opt, arg, 1);
 306 }
 307
 308 int option_fetch_parse_recurse_submodules(const struct option *opt,
 309                                           const char *arg, int unset)
 310 {
 311         int *v;
 312
 313         if (!opt->value)
 314                 return -1;
 315
 316         v = opt->value;
 317
 318         if (unset) {
 319                 *v = RECURSE_SUBMODULES_OFF;
 320         } else {
 321                 if (arg)
 322                         *v = parse_fetch_recurse_submodules_arg(opt->long_name, arg);
 323                 else
 324                         *v = RECURSE_SUBMODULES_ON;
 325         }
 326         return 0;
 327 }
 328
 329 static int parse_update_recurse(const char *opt, const char *arg,
 330                                 int die_on_error)
 331 {
 332         switch (git_parse_maybe_bool(arg)) {
 333         case 1:
 334                 return RECURSE_SUBMODULES_ON;
 335         case 0:
 336                 return RECURSE_SUBMODULES_OFF;
 337         default:
 338                 if (die_on_error)
 339                         die("bad %s argument: %s", opt, arg);
 340                 return RECURSE_SUBMODULES_ERROR;
 341         }
 342 }
 343
 344 int parse_update_recurse_submodules_arg(const char *opt, const char *arg)
 345 {
 346         return parse_update_recurse(opt, arg, 1);
 347 }
 348
 349 static int parse_push_recurse(const char *opt, const char *arg,
 350                                int die_on_error)
 351 {
 352         switch (git_parse_maybe_bool(arg)) {
 353         case 1:
 354                 /* There's no simple "on" value when pushing */
 355                 if (die_on_error)
 356                         die("bad %s argument: %s", opt, arg);
 357                 else
 358                         return RECURSE_SUBMODULES_ERROR;
 359         case 0:
 360                 return RECURSE_SUBMODULES_OFF;
 361         default:
 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;
 368                 /*
 369                  * Please update $__git_push_recurse_submodules in
 370                  * git-completion.bash when you add new modes.
 371                  */
 372                 else if (die_on_error)
 373                         die("bad %s argument: %s", opt, arg);
 374                 else
 375                         return RECURSE_SUBMODULES_ERROR;
 376         }
 377 }
 378
 379 int parse_push_recurse_submodules_arg(const char *opt, const char *arg)
 380 {
 381         return parse_push_recurse(opt, arg, 1);
 382 }
 383
 384 static void warn_multiple_config(const struct object_id *treeish_name,
 385                                  const char *name, const char *option)
 386 {
 387         const char *commit_string = "WORKTREE";
 388         if (treeish_name)
 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);
 393 }
 394
 395 static void warn_command_line_option(const char *var, const char *value)
 396 {
 397         warning(_("ignoring '%s' which may be interpreted as"
 398                   " a command-line option: %s"), var, value);
 399 }
 400
 401 struct parse_config_parameter {
 402         struct submodule_cache *cache;
 403         const struct object_id *treeish_name;
 404         const struct object_id *gitmodules_oid;
 405         int overwrite;
 406 };
 407
 408 /*
 409  * Parse a config item from .gitmodules.
 410  *
 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.
 414  */
 415 static int parse_config(const char *var, const char *value, void *data)
 416 {
 417         struct parse_config_parameter *me = data;
 418         struct submodule *submodule;
 419         struct strbuf name = STRBUF_INIT, item = STRBUF_INIT;
 420         int ret = 0;
 421
 422         /* this also ensures that we only parse submodule entries */
 423         if (!name_and_item_from_var(var, &name, &item))
 424                 return 0;
 425
 426         submodule = lookup_or_create_by_name(me->cache,
 427                                              me->gitmodules_oid,
 428                                              name.buf);
 429
 430         if (!strcmp(item.buf, "path")) {
 431                 if (!value)
 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,
 437                                         "path");
 438                 else {
 439                         if (submodule->path)
 440                                 cache_remove_path(me->cache, submodule);
 441                         free((void *) submodule->path);
 442                         submodule->path = xstrdup(value);
 443                         cache_put_path(me->cache, submodule);
 444                 }
 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");
 452                 else
 453                         submodule->fetch_recurse = parse_fetch_recurse(
 454                                                                 var, value,
 455                                                                 die_on_error);
 456         } else if (!strcmp(item.buf, "ignore")) {
 457                 if (!value)
 458                         ret = config_error_nonbool(var);
 459                 else if (!me->overwrite && submodule->ignore)
 460                         warn_multiple_config(me->treeish_name, submodule->name,
 461                                         "ignore");
 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);
 468                 else {
 469                         free((void *) submodule->ignore);
 470                         submodule->ignore = xstrdup(value);
 471                 }
 472         } else if (!strcmp(item.buf, "url")) {
 473                 if (!value) {
 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,
 479                                         "url");
 480                 } else {
 481                         free((void *) submodule->url);
 482                         submodule->url = xstrdup(value);
 483                 }
 484         } else if (!strcmp(item.buf, "update")) {
 485                 if (!value)
 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,
 490                                              "update");
 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,
 498                                              "shallow");
 499                 else
 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,
 505                                              "branch");
 506                 else {
 507                         free((void *)submodule->branch);
 508                         submodule->branch = xstrdup(value);
 509                 }
 510         }
 511
 512         strbuf_release(&name);
 513         strbuf_release(&item);
 514
 515         return ret;
 516 }
 517
 518 static int gitmodule_oid_from_commit(const struct object_id *treeish_name,
 519                                      struct object_id *gitmodules_oid,
 520                                      struct strbuf *rev)
 521 {
 522         int ret = 0;
 523
 524         if (is_null_oid(treeish_name)) {
 525                 oidclr(gitmodules_oid);
 526                 return 1;
 527         }
 528
 529         strbuf_addf(rev, "%s:.gitmodules", oid_to_hex(treeish_name));
 530         if (get_oid(rev->buf, gitmodules_oid) >= 0)
 531                 ret = 1;
 532
 533         return ret;
 534 }
 535
 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
 538  * revisions.
 539  */
 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)
 543 {
 544         struct strbuf rev = STRBUF_INIT;
 545         unsigned long config_size;
 546         char *config = NULL;
 547         struct object_id oid;
 548         enum object_type type;
 549         const struct submodule *submodule = NULL;
 550         struct parse_config_parameter parameter;
 551
 552         /*
 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.
 556          */
 557         if (!treeish_name || !key) {
 558                 struct hashmap_iter iter;
 559                 struct submodule_entry *entry;
 560
 561                 entry = hashmap_iter_first(&cache->for_name, &iter);
 562                 if (!entry)
 563                         return NULL;
 564                 return entry->config;
 565         }
 566
 567         if (!gitmodule_oid_from_commit(treeish_name, &oid, &rev))
 568                 goto out;
 569
 570         switch (lookup_type) {
 571         case lookup_name:
 572                 submodule = cache_lookup_name(cache, &oid, key);
 573                 break;
 574         case lookup_path:
 575                 submodule = cache_lookup_path(cache, &oid, key);
 576                 break;
 577         }
 578         if (submodule)
 579                 goto out;
 580
 581         config = read_object_file(&oid, &type, &config_size);
 582         if (!config || type != OBJ_BLOB)
 583                 goto out;
 584
 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, &parameter, NULL);
 592         strbuf_release(&rev);
 593         free(config);
 594
 595         switch (lookup_type) {
 596         case lookup_name:
 597                 return cache_lookup_name(cache, &oid, key);
 598         case lookup_path:
 599                 return cache_lookup_path(cache, &oid, key);
 600         default:
 601                 return NULL;
 602         }
 603
 604 out:
 605         strbuf_release(&rev);
 606         free(config);
 607         return submodule;
 608 }
 609
 610 static void submodule_cache_check_init(struct repository *repo)
 611 {
 612         if (repo->submodule_cache && repo->submodule_cache->initialized)
 613                 return;
 614
 615         if (!repo->submodule_cache)
 616                 repo->submodule_cache = submodule_cache_alloc();
 617
 618         submodule_cache_init(repo->submodule_cache);
 619 }
 620
 621 /*
 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
 624  * the repository.
 625  *
 626  * Runs the provided config function on the '.gitmodules' file found in the
 627  * working directory.
 628  */
 629 static void config_from_gitmodules(config_fn_t fn, struct repository *repo, void *data)
 630 {
 631         if (repo->worktree) {
 632                 struct git_config_source config_source = { 0 };
 633                 const struct config_options opts = { 0 };
 634                 struct object_id oid;
 635                 char *file;
 636                 char *oidstr = NULL;
 637
 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);
 646                 } else {
 647                         goto out;
 648                 }
 649
 650                 config_with_options(fn, data, &config_source, &opts);
 651
 652 out:
 653                 free(oidstr);
 654                 free(file);
 655         }
 656 }
 657
 658 static int gitmodules_cb(const char *var, const char *value, void *data)
 659 {
 660         struct repository *repo = data;
 661         struct parse_config_parameter parameter;
 662
 663         parameter.cache = repo->submodule_cache;
 664         parameter.treeish_name = NULL;
 665         parameter.gitmodules_oid = &null_oid;
 666         parameter.overwrite = 1;
 667
 668         return parse_config(var, value, &parameter);
 669 }
 670
 671 void repo_read_gitmodules(struct repository *repo)
 672 {
 673         submodule_cache_check_init(repo);
 674
 675         if (repo_read_index(repo) < 0)
 676                 return;
 677
 678         if (!is_gitmodules_unmerged(repo->index))
 679                 config_from_gitmodules(gitmodules_cb, repo, repo);
 680
 681         repo->submodule_cache->gitmodules_read = 1;
 682 }
 683
 684 void gitmodules_config_oid(const struct object_id *commit_oid)
 685 {
 686         struct strbuf rev = STRBUF_INIT;
 687         struct object_id oid;
 688
 689         submodule_cache_check_init(the_repository);
 690
 691         if (gitmodule_oid_from_commit(commit_oid, &oid, &rev)) {
 692                 git_config_from_blob_oid(gitmodules_cb, rev.buf,
 693                                          &oid, the_repository);
 694         }
 695         strbuf_release(&rev);
 696
 697         the_repository->submodule_cache->gitmodules_read = 1;
 698 }
 699
 700 static void gitmodules_read_check(struct repository *repo)
 701 {
 702         submodule_cache_check_init(repo);
 703
 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);
 707 }
 708
 709 const struct submodule *submodule_from_name(struct repository *r,
 710                                             const struct object_id *treeish_name,
 711                 const char *name)
 712 {
 713         gitmodules_read_check(r);
 714         return config_from(r->submodule_cache, treeish_name, name, lookup_name);
 715 }
 716
 717 const struct submodule *submodule_from_path(struct repository *r,
 718                                             const struct object_id *treeish_name,
 719                 const char *path)
 720 {
 721         gitmodules_read_check(r);
 722         return config_from(r->submodule_cache, treeish_name, path, lookup_path);
 723 }
 724
 725 void submodule_free(struct repository *r)
 726 {
 727         if (r->submodule_cache)
 728                 submodule_cache_clear(r->submodule_cache);
 729 }
 730
 731 static int config_print_callback(const char *var, const char *value, void *cb_data)
 732 {
 733         char *wanted_key = cb_data;
 734
 735         if (!strcmp(wanted_key, var))
 736                 printf("%s\n", value);
 737
 738         return 0;
 739 }
 740
 741 int print_config_from_gitmodules(struct repository *repo, const char *key)
 742 {
 743         int ret;
 744         char *store_key;
 745
 746         ret = git_config_parse_key(key, &store_key, NULL);
 747         if (ret < 0)
 748                 return CONFIG_INVALID_KEY;
 749
 750         config_from_gitmodules(config_print_callback, repo, store_key);
 751
 752         free(store_key);
 753         return 0;
 754 }
 755
 756 int config_set_in_gitmodules_file_gently(const char *key, const char *value)
 757 {
 758         int ret;
 759
 760         ret = git_config_set_in_file_gently(GITMODULES_FILE, key, value);
 761         if (ret < 0)
 762                 /* Maybe the user already did that, don't error out here */
 763                 warning(_("Could not update .gitmodules entry %s"), key);
 764
 765         return ret;
 766 }
 767
 768 struct fetch_config {
 769         int *max_children;
 770         int *recurse_submodules;
 771 };
 772
 773 static int gitmodules_fetch_config(const char *var, const char *value, void *cb)
 774 {
 775         struct fetch_config *config = cb;
 776         if (!strcmp(var, "submodule.fetchjobs")) {
 777                 *(config->max_children) = parse_submodule_fetchjobs(var, value);
 778                 return 0;
 779         } else if (!strcmp(var, "fetch.recursesubmodules")) {
 780                 *(config->recurse_submodules) = parse_fetch_recurse_submodules_arg(var, value);
 781                 return 0;
 782         }
 783
 784         return 0;
 785 }
 786
 787 void fetch_config_from_gitmodules(int *max_children, int *recurse_submodules)
 788 {
 789         struct fetch_config config = {
 790                 .max_children = max_children,
 791                 .recurse_submodules = recurse_submodules
 792         };
 793         config_from_gitmodules(gitmodules_fetch_config, the_repository, &config);
 794 }
 795
 796 static int gitmodules_update_clone_config(const char *var, const char *value,
 797                                           void *cb)
 798 {
 799         int *max_jobs = cb;
 800         if (!strcmp(var, "submodule.fetchjobs"))
 801                 *max_jobs = parse_submodule_fetchjobs(var, value);
 802         return 0;
 803 }
 804
 805 void update_clone_config_from_gitmodules(int *max_jobs)
 806 {
 807         config_from_gitmodules(gitmodules_update_clone_config, the_repository, &max_jobs);
 808 }