reftable/block: better grouping of functions
[git.git] / config.c
blobeebce8c7e09393fa8756230e483965674b9afbdf
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "git-compat-util.h"
9 #include "abspath.h"
10 #include "advice.h"
11 #include "date.h"
12 #include "branch.h"
13 #include "config.h"
14 #include "parse.h"
15 #include "convert.h"
16 #include "environment.h"
17 #include "gettext.h"
18 #include "ident.h"
19 #include "repository.h"
20 #include "lockfile.h"
21 #include "mailmap.h"
22 #include "attr.h"
23 #include "exec-cmd.h"
24 #include "strbuf.h"
25 #include "quote.h"
26 #include "hashmap.h"
27 #include "string-list.h"
28 #include "object-name.h"
29 #include "object-store-ll.h"
30 #include "pager.h"
31 #include "path.h"
32 #include "utf8.h"
33 #include "color.h"
34 #include "refs.h"
35 #include "setup.h"
36 #include "strvec.h"
37 #include "trace2.h"
38 #include "wildmatch.h"
39 #include "ws.h"
40 #include "write-or-die.h"
42 struct config_source {
43 struct config_source *prev;
44 union {
45 FILE *file;
46 struct config_buf {
47 const char *buf;
48 size_t len;
49 size_t pos;
50 } buf;
51 } u;
52 enum config_origin_type origin_type;
53 const char *name;
54 const char *path;
55 enum config_error_action default_error_action;
56 int linenr;
57 int eof;
58 size_t total_len;
59 struct strbuf value;
60 struct strbuf var;
61 unsigned subsection_case_sensitive : 1;
63 int (*do_fgetc)(struct config_source *c);
64 int (*do_ungetc)(int c, struct config_source *conf);
65 long (*do_ftell)(struct config_source *c);
67 #define CONFIG_SOURCE_INIT { 0 }
69 static int pack_compression_seen;
70 static int zlib_compression_seen;
73 * Config that comes from trusted scopes, namely:
74 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
75 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
76 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
78 * This is declared here for code cleanliness, but unlike the other
79 * static variables, this does not hold config parser state.
81 static struct config_set protected_config;
83 static int config_file_fgetc(struct config_source *conf)
85 return getc_unlocked(conf->u.file);
88 static int config_file_ungetc(int c, struct config_source *conf)
90 return ungetc(c, conf->u.file);
93 static long config_file_ftell(struct config_source *conf)
95 return ftell(conf->u.file);
98 static int config_buf_fgetc(struct config_source *conf)
100 if (conf->u.buf.pos < conf->u.buf.len)
101 return conf->u.buf.buf[conf->u.buf.pos++];
103 return EOF;
106 static int config_buf_ungetc(int c, struct config_source *conf)
108 if (conf->u.buf.pos > 0) {
109 conf->u.buf.pos--;
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
111 BUG("config_buf can only ungetc the same character");
112 return c;
115 return EOF;
118 static long config_buf_ftell(struct config_source *conf)
120 return conf->u.buf.pos;
123 struct config_include_data {
124 int depth;
125 config_fn_t fn;
126 void *data;
127 const struct config_options *opts;
128 struct git_config_source *config_source;
129 struct repository *repo;
132 * All remote URLs discovered when reading all config files.
134 struct string_list *remote_urls;
136 #define CONFIG_INCLUDE_INIT { 0 }
138 static int git_config_include(const char *var, const char *value,
139 const struct config_context *ctx, void *data);
141 #define MAX_INCLUDE_DEPTH 10
142 static const char include_depth_advice[] = N_(
143 "exceeded maximum include depth (%d) while including\n"
144 " %s\n"
145 "from\n"
146 " %s\n"
147 "This might be due to circular includes.");
148 static int handle_path_include(const struct key_value_info *kvi,
149 const char *path,
150 struct config_include_data *inc)
152 int ret = 0;
153 struct strbuf buf = STRBUF_INIT;
154 char *expanded;
156 if (!path)
157 return config_error_nonbool("include.path");
159 expanded = interpolate_path(path, 0);
160 if (!expanded)
161 return error(_("could not expand include path '%s'"), path);
162 path = expanded;
165 * Use an absolute path as-is, but interpret relative paths
166 * based on the including config file.
168 if (!is_absolute_path(path)) {
169 char *slash;
171 if (!kvi || !kvi->path) {
172 ret = error(_("relative config includes must come from files"));
173 goto cleanup;
176 slash = find_last_dir_sep(kvi->path);
177 if (slash)
178 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
179 strbuf_addstr(&buf, path);
180 path = buf.buf;
183 if (!access_or_die(path, R_OK, 0)) {
184 if (++inc->depth > MAX_INCLUDE_DEPTH)
185 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
186 !kvi ? "<unknown>" :
187 kvi->filename ? kvi->filename :
188 "the command line");
189 ret = git_config_from_file_with_options(git_config_include, path, inc,
190 kvi->scope, NULL);
191 inc->depth--;
193 cleanup:
194 strbuf_release(&buf);
195 free(expanded);
196 return ret;
199 static void add_trailing_starstar_for_dir(struct strbuf *pat)
201 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
202 strbuf_addstr(pat, "**");
205 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
206 struct strbuf *pat)
208 struct strbuf path = STRBUF_INIT;
209 char *expanded;
210 int prefix = 0;
212 expanded = interpolate_path(pat->buf, 1);
213 if (expanded) {
214 strbuf_reset(pat);
215 strbuf_addstr(pat, expanded);
216 free(expanded);
219 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
220 const char *slash;
222 if (!kvi || !kvi->path)
223 return error(_("relative config include "
224 "conditionals must come from files"));
226 strbuf_realpath(&path, kvi->path, 1);
227 slash = find_last_dir_sep(path.buf);
228 if (!slash)
229 BUG("how is this possible?");
230 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
231 prefix = slash - path.buf + 1 /* slash */;
232 } else if (!is_absolute_path(pat->buf))
233 strbuf_insertstr(pat, 0, "**/");
235 add_trailing_starstar_for_dir(pat);
237 strbuf_release(&path);
238 return prefix;
241 static int include_by_gitdir(const struct key_value_info *kvi,
242 const struct config_options *opts,
243 const char *cond, size_t cond_len, int icase)
245 struct strbuf text = STRBUF_INIT;
246 struct strbuf pattern = STRBUF_INIT;
247 int ret = 0, prefix;
248 const char *git_dir;
249 int already_tried_absolute = 0;
251 if (opts->git_dir)
252 git_dir = opts->git_dir;
253 else
254 goto done;
256 strbuf_realpath(&text, git_dir, 1);
257 strbuf_add(&pattern, cond, cond_len);
258 prefix = prepare_include_condition_pattern(kvi, &pattern);
260 again:
261 if (prefix < 0)
262 goto done;
264 if (prefix > 0) {
266 * perform literal matching on the prefix part so that
267 * any wildcard character in it can't create side effects.
269 if (text.len < prefix)
270 goto done;
271 if (!icase && strncmp(pattern.buf, text.buf, prefix))
272 goto done;
273 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
274 goto done;
277 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
278 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
280 if (!ret && !already_tried_absolute) {
282 * We've tried e.g. matching gitdir:~/work, but if
283 * ~/work is a symlink to /mnt/storage/work
284 * strbuf_realpath() will expand it, so the rule won't
285 * match. Let's match against a
286 * strbuf_add_absolute_path() version of the path,
287 * which'll do the right thing
289 strbuf_reset(&text);
290 strbuf_add_absolute_path(&text, git_dir);
291 already_tried_absolute = 1;
292 goto again;
294 done:
295 strbuf_release(&pattern);
296 strbuf_release(&text);
297 return ret;
300 static int include_by_branch(const char *cond, size_t cond_len)
302 int flags;
303 int ret;
304 struct strbuf pattern = STRBUF_INIT;
305 const char *refname = !the_repository->gitdir ?
306 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
307 const char *shortname;
309 if (!refname || !(flags & REF_ISSYMREF) ||
310 !skip_prefix(refname, "refs/heads/", &shortname))
311 return 0;
313 strbuf_add(&pattern, cond, cond_len);
314 add_trailing_starstar_for_dir(&pattern);
315 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
316 strbuf_release(&pattern);
317 return ret;
320 static int add_remote_url(const char *var, const char *value,
321 const struct config_context *ctx UNUSED, void *data)
323 struct string_list *remote_urls = data;
324 const char *remote_name;
325 size_t remote_name_len;
326 const char *key;
328 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
329 &key) &&
330 remote_name &&
331 !strcmp(key, "url"))
332 string_list_append(remote_urls, value);
333 return 0;
336 static void populate_remote_urls(struct config_include_data *inc)
338 struct config_options opts;
340 opts = *inc->opts;
341 opts.unconditional_remote_url = 1;
343 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
344 string_list_init_dup(inc->remote_urls);
345 config_with_options(add_remote_url, inc->remote_urls,
346 inc->config_source, inc->repo, &opts);
349 static int forbid_remote_url(const char *var, const char *value UNUSED,
350 const struct config_context *ctx UNUSED,
351 void *data UNUSED)
353 const char *remote_name;
354 size_t remote_name_len;
355 const char *key;
357 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
358 &key) &&
359 remote_name &&
360 !strcmp(key, "url"))
361 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
362 return 0;
365 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
366 struct string_list *remote_urls)
368 struct strbuf pattern = STRBUF_INIT;
369 struct string_list_item *url_item;
370 int found = 0;
372 strbuf_add(&pattern, glob, glob_len);
373 for_each_string_list_item(url_item, remote_urls) {
374 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
375 found = 1;
376 break;
379 strbuf_release(&pattern);
380 return found;
383 static int include_by_remote_url(struct config_include_data *inc,
384 const char *cond, size_t cond_len)
386 if (inc->opts->unconditional_remote_url)
387 return 1;
388 if (!inc->remote_urls)
389 populate_remote_urls(inc);
390 return at_least_one_url_matches_glob(cond, cond_len,
391 inc->remote_urls);
394 static int include_condition_is_true(const struct key_value_info *kvi,
395 struct config_include_data *inc,
396 const char *cond, size_t cond_len)
398 const struct config_options *opts = inc->opts;
400 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
401 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
402 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
403 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
404 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
405 return include_by_branch(cond, cond_len);
406 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
407 &cond_len))
408 return include_by_remote_url(inc, cond, cond_len);
410 /* unknown conditionals are always false */
411 return 0;
414 static int git_config_include(const char *var, const char *value,
415 const struct config_context *ctx,
416 void *data)
418 struct config_include_data *inc = data;
419 const char *cond, *key;
420 size_t cond_len;
421 int ret;
424 * Pass along all values, including "include" directives; this makes it
425 * possible to query information on the includes themselves.
427 ret = inc->fn(var, value, ctx, inc->data);
428 if (ret < 0)
429 return ret;
431 if (!strcmp(var, "include.path"))
432 ret = handle_path_include(ctx->kvi, value, inc);
434 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
435 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
436 !strcmp(key, "path")) {
437 config_fn_t old_fn = inc->fn;
439 if (inc->opts->unconditional_remote_url)
440 inc->fn = forbid_remote_url;
441 ret = handle_path_include(ctx->kvi, value, inc);
442 inc->fn = old_fn;
445 return ret;
448 static void git_config_push_split_parameter(const char *key, const char *value)
450 struct strbuf env = STRBUF_INIT;
451 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
452 if (old && *old) {
453 strbuf_addstr(&env, old);
454 strbuf_addch(&env, ' ');
456 sq_quote_buf(&env, key);
457 strbuf_addch(&env, '=');
458 if (value)
459 sq_quote_buf(&env, value);
460 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
461 strbuf_release(&env);
464 void git_config_push_parameter(const char *text)
466 const char *value;
469 * When we see:
471 * section.subsection=with=equals.key=value
473 * we cannot tell if it means:
475 * [section "subsection=with=equals"]
476 * key = value
478 * or:
480 * [section]
481 * subsection = with=equals.key=value
483 * We parse left-to-right for the first "=", meaning we'll prefer to
484 * keep the value intact over the subsection. This is historical, but
485 * also sensible since values are more likely to contain odd or
486 * untrusted input than a section name.
488 * A missing equals is explicitly allowed (as a bool-only entry).
490 value = strchr(text, '=');
491 if (value) {
492 char *key = xmemdupz(text, value - text);
493 git_config_push_split_parameter(key, value + 1);
494 free(key);
495 } else {
496 git_config_push_split_parameter(text, NULL);
500 void git_config_push_env(const char *spec)
502 char *key;
503 const char *env_name;
504 const char *env_value;
506 env_name = strrchr(spec, '=');
507 if (!env_name)
508 die(_("invalid config format: %s"), spec);
509 key = xmemdupz(spec, env_name - spec);
510 env_name++;
511 if (!*env_name)
512 die(_("missing environment variable name for configuration '%.*s'"),
513 (int)(env_name - spec - 1), spec);
515 env_value = getenv(env_name);
516 if (!env_value)
517 die(_("missing environment variable '%s' for configuration '%.*s'"),
518 env_name, (int)(env_name - spec - 1), spec);
520 git_config_push_split_parameter(key, env_value);
521 free(key);
524 static inline int iskeychar(int c)
526 return isalnum(c) || c == '-';
530 * Auxiliary function to sanity-check and split the key into the section
531 * identifier and variable name.
533 * Returns 0 on success, -1 when there is an invalid character in the key and
534 * -2 if there is no section name in the key.
536 * store_key - pointer to char* which will hold a copy of the key with
537 * lowercase section and variable name
538 * baselen - pointer to size_t which will hold the length of the
539 * section + subsection part, can be NULL
541 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
543 size_t i, baselen;
544 int dot;
545 const char *last_dot = strrchr(key, '.');
548 * Since "key" actually contains the section name and the real
549 * key name separated by a dot, we have to know where the dot is.
552 if (last_dot == NULL || last_dot == key) {
553 error(_("key does not contain a section: %s"), key);
554 return -CONFIG_NO_SECTION_OR_NAME;
557 if (!last_dot[1]) {
558 error(_("key does not contain variable name: %s"), key);
559 return -CONFIG_NO_SECTION_OR_NAME;
562 baselen = last_dot - key;
563 if (baselen_)
564 *baselen_ = baselen;
567 * Validate the key and while at it, lower case it for matching.
569 *store_key = xmallocz(strlen(key));
571 dot = 0;
572 for (i = 0; key[i]; i++) {
573 unsigned char c = key[i];
574 if (c == '.')
575 dot = 1;
576 /* Leave the extended basename untouched.. */
577 if (!dot || i > baselen) {
578 if (!iskeychar(c) ||
579 (i == baselen + 1 && !isalpha(c))) {
580 error(_("invalid key: %s"), key);
581 goto out_free_ret_1;
583 c = tolower(c);
584 } else if (c == '\n') {
585 error(_("invalid key (newline): %s"), key);
586 goto out_free_ret_1;
588 (*store_key)[i] = c;
591 return 0;
593 out_free_ret_1:
594 FREE_AND_NULL(*store_key);
595 return -CONFIG_INVALID_KEY;
598 static int config_parse_pair(const char *key, const char *value,
599 struct key_value_info *kvi,
600 config_fn_t fn, void *data)
602 char *canonical_name;
603 int ret;
604 struct config_context ctx = {
605 .kvi = kvi,
608 if (!strlen(key))
609 return error(_("empty config key"));
610 if (git_config_parse_key(key, &canonical_name, NULL))
611 return -1;
613 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
614 free(canonical_name);
615 return ret;
619 /* for values read from `git_config_from_parameters()` */
620 void kvi_from_param(struct key_value_info *out)
622 out->filename = NULL;
623 out->linenr = -1;
624 out->origin_type = CONFIG_ORIGIN_CMDLINE;
625 out->scope = CONFIG_SCOPE_COMMAND;
626 out->path = NULL;
629 int git_config_parse_parameter(const char *text,
630 config_fn_t fn, void *data)
632 const char *value;
633 struct strbuf **pair;
634 int ret;
635 struct key_value_info kvi = KVI_INIT;
637 kvi_from_param(&kvi);
639 pair = strbuf_split_str(text, '=', 2);
640 if (!pair[0])
641 return error(_("bogus config parameter: %s"), text);
643 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
644 strbuf_setlen(pair[0], pair[0]->len - 1);
645 value = pair[1] ? pair[1]->buf : "";
646 } else {
647 value = NULL;
650 strbuf_trim(pair[0]);
651 if (!pair[0]->len) {
652 strbuf_list_free(pair);
653 return error(_("bogus config parameter: %s"), text);
656 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
657 strbuf_list_free(pair);
658 return ret;
661 static int parse_config_env_list(char *env, struct key_value_info *kvi,
662 config_fn_t fn, void *data)
664 char *cur = env;
665 while (cur && *cur) {
666 const char *key = sq_dequote_step(cur, &cur);
667 if (!key)
668 return error(_("bogus format in %s"),
669 CONFIG_DATA_ENVIRONMENT);
671 if (!cur || isspace(*cur)) {
672 /* old-style 'key=value' */
673 if (git_config_parse_parameter(key, fn, data) < 0)
674 return -1;
676 else if (*cur == '=') {
677 /* new-style 'key'='value' */
678 const char *value;
680 cur++;
681 if (*cur == '\'') {
682 /* quoted value */
683 value = sq_dequote_step(cur, &cur);
684 if (!value || (cur && !isspace(*cur))) {
685 return error(_("bogus format in %s"),
686 CONFIG_DATA_ENVIRONMENT);
688 } else if (!*cur || isspace(*cur)) {
689 /* implicit bool: 'key'= */
690 value = NULL;
691 } else {
692 return error(_("bogus format in %s"),
693 CONFIG_DATA_ENVIRONMENT);
696 if (config_parse_pair(key, value, kvi, fn, data) < 0)
697 return -1;
699 else {
700 /* unknown format */
701 return error(_("bogus format in %s"),
702 CONFIG_DATA_ENVIRONMENT);
705 if (cur) {
706 while (isspace(*cur))
707 cur++;
710 return 0;
713 int git_config_from_parameters(config_fn_t fn, void *data)
715 const char *env;
716 struct strbuf envvar = STRBUF_INIT;
717 struct strvec to_free = STRVEC_INIT;
718 int ret = 0;
719 char *envw = NULL;
720 struct key_value_info kvi = KVI_INIT;
722 kvi_from_param(&kvi);
723 env = getenv(CONFIG_COUNT_ENVIRONMENT);
724 if (env) {
725 unsigned long count;
726 char *endp;
727 int i;
729 count = strtoul(env, &endp, 10);
730 if (*endp) {
731 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
732 goto out;
734 if (count > INT_MAX) {
735 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
736 goto out;
739 for (i = 0; i < count; i++) {
740 const char *key, *value;
742 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
743 key = getenv_safe(&to_free, envvar.buf);
744 if (!key) {
745 ret = error(_("missing config key %s"), envvar.buf);
746 goto out;
748 strbuf_reset(&envvar);
750 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
751 value = getenv_safe(&to_free, envvar.buf);
752 if (!value) {
753 ret = error(_("missing config value %s"), envvar.buf);
754 goto out;
756 strbuf_reset(&envvar);
758 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
759 ret = -1;
760 goto out;
765 env = getenv(CONFIG_DATA_ENVIRONMENT);
766 if (env) {
767 /* sq_dequote will write over it */
768 envw = xstrdup(env);
769 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
770 ret = -1;
771 goto out;
775 out:
776 strbuf_release(&envvar);
777 strvec_clear(&to_free);
778 free(envw);
779 return ret;
782 static int get_next_char(struct config_source *cs)
784 int c = cs->do_fgetc(cs);
786 if (c == '\r') {
787 /* DOS like systems */
788 c = cs->do_fgetc(cs);
789 if (c != '\n') {
790 if (c != EOF)
791 cs->do_ungetc(c, cs);
792 c = '\r';
796 if (c != EOF && ++cs->total_len > INT_MAX) {
798 * This is an absurdly long config file; refuse to parse
799 * further in order to protect downstream code from integer
800 * overflows. Note that we can't return an error specifically,
801 * but we can mark EOF and put trash in the return value,
802 * which will trigger a parse error.
804 cs->eof = 1;
805 return 0;
808 if (c == '\n')
809 cs->linenr++;
810 if (c == EOF) {
811 cs->eof = 1;
812 cs->linenr++;
813 c = '\n';
815 return c;
818 static char *parse_value(struct config_source *cs)
820 int quote = 0, comment = 0;
821 size_t trim_len = 0;
823 strbuf_reset(&cs->value);
824 for (;;) {
825 int c = get_next_char(cs);
826 if (c == '\n') {
827 if (quote) {
828 cs->linenr--;
829 return NULL;
831 if (trim_len)
832 strbuf_setlen(&cs->value, trim_len);
833 return cs->value.buf;
835 if (comment)
836 continue;
837 if (isspace(c) && !quote) {
838 if (!trim_len)
839 trim_len = cs->value.len;
840 if (cs->value.len)
841 strbuf_addch(&cs->value, c);
842 continue;
844 if (!quote) {
845 if (c == ';' || c == '#') {
846 comment = 1;
847 continue;
850 if (trim_len)
851 trim_len = 0;
852 if (c == '\\') {
853 c = get_next_char(cs);
854 switch (c) {
855 case '\n':
856 continue;
857 case 't':
858 c = '\t';
859 break;
860 case 'b':
861 c = '\b';
862 break;
863 case 'n':
864 c = '\n';
865 break;
866 /* Some characters escape as themselves */
867 case '\\': case '"':
868 break;
869 /* Reject unknown escape sequences */
870 default:
871 return NULL;
873 strbuf_addch(&cs->value, c);
874 continue;
876 if (c == '"') {
877 quote = 1 - quote;
878 continue;
880 strbuf_addch(&cs->value, c);
884 static int get_value(struct config_source *cs, struct key_value_info *kvi,
885 config_fn_t fn, void *data, struct strbuf *name)
887 int c;
888 char *value;
889 int ret;
890 struct config_context ctx = {
891 .kvi = kvi,
894 /* Get the full name */
895 for (;;) {
896 c = get_next_char(cs);
897 if (cs->eof)
898 break;
899 if (!iskeychar(c))
900 break;
901 strbuf_addch(name, tolower(c));
904 while (c == ' ' || c == '\t')
905 c = get_next_char(cs);
907 value = NULL;
908 if (c != '\n') {
909 if (c != '=')
910 return -1;
911 value = parse_value(cs);
912 if (!value)
913 return -1;
916 * We already consumed the \n, but we need linenr to point to
917 * the line we just parsed during the call to fn to get
918 * accurate line number in error messages.
920 cs->linenr--;
921 kvi->linenr = cs->linenr;
922 ret = fn(name->buf, value, &ctx, data);
923 if (ret >= 0)
924 cs->linenr++;
925 return ret;
928 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
929 int c)
931 cs->subsection_case_sensitive = 0;
932 do {
933 if (c == '\n')
934 goto error_incomplete_line;
935 c = get_next_char(cs);
936 } while (isspace(c));
938 /* We require the format to be '[base "extension"]' */
939 if (c != '"')
940 return -1;
941 strbuf_addch(name, '.');
943 for (;;) {
944 int c = get_next_char(cs);
945 if (c == '\n')
946 goto error_incomplete_line;
947 if (c == '"')
948 break;
949 if (c == '\\') {
950 c = get_next_char(cs);
951 if (c == '\n')
952 goto error_incomplete_line;
954 strbuf_addch(name, c);
957 /* Final ']' */
958 if (get_next_char(cs) != ']')
959 return -1;
960 return 0;
961 error_incomplete_line:
962 cs->linenr--;
963 return -1;
966 static int get_base_var(struct config_source *cs, struct strbuf *name)
968 cs->subsection_case_sensitive = 1;
969 for (;;) {
970 int c = get_next_char(cs);
971 if (cs->eof)
972 return -1;
973 if (c == ']')
974 return 0;
975 if (isspace(c))
976 return get_extended_base_var(cs, name, c);
977 if (!iskeychar(c) && c != '.')
978 return -1;
979 strbuf_addch(name, tolower(c));
983 struct parse_event_data {
984 enum config_event_t previous_type;
985 size_t previous_offset;
986 const struct config_options *opts;
989 static int do_event(struct config_source *cs, enum config_event_t type,
990 struct parse_event_data *data)
992 size_t offset;
994 if (!data->opts || !data->opts->event_fn)
995 return 0;
997 if (type == CONFIG_EVENT_WHITESPACE &&
998 data->previous_type == type)
999 return 0;
1001 offset = cs->do_ftell(cs);
1003 * At EOF, the parser always "inserts" an extra '\n', therefore
1004 * the end offset of the event is the current file position, otherwise
1005 * we will already have advanced to the next event.
1007 if (type != CONFIG_EVENT_EOF)
1008 offset--;
1010 if (data->previous_type != CONFIG_EVENT_EOF &&
1011 data->opts->event_fn(data->previous_type, data->previous_offset,
1012 offset, cs, data->opts->event_fn_data) < 0)
1013 return -1;
1015 data->previous_type = type;
1016 data->previous_offset = offset;
1018 return 0;
1021 static void kvi_from_source(struct config_source *cs,
1022 enum config_scope scope,
1023 struct key_value_info *out)
1025 out->filename = strintern(cs->name);
1026 out->origin_type = cs->origin_type;
1027 out->linenr = cs->linenr;
1028 out->scope = scope;
1029 out->path = cs->path;
1032 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1033 struct key_value_info *kvi, void *data,
1034 const struct config_options *opts)
1036 int comment = 0;
1037 size_t baselen = 0;
1038 struct strbuf *var = &cs->var;
1039 int error_return = 0;
1040 char *error_msg = NULL;
1042 /* U+FEFF Byte Order Mark in UTF8 */
1043 const char *bomptr = utf8_bom;
1045 /* For the parser event callback */
1046 struct parse_event_data event_data = {
1047 CONFIG_EVENT_EOF, 0, opts
1050 for (;;) {
1051 int c;
1053 c = get_next_char(cs);
1054 if (bomptr && *bomptr) {
1055 /* We are at the file beginning; skip UTF8-encoded BOM
1056 * if present. Sane editors won't put this in on their
1057 * own, but e.g. Windows Notepad will do it happily. */
1058 if (c == (*bomptr & 0377)) {
1059 bomptr++;
1060 continue;
1061 } else {
1062 /* Do not tolerate partial BOM. */
1063 if (bomptr != utf8_bom)
1064 break;
1065 /* No BOM at file beginning. Cool. */
1066 bomptr = NULL;
1069 if (c == '\n') {
1070 if (cs->eof) {
1071 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1072 return -1;
1073 return 0;
1075 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1076 return -1;
1077 comment = 0;
1078 continue;
1080 if (comment)
1081 continue;
1082 if (isspace(c)) {
1083 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1084 return -1;
1085 continue;
1087 if (c == '#' || c == ';') {
1088 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1089 return -1;
1090 comment = 1;
1091 continue;
1093 if (c == '[') {
1094 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1095 return -1;
1097 /* Reset prior to determining a new stem */
1098 strbuf_reset(var);
1099 if (get_base_var(cs, var) < 0 || var->len < 1)
1100 break;
1101 strbuf_addch(var, '.');
1102 baselen = var->len;
1103 continue;
1105 if (!isalpha(c))
1106 break;
1108 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1109 return -1;
1112 * Truncate the var name back to the section header
1113 * stem prior to grabbing the suffix part of the name
1114 * and the value.
1116 strbuf_setlen(var, baselen);
1117 strbuf_addch(var, tolower(c));
1118 if (get_value(cs, kvi, fn, data, var) < 0)
1119 break;
1122 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1123 return -1;
1125 switch (cs->origin_type) {
1126 case CONFIG_ORIGIN_BLOB:
1127 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1128 cs->linenr, cs->name);
1129 break;
1130 case CONFIG_ORIGIN_FILE:
1131 error_msg = xstrfmt(_("bad config line %d in file %s"),
1132 cs->linenr, cs->name);
1133 break;
1134 case CONFIG_ORIGIN_STDIN:
1135 error_msg = xstrfmt(_("bad config line %d in standard input"),
1136 cs->linenr);
1137 break;
1138 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1139 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1140 cs->linenr, cs->name);
1141 break;
1142 case CONFIG_ORIGIN_CMDLINE:
1143 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1144 cs->linenr, cs->name);
1145 break;
1146 default:
1147 error_msg = xstrfmt(_("bad config line %d in %s"),
1148 cs->linenr, cs->name);
1151 switch (opts && opts->error_action ?
1152 opts->error_action :
1153 cs->default_error_action) {
1154 case CONFIG_ERROR_DIE:
1155 die("%s", error_msg);
1156 break;
1157 case CONFIG_ERROR_ERROR:
1158 error_return = error("%s", error_msg);
1159 break;
1160 case CONFIG_ERROR_SILENT:
1161 error_return = -1;
1162 break;
1163 case CONFIG_ERROR_UNSET:
1164 BUG("config error action unset");
1167 free(error_msg);
1168 return error_return;
1171 NORETURN
1172 static void die_bad_number(const char *name, const char *value,
1173 const struct key_value_info *kvi)
1175 const char *error_type = (errno == ERANGE) ?
1176 N_("out of range") : N_("invalid unit");
1177 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1179 if (!kvi)
1180 BUG("kvi should not be NULL");
1182 if (!value)
1183 value = "";
1185 if (!kvi->filename)
1186 die(_(bad_numeric), value, name, _(error_type));
1188 switch (kvi->origin_type) {
1189 case CONFIG_ORIGIN_BLOB:
1190 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1191 value, name, kvi->filename, _(error_type));
1192 case CONFIG_ORIGIN_FILE:
1193 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1194 value, name, kvi->filename, _(error_type));
1195 case CONFIG_ORIGIN_STDIN:
1196 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1197 value, name, _(error_type));
1198 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1199 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1200 value, name, kvi->filename, _(error_type));
1201 case CONFIG_ORIGIN_CMDLINE:
1202 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1203 value, name, kvi->filename, _(error_type));
1204 default:
1205 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1206 value, name, kvi->filename, _(error_type));
1210 int git_config_int(const char *name, const char *value,
1211 const struct key_value_info *kvi)
1213 int ret;
1214 if (!git_parse_int(value, &ret))
1215 die_bad_number(name, value, kvi);
1216 return ret;
1219 int64_t git_config_int64(const char *name, const char *value,
1220 const struct key_value_info *kvi)
1222 int64_t ret;
1223 if (!git_parse_int64(value, &ret))
1224 die_bad_number(name, value, kvi);
1225 return ret;
1228 unsigned long git_config_ulong(const char *name, const char *value,
1229 const struct key_value_info *kvi)
1231 unsigned long ret;
1232 if (!git_parse_ulong(value, &ret))
1233 die_bad_number(name, value, kvi);
1234 return ret;
1237 ssize_t git_config_ssize_t(const char *name, const char *value,
1238 const struct key_value_info *kvi)
1240 ssize_t ret;
1241 if (!git_parse_ssize_t(value, &ret))
1242 die_bad_number(name, value, kvi);
1243 return ret;
1246 static const struct fsync_component_name {
1247 const char *name;
1248 enum fsync_component component_bits;
1249 } fsync_component_names[] = {
1250 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1251 { "pack", FSYNC_COMPONENT_PACK },
1252 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1253 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1254 { "index", FSYNC_COMPONENT_INDEX },
1255 { "objects", FSYNC_COMPONENTS_OBJECTS },
1256 { "reference", FSYNC_COMPONENT_REFERENCE },
1257 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1258 { "committed", FSYNC_COMPONENTS_COMMITTED },
1259 { "added", FSYNC_COMPONENTS_ADDED },
1260 { "all", FSYNC_COMPONENTS_ALL },
1263 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1265 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1266 enum fsync_component positive = 0, negative = 0;
1268 while (string) {
1269 int i;
1270 size_t len;
1271 const char *ep;
1272 int negated = 0;
1273 int found = 0;
1275 string = string + strspn(string, ", \t\n\r");
1276 ep = strchrnul(string, ',');
1277 len = ep - string;
1278 if (!strcmp(string, "none")) {
1279 current = FSYNC_COMPONENT_NONE;
1280 goto next_name;
1283 if (*string == '-') {
1284 negated = 1;
1285 string++;
1286 len--;
1287 if (!len)
1288 warning(_("invalid value for variable %s"), var);
1291 if (!len)
1292 break;
1294 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1295 const struct fsync_component_name *n = &fsync_component_names[i];
1297 if (strncmp(n->name, string, len))
1298 continue;
1300 found = 1;
1301 if (negated)
1302 negative |= n->component_bits;
1303 else
1304 positive |= n->component_bits;
1307 if (!found) {
1308 char *component = xstrndup(string, len);
1309 warning(_("ignoring unknown core.fsync component '%s'"), component);
1310 free(component);
1313 next_name:
1314 string = ep;
1317 return (current & ~negative) | positive;
1320 int git_config_bool_or_int(const char *name, const char *value,
1321 const struct key_value_info *kvi, int *is_bool)
1323 int v = git_parse_maybe_bool_text(value);
1324 if (0 <= v) {
1325 *is_bool = 1;
1326 return v;
1328 *is_bool = 0;
1329 return git_config_int(name, value, kvi);
1332 int git_config_bool(const char *name, const char *value)
1334 int v = git_parse_maybe_bool(value);
1335 if (v < 0)
1336 die(_("bad boolean config value '%s' for '%s'"), value, name);
1337 return v;
1340 int git_config_string(const char **dest, const char *var, const char *value)
1342 if (!value)
1343 return config_error_nonbool(var);
1344 *dest = xstrdup(value);
1345 return 0;
1348 int git_config_pathname(const char **dest, const char *var, const char *value)
1350 if (!value)
1351 return config_error_nonbool(var);
1352 *dest = interpolate_path(value, 0);
1353 if (!*dest)
1354 die(_("failed to expand user dir in: '%s'"), value);
1355 return 0;
1358 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1360 if (!value)
1361 return config_error_nonbool(var);
1362 if (parse_expiry_date(value, timestamp))
1363 return error(_("'%s' for '%s' is not a valid timestamp"),
1364 value, var);
1365 return 0;
1368 int git_config_color(char *dest, const char *var, const char *value)
1370 if (!value)
1371 return config_error_nonbool(var);
1372 if (color_parse(value, dest) < 0)
1373 return -1;
1374 return 0;
1377 static int git_default_core_config(const char *var, const char *value,
1378 const struct config_context *ctx, void *cb)
1380 /* This needs a better name */
1381 if (!strcmp(var, "core.filemode")) {
1382 trust_executable_bit = git_config_bool(var, value);
1383 return 0;
1385 if (!strcmp(var, "core.trustctime")) {
1386 trust_ctime = git_config_bool(var, value);
1387 return 0;
1389 if (!strcmp(var, "core.checkstat")) {
1390 if (!value)
1391 return config_error_nonbool(var);
1392 if (!strcasecmp(value, "default"))
1393 check_stat = 1;
1394 else if (!strcasecmp(value, "minimal"))
1395 check_stat = 0;
1396 else
1397 return error(_("invalid value for '%s': '%s'"),
1398 var, value);
1401 if (!strcmp(var, "core.quotepath")) {
1402 quote_path_fully = git_config_bool(var, value);
1403 return 0;
1406 if (!strcmp(var, "core.symlinks")) {
1407 has_symlinks = git_config_bool(var, value);
1408 return 0;
1411 if (!strcmp(var, "core.ignorecase")) {
1412 ignore_case = git_config_bool(var, value);
1413 return 0;
1416 if (!strcmp(var, "core.attributesfile"))
1417 return git_config_pathname(&git_attributes_file, var, value);
1419 if (!strcmp(var, "core.hookspath"))
1420 return git_config_pathname(&git_hooks_path, var, value);
1422 if (!strcmp(var, "core.bare")) {
1423 is_bare_repository_cfg = git_config_bool(var, value);
1424 return 0;
1427 if (!strcmp(var, "core.ignorestat")) {
1428 assume_unchanged = git_config_bool(var, value);
1429 return 0;
1432 if (!strcmp(var, "core.prefersymlinkrefs")) {
1433 prefer_symlink_refs = git_config_bool(var, value);
1434 return 0;
1437 if (!strcmp(var, "core.logallrefupdates")) {
1438 if (value && !strcasecmp(value, "always"))
1439 log_all_ref_updates = LOG_REFS_ALWAYS;
1440 else if (git_config_bool(var, value))
1441 log_all_ref_updates = LOG_REFS_NORMAL;
1442 else
1443 log_all_ref_updates = LOG_REFS_NONE;
1444 return 0;
1447 if (!strcmp(var, "core.warnambiguousrefs")) {
1448 warn_ambiguous_refs = git_config_bool(var, value);
1449 return 0;
1452 if (!strcmp(var, "core.abbrev")) {
1453 if (!value)
1454 return config_error_nonbool(var);
1455 if (!strcasecmp(value, "auto"))
1456 default_abbrev = -1;
1457 else if (!git_parse_maybe_bool_text(value))
1458 default_abbrev = the_hash_algo->hexsz;
1459 else {
1460 int abbrev = git_config_int(var, value, ctx->kvi);
1461 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1462 return error(_("abbrev length out of range: %d"), abbrev);
1463 default_abbrev = abbrev;
1465 return 0;
1468 if (!strcmp(var, "core.disambiguate"))
1469 return set_disambiguate_hint_config(var, value);
1471 if (!strcmp(var, "core.loosecompression")) {
1472 int level = git_config_int(var, value, ctx->kvi);
1473 if (level == -1)
1474 level = Z_DEFAULT_COMPRESSION;
1475 else if (level < 0 || level > Z_BEST_COMPRESSION)
1476 die(_("bad zlib compression level %d"), level);
1477 zlib_compression_level = level;
1478 zlib_compression_seen = 1;
1479 return 0;
1482 if (!strcmp(var, "core.compression")) {
1483 int level = git_config_int(var, value, ctx->kvi);
1484 if (level == -1)
1485 level = Z_DEFAULT_COMPRESSION;
1486 else if (level < 0 || level > Z_BEST_COMPRESSION)
1487 die(_("bad zlib compression level %d"), level);
1488 if (!zlib_compression_seen)
1489 zlib_compression_level = level;
1490 if (!pack_compression_seen)
1491 pack_compression_level = level;
1492 return 0;
1495 if (!strcmp(var, "core.packedgitwindowsize")) {
1496 int pgsz_x2 = getpagesize() * 2;
1497 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1499 /* This value must be multiple of (pagesize * 2) */
1500 packed_git_window_size /= pgsz_x2;
1501 if (packed_git_window_size < 1)
1502 packed_git_window_size = 1;
1503 packed_git_window_size *= pgsz_x2;
1504 return 0;
1507 if (!strcmp(var, "core.bigfilethreshold")) {
1508 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1509 return 0;
1512 if (!strcmp(var, "core.packedgitlimit")) {
1513 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1514 return 0;
1517 if (!strcmp(var, "core.deltabasecachelimit")) {
1518 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1519 return 0;
1522 if (!strcmp(var, "core.autocrlf")) {
1523 if (value && !strcasecmp(value, "input")) {
1524 auto_crlf = AUTO_CRLF_INPUT;
1525 return 0;
1527 auto_crlf = git_config_bool(var, value);
1528 return 0;
1531 if (!strcmp(var, "core.safecrlf")) {
1532 int eol_rndtrp_die;
1533 if (value && !strcasecmp(value, "warn")) {
1534 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1535 return 0;
1537 eol_rndtrp_die = git_config_bool(var, value);
1538 global_conv_flags_eol = eol_rndtrp_die ?
1539 CONV_EOL_RNDTRP_DIE : 0;
1540 return 0;
1543 if (!strcmp(var, "core.eol")) {
1544 if (value && !strcasecmp(value, "lf"))
1545 core_eol = EOL_LF;
1546 else if (value && !strcasecmp(value, "crlf"))
1547 core_eol = EOL_CRLF;
1548 else if (value && !strcasecmp(value, "native"))
1549 core_eol = EOL_NATIVE;
1550 else
1551 core_eol = EOL_UNSET;
1552 return 0;
1555 if (!strcmp(var, "core.checkroundtripencoding"))
1556 return git_config_string(&check_roundtrip_encoding, var, value);
1558 if (!strcmp(var, "core.notesref")) {
1559 if (!value)
1560 return config_error_nonbool(var);
1561 notes_ref_name = xstrdup(value);
1562 return 0;
1565 if (!strcmp(var, "core.editor"))
1566 return git_config_string(&editor_program, var, value);
1568 if (!strcmp(var, "core.commentchar") ||
1569 !strcmp(var, "core.commentstring")) {
1570 if (!value)
1571 return config_error_nonbool(var);
1572 else if (!strcasecmp(value, "auto"))
1573 auto_comment_line_char = 1;
1574 else if (value[0]) {
1575 if (strchr(value, '\n'))
1576 return error(_("%s cannot contain newline"), var);
1577 comment_line_str = xstrdup(value);
1578 auto_comment_line_char = 0;
1579 } else
1580 return error(_("%s must have at least one character"), var);
1581 return 0;
1584 if (!strcmp(var, "core.askpass"))
1585 return git_config_string(&askpass_program, var, value);
1587 if (!strcmp(var, "core.excludesfile"))
1588 return git_config_pathname(&excludes_file, var, value);
1590 if (!strcmp(var, "core.whitespace")) {
1591 if (!value)
1592 return config_error_nonbool(var);
1593 whitespace_rule_cfg = parse_whitespace_rule(value);
1594 return 0;
1597 if (!strcmp(var, "core.fsync")) {
1598 if (!value)
1599 return config_error_nonbool(var);
1600 fsync_components = parse_fsync_components(var, value);
1601 return 0;
1604 if (!strcmp(var, "core.fsyncmethod")) {
1605 if (!value)
1606 return config_error_nonbool(var);
1607 if (!strcmp(value, "fsync"))
1608 fsync_method = FSYNC_METHOD_FSYNC;
1609 else if (!strcmp(value, "writeout-only"))
1610 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1611 else if (!strcmp(value, "batch"))
1612 fsync_method = FSYNC_METHOD_BATCH;
1613 else
1614 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1618 if (!strcmp(var, "core.fsyncobjectfiles")) {
1619 if (fsync_object_files < 0)
1620 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1621 fsync_object_files = git_config_bool(var, value);
1622 return 0;
1625 if (!strcmp(var, "core.preloadindex")) {
1626 core_preload_index = git_config_bool(var, value);
1627 return 0;
1630 if (!strcmp(var, "core.createobject")) {
1631 if (!value)
1632 return config_error_nonbool(var);
1633 if (!strcmp(value, "rename"))
1634 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1635 else if (!strcmp(value, "link"))
1636 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1637 else
1638 die(_("invalid mode for object creation: %s"), value);
1639 return 0;
1642 if (!strcmp(var, "core.sparsecheckout")) {
1643 core_apply_sparse_checkout = git_config_bool(var, value);
1644 return 0;
1647 if (!strcmp(var, "core.sparsecheckoutcone")) {
1648 core_sparse_checkout_cone = git_config_bool(var, value);
1649 return 0;
1652 if (!strcmp(var, "core.precomposeunicode")) {
1653 precomposed_unicode = git_config_bool(var, value);
1654 return 0;
1657 if (!strcmp(var, "core.protecthfs")) {
1658 protect_hfs = git_config_bool(var, value);
1659 return 0;
1662 if (!strcmp(var, "core.protectntfs")) {
1663 protect_ntfs = git_config_bool(var, value);
1664 return 0;
1667 if (!strcmp(var, "core.maxtreedepth")) {
1668 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1669 return 0;
1672 /* Add other config variables here and to Documentation/config.txt. */
1673 return platform_core_config(var, value, ctx, cb);
1676 static int git_default_sparse_config(const char *var, const char *value)
1678 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1679 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1680 return 0;
1683 /* Add other config variables here and to Documentation/config/sparse.txt. */
1684 return 0;
1687 static int git_default_i18n_config(const char *var, const char *value)
1689 if (!strcmp(var, "i18n.commitencoding"))
1690 return git_config_string(&git_commit_encoding, var, value);
1692 if (!strcmp(var, "i18n.logoutputencoding"))
1693 return git_config_string(&git_log_output_encoding, var, value);
1695 /* Add other config variables here and to Documentation/config.txt. */
1696 return 0;
1699 static int git_default_branch_config(const char *var, const char *value)
1701 if (!strcmp(var, "branch.autosetupmerge")) {
1702 if (value && !strcmp(value, "always")) {
1703 git_branch_track = BRANCH_TRACK_ALWAYS;
1704 return 0;
1705 } else if (value && !strcmp(value, "inherit")) {
1706 git_branch_track = BRANCH_TRACK_INHERIT;
1707 return 0;
1708 } else if (value && !strcmp(value, "simple")) {
1709 git_branch_track = BRANCH_TRACK_SIMPLE;
1710 return 0;
1712 git_branch_track = git_config_bool(var, value);
1713 return 0;
1715 if (!strcmp(var, "branch.autosetuprebase")) {
1716 if (!value)
1717 return config_error_nonbool(var);
1718 else if (!strcmp(value, "never"))
1719 autorebase = AUTOREBASE_NEVER;
1720 else if (!strcmp(value, "local"))
1721 autorebase = AUTOREBASE_LOCAL;
1722 else if (!strcmp(value, "remote"))
1723 autorebase = AUTOREBASE_REMOTE;
1724 else if (!strcmp(value, "always"))
1725 autorebase = AUTOREBASE_ALWAYS;
1726 else
1727 return error(_("malformed value for %s"), var);
1728 return 0;
1731 /* Add other config variables here and to Documentation/config.txt. */
1732 return 0;
1735 static int git_default_push_config(const char *var, const char *value)
1737 if (!strcmp(var, "push.default")) {
1738 if (!value)
1739 return config_error_nonbool(var);
1740 else if (!strcmp(value, "nothing"))
1741 push_default = PUSH_DEFAULT_NOTHING;
1742 else if (!strcmp(value, "matching"))
1743 push_default = PUSH_DEFAULT_MATCHING;
1744 else if (!strcmp(value, "simple"))
1745 push_default = PUSH_DEFAULT_SIMPLE;
1746 else if (!strcmp(value, "upstream"))
1747 push_default = PUSH_DEFAULT_UPSTREAM;
1748 else if (!strcmp(value, "tracking")) /* deprecated */
1749 push_default = PUSH_DEFAULT_UPSTREAM;
1750 else if (!strcmp(value, "current"))
1751 push_default = PUSH_DEFAULT_CURRENT;
1752 else {
1753 error(_("malformed value for %s: %s"), var, value);
1754 return error(_("must be one of nothing, matching, simple, "
1755 "upstream or current"));
1757 return 0;
1760 /* Add other config variables here and to Documentation/config.txt. */
1761 return 0;
1764 static int git_default_mailmap_config(const char *var, const char *value)
1766 if (!strcmp(var, "mailmap.file"))
1767 return git_config_pathname(&git_mailmap_file, var, value);
1768 if (!strcmp(var, "mailmap.blob"))
1769 return git_config_string(&git_mailmap_blob, var, value);
1771 /* Add other config variables here and to Documentation/config.txt. */
1772 return 0;
1775 static int git_default_attr_config(const char *var, const char *value)
1777 if (!strcmp(var, "attr.tree"))
1778 return git_config_string(&git_attr_tree, var, value);
1781 * Add other attribute related config variables here and to
1782 * Documentation/config/attr.txt.
1784 return 0;
1787 int git_default_config(const char *var, const char *value,
1788 const struct config_context *ctx, void *cb)
1790 if (starts_with(var, "core."))
1791 return git_default_core_config(var, value, ctx, cb);
1793 if (starts_with(var, "user.") ||
1794 starts_with(var, "author.") ||
1795 starts_with(var, "committer."))
1796 return git_ident_config(var, value, ctx, cb);
1798 if (starts_with(var, "i18n."))
1799 return git_default_i18n_config(var, value);
1801 if (starts_with(var, "branch."))
1802 return git_default_branch_config(var, value);
1804 if (starts_with(var, "push."))
1805 return git_default_push_config(var, value);
1807 if (starts_with(var, "mailmap."))
1808 return git_default_mailmap_config(var, value);
1810 if (starts_with(var, "attr."))
1811 return git_default_attr_config(var, value);
1813 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1814 return git_default_advice_config(var, value);
1816 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1817 pager_use_color = git_config_bool(var,value);
1818 return 0;
1821 if (!strcmp(var, "pack.packsizelimit")) {
1822 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1823 return 0;
1826 if (!strcmp(var, "pack.compression")) {
1827 int level = git_config_int(var, value, ctx->kvi);
1828 if (level == -1)
1829 level = Z_DEFAULT_COMPRESSION;
1830 else if (level < 0 || level > Z_BEST_COMPRESSION)
1831 die(_("bad pack compression level %d"), level);
1832 pack_compression_level = level;
1833 pack_compression_seen = 1;
1834 return 0;
1837 if (starts_with(var, "sparse."))
1838 return git_default_sparse_config(var, value);
1840 /* Add other config variables here and to Documentation/config.txt. */
1841 return 0;
1845 * All source specific fields in the union, die_on_error, name and the callbacks
1846 * fgetc, ungetc, ftell of top need to be initialized before calling
1847 * this function.
1849 static int do_config_from(struct config_source *top, config_fn_t fn,
1850 void *data, enum config_scope scope,
1851 const struct config_options *opts)
1853 struct key_value_info kvi = KVI_INIT;
1854 int ret;
1856 /* push config-file parsing state stack */
1857 top->linenr = 1;
1858 top->eof = 0;
1859 top->total_len = 0;
1860 strbuf_init(&top->value, 1024);
1861 strbuf_init(&top->var, 1024);
1862 kvi_from_source(top, scope, &kvi);
1864 ret = git_parse_source(top, fn, &kvi, data, opts);
1866 strbuf_release(&top->value);
1867 strbuf_release(&top->var);
1869 return ret;
1872 static int do_config_from_file(config_fn_t fn,
1873 const enum config_origin_type origin_type,
1874 const char *name, const char *path, FILE *f,
1875 void *data, enum config_scope scope,
1876 const struct config_options *opts)
1878 struct config_source top = CONFIG_SOURCE_INIT;
1879 int ret;
1881 top.u.file = f;
1882 top.origin_type = origin_type;
1883 top.name = name;
1884 top.path = path;
1885 top.default_error_action = CONFIG_ERROR_DIE;
1886 top.do_fgetc = config_file_fgetc;
1887 top.do_ungetc = config_file_ungetc;
1888 top.do_ftell = config_file_ftell;
1890 flockfile(f);
1891 ret = do_config_from(&top, fn, data, scope, opts);
1892 funlockfile(f);
1893 return ret;
1896 static int git_config_from_stdin(config_fn_t fn, void *data,
1897 enum config_scope scope)
1899 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1900 data, scope, NULL);
1903 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1904 void *data, enum config_scope scope,
1905 const struct config_options *opts)
1907 int ret = -1;
1908 FILE *f;
1910 if (!filename)
1911 BUG("filename cannot be NULL");
1912 f = fopen_or_warn(filename, "r");
1913 if (f) {
1914 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1915 filename, f, data, scope, opts);
1916 fclose(f);
1918 return ret;
1921 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1923 return git_config_from_file_with_options(fn, filename, data,
1924 CONFIG_SCOPE_UNKNOWN, NULL);
1927 int git_config_from_mem(config_fn_t fn,
1928 const enum config_origin_type origin_type,
1929 const char *name, const char *buf, size_t len,
1930 void *data, enum config_scope scope,
1931 const struct config_options *opts)
1933 struct config_source top = CONFIG_SOURCE_INIT;
1935 top.u.buf.buf = buf;
1936 top.u.buf.len = len;
1937 top.u.buf.pos = 0;
1938 top.origin_type = origin_type;
1939 top.name = name;
1940 top.path = NULL;
1941 top.default_error_action = CONFIG_ERROR_ERROR;
1942 top.do_fgetc = config_buf_fgetc;
1943 top.do_ungetc = config_buf_ungetc;
1944 top.do_ftell = config_buf_ftell;
1946 return do_config_from(&top, fn, data, scope, opts);
1949 int git_config_from_blob_oid(config_fn_t fn,
1950 const char *name,
1951 struct repository *repo,
1952 const struct object_id *oid,
1953 void *data,
1954 enum config_scope scope)
1956 enum object_type type;
1957 char *buf;
1958 unsigned long size;
1959 int ret;
1961 buf = repo_read_object_file(repo, oid, &type, &size);
1962 if (!buf)
1963 return error(_("unable to load config blob object '%s'"), name);
1964 if (type != OBJ_BLOB) {
1965 free(buf);
1966 return error(_("reference '%s' does not point to a blob"), name);
1969 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1970 data, scope, NULL);
1971 free(buf);
1973 return ret;
1976 static int git_config_from_blob_ref(config_fn_t fn,
1977 struct repository *repo,
1978 const char *name,
1979 void *data,
1980 enum config_scope scope)
1982 struct object_id oid;
1984 if (repo_get_oid(repo, name, &oid) < 0)
1985 return error(_("unable to resolve config blob '%s'"), name);
1986 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
1989 char *git_system_config(void)
1991 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1992 if (!system_config)
1993 system_config = system_path(ETC_GITCONFIG);
1994 normalize_path_copy(system_config, system_config);
1995 return system_config;
1998 char *git_global_config(void)
2000 char *user_config, *xdg_config;
2002 git_global_config_paths(&user_config, &xdg_config);
2003 if (!user_config) {
2004 free(xdg_config);
2005 return NULL;
2008 if (access_or_warn(user_config, R_OK, 0) && xdg_config &&
2009 !access_or_warn(xdg_config, R_OK, 0)) {
2010 free(user_config);
2011 return xdg_config;
2012 } else {
2013 free(xdg_config);
2014 return user_config;
2018 void git_global_config_paths(char **user_out, char **xdg_out)
2020 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2021 char *xdg_config = NULL;
2023 if (!user_config) {
2024 user_config = interpolate_path("~/.gitconfig", 0);
2025 xdg_config = xdg_config_home("config");
2028 *user_out = user_config;
2029 *xdg_out = xdg_config;
2032 int git_config_system(void)
2034 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2037 static int do_git_config_sequence(const struct config_options *opts,
2038 const struct repository *repo,
2039 config_fn_t fn, void *data)
2041 int ret = 0;
2042 char *system_config = git_system_config();
2043 char *xdg_config = NULL;
2044 char *user_config = NULL;
2045 char *repo_config;
2046 char *worktree_config;
2049 * Ensure that either:
2050 * - the git_dir and commondir are both set, or
2051 * - the git_dir and commondir are both NULL
2053 if (!opts->git_dir != !opts->commondir)
2054 BUG("only one of commondir and git_dir is non-NULL");
2056 if (opts->commondir) {
2057 repo_config = mkpathdup("%s/config", opts->commondir);
2058 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2059 } else {
2060 repo_config = NULL;
2061 worktree_config = NULL;
2064 if (git_config_system() && system_config &&
2065 !access_or_die(system_config, R_OK,
2066 opts->system_gently ? ACCESS_EACCES_OK : 0))
2067 ret += git_config_from_file_with_options(fn, system_config,
2068 data, CONFIG_SCOPE_SYSTEM,
2069 NULL);
2071 git_global_config_paths(&user_config, &xdg_config);
2073 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2074 ret += git_config_from_file_with_options(fn, xdg_config, data,
2075 CONFIG_SCOPE_GLOBAL, NULL);
2077 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2078 ret += git_config_from_file_with_options(fn, user_config, data,
2079 CONFIG_SCOPE_GLOBAL, NULL);
2081 if (!opts->ignore_repo && repo_config &&
2082 !access_or_die(repo_config, R_OK, 0))
2083 ret += git_config_from_file_with_options(fn, repo_config, data,
2084 CONFIG_SCOPE_LOCAL, NULL);
2086 if (!opts->ignore_worktree && worktree_config &&
2087 repo && repo->repository_format_worktree_config &&
2088 !access_or_die(worktree_config, R_OK, 0)) {
2089 ret += git_config_from_file_with_options(fn, worktree_config, data,
2090 CONFIG_SCOPE_WORKTREE,
2091 NULL);
2094 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2095 die(_("unable to parse command-line config"));
2097 free(system_config);
2098 free(xdg_config);
2099 free(user_config);
2100 free(repo_config);
2101 free(worktree_config);
2102 return ret;
2105 int config_with_options(config_fn_t fn, void *data,
2106 struct git_config_source *config_source,
2107 struct repository *repo,
2108 const struct config_options *opts)
2110 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2111 int ret;
2113 if (opts->respect_includes) {
2114 inc.fn = fn;
2115 inc.data = data;
2116 inc.opts = opts;
2117 inc.repo = repo;
2118 inc.config_source = config_source;
2119 fn = git_config_include;
2120 data = &inc;
2124 * If we have a specific filename, use it. Otherwise, follow the
2125 * regular lookup sequence.
2127 if (config_source && config_source->use_stdin) {
2128 ret = git_config_from_stdin(fn, data, config_source->scope);
2129 } else if (config_source && config_source->file) {
2130 ret = git_config_from_file_with_options(fn, config_source->file,
2131 data, config_source->scope,
2132 NULL);
2133 } else if (config_source && config_source->blob) {
2134 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2135 data, config_source->scope);
2136 } else {
2137 ret = do_git_config_sequence(opts, repo, fn, data);
2140 if (inc.remote_urls) {
2141 string_list_clear(inc.remote_urls, 0);
2142 FREE_AND_NULL(inc.remote_urls);
2144 return ret;
2147 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2149 int i, value_index;
2150 struct string_list *values;
2151 struct config_set_element *entry;
2152 struct configset_list *list = &set->list;
2153 struct config_context ctx = CONFIG_CONTEXT_INIT;
2155 for (i = 0; i < list->nr; i++) {
2156 entry = list->items[i].e;
2157 value_index = list->items[i].value_index;
2158 values = &entry->value_list;
2160 ctx.kvi = values->items[value_index].util;
2161 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2162 git_die_config_linenr(entry->key,
2163 ctx.kvi->filename,
2164 ctx.kvi->linenr);
2168 void read_early_config(config_fn_t cb, void *data)
2170 struct config_options opts = {0};
2171 struct strbuf commondir = STRBUF_INIT;
2172 struct strbuf gitdir = STRBUF_INIT;
2174 opts.respect_includes = 1;
2176 if (have_git_dir()) {
2177 opts.commondir = get_git_common_dir();
2178 opts.git_dir = get_git_dir();
2180 * When setup_git_directory() was not yet asked to discover the
2181 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2182 * is any repository config we should use (but unlike
2183 * setup_git_directory_gently(), no global state is changed, most
2184 * notably, the current working directory is still the same after the
2185 * call).
2187 } else if (!discover_git_directory(&commondir, &gitdir)) {
2188 opts.commondir = commondir.buf;
2189 opts.git_dir = gitdir.buf;
2192 config_with_options(cb, data, NULL, NULL, &opts);
2194 strbuf_release(&commondir);
2195 strbuf_release(&gitdir);
2199 * Read config but only enumerate system and global settings.
2200 * Omit any repo-local, worktree-local, or command-line settings.
2202 void read_very_early_config(config_fn_t cb, void *data)
2204 struct config_options opts = { 0 };
2206 opts.respect_includes = 1;
2207 opts.ignore_repo = 1;
2208 opts.ignore_worktree = 1;
2209 opts.ignore_cmdline = 1;
2210 opts.system_gently = 1;
2212 config_with_options(cb, data, NULL, NULL, &opts);
2215 RESULT_MUST_BE_USED
2216 static int configset_find_element(struct config_set *set, const char *key,
2217 struct config_set_element **dest)
2219 struct config_set_element k;
2220 struct config_set_element *found_entry;
2221 char *normalized_key;
2222 int ret;
2225 * `key` may come from the user, so normalize it before using it
2226 * for querying entries from the hashmap.
2228 ret = git_config_parse_key(key, &normalized_key, NULL);
2229 if (ret)
2230 return ret;
2232 hashmap_entry_init(&k.ent, strhash(normalized_key));
2233 k.key = normalized_key;
2234 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2235 free(normalized_key);
2236 *dest = found_entry;
2237 return 0;
2240 static int configset_add_value(const struct key_value_info *kvi_p,
2241 struct config_set *set, const char *key,
2242 const char *value)
2244 struct config_set_element *e;
2245 struct string_list_item *si;
2246 struct configset_list_item *l_item;
2247 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2248 int ret;
2250 ret = configset_find_element(set, key, &e);
2251 if (ret)
2252 return ret;
2254 * Since the keys are being fed by git_config*() callback mechanism, they
2255 * are already normalized. So simply add them without any further munging.
2257 if (!e) {
2258 e = xmalloc(sizeof(*e));
2259 hashmap_entry_init(&e->ent, strhash(key));
2260 e->key = xstrdup(key);
2261 string_list_init_dup(&e->value_list);
2262 hashmap_add(&set->config_hash, &e->ent);
2264 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2266 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2267 l_item = &set->list.items[set->list.nr++];
2268 l_item->e = e;
2269 l_item->value_index = e->value_list.nr - 1;
2271 *kv_info = *kvi_p;
2272 si->util = kv_info;
2274 return 0;
2277 static int config_set_element_cmp(const void *cmp_data UNUSED,
2278 const struct hashmap_entry *eptr,
2279 const struct hashmap_entry *entry_or_key,
2280 const void *keydata UNUSED)
2282 const struct config_set_element *e1, *e2;
2284 e1 = container_of(eptr, const struct config_set_element, ent);
2285 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2287 return strcmp(e1->key, e2->key);
2290 void git_configset_init(struct config_set *set)
2292 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2293 set->hash_initialized = 1;
2294 set->list.nr = 0;
2295 set->list.alloc = 0;
2296 set->list.items = NULL;
2299 void git_configset_clear(struct config_set *set)
2301 struct config_set_element *entry;
2302 struct hashmap_iter iter;
2303 if (!set->hash_initialized)
2304 return;
2306 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2307 ent /* member name */) {
2308 free(entry->key);
2309 string_list_clear(&entry->value_list, 1);
2311 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2312 set->hash_initialized = 0;
2313 free(set->list.items);
2314 set->list.nr = 0;
2315 set->list.alloc = 0;
2316 set->list.items = NULL;
2319 static int config_set_callback(const char *key, const char *value,
2320 const struct config_context *ctx,
2321 void *cb)
2323 struct config_set *set = cb;
2324 configset_add_value(ctx->kvi, set, key, value);
2325 return 0;
2328 int git_configset_add_file(struct config_set *set, const char *filename)
2330 return git_config_from_file(config_set_callback, filename, set);
2333 int git_configset_get_value(struct config_set *set, const char *key,
2334 const char **value, struct key_value_info *kvi)
2336 const struct string_list *values = NULL;
2337 int ret;
2338 struct string_list_item item;
2340 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2341 * queried key in the files of the configset, the value returned will be the last
2342 * value in the value list for that key.
2344 if ((ret = git_configset_get_value_multi(set, key, &values)))
2345 return ret;
2347 assert(values->nr > 0);
2348 item = values->items[values->nr - 1];
2349 *value = item.string;
2350 if (kvi)
2351 *kvi = *((struct key_value_info *)item.util);
2352 return 0;
2355 int git_configset_get_value_multi(struct config_set *set, const char *key,
2356 const struct string_list **dest)
2358 struct config_set_element *e;
2359 int ret;
2361 if ((ret = configset_find_element(set, key, &e)))
2362 return ret;
2363 else if (!e)
2364 return 1;
2365 *dest = &e->value_list;
2367 return 0;
2370 static int check_multi_string(struct string_list_item *item, void *util)
2372 return item->string ? 0 : config_error_nonbool(util);
2375 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2376 const struct string_list **dest)
2378 int ret;
2380 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2381 return ret;
2382 if ((ret = for_each_string_list((struct string_list *)*dest,
2383 check_multi_string, (void *)key)))
2384 return ret;
2386 return 0;
2389 int git_configset_get(struct config_set *set, const char *key)
2391 struct config_set_element *e;
2392 int ret;
2394 if ((ret = configset_find_element(set, key, &e)))
2395 return ret;
2396 else if (!e)
2397 return 1;
2398 return 0;
2401 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2403 const char *value;
2404 if (!git_configset_get_value(set, key, &value, NULL))
2405 return git_config_string((const char **)dest, key, value);
2406 else
2407 return 1;
2410 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2411 const char **dest)
2413 const char *value;
2414 if (!git_configset_get_value(set, key, &value, NULL)) {
2415 if (!value)
2416 return config_error_nonbool(key);
2417 *dest = value;
2418 return 0;
2419 } else {
2420 return 1;
2424 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2426 const char *value;
2427 struct key_value_info kvi;
2429 if (!git_configset_get_value(set, key, &value, &kvi)) {
2430 *dest = git_config_int(key, value, &kvi);
2431 return 0;
2432 } else
2433 return 1;
2436 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2438 const char *value;
2439 struct key_value_info kvi;
2441 if (!git_configset_get_value(set, key, &value, &kvi)) {
2442 *dest = git_config_ulong(key, value, &kvi);
2443 return 0;
2444 } else
2445 return 1;
2448 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2450 const char *value;
2451 if (!git_configset_get_value(set, key, &value, NULL)) {
2452 *dest = git_config_bool(key, value);
2453 return 0;
2454 } else
2455 return 1;
2458 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2459 int *is_bool, int *dest)
2461 const char *value;
2462 struct key_value_info kvi;
2464 if (!git_configset_get_value(set, key, &value, &kvi)) {
2465 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2466 return 0;
2467 } else
2468 return 1;
2471 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2473 const char *value;
2474 if (!git_configset_get_value(set, key, &value, NULL)) {
2475 *dest = git_parse_maybe_bool(value);
2476 if (*dest == -1)
2477 return -1;
2478 return 0;
2479 } else
2480 return 1;
2483 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2485 const char *value;
2486 if (!git_configset_get_value(set, key, &value, NULL))
2487 return git_config_pathname(dest, key, value);
2488 else
2489 return 1;
2492 /* Functions use to read configuration from a repository */
2493 static void repo_read_config(struct repository *repo)
2495 struct config_options opts = { 0 };
2497 opts.respect_includes = 1;
2498 opts.commondir = repo->commondir;
2499 opts.git_dir = repo->gitdir;
2501 if (!repo->config)
2502 CALLOC_ARRAY(repo->config, 1);
2503 else
2504 git_configset_clear(repo->config);
2506 git_configset_init(repo->config);
2507 if (config_with_options(config_set_callback, repo->config, NULL,
2508 repo, &opts) < 0)
2510 * config_with_options() normally returns only
2511 * zero, as most errors are fatal, and
2512 * non-fatal potential errors are guarded by "if"
2513 * statements that are entered only when no error is
2514 * possible.
2516 * If we ever encounter a non-fatal error, it means
2517 * something went really wrong and we should stop
2518 * immediately.
2520 die(_("unknown error occurred while reading the configuration files"));
2523 static void git_config_check_init(struct repository *repo)
2525 if (repo->config && repo->config->hash_initialized)
2526 return;
2527 repo_read_config(repo);
2530 static void repo_config_clear(struct repository *repo)
2532 if (!repo->config || !repo->config->hash_initialized)
2533 return;
2534 git_configset_clear(repo->config);
2537 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2539 git_config_check_init(repo);
2540 configset_iter(repo->config, fn, data);
2543 int repo_config_get(struct repository *repo, const char *key)
2545 git_config_check_init(repo);
2546 return git_configset_get(repo->config, key);
2549 int repo_config_get_value(struct repository *repo,
2550 const char *key, const char **value)
2552 git_config_check_init(repo);
2553 return git_configset_get_value(repo->config, key, value, NULL);
2556 int repo_config_get_value_multi(struct repository *repo, const char *key,
2557 const struct string_list **dest)
2559 git_config_check_init(repo);
2560 return git_configset_get_value_multi(repo->config, key, dest);
2563 int repo_config_get_string_multi(struct repository *repo, const char *key,
2564 const struct string_list **dest)
2566 git_config_check_init(repo);
2567 return git_configset_get_string_multi(repo->config, key, dest);
2570 int repo_config_get_string(struct repository *repo,
2571 const char *key, char **dest)
2573 int ret;
2574 git_config_check_init(repo);
2575 ret = git_configset_get_string(repo->config, key, dest);
2576 if (ret < 0)
2577 git_die_config(key, NULL);
2578 return ret;
2581 int repo_config_get_string_tmp(struct repository *repo,
2582 const char *key, const char **dest)
2584 int ret;
2585 git_config_check_init(repo);
2586 ret = git_configset_get_string_tmp(repo->config, key, dest);
2587 if (ret < 0)
2588 git_die_config(key, NULL);
2589 return ret;
2592 int repo_config_get_int(struct repository *repo,
2593 const char *key, int *dest)
2595 git_config_check_init(repo);
2596 return git_configset_get_int(repo->config, key, dest);
2599 int repo_config_get_ulong(struct repository *repo,
2600 const char *key, unsigned long *dest)
2602 git_config_check_init(repo);
2603 return git_configset_get_ulong(repo->config, key, dest);
2606 int repo_config_get_bool(struct repository *repo,
2607 const char *key, int *dest)
2609 git_config_check_init(repo);
2610 return git_configset_get_bool(repo->config, key, dest);
2613 int repo_config_get_bool_or_int(struct repository *repo,
2614 const char *key, int *is_bool, int *dest)
2616 git_config_check_init(repo);
2617 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2620 int repo_config_get_maybe_bool(struct repository *repo,
2621 const char *key, int *dest)
2623 git_config_check_init(repo);
2624 return git_configset_get_maybe_bool(repo->config, key, dest);
2627 int repo_config_get_pathname(struct repository *repo,
2628 const char *key, const char **dest)
2630 int ret;
2631 git_config_check_init(repo);
2632 ret = git_configset_get_pathname(repo->config, key, dest);
2633 if (ret < 0)
2634 git_die_config(key, NULL);
2635 return ret;
2638 /* Read values into protected_config. */
2639 static void read_protected_config(void)
2641 struct config_options opts = {
2642 .respect_includes = 1,
2643 .ignore_repo = 1,
2644 .ignore_worktree = 1,
2645 .system_gently = 1,
2648 git_configset_init(&protected_config);
2649 config_with_options(config_set_callback, &protected_config, NULL,
2650 NULL, &opts);
2653 void git_protected_config(config_fn_t fn, void *data)
2655 if (!protected_config.hash_initialized)
2656 read_protected_config();
2657 configset_iter(&protected_config, fn, data);
2660 /* Functions used historically to read configuration from 'the_repository' */
2661 void git_config(config_fn_t fn, void *data)
2663 repo_config(the_repository, fn, data);
2666 void git_config_clear(void)
2668 repo_config_clear(the_repository);
2671 int git_config_get(const char *key)
2673 return repo_config_get(the_repository, key);
2676 int git_config_get_value(const char *key, const char **value)
2678 return repo_config_get_value(the_repository, key, value);
2681 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2683 return repo_config_get_value_multi(the_repository, key, dest);
2686 int git_config_get_string_multi(const char *key,
2687 const struct string_list **dest)
2689 return repo_config_get_string_multi(the_repository, key, dest);
2692 int git_config_get_string(const char *key, char **dest)
2694 return repo_config_get_string(the_repository, key, dest);
2697 int git_config_get_string_tmp(const char *key, const char **dest)
2699 return repo_config_get_string_tmp(the_repository, key, dest);
2702 int git_config_get_int(const char *key, int *dest)
2704 return repo_config_get_int(the_repository, key, dest);
2707 int git_config_get_ulong(const char *key, unsigned long *dest)
2709 return repo_config_get_ulong(the_repository, key, dest);
2712 int git_config_get_bool(const char *key, int *dest)
2714 return repo_config_get_bool(the_repository, key, dest);
2717 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2719 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2722 int git_config_get_maybe_bool(const char *key, int *dest)
2724 return repo_config_get_maybe_bool(the_repository, key, dest);
2727 int git_config_get_pathname(const char *key, const char **dest)
2729 return repo_config_get_pathname(the_repository, key, dest);
2732 int git_config_get_expiry(const char *key, const char **output)
2734 int ret = git_config_get_string(key, (char **)output);
2735 if (ret)
2736 return ret;
2737 if (strcmp(*output, "now")) {
2738 timestamp_t now = approxidate("now");
2739 if (approxidate(*output) >= now)
2740 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2742 return ret;
2745 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2747 const char *expiry_string;
2748 intmax_t days;
2749 timestamp_t when;
2751 if (git_config_get_string_tmp(key, &expiry_string))
2752 return 1; /* no such thing */
2754 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2755 const int scale = 86400;
2756 *expiry = now - days * scale;
2757 return 0;
2760 if (!parse_expiry_date(expiry_string, &when)) {
2761 *expiry = when;
2762 return 0;
2764 return -1; /* thing exists but cannot be parsed */
2767 int git_config_get_split_index(void)
2769 int val;
2771 if (!git_config_get_maybe_bool("core.splitindex", &val))
2772 return val;
2774 return -1; /* default value */
2777 int git_config_get_max_percent_split_change(void)
2779 int val = -1;
2781 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2782 if (0 <= val && val <= 100)
2783 return val;
2785 return error(_("splitIndex.maxPercentChange value '%d' "
2786 "should be between 0 and 100"), val);
2789 return -1; /* default value */
2792 int git_config_get_index_threads(int *dest)
2794 int is_bool, val;
2796 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2797 if (val) {
2798 *dest = val;
2799 return 0;
2802 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2803 if (is_bool)
2804 *dest = val ? 0 : 1;
2805 else
2806 *dest = val;
2807 return 0;
2810 return 1;
2813 NORETURN
2814 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2816 if (!filename)
2817 die(_("unable to parse '%s' from command-line config"), key);
2818 else
2819 die(_("bad config variable '%s' in file '%s' at line %d"),
2820 key, filename, linenr);
2823 NORETURN __attribute__((format(printf, 2, 3)))
2824 void git_die_config(const char *key, const char *err, ...)
2826 const struct string_list *values;
2827 struct key_value_info *kv_info;
2828 report_fn error_fn = get_error_routine();
2830 if (err) {
2831 va_list params;
2832 va_start(params, err);
2833 error_fn(err, params);
2834 va_end(params);
2836 if (git_config_get_value_multi(key, &values))
2837 BUG("for key '%s' we must have a value to report on", key);
2838 kv_info = values->items[values->nr - 1].util;
2839 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2843 * Find all the stuff for git_config_set() below.
2846 struct config_store_data {
2847 size_t baselen;
2848 char *key;
2849 int do_not_match;
2850 const char *fixed_value;
2851 regex_t *value_pattern;
2852 int multi_replace;
2853 struct {
2854 size_t begin, end;
2855 enum config_event_t type;
2856 int is_keys_section;
2857 } *parsed;
2858 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2859 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2861 #define CONFIG_STORE_INIT { 0 }
2863 static void config_store_data_clear(struct config_store_data *store)
2865 free(store->key);
2866 if (store->value_pattern != NULL &&
2867 store->value_pattern != CONFIG_REGEX_NONE) {
2868 regfree(store->value_pattern);
2869 free(store->value_pattern);
2871 free(store->parsed);
2872 free(store->seen);
2873 memset(store, 0, sizeof(*store));
2876 static int matches(const char *key, const char *value,
2877 const struct config_store_data *store)
2879 if (strcmp(key, store->key))
2880 return 0; /* not ours */
2881 if (store->fixed_value)
2882 return !strcmp(store->fixed_value, value);
2883 if (!store->value_pattern)
2884 return 1; /* always matches */
2885 if (store->value_pattern == CONFIG_REGEX_NONE)
2886 return 0; /* never matches */
2888 return store->do_not_match ^
2889 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2892 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2893 struct config_source *cs, void *data)
2895 struct config_store_data *store = data;
2897 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2898 store->parsed[store->parsed_nr].begin = begin;
2899 store->parsed[store->parsed_nr].end = end;
2900 store->parsed[store->parsed_nr].type = type;
2902 if (type == CONFIG_EVENT_SECTION) {
2903 int (*cmpfn)(const char *, const char *, size_t);
2905 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2906 return error(_("invalid section name '%s'"), cs->var.buf);
2908 if (cs->subsection_case_sensitive)
2909 cmpfn = strncasecmp;
2910 else
2911 cmpfn = strncmp;
2913 /* Is this the section we were looking for? */
2914 store->is_keys_section =
2915 store->parsed[store->parsed_nr].is_keys_section =
2916 cs->var.len - 1 == store->baselen &&
2917 !cmpfn(cs->var.buf, store->key, store->baselen);
2918 if (store->is_keys_section) {
2919 store->section_seen = 1;
2920 ALLOC_GROW(store->seen, store->seen_nr + 1,
2921 store->seen_alloc);
2922 store->seen[store->seen_nr] = store->parsed_nr;
2926 store->parsed_nr++;
2928 return 0;
2931 static int store_aux(const char *key, const char *value,
2932 const struct config_context *ctx UNUSED, void *cb)
2934 struct config_store_data *store = cb;
2936 if (store->key_seen) {
2937 if (matches(key, value, store)) {
2938 if (store->seen_nr == 1 && store->multi_replace == 0) {
2939 warning(_("%s has multiple values"), key);
2942 ALLOC_GROW(store->seen, store->seen_nr + 1,
2943 store->seen_alloc);
2945 store->seen[store->seen_nr] = store->parsed_nr;
2946 store->seen_nr++;
2948 } else if (store->is_keys_section) {
2950 * Do not increment matches yet: this may not be a match, but we
2951 * are in the desired section.
2953 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2954 store->seen[store->seen_nr] = store->parsed_nr;
2955 store->section_seen = 1;
2957 if (matches(key, value, store)) {
2958 store->seen_nr++;
2959 store->key_seen = 1;
2963 return 0;
2966 static int write_error(const char *filename)
2968 error(_("failed to write new configuration file %s"), filename);
2970 /* Same error code as "failed to rename". */
2971 return 4;
2974 static struct strbuf store_create_section(const char *key,
2975 const struct config_store_data *store)
2977 const char *dot;
2978 size_t i;
2979 struct strbuf sb = STRBUF_INIT;
2981 dot = memchr(key, '.', store->baselen);
2982 if (dot) {
2983 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2984 for (i = dot - key + 1; i < store->baselen; i++) {
2985 if (key[i] == '"' || key[i] == '\\')
2986 strbuf_addch(&sb, '\\');
2987 strbuf_addch(&sb, key[i]);
2989 strbuf_addstr(&sb, "\"]\n");
2990 } else {
2991 strbuf_addch(&sb, '[');
2992 strbuf_add(&sb, key, store->baselen);
2993 strbuf_addstr(&sb, "]\n");
2996 return sb;
2999 static ssize_t write_section(int fd, const char *key,
3000 const struct config_store_data *store)
3002 struct strbuf sb = store_create_section(key, store);
3003 ssize_t ret;
3005 ret = write_in_full(fd, sb.buf, sb.len);
3006 strbuf_release(&sb);
3008 return ret;
3011 static ssize_t write_pair(int fd, const char *key, const char *value,
3012 const char *comment,
3013 const struct config_store_data *store)
3015 int i;
3016 ssize_t ret;
3017 const char *quote = "";
3018 struct strbuf sb = STRBUF_INIT;
3021 * Check to see if the value needs to be surrounded with a dq pair.
3022 * Note that problematic characters are always backslash-quoted; this
3023 * check is about not losing leading or trailing SP and strings that
3024 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3025 * configuration parser.
3027 if (value[0] == ' ')
3028 quote = "\"";
3029 for (i = 0; value[i]; i++)
3030 if (value[i] == ';' || value[i] == '#')
3031 quote = "\"";
3032 if (i && value[i - 1] == ' ')
3033 quote = "\"";
3035 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3037 for (i = 0; value[i]; i++)
3038 switch (value[i]) {
3039 case '\n':
3040 strbuf_addstr(&sb, "\\n");
3041 break;
3042 case '\t':
3043 strbuf_addstr(&sb, "\\t");
3044 break;
3045 case '"':
3046 case '\\':
3047 strbuf_addch(&sb, '\\');
3048 /* fallthrough */
3049 default:
3050 strbuf_addch(&sb, value[i]);
3051 break;
3054 if (comment)
3055 strbuf_addf(&sb, "%s%s\n", quote, comment);
3056 else
3057 strbuf_addf(&sb, "%s\n", quote);
3059 ret = write_in_full(fd, sb.buf, sb.len);
3060 strbuf_release(&sb);
3062 return ret;
3066 * If we are about to unset the last key(s) in a section, and if there are
3067 * no comments surrounding (or included in) the section, we will want to
3068 * extend begin/end to remove the entire section.
3070 * Note: the parameter `seen_ptr` points to the index into the store.seen
3071 * array. * This index may be incremented if a section has more than one
3072 * entry (which all are to be removed).
3074 static void maybe_remove_section(struct config_store_data *store,
3075 size_t *begin_offset, size_t *end_offset,
3076 int *seen_ptr)
3078 size_t begin;
3079 int i, seen, section_seen = 0;
3082 * First, ensure that this is the first key, and that there are no
3083 * comments before the entry nor before the section header.
3085 seen = *seen_ptr;
3086 for (i = store->seen[seen]; i > 0; i--) {
3087 enum config_event_t type = store->parsed[i - 1].type;
3089 if (type == CONFIG_EVENT_COMMENT)
3090 /* There is a comment before this entry or section */
3091 return;
3092 if (type == CONFIG_EVENT_ENTRY) {
3093 if (!section_seen)
3094 /* This is not the section's first entry. */
3095 return;
3096 /* We encountered no comment before the section. */
3097 break;
3099 if (type == CONFIG_EVENT_SECTION) {
3100 if (!store->parsed[i - 1].is_keys_section)
3101 break;
3102 section_seen = 1;
3105 begin = store->parsed[i].begin;
3108 * Next, make sure that we are removing the last key(s) in the section,
3109 * and that there are no comments that are possibly about the current
3110 * section.
3112 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3113 enum config_event_t type = store->parsed[i].type;
3115 if (type == CONFIG_EVENT_COMMENT)
3116 return;
3117 if (type == CONFIG_EVENT_SECTION) {
3118 if (store->parsed[i].is_keys_section)
3119 continue;
3120 break;
3122 if (type == CONFIG_EVENT_ENTRY) {
3123 if (++seen < store->seen_nr &&
3124 i == store->seen[seen])
3125 /* We want to remove this entry, too */
3126 continue;
3127 /* There is another entry in this section. */
3128 return;
3133 * We are really removing the last entry/entries from this section, and
3134 * there are no enclosed or surrounding comments. Remove the entire,
3135 * now-empty section.
3137 *seen_ptr = seen;
3138 *begin_offset = begin;
3139 if (i < store->parsed_nr)
3140 *end_offset = store->parsed[i].begin;
3141 else
3142 *end_offset = store->parsed[store->parsed_nr - 1].end;
3145 int git_config_set_in_file_gently(const char *config_filename,
3146 const char *key, const char *comment, const char *value)
3148 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, comment, 0);
3151 void git_config_set_in_file(const char *config_filename,
3152 const char *key, const char *value)
3154 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3157 int git_config_set_gently(const char *key, const char *value)
3159 return git_config_set_multivar_gently(key, value, NULL, 0);
3162 int repo_config_set_worktree_gently(struct repository *r,
3163 const char *key, const char *value)
3165 /* Only use worktree-specific config if it is already enabled. */
3166 if (r->repository_format_worktree_config) {
3167 char *file = repo_git_path(r, "config.worktree");
3168 int ret = git_config_set_multivar_in_file_gently(
3169 file, key, value, NULL, NULL, 0);
3170 free(file);
3171 return ret;
3173 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3176 void git_config_set(const char *key, const char *value)
3178 git_config_set_multivar(key, value, NULL, 0);
3180 trace2_cmd_set_config(key, value);
3184 * The ownership rule is that the caller will own the string
3185 * if it receives a piece of memory different from what it passed
3186 * as the parameter.
3188 const char *git_config_prepare_comment_string(const char *comment)
3190 size_t leading_blanks;
3192 if (!comment)
3193 return NULL;
3195 if (strchr(comment, '\n'))
3196 die(_("no multi-line comment allowed: '%s'"), comment);
3199 * If it begins with one or more leading whitespace characters
3200 * followed by '#", the comment string is used as-is.
3202 * If it begins with '#', a SP is inserted between the comment
3203 * and the value the comment is about.
3205 * Otherwise, the value is followed by a SP followed by '#'
3206 * followed by SP and then the comment string comes.
3209 leading_blanks = strspn(comment, " \t");
3210 if (leading_blanks && comment[leading_blanks] == '#')
3211 ; /* use it as-is */
3212 else if (comment[0] == '#')
3213 comment = xstrfmt(" %s", comment);
3214 else
3215 comment = xstrfmt(" # %s", comment);
3217 return comment;
3220 static void validate_comment_string(const char *comment)
3222 size_t leading_blanks;
3224 if (!comment)
3225 return;
3227 * The front-end must have massaged the comment string
3228 * properly before calling us.
3230 if (strchr(comment, '\n'))
3231 BUG("multi-line comments are not permitted: '%s'", comment);
3233 leading_blanks = strspn(comment, " \t");
3234 if (!leading_blanks || comment[leading_blanks] != '#')
3235 BUG("comment must begin with one or more SP followed by '#': '%s'",
3236 comment);
3240 * If value==NULL, unset in (remove from) config,
3241 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3242 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3243 * (only add a new one)
3244 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3245 * key/values are removed before a single new pair is written. If the
3246 * flag is not present, then replace only the first match.
3248 * Returns 0 on success.
3250 * This function does this:
3252 * - it locks the config file by creating ".git/config.lock"
3254 * - it then parses the config using store_aux() as validator to find
3255 * the position on the key/value pair to replace. If it is to be unset,
3256 * it must be found exactly once.
3258 * - the config file is mmap()ed and the part before the match (if any) is
3259 * written to the lock file, then the changed part and the rest.
3261 * - the config file is removed and the lock file rename()d to it.
3264 int git_config_set_multivar_in_file_gently(const char *config_filename,
3265 const char *key, const char *value,
3266 const char *value_pattern,
3267 const char *comment,
3268 unsigned flags)
3270 int fd = -1, in_fd = -1;
3271 int ret;
3272 struct lock_file lock = LOCK_INIT;
3273 char *filename_buf = NULL;
3274 char *contents = NULL;
3275 size_t contents_sz;
3276 struct config_store_data store = CONFIG_STORE_INIT;
3278 validate_comment_string(comment);
3280 /* parse-key returns negative; flip the sign to feed exit(3) */
3281 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3282 if (ret)
3283 goto out_free;
3285 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3287 if (!config_filename)
3288 config_filename = filename_buf = git_pathdup("config");
3291 * The lock serves a purpose in addition to locking: the new
3292 * contents of .git/config will be written into it.
3294 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3295 if (fd < 0) {
3296 error_errno(_("could not lock config file %s"), config_filename);
3297 ret = CONFIG_NO_LOCK;
3298 goto out_free;
3302 * If .git/config does not exist yet, write a minimal version.
3304 in_fd = open(config_filename, O_RDONLY);
3305 if ( in_fd < 0 ) {
3306 if ( ENOENT != errno ) {
3307 error_errno(_("opening %s"), config_filename);
3308 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3309 goto out_free;
3311 /* if nothing to unset, error out */
3312 if (!value) {
3313 ret = CONFIG_NOTHING_SET;
3314 goto out_free;
3317 free(store.key);
3318 store.key = xstrdup(key);
3319 if (write_section(fd, key, &store) < 0 ||
3320 write_pair(fd, key, value, comment, &store) < 0)
3321 goto write_err_out;
3322 } else {
3323 struct stat st;
3324 size_t copy_begin, copy_end;
3325 int i, new_line = 0;
3326 struct config_options opts;
3328 if (!value_pattern)
3329 store.value_pattern = NULL;
3330 else if (value_pattern == CONFIG_REGEX_NONE)
3331 store.value_pattern = CONFIG_REGEX_NONE;
3332 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3333 store.fixed_value = value_pattern;
3334 else {
3335 if (value_pattern[0] == '!') {
3336 store.do_not_match = 1;
3337 value_pattern++;
3338 } else
3339 store.do_not_match = 0;
3341 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3342 if (regcomp(store.value_pattern, value_pattern,
3343 REG_EXTENDED)) {
3344 error(_("invalid pattern: %s"), value_pattern);
3345 FREE_AND_NULL(store.value_pattern);
3346 ret = CONFIG_INVALID_PATTERN;
3347 goto out_free;
3351 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3352 store.parsed[0].end = 0;
3354 memset(&opts, 0, sizeof(opts));
3355 opts.event_fn = store_aux_event;
3356 opts.event_fn_data = &store;
3359 * After this, store.parsed will contain offsets of all the
3360 * parsed elements, and store.seen will contain a list of
3361 * matches, as indices into store.parsed.
3363 * As a side effect, we make sure to transform only a valid
3364 * existing config file.
3366 if (git_config_from_file_with_options(store_aux,
3367 config_filename,
3368 &store, CONFIG_SCOPE_UNKNOWN,
3369 &opts)) {
3370 error(_("invalid config file %s"), config_filename);
3371 ret = CONFIG_INVALID_FILE;
3372 goto out_free;
3375 /* if nothing to unset, or too many matches, error out */
3376 if ((store.seen_nr == 0 && value == NULL) ||
3377 (store.seen_nr > 1 && !store.multi_replace)) {
3378 ret = CONFIG_NOTHING_SET;
3379 goto out_free;
3382 if (fstat(in_fd, &st) == -1) {
3383 error_errno(_("fstat on %s failed"), config_filename);
3384 ret = CONFIG_INVALID_FILE;
3385 goto out_free;
3388 contents_sz = xsize_t(st.st_size);
3389 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3390 MAP_PRIVATE, in_fd, 0);
3391 if (contents == MAP_FAILED) {
3392 if (errno == ENODEV && S_ISDIR(st.st_mode))
3393 errno = EISDIR;
3394 error_errno(_("unable to mmap '%s'%s"),
3395 config_filename, mmap_os_err());
3396 ret = CONFIG_INVALID_FILE;
3397 contents = NULL;
3398 goto out_free;
3400 close(in_fd);
3401 in_fd = -1;
3403 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3404 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3405 ret = CONFIG_NO_WRITE;
3406 goto out_free;
3409 if (store.seen_nr == 0) {
3410 if (!store.seen_alloc) {
3411 /* Did not see key nor section */
3412 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3413 store.seen[0] = store.parsed_nr
3414 - !!store.parsed_nr;
3416 store.seen_nr = 1;
3419 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3420 size_t replace_end;
3421 int j = store.seen[i];
3423 new_line = 0;
3424 if (!store.key_seen) {
3425 copy_end = store.parsed[j].end;
3426 /* include '\n' when copying section header */
3427 if (copy_end > 0 && copy_end < contents_sz &&
3428 contents[copy_end - 1] != '\n' &&
3429 contents[copy_end] == '\n')
3430 copy_end++;
3431 replace_end = copy_end;
3432 } else {
3433 replace_end = store.parsed[j].end;
3434 copy_end = store.parsed[j].begin;
3435 if (!value)
3436 maybe_remove_section(&store,
3437 &copy_end,
3438 &replace_end, &i);
3440 * Swallow preceding white-space on the same
3441 * line.
3443 while (copy_end > 0 ) {
3444 char c = contents[copy_end - 1];
3446 if (isspace(c) && c != '\n')
3447 copy_end--;
3448 else
3449 break;
3453 if (copy_end > 0 && contents[copy_end-1] != '\n')
3454 new_line = 1;
3456 /* write the first part of the config */
3457 if (copy_end > copy_begin) {
3458 if (write_in_full(fd, contents + copy_begin,
3459 copy_end - copy_begin) < 0)
3460 goto write_err_out;
3461 if (new_line &&
3462 write_str_in_full(fd, "\n") < 0)
3463 goto write_err_out;
3465 copy_begin = replace_end;
3468 /* write the pair (value == NULL means unset) */
3469 if (value) {
3470 if (!store.section_seen) {
3471 if (write_section(fd, key, &store) < 0)
3472 goto write_err_out;
3474 if (write_pair(fd, key, value, comment, &store) < 0)
3475 goto write_err_out;
3478 /* write the rest of the config */
3479 if (copy_begin < contents_sz)
3480 if (write_in_full(fd, contents + copy_begin,
3481 contents_sz - copy_begin) < 0)
3482 goto write_err_out;
3484 munmap(contents, contents_sz);
3485 contents = NULL;
3488 if (commit_lock_file(&lock) < 0) {
3489 error_errno(_("could not write config file %s"), config_filename);
3490 ret = CONFIG_NO_WRITE;
3491 goto out_free;
3494 ret = 0;
3496 /* Invalidate the config cache */
3497 git_config_clear();
3499 out_free:
3500 rollback_lock_file(&lock);
3501 free(filename_buf);
3502 if (contents)
3503 munmap(contents, contents_sz);
3504 if (in_fd >= 0)
3505 close(in_fd);
3506 config_store_data_clear(&store);
3507 return ret;
3509 write_err_out:
3510 ret = write_error(get_lock_file_path(&lock));
3511 goto out_free;
3514 void git_config_set_multivar_in_file(const char *config_filename,
3515 const char *key, const char *value,
3516 const char *value_pattern, unsigned flags)
3518 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3519 value_pattern, NULL, flags))
3520 return;
3521 if (value)
3522 die(_("could not set '%s' to '%s'"), key, value);
3523 else
3524 die(_("could not unset '%s'"), key);
3527 int git_config_set_multivar_gently(const char *key, const char *value,
3528 const char *value_pattern, unsigned flags)
3530 return repo_config_set_multivar_gently(the_repository, key, value,
3531 value_pattern, flags);
3534 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3535 const char *value,
3536 const char *value_pattern, unsigned flags)
3538 char *file = repo_git_path(r, "config");
3539 int res = git_config_set_multivar_in_file_gently(file,
3540 key, value,
3541 value_pattern,
3542 NULL, flags);
3543 free(file);
3544 return res;
3547 void git_config_set_multivar(const char *key, const char *value,
3548 const char *value_pattern, unsigned flags)
3550 git_config_set_multivar_in_file(git_path("config"),
3551 key, value, value_pattern,
3552 flags);
3555 static size_t section_name_match (const char *buf, const char *name)
3557 size_t i = 0, j = 0;
3558 int dot = 0;
3559 if (buf[i] != '[')
3560 return 0;
3561 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3562 if (!dot && isspace(buf[i])) {
3563 dot = 1;
3564 if (name[j++] != '.')
3565 break;
3566 for (i++; isspace(buf[i]); i++)
3567 ; /* do nothing */
3568 if (buf[i] != '"')
3569 break;
3570 continue;
3572 if (buf[i] == '\\' && dot)
3573 i++;
3574 else if (buf[i] == '"' && dot) {
3575 for (i++; isspace(buf[i]); i++)
3576 ; /* do_nothing */
3577 break;
3579 if (buf[i] != name[j++])
3580 break;
3582 if (buf[i] == ']' && name[j] == 0) {
3584 * We match, now just find the right length offset by
3585 * gobbling up any whitespace after it, as well
3587 i++;
3588 for (; buf[i] && isspace(buf[i]); i++)
3589 ; /* do nothing */
3590 return i;
3592 return 0;
3595 static int section_name_is_ok(const char *name)
3597 /* Empty section names are bogus. */
3598 if (!*name)
3599 return 0;
3602 * Before a dot, we must be alphanumeric or dash. After the first dot,
3603 * anything goes, so we can stop checking.
3605 for (; *name && *name != '.'; name++)
3606 if (*name != '-' && !isalnum(*name))
3607 return 0;
3608 return 1;
3611 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3613 /* if new_name == NULL, the section is removed instead */
3614 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3615 const char *old_name,
3616 const char *new_name, int copy)
3618 int ret = 0, remove = 0;
3619 char *filename_buf = NULL;
3620 struct lock_file lock = LOCK_INIT;
3621 int out_fd;
3622 struct strbuf buf = STRBUF_INIT;
3623 FILE *config_file = NULL;
3624 struct stat st;
3625 struct strbuf copystr = STRBUF_INIT;
3626 struct config_store_data store;
3627 uint32_t line_nr = 0;
3629 memset(&store, 0, sizeof(store));
3631 if (new_name && !section_name_is_ok(new_name)) {
3632 ret = error(_("invalid section name: %s"), new_name);
3633 goto out_no_rollback;
3636 if (!config_filename)
3637 config_filename = filename_buf = git_pathdup("config");
3639 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3640 if (out_fd < 0) {
3641 ret = error(_("could not lock config file %s"), config_filename);
3642 goto out;
3645 if (!(config_file = fopen(config_filename, "rb"))) {
3646 ret = warn_on_fopen_errors(config_filename);
3647 if (ret)
3648 goto out;
3649 /* no config file means nothing to rename, no error */
3650 goto commit_and_out;
3653 if (fstat(fileno(config_file), &st) == -1) {
3654 ret = error_errno(_("fstat on %s failed"), config_filename);
3655 goto out;
3658 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3659 ret = error_errno(_("chmod on %s failed"),
3660 get_lock_file_path(&lock));
3661 goto out;
3664 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3665 size_t i, length;
3666 int is_section = 0;
3667 char *output = buf.buf;
3669 line_nr++;
3671 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3672 ret = error(_("refusing to work with overly long line "
3673 "in '%s' on line %"PRIuMAX),
3674 config_filename, (uintmax_t)line_nr);
3675 goto out;
3678 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3679 ; /* do nothing */
3680 if (buf.buf[i] == '[') {
3681 /* it's a section */
3682 size_t offset;
3683 is_section = 1;
3686 * When encountering a new section under -c we
3687 * need to flush out any section we're already
3688 * coping and begin anew. There might be
3689 * multiple [branch "$name"] sections.
3691 if (copystr.len > 0) {
3692 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3693 ret = write_error(get_lock_file_path(&lock));
3694 goto out;
3696 strbuf_reset(&copystr);
3699 offset = section_name_match(&buf.buf[i], old_name);
3700 if (offset > 0) {
3701 ret++;
3702 if (!new_name) {
3703 remove = 1;
3704 continue;
3706 store.baselen = strlen(new_name);
3707 if (!copy) {
3708 if (write_section(out_fd, new_name, &store) < 0) {
3709 ret = write_error(get_lock_file_path(&lock));
3710 goto out;
3713 * We wrote out the new section, with
3714 * a newline, now skip the old
3715 * section's length
3717 output += offset + i;
3718 if (strlen(output) > 0) {
3720 * More content means there's
3721 * a declaration to put on the
3722 * next line; indent with a
3723 * tab
3725 output -= 1;
3726 output[0] = '\t';
3728 } else {
3729 strbuf_release(&copystr);
3730 copystr = store_create_section(new_name, &store);
3733 remove = 0;
3735 if (remove)
3736 continue;
3737 length = strlen(output);
3739 if (!is_section && copystr.len > 0) {
3740 strbuf_add(&copystr, output, length);
3743 if (write_in_full(out_fd, output, length) < 0) {
3744 ret = write_error(get_lock_file_path(&lock));
3745 goto out;
3750 * Copy a trailing section at the end of the config, won't be
3751 * flushed by the usual "flush because we have a new section
3752 * logic in the loop above.
3754 if (copystr.len > 0) {
3755 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3756 ret = write_error(get_lock_file_path(&lock));
3757 goto out;
3759 strbuf_reset(&copystr);
3762 fclose(config_file);
3763 config_file = NULL;
3764 commit_and_out:
3765 if (commit_lock_file(&lock) < 0)
3766 ret = error_errno(_("could not write config file %s"),
3767 config_filename);
3768 out:
3769 if (config_file)
3770 fclose(config_file);
3771 rollback_lock_file(&lock);
3772 out_no_rollback:
3773 free(filename_buf);
3774 config_store_data_clear(&store);
3775 strbuf_release(&buf);
3776 strbuf_release(&copystr);
3777 return ret;
3780 int git_config_rename_section_in_file(const char *config_filename,
3781 const char *old_name, const char *new_name)
3783 return git_config_copy_or_rename_section_in_file(config_filename,
3784 old_name, new_name, 0);
3787 int git_config_rename_section(const char *old_name, const char *new_name)
3789 return git_config_rename_section_in_file(NULL, old_name, new_name);
3792 int git_config_copy_section_in_file(const char *config_filename,
3793 const char *old_name, const char *new_name)
3795 return git_config_copy_or_rename_section_in_file(config_filename,
3796 old_name, new_name, 1);
3799 int git_config_copy_section(const char *old_name, const char *new_name)
3801 return git_config_copy_section_in_file(NULL, old_name, new_name);
3805 * Call this to report error for your variable that should not
3806 * get a boolean value (i.e. "[my] var" means "true").
3808 #undef config_error_nonbool
3809 int config_error_nonbool(const char *var)
3811 return error(_("missing value for '%s'"), var);
3814 int parse_config_key(const char *var,
3815 const char *section,
3816 const char **subsection, size_t *subsection_len,
3817 const char **key)
3819 const char *dot;
3821 /* Does it start with "section." ? */
3822 if (!skip_prefix(var, section, &var) || *var != '.')
3823 return -1;
3826 * Find the key; we don't know yet if we have a subsection, but we must
3827 * parse backwards from the end, since the subsection may have dots in
3828 * it, too.
3830 dot = strrchr(var, '.');
3831 *key = dot + 1;
3833 /* Did we have a subsection at all? */
3834 if (dot == var) {
3835 if (subsection) {
3836 *subsection = NULL;
3837 *subsection_len = 0;
3840 else {
3841 if (!subsection)
3842 return -1;
3843 *subsection = var + 1;
3844 *subsection_len = dot - *subsection;
3847 return 0;
3850 const char *config_origin_type_name(enum config_origin_type type)
3852 switch (type) {
3853 case CONFIG_ORIGIN_BLOB:
3854 return "blob";
3855 case CONFIG_ORIGIN_FILE:
3856 return "file";
3857 case CONFIG_ORIGIN_STDIN:
3858 return "standard input";
3859 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3860 return "submodule-blob";
3861 case CONFIG_ORIGIN_CMDLINE:
3862 return "command line";
3863 default:
3864 BUG("unknown config origin type");
3868 const char *config_scope_name(enum config_scope scope)
3870 switch (scope) {
3871 case CONFIG_SCOPE_SYSTEM:
3872 return "system";
3873 case CONFIG_SCOPE_GLOBAL:
3874 return "global";
3875 case CONFIG_SCOPE_LOCAL:
3876 return "local";
3877 case CONFIG_SCOPE_WORKTREE:
3878 return "worktree";
3879 case CONFIG_SCOPE_COMMAND:
3880 return "command";
3881 case CONFIG_SCOPE_SUBMODULE:
3882 return "submodule";
3883 default:
3884 return "unknown";
3888 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3890 int i;
3892 for (i = 0; i < nr_mapping; i++) {
3893 const char *name = mapping[i];
3895 if (name && !strcasecmp(var, name))
3896 return i;
3898 return -1;