]> git.ipfire.org Git - thirdparty/git.git/commitdiff
config: pass ctx with config files
authorGlen Choo <chooglen@google.com>
Wed, 28 Jun 2023 19:26:24 +0000 (19:26 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 28 Jun 2023 21:06:39 +0000 (14:06 -0700)
Pass config_context to config_callbacks when parsing config files. To
provide the .kvi member, refactor out the configset logic that caches
"struct config_source" and "enum config_scope" as a "struct
key_value_info". Make the "enum config_scope" available to the config
file machinery by plumbing an additional arg through
git_config_from_file_with_options().

We do not exercise ctx yet because the remaining current_config_*()
callers may be used with config_with_options(), which may read config
from parameters, but parameters don't pass ctx yet.

Signed-off-by: Glen Choo <chooglen@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
bundle-uri.c
config.c
config.h
fsck.c
submodule-config.c

index 0d5acc3dc51698987ac8cf70b63d2e1dd50c9ae8..64f3238774555f8c6b4ee301da76fe1178605286 100644 (file)
@@ -255,6 +255,7 @@ int bundle_uri_parse_config_format(const char *uri,
        }
        result = git_config_from_file_with_options(config_to_bundle_list,
                                                   filename, list,
+                                                  CONFIG_SCOPE_UNKNOWN,
                                                   &opts);
 
        if (!result && list->mode == BUNDLE_MODE_NONE) {
index 662d406ac1eca1f1a7fc446f57cc15e964ae9048..31718711827233bfba37d25f4406b7b93206eacf 100644 (file)
--- a/config.c
+++ b/config.c
@@ -259,7 +259,9 @@ static int handle_path_include(struct config_source *cs, const char *path,
                            !cs ? "<unknown>" :
                            cs->name ? cs->name :
                            "the command line");
-               ret = git_config_from_file(git_config_include, path, inc);
+               ret = git_config_from_file_with_options(git_config_include, path, inc,
+                                                       current_config_scope(),
+                                                       NULL);
                inc->depth--;
        }
 cleanup:
@@ -503,7 +505,7 @@ static int git_config_include(const char *var, const char *value,
         * Pass along all values, including "include" directives; this makes it
         * possible to query information on the includes themselves.
         */
-       ret = inc->fn(var, value, NULL, inc->data);
+       ret = inc->fn(var, value, ctx, inc->data);
        if (ret < 0)
                return ret;
 
@@ -939,12 +941,15 @@ static char *parse_value(struct config_source *cs)
        }
 }
 
-static int get_value(struct config_source *cs, config_fn_t fn, void *data,
-                    struct strbuf *name)
+static int get_value(struct config_source *cs, struct key_value_info *kvi,
+                    config_fn_t fn, void *data, struct strbuf *name)
 {
        int c;
        char *value;
        int ret;
+       struct config_context ctx = {
+               .kvi = kvi,
+       };
 
        /* Get the full name */
        for (;;) {
@@ -973,7 +978,8 @@ static int get_value(struct config_source *cs, config_fn_t fn, void *data,
         * accurate line number in error messages.
         */
        cs->linenr--;
-       ret = fn(name->buf, value, NULL, data);
+       kvi->linenr = cs->linenr;
+       ret = fn(name->buf, value, &ctx, data);
        if (ret >= 0)
                cs->linenr++;
        return ret;
@@ -1072,8 +1078,19 @@ static int do_event(struct config_source *cs, enum config_event_t type,
        return 0;
 }
 
+static void kvi_from_source(struct config_source *cs,
+                           enum config_scope scope,
+                           struct key_value_info *out)
+{
+       out->filename = strintern(cs->name);
+       out->origin_type = cs->origin_type;
+       out->linenr = cs->linenr;
+       out->scope = scope;
+}
+
 static int git_parse_source(struct config_source *cs, config_fn_t fn,
-                           void *data, const struct config_options *opts)
+                           struct key_value_info *kvi, void *data,
+                           const struct config_options *opts)
 {
        int comment = 0;
        size_t baselen = 0;
@@ -1157,7 +1174,7 @@ static int git_parse_source(struct config_source *cs, config_fn_t fn,
                 */
                strbuf_setlen(var, baselen);
                strbuf_addch(var, tolower(c));
-               if (get_value(cs, fn, data, var) < 0)
+               if (get_value(cs, kvi, fn, data, var) < 0)
                        break;
        }
 
@@ -2010,9 +2027,11 @@ int git_default_config(const char *var, const char *value,
  * this function.
  */
 static int do_config_from(struct config_reader *reader,
-                         struct config_source *top, config_fn_t fn, void *data,
+                         struct config_source *top, config_fn_t fn,
+                         void *data, enum config_scope scope,
                          const struct config_options *opts)
 {
+       struct key_value_info kvi = KVI_INIT;
        int ret;
 
        /* push config-file parsing state stack */
@@ -2022,8 +2041,9 @@ static int do_config_from(struct config_reader *reader,
        strbuf_init(&top->value, 1024);
        strbuf_init(&top->var, 1024);
        config_reader_push_source(reader, top);
+       kvi_from_source(top, scope, &kvi);
 
-       ret = git_parse_source(top, fn, data, opts);
+       ret = git_parse_source(top, fn, &kvi, data, opts);
 
        /* pop config-file parsing state stack */
        strbuf_release(&top->value);
@@ -2037,7 +2057,8 @@ static int do_config_from_file(struct config_reader *reader,
                               config_fn_t fn,
                               const enum config_origin_type origin_type,
                               const char *name, const char *path, FILE *f,
-                              void *data, const struct config_options *opts)
+                              void *data, enum config_scope scope,
+                              const struct config_options *opts)
 {
        struct config_source top = CONFIG_SOURCE_INIT;
        int ret;
@@ -2052,19 +2073,20 @@ static int do_config_from_file(struct config_reader *reader,
        top.do_ftell = config_file_ftell;
 
        flockfile(f);
-       ret = do_config_from(reader, &top, fn, data, opts);
+       ret = do_config_from(reader, &top, fn, data, scope, opts);
        funlockfile(f);
        return ret;
 }
 
-static int git_config_from_stdin(config_fn_t fn, void *data)
+static int git_config_from_stdin(config_fn_t fn, void *data,
+                                enum config_scope scope)
 {
        return do_config_from_file(&the_reader, fn, CONFIG_ORIGIN_STDIN, "",
-                                  NULL, stdin, data, NULL);
+                                  NULL, stdin, data, scope, NULL);
 }
 
 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
-                                     void *data,
+                                     void *data, enum config_scope scope,
                                      const struct config_options *opts)
 {
        int ret = -1;
@@ -2075,7 +2097,8 @@ int git_config_from_file_with_options(config_fn_t fn, const char *filename,
        f = fopen_or_warn(filename, "r");
        if (f) {
                ret = do_config_from_file(&the_reader, fn, CONFIG_ORIGIN_FILE,
-                                         filename, filename, f, data, opts);
+                                         filename, filename, f, data, scope,
+                                         opts);
                fclose(f);
        }
        return ret;
@@ -2083,13 +2106,15 @@ int git_config_from_file_with_options(config_fn_t fn, const char *filename,
 
 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
 {
-       return git_config_from_file_with_options(fn, filename, data, NULL);
+       return git_config_from_file_with_options(fn, filename, data,
+                                                CONFIG_SCOPE_UNKNOWN, NULL);
 }
 
 int git_config_from_mem(config_fn_t fn,
                        const enum config_origin_type origin_type,
                        const char *name, const char *buf, size_t len,
-                       void *data, const struct config_options *opts)
+                       void *data, enum config_scope scope,
+                       const struct config_options *opts)
 {
        struct config_source top = CONFIG_SOURCE_INIT;
 
@@ -2104,14 +2129,15 @@ int git_config_from_mem(config_fn_t fn,
        top.do_ungetc = config_buf_ungetc;
        top.do_ftell = config_buf_ftell;
 
-       return do_config_from(&the_reader, &top, fn, data, opts);
+       return do_config_from(&the_reader, &top, fn, data, scope, opts);
 }
 
 int git_config_from_blob_oid(config_fn_t fn,
                              const char *name,
                              struct repository *repo,
                              const struct object_id *oid,
-                             void *data)
+                             void *data,
+                             enum config_scope scope)
 {
        enum object_type type;
        char *buf;
@@ -2127,7 +2153,7 @@ int git_config_from_blob_oid(config_fn_t fn,
        }
 
        ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
-                                 data, NULL);
+                                 data, scope, NULL);
        free(buf);
 
        return ret;
@@ -2136,13 +2162,14 @@ int git_config_from_blob_oid(config_fn_t fn,
 static int git_config_from_blob_ref(config_fn_t fn,
                                    struct repository *repo,
                                    const char *name,
-                                   void *data)
+                                   void *data,
+                                   enum config_scope scope)
 {
        struct object_id oid;
 
        if (repo_get_oid(repo, name, &oid) < 0)
                return error(_("unable to resolve config blob '%s'"), name);
-       return git_config_from_blob_oid(fn, name, repo, &oid, data);
+       return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
 }
 
 char *git_system_config(void)
@@ -2228,27 +2255,34 @@ static int do_git_config_sequence(struct config_reader *reader,
        if (git_config_system() && system_config &&
            !access_or_die(system_config, R_OK,
                           opts->system_gently ? ACCESS_EACCES_OK : 0))
-               ret += git_config_from_file(fn, system_config, data);
+               ret += git_config_from_file_with_options(fn, system_config,
+                                                        data, CONFIG_SCOPE_SYSTEM,
+                                                        NULL);
 
        config_reader_set_scope(reader, CONFIG_SCOPE_GLOBAL);
        git_global_config(&user_config, &xdg_config);
 
        if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
-               ret += git_config_from_file(fn, xdg_config, data);
+               ret += git_config_from_file_with_options(fn, xdg_config, data,
+                                                        CONFIG_SCOPE_GLOBAL, NULL);
 
        if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
-               ret += git_config_from_file(fn, user_config, data);
+               ret += git_config_from_file_with_options(fn, user_config, data,
+                                                        CONFIG_SCOPE_GLOBAL, NULL);
 
        config_reader_set_scope(reader, CONFIG_SCOPE_LOCAL);
        if (!opts->ignore_repo && repo_config &&
            !access_or_die(repo_config, R_OK, 0))
-               ret += git_config_from_file(fn, repo_config, data);
+               ret += git_config_from_file_with_options(fn, repo_config, data,
+                                                        CONFIG_SCOPE_LOCAL, NULL);
 
        config_reader_set_scope(reader, CONFIG_SCOPE_WORKTREE);
        if (!opts->ignore_worktree && worktree_config &&
            repo && repo->repository_format_worktree_config &&
            !access_or_die(worktree_config, R_OK, 0)) {
-               ret += git_config_from_file(fn, worktree_config, data);
+                       ret += git_config_from_file_with_options(fn, worktree_config, data,
+                                                                CONFIG_SCOPE_WORKTREE,
+                                                                NULL);
        }
 
        config_reader_set_scope(reader, CONFIG_SCOPE_COMMAND);
@@ -2292,12 +2326,14 @@ int config_with_options(config_fn_t fn, void *data,
         * regular lookup sequence.
         */
        if (config_source && config_source->use_stdin) {
-               ret = git_config_from_stdin(fn, data);
+               ret = git_config_from_stdin(fn, data, config_source->scope);
        } else if (config_source && config_source->file) {
-               ret = git_config_from_file(fn, config_source->file, data);
+               ret = git_config_from_file_with_options(fn, config_source->file,
+                                                       data, config_source->scope,
+                                                       NULL);
        } else if (config_source && config_source->blob) {
                ret = git_config_from_blob_ref(fn, repo, config_source->blob,
-                                               data);
+                                              data, config_source->scope);
        } else {
                ret = do_git_config_sequence(&the_reader, opts, repo, fn, data);
        }
@@ -2440,16 +2476,14 @@ static int configset_add_value(struct config_reader *reader,
        if (!reader->source)
                BUG("configset_add_value has no source");
        if (reader->source->name) {
-               kv_info->filename = strintern(reader->source->name);
-               kv_info->linenr = reader->source->linenr;
-               kv_info->origin_type = reader->source->origin_type;
+               kvi_from_source(reader->source, current_config_scope(), kv_info);
        } else {
                /* for values read from `git_config_from_parameters()` */
                kv_info->filename = NULL;
                kv_info->linenr = -1;
                kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
+               kv_info->scope = reader->parsing_scope;
        }
-       kv_info->scope = reader->parsing_scope;
        si->util = kv_info;
 
        return 0;
@@ -3490,7 +3524,8 @@ int git_config_set_multivar_in_file_gently(const char *config_filename,
                 */
                if (git_config_from_file_with_options(store_aux,
                                                      config_filename,
-                                                     &store, &opts)) {
+                                                     &store, CONFIG_SCOPE_UNKNOWN,
+                                                     &opts)) {
                        error(_("invalid config file %s"), config_filename);
                        ret = CONFIG_INVALID_FILE;
                        goto out_free;
index ddf147bb2d15f157e92036ecfcdfd75da64eea89..206bf1f175ad30ab0890699ebb4156e43b20b46b 100644 (file)
--- a/config.h
+++ b/config.h
@@ -169,16 +169,18 @@ int git_default_config(const char *, const char *,
 int git_config_from_file(config_fn_t fn, const char *, void *);
 
 int git_config_from_file_with_options(config_fn_t fn, const char *,
-                                     void *,
+                                     void *, enum config_scope,
                                      const struct config_options *);
 int git_config_from_mem(config_fn_t fn,
                        const enum config_origin_type,
                        const char *name,
                        const char *buf, size_t len,
-                       void *data, const struct config_options *opts);
+                       void *data, enum config_scope scope,
+                       const struct config_options *opts);
 int git_config_from_blob_oid(config_fn_t fn, const char *name,
                             struct repository *repo,
-                            const struct object_id *oid, void *data);
+                            const struct object_id *oid, void *data,
+                            enum config_scope scope);
 void git_config_push_parameter(const char *text);
 void git_config_push_env(const char *spec);
 int git_config_from_parameters(config_fn_t fn, void *data);
diff --git a/fsck.c b/fsck.c
index 55b6a694853ce6ce5f5065107c78e0fd28715541..f92c216fb5c7b58c74f9590c308ebdd7951ead28 100644 (file)
--- a/fsck.c
+++ b/fsck.c
@@ -1238,7 +1238,8 @@ static int fsck_blob(const struct object_id *oid, const char *buf,
                data.ret = 0;
                config_opts.error_action = CONFIG_ERROR_SILENT;
                if (git_config_from_mem(fsck_gitmodules_fn, CONFIG_ORIGIN_BLOB,
-                                       ".gitmodules", buf, size, &data, &config_opts))
+                                       ".gitmodules", buf, size, &data,
+                                       CONFIG_SCOPE_UNKNOWN, &config_opts))
                        data.ret |= report(options, oid, OBJ_BLOB,
                                        FSCK_MSG_GITMODULES_PARSE,
                                        "could not parse gitmodules blob");
index a38d4d497314f0e42c66f3cf1066c0f6c9523488..3f25bd1367407e0275c21550897bf3603d016d4f 100644 (file)
@@ -606,7 +606,7 @@ static const struct submodule *config_from(struct submodule_cache *cache,
        parameter.gitmodules_oid = &oid;
        parameter.overwrite = 0;
        git_config_from_mem(parse_config, CONFIG_ORIGIN_SUBMODULE_BLOB, rev.buf,
-                       config, config_size, &parameter, NULL);
+                           config, config_size, &parameter, CONFIG_SCOPE_UNKNOWN, NULL);
        strbuf_release(&rev);
        free(config);
 
@@ -714,7 +714,8 @@ void gitmodules_config_oid(const struct object_id *commit_oid)
 
        if (gitmodule_oid_from_commit(commit_oid, &oid, &rev)) {
                git_config_from_blob_oid(gitmodules_cb, rev.buf,
-                                        the_repository, &oid, the_repository);
+                                        the_repository, &oid, the_repository,
+                                        CONFIG_SCOPE_UNKNOWN);
        }
        strbuf_release(&rev);