submodule-config.c

   1 #include "cache.h"
   2 #include "repository.h"
   3 #include "config.h"
   4 #include "submodule-config.h"
   5 #include "submodule.h"
   6 #include "strbuf.h"
   7 #include "object-store.h"
   8 #include "parse-options.h"
   9
  10 /*
  11  * submodule cache lookup structure
  12  * There is one shared set of 'struct submodule' entries which can be
  13  * looked up by their sha1 blob id of the .gitmodules file and either
  14  * using path or name as key.
  15  * for_path stores submodule entries with path as key
  16  * for_name stores submodule entries with name as key
  17  */
  18 struct submodule_cache {
  19         struct hashmap for_path;
  20         struct hashmap for_name;
  21         unsigned initialized:1;
  22         unsigned gitmodules_read:1;
  23 };
  24
  25 /*
  26  * thin wrapper struct needed to insert 'struct submodule' entries to
  27  * the hashmap
  28  */
  29 struct submodule_entry {
  30         struct hashmap_entry ent;
  31         struct submodule *config;
  32 };
  33
  34 enum lookup_type {
  35         lookup_name,
  36         lookup_path
  37 };
  38
  39 static int config_path_cmp(const void *unused_cmp_data,
  40                            const void *entry,
  41                            const void *entry_or_key,
  42                            const void *unused_keydata)
  43 {
  44         const struct submodule_entry *a = entry;
  45         const struct submodule_entry *b = entry_or_key;
  46
  47         return strcmp(a->config->path, b->config->path) ||
  48                oidcmp(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
  49 }
  50
  51 static int config_name_cmp(const void *unused_cmp_data,
  52                            const void *entry,
  53                            const void *entry_or_key,
  54                            const void *unused_keydata)
  55 {
  56         const struct submodule_entry *a = entry;
  57         const struct submodule_entry *b = entry_or_key;
  58
  59         return strcmp(a->config->name, b->config->name) ||
  60                oidcmp(&a->config->gitmodules_oid, &b->config->gitmodules_oid);
  61 }
  62
  63 static struct submodule_cache *submodule_cache_alloc(void)
  64 {
  65         return xcalloc(1, sizeof(struct submodule_cache));
  66 }
  67
  68 static void submodule_cache_init(struct submodule_cache *cache)
  69 {
  70         hashmap_init(&cache->for_path, config_path_cmp, NULL, 0);
  71         hashmap_init(&cache->for_name, config_name_cmp, NULL, 0);
  72         cache->initialized = 1;
  73 }
  74
  75 static void free_one_config(struct submodule_entry *entry)
  76 {
  77         free((void *) entry->config->path);
  78         free((void *) entry->config->name);
  79         free((void *) entry->config->branch);
  80         free((void *) entry->config->update_strategy.command);
  81         free(entry->config);
  82 }
  83
  84 static void submodule_cache_clear(struct submodule_cache *cache)
  85 {
  86         struct hashmap_iter iter;
  87         struct submodule_entry *entry;
  88
  89         if (!cache->initialized)
  90                 return;
  91
  92         /*
  93          * We iterate over the name hash here to be symmetric with the
  94          * allocation of struct submodule entries. Each is allocated by
  95          * their .gitmodules blob sha1 and submodule name.
  96          */
  97         hashmap_iter_init(&cache->for_name, &iter);
  98         while ((entry = hashmap_iter_next(&iter)))
  99                 free_one_config(entry);
 100
 101         hashmap_free(&cache->for_path, 1);
 102         hashmap_free(&cache->for_name, 1);
 103         cache->initialized = 0;
 104         cache->gitmodules_read = 0;
 105 }
 106
 107 void submodule_cache_free(struct submodule_cache *cache)
 108 {
 109         submodule_cache_clear(cache);
 110         free(cache);
 111 }
 112
 113 static unsigned int hash_oid_string(const struct object_id *oid,
 114                                     const char *string)
 115 {
 116         return memhash(oid->hash, the_hash_algo->rawsz) + strhash(string);
 117 }
 118
 119 static void cache_put_path(struct submodule_cache *cache,
 120                            struct submodule *submodule)
 121 {
 122         unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
 123                                             submodule->path);
 124         struct submodule_entry *e = xmalloc(sizeof(*e));
 125         hashmap_entry_init(e, hash);
 126         e->config = submodule;
 127         hashmap_put(&cache->for_path, e);
 128 }
 129
 130 static void cache_remove_path(struct submodule_cache *cache,
 131                               struct submodule *submodule)
 132 {
 133         unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
 134                                             submodule->path);
 135         struct submodule_entry e;
 136         struct submodule_entry *removed;
 137         hashmap_entry_init(&e, hash);
 138         e.config = submodule;
 139         removed = hashmap_remove(&cache->for_path, &e, NULL);
 140         free(removed);
 141 }
 142
 143 static void cache_add(struct submodule_cache *cache,
 144                       struct submodule *submodule)
 145 {
 146         unsigned int hash = hash_oid_string(&submodule->gitmodules_oid,
 147                                             submodule->name);
 148         struct submodule_entry *e = xmalloc(sizeof(*e));
 149         hashmap_entry_init(e, hash);
 150         e->config = submodule;
 151         hashmap_add(&cache->for_name, e);
 152 }
 153
 154 static const struct submodule *cache_lookup_path(struct submodule_cache *cache,
 155                 const struct object_id *gitmodules_oid, const char *path)
 156 {
 157         struct submodule_entry *entry;
 158         unsigned int hash = hash_oid_string(gitmodules_oid, path);
 159         struct submodule_entry key;
 160         struct submodule key_config;
 161
 162         oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
 163         key_config.path = path;
 164
 165         hashmap_entry_init(&key, hash);
 166         key.config = &key_config;
 167
 168         entry = hashmap_get(&cache->for_path, &key, NULL);
 169         if (entry)
 170                 return entry->config;
 171         return NULL;
 172 }
 173
 174 static struct submodule *cache_lookup_name(struct submodule_cache *cache,
 175                 const struct object_id *gitmodules_oid, const char *name)
 176 {
 177         struct submodule_entry *entry;
 178         unsigned int hash = hash_oid_string(gitmodules_oid, name);
 179         struct submodule_entry key;
 180         struct submodule key_config;
 181
 182         oidcpy(&key_config.gitmodules_oid, gitmodules_oid);
 183         key_config.name = name;
 184
 185         hashmap_entry_init(&key, hash);
 186         key.config = &key_config;
 187
 188         entry = hashmap_get(&cache->for_name, &key, NULL);
 189         if (entry)
 190                 return entry->config;
 191         return NULL;
 192 }
 193
 194 int check_submodule_name(const char *name)
 195 {
 196         /* Disallow empty names */
 197         if (!*name)
 198                 return -1;
 199
 200         /*
 201          * Look for '..' as a path component. Check both '/' and '\\' as
 202          * separators rather than is_dir_sep(), because we want the name rules
 203          * to be consistent across platforms.
 204          */
 205         goto in_component; /* always start inside component */
 206         while (*name) {
 207                 char c = *name++;
 208                 if (c == '/' || c == '\\') {
 209 in_component:
 210                         if (name[0] == '.' && name[1] == '.' &&
 211                             (!name[2] || name[2] == '/' || name[2] == '\\'))
 212                                 return -1;
 213                 }
 214         }
 215
 216         return 0;
 217 }
 218
 219 static int name_and_item_from_var(const char *var, struct strbuf *name,
 220                                   struct strbuf *item)
 221 {
 222         const char *subsection, *key;
 223         int subsection_len, parse;
 224         parse = parse_config_key(var, "submodule", &subsection,
 225                         &subsection_len, &key);
 226         if (parse < 0 || !subsection)
 227                 return 0;
 228
 229         strbuf_add(name, subsection, subsection_len);
 230         if (check_submodule_name(name->buf) < 0) {
 231                 warning(_("ignoring suspicious submodule name: %s"), name->buf);
 232                 strbuf_release(name);
 233                 return 0;
 234         }
 235
 236         strbuf_addstr(item, key);
 237
 238         return 1;
 239 }
 240
 241 static struct submodule *lookup_or_create_by_name(struct submodule_cache *cache,
 242                 const struct object_id *gitmodules_oid, const char *name)
 243 {
 244         struct submodule *submodule;
 245         struct strbuf name_buf = STRBUF_INIT;
 246
 247         submodule = cache_lookup_name(cache, gitmodules_oid, name);
 248         if (submodule)
 249                 return submodule;
 250
 251         submodule = xmalloc(sizeof(*submodule));
 252
 253         strbuf_addstr(&name_buf, name);
 254         submodule->name = strbuf_detach(&name_buf, NULL);
 255
 256         submodule->path = NULL;
 257         submodule->url = NULL;
 258         submodule->update_strategy.type = SM_UPDATE_UNSPECIFIED;
 259         submodule->update_strategy.command = NULL;
 260         submodule->fetch_recurse = RECURSE_SUBMODULES_NONE;
 261         submodule->ignore = NULL;
 262         submodule->branch = NULL;
 263         submodule->recommend_shallow = -1;
 264
 265         oidcpy(&submodule->gitmodules_oid, gitmodules_oid);
 266
 267         cache_add(cache, submodule);
 268
 269         return submodule;
 270 }
 271
 272 static int parse_fetch_recurse(const char *opt, const char *arg,
 273                                int die_on_error)
 274 {
 275         switch (git_parse_maybe_bool(arg)) {
 276         case 1:
 277                 return RECURSE_SUBMODULES_ON;
 278         case 0:
 279                 return RECURSE_SUBMODULES_OFF;
 280         default:
 281                 if (!strcmp(arg, "on-demand"))
 282                         return RECURSE_SUBMODULES_ON_DEMAND;
 283
 284                 if (die_on_error)
 285                         die("bad %s argument: %s", opt, arg);
 286                 else
 287                         return RECURSE_SUBMODULES_ERROR;
 288         }
 289 }
 290
 291 int parse_submodule_fetchjobs(const char *var, const char *value)
 292 {
 293         int fetchjobs = git_config_int(var, value);
 294         if (fetchjobs < 0)
 295                 die(_("negative values not allowed for submodule.fetchjobs"));
 296         return fetchjobs;
 297 }
 298
 299 int parse_fetch_recurse_submodules_arg(const char *opt, const char *arg)
 300 {
 301         return parse_fetch_recurse(opt, arg, 1);
 302 }
 303
 304 int option_fetch_parse_recurse_submodules(const struct option *opt,
 305                                           const char *arg, int unset)
 306 {
 307         int *v;
 308
 309         if (!opt->value)
 310                 return -1;
 311
 312         v = opt->value;
 313
 314         if (unset) {
 315                 *v = RECURSE_SUBMODULES_OFF;
 316         } else {
 317                 if (arg)
 318                         *v = parse_fetch_recurse_submodules_arg(opt->long_name, arg);
 319                 else
 320                         *v = RECURSE_SUBMODULES_ON;
 321         }
 322         return 0;
 323 }
 324
 325 static int parse_update_recurse(const char *opt, const char *arg,
 326                                 int die_on_error)
 327 {
 328         switch (git_parse_maybe_bool(arg)) {
 329         case 1:
 330                 return RECURSE_SUBMODULES_ON;
 331         case 0:
 332                 return RECURSE_SUBMODULES_OFF;
 333         default:
 334                 if (die_on_error)
 335                         die("bad %s argument: %s", opt, arg);
 336                 return RECURSE_SUBMODULES_ERROR;
 337         }
 338 }
 339
 340 int parse_update_recurse_submodules_arg(const char *opt, const char *arg)
 341 {
 342         return parse_update_recurse(opt, arg, 1);
 343 }
 344
 345 static int parse_push_recurse(const char *opt, const char *arg,
 346                                int die_on_error)
 347 {
 348         switch (git_parse_maybe_bool(arg)) {
 349         case 1:
 350                 /* There's no simple "on" value when pushing */
 351                 if (die_on_error)
 352                         die("bad %s argument: %s", opt, arg);
 353                 else
 354                         return RECURSE_SUBMODULES_ERROR;
 355         case 0:
 356                 return RECURSE_SUBMODULES_OFF;
 357         default:
 358                 if (!strcmp(arg, "on-demand"))
 359                         return RECURSE_SUBMODULES_ON_DEMAND;
 360                 else if (!strcmp(arg, "check"))
 361                         return RECURSE_SUBMODULES_CHECK;
 362                 else if (!strcmp(arg, "only"))
 363                         return RECURSE_SUBMODULES_ONLY;
 364                 else if (die_on_error)
 365                         die("bad %s argument: %s", opt, arg);
 366                 else
 367                         return RECURSE_SUBMODULES_ERROR;
 368         }
 369 }
 370
 371 int parse_push_recurse_submodules_arg(const char *opt, const char *arg)
 372 {
 373         return parse_push_recurse(opt, arg, 1);
 374 }
 375
 376 static void warn_multiple_config(const struct object_id *treeish_name,
 377                                  const char *name, const char *option)
 378 {
 379         const char *commit_string = "WORKTREE";
 380         if (treeish_name)
 381                 commit_string = oid_to_hex(treeish_name);
 382         warning("%s:.gitmodules, multiple configurations found for "
 383                         "'submodule.%s.%s'. Skipping second one!",
 384                         commit_string, name, option);
 385 }
 386
 387 struct parse_config_parameter {
 388         struct submodule_cache *cache;
 389         const struct object_id *treeish_name;
 390         const struct object_id *gitmodules_oid;
 391         int overwrite;
 392 };
 393
 394 static int parse_config(const char *var, const char *value, void *data)
 395 {
 396         struct parse_config_parameter *me = data;
 397         struct submodule *submodule;
 398         struct strbuf name = STRBUF_INIT, item = STRBUF_INIT;
 399         int ret = 0;
 400
 401         /* this also ensures that we only parse submodule entries */
 402         if (!name_and_item_from_var(var, &name, &item))
 403                 return 0;
 404
 405         submodule = lookup_or_create_by_name(me->cache,
 406                                              me->gitmodules_oid,
 407                                              name.buf);
 408
 409         if (!strcmp(item.buf, "path")) {
 410                 if (!value)
 411                         ret = config_error_nonbool(var);
 412                 else if (!me->overwrite && submodule->path)
 413                         warn_multiple_config(me->treeish_name, submodule->name,
 414                                         "path");
 415                 else {
 416                         if (submodule->path)
 417                                 cache_remove_path(me->cache, submodule);
 418                         free((void *) submodule->path);
 419                         submodule->path = xstrdup(value);
 420                         cache_put_path(me->cache, submodule);
 421                 }
 422         } else if (!strcmp(item.buf, "fetchrecursesubmodules")) {
 423                 /* when parsing worktree configurations we can die early */
 424                 int die_on_error = is_null_oid(me->gitmodules_oid);
 425                 if (!me->overwrite &&
 426                     submodule->fetch_recurse != RECURSE_SUBMODULES_NONE)
 427                         warn_multiple_config(me->treeish_name, submodule->name,
 428                                         "fetchrecursesubmodules");
 429                 else
 430                         submodule->fetch_recurse = parse_fetch_recurse(
 431                                                                 var, value,
 432                                                                 die_on_error);
 433         } else if (!strcmp(item.buf, "ignore")) {
 434                 if (!value)
 435                         ret = config_error_nonbool(var);
 436                 else if (!me->overwrite && submodule->ignore)
 437                         warn_multiple_config(me->treeish_name, submodule->name,
 438                                         "ignore");
 439                 else if (strcmp(value, "untracked") &&
 440                          strcmp(value, "dirty") &&
 441                          strcmp(value, "all") &&
 442                          strcmp(value, "none"))
 443                         warning("Invalid parameter '%s' for config option "
 444                                         "'submodule.%s.ignore'", value, name.buf);
 445                 else {
 446                         free((void *) submodule->ignore);
 447                         submodule->ignore = xstrdup(value);
 448                 }
 449         } else if (!strcmp(item.buf, "url")) {
 450                 if (!value) {
 451                         ret = config_error_nonbool(var);
 452                 } else if (!me->overwrite && submodule->url) {
 453                         warn_multiple_config(me->treeish_name, submodule->name,
 454                                         "url");
 455                 } else {
 456                         free((void *) submodule->url);
 457                         submodule->url = xstrdup(value);
 458                 }
 459         } else if (!strcmp(item.buf, "update")) {
 460                 if (!value)
 461                         ret = config_error_nonbool(var);
 462                 else if (!me->overwrite &&
 463                          submodule->update_strategy.type != SM_UPDATE_UNSPECIFIED)
 464                         warn_multiple_config(me->treeish_name, submodule->name,
 465                                              "update");
 466                 else if (parse_submodule_update_strategy(value,
 467                          &submodule->update_strategy) < 0)
 468                                 die(_("invalid value for %s"), var);
 469         } else if (!strcmp(item.buf, "shallow")) {
 470                 if (!me->overwrite && submodule->recommend_shallow != -1)
 471                         warn_multiple_config(me->treeish_name, submodule->name,
 472                                              "shallow");
 473                 else
 474                         submodule->recommend_shallow =
 475                                 git_config_bool(var, value);
 476         } else if (!strcmp(item.buf, "branch")) {
 477                 if (!me->overwrite && submodule->branch)
 478                         warn_multiple_config(me->treeish_name, submodule->name,
 479                                              "branch");
 480                 else {
 481                         free((void *)submodule->branch);
 482                         submodule->branch = xstrdup(value);
 483                 }
 484         }
 485
 486         strbuf_release(&name);
 487         strbuf_release(&item);
 488
 489         return ret;
 490 }
 491
 492 static int gitmodule_oid_from_commit(const struct object_id *treeish_name,
 493                                      struct object_id *gitmodules_oid,
 494                                      struct strbuf *rev)
 495 {
 496         int ret = 0;
 497
 498         if (is_null_oid(treeish_name)) {
 499                 oidclr(gitmodules_oid);
 500                 return 1;
 501         }
 502
 503         strbuf_addf(rev, "%s:.gitmodules", oid_to_hex(treeish_name));
 504         if (get_oid(rev->buf, gitmodules_oid) >= 0)
 505                 ret = 1;
 506
 507         return ret;
 508 }
 509
 510 /* This does a lookup of a submodule configuration by name or by path
 511  * (key) with on-demand reading of the appropriate .gitmodules from
 512  * revisions.
 513  */
 514 static const struct submodule *config_from(struct submodule_cache *cache,
 515                 const struct object_id *treeish_name, const char *key,
 516                 enum lookup_type lookup_type)
 517 {
 518         struct strbuf rev = STRBUF_INIT;
 519         unsigned long config_size;
 520         char *config = NULL;
 521         struct object_id oid;
 522         enum object_type type;
 523         const struct submodule *submodule = NULL;
 524         struct parse_config_parameter parameter;
 525
 526         /*
 527          * If any parameter except the cache is a NULL pointer just
 528          * return the first submodule. Can be used to check whether
 529          * there are any submodules parsed.
 530          */
 531         if (!treeish_name || !key) {
 532                 struct hashmap_iter iter;
 533                 struct submodule_entry *entry;
 534
 535                 entry = hashmap_iter_first(&cache->for_name, &iter);
 536                 if (!entry)
 537                         return NULL;
 538                 return entry->config;
 539         }
 540
 541         if (!gitmodule_oid_from_commit(treeish_name, &oid, &rev))
 542                 goto out;
 543
 544         switch (lookup_type) {
 545         case lookup_name:
 546                 submodule = cache_lookup_name(cache, &oid, key);
 547                 break;
 548         case lookup_path:
 549                 submodule = cache_lookup_path(cache, &oid, key);
 550                 break;
 551         }
 552         if (submodule)
 553                 goto out;
 554
 555         config = read_object_file(&oid, &type, &config_size);
 556         if (!config || type != OBJ_BLOB)
 557                 goto out;
 558
 559         /* fill the submodule config into the cache */
 560         parameter.cache = cache;
 561         parameter.treeish_name = treeish_name;
 562         parameter.gitmodules_oid = &oid;
 563         parameter.overwrite = 0;
 564         git_config_from_mem(parse_config, CONFIG_ORIGIN_SUBMODULE_BLOB, rev.buf,
 565                         config, config_size, &parameter);
 566         strbuf_release(&rev);
 567         free(config);
 568
 569         switch (lookup_type) {
 570         case lookup_name:
 571                 return cache_lookup_name(cache, &oid, key);
 572         case lookup_path:
 573                 return cache_lookup_path(cache, &oid, key);
 574         default:
 575                 return NULL;
 576         }
 577
 578 out:
 579         strbuf_release(&rev);
 580         free(config);
 581         return submodule;
 582 }
 583
 584 static void submodule_cache_check_init(struct repository *repo)
 585 {
 586         if (repo->submodule_cache && repo->submodule_cache->initialized)
 587                 return;
 588
 589         if (!repo->submodule_cache)
 590                 repo->submodule_cache = submodule_cache_alloc();
 591
 592         submodule_cache_init(repo->submodule_cache);
 593 }
 594
 595 static int gitmodules_cb(const char *var, const char *value, void *data)
 596 {
 597         struct repository *repo = data;
 598         struct parse_config_parameter parameter;
 599
 600         parameter.cache = repo->submodule_cache;
 601         parameter.treeish_name = NULL;
 602         parameter.gitmodules_oid = &null_oid;
 603         parameter.overwrite = 1;
 604
 605         return parse_config(var, value, &parameter);
 606 }
 607
 608 void repo_read_gitmodules(struct repository *repo)
 609 {
 610         submodule_cache_check_init(repo);
 611
 612         if (repo->worktree) {
 613                 char *gitmodules;
 614
 615                 if (repo_read_index(repo) < 0)
 616                         return;
 617
 618                 gitmodules = repo_worktree_path(repo, GITMODULES_FILE);
 619
 620                 if (!is_gitmodules_unmerged(repo->index))
 621                         git_config_from_file(gitmodules_cb, gitmodules, repo);
 622
 623                 free(gitmodules);
 624         }
 625
 626         repo->submodule_cache->gitmodules_read = 1;
 627 }
 628
 629 void gitmodules_config_oid(const struct object_id *commit_oid)
 630 {
 631         struct strbuf rev = STRBUF_INIT;
 632         struct object_id oid;
 633
 634         submodule_cache_check_init(the_repository);
 635
 636         if (gitmodule_oid_from_commit(commit_oid, &oid, &rev)) {
 637                 git_config_from_blob_oid(gitmodules_cb, rev.buf,
 638                                          &oid, the_repository);
 639         }
 640         strbuf_release(&rev);
 641
 642         the_repository->submodule_cache->gitmodules_read = 1;
 643 }
 644
 645 static void gitmodules_read_check(struct repository *repo)
 646 {
 647         submodule_cache_check_init(repo);
 648
 649         /* read the repo's .gitmodules file if it hasn't been already */
 650         if (!repo->submodule_cache->gitmodules_read)
 651                 repo_read_gitmodules(repo);
 652 }
 653
 654 const struct submodule *submodule_from_name(struct repository *r,
 655                                             const struct object_id *treeish_name,
 656                 const char *name)
 657 {
 658         gitmodules_read_check(r);
 659         return config_from(r->submodule_cache, treeish_name, name, lookup_name);
 660 }
 661
 662 const struct submodule *submodule_from_path(struct repository *r,
 663                                             const struct object_id *treeish_name,
 664                 const char *path)
 665 {
 666         gitmodules_read_check(r);
 667         return config_from(r->submodule_cache, treeish_name, path, lookup_path);
 668 }
 669
 670 void submodule_free(struct repository *r)
 671 {
 672         if (r->submodule_cache)
 673                 submodule_cache_clear(r->submodule_cache);
 674 }