Merge branch 'rs/unit-tests-test-run'
[git/gitster.git] / config.c
blob05f369ec0d88761335ee1621500a85e7588e6d21
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
9 #define USE_THE_REPOSITORY_VARIABLE
11 #include "git-compat-util.h"
12 #include "abspath.h"
13 #include "advice.h"
14 #include "date.h"
15 #include "branch.h"
16 #include "config.h"
17 #include "parse.h"
18 #include "convert.h"
19 #include "environment.h"
20 #include "gettext.h"
21 #include "ident.h"
22 #include "repository.h"
23 #include "lockfile.h"
24 #include "mailmap.h"
25 #include "attr.h"
26 #include "exec-cmd.h"
27 #include "strbuf.h"
28 #include "quote.h"
29 #include "hashmap.h"
30 #include "string-list.h"
31 #include "object-name.h"
32 #include "object-store-ll.h"
33 #include "pager.h"
34 #include "path.h"
35 #include "utf8.h"
36 #include "color.h"
37 #include "refs.h"
38 #include "setup.h"
39 #include "strvec.h"
40 #include "trace2.h"
41 #include "wildmatch.h"
42 #include "ws.h"
43 #include "write-or-die.h"
45 struct config_source {
46 struct config_source *prev;
47 union {
48 FILE *file;
49 struct config_buf {
50 const char *buf;
51 size_t len;
52 size_t pos;
53 } buf;
54 } u;
55 enum config_origin_type origin_type;
56 const char *name;
57 const char *path;
58 enum config_error_action default_error_action;
59 int linenr;
60 int eof;
61 size_t total_len;
62 struct strbuf value;
63 struct strbuf var;
64 unsigned subsection_case_sensitive : 1;
66 int (*do_fgetc)(struct config_source *c);
67 int (*do_ungetc)(int c, struct config_source *conf);
68 long (*do_ftell)(struct config_source *c);
70 #define CONFIG_SOURCE_INIT { 0 }
72 static int pack_compression_seen;
73 static int zlib_compression_seen;
76 * Config that comes from trusted scopes, namely:
77 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
78 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
79 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
81 * This is declared here for code cleanliness, but unlike the other
82 * static variables, this does not hold config parser state.
84 static struct config_set protected_config;
86 static int config_file_fgetc(struct config_source *conf)
88 return getc_unlocked(conf->u.file);
91 static int config_file_ungetc(int c, struct config_source *conf)
93 return ungetc(c, conf->u.file);
96 static long config_file_ftell(struct config_source *conf)
98 return ftell(conf->u.file);
101 static int config_buf_fgetc(struct config_source *conf)
103 if (conf->u.buf.pos < conf->u.buf.len)
104 return conf->u.buf.buf[conf->u.buf.pos++];
106 return EOF;
109 static int config_buf_ungetc(int c, struct config_source *conf)
111 if (conf->u.buf.pos > 0) {
112 conf->u.buf.pos--;
113 if (conf->u.buf.buf[conf->u.buf.pos] != c)
114 BUG("config_buf can only ungetc the same character");
115 return c;
118 return EOF;
121 static long config_buf_ftell(struct config_source *conf)
123 return conf->u.buf.pos;
126 struct config_include_data {
127 int depth;
128 config_fn_t fn;
129 void *data;
130 const struct config_options *opts;
131 const struct git_config_source *config_source;
132 struct repository *repo;
135 * All remote URLs discovered when reading all config files.
137 struct string_list *remote_urls;
139 #define CONFIG_INCLUDE_INIT { 0 }
141 static int git_config_include(const char *var, const char *value,
142 const struct config_context *ctx, void *data);
144 #define MAX_INCLUDE_DEPTH 10
145 static const char include_depth_advice[] = N_(
146 "exceeded maximum include depth (%d) while including\n"
147 " %s\n"
148 "from\n"
149 " %s\n"
150 "This might be due to circular includes.");
151 static int handle_path_include(const struct key_value_info *kvi,
152 const char *path,
153 struct config_include_data *inc)
155 int ret = 0;
156 struct strbuf buf = STRBUF_INIT;
157 char *expanded;
159 if (!path)
160 return config_error_nonbool("include.path");
162 expanded = interpolate_path(path, 0);
163 if (!expanded)
164 return error(_("could not expand include path '%s'"), path);
165 path = expanded;
168 * Use an absolute path as-is, but interpret relative paths
169 * based on the including config file.
171 if (!is_absolute_path(path)) {
172 char *slash;
174 if (!kvi || !kvi->path) {
175 ret = error(_("relative config includes must come from files"));
176 goto cleanup;
179 slash = find_last_dir_sep(kvi->path);
180 if (slash)
181 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
182 strbuf_addstr(&buf, path);
183 path = buf.buf;
186 if (!access_or_die(path, R_OK, 0)) {
187 if (++inc->depth > MAX_INCLUDE_DEPTH)
188 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
189 !kvi ? "<unknown>" :
190 kvi->filename ? kvi->filename :
191 "the command line");
192 ret = git_config_from_file_with_options(git_config_include, path, inc,
193 kvi->scope, NULL);
194 inc->depth--;
196 cleanup:
197 strbuf_release(&buf);
198 free(expanded);
199 return ret;
202 static void add_trailing_starstar_for_dir(struct strbuf *pat)
204 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
205 strbuf_addstr(pat, "**");
208 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
209 struct strbuf *pat)
211 struct strbuf path = STRBUF_INIT;
212 char *expanded;
213 int prefix = 0;
215 expanded = interpolate_path(pat->buf, 1);
216 if (expanded) {
217 strbuf_reset(pat);
218 strbuf_addstr(pat, expanded);
219 free(expanded);
222 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
223 const char *slash;
225 if (!kvi || !kvi->path)
226 return error(_("relative config include "
227 "conditionals must come from files"));
229 strbuf_realpath(&path, kvi->path, 1);
230 slash = find_last_dir_sep(path.buf);
231 if (!slash)
232 BUG("how is this possible?");
233 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
234 prefix = slash - path.buf + 1 /* slash */;
235 } else if (!is_absolute_path(pat->buf))
236 strbuf_insertstr(pat, 0, "**/");
238 add_trailing_starstar_for_dir(pat);
240 strbuf_release(&path);
241 return prefix;
244 static int include_by_gitdir(const struct key_value_info *kvi,
245 const struct config_options *opts,
246 const char *cond, size_t cond_len, int icase)
248 struct strbuf text = STRBUF_INIT;
249 struct strbuf pattern = STRBUF_INIT;
250 int ret = 0, prefix;
251 const char *git_dir;
252 int already_tried_absolute = 0;
254 if (opts->git_dir)
255 git_dir = opts->git_dir;
256 else
257 goto done;
259 strbuf_realpath(&text, git_dir, 1);
260 strbuf_add(&pattern, cond, cond_len);
261 prefix = prepare_include_condition_pattern(kvi, &pattern);
263 again:
264 if (prefix < 0)
265 goto done;
267 if (prefix > 0) {
269 * perform literal matching on the prefix part so that
270 * any wildcard character in it can't create side effects.
272 if (text.len < prefix)
273 goto done;
274 if (!icase && strncmp(pattern.buf, text.buf, prefix))
275 goto done;
276 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
277 goto done;
280 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
281 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
283 if (!ret && !already_tried_absolute) {
285 * We've tried e.g. matching gitdir:~/work, but if
286 * ~/work is a symlink to /mnt/storage/work
287 * strbuf_realpath() will expand it, so the rule won't
288 * match. Let's match against a
289 * strbuf_add_absolute_path() version of the path,
290 * which'll do the right thing
292 strbuf_reset(&text);
293 strbuf_add_absolute_path(&text, git_dir);
294 already_tried_absolute = 1;
295 goto again;
297 done:
298 strbuf_release(&pattern);
299 strbuf_release(&text);
300 return ret;
303 static int include_by_branch(const char *cond, size_t cond_len)
305 int flags;
306 int ret;
307 struct strbuf pattern = STRBUF_INIT;
308 const char *refname = !the_repository->gitdir ?
309 NULL : refs_resolve_ref_unsafe(get_main_ref_store(the_repository),
310 "HEAD", 0, NULL, &flags);
311 const char *shortname;
313 if (!refname || !(flags & REF_ISSYMREF) ||
314 !skip_prefix(refname, "refs/heads/", &shortname))
315 return 0;
317 strbuf_add(&pattern, cond, cond_len);
318 add_trailing_starstar_for_dir(&pattern);
319 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
320 strbuf_release(&pattern);
321 return ret;
324 static int add_remote_url(const char *var, const char *value,
325 const struct config_context *ctx UNUSED, void *data)
327 struct string_list *remote_urls = data;
328 const char *remote_name;
329 size_t remote_name_len;
330 const char *key;
332 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
333 &key) &&
334 remote_name &&
335 !strcmp(key, "url"))
336 string_list_append(remote_urls, value);
337 return 0;
340 static void populate_remote_urls(struct config_include_data *inc)
342 struct config_options opts;
344 opts = *inc->opts;
345 opts.unconditional_remote_url = 1;
347 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
348 string_list_init_dup(inc->remote_urls);
349 config_with_options(add_remote_url, inc->remote_urls,
350 inc->config_source, inc->repo, &opts);
353 static int forbid_remote_url(const char *var, const char *value UNUSED,
354 const struct config_context *ctx UNUSED,
355 void *data UNUSED)
357 const char *remote_name;
358 size_t remote_name_len;
359 const char *key;
361 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
362 &key) &&
363 remote_name &&
364 !strcmp(key, "url"))
365 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
366 return 0;
369 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
370 struct string_list *remote_urls)
372 struct strbuf pattern = STRBUF_INIT;
373 struct string_list_item *url_item;
374 int found = 0;
376 strbuf_add(&pattern, glob, glob_len);
377 for_each_string_list_item(url_item, remote_urls) {
378 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
379 found = 1;
380 break;
383 strbuf_release(&pattern);
384 return found;
387 static int include_by_remote_url(struct config_include_data *inc,
388 const char *cond, size_t cond_len)
390 if (inc->opts->unconditional_remote_url)
391 return 1;
392 if (!inc->remote_urls)
393 populate_remote_urls(inc);
394 return at_least_one_url_matches_glob(cond, cond_len,
395 inc->remote_urls);
398 static int include_condition_is_true(const struct key_value_info *kvi,
399 struct config_include_data *inc,
400 const char *cond, size_t cond_len)
402 const struct config_options *opts = inc->opts;
404 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
405 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
406 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
407 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
408 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
409 return include_by_branch(cond, cond_len);
410 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
411 &cond_len))
412 return include_by_remote_url(inc, cond, cond_len);
414 /* unknown conditionals are always false */
415 return 0;
418 static int git_config_include(const char *var, const char *value,
419 const struct config_context *ctx,
420 void *data)
422 struct config_include_data *inc = data;
423 const char *cond, *key;
424 size_t cond_len;
425 int ret;
428 * Pass along all values, including "include" directives; this makes it
429 * possible to query information on the includes themselves.
431 ret = inc->fn(var, value, ctx, inc->data);
432 if (ret < 0)
433 return ret;
435 if (!strcmp(var, "include.path"))
436 ret = handle_path_include(ctx->kvi, value, inc);
438 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
439 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
440 !strcmp(key, "path")) {
441 config_fn_t old_fn = inc->fn;
443 if (inc->opts->unconditional_remote_url)
444 inc->fn = forbid_remote_url;
445 ret = handle_path_include(ctx->kvi, value, inc);
446 inc->fn = old_fn;
449 return ret;
452 static void git_config_push_split_parameter(const char *key, const char *value)
454 struct strbuf env = STRBUF_INIT;
455 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
456 if (old && *old) {
457 strbuf_addstr(&env, old);
458 strbuf_addch(&env, ' ');
460 sq_quote_buf(&env, key);
461 strbuf_addch(&env, '=');
462 if (value)
463 sq_quote_buf(&env, value);
464 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
465 strbuf_release(&env);
468 void git_config_push_parameter(const char *text)
470 const char *value;
473 * When we see:
475 * section.subsection=with=equals.key=value
477 * we cannot tell if it means:
479 * [section "subsection=with=equals"]
480 * key = value
482 * or:
484 * [section]
485 * subsection = with=equals.key=value
487 * We parse left-to-right for the first "=", meaning we'll prefer to
488 * keep the value intact over the subsection. This is historical, but
489 * also sensible since values are more likely to contain odd or
490 * untrusted input than a section name.
492 * A missing equals is explicitly allowed (as a bool-only entry).
494 value = strchr(text, '=');
495 if (value) {
496 char *key = xmemdupz(text, value - text);
497 git_config_push_split_parameter(key, value + 1);
498 free(key);
499 } else {
500 git_config_push_split_parameter(text, NULL);
504 void git_config_push_env(const char *spec)
506 char *key;
507 const char *env_name;
508 const char *env_value;
510 env_name = strrchr(spec, '=');
511 if (!env_name)
512 die(_("invalid config format: %s"), spec);
513 key = xmemdupz(spec, env_name - spec);
514 env_name++;
515 if (!*env_name)
516 die(_("missing environment variable name for configuration '%.*s'"),
517 (int)(env_name - spec - 1), spec);
519 env_value = getenv(env_name);
520 if (!env_value)
521 die(_("missing environment variable '%s' for configuration '%.*s'"),
522 env_name, (int)(env_name - spec - 1), spec);
524 git_config_push_split_parameter(key, env_value);
525 free(key);
528 static inline int iskeychar(int c)
530 return isalnum(c) || c == '-';
534 * Auxiliary function to sanity-check and split the key into the section
535 * identifier and variable name.
537 * Returns 0 on success, -1 when there is an invalid character in the key and
538 * -2 if there is no section name in the key.
540 * store_key - pointer to char* which will hold a copy of the key with
541 * lowercase section and variable name
542 * baselen - pointer to size_t which will hold the length of the
543 * section + subsection part, can be NULL
545 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
547 size_t i, baselen;
548 int dot;
549 const char *last_dot = strrchr(key, '.');
552 * Since "key" actually contains the section name and the real
553 * key name separated by a dot, we have to know where the dot is.
556 if (last_dot == NULL || last_dot == key) {
557 error(_("key does not contain a section: %s"), key);
558 return -CONFIG_NO_SECTION_OR_NAME;
561 if (!last_dot[1]) {
562 error(_("key does not contain variable name: %s"), key);
563 return -CONFIG_NO_SECTION_OR_NAME;
566 baselen = last_dot - key;
567 if (baselen_)
568 *baselen_ = baselen;
571 * Validate the key and while at it, lower case it for matching.
573 *store_key = xmallocz(strlen(key));
575 dot = 0;
576 for (i = 0; key[i]; i++) {
577 unsigned char c = key[i];
578 if (c == '.')
579 dot = 1;
580 /* Leave the extended basename untouched.. */
581 if (!dot || i > baselen) {
582 if (!iskeychar(c) ||
583 (i == baselen + 1 && !isalpha(c))) {
584 error(_("invalid key: %s"), key);
585 goto out_free_ret_1;
587 c = tolower(c);
588 } else if (c == '\n') {
589 error(_("invalid key (newline): %s"), key);
590 goto out_free_ret_1;
592 (*store_key)[i] = c;
595 return 0;
597 out_free_ret_1:
598 FREE_AND_NULL(*store_key);
599 return -CONFIG_INVALID_KEY;
602 static int config_parse_pair(const char *key, const char *value,
603 struct key_value_info *kvi,
604 config_fn_t fn, void *data)
606 char *canonical_name;
607 int ret;
608 struct config_context ctx = {
609 .kvi = kvi,
612 if (!strlen(key))
613 return error(_("empty config key"));
614 if (git_config_parse_key(key, &canonical_name, NULL))
615 return -1;
617 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
618 free(canonical_name);
619 return ret;
623 /* for values read from `git_config_from_parameters()` */
624 void kvi_from_param(struct key_value_info *out)
626 out->filename = NULL;
627 out->linenr = -1;
628 out->origin_type = CONFIG_ORIGIN_CMDLINE;
629 out->scope = CONFIG_SCOPE_COMMAND;
630 out->path = NULL;
633 int git_config_parse_parameter(const char *text,
634 config_fn_t fn, void *data)
636 const char *value;
637 struct strbuf **pair;
638 int ret;
639 struct key_value_info kvi = KVI_INIT;
641 kvi_from_param(&kvi);
643 pair = strbuf_split_str(text, '=', 2);
644 if (!pair[0])
645 return error(_("bogus config parameter: %s"), text);
647 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
648 strbuf_setlen(pair[0], pair[0]->len - 1);
649 value = pair[1] ? pair[1]->buf : "";
650 } else {
651 value = NULL;
654 strbuf_trim(pair[0]);
655 if (!pair[0]->len) {
656 strbuf_list_free(pair);
657 return error(_("bogus config parameter: %s"), text);
660 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
661 strbuf_list_free(pair);
662 return ret;
665 static int parse_config_env_list(char *env, struct key_value_info *kvi,
666 config_fn_t fn, void *data)
668 char *cur = env;
669 while (cur && *cur) {
670 const char *key = sq_dequote_step(cur, &cur);
671 if (!key)
672 return error(_("bogus format in %s"),
673 CONFIG_DATA_ENVIRONMENT);
675 if (!cur || isspace(*cur)) {
676 /* old-style 'key=value' */
677 if (git_config_parse_parameter(key, fn, data) < 0)
678 return -1;
680 else if (*cur == '=') {
681 /* new-style 'key'='value' */
682 const char *value;
684 cur++;
685 if (*cur == '\'') {
686 /* quoted value */
687 value = sq_dequote_step(cur, &cur);
688 if (!value || (cur && !isspace(*cur))) {
689 return error(_("bogus format in %s"),
690 CONFIG_DATA_ENVIRONMENT);
692 } else if (!*cur || isspace(*cur)) {
693 /* implicit bool: 'key'= */
694 value = NULL;
695 } else {
696 return error(_("bogus format in %s"),
697 CONFIG_DATA_ENVIRONMENT);
700 if (config_parse_pair(key, value, kvi, fn, data) < 0)
701 return -1;
703 else {
704 /* unknown format */
705 return error(_("bogus format in %s"),
706 CONFIG_DATA_ENVIRONMENT);
709 if (cur) {
710 while (isspace(*cur))
711 cur++;
714 return 0;
717 int git_config_from_parameters(config_fn_t fn, void *data)
719 const char *env;
720 struct strbuf envvar = STRBUF_INIT;
721 struct strvec to_free = STRVEC_INIT;
722 int ret = 0;
723 char *envw = NULL;
724 struct key_value_info kvi = KVI_INIT;
726 kvi_from_param(&kvi);
727 env = getenv(CONFIG_COUNT_ENVIRONMENT);
728 if (env) {
729 unsigned long count;
730 char *endp;
731 int i;
733 count = strtoul(env, &endp, 10);
734 if (*endp) {
735 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
736 goto out;
738 if (count > INT_MAX) {
739 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
740 goto out;
743 for (i = 0; i < count; i++) {
744 const char *key, *value;
746 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
747 key = getenv_safe(&to_free, envvar.buf);
748 if (!key) {
749 ret = error(_("missing config key %s"), envvar.buf);
750 goto out;
752 strbuf_reset(&envvar);
754 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
755 value = getenv_safe(&to_free, envvar.buf);
756 if (!value) {
757 ret = error(_("missing config value %s"), envvar.buf);
758 goto out;
760 strbuf_reset(&envvar);
762 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
763 ret = -1;
764 goto out;
769 env = getenv(CONFIG_DATA_ENVIRONMENT);
770 if (env) {
771 /* sq_dequote will write over it */
772 envw = xstrdup(env);
773 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
774 ret = -1;
775 goto out;
779 out:
780 strbuf_release(&envvar);
781 strvec_clear(&to_free);
782 free(envw);
783 return ret;
786 static int get_next_char(struct config_source *cs)
788 int c = cs->do_fgetc(cs);
790 if (c == '\r') {
791 /* DOS like systems */
792 c = cs->do_fgetc(cs);
793 if (c != '\n') {
794 if (c != EOF)
795 cs->do_ungetc(c, cs);
796 c = '\r';
800 if (c != EOF && ++cs->total_len > INT_MAX) {
802 * This is an absurdly long config file; refuse to parse
803 * further in order to protect downstream code from integer
804 * overflows. Note that we can't return an error specifically,
805 * but we can mark EOF and put trash in the return value,
806 * which will trigger a parse error.
808 cs->eof = 1;
809 return 0;
812 if (c == '\n')
813 cs->linenr++;
814 if (c == EOF) {
815 cs->eof = 1;
816 cs->linenr++;
817 c = '\n';
819 return c;
822 static char *parse_value(struct config_source *cs)
824 int quote = 0, comment = 0;
825 size_t trim_len = 0;
827 strbuf_reset(&cs->value);
828 for (;;) {
829 int c = get_next_char(cs);
830 if (c == '\n') {
831 if (quote) {
832 cs->linenr--;
833 return NULL;
835 if (trim_len)
836 strbuf_setlen(&cs->value, trim_len);
837 return cs->value.buf;
839 if (comment)
840 continue;
841 if (isspace(c) && !quote) {
842 if (!trim_len)
843 trim_len = cs->value.len;
844 if (cs->value.len)
845 strbuf_addch(&cs->value, c);
846 continue;
848 if (!quote) {
849 if (c == ';' || c == '#') {
850 comment = 1;
851 continue;
854 if (trim_len)
855 trim_len = 0;
856 if (c == '\\') {
857 c = get_next_char(cs);
858 switch (c) {
859 case '\n':
860 continue;
861 case 't':
862 c = '\t';
863 break;
864 case 'b':
865 c = '\b';
866 break;
867 case 'n':
868 c = '\n';
869 break;
870 /* Some characters escape as themselves */
871 case '\\': case '"':
872 break;
873 /* Reject unknown escape sequences */
874 default:
875 return NULL;
877 strbuf_addch(&cs->value, c);
878 continue;
880 if (c == '"') {
881 quote = 1 - quote;
882 continue;
884 strbuf_addch(&cs->value, c);
888 static int get_value(struct config_source *cs, struct key_value_info *kvi,
889 config_fn_t fn, void *data, struct strbuf *name)
891 int c;
892 char *value;
893 int ret;
894 struct config_context ctx = {
895 .kvi = kvi,
898 /* Get the full name */
899 for (;;) {
900 c = get_next_char(cs);
901 if (cs->eof)
902 break;
903 if (!iskeychar(c))
904 break;
905 strbuf_addch(name, tolower(c));
908 while (c == ' ' || c == '\t')
909 c = get_next_char(cs);
911 value = NULL;
912 if (c != '\n') {
913 if (c != '=')
914 return -1;
915 value = parse_value(cs);
916 if (!value)
917 return -1;
920 * We already consumed the \n, but we need linenr to point to
921 * the line we just parsed during the call to fn to get
922 * accurate line number in error messages.
924 cs->linenr--;
925 kvi->linenr = cs->linenr;
926 ret = fn(name->buf, value, &ctx, data);
927 if (ret >= 0)
928 cs->linenr++;
929 return ret;
932 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
933 int c)
935 cs->subsection_case_sensitive = 0;
936 do {
937 if (c == '\n')
938 goto error_incomplete_line;
939 c = get_next_char(cs);
940 } while (isspace(c));
942 /* We require the format to be '[base "extension"]' */
943 if (c != '"')
944 return -1;
945 strbuf_addch(name, '.');
947 for (;;) {
948 int c = get_next_char(cs);
949 if (c == '\n')
950 goto error_incomplete_line;
951 if (c == '"')
952 break;
953 if (c == '\\') {
954 c = get_next_char(cs);
955 if (c == '\n')
956 goto error_incomplete_line;
958 strbuf_addch(name, c);
961 /* Final ']' */
962 if (get_next_char(cs) != ']')
963 return -1;
964 return 0;
965 error_incomplete_line:
966 cs->linenr--;
967 return -1;
970 static int get_base_var(struct config_source *cs, struct strbuf *name)
972 cs->subsection_case_sensitive = 1;
973 for (;;) {
974 int c = get_next_char(cs);
975 if (cs->eof)
976 return -1;
977 if (c == ']')
978 return 0;
979 if (isspace(c))
980 return get_extended_base_var(cs, name, c);
981 if (!iskeychar(c) && c != '.')
982 return -1;
983 strbuf_addch(name, tolower(c));
987 struct parse_event_data {
988 enum config_event_t previous_type;
989 size_t previous_offset;
990 const struct config_options *opts;
993 static int do_event(struct config_source *cs, enum config_event_t type,
994 struct parse_event_data *data)
996 size_t offset;
998 if (!data->opts || !data->opts->event_fn)
999 return 0;
1001 if (type == CONFIG_EVENT_WHITESPACE &&
1002 data->previous_type == type)
1003 return 0;
1005 offset = cs->do_ftell(cs);
1007 * At EOF, the parser always "inserts" an extra '\n', therefore
1008 * the end offset of the event is the current file position, otherwise
1009 * we will already have advanced to the next event.
1011 if (type != CONFIG_EVENT_EOF)
1012 offset--;
1014 if (data->previous_type != CONFIG_EVENT_EOF &&
1015 data->opts->event_fn(data->previous_type, data->previous_offset,
1016 offset, cs, data->opts->event_fn_data) < 0)
1017 return -1;
1019 data->previous_type = type;
1020 data->previous_offset = offset;
1022 return 0;
1025 static void kvi_from_source(struct config_source *cs,
1026 enum config_scope scope,
1027 struct key_value_info *out)
1029 out->filename = strintern(cs->name);
1030 out->origin_type = cs->origin_type;
1031 out->linenr = cs->linenr;
1032 out->scope = scope;
1033 out->path = cs->path;
1036 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1037 struct key_value_info *kvi, void *data,
1038 const struct config_options *opts)
1040 int comment = 0;
1041 size_t baselen = 0;
1042 struct strbuf *var = &cs->var;
1043 int error_return = 0;
1044 char *error_msg = NULL;
1046 /* U+FEFF Byte Order Mark in UTF8 */
1047 const char *bomptr = utf8_bom;
1049 /* For the parser event callback */
1050 struct parse_event_data event_data = {
1051 CONFIG_EVENT_EOF, 0, opts
1054 for (;;) {
1055 int c;
1057 c = get_next_char(cs);
1058 if (bomptr && *bomptr) {
1059 /* We are at the file beginning; skip UTF8-encoded BOM
1060 * if present. Sane editors won't put this in on their
1061 * own, but e.g. Windows Notepad will do it happily. */
1062 if (c == (*bomptr & 0377)) {
1063 bomptr++;
1064 continue;
1065 } else {
1066 /* Do not tolerate partial BOM. */
1067 if (bomptr != utf8_bom)
1068 break;
1069 /* No BOM at file beginning. Cool. */
1070 bomptr = NULL;
1073 if (c == '\n') {
1074 if (cs->eof) {
1075 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1076 return -1;
1077 return 0;
1079 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1080 return -1;
1081 comment = 0;
1082 continue;
1084 if (comment)
1085 continue;
1086 if (isspace(c)) {
1087 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1088 return -1;
1089 continue;
1091 if (c == '#' || c == ';') {
1092 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1093 return -1;
1094 comment = 1;
1095 continue;
1097 if (c == '[') {
1098 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1099 return -1;
1101 /* Reset prior to determining a new stem */
1102 strbuf_reset(var);
1103 if (get_base_var(cs, var) < 0 || var->len < 1)
1104 break;
1105 strbuf_addch(var, '.');
1106 baselen = var->len;
1107 continue;
1109 if (!isalpha(c))
1110 break;
1112 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1113 return -1;
1116 * Truncate the var name back to the section header
1117 * stem prior to grabbing the suffix part of the name
1118 * and the value.
1120 strbuf_setlen(var, baselen);
1121 strbuf_addch(var, tolower(c));
1122 if (get_value(cs, kvi, fn, data, var) < 0)
1123 break;
1126 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1127 return -1;
1129 switch (cs->origin_type) {
1130 case CONFIG_ORIGIN_BLOB:
1131 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1132 cs->linenr, cs->name);
1133 break;
1134 case CONFIG_ORIGIN_FILE:
1135 error_msg = xstrfmt(_("bad config line %d in file %s"),
1136 cs->linenr, cs->name);
1137 break;
1138 case CONFIG_ORIGIN_STDIN:
1139 error_msg = xstrfmt(_("bad config line %d in standard input"),
1140 cs->linenr);
1141 break;
1142 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1143 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1144 cs->linenr, cs->name);
1145 break;
1146 case CONFIG_ORIGIN_CMDLINE:
1147 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1148 cs->linenr, cs->name);
1149 break;
1150 default:
1151 error_msg = xstrfmt(_("bad config line %d in %s"),
1152 cs->linenr, cs->name);
1155 switch (opts && opts->error_action ?
1156 opts->error_action :
1157 cs->default_error_action) {
1158 case CONFIG_ERROR_DIE:
1159 die("%s", error_msg);
1160 break;
1161 case CONFIG_ERROR_ERROR:
1162 error_return = error("%s", error_msg);
1163 break;
1164 case CONFIG_ERROR_SILENT:
1165 error_return = -1;
1166 break;
1167 case CONFIG_ERROR_UNSET:
1168 BUG("config error action unset");
1171 free(error_msg);
1172 return error_return;
1175 NORETURN
1176 static void die_bad_number(const char *name, const char *value,
1177 const struct key_value_info *kvi)
1179 const char *error_type = (errno == ERANGE) ?
1180 N_("out of range") : N_("invalid unit");
1181 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1183 if (!kvi)
1184 BUG("kvi should not be NULL");
1186 if (!value)
1187 value = "";
1189 if (!kvi->filename)
1190 die(_(bad_numeric), value, name, _(error_type));
1192 switch (kvi->origin_type) {
1193 case CONFIG_ORIGIN_BLOB:
1194 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1195 value, name, kvi->filename, _(error_type));
1196 case CONFIG_ORIGIN_FILE:
1197 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1198 value, name, kvi->filename, _(error_type));
1199 case CONFIG_ORIGIN_STDIN:
1200 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1201 value, name, _(error_type));
1202 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1203 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1204 value, name, kvi->filename, _(error_type));
1205 case CONFIG_ORIGIN_CMDLINE:
1206 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1207 value, name, kvi->filename, _(error_type));
1208 default:
1209 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1210 value, name, kvi->filename, _(error_type));
1214 int git_config_int(const char *name, const char *value,
1215 const struct key_value_info *kvi)
1217 int ret;
1218 if (!git_parse_int(value, &ret))
1219 die_bad_number(name, value, kvi);
1220 return ret;
1223 int64_t git_config_int64(const char *name, const char *value,
1224 const struct key_value_info *kvi)
1226 int64_t ret;
1227 if (!git_parse_int64(value, &ret))
1228 die_bad_number(name, value, kvi);
1229 return ret;
1232 unsigned long git_config_ulong(const char *name, const char *value,
1233 const struct key_value_info *kvi)
1235 unsigned long ret;
1236 if (!git_parse_ulong(value, &ret))
1237 die_bad_number(name, value, kvi);
1238 return ret;
1241 ssize_t git_config_ssize_t(const char *name, const char *value,
1242 const struct key_value_info *kvi)
1244 ssize_t ret;
1245 if (!git_parse_ssize_t(value, &ret))
1246 die_bad_number(name, value, kvi);
1247 return ret;
1250 double git_config_double(const char *name, const char *value,
1251 const struct key_value_info *kvi)
1253 double ret;
1254 if (!git_parse_double(value, &ret))
1255 die_bad_number(name, value, kvi);
1256 return ret;
1259 static const struct fsync_component_name {
1260 const char *name;
1261 enum fsync_component component_bits;
1262 } fsync_component_names[] = {
1263 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1264 { "pack", FSYNC_COMPONENT_PACK },
1265 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1266 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1267 { "index", FSYNC_COMPONENT_INDEX },
1268 { "objects", FSYNC_COMPONENTS_OBJECTS },
1269 { "reference", FSYNC_COMPONENT_REFERENCE },
1270 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1271 { "committed", FSYNC_COMPONENTS_COMMITTED },
1272 { "added", FSYNC_COMPONENTS_ADDED },
1273 { "all", FSYNC_COMPONENTS_ALL },
1276 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1278 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1279 enum fsync_component positive = 0, negative = 0;
1281 while (string) {
1282 int i;
1283 size_t len;
1284 const char *ep;
1285 int negated = 0;
1286 int found = 0;
1288 string = string + strspn(string, ", \t\n\r");
1289 ep = strchrnul(string, ',');
1290 len = ep - string;
1291 if (!strcmp(string, "none")) {
1292 current = FSYNC_COMPONENT_NONE;
1293 goto next_name;
1296 if (*string == '-') {
1297 negated = 1;
1298 string++;
1299 len--;
1300 if (!len)
1301 warning(_("invalid value for variable %s"), var);
1304 if (!len)
1305 break;
1307 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1308 const struct fsync_component_name *n = &fsync_component_names[i];
1310 if (strncmp(n->name, string, len))
1311 continue;
1313 found = 1;
1314 if (negated)
1315 negative |= n->component_bits;
1316 else
1317 positive |= n->component_bits;
1320 if (!found) {
1321 char *component = xstrndup(string, len);
1322 warning(_("ignoring unknown core.fsync component '%s'"), component);
1323 free(component);
1326 next_name:
1327 string = ep;
1330 return (current & ~negative) | positive;
1333 int git_config_bool_or_int(const char *name, const char *value,
1334 const struct key_value_info *kvi, int *is_bool)
1336 int v = git_parse_maybe_bool_text(value);
1337 if (0 <= v) {
1338 *is_bool = 1;
1339 return v;
1341 *is_bool = 0;
1342 return git_config_int(name, value, kvi);
1345 int git_config_bool(const char *name, const char *value)
1347 int v = git_parse_maybe_bool(value);
1348 if (v < 0)
1349 die(_("bad boolean config value '%s' for '%s'"), value, name);
1350 return v;
1353 int git_config_string(char **dest, const char *var, const char *value)
1355 if (!value)
1356 return config_error_nonbool(var);
1357 *dest = xstrdup(value);
1358 return 0;
1361 int git_config_pathname(char **dest, const char *var, const char *value)
1363 if (!value)
1364 return config_error_nonbool(var);
1365 *dest = interpolate_path(value, 0);
1366 if (!*dest)
1367 die(_("failed to expand user dir in: '%s'"), value);
1368 return 0;
1371 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1373 if (!value)
1374 return config_error_nonbool(var);
1375 if (parse_expiry_date(value, timestamp))
1376 return error(_("'%s' for '%s' is not a valid timestamp"),
1377 value, var);
1378 return 0;
1381 int git_config_color(char *dest, const char *var, const char *value)
1383 if (!value)
1384 return config_error_nonbool(var);
1385 if (color_parse(value, dest) < 0)
1386 return -1;
1387 return 0;
1390 static int git_default_core_config(const char *var, const char *value,
1391 const struct config_context *ctx, void *cb)
1393 /* This needs a better name */
1394 if (!strcmp(var, "core.filemode")) {
1395 trust_executable_bit = git_config_bool(var, value);
1396 return 0;
1398 if (!strcmp(var, "core.trustctime")) {
1399 trust_ctime = git_config_bool(var, value);
1400 return 0;
1402 if (!strcmp(var, "core.checkstat")) {
1403 if (!value)
1404 return config_error_nonbool(var);
1405 if (!strcasecmp(value, "default"))
1406 check_stat = 1;
1407 else if (!strcasecmp(value, "minimal"))
1408 check_stat = 0;
1409 else
1410 return error(_("invalid value for '%s': '%s'"),
1411 var, value);
1414 if (!strcmp(var, "core.quotepath")) {
1415 quote_path_fully = git_config_bool(var, value);
1416 return 0;
1419 if (!strcmp(var, "core.symlinks")) {
1420 has_symlinks = git_config_bool(var, value);
1421 return 0;
1424 if (!strcmp(var, "core.ignorecase")) {
1425 ignore_case = git_config_bool(var, value);
1426 return 0;
1429 if (!strcmp(var, "core.attributesfile")) {
1430 FREE_AND_NULL(git_attributes_file);
1431 return git_config_pathname(&git_attributes_file, var, value);
1434 if (!strcmp(var, "core.hookspath")) {
1435 FREE_AND_NULL(git_hooks_path);
1436 return git_config_pathname(&git_hooks_path, var, value);
1439 if (!strcmp(var, "core.bare")) {
1440 is_bare_repository_cfg = git_config_bool(var, value);
1441 return 0;
1444 if (!strcmp(var, "core.ignorestat")) {
1445 assume_unchanged = git_config_bool(var, value);
1446 return 0;
1449 if (!strcmp(var, "core.prefersymlinkrefs")) {
1450 prefer_symlink_refs = git_config_bool(var, value);
1451 return 0;
1454 if (!strcmp(var, "core.logallrefupdates")) {
1455 if (value && !strcasecmp(value, "always"))
1456 log_all_ref_updates = LOG_REFS_ALWAYS;
1457 else if (git_config_bool(var, value))
1458 log_all_ref_updates = LOG_REFS_NORMAL;
1459 else
1460 log_all_ref_updates = LOG_REFS_NONE;
1461 return 0;
1464 if (!strcmp(var, "core.warnambiguousrefs")) {
1465 warn_ambiguous_refs = git_config_bool(var, value);
1466 return 0;
1469 if (!strcmp(var, "core.abbrev")) {
1470 if (!value)
1471 return config_error_nonbool(var);
1472 if (!strcasecmp(value, "auto"))
1473 default_abbrev = -1;
1474 else if (!git_parse_maybe_bool_text(value))
1475 default_abbrev = GIT_MAX_HEXSZ;
1476 else {
1477 int abbrev = git_config_int(var, value, ctx->kvi);
1478 if (abbrev < minimum_abbrev)
1479 return error(_("abbrev length out of range: %d"), abbrev);
1480 default_abbrev = abbrev;
1482 return 0;
1485 if (!strcmp(var, "core.disambiguate"))
1486 return set_disambiguate_hint_config(var, value);
1488 if (!strcmp(var, "core.loosecompression")) {
1489 int level = git_config_int(var, value, ctx->kvi);
1490 if (level == -1)
1491 level = Z_DEFAULT_COMPRESSION;
1492 else if (level < 0 || level > Z_BEST_COMPRESSION)
1493 die(_("bad zlib compression level %d"), level);
1494 zlib_compression_level = level;
1495 zlib_compression_seen = 1;
1496 return 0;
1499 if (!strcmp(var, "core.compression")) {
1500 int level = git_config_int(var, value, ctx->kvi);
1501 if (level == -1)
1502 level = Z_DEFAULT_COMPRESSION;
1503 else if (level < 0 || level > Z_BEST_COMPRESSION)
1504 die(_("bad zlib compression level %d"), level);
1505 if (!zlib_compression_seen)
1506 zlib_compression_level = level;
1507 if (!pack_compression_seen)
1508 pack_compression_level = level;
1509 return 0;
1512 if (!strcmp(var, "core.packedgitwindowsize")) {
1513 int pgsz_x2 = getpagesize() * 2;
1514 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1516 /* This value must be multiple of (pagesize * 2) */
1517 packed_git_window_size /= pgsz_x2;
1518 if (packed_git_window_size < 1)
1519 packed_git_window_size = 1;
1520 packed_git_window_size *= pgsz_x2;
1521 return 0;
1524 if (!strcmp(var, "core.bigfilethreshold")) {
1525 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1526 return 0;
1529 if (!strcmp(var, "core.packedgitlimit")) {
1530 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1531 return 0;
1534 if (!strcmp(var, "core.deltabasecachelimit")) {
1535 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1536 return 0;
1539 if (!strcmp(var, "core.autocrlf")) {
1540 if (value && !strcasecmp(value, "input")) {
1541 auto_crlf = AUTO_CRLF_INPUT;
1542 return 0;
1544 auto_crlf = git_config_bool(var, value);
1545 return 0;
1548 if (!strcmp(var, "core.safecrlf")) {
1549 int eol_rndtrp_die;
1550 if (value && !strcasecmp(value, "warn")) {
1551 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1552 return 0;
1554 eol_rndtrp_die = git_config_bool(var, value);
1555 global_conv_flags_eol = eol_rndtrp_die ?
1556 CONV_EOL_RNDTRP_DIE : 0;
1557 return 0;
1560 if (!strcmp(var, "core.eol")) {
1561 if (value && !strcasecmp(value, "lf"))
1562 core_eol = EOL_LF;
1563 else if (value && !strcasecmp(value, "crlf"))
1564 core_eol = EOL_CRLF;
1565 else if (value && !strcasecmp(value, "native"))
1566 core_eol = EOL_NATIVE;
1567 else
1568 core_eol = EOL_UNSET;
1569 return 0;
1572 if (!strcmp(var, "core.checkroundtripencoding")) {
1573 FREE_AND_NULL(check_roundtrip_encoding);
1574 return git_config_string(&check_roundtrip_encoding, var, value);
1577 if (!strcmp(var, "core.notesref")) {
1578 if (!value)
1579 return config_error_nonbool(var);
1580 free(notes_ref_name);
1581 notes_ref_name = xstrdup(value);
1582 return 0;
1585 if (!strcmp(var, "core.editor")) {
1586 FREE_AND_NULL(editor_program);
1587 return git_config_string(&editor_program, var, value);
1590 if (!strcmp(var, "core.commentchar") ||
1591 !strcmp(var, "core.commentstring")) {
1592 if (!value)
1593 return config_error_nonbool(var);
1594 else if (!strcasecmp(value, "auto"))
1595 auto_comment_line_char = 1;
1596 else if (value[0]) {
1597 if (strchr(value, '\n'))
1598 return error(_("%s cannot contain newline"), var);
1599 comment_line_str = xstrdup(value);
1600 auto_comment_line_char = 0;
1601 } else
1602 return error(_("%s must have at least one character"), var);
1603 return 0;
1606 if (!strcmp(var, "core.askpass")) {
1607 FREE_AND_NULL(askpass_program);
1608 return git_config_string(&askpass_program, var, value);
1611 if (!strcmp(var, "core.excludesfile")) {
1612 FREE_AND_NULL(excludes_file);
1613 return git_config_pathname(&excludes_file, var, value);
1616 if (!strcmp(var, "core.whitespace")) {
1617 if (!value)
1618 return config_error_nonbool(var);
1619 whitespace_rule_cfg = parse_whitespace_rule(value);
1620 return 0;
1623 if (!strcmp(var, "core.fsync")) {
1624 if (!value)
1625 return config_error_nonbool(var);
1626 fsync_components = parse_fsync_components(var, value);
1627 return 0;
1630 if (!strcmp(var, "core.fsyncmethod")) {
1631 if (!value)
1632 return config_error_nonbool(var);
1633 if (!strcmp(value, "fsync"))
1634 fsync_method = FSYNC_METHOD_FSYNC;
1635 else if (!strcmp(value, "writeout-only"))
1636 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1637 else if (!strcmp(value, "batch"))
1638 fsync_method = FSYNC_METHOD_BATCH;
1639 else
1640 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1644 if (!strcmp(var, "core.fsyncobjectfiles")) {
1645 if (fsync_object_files < 0)
1646 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1647 fsync_object_files = git_config_bool(var, value);
1648 return 0;
1651 if (!strcmp(var, "core.preloadindex")) {
1652 core_preload_index = git_config_bool(var, value);
1653 return 0;
1656 if (!strcmp(var, "core.createobject")) {
1657 if (!value)
1658 return config_error_nonbool(var);
1659 if (!strcmp(value, "rename"))
1660 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1661 else if (!strcmp(value, "link"))
1662 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1663 else
1664 die(_("invalid mode for object creation: %s"), value);
1665 return 0;
1668 if (!strcmp(var, "core.sparsecheckout")) {
1669 core_apply_sparse_checkout = git_config_bool(var, value);
1670 return 0;
1673 if (!strcmp(var, "core.sparsecheckoutcone")) {
1674 core_sparse_checkout_cone = git_config_bool(var, value);
1675 return 0;
1678 if (!strcmp(var, "core.precomposeunicode")) {
1679 precomposed_unicode = git_config_bool(var, value);
1680 return 0;
1683 if (!strcmp(var, "core.protecthfs")) {
1684 protect_hfs = git_config_bool(var, value);
1685 return 0;
1688 if (!strcmp(var, "core.protectntfs")) {
1689 protect_ntfs = git_config_bool(var, value);
1690 return 0;
1693 if (!strcmp(var, "core.maxtreedepth")) {
1694 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1695 return 0;
1698 /* Add other config variables here and to Documentation/config.txt. */
1699 return platform_core_config(var, value, ctx, cb);
1702 static int git_default_sparse_config(const char *var, const char *value)
1704 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1705 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1706 return 0;
1709 /* Add other config variables here and to Documentation/config/sparse.txt. */
1710 return 0;
1713 static int git_default_i18n_config(const char *var, const char *value)
1715 if (!strcmp(var, "i18n.commitencoding")) {
1716 FREE_AND_NULL(git_commit_encoding);
1717 return git_config_string(&git_commit_encoding, var, value);
1720 if (!strcmp(var, "i18n.logoutputencoding")) {
1721 FREE_AND_NULL(git_log_output_encoding);
1722 return git_config_string(&git_log_output_encoding, var, value);
1725 /* Add other config variables here and to Documentation/config.txt. */
1726 return 0;
1729 static int git_default_branch_config(const char *var, const char *value)
1731 if (!strcmp(var, "branch.autosetupmerge")) {
1732 if (value && !strcmp(value, "always")) {
1733 git_branch_track = BRANCH_TRACK_ALWAYS;
1734 return 0;
1735 } else if (value && !strcmp(value, "inherit")) {
1736 git_branch_track = BRANCH_TRACK_INHERIT;
1737 return 0;
1738 } else if (value && !strcmp(value, "simple")) {
1739 git_branch_track = BRANCH_TRACK_SIMPLE;
1740 return 0;
1742 git_branch_track = git_config_bool(var, value);
1743 return 0;
1745 if (!strcmp(var, "branch.autosetuprebase")) {
1746 if (!value)
1747 return config_error_nonbool(var);
1748 else if (!strcmp(value, "never"))
1749 autorebase = AUTOREBASE_NEVER;
1750 else if (!strcmp(value, "local"))
1751 autorebase = AUTOREBASE_LOCAL;
1752 else if (!strcmp(value, "remote"))
1753 autorebase = AUTOREBASE_REMOTE;
1754 else if (!strcmp(value, "always"))
1755 autorebase = AUTOREBASE_ALWAYS;
1756 else
1757 return error(_("malformed value for %s"), var);
1758 return 0;
1761 /* Add other config variables here and to Documentation/config.txt. */
1762 return 0;
1765 static int git_default_push_config(const char *var, const char *value)
1767 if (!strcmp(var, "push.default")) {
1768 if (!value)
1769 return config_error_nonbool(var);
1770 else if (!strcmp(value, "nothing"))
1771 push_default = PUSH_DEFAULT_NOTHING;
1772 else if (!strcmp(value, "matching"))
1773 push_default = PUSH_DEFAULT_MATCHING;
1774 else if (!strcmp(value, "simple"))
1775 push_default = PUSH_DEFAULT_SIMPLE;
1776 else if (!strcmp(value, "upstream"))
1777 push_default = PUSH_DEFAULT_UPSTREAM;
1778 else if (!strcmp(value, "tracking")) /* deprecated */
1779 push_default = PUSH_DEFAULT_UPSTREAM;
1780 else if (!strcmp(value, "current"))
1781 push_default = PUSH_DEFAULT_CURRENT;
1782 else {
1783 error(_("malformed value for %s: %s"), var, value);
1784 return error(_("must be one of nothing, matching, simple, "
1785 "upstream or current"));
1787 return 0;
1790 /* Add other config variables here and to Documentation/config.txt. */
1791 return 0;
1794 static int git_default_mailmap_config(const char *var, const char *value)
1796 if (!strcmp(var, "mailmap.file")) {
1797 FREE_AND_NULL(git_mailmap_file);
1798 return git_config_pathname(&git_mailmap_file, var, value);
1801 if (!strcmp(var, "mailmap.blob")) {
1802 FREE_AND_NULL(git_mailmap_blob);
1803 return git_config_string(&git_mailmap_blob, var, value);
1806 /* Add other config variables here and to Documentation/config.txt. */
1807 return 0;
1810 static int git_default_attr_config(const char *var, const char *value)
1812 if (!strcmp(var, "attr.tree")) {
1813 FREE_AND_NULL(git_attr_tree);
1814 return git_config_string(&git_attr_tree, var, value);
1818 * Add other attribute related config variables here and to
1819 * Documentation/config/attr.txt.
1821 return 0;
1824 int git_default_config(const char *var, const char *value,
1825 const struct config_context *ctx, void *cb)
1827 if (starts_with(var, "core."))
1828 return git_default_core_config(var, value, ctx, cb);
1830 if (starts_with(var, "user.") ||
1831 starts_with(var, "author.") ||
1832 starts_with(var, "committer."))
1833 return git_ident_config(var, value, ctx, cb);
1835 if (starts_with(var, "i18n."))
1836 return git_default_i18n_config(var, value);
1838 if (starts_with(var, "branch."))
1839 return git_default_branch_config(var, value);
1841 if (starts_with(var, "push."))
1842 return git_default_push_config(var, value);
1844 if (starts_with(var, "mailmap."))
1845 return git_default_mailmap_config(var, value);
1847 if (starts_with(var, "attr."))
1848 return git_default_attr_config(var, value);
1850 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1851 return git_default_advice_config(var, value);
1853 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1854 pager_use_color = git_config_bool(var,value);
1855 return 0;
1858 if (!strcmp(var, "pack.packsizelimit")) {
1859 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1860 return 0;
1863 if (!strcmp(var, "pack.compression")) {
1864 int level = git_config_int(var, value, ctx->kvi);
1865 if (level == -1)
1866 level = Z_DEFAULT_COMPRESSION;
1867 else if (level < 0 || level > Z_BEST_COMPRESSION)
1868 die(_("bad pack compression level %d"), level);
1869 pack_compression_level = level;
1870 pack_compression_seen = 1;
1871 return 0;
1874 if (starts_with(var, "sparse."))
1875 return git_default_sparse_config(var, value);
1877 /* Add other config variables here and to Documentation/config.txt. */
1878 return 0;
1882 * All source specific fields in the union, die_on_error, name and the callbacks
1883 * fgetc, ungetc, ftell of top need to be initialized before calling
1884 * this function.
1886 static int do_config_from(struct config_source *top, config_fn_t fn,
1887 void *data, enum config_scope scope,
1888 const struct config_options *opts)
1890 struct key_value_info kvi = KVI_INIT;
1891 int ret;
1893 /* push config-file parsing state stack */
1894 top->linenr = 1;
1895 top->eof = 0;
1896 top->total_len = 0;
1897 strbuf_init(&top->value, 1024);
1898 strbuf_init(&top->var, 1024);
1899 kvi_from_source(top, scope, &kvi);
1901 ret = git_parse_source(top, fn, &kvi, data, opts);
1903 strbuf_release(&top->value);
1904 strbuf_release(&top->var);
1906 return ret;
1909 static int do_config_from_file(config_fn_t fn,
1910 const enum config_origin_type origin_type,
1911 const char *name, const char *path, FILE *f,
1912 void *data, enum config_scope scope,
1913 const struct config_options *opts)
1915 struct config_source top = CONFIG_SOURCE_INIT;
1916 int ret;
1918 top.u.file = f;
1919 top.origin_type = origin_type;
1920 top.name = name;
1921 top.path = path;
1922 top.default_error_action = CONFIG_ERROR_DIE;
1923 top.do_fgetc = config_file_fgetc;
1924 top.do_ungetc = config_file_ungetc;
1925 top.do_ftell = config_file_ftell;
1927 flockfile(f);
1928 ret = do_config_from(&top, fn, data, scope, opts);
1929 funlockfile(f);
1930 return ret;
1933 static int git_config_from_stdin(config_fn_t fn, void *data,
1934 enum config_scope scope)
1936 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1937 data, scope, NULL);
1940 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1941 void *data, enum config_scope scope,
1942 const struct config_options *opts)
1944 int ret = -1;
1945 FILE *f;
1947 if (!filename)
1948 BUG("filename cannot be NULL");
1949 f = fopen_or_warn(filename, "r");
1950 if (f) {
1951 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1952 filename, f, data, scope, opts);
1953 fclose(f);
1955 return ret;
1958 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1960 return git_config_from_file_with_options(fn, filename, data,
1961 CONFIG_SCOPE_UNKNOWN, NULL);
1964 int git_config_from_mem(config_fn_t fn,
1965 const enum config_origin_type origin_type,
1966 const char *name, const char *buf, size_t len,
1967 void *data, enum config_scope scope,
1968 const struct config_options *opts)
1970 struct config_source top = CONFIG_SOURCE_INIT;
1972 top.u.buf.buf = buf;
1973 top.u.buf.len = len;
1974 top.u.buf.pos = 0;
1975 top.origin_type = origin_type;
1976 top.name = name;
1977 top.path = NULL;
1978 top.default_error_action = CONFIG_ERROR_ERROR;
1979 top.do_fgetc = config_buf_fgetc;
1980 top.do_ungetc = config_buf_ungetc;
1981 top.do_ftell = config_buf_ftell;
1983 return do_config_from(&top, fn, data, scope, opts);
1986 int git_config_from_blob_oid(config_fn_t fn,
1987 const char *name,
1988 struct repository *repo,
1989 const struct object_id *oid,
1990 void *data,
1991 enum config_scope scope)
1993 enum object_type type;
1994 char *buf;
1995 unsigned long size;
1996 int ret;
1998 buf = repo_read_object_file(repo, oid, &type, &size);
1999 if (!buf)
2000 return error(_("unable to load config blob object '%s'"), name);
2001 if (type != OBJ_BLOB) {
2002 free(buf);
2003 return error(_("reference '%s' does not point to a blob"), name);
2006 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
2007 data, scope, NULL);
2008 free(buf);
2010 return ret;
2013 static int git_config_from_blob_ref(config_fn_t fn,
2014 struct repository *repo,
2015 const char *name,
2016 void *data,
2017 enum config_scope scope)
2019 struct object_id oid;
2021 if (repo_get_oid(repo, name, &oid) < 0)
2022 return error(_("unable to resolve config blob '%s'"), name);
2023 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
2026 char *git_system_config(void)
2028 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2029 if (!system_config)
2030 system_config = system_path(ETC_GITCONFIG);
2031 normalize_path_copy(system_config, system_config);
2032 return system_config;
2035 char *git_global_config(void)
2037 char *user_config, *xdg_config;
2039 git_global_config_paths(&user_config, &xdg_config);
2040 if (!user_config) {
2041 free(xdg_config);
2042 return NULL;
2045 if (access_or_warn(user_config, R_OK, 0) && xdg_config &&
2046 !access_or_warn(xdg_config, R_OK, 0)) {
2047 free(user_config);
2048 return xdg_config;
2049 } else {
2050 free(xdg_config);
2051 return user_config;
2055 void git_global_config_paths(char **user_out, char **xdg_out)
2057 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2058 char *xdg_config = NULL;
2060 if (!user_config) {
2061 user_config = interpolate_path("~/.gitconfig", 0);
2062 xdg_config = xdg_config_home("config");
2065 *user_out = user_config;
2066 *xdg_out = xdg_config;
2069 int git_config_system(void)
2071 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2074 static int do_git_config_sequence(const struct config_options *opts,
2075 const struct repository *repo,
2076 config_fn_t fn, void *data)
2078 int ret = 0;
2079 char *system_config = git_system_config();
2080 char *xdg_config = NULL;
2081 char *user_config = NULL;
2082 char *repo_config;
2083 char *worktree_config;
2086 * Ensure that either:
2087 * - the git_dir and commondir are both set, or
2088 * - the git_dir and commondir are both NULL
2090 if (!opts->git_dir != !opts->commondir)
2091 BUG("only one of commondir and git_dir is non-NULL");
2093 if (opts->commondir) {
2094 repo_config = mkpathdup("%s/config", opts->commondir);
2095 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2096 } else {
2097 repo_config = NULL;
2098 worktree_config = NULL;
2101 if (git_config_system() && system_config &&
2102 !access_or_die(system_config, R_OK,
2103 opts->system_gently ? ACCESS_EACCES_OK : 0))
2104 ret += git_config_from_file_with_options(fn, system_config,
2105 data, CONFIG_SCOPE_SYSTEM,
2106 NULL);
2108 git_global_config_paths(&user_config, &xdg_config);
2110 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2111 ret += git_config_from_file_with_options(fn, xdg_config, data,
2112 CONFIG_SCOPE_GLOBAL, NULL);
2114 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2115 ret += git_config_from_file_with_options(fn, user_config, data,
2116 CONFIG_SCOPE_GLOBAL, NULL);
2118 if (!opts->ignore_repo && repo_config &&
2119 !access_or_die(repo_config, R_OK, 0))
2120 ret += git_config_from_file_with_options(fn, repo_config, data,
2121 CONFIG_SCOPE_LOCAL, NULL);
2123 if (!opts->ignore_worktree && worktree_config &&
2124 repo && repo->repository_format_worktree_config &&
2125 !access_or_die(worktree_config, R_OK, 0)) {
2126 ret += git_config_from_file_with_options(fn, worktree_config, data,
2127 CONFIG_SCOPE_WORKTREE,
2128 NULL);
2131 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2132 die(_("unable to parse command-line config"));
2134 free(system_config);
2135 free(xdg_config);
2136 free(user_config);
2137 free(repo_config);
2138 free(worktree_config);
2139 return ret;
2142 int config_with_options(config_fn_t fn, void *data,
2143 const struct git_config_source *config_source,
2144 struct repository *repo,
2145 const struct config_options *opts)
2147 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2148 int ret;
2150 if (opts->respect_includes) {
2151 inc.fn = fn;
2152 inc.data = data;
2153 inc.opts = opts;
2154 inc.repo = repo;
2155 inc.config_source = config_source;
2156 fn = git_config_include;
2157 data = &inc;
2161 * If we have a specific filename, use it. Otherwise, follow the
2162 * regular lookup sequence.
2164 if (config_source && config_source->use_stdin) {
2165 ret = git_config_from_stdin(fn, data, config_source->scope);
2166 } else if (config_source && config_source->file) {
2167 ret = git_config_from_file_with_options(fn, config_source->file,
2168 data, config_source->scope,
2169 NULL);
2170 } else if (config_source && config_source->blob) {
2171 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2172 data, config_source->scope);
2173 } else {
2174 ret = do_git_config_sequence(opts, repo, fn, data);
2177 if (inc.remote_urls) {
2178 string_list_clear(inc.remote_urls, 0);
2179 FREE_AND_NULL(inc.remote_urls);
2181 return ret;
2184 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2186 int i, value_index;
2187 struct string_list *values;
2188 struct config_set_element *entry;
2189 struct configset_list *list = &set->list;
2190 struct config_context ctx = CONFIG_CONTEXT_INIT;
2192 for (i = 0; i < list->nr; i++) {
2193 entry = list->items[i].e;
2194 value_index = list->items[i].value_index;
2195 values = &entry->value_list;
2197 ctx.kvi = values->items[value_index].util;
2198 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2199 git_die_config_linenr(entry->key,
2200 ctx.kvi->filename,
2201 ctx.kvi->linenr);
2205 void read_early_config(config_fn_t cb, void *data)
2207 struct config_options opts = {0};
2208 struct strbuf commondir = STRBUF_INIT;
2209 struct strbuf gitdir = STRBUF_INIT;
2211 opts.respect_includes = 1;
2213 if (have_git_dir()) {
2214 opts.commondir = get_git_common_dir();
2215 opts.git_dir = get_git_dir();
2217 * When setup_git_directory() was not yet asked to discover the
2218 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2219 * is any repository config we should use (but unlike
2220 * setup_git_directory_gently(), no global state is changed, most
2221 * notably, the current working directory is still the same after the
2222 * call).
2224 } else if (!discover_git_directory(&commondir, &gitdir)) {
2225 opts.commondir = commondir.buf;
2226 opts.git_dir = gitdir.buf;
2229 config_with_options(cb, data, NULL, NULL, &opts);
2231 strbuf_release(&commondir);
2232 strbuf_release(&gitdir);
2236 * Read config but only enumerate system and global settings.
2237 * Omit any repo-local, worktree-local, or command-line settings.
2239 void read_very_early_config(config_fn_t cb, void *data)
2241 struct config_options opts = { 0 };
2243 opts.respect_includes = 1;
2244 opts.ignore_repo = 1;
2245 opts.ignore_worktree = 1;
2246 opts.ignore_cmdline = 1;
2247 opts.system_gently = 1;
2249 config_with_options(cb, data, NULL, NULL, &opts);
2252 RESULT_MUST_BE_USED
2253 static int configset_find_element(struct config_set *set, const char *key,
2254 struct config_set_element **dest)
2256 struct config_set_element k;
2257 struct config_set_element *found_entry;
2258 char *normalized_key;
2259 int ret;
2262 * `key` may come from the user, so normalize it before using it
2263 * for querying entries from the hashmap.
2265 ret = git_config_parse_key(key, &normalized_key, NULL);
2266 if (ret)
2267 return ret;
2269 hashmap_entry_init(&k.ent, strhash(normalized_key));
2270 k.key = normalized_key;
2271 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2272 free(normalized_key);
2273 *dest = found_entry;
2274 return 0;
2277 static int configset_add_value(const struct key_value_info *kvi_p,
2278 struct config_set *set, const char *key,
2279 const char *value)
2281 struct config_set_element *e;
2282 struct string_list_item *si;
2283 struct configset_list_item *l_item;
2284 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2285 int ret;
2287 ret = configset_find_element(set, key, &e);
2288 if (ret)
2289 return ret;
2291 * Since the keys are being fed by git_config*() callback mechanism, they
2292 * are already normalized. So simply add them without any further munging.
2294 if (!e) {
2295 e = xmalloc(sizeof(*e));
2296 hashmap_entry_init(&e->ent, strhash(key));
2297 e->key = xstrdup(key);
2298 string_list_init_dup(&e->value_list);
2299 hashmap_add(&set->config_hash, &e->ent);
2301 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2303 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2304 l_item = &set->list.items[set->list.nr++];
2305 l_item->e = e;
2306 l_item->value_index = e->value_list.nr - 1;
2308 *kv_info = *kvi_p;
2309 si->util = kv_info;
2311 return 0;
2314 static int config_set_element_cmp(const void *cmp_data UNUSED,
2315 const struct hashmap_entry *eptr,
2316 const struct hashmap_entry *entry_or_key,
2317 const void *keydata UNUSED)
2319 const struct config_set_element *e1, *e2;
2321 e1 = container_of(eptr, const struct config_set_element, ent);
2322 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2324 return strcmp(e1->key, e2->key);
2327 void git_configset_init(struct config_set *set)
2329 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2330 set->hash_initialized = 1;
2331 set->list.nr = 0;
2332 set->list.alloc = 0;
2333 set->list.items = NULL;
2336 void git_configset_clear(struct config_set *set)
2338 struct config_set_element *entry;
2339 struct hashmap_iter iter;
2340 if (!set->hash_initialized)
2341 return;
2343 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2344 ent /* member name */) {
2345 free(entry->key);
2346 string_list_clear(&entry->value_list, 1);
2348 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2349 set->hash_initialized = 0;
2350 free(set->list.items);
2351 set->list.nr = 0;
2352 set->list.alloc = 0;
2353 set->list.items = NULL;
2356 static int config_set_callback(const char *key, const char *value,
2357 const struct config_context *ctx,
2358 void *cb)
2360 struct config_set *set = cb;
2361 configset_add_value(ctx->kvi, set, key, value);
2362 return 0;
2365 int git_configset_add_file(struct config_set *set, const char *filename)
2367 return git_config_from_file(config_set_callback, filename, set);
2370 int git_configset_get_value(struct config_set *set, const char *key,
2371 const char **value, struct key_value_info *kvi)
2373 const struct string_list *values = NULL;
2374 int ret;
2375 struct string_list_item item;
2377 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2378 * queried key in the files of the configset, the value returned will be the last
2379 * value in the value list for that key.
2381 if ((ret = git_configset_get_value_multi(set, key, &values)))
2382 return ret;
2384 assert(values->nr > 0);
2385 item = values->items[values->nr - 1];
2386 *value = item.string;
2387 if (kvi)
2388 *kvi = *((struct key_value_info *)item.util);
2389 return 0;
2392 int git_configset_get_value_multi(struct config_set *set, const char *key,
2393 const struct string_list **dest)
2395 struct config_set_element *e;
2396 int ret;
2398 if ((ret = configset_find_element(set, key, &e)))
2399 return ret;
2400 else if (!e)
2401 return 1;
2402 *dest = &e->value_list;
2404 return 0;
2407 static int check_multi_string(struct string_list_item *item, void *util)
2409 return item->string ? 0 : config_error_nonbool(util);
2412 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2413 const struct string_list **dest)
2415 int ret;
2417 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2418 return ret;
2419 if ((ret = for_each_string_list((struct string_list *)*dest,
2420 check_multi_string, (void *)key)))
2421 return ret;
2423 return 0;
2426 int git_configset_get(struct config_set *set, const char *key)
2428 struct config_set_element *e;
2429 int ret;
2431 if ((ret = configset_find_element(set, key, &e)))
2432 return ret;
2433 else if (!e)
2434 return 1;
2435 return 0;
2438 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2440 const char *value;
2441 if (!git_configset_get_value(set, key, &value, NULL))
2442 return git_config_string(dest, key, value);
2443 else
2444 return 1;
2447 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2448 const char **dest)
2450 const char *value;
2451 if (!git_configset_get_value(set, key, &value, NULL)) {
2452 if (!value)
2453 return config_error_nonbool(key);
2454 *dest = value;
2455 return 0;
2456 } else {
2457 return 1;
2461 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2463 const char *value;
2464 struct key_value_info kvi;
2466 if (!git_configset_get_value(set, key, &value, &kvi)) {
2467 *dest = git_config_int(key, value, &kvi);
2468 return 0;
2469 } else
2470 return 1;
2473 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2475 const char *value;
2476 struct key_value_info kvi;
2478 if (!git_configset_get_value(set, key, &value, &kvi)) {
2479 *dest = git_config_ulong(key, value, &kvi);
2480 return 0;
2481 } else
2482 return 1;
2485 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2487 const char *value;
2488 if (!git_configset_get_value(set, key, &value, NULL)) {
2489 *dest = git_config_bool(key, value);
2490 return 0;
2491 } else
2492 return 1;
2495 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2496 int *is_bool, int *dest)
2498 const char *value;
2499 struct key_value_info kvi;
2501 if (!git_configset_get_value(set, key, &value, &kvi)) {
2502 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2503 return 0;
2504 } else
2505 return 1;
2508 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2510 const char *value;
2511 if (!git_configset_get_value(set, key, &value, NULL)) {
2512 *dest = git_parse_maybe_bool(value);
2513 if (*dest == -1)
2514 return -1;
2515 return 0;
2516 } else
2517 return 1;
2520 int git_configset_get_pathname(struct config_set *set, const char *key, char **dest)
2522 const char *value;
2523 if (!git_configset_get_value(set, key, &value, NULL))
2524 return git_config_pathname(dest, key, value);
2525 else
2526 return 1;
2529 /* Functions use to read configuration from a repository */
2530 static void repo_read_config(struct repository *repo)
2532 struct config_options opts = { 0 };
2534 opts.respect_includes = 1;
2535 opts.commondir = repo->commondir;
2536 opts.git_dir = repo->gitdir;
2538 if (!repo->config)
2539 CALLOC_ARRAY(repo->config, 1);
2540 else
2541 git_configset_clear(repo->config);
2543 git_configset_init(repo->config);
2544 if (config_with_options(config_set_callback, repo->config, NULL,
2545 repo, &opts) < 0)
2547 * config_with_options() normally returns only
2548 * zero, as most errors are fatal, and
2549 * non-fatal potential errors are guarded by "if"
2550 * statements that are entered only when no error is
2551 * possible.
2553 * If we ever encounter a non-fatal error, it means
2554 * something went really wrong and we should stop
2555 * immediately.
2557 die(_("unknown error occurred while reading the configuration files"));
2560 static void git_config_check_init(struct repository *repo)
2562 if (repo->config && repo->config->hash_initialized)
2563 return;
2564 repo_read_config(repo);
2567 static void repo_config_clear(struct repository *repo)
2569 if (!repo->config || !repo->config->hash_initialized)
2570 return;
2571 git_configset_clear(repo->config);
2574 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2576 git_config_check_init(repo);
2577 configset_iter(repo->config, fn, data);
2580 int repo_config_get(struct repository *repo, const char *key)
2582 git_config_check_init(repo);
2583 return git_configset_get(repo->config, key);
2586 int repo_config_get_value(struct repository *repo,
2587 const char *key, const char **value)
2589 git_config_check_init(repo);
2590 return git_configset_get_value(repo->config, key, value, NULL);
2593 int repo_config_get_value_multi(struct repository *repo, const char *key,
2594 const struct string_list **dest)
2596 git_config_check_init(repo);
2597 return git_configset_get_value_multi(repo->config, key, dest);
2600 int repo_config_get_string_multi(struct repository *repo, const char *key,
2601 const struct string_list **dest)
2603 git_config_check_init(repo);
2604 return git_configset_get_string_multi(repo->config, key, dest);
2607 int repo_config_get_string(struct repository *repo,
2608 const char *key, char **dest)
2610 int ret;
2611 git_config_check_init(repo);
2612 ret = git_configset_get_string(repo->config, key, dest);
2613 if (ret < 0)
2614 git_die_config(key, NULL);
2615 return ret;
2618 int repo_config_get_string_tmp(struct repository *repo,
2619 const char *key, const char **dest)
2621 int ret;
2622 git_config_check_init(repo);
2623 ret = git_configset_get_string_tmp(repo->config, key, dest);
2624 if (ret < 0)
2625 git_die_config(key, NULL);
2626 return ret;
2629 int repo_config_get_int(struct repository *repo,
2630 const char *key, int *dest)
2632 git_config_check_init(repo);
2633 return git_configset_get_int(repo->config, key, dest);
2636 int repo_config_get_ulong(struct repository *repo,
2637 const char *key, unsigned long *dest)
2639 git_config_check_init(repo);
2640 return git_configset_get_ulong(repo->config, key, dest);
2643 int repo_config_get_bool(struct repository *repo,
2644 const char *key, int *dest)
2646 git_config_check_init(repo);
2647 return git_configset_get_bool(repo->config, key, dest);
2650 int repo_config_get_bool_or_int(struct repository *repo,
2651 const char *key, int *is_bool, int *dest)
2653 git_config_check_init(repo);
2654 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2657 int repo_config_get_maybe_bool(struct repository *repo,
2658 const char *key, int *dest)
2660 git_config_check_init(repo);
2661 return git_configset_get_maybe_bool(repo->config, key, dest);
2664 int repo_config_get_pathname(struct repository *repo,
2665 const char *key, char **dest)
2667 int ret;
2668 git_config_check_init(repo);
2669 ret = git_configset_get_pathname(repo->config, key, dest);
2670 if (ret < 0)
2671 git_die_config(key, NULL);
2672 return ret;
2675 /* Read values into protected_config. */
2676 static void read_protected_config(void)
2678 struct config_options opts = {
2679 .respect_includes = 1,
2680 .ignore_repo = 1,
2681 .ignore_worktree = 1,
2682 .system_gently = 1,
2685 git_configset_init(&protected_config);
2686 config_with_options(config_set_callback, &protected_config, NULL,
2687 NULL, &opts);
2690 void git_protected_config(config_fn_t fn, void *data)
2692 if (!protected_config.hash_initialized)
2693 read_protected_config();
2694 configset_iter(&protected_config, fn, data);
2697 /* Functions used historically to read configuration from 'the_repository' */
2698 void git_config(config_fn_t fn, void *data)
2700 repo_config(the_repository, fn, data);
2703 void git_config_clear(void)
2705 repo_config_clear(the_repository);
2708 int git_config_get(const char *key)
2710 return repo_config_get(the_repository, key);
2713 int git_config_get_value(const char *key, const char **value)
2715 return repo_config_get_value(the_repository, key, value);
2718 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2720 return repo_config_get_value_multi(the_repository, key, dest);
2723 int git_config_get_string_multi(const char *key,
2724 const struct string_list **dest)
2726 return repo_config_get_string_multi(the_repository, key, dest);
2729 int git_config_get_string(const char *key, char **dest)
2731 return repo_config_get_string(the_repository, key, dest);
2734 int git_config_get_string_tmp(const char *key, const char **dest)
2736 return repo_config_get_string_tmp(the_repository, key, dest);
2739 int git_config_get_int(const char *key, int *dest)
2741 return repo_config_get_int(the_repository, key, dest);
2744 int git_config_get_ulong(const char *key, unsigned long *dest)
2746 return repo_config_get_ulong(the_repository, key, dest);
2749 int git_config_get_bool(const char *key, int *dest)
2751 return repo_config_get_bool(the_repository, key, dest);
2754 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2756 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2759 int git_config_get_maybe_bool(const char *key, int *dest)
2761 return repo_config_get_maybe_bool(the_repository, key, dest);
2764 int git_config_get_pathname(const char *key, char **dest)
2766 return repo_config_get_pathname(the_repository, key, dest);
2769 int git_config_get_expiry(const char *key, const char **output)
2771 int ret = git_config_get_string(key, (char **)output);
2772 if (ret)
2773 return ret;
2774 if (strcmp(*output, "now")) {
2775 timestamp_t now = approxidate("now");
2776 if (approxidate(*output) >= now)
2777 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2779 return ret;
2782 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2784 const char *expiry_string;
2785 intmax_t days;
2786 timestamp_t when;
2788 if (git_config_get_string_tmp(key, &expiry_string))
2789 return 1; /* no such thing */
2791 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2792 const int scale = 86400;
2793 *expiry = now - days * scale;
2794 return 0;
2797 if (!parse_expiry_date(expiry_string, &when)) {
2798 *expiry = when;
2799 return 0;
2801 return -1; /* thing exists but cannot be parsed */
2804 int git_config_get_split_index(void)
2806 int val;
2808 if (!git_config_get_maybe_bool("core.splitindex", &val))
2809 return val;
2811 return -1; /* default value */
2814 int git_config_get_max_percent_split_change(void)
2816 int val = -1;
2818 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2819 if (0 <= val && val <= 100)
2820 return val;
2822 return error(_("splitIndex.maxPercentChange value '%d' "
2823 "should be between 0 and 100"), val);
2826 return -1; /* default value */
2829 int git_config_get_index_threads(int *dest)
2831 int is_bool, val;
2833 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2834 if (val) {
2835 *dest = val;
2836 return 0;
2839 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2840 if (is_bool)
2841 *dest = val ? 0 : 1;
2842 else
2843 *dest = val;
2844 return 0;
2847 return 1;
2850 NORETURN
2851 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2853 if (!filename)
2854 die(_("unable to parse '%s' from command-line config"), key);
2855 else
2856 die(_("bad config variable '%s' in file '%s' at line %d"),
2857 key, filename, linenr);
2860 void git_die_config(const char *key, const char *err, ...)
2862 const struct string_list *values;
2863 struct key_value_info *kv_info;
2864 report_fn error_fn = get_error_routine();
2866 if (err) {
2867 va_list params;
2868 va_start(params, err);
2869 error_fn(err, params);
2870 va_end(params);
2872 if (git_config_get_value_multi(key, &values))
2873 BUG("for key '%s' we must have a value to report on", key);
2874 kv_info = values->items[values->nr - 1].util;
2875 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2879 * Find all the stuff for git_config_set() below.
2882 struct config_store_data {
2883 size_t baselen;
2884 char *key;
2885 int do_not_match;
2886 const char *fixed_value;
2887 regex_t *value_pattern;
2888 int multi_replace;
2889 struct {
2890 size_t begin, end;
2891 enum config_event_t type;
2892 int is_keys_section;
2893 } *parsed;
2894 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2895 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2897 #define CONFIG_STORE_INIT { 0 }
2899 static void config_store_data_clear(struct config_store_data *store)
2901 free(store->key);
2902 if (store->value_pattern != NULL &&
2903 store->value_pattern != CONFIG_REGEX_NONE) {
2904 regfree(store->value_pattern);
2905 free(store->value_pattern);
2907 free(store->parsed);
2908 free(store->seen);
2909 memset(store, 0, sizeof(*store));
2912 static int matches(const char *key, const char *value,
2913 const struct config_store_data *store)
2915 if (strcmp(key, store->key))
2916 return 0; /* not ours */
2917 if (store->fixed_value && value)
2918 return !strcmp(store->fixed_value, value);
2919 if (!store->value_pattern)
2920 return 1; /* always matches */
2921 if (store->value_pattern == CONFIG_REGEX_NONE)
2922 return 0; /* never matches */
2924 return store->do_not_match ^
2925 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2928 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2929 struct config_source *cs, void *data)
2931 struct config_store_data *store = data;
2933 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2934 store->parsed[store->parsed_nr].begin = begin;
2935 store->parsed[store->parsed_nr].end = end;
2936 store->parsed[store->parsed_nr].type = type;
2938 if (type == CONFIG_EVENT_SECTION) {
2939 int (*cmpfn)(const char *, const char *, size_t);
2941 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2942 return error(_("invalid section name '%s'"), cs->var.buf);
2944 if (cs->subsection_case_sensitive)
2945 cmpfn = strncasecmp;
2946 else
2947 cmpfn = strncmp;
2949 /* Is this the section we were looking for? */
2950 store->is_keys_section =
2951 store->parsed[store->parsed_nr].is_keys_section =
2952 cs->var.len - 1 == store->baselen &&
2953 !cmpfn(cs->var.buf, store->key, store->baselen);
2954 if (store->is_keys_section) {
2955 store->section_seen = 1;
2956 ALLOC_GROW(store->seen, store->seen_nr + 1,
2957 store->seen_alloc);
2958 store->seen[store->seen_nr] = store->parsed_nr;
2962 store->parsed_nr++;
2964 return 0;
2967 static int store_aux(const char *key, const char *value,
2968 const struct config_context *ctx UNUSED, void *cb)
2970 struct config_store_data *store = cb;
2972 if (store->key_seen) {
2973 if (matches(key, value, store)) {
2974 if (store->seen_nr == 1 && store->multi_replace == 0) {
2975 warning(_("%s has multiple values"), key);
2978 ALLOC_GROW(store->seen, store->seen_nr + 1,
2979 store->seen_alloc);
2981 store->seen[store->seen_nr] = store->parsed_nr;
2982 store->seen_nr++;
2984 } else if (store->is_keys_section) {
2986 * Do not increment matches yet: this may not be a match, but we
2987 * are in the desired section.
2989 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2990 store->seen[store->seen_nr] = store->parsed_nr;
2991 store->section_seen = 1;
2993 if (matches(key, value, store)) {
2994 store->seen_nr++;
2995 store->key_seen = 1;
2999 return 0;
3002 static int write_error(const char *filename)
3004 error(_("failed to write new configuration file %s"), filename);
3006 /* Same error code as "failed to rename". */
3007 return 4;
3010 static struct strbuf store_create_section(const char *key,
3011 const struct config_store_data *store)
3013 const char *dot;
3014 size_t i;
3015 struct strbuf sb = STRBUF_INIT;
3017 dot = memchr(key, '.', store->baselen);
3018 if (dot) {
3019 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
3020 for (i = dot - key + 1; i < store->baselen; i++) {
3021 if (key[i] == '"' || key[i] == '\\')
3022 strbuf_addch(&sb, '\\');
3023 strbuf_addch(&sb, key[i]);
3025 strbuf_addstr(&sb, "\"]\n");
3026 } else {
3027 strbuf_addch(&sb, '[');
3028 strbuf_add(&sb, key, store->baselen);
3029 strbuf_addstr(&sb, "]\n");
3032 return sb;
3035 static ssize_t write_section(int fd, const char *key,
3036 const struct config_store_data *store)
3038 struct strbuf sb = store_create_section(key, store);
3039 ssize_t ret;
3041 ret = write_in_full(fd, sb.buf, sb.len);
3042 strbuf_release(&sb);
3044 return ret;
3047 static ssize_t write_pair(int fd, const char *key, const char *value,
3048 const char *comment,
3049 const struct config_store_data *store)
3051 int i;
3052 ssize_t ret;
3053 const char *quote = "";
3054 struct strbuf sb = STRBUF_INIT;
3057 * Check to see if the value needs to be surrounded with a dq pair.
3058 * Note that problematic characters are always backslash-quoted; this
3059 * check is about not losing leading or trailing SP and strings that
3060 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3061 * configuration parser.
3063 if (value[0] == ' ')
3064 quote = "\"";
3065 for (i = 0; value[i]; i++)
3066 if (value[i] == ';' || value[i] == '#')
3067 quote = "\"";
3068 if (i && value[i - 1] == ' ')
3069 quote = "\"";
3071 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3073 for (i = 0; value[i]; i++)
3074 switch (value[i]) {
3075 case '\n':
3076 strbuf_addstr(&sb, "\\n");
3077 break;
3078 case '\t':
3079 strbuf_addstr(&sb, "\\t");
3080 break;
3081 case '"':
3082 case '\\':
3083 strbuf_addch(&sb, '\\');
3084 /* fallthrough */
3085 default:
3086 strbuf_addch(&sb, value[i]);
3087 break;
3090 if (comment)
3091 strbuf_addf(&sb, "%s%s\n", quote, comment);
3092 else
3093 strbuf_addf(&sb, "%s\n", quote);
3095 ret = write_in_full(fd, sb.buf, sb.len);
3096 strbuf_release(&sb);
3098 return ret;
3102 * If we are about to unset the last key(s) in a section, and if there are
3103 * no comments surrounding (or included in) the section, we will want to
3104 * extend begin/end to remove the entire section.
3106 * Note: the parameter `seen_ptr` points to the index into the store.seen
3107 * array. * This index may be incremented if a section has more than one
3108 * entry (which all are to be removed).
3110 static void maybe_remove_section(struct config_store_data *store,
3111 size_t *begin_offset, size_t *end_offset,
3112 int *seen_ptr)
3114 size_t begin;
3115 int i, seen, section_seen = 0;
3118 * First, ensure that this is the first key, and that there are no
3119 * comments before the entry nor before the section header.
3121 seen = *seen_ptr;
3122 for (i = store->seen[seen]; i > 0; i--) {
3123 enum config_event_t type = store->parsed[i - 1].type;
3125 if (type == CONFIG_EVENT_COMMENT)
3126 /* There is a comment before this entry or section */
3127 return;
3128 if (type == CONFIG_EVENT_ENTRY) {
3129 if (!section_seen)
3130 /* This is not the section's first entry. */
3131 return;
3132 /* We encountered no comment before the section. */
3133 break;
3135 if (type == CONFIG_EVENT_SECTION) {
3136 if (!store->parsed[i - 1].is_keys_section)
3137 break;
3138 section_seen = 1;
3141 begin = store->parsed[i].begin;
3144 * Next, make sure that we are removing the last key(s) in the section,
3145 * and that there are no comments that are possibly about the current
3146 * section.
3148 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3149 enum config_event_t type = store->parsed[i].type;
3151 if (type == CONFIG_EVENT_COMMENT)
3152 return;
3153 if (type == CONFIG_EVENT_SECTION) {
3154 if (store->parsed[i].is_keys_section)
3155 continue;
3156 break;
3158 if (type == CONFIG_EVENT_ENTRY) {
3159 if (++seen < store->seen_nr &&
3160 i == store->seen[seen])
3161 /* We want to remove this entry, too */
3162 continue;
3163 /* There is another entry in this section. */
3164 return;
3169 * We are really removing the last entry/entries from this section, and
3170 * there are no enclosed or surrounding comments. Remove the entire,
3171 * now-empty section.
3173 *seen_ptr = seen;
3174 *begin_offset = begin;
3175 if (i < store->parsed_nr)
3176 *end_offset = store->parsed[i].begin;
3177 else
3178 *end_offset = store->parsed[store->parsed_nr - 1].end;
3181 int git_config_set_in_file_gently(const char *config_filename,
3182 const char *key, const char *comment, const char *value)
3184 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, comment, 0);
3187 void git_config_set_in_file(const char *config_filename,
3188 const char *key, const char *value)
3190 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3193 int git_config_set_gently(const char *key, const char *value)
3195 return git_config_set_multivar_gently(key, value, NULL, 0);
3198 int repo_config_set_worktree_gently(struct repository *r,
3199 const char *key, const char *value)
3201 /* Only use worktree-specific config if it is already enabled. */
3202 if (r->repository_format_worktree_config) {
3203 char *file = repo_git_path(r, "config.worktree");
3204 int ret = git_config_set_multivar_in_file_gently(
3205 file, key, value, NULL, NULL, 0);
3206 free(file);
3207 return ret;
3209 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3212 void git_config_set(const char *key, const char *value)
3214 git_config_set_multivar(key, value, NULL, 0);
3216 trace2_cmd_set_config(key, value);
3219 char *git_config_prepare_comment_string(const char *comment)
3221 size_t leading_blanks;
3222 char *prepared;
3224 if (!comment)
3225 return NULL;
3227 if (strchr(comment, '\n'))
3228 die(_("no multi-line comment allowed: '%s'"), comment);
3231 * If it begins with one or more leading whitespace characters
3232 * followed by '#", the comment string is used as-is.
3234 * If it begins with '#', a SP is inserted between the comment
3235 * and the value the comment is about.
3237 * Otherwise, the value is followed by a SP followed by '#'
3238 * followed by SP and then the comment string comes.
3241 leading_blanks = strspn(comment, " \t");
3242 if (leading_blanks && comment[leading_blanks] == '#')
3243 prepared = xstrdup(comment); /* use it as-is */
3244 else if (comment[0] == '#')
3245 prepared = xstrfmt(" %s", comment);
3246 else
3247 prepared = xstrfmt(" # %s", comment);
3249 return prepared;
3252 static void validate_comment_string(const char *comment)
3254 size_t leading_blanks;
3256 if (!comment)
3257 return;
3259 * The front-end must have massaged the comment string
3260 * properly before calling us.
3262 if (strchr(comment, '\n'))
3263 BUG("multi-line comments are not permitted: '%s'", comment);
3265 leading_blanks = strspn(comment, " \t");
3266 if (!leading_blanks || comment[leading_blanks] != '#')
3267 BUG("comment must begin with one or more SP followed by '#': '%s'",
3268 comment);
3272 * If value==NULL, unset in (remove from) config,
3273 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3274 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3275 * (only add a new one)
3276 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3277 * key/values are removed before a single new pair is written. If the
3278 * flag is not present, then replace only the first match.
3280 * Returns 0 on success.
3282 * This function does this:
3284 * - it locks the config file by creating ".git/config.lock"
3286 * - it then parses the config using store_aux() as validator to find
3287 * the position on the key/value pair to replace. If it is to be unset,
3288 * it must be found exactly once.
3290 * - the config file is mmap()ed and the part before the match (if any) is
3291 * written to the lock file, then the changed part and the rest.
3293 * - the config file is removed and the lock file rename()d to it.
3296 int git_config_set_multivar_in_file_gently(const char *config_filename,
3297 const char *key, const char *value,
3298 const char *value_pattern,
3299 const char *comment,
3300 unsigned flags)
3302 int fd = -1, in_fd = -1;
3303 int ret;
3304 struct lock_file lock = LOCK_INIT;
3305 char *filename_buf = NULL;
3306 char *contents = NULL;
3307 size_t contents_sz;
3308 struct config_store_data store = CONFIG_STORE_INIT;
3310 validate_comment_string(comment);
3312 /* parse-key returns negative; flip the sign to feed exit(3) */
3313 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3314 if (ret)
3315 goto out_free;
3317 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3319 if (!config_filename)
3320 config_filename = filename_buf = git_pathdup("config");
3323 * The lock serves a purpose in addition to locking: the new
3324 * contents of .git/config will be written into it.
3326 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3327 if (fd < 0) {
3328 error_errno(_("could not lock config file %s"), config_filename);
3329 ret = CONFIG_NO_LOCK;
3330 goto out_free;
3334 * If .git/config does not exist yet, write a minimal version.
3336 in_fd = open(config_filename, O_RDONLY);
3337 if ( in_fd < 0 ) {
3338 if ( ENOENT != errno ) {
3339 error_errno(_("opening %s"), config_filename);
3340 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3341 goto out_free;
3343 /* if nothing to unset, error out */
3344 if (!value) {
3345 ret = CONFIG_NOTHING_SET;
3346 goto out_free;
3349 free(store.key);
3350 store.key = xstrdup(key);
3351 if (write_section(fd, key, &store) < 0 ||
3352 write_pair(fd, key, value, comment, &store) < 0)
3353 goto write_err_out;
3354 } else {
3355 struct stat st;
3356 size_t copy_begin, copy_end;
3357 int i, new_line = 0;
3358 struct config_options opts;
3360 if (!value_pattern)
3361 store.value_pattern = NULL;
3362 else if (value_pattern == CONFIG_REGEX_NONE)
3363 store.value_pattern = CONFIG_REGEX_NONE;
3364 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3365 store.fixed_value = value_pattern;
3366 else {
3367 if (value_pattern[0] == '!') {
3368 store.do_not_match = 1;
3369 value_pattern++;
3370 } else
3371 store.do_not_match = 0;
3373 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3374 if (regcomp(store.value_pattern, value_pattern,
3375 REG_EXTENDED)) {
3376 error(_("invalid pattern: %s"), value_pattern);
3377 FREE_AND_NULL(store.value_pattern);
3378 ret = CONFIG_INVALID_PATTERN;
3379 goto out_free;
3383 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3384 store.parsed[0].end = 0;
3386 memset(&opts, 0, sizeof(opts));
3387 opts.event_fn = store_aux_event;
3388 opts.event_fn_data = &store;
3391 * After this, store.parsed will contain offsets of all the
3392 * parsed elements, and store.seen will contain a list of
3393 * matches, as indices into store.parsed.
3395 * As a side effect, we make sure to transform only a valid
3396 * existing config file.
3398 if (git_config_from_file_with_options(store_aux,
3399 config_filename,
3400 &store, CONFIG_SCOPE_UNKNOWN,
3401 &opts)) {
3402 error(_("invalid config file %s"), config_filename);
3403 ret = CONFIG_INVALID_FILE;
3404 goto out_free;
3407 /* if nothing to unset, or too many matches, error out */
3408 if ((store.seen_nr == 0 && value == NULL) ||
3409 (store.seen_nr > 1 && !store.multi_replace)) {
3410 ret = CONFIG_NOTHING_SET;
3411 goto out_free;
3414 if (fstat(in_fd, &st) == -1) {
3415 error_errno(_("fstat on %s failed"), config_filename);
3416 ret = CONFIG_INVALID_FILE;
3417 goto out_free;
3420 contents_sz = xsize_t(st.st_size);
3421 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3422 MAP_PRIVATE, in_fd, 0);
3423 if (contents == MAP_FAILED) {
3424 if (errno == ENODEV && S_ISDIR(st.st_mode))
3425 errno = EISDIR;
3426 error_errno(_("unable to mmap '%s'%s"),
3427 config_filename, mmap_os_err());
3428 ret = CONFIG_INVALID_FILE;
3429 contents = NULL;
3430 goto out_free;
3432 close(in_fd);
3433 in_fd = -1;
3435 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3436 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3437 ret = CONFIG_NO_WRITE;
3438 goto out_free;
3441 if (store.seen_nr == 0) {
3442 if (!store.seen_alloc) {
3443 /* Did not see key nor section */
3444 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3445 store.seen[0] = store.parsed_nr
3446 - !!store.parsed_nr;
3448 store.seen_nr = 1;
3451 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3452 size_t replace_end;
3453 int j = store.seen[i];
3455 new_line = 0;
3456 if (!store.key_seen) {
3457 copy_end = store.parsed[j].end;
3458 /* include '\n' when copying section header */
3459 if (copy_end > 0 && copy_end < contents_sz &&
3460 contents[copy_end - 1] != '\n' &&
3461 contents[copy_end] == '\n')
3462 copy_end++;
3463 replace_end = copy_end;
3464 } else {
3465 replace_end = store.parsed[j].end;
3466 copy_end = store.parsed[j].begin;
3467 if (!value)
3468 maybe_remove_section(&store,
3469 &copy_end,
3470 &replace_end, &i);
3472 * Swallow preceding white-space on the same
3473 * line.
3475 while (copy_end > 0 ) {
3476 char c = contents[copy_end - 1];
3478 if (isspace(c) && c != '\n')
3479 copy_end--;
3480 else
3481 break;
3485 if (copy_end > 0 && contents[copy_end-1] != '\n')
3486 new_line = 1;
3488 /* write the first part of the config */
3489 if (copy_end > copy_begin) {
3490 if (write_in_full(fd, contents + copy_begin,
3491 copy_end - copy_begin) < 0)
3492 goto write_err_out;
3493 if (new_line &&
3494 write_str_in_full(fd, "\n") < 0)
3495 goto write_err_out;
3497 copy_begin = replace_end;
3500 /* write the pair (value == NULL means unset) */
3501 if (value) {
3502 if (!store.section_seen) {
3503 if (write_section(fd, key, &store) < 0)
3504 goto write_err_out;
3506 if (write_pair(fd, key, value, comment, &store) < 0)
3507 goto write_err_out;
3510 /* write the rest of the config */
3511 if (copy_begin < contents_sz)
3512 if (write_in_full(fd, contents + copy_begin,
3513 contents_sz - copy_begin) < 0)
3514 goto write_err_out;
3516 munmap(contents, contents_sz);
3517 contents = NULL;
3520 if (commit_lock_file(&lock) < 0) {
3521 error_errno(_("could not write config file %s"), config_filename);
3522 ret = CONFIG_NO_WRITE;
3523 goto out_free;
3526 ret = 0;
3528 /* Invalidate the config cache */
3529 git_config_clear();
3531 out_free:
3532 rollback_lock_file(&lock);
3533 free(filename_buf);
3534 if (contents)
3535 munmap(contents, contents_sz);
3536 if (in_fd >= 0)
3537 close(in_fd);
3538 config_store_data_clear(&store);
3539 return ret;
3541 write_err_out:
3542 ret = write_error(get_lock_file_path(&lock));
3543 goto out_free;
3546 void git_config_set_multivar_in_file(const char *config_filename,
3547 const char *key, const char *value,
3548 const char *value_pattern, unsigned flags)
3550 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3551 value_pattern, NULL, flags))
3552 return;
3553 if (value)
3554 die(_("could not set '%s' to '%s'"), key, value);
3555 else
3556 die(_("could not unset '%s'"), key);
3559 int git_config_set_multivar_gently(const char *key, const char *value,
3560 const char *value_pattern, unsigned flags)
3562 return repo_config_set_multivar_gently(the_repository, key, value,
3563 value_pattern, flags);
3566 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3567 const char *value,
3568 const char *value_pattern, unsigned flags)
3570 char *file = repo_git_path(r, "config");
3571 int res = git_config_set_multivar_in_file_gently(file,
3572 key, value,
3573 value_pattern,
3574 NULL, flags);
3575 free(file);
3576 return res;
3579 void git_config_set_multivar(const char *key, const char *value,
3580 const char *value_pattern, unsigned flags)
3582 git_config_set_multivar_in_file(git_path("config"),
3583 key, value, value_pattern,
3584 flags);
3587 static size_t section_name_match (const char *buf, const char *name)
3589 size_t i = 0, j = 0;
3590 int dot = 0;
3591 if (buf[i] != '[')
3592 return 0;
3593 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3594 if (!dot && isspace(buf[i])) {
3595 dot = 1;
3596 if (name[j++] != '.')
3597 break;
3598 for (i++; isspace(buf[i]); i++)
3599 ; /* do nothing */
3600 if (buf[i] != '"')
3601 break;
3602 continue;
3604 if (buf[i] == '\\' && dot)
3605 i++;
3606 else if (buf[i] == '"' && dot) {
3607 for (i++; isspace(buf[i]); i++)
3608 ; /* do_nothing */
3609 break;
3611 if (buf[i] != name[j++])
3612 break;
3614 if (buf[i] == ']' && name[j] == 0) {
3616 * We match, now just find the right length offset by
3617 * gobbling up any whitespace after it, as well
3619 i++;
3620 for (; buf[i] && isspace(buf[i]); i++)
3621 ; /* do nothing */
3622 return i;
3624 return 0;
3627 static int section_name_is_ok(const char *name)
3629 /* Empty section names are bogus. */
3630 if (!*name)
3631 return 0;
3634 * Before a dot, we must be alphanumeric or dash. After the first dot,
3635 * anything goes, so we can stop checking.
3637 for (; *name && *name != '.'; name++)
3638 if (*name != '-' && !isalnum(*name))
3639 return 0;
3640 return 1;
3643 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3645 /* if new_name == NULL, the section is removed instead */
3646 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3647 const char *old_name,
3648 const char *new_name, int copy)
3650 int ret = 0, remove = 0;
3651 char *filename_buf = NULL;
3652 struct lock_file lock = LOCK_INIT;
3653 int out_fd;
3654 struct strbuf buf = STRBUF_INIT;
3655 FILE *config_file = NULL;
3656 struct stat st;
3657 struct strbuf copystr = STRBUF_INIT;
3658 struct config_store_data store;
3659 uint32_t line_nr = 0;
3661 memset(&store, 0, sizeof(store));
3663 if (new_name && !section_name_is_ok(new_name)) {
3664 ret = error(_("invalid section name: %s"), new_name);
3665 goto out_no_rollback;
3668 if (!config_filename)
3669 config_filename = filename_buf = git_pathdup("config");
3671 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3672 if (out_fd < 0) {
3673 ret = error(_("could not lock config file %s"), config_filename);
3674 goto out;
3677 if (!(config_file = fopen(config_filename, "rb"))) {
3678 ret = warn_on_fopen_errors(config_filename);
3679 if (ret)
3680 goto out;
3681 /* no config file means nothing to rename, no error */
3682 goto commit_and_out;
3685 if (fstat(fileno(config_file), &st) == -1) {
3686 ret = error_errno(_("fstat on %s failed"), config_filename);
3687 goto out;
3690 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3691 ret = error_errno(_("chmod on %s failed"),
3692 get_lock_file_path(&lock));
3693 goto out;
3696 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3697 size_t i, length;
3698 int is_section = 0;
3699 char *output = buf.buf;
3701 line_nr++;
3703 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3704 ret = error(_("refusing to work with overly long line "
3705 "in '%s' on line %"PRIuMAX),
3706 config_filename, (uintmax_t)line_nr);
3707 goto out;
3710 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3711 ; /* do nothing */
3712 if (buf.buf[i] == '[') {
3713 /* it's a section */
3714 size_t offset;
3715 is_section = 1;
3718 * When encountering a new section under -c we
3719 * need to flush out any section we're already
3720 * coping and begin anew. There might be
3721 * multiple [branch "$name"] sections.
3723 if (copystr.len > 0) {
3724 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3725 ret = write_error(get_lock_file_path(&lock));
3726 goto out;
3728 strbuf_reset(&copystr);
3731 offset = section_name_match(&buf.buf[i], old_name);
3732 if (offset > 0) {
3733 ret++;
3734 if (!new_name) {
3735 remove = 1;
3736 continue;
3738 store.baselen = strlen(new_name);
3739 if (!copy) {
3740 if (write_section(out_fd, new_name, &store) < 0) {
3741 ret = write_error(get_lock_file_path(&lock));
3742 goto out;
3745 * We wrote out the new section, with
3746 * a newline, now skip the old
3747 * section's length
3749 output += offset + i;
3750 if (strlen(output) > 0) {
3752 * More content means there's
3753 * a declaration to put on the
3754 * next line; indent with a
3755 * tab
3757 output -= 1;
3758 output[0] = '\t';
3760 } else {
3761 strbuf_release(&copystr);
3762 copystr = store_create_section(new_name, &store);
3765 remove = 0;
3767 if (remove)
3768 continue;
3769 length = strlen(output);
3771 if (!is_section && copystr.len > 0) {
3772 strbuf_add(&copystr, output, length);
3775 if (write_in_full(out_fd, output, length) < 0) {
3776 ret = write_error(get_lock_file_path(&lock));
3777 goto out;
3782 * Copy a trailing section at the end of the config, won't be
3783 * flushed by the usual "flush because we have a new section
3784 * logic in the loop above.
3786 if (copystr.len > 0) {
3787 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3788 ret = write_error(get_lock_file_path(&lock));
3789 goto out;
3791 strbuf_reset(&copystr);
3794 fclose(config_file);
3795 config_file = NULL;
3796 commit_and_out:
3797 if (commit_lock_file(&lock) < 0)
3798 ret = error_errno(_("could not write config file %s"),
3799 config_filename);
3800 out:
3801 if (config_file)
3802 fclose(config_file);
3803 rollback_lock_file(&lock);
3804 out_no_rollback:
3805 free(filename_buf);
3806 config_store_data_clear(&store);
3807 strbuf_release(&buf);
3808 strbuf_release(&copystr);
3809 return ret;
3812 int git_config_rename_section_in_file(const char *config_filename,
3813 const char *old_name, const char *new_name)
3815 return git_config_copy_or_rename_section_in_file(config_filename,
3816 old_name, new_name, 0);
3819 int git_config_rename_section(const char *old_name, const char *new_name)
3821 return git_config_rename_section_in_file(NULL, old_name, new_name);
3824 int git_config_copy_section_in_file(const char *config_filename,
3825 const char *old_name, const char *new_name)
3827 return git_config_copy_or_rename_section_in_file(config_filename,
3828 old_name, new_name, 1);
3831 int git_config_copy_section(const char *old_name, const char *new_name)
3833 return git_config_copy_section_in_file(NULL, old_name, new_name);
3837 * Call this to report error for your variable that should not
3838 * get a boolean value (i.e. "[my] var" means "true").
3840 #undef config_error_nonbool
3841 int config_error_nonbool(const char *var)
3843 return error(_("missing value for '%s'"), var);
3846 int parse_config_key(const char *var,
3847 const char *section,
3848 const char **subsection, size_t *subsection_len,
3849 const char **key)
3851 const char *dot;
3853 /* Does it start with "section." ? */
3854 if (!skip_prefix(var, section, &var) || *var != '.')
3855 return -1;
3858 * Find the key; we don't know yet if we have a subsection, but we must
3859 * parse backwards from the end, since the subsection may have dots in
3860 * it, too.
3862 dot = strrchr(var, '.');
3863 *key = dot + 1;
3865 /* Did we have a subsection at all? */
3866 if (dot == var) {
3867 if (subsection) {
3868 *subsection = NULL;
3869 *subsection_len = 0;
3872 else {
3873 if (!subsection)
3874 return -1;
3875 *subsection = var + 1;
3876 *subsection_len = dot - *subsection;
3879 return 0;
3882 const char *config_origin_type_name(enum config_origin_type type)
3884 switch (type) {
3885 case CONFIG_ORIGIN_BLOB:
3886 return "blob";
3887 case CONFIG_ORIGIN_FILE:
3888 return "file";
3889 case CONFIG_ORIGIN_STDIN:
3890 return "standard input";
3891 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3892 return "submodule-blob";
3893 case CONFIG_ORIGIN_CMDLINE:
3894 return "command line";
3895 default:
3896 BUG("unknown config origin type");
3900 const char *config_scope_name(enum config_scope scope)
3902 switch (scope) {
3903 case CONFIG_SCOPE_SYSTEM:
3904 return "system";
3905 case CONFIG_SCOPE_GLOBAL:
3906 return "global";
3907 case CONFIG_SCOPE_LOCAL:
3908 return "local";
3909 case CONFIG_SCOPE_WORKTREE:
3910 return "worktree";
3911 case CONFIG_SCOPE_COMMAND:
3912 return "command";
3913 case CONFIG_SCOPE_SUBMODULE:
3914 return "submodule";
3915 default:
3916 return "unknown";
3920 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3922 int i;
3924 for (i = 0; i < nr_mapping; i++) {
3925 const char *name = mapping[i];
3927 if (name && !strcasecmp(var, name))
3928 return i;
3930 return -1;