Sync with 2.42.2
[git.git] / config.c
blobe1f8436395d916be3ec0ac36a407398cbcc483d9
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "git-compat-util.h"
9 #include "abspath.h"
10 #include "advice.h"
11 #include "date.h"
12 #include "branch.h"
13 #include "config.h"
14 #include "parse.h"
15 #include "convert.h"
16 #include "environment.h"
17 #include "gettext.h"
18 #include "ident.h"
19 #include "repository.h"
20 #include "lockfile.h"
21 #include "mailmap.h"
22 #include "attr.h"
23 #include "exec-cmd.h"
24 #include "strbuf.h"
25 #include "quote.h"
26 #include "hashmap.h"
27 #include "string-list.h"
28 #include "object-name.h"
29 #include "object-store-ll.h"
30 #include "pager.h"
31 #include "path.h"
32 #include "utf8.h"
33 #include "color.h"
34 #include "refs.h"
35 #include "setup.h"
36 #include "strvec.h"
37 #include "trace2.h"
38 #include "wildmatch.h"
39 #include "ws.h"
40 #include "write-or-die.h"
42 struct config_source {
43 struct config_source *prev;
44 union {
45 FILE *file;
46 struct config_buf {
47 const char *buf;
48 size_t len;
49 size_t pos;
50 } buf;
51 } u;
52 enum config_origin_type origin_type;
53 const char *name;
54 const char *path;
55 enum config_error_action default_error_action;
56 int linenr;
57 int eof;
58 size_t total_len;
59 struct strbuf value;
60 struct strbuf var;
61 unsigned subsection_case_sensitive : 1;
63 int (*do_fgetc)(struct config_source *c);
64 int (*do_ungetc)(int c, struct config_source *conf);
65 long (*do_ftell)(struct config_source *c);
67 #define CONFIG_SOURCE_INIT { 0 }
69 static int pack_compression_seen;
70 static int zlib_compression_seen;
73 * Config that comes from trusted scopes, namely:
74 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
75 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
76 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
78 * This is declared here for code cleanliness, but unlike the other
79 * static variables, this does not hold config parser state.
81 static struct config_set protected_config;
83 static int config_file_fgetc(struct config_source *conf)
85 return getc_unlocked(conf->u.file);
88 static int config_file_ungetc(int c, struct config_source *conf)
90 return ungetc(c, conf->u.file);
93 static long config_file_ftell(struct config_source *conf)
95 return ftell(conf->u.file);
99 static int config_buf_fgetc(struct config_source *conf)
101 if (conf->u.buf.pos < conf->u.buf.len)
102 return conf->u.buf.buf[conf->u.buf.pos++];
104 return EOF;
107 static int config_buf_ungetc(int c, struct config_source *conf)
109 if (conf->u.buf.pos > 0) {
110 conf->u.buf.pos--;
111 if (conf->u.buf.buf[conf->u.buf.pos] != c)
112 BUG("config_buf can only ungetc the same character");
113 return c;
116 return EOF;
119 static long config_buf_ftell(struct config_source *conf)
121 return conf->u.buf.pos;
124 struct config_include_data {
125 int depth;
126 config_fn_t fn;
127 void *data;
128 const struct config_options *opts;
129 struct git_config_source *config_source;
130 struct repository *repo;
133 * All remote URLs discovered when reading all config files.
135 struct string_list *remote_urls;
137 #define CONFIG_INCLUDE_INIT { 0 }
139 static int git_config_include(const char *var, const char *value,
140 const struct config_context *ctx, void *data);
142 #define MAX_INCLUDE_DEPTH 10
143 static const char include_depth_advice[] = N_(
144 "exceeded maximum include depth (%d) while including\n"
145 " %s\n"
146 "from\n"
147 " %s\n"
148 "This might be due to circular includes.");
149 static int handle_path_include(const struct key_value_info *kvi,
150 const char *path,
151 struct config_include_data *inc)
153 int ret = 0;
154 struct strbuf buf = STRBUF_INIT;
155 char *expanded;
157 if (!path)
158 return config_error_nonbool("include.path");
160 expanded = interpolate_path(path, 0);
161 if (!expanded)
162 return error(_("could not expand include path '%s'"), path);
163 path = expanded;
166 * Use an absolute path as-is, but interpret relative paths
167 * based on the including config file.
169 if (!is_absolute_path(path)) {
170 char *slash;
172 if (!kvi || !kvi->path) {
173 ret = error(_("relative config includes must come from files"));
174 goto cleanup;
177 slash = find_last_dir_sep(kvi->path);
178 if (slash)
179 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
180 strbuf_addstr(&buf, path);
181 path = buf.buf;
184 if (!access_or_die(path, R_OK, 0)) {
185 if (++inc->depth > MAX_INCLUDE_DEPTH)
186 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
187 !kvi ? "<unknown>" :
188 kvi->filename ? kvi->filename :
189 "the command line");
190 ret = git_config_from_file_with_options(git_config_include, path, inc,
191 kvi->scope, NULL);
192 inc->depth--;
194 cleanup:
195 strbuf_release(&buf);
196 free(expanded);
197 return ret;
200 static void add_trailing_starstar_for_dir(struct strbuf *pat)
202 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
203 strbuf_addstr(pat, "**");
206 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
207 struct strbuf *pat)
209 struct strbuf path = STRBUF_INIT;
210 char *expanded;
211 int prefix = 0;
213 expanded = interpolate_path(pat->buf, 1);
214 if (expanded) {
215 strbuf_reset(pat);
216 strbuf_addstr(pat, expanded);
217 free(expanded);
220 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
221 const char *slash;
223 if (!kvi || !kvi->path)
224 return error(_("relative config include "
225 "conditionals must come from files"));
227 strbuf_realpath(&path, kvi->path, 1);
228 slash = find_last_dir_sep(path.buf);
229 if (!slash)
230 BUG("how is this possible?");
231 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
232 prefix = slash - path.buf + 1 /* slash */;
233 } else if (!is_absolute_path(pat->buf))
234 strbuf_insertstr(pat, 0, "**/");
236 add_trailing_starstar_for_dir(pat);
238 strbuf_release(&path);
239 return prefix;
242 static int include_by_gitdir(const struct key_value_info *kvi,
243 const struct config_options *opts,
244 const char *cond, size_t cond_len, int icase)
246 struct strbuf text = STRBUF_INIT;
247 struct strbuf pattern = STRBUF_INIT;
248 int ret = 0, prefix;
249 const char *git_dir;
250 int already_tried_absolute = 0;
252 if (opts->git_dir)
253 git_dir = opts->git_dir;
254 else
255 goto done;
257 strbuf_realpath(&text, git_dir, 1);
258 strbuf_add(&pattern, cond, cond_len);
259 prefix = prepare_include_condition_pattern(kvi, &pattern);
261 again:
262 if (prefix < 0)
263 goto done;
265 if (prefix > 0) {
267 * perform literal matching on the prefix part so that
268 * any wildcard character in it can't create side effects.
270 if (text.len < prefix)
271 goto done;
272 if (!icase && strncmp(pattern.buf, text.buf, prefix))
273 goto done;
274 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
275 goto done;
278 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
279 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
281 if (!ret && !already_tried_absolute) {
283 * We've tried e.g. matching gitdir:~/work, but if
284 * ~/work is a symlink to /mnt/storage/work
285 * strbuf_realpath() will expand it, so the rule won't
286 * match. Let's match against a
287 * strbuf_add_absolute_path() version of the path,
288 * which'll do the right thing
290 strbuf_reset(&text);
291 strbuf_add_absolute_path(&text, git_dir);
292 already_tried_absolute = 1;
293 goto again;
295 done:
296 strbuf_release(&pattern);
297 strbuf_release(&text);
298 return ret;
301 static int include_by_branch(const char *cond, size_t cond_len)
303 int flags;
304 int ret;
305 struct strbuf pattern = STRBUF_INIT;
306 const char *refname = !the_repository->gitdir ?
307 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
308 const char *shortname;
310 if (!refname || !(flags & REF_ISSYMREF) ||
311 !skip_prefix(refname, "refs/heads/", &shortname))
312 return 0;
314 strbuf_add(&pattern, cond, cond_len);
315 add_trailing_starstar_for_dir(&pattern);
316 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
317 strbuf_release(&pattern);
318 return ret;
321 static int add_remote_url(const char *var, const char *value,
322 const struct config_context *ctx UNUSED, void *data)
324 struct string_list *remote_urls = data;
325 const char *remote_name;
326 size_t remote_name_len;
327 const char *key;
329 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
330 &key) &&
331 remote_name &&
332 !strcmp(key, "url"))
333 string_list_append(remote_urls, value);
334 return 0;
337 static void populate_remote_urls(struct config_include_data *inc)
339 struct config_options opts;
341 opts = *inc->opts;
342 opts.unconditional_remote_url = 1;
344 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
345 string_list_init_dup(inc->remote_urls);
346 config_with_options(add_remote_url, inc->remote_urls,
347 inc->config_source, inc->repo, &opts);
350 static int forbid_remote_url(const char *var, const char *value UNUSED,
351 const struct config_context *ctx UNUSED,
352 void *data UNUSED)
354 const char *remote_name;
355 size_t remote_name_len;
356 const char *key;
358 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
359 &key) &&
360 remote_name &&
361 !strcmp(key, "url"))
362 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
363 return 0;
366 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
367 struct string_list *remote_urls)
369 struct strbuf pattern = STRBUF_INIT;
370 struct string_list_item *url_item;
371 int found = 0;
373 strbuf_add(&pattern, glob, glob_len);
374 for_each_string_list_item(url_item, remote_urls) {
375 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
376 found = 1;
377 break;
380 strbuf_release(&pattern);
381 return found;
384 static int include_by_remote_url(struct config_include_data *inc,
385 const char *cond, size_t cond_len)
387 if (inc->opts->unconditional_remote_url)
388 return 1;
389 if (!inc->remote_urls)
390 populate_remote_urls(inc);
391 return at_least_one_url_matches_glob(cond, cond_len,
392 inc->remote_urls);
395 static int include_condition_is_true(const struct key_value_info *kvi,
396 struct config_include_data *inc,
397 const char *cond, size_t cond_len)
399 const struct config_options *opts = inc->opts;
401 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
402 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
403 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
404 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
405 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
406 return include_by_branch(cond, cond_len);
407 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
408 &cond_len))
409 return include_by_remote_url(inc, cond, cond_len);
411 /* unknown conditionals are always false */
412 return 0;
415 static int git_config_include(const char *var, const char *value,
416 const struct config_context *ctx,
417 void *data)
419 struct config_include_data *inc = data;
420 const char *cond, *key;
421 size_t cond_len;
422 int ret;
425 * Pass along all values, including "include" directives; this makes it
426 * possible to query information on the includes themselves.
428 ret = inc->fn(var, value, ctx, inc->data);
429 if (ret < 0)
430 return ret;
432 if (!strcmp(var, "include.path"))
433 ret = handle_path_include(ctx->kvi, value, inc);
435 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
436 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
437 !strcmp(key, "path")) {
438 config_fn_t old_fn = inc->fn;
440 if (inc->opts->unconditional_remote_url)
441 inc->fn = forbid_remote_url;
442 ret = handle_path_include(ctx->kvi, value, inc);
443 inc->fn = old_fn;
446 return ret;
449 static void git_config_push_split_parameter(const char *key, const char *value)
451 struct strbuf env = STRBUF_INIT;
452 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
453 if (old && *old) {
454 strbuf_addstr(&env, old);
455 strbuf_addch(&env, ' ');
457 sq_quote_buf(&env, key);
458 strbuf_addch(&env, '=');
459 if (value)
460 sq_quote_buf(&env, value);
461 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
462 strbuf_release(&env);
465 void git_config_push_parameter(const char *text)
467 const char *value;
470 * When we see:
472 * section.subsection=with=equals.key=value
474 * we cannot tell if it means:
476 * [section "subsection=with=equals"]
477 * key = value
479 * or:
481 * [section]
482 * subsection = with=equals.key=value
484 * We parse left-to-right for the first "=", meaning we'll prefer to
485 * keep the value intact over the subsection. This is historical, but
486 * also sensible since values are more likely to contain odd or
487 * untrusted input than a section name.
489 * A missing equals is explicitly allowed (as a bool-only entry).
491 value = strchr(text, '=');
492 if (value) {
493 char *key = xmemdupz(text, value - text);
494 git_config_push_split_parameter(key, value + 1);
495 free(key);
496 } else {
497 git_config_push_split_parameter(text, NULL);
501 void git_config_push_env(const char *spec)
503 char *key;
504 const char *env_name;
505 const char *env_value;
507 env_name = strrchr(spec, '=');
508 if (!env_name)
509 die(_("invalid config format: %s"), spec);
510 key = xmemdupz(spec, env_name - spec);
511 env_name++;
512 if (!*env_name)
513 die(_("missing environment variable name for configuration '%.*s'"),
514 (int)(env_name - spec - 1), spec);
516 env_value = getenv(env_name);
517 if (!env_value)
518 die(_("missing environment variable '%s' for configuration '%.*s'"),
519 env_name, (int)(env_name - spec - 1), spec);
521 git_config_push_split_parameter(key, env_value);
522 free(key);
525 static inline int iskeychar(int c)
527 return isalnum(c) || c == '-';
531 * Auxiliary function to sanity-check and split the key into the section
532 * identifier and variable name.
534 * Returns 0 on success, -1 when there is an invalid character in the key and
535 * -2 if there is no section name in the key.
537 * store_key - pointer to char* which will hold a copy of the key with
538 * lowercase section and variable name
539 * baselen - pointer to size_t which will hold the length of the
540 * section + subsection part, can be NULL
542 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
544 size_t i, baselen;
545 int dot;
546 const char *last_dot = strrchr(key, '.');
549 * Since "key" actually contains the section name and the real
550 * key name separated by a dot, we have to know where the dot is.
553 if (last_dot == NULL || last_dot == key) {
554 error(_("key does not contain a section: %s"), key);
555 return -CONFIG_NO_SECTION_OR_NAME;
558 if (!last_dot[1]) {
559 error(_("key does not contain variable name: %s"), key);
560 return -CONFIG_NO_SECTION_OR_NAME;
563 baselen = last_dot - key;
564 if (baselen_)
565 *baselen_ = baselen;
568 * Validate the key and while at it, lower case it for matching.
570 *store_key = xmallocz(strlen(key));
572 dot = 0;
573 for (i = 0; key[i]; i++) {
574 unsigned char c = key[i];
575 if (c == '.')
576 dot = 1;
577 /* Leave the extended basename untouched.. */
578 if (!dot || i > baselen) {
579 if (!iskeychar(c) ||
580 (i == baselen + 1 && !isalpha(c))) {
581 error(_("invalid key: %s"), key);
582 goto out_free_ret_1;
584 c = tolower(c);
585 } else if (c == '\n') {
586 error(_("invalid key (newline): %s"), key);
587 goto out_free_ret_1;
589 (*store_key)[i] = c;
592 return 0;
594 out_free_ret_1:
595 FREE_AND_NULL(*store_key);
596 return -CONFIG_INVALID_KEY;
599 static int config_parse_pair(const char *key, const char *value,
600 struct key_value_info *kvi,
601 config_fn_t fn, void *data)
603 char *canonical_name;
604 int ret;
605 struct config_context ctx = {
606 .kvi = kvi,
609 if (!strlen(key))
610 return error(_("empty config key"));
611 if (git_config_parse_key(key, &canonical_name, NULL))
612 return -1;
614 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
615 free(canonical_name);
616 return ret;
620 /* for values read from `git_config_from_parameters()` */
621 void kvi_from_param(struct key_value_info *out)
623 out->filename = NULL;
624 out->linenr = -1;
625 out->origin_type = CONFIG_ORIGIN_CMDLINE;
626 out->scope = CONFIG_SCOPE_COMMAND;
627 out->path = NULL;
630 int git_config_parse_parameter(const char *text,
631 config_fn_t fn, void *data)
633 const char *value;
634 struct strbuf **pair;
635 int ret;
636 struct key_value_info kvi = KVI_INIT;
638 kvi_from_param(&kvi);
640 pair = strbuf_split_str(text, '=', 2);
641 if (!pair[0])
642 return error(_("bogus config parameter: %s"), text);
644 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
645 strbuf_setlen(pair[0], pair[0]->len - 1);
646 value = pair[1] ? pair[1]->buf : "";
647 } else {
648 value = NULL;
651 strbuf_trim(pair[0]);
652 if (!pair[0]->len) {
653 strbuf_list_free(pair);
654 return error(_("bogus config parameter: %s"), text);
657 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
658 strbuf_list_free(pair);
659 return ret;
662 static int parse_config_env_list(char *env, struct key_value_info *kvi,
663 config_fn_t fn, void *data)
665 char *cur = env;
666 while (cur && *cur) {
667 const char *key = sq_dequote_step(cur, &cur);
668 if (!key)
669 return error(_("bogus format in %s"),
670 CONFIG_DATA_ENVIRONMENT);
672 if (!cur || isspace(*cur)) {
673 /* old-style 'key=value' */
674 if (git_config_parse_parameter(key, fn, data) < 0)
675 return -1;
677 else if (*cur == '=') {
678 /* new-style 'key'='value' */
679 const char *value;
681 cur++;
682 if (*cur == '\'') {
683 /* quoted value */
684 value = sq_dequote_step(cur, &cur);
685 if (!value || (cur && !isspace(*cur))) {
686 return error(_("bogus format in %s"),
687 CONFIG_DATA_ENVIRONMENT);
689 } else if (!*cur || isspace(*cur)) {
690 /* implicit bool: 'key'= */
691 value = NULL;
692 } else {
693 return error(_("bogus format in %s"),
694 CONFIG_DATA_ENVIRONMENT);
697 if (config_parse_pair(key, value, kvi, fn, data) < 0)
698 return -1;
700 else {
701 /* unknown format */
702 return error(_("bogus format in %s"),
703 CONFIG_DATA_ENVIRONMENT);
706 if (cur) {
707 while (isspace(*cur))
708 cur++;
711 return 0;
714 int git_config_from_parameters(config_fn_t fn, void *data)
716 const char *env;
717 struct strbuf envvar = STRBUF_INIT;
718 struct strvec to_free = STRVEC_INIT;
719 int ret = 0;
720 char *envw = NULL;
721 struct key_value_info kvi = KVI_INIT;
723 kvi_from_param(&kvi);
724 env = getenv(CONFIG_COUNT_ENVIRONMENT);
725 if (env) {
726 unsigned long count;
727 char *endp;
728 int i;
730 count = strtoul(env, &endp, 10);
731 if (*endp) {
732 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
733 goto out;
735 if (count > INT_MAX) {
736 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
737 goto out;
740 for (i = 0; i < count; i++) {
741 const char *key, *value;
743 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
744 key = getenv_safe(&to_free, envvar.buf);
745 if (!key) {
746 ret = error(_("missing config key %s"), envvar.buf);
747 goto out;
749 strbuf_reset(&envvar);
751 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
752 value = getenv_safe(&to_free, envvar.buf);
753 if (!value) {
754 ret = error(_("missing config value %s"), envvar.buf);
755 goto out;
757 strbuf_reset(&envvar);
759 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
760 ret = -1;
761 goto out;
766 env = getenv(CONFIG_DATA_ENVIRONMENT);
767 if (env) {
768 /* sq_dequote will write over it */
769 envw = xstrdup(env);
770 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
771 ret = -1;
772 goto out;
776 out:
777 strbuf_release(&envvar);
778 strvec_clear(&to_free);
779 free(envw);
780 return ret;
783 static int get_next_char(struct config_source *cs)
785 int c = cs->do_fgetc(cs);
787 if (c == '\r') {
788 /* DOS like systems */
789 c = cs->do_fgetc(cs);
790 if (c != '\n') {
791 if (c != EOF)
792 cs->do_ungetc(c, cs);
793 c = '\r';
797 if (c != EOF && ++cs->total_len > INT_MAX) {
799 * This is an absurdly long config file; refuse to parse
800 * further in order to protect downstream code from integer
801 * overflows. Note that we can't return an error specifically,
802 * but we can mark EOF and put trash in the return value,
803 * which will trigger a parse error.
805 cs->eof = 1;
806 return 0;
809 if (c == '\n')
810 cs->linenr++;
811 if (c == EOF) {
812 cs->eof = 1;
813 cs->linenr++;
814 c = '\n';
816 return c;
819 static char *parse_value(struct config_source *cs)
821 int quote = 0, comment = 0, space = 0;
823 strbuf_reset(&cs->value);
824 for (;;) {
825 int c = get_next_char(cs);
826 if (c == '\n') {
827 if (quote) {
828 cs->linenr--;
829 return NULL;
831 return cs->value.buf;
833 if (comment)
834 continue;
835 if (isspace(c) && !quote) {
836 if (cs->value.len)
837 space++;
838 continue;
840 if (!quote) {
841 if (c == ';' || c == '#') {
842 comment = 1;
843 continue;
846 for (; space; space--)
847 strbuf_addch(&cs->value, ' ');
848 if (c == '\\') {
849 c = get_next_char(cs);
850 switch (c) {
851 case '\n':
852 continue;
853 case 't':
854 c = '\t';
855 break;
856 case 'b':
857 c = '\b';
858 break;
859 case 'n':
860 c = '\n';
861 break;
862 /* Some characters escape as themselves */
863 case '\\': case '"':
864 break;
865 /* Reject unknown escape sequences */
866 default:
867 return NULL;
869 strbuf_addch(&cs->value, c);
870 continue;
872 if (c == '"') {
873 quote = 1-quote;
874 continue;
876 strbuf_addch(&cs->value, c);
880 static int get_value(struct config_source *cs, struct key_value_info *kvi,
881 config_fn_t fn, void *data, struct strbuf *name)
883 int c;
884 char *value;
885 int ret;
886 struct config_context ctx = {
887 .kvi = kvi,
890 /* Get the full name */
891 for (;;) {
892 c = get_next_char(cs);
893 if (cs->eof)
894 break;
895 if (!iskeychar(c))
896 break;
897 strbuf_addch(name, tolower(c));
900 while (c == ' ' || c == '\t')
901 c = get_next_char(cs);
903 value = NULL;
904 if (c != '\n') {
905 if (c != '=')
906 return -1;
907 value = parse_value(cs);
908 if (!value)
909 return -1;
912 * We already consumed the \n, but we need linenr to point to
913 * the line we just parsed during the call to fn to get
914 * accurate line number in error messages.
916 cs->linenr--;
917 kvi->linenr = cs->linenr;
918 ret = fn(name->buf, value, &ctx, data);
919 if (ret >= 0)
920 cs->linenr++;
921 return ret;
924 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
925 int c)
927 cs->subsection_case_sensitive = 0;
928 do {
929 if (c == '\n')
930 goto error_incomplete_line;
931 c = get_next_char(cs);
932 } while (isspace(c));
934 /* We require the format to be '[base "extension"]' */
935 if (c != '"')
936 return -1;
937 strbuf_addch(name, '.');
939 for (;;) {
940 int c = get_next_char(cs);
941 if (c == '\n')
942 goto error_incomplete_line;
943 if (c == '"')
944 break;
945 if (c == '\\') {
946 c = get_next_char(cs);
947 if (c == '\n')
948 goto error_incomplete_line;
950 strbuf_addch(name, c);
953 /* Final ']' */
954 if (get_next_char(cs) != ']')
955 return -1;
956 return 0;
957 error_incomplete_line:
958 cs->linenr--;
959 return -1;
962 static int get_base_var(struct config_source *cs, struct strbuf *name)
964 cs->subsection_case_sensitive = 1;
965 for (;;) {
966 int c = get_next_char(cs);
967 if (cs->eof)
968 return -1;
969 if (c == ']')
970 return 0;
971 if (isspace(c))
972 return get_extended_base_var(cs, name, c);
973 if (!iskeychar(c) && c != '.')
974 return -1;
975 strbuf_addch(name, tolower(c));
979 struct parse_event_data {
980 enum config_event_t previous_type;
981 size_t previous_offset;
982 const struct config_options *opts;
985 static int do_event(struct config_source *cs, enum config_event_t type,
986 struct parse_event_data *data)
988 size_t offset;
990 if (!data->opts || !data->opts->event_fn)
991 return 0;
993 if (type == CONFIG_EVENT_WHITESPACE &&
994 data->previous_type == type)
995 return 0;
997 offset = cs->do_ftell(cs);
999 * At EOF, the parser always "inserts" an extra '\n', therefore
1000 * the end offset of the event is the current file position, otherwise
1001 * we will already have advanced to the next event.
1003 if (type != CONFIG_EVENT_EOF)
1004 offset--;
1006 if (data->previous_type != CONFIG_EVENT_EOF &&
1007 data->opts->event_fn(data->previous_type, data->previous_offset,
1008 offset, cs, data->opts->event_fn_data) < 0)
1009 return -1;
1011 data->previous_type = type;
1012 data->previous_offset = offset;
1014 return 0;
1017 static void kvi_from_source(struct config_source *cs,
1018 enum config_scope scope,
1019 struct key_value_info *out)
1021 out->filename = strintern(cs->name);
1022 out->origin_type = cs->origin_type;
1023 out->linenr = cs->linenr;
1024 out->scope = scope;
1025 out->path = cs->path;
1028 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1029 struct key_value_info *kvi, void *data,
1030 const struct config_options *opts)
1032 int comment = 0;
1033 size_t baselen = 0;
1034 struct strbuf *var = &cs->var;
1035 int error_return = 0;
1036 char *error_msg = NULL;
1038 /* U+FEFF Byte Order Mark in UTF8 */
1039 const char *bomptr = utf8_bom;
1041 /* For the parser event callback */
1042 struct parse_event_data event_data = {
1043 CONFIG_EVENT_EOF, 0, opts
1046 for (;;) {
1047 int c;
1049 c = get_next_char(cs);
1050 if (bomptr && *bomptr) {
1051 /* We are at the file beginning; skip UTF8-encoded BOM
1052 * if present. Sane editors won't put this in on their
1053 * own, but e.g. Windows Notepad will do it happily. */
1054 if (c == (*bomptr & 0377)) {
1055 bomptr++;
1056 continue;
1057 } else {
1058 /* Do not tolerate partial BOM. */
1059 if (bomptr != utf8_bom)
1060 break;
1061 /* No BOM at file beginning. Cool. */
1062 bomptr = NULL;
1065 if (c == '\n') {
1066 if (cs->eof) {
1067 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1068 return -1;
1069 return 0;
1071 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1072 return -1;
1073 comment = 0;
1074 continue;
1076 if (comment)
1077 continue;
1078 if (isspace(c)) {
1079 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1080 return -1;
1081 continue;
1083 if (c == '#' || c == ';') {
1084 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1085 return -1;
1086 comment = 1;
1087 continue;
1089 if (c == '[') {
1090 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1091 return -1;
1093 /* Reset prior to determining a new stem */
1094 strbuf_reset(var);
1095 if (get_base_var(cs, var) < 0 || var->len < 1)
1096 break;
1097 strbuf_addch(var, '.');
1098 baselen = var->len;
1099 continue;
1101 if (!isalpha(c))
1102 break;
1104 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1105 return -1;
1108 * Truncate the var name back to the section header
1109 * stem prior to grabbing the suffix part of the name
1110 * and the value.
1112 strbuf_setlen(var, baselen);
1113 strbuf_addch(var, tolower(c));
1114 if (get_value(cs, kvi, fn, data, var) < 0)
1115 break;
1118 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1119 return -1;
1121 switch (cs->origin_type) {
1122 case CONFIG_ORIGIN_BLOB:
1123 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1124 cs->linenr, cs->name);
1125 break;
1126 case CONFIG_ORIGIN_FILE:
1127 error_msg = xstrfmt(_("bad config line %d in file %s"),
1128 cs->linenr, cs->name);
1129 break;
1130 case CONFIG_ORIGIN_STDIN:
1131 error_msg = xstrfmt(_("bad config line %d in standard input"),
1132 cs->linenr);
1133 break;
1134 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1135 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1136 cs->linenr, cs->name);
1137 break;
1138 case CONFIG_ORIGIN_CMDLINE:
1139 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1140 cs->linenr, cs->name);
1141 break;
1142 default:
1143 error_msg = xstrfmt(_("bad config line %d in %s"),
1144 cs->linenr, cs->name);
1147 switch (opts && opts->error_action ?
1148 opts->error_action :
1149 cs->default_error_action) {
1150 case CONFIG_ERROR_DIE:
1151 die("%s", error_msg);
1152 break;
1153 case CONFIG_ERROR_ERROR:
1154 error_return = error("%s", error_msg);
1155 break;
1156 case CONFIG_ERROR_SILENT:
1157 error_return = -1;
1158 break;
1159 case CONFIG_ERROR_UNSET:
1160 BUG("config error action unset");
1163 free(error_msg);
1164 return error_return;
1167 NORETURN
1168 static void die_bad_number(const char *name, const char *value,
1169 const struct key_value_info *kvi)
1171 const char *error_type = (errno == ERANGE) ?
1172 N_("out of range") : N_("invalid unit");
1173 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1175 if (!kvi)
1176 BUG("kvi should not be NULL");
1178 if (!value)
1179 value = "";
1181 if (!kvi->filename)
1182 die(_(bad_numeric), value, name, _(error_type));
1184 switch (kvi->origin_type) {
1185 case CONFIG_ORIGIN_BLOB:
1186 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1187 value, name, kvi->filename, _(error_type));
1188 case CONFIG_ORIGIN_FILE:
1189 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1190 value, name, kvi->filename, _(error_type));
1191 case CONFIG_ORIGIN_STDIN:
1192 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1193 value, name, _(error_type));
1194 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1195 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1196 value, name, kvi->filename, _(error_type));
1197 case CONFIG_ORIGIN_CMDLINE:
1198 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1199 value, name, kvi->filename, _(error_type));
1200 default:
1201 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1202 value, name, kvi->filename, _(error_type));
1206 int git_config_int(const char *name, const char *value,
1207 const struct key_value_info *kvi)
1209 int ret;
1210 if (!git_parse_int(value, &ret))
1211 die_bad_number(name, value, kvi);
1212 return ret;
1215 int64_t git_config_int64(const char *name, const char *value,
1216 const struct key_value_info *kvi)
1218 int64_t ret;
1219 if (!git_parse_int64(value, &ret))
1220 die_bad_number(name, value, kvi);
1221 return ret;
1224 unsigned long git_config_ulong(const char *name, const char *value,
1225 const struct key_value_info *kvi)
1227 unsigned long ret;
1228 if (!git_parse_ulong(value, &ret))
1229 die_bad_number(name, value, kvi);
1230 return ret;
1233 ssize_t git_config_ssize_t(const char *name, const char *value,
1234 const struct key_value_info *kvi)
1236 ssize_t ret;
1237 if (!git_parse_ssize_t(value, &ret))
1238 die_bad_number(name, value, kvi);
1239 return ret;
1242 static const struct fsync_component_name {
1243 const char *name;
1244 enum fsync_component component_bits;
1245 } fsync_component_names[] = {
1246 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1247 { "pack", FSYNC_COMPONENT_PACK },
1248 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1249 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1250 { "index", FSYNC_COMPONENT_INDEX },
1251 { "objects", FSYNC_COMPONENTS_OBJECTS },
1252 { "reference", FSYNC_COMPONENT_REFERENCE },
1253 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1254 { "committed", FSYNC_COMPONENTS_COMMITTED },
1255 { "added", FSYNC_COMPONENTS_ADDED },
1256 { "all", FSYNC_COMPONENTS_ALL },
1259 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1261 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1262 enum fsync_component positive = 0, negative = 0;
1264 while (string) {
1265 int i;
1266 size_t len;
1267 const char *ep;
1268 int negated = 0;
1269 int found = 0;
1271 string = string + strspn(string, ", \t\n\r");
1272 ep = strchrnul(string, ',');
1273 len = ep - string;
1274 if (!strcmp(string, "none")) {
1275 current = FSYNC_COMPONENT_NONE;
1276 goto next_name;
1279 if (*string == '-') {
1280 negated = 1;
1281 string++;
1282 len--;
1283 if (!len)
1284 warning(_("invalid value for variable %s"), var);
1287 if (!len)
1288 break;
1290 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1291 const struct fsync_component_name *n = &fsync_component_names[i];
1293 if (strncmp(n->name, string, len))
1294 continue;
1296 found = 1;
1297 if (negated)
1298 negative |= n->component_bits;
1299 else
1300 positive |= n->component_bits;
1303 if (!found) {
1304 char *component = xstrndup(string, len);
1305 warning(_("ignoring unknown core.fsync component '%s'"), component);
1306 free(component);
1309 next_name:
1310 string = ep;
1313 return (current & ~negative) | positive;
1316 int git_config_bool_or_int(const char *name, const char *value,
1317 const struct key_value_info *kvi, int *is_bool)
1319 int v = git_parse_maybe_bool_text(value);
1320 if (0 <= v) {
1321 *is_bool = 1;
1322 return v;
1324 *is_bool = 0;
1325 return git_config_int(name, value, kvi);
1328 int git_config_bool(const char *name, const char *value)
1330 int v = git_parse_maybe_bool(value);
1331 if (v < 0)
1332 die(_("bad boolean config value '%s' for '%s'"), value, name);
1333 return v;
1336 int git_config_string(const char **dest, const char *var, const char *value)
1338 if (!value)
1339 return config_error_nonbool(var);
1340 *dest = xstrdup(value);
1341 return 0;
1344 int git_config_pathname(const char **dest, const char *var, const char *value)
1346 if (!value)
1347 return config_error_nonbool(var);
1348 *dest = interpolate_path(value, 0);
1349 if (!*dest)
1350 die(_("failed to expand user dir in: '%s'"), value);
1351 return 0;
1354 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1356 if (!value)
1357 return config_error_nonbool(var);
1358 if (parse_expiry_date(value, timestamp))
1359 return error(_("'%s' for '%s' is not a valid timestamp"),
1360 value, var);
1361 return 0;
1364 int git_config_color(char *dest, const char *var, const char *value)
1366 if (!value)
1367 return config_error_nonbool(var);
1368 if (color_parse(value, dest) < 0)
1369 return -1;
1370 return 0;
1373 static int git_default_core_config(const char *var, const char *value,
1374 const struct config_context *ctx, void *cb)
1376 /* This needs a better name */
1377 if (!strcmp(var, "core.filemode")) {
1378 trust_executable_bit = git_config_bool(var, value);
1379 return 0;
1381 if (!strcmp(var, "core.trustctime")) {
1382 trust_ctime = git_config_bool(var, value);
1383 return 0;
1385 if (!strcmp(var, "core.checkstat")) {
1386 if (!value)
1387 return config_error_nonbool(var);
1388 if (!strcasecmp(value, "default"))
1389 check_stat = 1;
1390 else if (!strcasecmp(value, "minimal"))
1391 check_stat = 0;
1392 else
1393 return error(_("invalid value for '%s': '%s'"),
1394 var, value);
1397 if (!strcmp(var, "core.quotepath")) {
1398 quote_path_fully = git_config_bool(var, value);
1399 return 0;
1402 if (!strcmp(var, "core.symlinks")) {
1403 has_symlinks = git_config_bool(var, value);
1404 return 0;
1407 if (!strcmp(var, "core.ignorecase")) {
1408 ignore_case = git_config_bool(var, value);
1409 return 0;
1412 if (!strcmp(var, "core.attributesfile"))
1413 return git_config_pathname(&git_attributes_file, var, value);
1415 if (!strcmp(var, "core.hookspath")) {
1416 if (ctx->kvi && ctx->kvi->scope == CONFIG_SCOPE_LOCAL &&
1417 git_env_bool("GIT_CLONE_PROTECTION_ACTIVE", 0))
1418 die(_("active `core.hooksPath` found in the local "
1419 "repository config:\n\t%s\nFor security "
1420 "reasons, this is disallowed by default.\nIf "
1421 "this is intentional and the hook should "
1422 "actually be run, please\nrun the command "
1423 "again with "
1424 "`GIT_CLONE_PROTECTION_ACTIVE=false`"),
1425 value);
1426 return git_config_pathname(&git_hooks_path, var, value);
1429 if (!strcmp(var, "core.bare")) {
1430 is_bare_repository_cfg = git_config_bool(var, value);
1431 return 0;
1434 if (!strcmp(var, "core.ignorestat")) {
1435 assume_unchanged = git_config_bool(var, value);
1436 return 0;
1439 if (!strcmp(var, "core.prefersymlinkrefs")) {
1440 prefer_symlink_refs = git_config_bool(var, value);
1441 return 0;
1444 if (!strcmp(var, "core.logallrefupdates")) {
1445 if (value && !strcasecmp(value, "always"))
1446 log_all_ref_updates = LOG_REFS_ALWAYS;
1447 else if (git_config_bool(var, value))
1448 log_all_ref_updates = LOG_REFS_NORMAL;
1449 else
1450 log_all_ref_updates = LOG_REFS_NONE;
1451 return 0;
1454 if (!strcmp(var, "core.warnambiguousrefs")) {
1455 warn_ambiguous_refs = git_config_bool(var, value);
1456 return 0;
1459 if (!strcmp(var, "core.abbrev")) {
1460 if (!value)
1461 return config_error_nonbool(var);
1462 if (!strcasecmp(value, "auto"))
1463 default_abbrev = -1;
1464 else if (!git_parse_maybe_bool_text(value))
1465 default_abbrev = the_hash_algo->hexsz;
1466 else {
1467 int abbrev = git_config_int(var, value, ctx->kvi);
1468 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1469 return error(_("abbrev length out of range: %d"), abbrev);
1470 default_abbrev = abbrev;
1472 return 0;
1475 if (!strcmp(var, "core.disambiguate"))
1476 return set_disambiguate_hint_config(var, value);
1478 if (!strcmp(var, "core.loosecompression")) {
1479 int level = git_config_int(var, value, ctx->kvi);
1480 if (level == -1)
1481 level = Z_DEFAULT_COMPRESSION;
1482 else if (level < 0 || level > Z_BEST_COMPRESSION)
1483 die(_("bad zlib compression level %d"), level);
1484 zlib_compression_level = level;
1485 zlib_compression_seen = 1;
1486 return 0;
1489 if (!strcmp(var, "core.compression")) {
1490 int level = git_config_int(var, value, ctx->kvi);
1491 if (level == -1)
1492 level = Z_DEFAULT_COMPRESSION;
1493 else if (level < 0 || level > Z_BEST_COMPRESSION)
1494 die(_("bad zlib compression level %d"), level);
1495 if (!zlib_compression_seen)
1496 zlib_compression_level = level;
1497 if (!pack_compression_seen)
1498 pack_compression_level = level;
1499 return 0;
1502 if (!strcmp(var, "core.packedgitwindowsize")) {
1503 int pgsz_x2 = getpagesize() * 2;
1504 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1506 /* This value must be multiple of (pagesize * 2) */
1507 packed_git_window_size /= pgsz_x2;
1508 if (packed_git_window_size < 1)
1509 packed_git_window_size = 1;
1510 packed_git_window_size *= pgsz_x2;
1511 return 0;
1514 if (!strcmp(var, "core.bigfilethreshold")) {
1515 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1516 return 0;
1519 if (!strcmp(var, "core.packedgitlimit")) {
1520 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1521 return 0;
1524 if (!strcmp(var, "core.deltabasecachelimit")) {
1525 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1526 return 0;
1529 if (!strcmp(var, "core.autocrlf")) {
1530 if (value && !strcasecmp(value, "input")) {
1531 auto_crlf = AUTO_CRLF_INPUT;
1532 return 0;
1534 auto_crlf = git_config_bool(var, value);
1535 return 0;
1538 if (!strcmp(var, "core.safecrlf")) {
1539 int eol_rndtrp_die;
1540 if (value && !strcasecmp(value, "warn")) {
1541 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1542 return 0;
1544 eol_rndtrp_die = git_config_bool(var, value);
1545 global_conv_flags_eol = eol_rndtrp_die ?
1546 CONV_EOL_RNDTRP_DIE : 0;
1547 return 0;
1550 if (!strcmp(var, "core.eol")) {
1551 if (value && !strcasecmp(value, "lf"))
1552 core_eol = EOL_LF;
1553 else if (value && !strcasecmp(value, "crlf"))
1554 core_eol = EOL_CRLF;
1555 else if (value && !strcasecmp(value, "native"))
1556 core_eol = EOL_NATIVE;
1557 else
1558 core_eol = EOL_UNSET;
1559 return 0;
1562 if (!strcmp(var, "core.checkroundtripencoding"))
1563 return git_config_string(&check_roundtrip_encoding, var, value);
1565 if (!strcmp(var, "core.notesref")) {
1566 if (!value)
1567 return config_error_nonbool(var);
1568 notes_ref_name = xstrdup(value);
1569 return 0;
1572 if (!strcmp(var, "core.editor"))
1573 return git_config_string(&editor_program, var, value);
1575 if (!strcmp(var, "core.commentchar")) {
1576 if (!value)
1577 return config_error_nonbool(var);
1578 else if (!strcasecmp(value, "auto"))
1579 auto_comment_line_char = 1;
1580 else if (value[0] && !value[1]) {
1581 comment_line_char = value[0];
1582 auto_comment_line_char = 0;
1583 } else
1584 return error(_("core.commentChar should only be one ASCII character"));
1585 return 0;
1588 if (!strcmp(var, "core.askpass"))
1589 return git_config_string(&askpass_program, var, value);
1591 if (!strcmp(var, "core.excludesfile"))
1592 return git_config_pathname(&excludes_file, var, value);
1594 if (!strcmp(var, "core.whitespace")) {
1595 if (!value)
1596 return config_error_nonbool(var);
1597 whitespace_rule_cfg = parse_whitespace_rule(value);
1598 return 0;
1601 if (!strcmp(var, "core.fsync")) {
1602 if (!value)
1603 return config_error_nonbool(var);
1604 fsync_components = parse_fsync_components(var, value);
1605 return 0;
1608 if (!strcmp(var, "core.fsyncmethod")) {
1609 if (!value)
1610 return config_error_nonbool(var);
1611 if (!strcmp(value, "fsync"))
1612 fsync_method = FSYNC_METHOD_FSYNC;
1613 else if (!strcmp(value, "writeout-only"))
1614 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1615 else if (!strcmp(value, "batch"))
1616 fsync_method = FSYNC_METHOD_BATCH;
1617 else
1618 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1622 if (!strcmp(var, "core.fsyncobjectfiles")) {
1623 if (fsync_object_files < 0)
1624 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1625 fsync_object_files = git_config_bool(var, value);
1626 return 0;
1629 if (!strcmp(var, "core.preloadindex")) {
1630 core_preload_index = git_config_bool(var, value);
1631 return 0;
1634 if (!strcmp(var, "core.createobject")) {
1635 if (!value)
1636 return config_error_nonbool(var);
1637 if (!strcmp(value, "rename"))
1638 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1639 else if (!strcmp(value, "link"))
1640 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1641 else
1642 die(_("invalid mode for object creation: %s"), value);
1643 return 0;
1646 if (!strcmp(var, "core.sparsecheckout")) {
1647 core_apply_sparse_checkout = git_config_bool(var, value);
1648 return 0;
1651 if (!strcmp(var, "core.sparsecheckoutcone")) {
1652 core_sparse_checkout_cone = git_config_bool(var, value);
1653 return 0;
1656 if (!strcmp(var, "core.precomposeunicode")) {
1657 precomposed_unicode = git_config_bool(var, value);
1658 return 0;
1661 if (!strcmp(var, "core.protecthfs")) {
1662 protect_hfs = git_config_bool(var, value);
1663 return 0;
1666 if (!strcmp(var, "core.protectntfs")) {
1667 protect_ntfs = git_config_bool(var, value);
1668 return 0;
1671 if (!strcmp(var, "core.maxtreedepth")) {
1672 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1673 return 0;
1676 /* Add other config variables here and to Documentation/config.txt. */
1677 return platform_core_config(var, value, ctx, cb);
1680 static int git_default_sparse_config(const char *var, const char *value)
1682 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1683 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1684 return 0;
1687 /* Add other config variables here and to Documentation/config/sparse.txt. */
1688 return 0;
1691 static int git_default_i18n_config(const char *var, const char *value)
1693 if (!strcmp(var, "i18n.commitencoding"))
1694 return git_config_string(&git_commit_encoding, var, value);
1696 if (!strcmp(var, "i18n.logoutputencoding"))
1697 return git_config_string(&git_log_output_encoding, var, value);
1699 /* Add other config variables here and to Documentation/config.txt. */
1700 return 0;
1703 static int git_default_branch_config(const char *var, const char *value)
1705 if (!strcmp(var, "branch.autosetupmerge")) {
1706 if (value && !strcmp(value, "always")) {
1707 git_branch_track = BRANCH_TRACK_ALWAYS;
1708 return 0;
1709 } else if (value && !strcmp(value, "inherit")) {
1710 git_branch_track = BRANCH_TRACK_INHERIT;
1711 return 0;
1712 } else if (value && !strcmp(value, "simple")) {
1713 git_branch_track = BRANCH_TRACK_SIMPLE;
1714 return 0;
1716 git_branch_track = git_config_bool(var, value);
1717 return 0;
1719 if (!strcmp(var, "branch.autosetuprebase")) {
1720 if (!value)
1721 return config_error_nonbool(var);
1722 else if (!strcmp(value, "never"))
1723 autorebase = AUTOREBASE_NEVER;
1724 else if (!strcmp(value, "local"))
1725 autorebase = AUTOREBASE_LOCAL;
1726 else if (!strcmp(value, "remote"))
1727 autorebase = AUTOREBASE_REMOTE;
1728 else if (!strcmp(value, "always"))
1729 autorebase = AUTOREBASE_ALWAYS;
1730 else
1731 return error(_("malformed value for %s"), var);
1732 return 0;
1735 /* Add other config variables here and to Documentation/config.txt. */
1736 return 0;
1739 static int git_default_push_config(const char *var, const char *value)
1741 if (!strcmp(var, "push.default")) {
1742 if (!value)
1743 return config_error_nonbool(var);
1744 else if (!strcmp(value, "nothing"))
1745 push_default = PUSH_DEFAULT_NOTHING;
1746 else if (!strcmp(value, "matching"))
1747 push_default = PUSH_DEFAULT_MATCHING;
1748 else if (!strcmp(value, "simple"))
1749 push_default = PUSH_DEFAULT_SIMPLE;
1750 else if (!strcmp(value, "upstream"))
1751 push_default = PUSH_DEFAULT_UPSTREAM;
1752 else if (!strcmp(value, "tracking")) /* deprecated */
1753 push_default = PUSH_DEFAULT_UPSTREAM;
1754 else if (!strcmp(value, "current"))
1755 push_default = PUSH_DEFAULT_CURRENT;
1756 else {
1757 error(_("malformed value for %s: %s"), var, value);
1758 return error(_("must be one of nothing, matching, simple, "
1759 "upstream or current"));
1761 return 0;
1764 /* Add other config variables here and to Documentation/config.txt. */
1765 return 0;
1768 static int git_default_mailmap_config(const char *var, const char *value)
1770 if (!strcmp(var, "mailmap.file"))
1771 return git_config_pathname(&git_mailmap_file, var, value);
1772 if (!strcmp(var, "mailmap.blob"))
1773 return git_config_string(&git_mailmap_blob, var, value);
1775 /* Add other config variables here and to Documentation/config.txt. */
1776 return 0;
1779 static int git_default_attr_config(const char *var, const char *value)
1781 if (!strcmp(var, "attr.tree"))
1782 return git_config_string(&git_attr_tree, var, value);
1785 * Add other attribute related config variables here and to
1786 * Documentation/config/attr.txt.
1788 return 0;
1791 int git_default_config(const char *var, const char *value,
1792 const struct config_context *ctx, void *cb)
1794 if (starts_with(var, "core."))
1795 return git_default_core_config(var, value, ctx, cb);
1797 if (starts_with(var, "user.") ||
1798 starts_with(var, "author.") ||
1799 starts_with(var, "committer."))
1800 return git_ident_config(var, value, ctx, cb);
1802 if (starts_with(var, "i18n."))
1803 return git_default_i18n_config(var, value);
1805 if (starts_with(var, "branch."))
1806 return git_default_branch_config(var, value);
1808 if (starts_with(var, "push."))
1809 return git_default_push_config(var, value);
1811 if (starts_with(var, "mailmap."))
1812 return git_default_mailmap_config(var, value);
1814 if (starts_with(var, "attr."))
1815 return git_default_attr_config(var, value);
1817 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1818 return git_default_advice_config(var, value);
1820 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1821 pager_use_color = git_config_bool(var,value);
1822 return 0;
1825 if (!strcmp(var, "pack.packsizelimit")) {
1826 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1827 return 0;
1830 if (!strcmp(var, "pack.compression")) {
1831 int level = git_config_int(var, value, ctx->kvi);
1832 if (level == -1)
1833 level = Z_DEFAULT_COMPRESSION;
1834 else if (level < 0 || level > Z_BEST_COMPRESSION)
1835 die(_("bad pack compression level %d"), level);
1836 pack_compression_level = level;
1837 pack_compression_seen = 1;
1838 return 0;
1841 if (starts_with(var, "sparse."))
1842 return git_default_sparse_config(var, value);
1844 /* Add other config variables here and to Documentation/config.txt. */
1845 return 0;
1849 * All source specific fields in the union, die_on_error, name and the callbacks
1850 * fgetc, ungetc, ftell of top need to be initialized before calling
1851 * this function.
1853 static int do_config_from(struct config_source *top, config_fn_t fn,
1854 void *data, enum config_scope scope,
1855 const struct config_options *opts)
1857 struct key_value_info kvi = KVI_INIT;
1858 int ret;
1860 /* push config-file parsing state stack */
1861 top->linenr = 1;
1862 top->eof = 0;
1863 top->total_len = 0;
1864 strbuf_init(&top->value, 1024);
1865 strbuf_init(&top->var, 1024);
1866 kvi_from_source(top, scope, &kvi);
1868 ret = git_parse_source(top, fn, &kvi, data, opts);
1870 strbuf_release(&top->value);
1871 strbuf_release(&top->var);
1873 return ret;
1876 static int do_config_from_file(config_fn_t fn,
1877 const enum config_origin_type origin_type,
1878 const char *name, const char *path, FILE *f,
1879 void *data, enum config_scope scope,
1880 const struct config_options *opts)
1882 struct config_source top = CONFIG_SOURCE_INIT;
1883 int ret;
1885 top.u.file = f;
1886 top.origin_type = origin_type;
1887 top.name = name;
1888 top.path = path;
1889 top.default_error_action = CONFIG_ERROR_DIE;
1890 top.do_fgetc = config_file_fgetc;
1891 top.do_ungetc = config_file_ungetc;
1892 top.do_ftell = config_file_ftell;
1894 flockfile(f);
1895 ret = do_config_from(&top, fn, data, scope, opts);
1896 funlockfile(f);
1897 return ret;
1900 static int git_config_from_stdin(config_fn_t fn, void *data,
1901 enum config_scope scope)
1903 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1904 data, scope, NULL);
1907 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1908 void *data, enum config_scope scope,
1909 const struct config_options *opts)
1911 int ret = -1;
1912 FILE *f;
1914 if (!filename)
1915 BUG("filename cannot be NULL");
1916 f = fopen_or_warn(filename, "r");
1917 if (f) {
1918 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1919 filename, f, data, scope, opts);
1920 fclose(f);
1922 return ret;
1925 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1927 return git_config_from_file_with_options(fn, filename, data,
1928 CONFIG_SCOPE_UNKNOWN, NULL);
1931 int git_config_from_mem(config_fn_t fn,
1932 const enum config_origin_type origin_type,
1933 const char *name, const char *buf, size_t len,
1934 void *data, enum config_scope scope,
1935 const struct config_options *opts)
1937 struct config_source top = CONFIG_SOURCE_INIT;
1939 top.u.buf.buf = buf;
1940 top.u.buf.len = len;
1941 top.u.buf.pos = 0;
1942 top.origin_type = origin_type;
1943 top.name = name;
1944 top.path = NULL;
1945 top.default_error_action = CONFIG_ERROR_ERROR;
1946 top.do_fgetc = config_buf_fgetc;
1947 top.do_ungetc = config_buf_ungetc;
1948 top.do_ftell = config_buf_ftell;
1950 return do_config_from(&top, fn, data, scope, opts);
1953 int git_config_from_blob_oid(config_fn_t fn,
1954 const char *name,
1955 struct repository *repo,
1956 const struct object_id *oid,
1957 void *data,
1958 enum config_scope scope)
1960 enum object_type type;
1961 char *buf;
1962 unsigned long size;
1963 int ret;
1965 buf = repo_read_object_file(repo, oid, &type, &size);
1966 if (!buf)
1967 return error(_("unable to load config blob object '%s'"), name);
1968 if (type != OBJ_BLOB) {
1969 free(buf);
1970 return error(_("reference '%s' does not point to a blob"), name);
1973 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1974 data, scope, NULL);
1975 free(buf);
1977 return ret;
1980 static int git_config_from_blob_ref(config_fn_t fn,
1981 struct repository *repo,
1982 const char *name,
1983 void *data,
1984 enum config_scope scope)
1986 struct object_id oid;
1988 if (repo_get_oid(repo, name, &oid) < 0)
1989 return error(_("unable to resolve config blob '%s'"), name);
1990 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
1993 char *git_system_config(void)
1995 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1996 if (!system_config)
1997 system_config = system_path(ETC_GITCONFIG);
1998 normalize_path_copy(system_config, system_config);
1999 return system_config;
2002 void git_global_config(char **user_out, char **xdg_out)
2004 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2005 char *xdg_config = NULL;
2007 if (!user_config) {
2008 user_config = interpolate_path("~/.gitconfig", 0);
2009 xdg_config = xdg_config_home("config");
2012 *user_out = user_config;
2013 *xdg_out = xdg_config;
2016 int git_config_system(void)
2018 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2021 static int do_git_config_sequence(const struct config_options *opts,
2022 const struct repository *repo,
2023 config_fn_t fn, void *data)
2025 int ret = 0;
2026 char *system_config = git_system_config();
2027 char *xdg_config = NULL;
2028 char *user_config = NULL;
2029 char *repo_config;
2030 char *worktree_config;
2033 * Ensure that either:
2034 * - the git_dir and commondir are both set, or
2035 * - the git_dir and commondir are both NULL
2037 if (!opts->git_dir != !opts->commondir)
2038 BUG("only one of commondir and git_dir is non-NULL");
2040 if (opts->commondir) {
2041 repo_config = mkpathdup("%s/config", opts->commondir);
2042 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2043 } else {
2044 repo_config = NULL;
2045 worktree_config = NULL;
2048 if (git_config_system() && system_config &&
2049 !access_or_die(system_config, R_OK,
2050 opts->system_gently ? ACCESS_EACCES_OK : 0))
2051 ret += git_config_from_file_with_options(fn, system_config,
2052 data, CONFIG_SCOPE_SYSTEM,
2053 NULL);
2055 git_global_config(&user_config, &xdg_config);
2057 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2058 ret += git_config_from_file_with_options(fn, xdg_config, data,
2059 CONFIG_SCOPE_GLOBAL, NULL);
2061 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2062 ret += git_config_from_file_with_options(fn, user_config, data,
2063 CONFIG_SCOPE_GLOBAL, NULL);
2065 if (!opts->ignore_repo && repo_config &&
2066 !access_or_die(repo_config, R_OK, 0))
2067 ret += git_config_from_file_with_options(fn, repo_config, data,
2068 CONFIG_SCOPE_LOCAL, NULL);
2070 if (!opts->ignore_worktree && worktree_config &&
2071 repo && repo->repository_format_worktree_config &&
2072 !access_or_die(worktree_config, R_OK, 0)) {
2073 ret += git_config_from_file_with_options(fn, worktree_config, data,
2074 CONFIG_SCOPE_WORKTREE,
2075 NULL);
2078 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2079 die(_("unable to parse command-line config"));
2081 free(system_config);
2082 free(xdg_config);
2083 free(user_config);
2084 free(repo_config);
2085 free(worktree_config);
2086 return ret;
2089 int config_with_options(config_fn_t fn, void *data,
2090 struct git_config_source *config_source,
2091 struct repository *repo,
2092 const struct config_options *opts)
2094 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2095 int ret;
2097 if (opts->respect_includes) {
2098 inc.fn = fn;
2099 inc.data = data;
2100 inc.opts = opts;
2101 inc.repo = repo;
2102 inc.config_source = config_source;
2103 fn = git_config_include;
2104 data = &inc;
2108 * If we have a specific filename, use it. Otherwise, follow the
2109 * regular lookup sequence.
2111 if (config_source && config_source->use_stdin) {
2112 ret = git_config_from_stdin(fn, data, config_source->scope);
2113 } else if (config_source && config_source->file) {
2114 ret = git_config_from_file_with_options(fn, config_source->file,
2115 data, config_source->scope,
2116 NULL);
2117 } else if (config_source && config_source->blob) {
2118 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2119 data, config_source->scope);
2120 } else {
2121 ret = do_git_config_sequence(opts, repo, fn, data);
2124 if (inc.remote_urls) {
2125 string_list_clear(inc.remote_urls, 0);
2126 FREE_AND_NULL(inc.remote_urls);
2128 return ret;
2131 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2133 int i, value_index;
2134 struct string_list *values;
2135 struct config_set_element *entry;
2136 struct configset_list *list = &set->list;
2137 struct config_context ctx = CONFIG_CONTEXT_INIT;
2139 for (i = 0; i < list->nr; i++) {
2140 entry = list->items[i].e;
2141 value_index = list->items[i].value_index;
2142 values = &entry->value_list;
2144 ctx.kvi = values->items[value_index].util;
2145 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2146 git_die_config_linenr(entry->key,
2147 ctx.kvi->filename,
2148 ctx.kvi->linenr);
2152 void read_early_config(config_fn_t cb, void *data)
2154 struct config_options opts = {0};
2155 struct strbuf commondir = STRBUF_INIT;
2156 struct strbuf gitdir = STRBUF_INIT;
2158 opts.respect_includes = 1;
2160 if (have_git_dir()) {
2161 opts.commondir = get_git_common_dir();
2162 opts.git_dir = get_git_dir();
2164 * When setup_git_directory() was not yet asked to discover the
2165 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2166 * is any repository config we should use (but unlike
2167 * setup_git_directory_gently(), no global state is changed, most
2168 * notably, the current working directory is still the same after the
2169 * call).
2171 } else if (!discover_git_directory(&commondir, &gitdir)) {
2172 opts.commondir = commondir.buf;
2173 opts.git_dir = gitdir.buf;
2176 config_with_options(cb, data, NULL, NULL, &opts);
2178 strbuf_release(&commondir);
2179 strbuf_release(&gitdir);
2183 * Read config but only enumerate system and global settings.
2184 * Omit any repo-local, worktree-local, or command-line settings.
2186 void read_very_early_config(config_fn_t cb, void *data)
2188 struct config_options opts = { 0 };
2190 opts.respect_includes = 1;
2191 opts.ignore_repo = 1;
2192 opts.ignore_worktree = 1;
2193 opts.ignore_cmdline = 1;
2194 opts.system_gently = 1;
2196 config_with_options(cb, data, NULL, NULL, &opts);
2199 RESULT_MUST_BE_USED
2200 static int configset_find_element(struct config_set *set, const char *key,
2201 struct config_set_element **dest)
2203 struct config_set_element k;
2204 struct config_set_element *found_entry;
2205 char *normalized_key;
2206 int ret;
2209 * `key` may come from the user, so normalize it before using it
2210 * for querying entries from the hashmap.
2212 ret = git_config_parse_key(key, &normalized_key, NULL);
2213 if (ret)
2214 return ret;
2216 hashmap_entry_init(&k.ent, strhash(normalized_key));
2217 k.key = normalized_key;
2218 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2219 free(normalized_key);
2220 *dest = found_entry;
2221 return 0;
2224 static int configset_add_value(const struct key_value_info *kvi_p,
2225 struct config_set *set, const char *key,
2226 const char *value)
2228 struct config_set_element *e;
2229 struct string_list_item *si;
2230 struct configset_list_item *l_item;
2231 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2232 int ret;
2234 ret = configset_find_element(set, key, &e);
2235 if (ret)
2236 return ret;
2238 * Since the keys are being fed by git_config*() callback mechanism, they
2239 * are already normalized. So simply add them without any further munging.
2241 if (!e) {
2242 e = xmalloc(sizeof(*e));
2243 hashmap_entry_init(&e->ent, strhash(key));
2244 e->key = xstrdup(key);
2245 string_list_init_dup(&e->value_list);
2246 hashmap_add(&set->config_hash, &e->ent);
2248 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2250 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2251 l_item = &set->list.items[set->list.nr++];
2252 l_item->e = e;
2253 l_item->value_index = e->value_list.nr - 1;
2255 *kv_info = *kvi_p;
2256 si->util = kv_info;
2258 return 0;
2261 static int config_set_element_cmp(const void *cmp_data UNUSED,
2262 const struct hashmap_entry *eptr,
2263 const struct hashmap_entry *entry_or_key,
2264 const void *keydata UNUSED)
2266 const struct config_set_element *e1, *e2;
2268 e1 = container_of(eptr, const struct config_set_element, ent);
2269 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2271 return strcmp(e1->key, e2->key);
2274 void git_configset_init(struct config_set *set)
2276 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2277 set->hash_initialized = 1;
2278 set->list.nr = 0;
2279 set->list.alloc = 0;
2280 set->list.items = NULL;
2283 void git_configset_clear(struct config_set *set)
2285 struct config_set_element *entry;
2286 struct hashmap_iter iter;
2287 if (!set->hash_initialized)
2288 return;
2290 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2291 ent /* member name */) {
2292 free(entry->key);
2293 string_list_clear(&entry->value_list, 1);
2295 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2296 set->hash_initialized = 0;
2297 free(set->list.items);
2298 set->list.nr = 0;
2299 set->list.alloc = 0;
2300 set->list.items = NULL;
2303 static int config_set_callback(const char *key, const char *value,
2304 const struct config_context *ctx,
2305 void *cb)
2307 struct config_set *set = cb;
2308 configset_add_value(ctx->kvi, set, key, value);
2309 return 0;
2312 int git_configset_add_file(struct config_set *set, const char *filename)
2314 return git_config_from_file(config_set_callback, filename, set);
2317 int git_configset_get_value(struct config_set *set, const char *key,
2318 const char **value, struct key_value_info *kvi)
2320 const struct string_list *values = NULL;
2321 int ret;
2322 struct string_list_item item;
2324 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2325 * queried key in the files of the configset, the value returned will be the last
2326 * value in the value list for that key.
2328 if ((ret = git_configset_get_value_multi(set, key, &values)))
2329 return ret;
2331 assert(values->nr > 0);
2332 item = values->items[values->nr - 1];
2333 *value = item.string;
2334 if (kvi)
2335 *kvi = *((struct key_value_info *)item.util);
2336 return 0;
2339 int git_configset_get_value_multi(struct config_set *set, const char *key,
2340 const struct string_list **dest)
2342 struct config_set_element *e;
2343 int ret;
2345 if ((ret = configset_find_element(set, key, &e)))
2346 return ret;
2347 else if (!e)
2348 return 1;
2349 *dest = &e->value_list;
2351 return 0;
2354 static int check_multi_string(struct string_list_item *item, void *util)
2356 return item->string ? 0 : config_error_nonbool(util);
2359 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2360 const struct string_list **dest)
2362 int ret;
2364 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2365 return ret;
2366 if ((ret = for_each_string_list((struct string_list *)*dest,
2367 check_multi_string, (void *)key)))
2368 return ret;
2370 return 0;
2373 int git_configset_get(struct config_set *set, const char *key)
2375 struct config_set_element *e;
2376 int ret;
2378 if ((ret = configset_find_element(set, key, &e)))
2379 return ret;
2380 else if (!e)
2381 return 1;
2382 return 0;
2385 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2387 const char *value;
2388 if (!git_configset_get_value(set, key, &value, NULL))
2389 return git_config_string((const char **)dest, key, value);
2390 else
2391 return 1;
2394 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2395 const char **dest)
2397 const char *value;
2398 if (!git_configset_get_value(set, key, &value, NULL)) {
2399 if (!value)
2400 return config_error_nonbool(key);
2401 *dest = value;
2402 return 0;
2403 } else {
2404 return 1;
2408 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2410 const char *value;
2411 struct key_value_info kvi;
2413 if (!git_configset_get_value(set, key, &value, &kvi)) {
2414 *dest = git_config_int(key, value, &kvi);
2415 return 0;
2416 } else
2417 return 1;
2420 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2422 const char *value;
2423 struct key_value_info kvi;
2425 if (!git_configset_get_value(set, key, &value, &kvi)) {
2426 *dest = git_config_ulong(key, value, &kvi);
2427 return 0;
2428 } else
2429 return 1;
2432 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2434 const char *value;
2435 if (!git_configset_get_value(set, key, &value, NULL)) {
2436 *dest = git_config_bool(key, value);
2437 return 0;
2438 } else
2439 return 1;
2442 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2443 int *is_bool, int *dest)
2445 const char *value;
2446 struct key_value_info kvi;
2448 if (!git_configset_get_value(set, key, &value, &kvi)) {
2449 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2450 return 0;
2451 } else
2452 return 1;
2455 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2457 const char *value;
2458 if (!git_configset_get_value(set, key, &value, NULL)) {
2459 *dest = git_parse_maybe_bool(value);
2460 if (*dest == -1)
2461 return -1;
2462 return 0;
2463 } else
2464 return 1;
2467 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2469 const char *value;
2470 if (!git_configset_get_value(set, key, &value, NULL))
2471 return git_config_pathname(dest, key, value);
2472 else
2473 return 1;
2476 /* Functions use to read configuration from a repository */
2477 static void repo_read_config(struct repository *repo)
2479 struct config_options opts = { 0 };
2481 opts.respect_includes = 1;
2482 opts.commondir = repo->commondir;
2483 opts.git_dir = repo->gitdir;
2485 if (!repo->config)
2486 CALLOC_ARRAY(repo->config, 1);
2487 else
2488 git_configset_clear(repo->config);
2490 git_configset_init(repo->config);
2491 if (config_with_options(config_set_callback, repo->config, NULL,
2492 repo, &opts) < 0)
2494 * config_with_options() normally returns only
2495 * zero, as most errors are fatal, and
2496 * non-fatal potential errors are guarded by "if"
2497 * statements that are entered only when no error is
2498 * possible.
2500 * If we ever encounter a non-fatal error, it means
2501 * something went really wrong and we should stop
2502 * immediately.
2504 die(_("unknown error occurred while reading the configuration files"));
2507 static void git_config_check_init(struct repository *repo)
2509 if (repo->config && repo->config->hash_initialized)
2510 return;
2511 repo_read_config(repo);
2514 static void repo_config_clear(struct repository *repo)
2516 if (!repo->config || !repo->config->hash_initialized)
2517 return;
2518 git_configset_clear(repo->config);
2521 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2523 git_config_check_init(repo);
2524 configset_iter(repo->config, fn, data);
2527 int repo_config_get(struct repository *repo, const char *key)
2529 git_config_check_init(repo);
2530 return git_configset_get(repo->config, key);
2533 int repo_config_get_value(struct repository *repo,
2534 const char *key, const char **value)
2536 git_config_check_init(repo);
2537 return git_configset_get_value(repo->config, key, value, NULL);
2540 int repo_config_get_value_multi(struct repository *repo, const char *key,
2541 const struct string_list **dest)
2543 git_config_check_init(repo);
2544 return git_configset_get_value_multi(repo->config, key, dest);
2547 int repo_config_get_string_multi(struct repository *repo, const char *key,
2548 const struct string_list **dest)
2550 git_config_check_init(repo);
2551 return git_configset_get_string_multi(repo->config, key, dest);
2554 int repo_config_get_string(struct repository *repo,
2555 const char *key, char **dest)
2557 int ret;
2558 git_config_check_init(repo);
2559 ret = git_configset_get_string(repo->config, key, dest);
2560 if (ret < 0)
2561 git_die_config(key, NULL);
2562 return ret;
2565 int repo_config_get_string_tmp(struct repository *repo,
2566 const char *key, const char **dest)
2568 int ret;
2569 git_config_check_init(repo);
2570 ret = git_configset_get_string_tmp(repo->config, key, dest);
2571 if (ret < 0)
2572 git_die_config(key, NULL);
2573 return ret;
2576 int repo_config_get_int(struct repository *repo,
2577 const char *key, int *dest)
2579 git_config_check_init(repo);
2580 return git_configset_get_int(repo->config, key, dest);
2583 int repo_config_get_ulong(struct repository *repo,
2584 const char *key, unsigned long *dest)
2586 git_config_check_init(repo);
2587 return git_configset_get_ulong(repo->config, key, dest);
2590 int repo_config_get_bool(struct repository *repo,
2591 const char *key, int *dest)
2593 git_config_check_init(repo);
2594 return git_configset_get_bool(repo->config, key, dest);
2597 int repo_config_get_bool_or_int(struct repository *repo,
2598 const char *key, int *is_bool, int *dest)
2600 git_config_check_init(repo);
2601 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2604 int repo_config_get_maybe_bool(struct repository *repo,
2605 const char *key, int *dest)
2607 git_config_check_init(repo);
2608 return git_configset_get_maybe_bool(repo->config, key, dest);
2611 int repo_config_get_pathname(struct repository *repo,
2612 const char *key, const char **dest)
2614 int ret;
2615 git_config_check_init(repo);
2616 ret = git_configset_get_pathname(repo->config, key, dest);
2617 if (ret < 0)
2618 git_die_config(key, NULL);
2619 return ret;
2622 /* Read values into protected_config. */
2623 static void read_protected_config(void)
2625 struct config_options opts = {
2626 .respect_includes = 1,
2627 .ignore_repo = 1,
2628 .ignore_worktree = 1,
2629 .system_gently = 1,
2632 git_configset_init(&protected_config);
2633 config_with_options(config_set_callback, &protected_config, NULL,
2634 NULL, &opts);
2637 void git_protected_config(config_fn_t fn, void *data)
2639 if (!protected_config.hash_initialized)
2640 read_protected_config();
2641 configset_iter(&protected_config, fn, data);
2644 /* Functions used historically to read configuration from 'the_repository' */
2645 void git_config(config_fn_t fn, void *data)
2647 repo_config(the_repository, fn, data);
2650 void git_config_clear(void)
2652 repo_config_clear(the_repository);
2655 int git_config_get(const char *key)
2657 return repo_config_get(the_repository, key);
2660 int git_config_get_value(const char *key, const char **value)
2662 return repo_config_get_value(the_repository, key, value);
2665 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2667 return repo_config_get_value_multi(the_repository, key, dest);
2670 int git_config_get_string_multi(const char *key,
2671 const struct string_list **dest)
2673 return repo_config_get_string_multi(the_repository, key, dest);
2676 int git_config_get_string(const char *key, char **dest)
2678 return repo_config_get_string(the_repository, key, dest);
2681 int git_config_get_string_tmp(const char *key, const char **dest)
2683 return repo_config_get_string_tmp(the_repository, key, dest);
2686 int git_config_get_int(const char *key, int *dest)
2688 return repo_config_get_int(the_repository, key, dest);
2691 int git_config_get_ulong(const char *key, unsigned long *dest)
2693 return repo_config_get_ulong(the_repository, key, dest);
2696 int git_config_get_bool(const char *key, int *dest)
2698 return repo_config_get_bool(the_repository, key, dest);
2701 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2703 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2706 int git_config_get_maybe_bool(const char *key, int *dest)
2708 return repo_config_get_maybe_bool(the_repository, key, dest);
2711 int git_config_get_pathname(const char *key, const char **dest)
2713 return repo_config_get_pathname(the_repository, key, dest);
2716 int git_config_get_expiry(const char *key, const char **output)
2718 int ret = git_config_get_string(key, (char **)output);
2719 if (ret)
2720 return ret;
2721 if (strcmp(*output, "now")) {
2722 timestamp_t now = approxidate("now");
2723 if (approxidate(*output) >= now)
2724 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2726 return ret;
2729 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2731 const char *expiry_string;
2732 intmax_t days;
2733 timestamp_t when;
2735 if (git_config_get_string_tmp(key, &expiry_string))
2736 return 1; /* no such thing */
2738 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2739 const int scale = 86400;
2740 *expiry = now - days * scale;
2741 return 0;
2744 if (!parse_expiry_date(expiry_string, &when)) {
2745 *expiry = when;
2746 return 0;
2748 return -1; /* thing exists but cannot be parsed */
2751 int git_config_get_split_index(void)
2753 int val;
2755 if (!git_config_get_maybe_bool("core.splitindex", &val))
2756 return val;
2758 return -1; /* default value */
2761 int git_config_get_max_percent_split_change(void)
2763 int val = -1;
2765 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2766 if (0 <= val && val <= 100)
2767 return val;
2769 return error(_("splitIndex.maxPercentChange value '%d' "
2770 "should be between 0 and 100"), val);
2773 return -1; /* default value */
2776 int git_config_get_index_threads(int *dest)
2778 int is_bool, val;
2780 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2781 if (val) {
2782 *dest = val;
2783 return 0;
2786 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2787 if (is_bool)
2788 *dest = val ? 0 : 1;
2789 else
2790 *dest = val;
2791 return 0;
2794 return 1;
2797 NORETURN
2798 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2800 if (!filename)
2801 die(_("unable to parse '%s' from command-line config"), key);
2802 else
2803 die(_("bad config variable '%s' in file '%s' at line %d"),
2804 key, filename, linenr);
2807 NORETURN __attribute__((format(printf, 2, 3)))
2808 void git_die_config(const char *key, const char *err, ...)
2810 const struct string_list *values;
2811 struct key_value_info *kv_info;
2812 report_fn error_fn = get_error_routine();
2814 if (err) {
2815 va_list params;
2816 va_start(params, err);
2817 error_fn(err, params);
2818 va_end(params);
2820 if (git_config_get_value_multi(key, &values))
2821 BUG("for key '%s' we must have a value to report on", key);
2822 kv_info = values->items[values->nr - 1].util;
2823 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2827 * Find all the stuff for git_config_set() below.
2830 struct config_store_data {
2831 size_t baselen;
2832 char *key;
2833 int do_not_match;
2834 const char *fixed_value;
2835 regex_t *value_pattern;
2836 int multi_replace;
2837 struct {
2838 size_t begin, end;
2839 enum config_event_t type;
2840 int is_keys_section;
2841 } *parsed;
2842 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2843 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2845 #define CONFIG_STORE_INIT { 0 }
2847 static void config_store_data_clear(struct config_store_data *store)
2849 free(store->key);
2850 if (store->value_pattern != NULL &&
2851 store->value_pattern != CONFIG_REGEX_NONE) {
2852 regfree(store->value_pattern);
2853 free(store->value_pattern);
2855 free(store->parsed);
2856 free(store->seen);
2857 memset(store, 0, sizeof(*store));
2860 static int matches(const char *key, const char *value,
2861 const struct config_store_data *store)
2863 if (strcmp(key, store->key))
2864 return 0; /* not ours */
2865 if (store->fixed_value)
2866 return !strcmp(store->fixed_value, value);
2867 if (!store->value_pattern)
2868 return 1; /* always matches */
2869 if (store->value_pattern == CONFIG_REGEX_NONE)
2870 return 0; /* never matches */
2872 return store->do_not_match ^
2873 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2876 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2877 struct config_source *cs, void *data)
2879 struct config_store_data *store = data;
2881 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2882 store->parsed[store->parsed_nr].begin = begin;
2883 store->parsed[store->parsed_nr].end = end;
2884 store->parsed[store->parsed_nr].type = type;
2886 if (type == CONFIG_EVENT_SECTION) {
2887 int (*cmpfn)(const char *, const char *, size_t);
2889 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2890 return error(_("invalid section name '%s'"), cs->var.buf);
2892 if (cs->subsection_case_sensitive)
2893 cmpfn = strncasecmp;
2894 else
2895 cmpfn = strncmp;
2897 /* Is this the section we were looking for? */
2898 store->is_keys_section =
2899 store->parsed[store->parsed_nr].is_keys_section =
2900 cs->var.len - 1 == store->baselen &&
2901 !cmpfn(cs->var.buf, store->key, store->baselen);
2902 if (store->is_keys_section) {
2903 store->section_seen = 1;
2904 ALLOC_GROW(store->seen, store->seen_nr + 1,
2905 store->seen_alloc);
2906 store->seen[store->seen_nr] = store->parsed_nr;
2910 store->parsed_nr++;
2912 return 0;
2915 static int store_aux(const char *key, const char *value,
2916 const struct config_context *ctx UNUSED, void *cb)
2918 struct config_store_data *store = cb;
2920 if (store->key_seen) {
2921 if (matches(key, value, store)) {
2922 if (store->seen_nr == 1 && store->multi_replace == 0) {
2923 warning(_("%s has multiple values"), key);
2926 ALLOC_GROW(store->seen, store->seen_nr + 1,
2927 store->seen_alloc);
2929 store->seen[store->seen_nr] = store->parsed_nr;
2930 store->seen_nr++;
2932 } else if (store->is_keys_section) {
2934 * Do not increment matches yet: this may not be a match, but we
2935 * are in the desired section.
2937 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2938 store->seen[store->seen_nr] = store->parsed_nr;
2939 store->section_seen = 1;
2941 if (matches(key, value, store)) {
2942 store->seen_nr++;
2943 store->key_seen = 1;
2947 return 0;
2950 static int write_error(const char *filename)
2952 error(_("failed to write new configuration file %s"), filename);
2954 /* Same error code as "failed to rename". */
2955 return 4;
2958 static struct strbuf store_create_section(const char *key,
2959 const struct config_store_data *store)
2961 const char *dot;
2962 size_t i;
2963 struct strbuf sb = STRBUF_INIT;
2965 dot = memchr(key, '.', store->baselen);
2966 if (dot) {
2967 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2968 for (i = dot - key + 1; i < store->baselen; i++) {
2969 if (key[i] == '"' || key[i] == '\\')
2970 strbuf_addch(&sb, '\\');
2971 strbuf_addch(&sb, key[i]);
2973 strbuf_addstr(&sb, "\"]\n");
2974 } else {
2975 strbuf_addch(&sb, '[');
2976 strbuf_add(&sb, key, store->baselen);
2977 strbuf_addstr(&sb, "]\n");
2980 return sb;
2983 static ssize_t write_section(int fd, const char *key,
2984 const struct config_store_data *store)
2986 struct strbuf sb = store_create_section(key, store);
2987 ssize_t ret;
2989 ret = write_in_full(fd, sb.buf, sb.len);
2990 strbuf_release(&sb);
2992 return ret;
2995 static ssize_t write_pair(int fd, const char *key, const char *value,
2996 const struct config_store_data *store)
2998 int i;
2999 ssize_t ret;
3000 const char *quote = "";
3001 struct strbuf sb = STRBUF_INIT;
3004 * Check to see if the value needs to be surrounded with a dq pair.
3005 * Note that problematic characters are always backslash-quoted; this
3006 * check is about not losing leading or trailing SP and strings that
3007 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3008 * configuration parser.
3010 if (value[0] == ' ')
3011 quote = "\"";
3012 for (i = 0; value[i]; i++)
3013 if (value[i] == ';' || value[i] == '#')
3014 quote = "\"";
3015 if (i && value[i - 1] == ' ')
3016 quote = "\"";
3018 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3020 for (i = 0; value[i]; i++)
3021 switch (value[i]) {
3022 case '\n':
3023 strbuf_addstr(&sb, "\\n");
3024 break;
3025 case '\t':
3026 strbuf_addstr(&sb, "\\t");
3027 break;
3028 case '"':
3029 case '\\':
3030 strbuf_addch(&sb, '\\');
3031 /* fallthrough */
3032 default:
3033 strbuf_addch(&sb, value[i]);
3034 break;
3036 strbuf_addf(&sb, "%s\n", quote);
3038 ret = write_in_full(fd, sb.buf, sb.len);
3039 strbuf_release(&sb);
3041 return ret;
3045 * If we are about to unset the last key(s) in a section, and if there are
3046 * no comments surrounding (or included in) the section, we will want to
3047 * extend begin/end to remove the entire section.
3049 * Note: the parameter `seen_ptr` points to the index into the store.seen
3050 * array. * This index may be incremented if a section has more than one
3051 * entry (which all are to be removed).
3053 static void maybe_remove_section(struct config_store_data *store,
3054 size_t *begin_offset, size_t *end_offset,
3055 int *seen_ptr)
3057 size_t begin;
3058 int i, seen, section_seen = 0;
3061 * First, ensure that this is the first key, and that there are no
3062 * comments before the entry nor before the section header.
3064 seen = *seen_ptr;
3065 for (i = store->seen[seen]; i > 0; i--) {
3066 enum config_event_t type = store->parsed[i - 1].type;
3068 if (type == CONFIG_EVENT_COMMENT)
3069 /* There is a comment before this entry or section */
3070 return;
3071 if (type == CONFIG_EVENT_ENTRY) {
3072 if (!section_seen)
3073 /* This is not the section's first entry. */
3074 return;
3075 /* We encountered no comment before the section. */
3076 break;
3078 if (type == CONFIG_EVENT_SECTION) {
3079 if (!store->parsed[i - 1].is_keys_section)
3080 break;
3081 section_seen = 1;
3084 begin = store->parsed[i].begin;
3087 * Next, make sure that we are removing the last key(s) in the section,
3088 * and that there are no comments that are possibly about the current
3089 * section.
3091 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3092 enum config_event_t type = store->parsed[i].type;
3094 if (type == CONFIG_EVENT_COMMENT)
3095 return;
3096 if (type == CONFIG_EVENT_SECTION) {
3097 if (store->parsed[i].is_keys_section)
3098 continue;
3099 break;
3101 if (type == CONFIG_EVENT_ENTRY) {
3102 if (++seen < store->seen_nr &&
3103 i == store->seen[seen])
3104 /* We want to remove this entry, too */
3105 continue;
3106 /* There is another entry in this section. */
3107 return;
3112 * We are really removing the last entry/entries from this section, and
3113 * there are no enclosed or surrounding comments. Remove the entire,
3114 * now-empty section.
3116 *seen_ptr = seen;
3117 *begin_offset = begin;
3118 if (i < store->parsed_nr)
3119 *end_offset = store->parsed[i].begin;
3120 else
3121 *end_offset = store->parsed[store->parsed_nr - 1].end;
3124 int git_config_set_in_file_gently(const char *config_filename,
3125 const char *key, const char *value)
3127 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3130 void git_config_set_in_file(const char *config_filename,
3131 const char *key, const char *value)
3133 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3136 int git_config_set_gently(const char *key, const char *value)
3138 return git_config_set_multivar_gently(key, value, NULL, 0);
3141 int repo_config_set_worktree_gently(struct repository *r,
3142 const char *key, const char *value)
3144 /* Only use worktree-specific config if it is already enabled. */
3145 if (r->repository_format_worktree_config) {
3146 char *file = repo_git_path(r, "config.worktree");
3147 int ret = git_config_set_multivar_in_file_gently(
3148 file, key, value, NULL, 0);
3149 free(file);
3150 return ret;
3152 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3155 void git_config_set(const char *key, const char *value)
3157 git_config_set_multivar(key, value, NULL, 0);
3159 trace2_cmd_set_config(key, value);
3163 * If value==NULL, unset in (remove from) config,
3164 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3165 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3166 * (only add a new one)
3167 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3168 * key/values are removed before a single new pair is written. If the
3169 * flag is not present, then replace only the first match.
3171 * Returns 0 on success.
3173 * This function does this:
3175 * - it locks the config file by creating ".git/config.lock"
3177 * - it then parses the config using store_aux() as validator to find
3178 * the position on the key/value pair to replace. If it is to be unset,
3179 * it must be found exactly once.
3181 * - the config file is mmap()ed and the part before the match (if any) is
3182 * written to the lock file, then the changed part and the rest.
3184 * - the config file is removed and the lock file rename()d to it.
3187 int git_config_set_multivar_in_file_gently(const char *config_filename,
3188 const char *key, const char *value,
3189 const char *value_pattern,
3190 unsigned flags)
3192 int fd = -1, in_fd = -1;
3193 int ret;
3194 struct lock_file lock = LOCK_INIT;
3195 char *filename_buf = NULL;
3196 char *contents = NULL;
3197 size_t contents_sz;
3198 struct config_store_data store = CONFIG_STORE_INIT;
3200 /* parse-key returns negative; flip the sign to feed exit(3) */
3201 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3202 if (ret)
3203 goto out_free;
3205 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3207 if (!config_filename)
3208 config_filename = filename_buf = git_pathdup("config");
3211 * The lock serves a purpose in addition to locking: the new
3212 * contents of .git/config will be written into it.
3214 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3215 if (fd < 0) {
3216 error_errno(_("could not lock config file %s"), config_filename);
3217 ret = CONFIG_NO_LOCK;
3218 goto out_free;
3222 * If .git/config does not exist yet, write a minimal version.
3224 in_fd = open(config_filename, O_RDONLY);
3225 if ( in_fd < 0 ) {
3226 if ( ENOENT != errno ) {
3227 error_errno(_("opening %s"), config_filename);
3228 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3229 goto out_free;
3231 /* if nothing to unset, error out */
3232 if (!value) {
3233 ret = CONFIG_NOTHING_SET;
3234 goto out_free;
3237 free(store.key);
3238 store.key = xstrdup(key);
3239 if (write_section(fd, key, &store) < 0 ||
3240 write_pair(fd, key, value, &store) < 0)
3241 goto write_err_out;
3242 } else {
3243 struct stat st;
3244 size_t copy_begin, copy_end;
3245 int i, new_line = 0;
3246 struct config_options opts;
3248 if (!value_pattern)
3249 store.value_pattern = NULL;
3250 else if (value_pattern == CONFIG_REGEX_NONE)
3251 store.value_pattern = CONFIG_REGEX_NONE;
3252 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3253 store.fixed_value = value_pattern;
3254 else {
3255 if (value_pattern[0] == '!') {
3256 store.do_not_match = 1;
3257 value_pattern++;
3258 } else
3259 store.do_not_match = 0;
3261 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3262 if (regcomp(store.value_pattern, value_pattern,
3263 REG_EXTENDED)) {
3264 error(_("invalid pattern: %s"), value_pattern);
3265 FREE_AND_NULL(store.value_pattern);
3266 ret = CONFIG_INVALID_PATTERN;
3267 goto out_free;
3271 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3272 store.parsed[0].end = 0;
3274 memset(&opts, 0, sizeof(opts));
3275 opts.event_fn = store_aux_event;
3276 opts.event_fn_data = &store;
3279 * After this, store.parsed will contain offsets of all the
3280 * parsed elements, and store.seen will contain a list of
3281 * matches, as indices into store.parsed.
3283 * As a side effect, we make sure to transform only a valid
3284 * existing config file.
3286 if (git_config_from_file_with_options(store_aux,
3287 config_filename,
3288 &store, CONFIG_SCOPE_UNKNOWN,
3289 &opts)) {
3290 error(_("invalid config file %s"), config_filename);
3291 ret = CONFIG_INVALID_FILE;
3292 goto out_free;
3295 /* if nothing to unset, or too many matches, error out */
3296 if ((store.seen_nr == 0 && value == NULL) ||
3297 (store.seen_nr > 1 && !store.multi_replace)) {
3298 ret = CONFIG_NOTHING_SET;
3299 goto out_free;
3302 if (fstat(in_fd, &st) == -1) {
3303 error_errno(_("fstat on %s failed"), config_filename);
3304 ret = CONFIG_INVALID_FILE;
3305 goto out_free;
3308 contents_sz = xsize_t(st.st_size);
3309 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3310 MAP_PRIVATE, in_fd, 0);
3311 if (contents == MAP_FAILED) {
3312 if (errno == ENODEV && S_ISDIR(st.st_mode))
3313 errno = EISDIR;
3314 error_errno(_("unable to mmap '%s'%s"),
3315 config_filename, mmap_os_err());
3316 ret = CONFIG_INVALID_FILE;
3317 contents = NULL;
3318 goto out_free;
3320 close(in_fd);
3321 in_fd = -1;
3323 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3324 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3325 ret = CONFIG_NO_WRITE;
3326 goto out_free;
3329 if (store.seen_nr == 0) {
3330 if (!store.seen_alloc) {
3331 /* Did not see key nor section */
3332 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3333 store.seen[0] = store.parsed_nr
3334 - !!store.parsed_nr;
3336 store.seen_nr = 1;
3339 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3340 size_t replace_end;
3341 int j = store.seen[i];
3343 new_line = 0;
3344 if (!store.key_seen) {
3345 copy_end = store.parsed[j].end;
3346 /* include '\n' when copying section header */
3347 if (copy_end > 0 && copy_end < contents_sz &&
3348 contents[copy_end - 1] != '\n' &&
3349 contents[copy_end] == '\n')
3350 copy_end++;
3351 replace_end = copy_end;
3352 } else {
3353 replace_end = store.parsed[j].end;
3354 copy_end = store.parsed[j].begin;
3355 if (!value)
3356 maybe_remove_section(&store,
3357 &copy_end,
3358 &replace_end, &i);
3360 * Swallow preceding white-space on the same
3361 * line.
3363 while (copy_end > 0 ) {
3364 char c = contents[copy_end - 1];
3366 if (isspace(c) && c != '\n')
3367 copy_end--;
3368 else
3369 break;
3373 if (copy_end > 0 && contents[copy_end-1] != '\n')
3374 new_line = 1;
3376 /* write the first part of the config */
3377 if (copy_end > copy_begin) {
3378 if (write_in_full(fd, contents + copy_begin,
3379 copy_end - copy_begin) < 0)
3380 goto write_err_out;
3381 if (new_line &&
3382 write_str_in_full(fd, "\n") < 0)
3383 goto write_err_out;
3385 copy_begin = replace_end;
3388 /* write the pair (value == NULL means unset) */
3389 if (value) {
3390 if (!store.section_seen) {
3391 if (write_section(fd, key, &store) < 0)
3392 goto write_err_out;
3394 if (write_pair(fd, key, value, &store) < 0)
3395 goto write_err_out;
3398 /* write the rest of the config */
3399 if (copy_begin < contents_sz)
3400 if (write_in_full(fd, contents + copy_begin,
3401 contents_sz - copy_begin) < 0)
3402 goto write_err_out;
3404 munmap(contents, contents_sz);
3405 contents = NULL;
3408 if (commit_lock_file(&lock) < 0) {
3409 error_errno(_("could not write config file %s"), config_filename);
3410 ret = CONFIG_NO_WRITE;
3411 goto out_free;
3414 ret = 0;
3416 /* Invalidate the config cache */
3417 git_config_clear();
3419 out_free:
3420 rollback_lock_file(&lock);
3421 free(filename_buf);
3422 if (contents)
3423 munmap(contents, contents_sz);
3424 if (in_fd >= 0)
3425 close(in_fd);
3426 config_store_data_clear(&store);
3427 return ret;
3429 write_err_out:
3430 ret = write_error(get_lock_file_path(&lock));
3431 goto out_free;
3435 void git_config_set_multivar_in_file(const char *config_filename,
3436 const char *key, const char *value,
3437 const char *value_pattern, unsigned flags)
3439 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3440 value_pattern, flags))
3441 return;
3442 if (value)
3443 die(_("could not set '%s' to '%s'"), key, value);
3444 else
3445 die(_("could not unset '%s'"), key);
3448 int git_config_set_multivar_gently(const char *key, const char *value,
3449 const char *value_pattern, unsigned flags)
3451 return repo_config_set_multivar_gently(the_repository, key, value,
3452 value_pattern, flags);
3455 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3456 const char *value,
3457 const char *value_pattern, unsigned flags)
3459 char *file = repo_git_path(r, "config");
3460 int res = git_config_set_multivar_in_file_gently(file,
3461 key, value,
3462 value_pattern,
3463 flags);
3464 free(file);
3465 return res;
3468 void git_config_set_multivar(const char *key, const char *value,
3469 const char *value_pattern, unsigned flags)
3471 git_config_set_multivar_in_file(git_path("config"),
3472 key, value, value_pattern,
3473 flags);
3476 static size_t section_name_match (const char *buf, const char *name)
3478 size_t i = 0, j = 0;
3479 int dot = 0;
3480 if (buf[i] != '[')
3481 return 0;
3482 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3483 if (!dot && isspace(buf[i])) {
3484 dot = 1;
3485 if (name[j++] != '.')
3486 break;
3487 for (i++; isspace(buf[i]); i++)
3488 ; /* do nothing */
3489 if (buf[i] != '"')
3490 break;
3491 continue;
3493 if (buf[i] == '\\' && dot)
3494 i++;
3495 else if (buf[i] == '"' && dot) {
3496 for (i++; isspace(buf[i]); i++)
3497 ; /* do_nothing */
3498 break;
3500 if (buf[i] != name[j++])
3501 break;
3503 if (buf[i] == ']' && name[j] == 0) {
3505 * We match, now just find the right length offset by
3506 * gobbling up any whitespace after it, as well
3508 i++;
3509 for (; buf[i] && isspace(buf[i]); i++)
3510 ; /* do nothing */
3511 return i;
3513 return 0;
3516 static int section_name_is_ok(const char *name)
3518 /* Empty section names are bogus. */
3519 if (!*name)
3520 return 0;
3523 * Before a dot, we must be alphanumeric or dash. After the first dot,
3524 * anything goes, so we can stop checking.
3526 for (; *name && *name != '.'; name++)
3527 if (*name != '-' && !isalnum(*name))
3528 return 0;
3529 return 1;
3532 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3534 /* if new_name == NULL, the section is removed instead */
3535 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3536 const char *old_name,
3537 const char *new_name, int copy)
3539 int ret = 0, remove = 0;
3540 char *filename_buf = NULL;
3541 struct lock_file lock = LOCK_INIT;
3542 int out_fd;
3543 struct strbuf buf = STRBUF_INIT;
3544 FILE *config_file = NULL;
3545 struct stat st;
3546 struct strbuf copystr = STRBUF_INIT;
3547 struct config_store_data store;
3548 uint32_t line_nr = 0;
3550 memset(&store, 0, sizeof(store));
3552 if (new_name && !section_name_is_ok(new_name)) {
3553 ret = error(_("invalid section name: %s"), new_name);
3554 goto out_no_rollback;
3557 if (!config_filename)
3558 config_filename = filename_buf = git_pathdup("config");
3560 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3561 if (out_fd < 0) {
3562 ret = error(_("could not lock config file %s"), config_filename);
3563 goto out;
3566 if (!(config_file = fopen(config_filename, "rb"))) {
3567 ret = warn_on_fopen_errors(config_filename);
3568 if (ret)
3569 goto out;
3570 /* no config file means nothing to rename, no error */
3571 goto commit_and_out;
3574 if (fstat(fileno(config_file), &st) == -1) {
3575 ret = error_errno(_("fstat on %s failed"), config_filename);
3576 goto out;
3579 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3580 ret = error_errno(_("chmod on %s failed"),
3581 get_lock_file_path(&lock));
3582 goto out;
3585 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3586 size_t i, length;
3587 int is_section = 0;
3588 char *output = buf.buf;
3590 line_nr++;
3592 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3593 ret = error(_("refusing to work with overly long line "
3594 "in '%s' on line %"PRIuMAX),
3595 config_filename, (uintmax_t)line_nr);
3596 goto out;
3599 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3600 ; /* do nothing */
3601 if (buf.buf[i] == '[') {
3602 /* it's a section */
3603 size_t offset;
3604 is_section = 1;
3607 * When encountering a new section under -c we
3608 * need to flush out any section we're already
3609 * coping and begin anew. There might be
3610 * multiple [branch "$name"] sections.
3612 if (copystr.len > 0) {
3613 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3614 ret = write_error(get_lock_file_path(&lock));
3615 goto out;
3617 strbuf_reset(&copystr);
3620 offset = section_name_match(&buf.buf[i], old_name);
3621 if (offset > 0) {
3622 ret++;
3623 if (!new_name) {
3624 remove = 1;
3625 continue;
3627 store.baselen = strlen(new_name);
3628 if (!copy) {
3629 if (write_section(out_fd, new_name, &store) < 0) {
3630 ret = write_error(get_lock_file_path(&lock));
3631 goto out;
3634 * We wrote out the new section, with
3635 * a newline, now skip the old
3636 * section's length
3638 output += offset + i;
3639 if (strlen(output) > 0) {
3641 * More content means there's
3642 * a declaration to put on the
3643 * next line; indent with a
3644 * tab
3646 output -= 1;
3647 output[0] = '\t';
3649 } else {
3650 strbuf_release(&copystr);
3651 copystr = store_create_section(new_name, &store);
3654 remove = 0;
3656 if (remove)
3657 continue;
3658 length = strlen(output);
3660 if (!is_section && copystr.len > 0) {
3661 strbuf_add(&copystr, output, length);
3664 if (write_in_full(out_fd, output, length) < 0) {
3665 ret = write_error(get_lock_file_path(&lock));
3666 goto out;
3671 * Copy a trailing section at the end of the config, won't be
3672 * flushed by the usual "flush because we have a new section
3673 * logic in the loop above.
3675 if (copystr.len > 0) {
3676 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3677 ret = write_error(get_lock_file_path(&lock));
3678 goto out;
3680 strbuf_reset(&copystr);
3683 fclose(config_file);
3684 config_file = NULL;
3685 commit_and_out:
3686 if (commit_lock_file(&lock) < 0)
3687 ret = error_errno(_("could not write config file %s"),
3688 config_filename);
3689 out:
3690 if (config_file)
3691 fclose(config_file);
3692 rollback_lock_file(&lock);
3693 out_no_rollback:
3694 free(filename_buf);
3695 config_store_data_clear(&store);
3696 strbuf_release(&buf);
3697 strbuf_release(&copystr);
3698 return ret;
3701 int git_config_rename_section_in_file(const char *config_filename,
3702 const char *old_name, const char *new_name)
3704 return git_config_copy_or_rename_section_in_file(config_filename,
3705 old_name, new_name, 0);
3708 int git_config_rename_section(const char *old_name, const char *new_name)
3710 return git_config_rename_section_in_file(NULL, old_name, new_name);
3713 int git_config_copy_section_in_file(const char *config_filename,
3714 const char *old_name, const char *new_name)
3716 return git_config_copy_or_rename_section_in_file(config_filename,
3717 old_name, new_name, 1);
3720 int git_config_copy_section(const char *old_name, const char *new_name)
3722 return git_config_copy_section_in_file(NULL, old_name, new_name);
3726 * Call this to report error for your variable that should not
3727 * get a boolean value (i.e. "[my] var" means "true").
3729 #undef config_error_nonbool
3730 int config_error_nonbool(const char *var)
3732 return error(_("missing value for '%s'"), var);
3735 int parse_config_key(const char *var,
3736 const char *section,
3737 const char **subsection, size_t *subsection_len,
3738 const char **key)
3740 const char *dot;
3742 /* Does it start with "section." ? */
3743 if (!skip_prefix(var, section, &var) || *var != '.')
3744 return -1;
3747 * Find the key; we don't know yet if we have a subsection, but we must
3748 * parse backwards from the end, since the subsection may have dots in
3749 * it, too.
3751 dot = strrchr(var, '.');
3752 *key = dot + 1;
3754 /* Did we have a subsection at all? */
3755 if (dot == var) {
3756 if (subsection) {
3757 *subsection = NULL;
3758 *subsection_len = 0;
3761 else {
3762 if (!subsection)
3763 return -1;
3764 *subsection = var + 1;
3765 *subsection_len = dot - *subsection;
3768 return 0;
3771 const char *config_origin_type_name(enum config_origin_type type)
3773 switch (type) {
3774 case CONFIG_ORIGIN_BLOB:
3775 return "blob";
3776 case CONFIG_ORIGIN_FILE:
3777 return "file";
3778 case CONFIG_ORIGIN_STDIN:
3779 return "standard input";
3780 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3781 return "submodule-blob";
3782 case CONFIG_ORIGIN_CMDLINE:
3783 return "command line";
3784 default:
3785 BUG("unknown config origin type");
3789 const char *config_scope_name(enum config_scope scope)
3791 switch (scope) {
3792 case CONFIG_SCOPE_SYSTEM:
3793 return "system";
3794 case CONFIG_SCOPE_GLOBAL:
3795 return "global";
3796 case CONFIG_SCOPE_LOCAL:
3797 return "local";
3798 case CONFIG_SCOPE_WORKTREE:
3799 return "worktree";
3800 case CONFIG_SCOPE_COMMAND:
3801 return "command";
3802 case CONFIG_SCOPE_SUBMODULE:
3803 return "submodule";
3804 default:
3805 return "unknown";
3809 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3811 int i;
3813 for (i = 0; i < nr_mapping; i++) {
3814 const char *name = mapping[i];
3816 if (name && !strcasecmp(var, name))
3817 return i;
3819 return -1;