submodule-config.c

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