fsck: handle NULL value when parsing message config
[git/gitster.git] / config.c
blob18085c7e387a756f4039776cc63fba5f56b684f6
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 "dir.h"
34 #include "color.h"
35 #include "replace-object.h"
36 #include "refs.h"
37 #include "setup.h"
38 #include "strvec.h"
39 #include "trace2.h"
40 #include "wildmatch.h"
41 #include "worktree.h"
42 #include "ws.h"
43 #include "write-or-die.h"
45 struct config_source {
46 struct config_source *prev;
47 union {
48 FILE *file;
49 struct config_buf {
50 const char *buf;
51 size_t len;
52 size_t pos;
53 } buf;
54 } u;
55 enum config_origin_type origin_type;
56 const char *name;
57 const char *path;
58 enum config_error_action default_error_action;
59 int linenr;
60 int eof;
61 size_t total_len;
62 struct strbuf value;
63 struct strbuf var;
64 unsigned subsection_case_sensitive : 1;
66 int (*do_fgetc)(struct config_source *c);
67 int (*do_ungetc)(int c, struct config_source *conf);
68 long (*do_ftell)(struct config_source *c);
70 #define CONFIG_SOURCE_INIT { 0 }
72 static int pack_compression_seen;
73 static int zlib_compression_seen;
76 * Config that comes from trusted scopes, namely:
77 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
78 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
79 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
81 * This is declared here for code cleanliness, but unlike the other
82 * static variables, this does not hold config parser state.
84 static struct config_set protected_config;
86 static int config_file_fgetc(struct config_source *conf)
88 return getc_unlocked(conf->u.file);
91 static int config_file_ungetc(int c, struct config_source *conf)
93 return ungetc(c, conf->u.file);
96 static long config_file_ftell(struct config_source *conf)
98 return ftell(conf->u.file);
102 static int config_buf_fgetc(struct config_source *conf)
104 if (conf->u.buf.pos < conf->u.buf.len)
105 return conf->u.buf.buf[conf->u.buf.pos++];
107 return EOF;
110 static int config_buf_ungetc(int c, struct config_source *conf)
112 if (conf->u.buf.pos > 0) {
113 conf->u.buf.pos--;
114 if (conf->u.buf.buf[conf->u.buf.pos] != c)
115 BUG("config_buf can only ungetc the same character");
116 return c;
119 return EOF;
122 static long config_buf_ftell(struct config_source *conf)
124 return conf->u.buf.pos;
127 struct config_include_data {
128 int depth;
129 config_fn_t fn;
130 void *data;
131 const struct config_options *opts;
132 struct git_config_source *config_source;
133 struct repository *repo;
136 * All remote URLs discovered when reading all config files.
138 struct string_list *remote_urls;
140 #define CONFIG_INCLUDE_INIT { 0 }
142 static int git_config_include(const char *var, const char *value,
143 const struct config_context *ctx, void *data);
145 #define MAX_INCLUDE_DEPTH 10
146 static const char include_depth_advice[] = N_(
147 "exceeded maximum include depth (%d) while including\n"
148 " %s\n"
149 "from\n"
150 " %s\n"
151 "This might be due to circular includes.");
152 static int handle_path_include(const struct key_value_info *kvi,
153 const char *path,
154 struct config_include_data *inc)
156 int ret = 0;
157 struct strbuf buf = STRBUF_INIT;
158 char *expanded;
160 if (!path)
161 return config_error_nonbool("include.path");
163 expanded = interpolate_path(path, 0);
164 if (!expanded)
165 return error(_("could not expand include path '%s'"), path);
166 path = expanded;
169 * Use an absolute path as-is, but interpret relative paths
170 * based on the including config file.
172 if (!is_absolute_path(path)) {
173 char *slash;
175 if (!kvi || !kvi->path) {
176 ret = error(_("relative config includes must come from files"));
177 goto cleanup;
180 slash = find_last_dir_sep(kvi->path);
181 if (slash)
182 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
183 strbuf_addstr(&buf, path);
184 path = buf.buf;
187 if (!access_or_die(path, R_OK, 0)) {
188 if (++inc->depth > MAX_INCLUDE_DEPTH)
189 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
190 !kvi ? "<unknown>" :
191 kvi->filename ? kvi->filename :
192 "the command line");
193 ret = git_config_from_file_with_options(git_config_include, path, inc,
194 kvi->scope, NULL);
195 inc->depth--;
197 cleanup:
198 strbuf_release(&buf);
199 free(expanded);
200 return ret;
203 static void add_trailing_starstar_for_dir(struct strbuf *pat)
205 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
206 strbuf_addstr(pat, "**");
209 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
210 struct strbuf *pat)
212 struct strbuf path = STRBUF_INIT;
213 char *expanded;
214 int prefix = 0;
216 expanded = interpolate_path(pat->buf, 1);
217 if (expanded) {
218 strbuf_reset(pat);
219 strbuf_addstr(pat, expanded);
220 free(expanded);
223 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
224 const char *slash;
226 if (!kvi || !kvi->path)
227 return error(_("relative config include "
228 "conditionals must come from files"));
230 strbuf_realpath(&path, kvi->path, 1);
231 slash = find_last_dir_sep(path.buf);
232 if (!slash)
233 BUG("how is this possible?");
234 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
235 prefix = slash - path.buf + 1 /* slash */;
236 } else if (!is_absolute_path(pat->buf))
237 strbuf_insertstr(pat, 0, "**/");
239 add_trailing_starstar_for_dir(pat);
241 strbuf_release(&path);
242 return prefix;
245 static int include_by_gitdir(const struct key_value_info *kvi,
246 const struct config_options *opts,
247 const char *cond, size_t cond_len, int icase)
249 struct strbuf text = STRBUF_INIT;
250 struct strbuf pattern = STRBUF_INIT;
251 int ret = 0, prefix;
252 const char *git_dir;
253 int already_tried_absolute = 0;
255 if (opts->git_dir)
256 git_dir = opts->git_dir;
257 else
258 goto done;
260 strbuf_realpath(&text, git_dir, 1);
261 strbuf_add(&pattern, cond, cond_len);
262 prefix = prepare_include_condition_pattern(kvi, &pattern);
264 again:
265 if (prefix < 0)
266 goto done;
268 if (prefix > 0) {
270 * perform literal matching on the prefix part so that
271 * any wildcard character in it can't create side effects.
273 if (text.len < prefix)
274 goto done;
275 if (!icase && strncmp(pattern.buf, text.buf, prefix))
276 goto done;
277 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
278 goto done;
281 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
282 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
284 if (!ret && !already_tried_absolute) {
286 * We've tried e.g. matching gitdir:~/work, but if
287 * ~/work is a symlink to /mnt/storage/work
288 * strbuf_realpath() will expand it, so the rule won't
289 * match. Let's match against a
290 * strbuf_add_absolute_path() version of the path,
291 * which'll do the right thing
293 strbuf_reset(&text);
294 strbuf_add_absolute_path(&text, git_dir);
295 already_tried_absolute = 1;
296 goto again;
298 done:
299 strbuf_release(&pattern);
300 strbuf_release(&text);
301 return ret;
304 static int include_by_branch(const char *cond, size_t cond_len)
306 int flags;
307 int ret;
308 struct strbuf pattern = STRBUF_INIT;
309 const char *refname = !the_repository->gitdir ?
310 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
311 const char *shortname;
313 if (!refname || !(flags & REF_ISSYMREF) ||
314 !skip_prefix(refname, "refs/heads/", &shortname))
315 return 0;
317 strbuf_add(&pattern, cond, cond_len);
318 add_trailing_starstar_for_dir(&pattern);
319 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
320 strbuf_release(&pattern);
321 return ret;
324 static int add_remote_url(const char *var, const char *value,
325 const struct config_context *ctx UNUSED, void *data)
327 struct string_list *remote_urls = data;
328 const char *remote_name;
329 size_t remote_name_len;
330 const char *key;
332 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
333 &key) &&
334 remote_name &&
335 !strcmp(key, "url"))
336 string_list_append(remote_urls, value);
337 return 0;
340 static void populate_remote_urls(struct config_include_data *inc)
342 struct config_options opts;
344 opts = *inc->opts;
345 opts.unconditional_remote_url = 1;
347 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
348 string_list_init_dup(inc->remote_urls);
349 config_with_options(add_remote_url, inc->remote_urls,
350 inc->config_source, inc->repo, &opts);
353 static int forbid_remote_url(const char *var, const char *value UNUSED,
354 const struct config_context *ctx UNUSED,
355 void *data UNUSED)
357 const char *remote_name;
358 size_t remote_name_len;
359 const char *key;
361 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
362 &key) &&
363 remote_name &&
364 !strcmp(key, "url"))
365 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
366 return 0;
369 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
370 struct string_list *remote_urls)
372 struct strbuf pattern = STRBUF_INIT;
373 struct string_list_item *url_item;
374 int found = 0;
376 strbuf_add(&pattern, glob, glob_len);
377 for_each_string_list_item(url_item, remote_urls) {
378 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
379 found = 1;
380 break;
383 strbuf_release(&pattern);
384 return found;
387 static int include_by_remote_url(struct config_include_data *inc,
388 const char *cond, size_t cond_len)
390 if (inc->opts->unconditional_remote_url)
391 return 1;
392 if (!inc->remote_urls)
393 populate_remote_urls(inc);
394 return at_least_one_url_matches_glob(cond, cond_len,
395 inc->remote_urls);
398 static int include_condition_is_true(const struct key_value_info *kvi,
399 struct config_include_data *inc,
400 const char *cond, size_t cond_len)
402 const struct config_options *opts = inc->opts;
404 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
405 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
406 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
407 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
408 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
409 return include_by_branch(cond, cond_len);
410 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
411 &cond_len))
412 return include_by_remote_url(inc, cond, cond_len);
414 /* unknown conditionals are always false */
415 return 0;
418 static int git_config_include(const char *var, const char *value,
419 const struct config_context *ctx,
420 void *data)
422 struct config_include_data *inc = data;
423 const char *cond, *key;
424 size_t cond_len;
425 int ret;
428 * Pass along all values, including "include" directives; this makes it
429 * possible to query information on the includes themselves.
431 ret = inc->fn(var, value, ctx, inc->data);
432 if (ret < 0)
433 return ret;
435 if (!strcmp(var, "include.path"))
436 ret = handle_path_include(ctx->kvi, value, inc);
438 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
439 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
440 !strcmp(key, "path")) {
441 config_fn_t old_fn = inc->fn;
443 if (inc->opts->unconditional_remote_url)
444 inc->fn = forbid_remote_url;
445 ret = handle_path_include(ctx->kvi, value, inc);
446 inc->fn = old_fn;
449 return ret;
452 static void git_config_push_split_parameter(const char *key, const char *value)
454 struct strbuf env = STRBUF_INIT;
455 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
456 if (old && *old) {
457 strbuf_addstr(&env, old);
458 strbuf_addch(&env, ' ');
460 sq_quote_buf(&env, key);
461 strbuf_addch(&env, '=');
462 if (value)
463 sq_quote_buf(&env, value);
464 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
465 strbuf_release(&env);
468 void git_config_push_parameter(const char *text)
470 const char *value;
473 * When we see:
475 * section.subsection=with=equals.key=value
477 * we cannot tell if it means:
479 * [section "subsection=with=equals"]
480 * key = value
482 * or:
484 * [section]
485 * subsection = with=equals.key=value
487 * We parse left-to-right for the first "=", meaning we'll prefer to
488 * keep the value intact over the subsection. This is historical, but
489 * also sensible since values are more likely to contain odd or
490 * untrusted input than a section name.
492 * A missing equals is explicitly allowed (as a bool-only entry).
494 value = strchr(text, '=');
495 if (value) {
496 char *key = xmemdupz(text, value - text);
497 git_config_push_split_parameter(key, value + 1);
498 free(key);
499 } else {
500 git_config_push_split_parameter(text, NULL);
504 void git_config_push_env(const char *spec)
506 char *key;
507 const char *env_name;
508 const char *env_value;
510 env_name = strrchr(spec, '=');
511 if (!env_name)
512 die(_("invalid config format: %s"), spec);
513 key = xmemdupz(spec, env_name - spec);
514 env_name++;
515 if (!*env_name)
516 die(_("missing environment variable name for configuration '%.*s'"),
517 (int)(env_name - spec - 1), spec);
519 env_value = getenv(env_name);
520 if (!env_value)
521 die(_("missing environment variable '%s' for configuration '%.*s'"),
522 env_name, (int)(env_name - spec - 1), spec);
524 git_config_push_split_parameter(key, env_value);
525 free(key);
528 static inline int iskeychar(int c)
530 return isalnum(c) || c == '-';
534 * Auxiliary function to sanity-check and split the key into the section
535 * identifier and variable name.
537 * Returns 0 on success, -1 when there is an invalid character in the key and
538 * -2 if there is no section name in the key.
540 * store_key - pointer to char* which will hold a copy of the key with
541 * lowercase section and variable name
542 * baselen - pointer to size_t which will hold the length of the
543 * section + subsection part, can be NULL
545 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
547 size_t i, baselen;
548 int dot;
549 const char *last_dot = strrchr(key, '.');
552 * Since "key" actually contains the section name and the real
553 * key name separated by a dot, we have to know where the dot is.
556 if (last_dot == NULL || last_dot == key) {
557 error(_("key does not contain a section: %s"), key);
558 return -CONFIG_NO_SECTION_OR_NAME;
561 if (!last_dot[1]) {
562 error(_("key does not contain variable name: %s"), key);
563 return -CONFIG_NO_SECTION_OR_NAME;
566 baselen = last_dot - key;
567 if (baselen_)
568 *baselen_ = baselen;
571 * Validate the key and while at it, lower case it for matching.
573 *store_key = xmallocz(strlen(key));
575 dot = 0;
576 for (i = 0; key[i]; i++) {
577 unsigned char c = key[i];
578 if (c == '.')
579 dot = 1;
580 /* Leave the extended basename untouched.. */
581 if (!dot || i > baselen) {
582 if (!iskeychar(c) ||
583 (i == baselen + 1 && !isalpha(c))) {
584 error(_("invalid key: %s"), key);
585 goto out_free_ret_1;
587 c = tolower(c);
588 } else if (c == '\n') {
589 error(_("invalid key (newline): %s"), key);
590 goto out_free_ret_1;
592 (*store_key)[i] = c;
595 return 0;
597 out_free_ret_1:
598 FREE_AND_NULL(*store_key);
599 return -CONFIG_INVALID_KEY;
602 static int config_parse_pair(const char *key, const char *value,
603 struct key_value_info *kvi,
604 config_fn_t fn, void *data)
606 char *canonical_name;
607 int ret;
608 struct config_context ctx = {
609 .kvi = kvi,
612 if (!strlen(key))
613 return error(_("empty config key"));
614 if (git_config_parse_key(key, &canonical_name, NULL))
615 return -1;
617 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
618 free(canonical_name);
619 return ret;
623 /* for values read from `git_config_from_parameters()` */
624 void kvi_from_param(struct key_value_info *out)
626 out->filename = NULL;
627 out->linenr = -1;
628 out->origin_type = CONFIG_ORIGIN_CMDLINE;
629 out->scope = CONFIG_SCOPE_COMMAND;
630 out->path = NULL;
633 int git_config_parse_parameter(const char *text,
634 config_fn_t fn, void *data)
636 const char *value;
637 struct strbuf **pair;
638 int ret;
639 struct key_value_info kvi = KVI_INIT;
641 kvi_from_param(&kvi);
643 pair = strbuf_split_str(text, '=', 2);
644 if (!pair[0])
645 return error(_("bogus config parameter: %s"), text);
647 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
648 strbuf_setlen(pair[0], pair[0]->len - 1);
649 value = pair[1] ? pair[1]->buf : "";
650 } else {
651 value = NULL;
654 strbuf_trim(pair[0]);
655 if (!pair[0]->len) {
656 strbuf_list_free(pair);
657 return error(_("bogus config parameter: %s"), text);
660 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
661 strbuf_list_free(pair);
662 return ret;
665 static int parse_config_env_list(char *env, struct key_value_info *kvi,
666 config_fn_t fn, void *data)
668 char *cur = env;
669 while (cur && *cur) {
670 const char *key = sq_dequote_step(cur, &cur);
671 if (!key)
672 return error(_("bogus format in %s"),
673 CONFIG_DATA_ENVIRONMENT);
675 if (!cur || isspace(*cur)) {
676 /* old-style 'key=value' */
677 if (git_config_parse_parameter(key, fn, data) < 0)
678 return -1;
680 else if (*cur == '=') {
681 /* new-style 'key'='value' */
682 const char *value;
684 cur++;
685 if (*cur == '\'') {
686 /* quoted value */
687 value = sq_dequote_step(cur, &cur);
688 if (!value || (cur && !isspace(*cur))) {
689 return error(_("bogus format in %s"),
690 CONFIG_DATA_ENVIRONMENT);
692 } else if (!*cur || isspace(*cur)) {
693 /* implicit bool: 'key'= */
694 value = NULL;
695 } else {
696 return error(_("bogus format in %s"),
697 CONFIG_DATA_ENVIRONMENT);
700 if (config_parse_pair(key, value, kvi, fn, data) < 0)
701 return -1;
703 else {
704 /* unknown format */
705 return error(_("bogus format in %s"),
706 CONFIG_DATA_ENVIRONMENT);
709 if (cur) {
710 while (isspace(*cur))
711 cur++;
714 return 0;
717 int git_config_from_parameters(config_fn_t fn, void *data)
719 const char *env;
720 struct strbuf envvar = STRBUF_INIT;
721 struct strvec to_free = STRVEC_INIT;
722 int ret = 0;
723 char *envw = NULL;
724 struct key_value_info kvi = KVI_INIT;
726 kvi_from_param(&kvi);
727 env = getenv(CONFIG_COUNT_ENVIRONMENT);
728 if (env) {
729 unsigned long count;
730 char *endp;
731 int i;
733 count = strtoul(env, &endp, 10);
734 if (*endp) {
735 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
736 goto out;
738 if (count > INT_MAX) {
739 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
740 goto out;
743 for (i = 0; i < count; i++) {
744 const char *key, *value;
746 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
747 key = getenv_safe(&to_free, envvar.buf);
748 if (!key) {
749 ret = error(_("missing config key %s"), envvar.buf);
750 goto out;
752 strbuf_reset(&envvar);
754 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
755 value = getenv_safe(&to_free, envvar.buf);
756 if (!value) {
757 ret = error(_("missing config value %s"), envvar.buf);
758 goto out;
760 strbuf_reset(&envvar);
762 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
763 ret = -1;
764 goto out;
769 env = getenv(CONFIG_DATA_ENVIRONMENT);
770 if (env) {
771 /* sq_dequote will write over it */
772 envw = xstrdup(env);
773 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
774 ret = -1;
775 goto out;
779 out:
780 strbuf_release(&envvar);
781 strvec_clear(&to_free);
782 free(envw);
783 return ret;
786 static int get_next_char(struct config_source *cs)
788 int c = cs->do_fgetc(cs);
790 if (c == '\r') {
791 /* DOS like systems */
792 c = cs->do_fgetc(cs);
793 if (c != '\n') {
794 if (c != EOF)
795 cs->do_ungetc(c, cs);
796 c = '\r';
800 if (c != EOF && ++cs->total_len > INT_MAX) {
802 * This is an absurdly long config file; refuse to parse
803 * further in order to protect downstream code from integer
804 * overflows. Note that we can't return an error specifically,
805 * but we can mark EOF and put trash in the return value,
806 * which will trigger a parse error.
808 cs->eof = 1;
809 return 0;
812 if (c == '\n')
813 cs->linenr++;
814 if (c == EOF) {
815 cs->eof = 1;
816 cs->linenr++;
817 c = '\n';
819 return c;
822 static char *parse_value(struct config_source *cs)
824 int quote = 0, comment = 0, space = 0;
826 strbuf_reset(&cs->value);
827 for (;;) {
828 int c = get_next_char(cs);
829 if (c == '\n') {
830 if (quote) {
831 cs->linenr--;
832 return NULL;
834 return cs->value.buf;
836 if (comment)
837 continue;
838 if (isspace(c) && !quote) {
839 if (cs->value.len)
840 space++;
841 continue;
843 if (!quote) {
844 if (c == ';' || c == '#') {
845 comment = 1;
846 continue;
849 for (; space; space--)
850 strbuf_addch(&cs->value, ' ');
851 if (c == '\\') {
852 c = get_next_char(cs);
853 switch (c) {
854 case '\n':
855 continue;
856 case 't':
857 c = '\t';
858 break;
859 case 'b':
860 c = '\b';
861 break;
862 case 'n':
863 c = '\n';
864 break;
865 /* Some characters escape as themselves */
866 case '\\': case '"':
867 break;
868 /* Reject unknown escape sequences */
869 default:
870 return NULL;
872 strbuf_addch(&cs->value, c);
873 continue;
875 if (c == '"') {
876 quote = 1-quote;
877 continue;
879 strbuf_addch(&cs->value, c);
883 static int get_value(struct config_source *cs, struct key_value_info *kvi,
884 config_fn_t fn, void *data, struct strbuf *name)
886 int c;
887 char *value;
888 int ret;
889 struct config_context ctx = {
890 .kvi = kvi,
893 /* Get the full name */
894 for (;;) {
895 c = get_next_char(cs);
896 if (cs->eof)
897 break;
898 if (!iskeychar(c))
899 break;
900 strbuf_addch(name, tolower(c));
903 while (c == ' ' || c == '\t')
904 c = get_next_char(cs);
906 value = NULL;
907 if (c != '\n') {
908 if (c != '=')
909 return -1;
910 value = parse_value(cs);
911 if (!value)
912 return -1;
915 * We already consumed the \n, but we need linenr to point to
916 * the line we just parsed during the call to fn to get
917 * accurate line number in error messages.
919 cs->linenr--;
920 kvi->linenr = cs->linenr;
921 ret = fn(name->buf, value, &ctx, data);
922 if (ret >= 0)
923 cs->linenr++;
924 return ret;
927 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
928 int c)
930 cs->subsection_case_sensitive = 0;
931 do {
932 if (c == '\n')
933 goto error_incomplete_line;
934 c = get_next_char(cs);
935 } while (isspace(c));
937 /* We require the format to be '[base "extension"]' */
938 if (c != '"')
939 return -1;
940 strbuf_addch(name, '.');
942 for (;;) {
943 int c = get_next_char(cs);
944 if (c == '\n')
945 goto error_incomplete_line;
946 if (c == '"')
947 break;
948 if (c == '\\') {
949 c = get_next_char(cs);
950 if (c == '\n')
951 goto error_incomplete_line;
953 strbuf_addch(name, c);
956 /* Final ']' */
957 if (get_next_char(cs) != ']')
958 return -1;
959 return 0;
960 error_incomplete_line:
961 cs->linenr--;
962 return -1;
965 static int get_base_var(struct config_source *cs, struct strbuf *name)
967 cs->subsection_case_sensitive = 1;
968 for (;;) {
969 int c = get_next_char(cs);
970 if (cs->eof)
971 return -1;
972 if (c == ']')
973 return 0;
974 if (isspace(c))
975 return get_extended_base_var(cs, name, c);
976 if (!iskeychar(c) && c != '.')
977 return -1;
978 strbuf_addch(name, tolower(c));
982 struct parse_event_data {
983 enum config_event_t previous_type;
984 size_t previous_offset;
985 const struct config_options *opts;
988 static int do_event(struct config_source *cs, enum config_event_t type,
989 struct parse_event_data *data)
991 size_t offset;
993 if (!data->opts || !data->opts->event_fn)
994 return 0;
996 if (type == CONFIG_EVENT_WHITESPACE &&
997 data->previous_type == type)
998 return 0;
1000 offset = cs->do_ftell(cs);
1002 * At EOF, the parser always "inserts" an extra '\n', therefore
1003 * the end offset of the event is the current file position, otherwise
1004 * we will already have advanced to the next event.
1006 if (type != CONFIG_EVENT_EOF)
1007 offset--;
1009 if (data->previous_type != CONFIG_EVENT_EOF &&
1010 data->opts->event_fn(data->previous_type, data->previous_offset,
1011 offset, cs, data->opts->event_fn_data) < 0)
1012 return -1;
1014 data->previous_type = type;
1015 data->previous_offset = offset;
1017 return 0;
1020 static void kvi_from_source(struct config_source *cs,
1021 enum config_scope scope,
1022 struct key_value_info *out)
1024 out->filename = strintern(cs->name);
1025 out->origin_type = cs->origin_type;
1026 out->linenr = cs->linenr;
1027 out->scope = scope;
1028 out->path = cs->path;
1031 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1032 struct key_value_info *kvi, void *data,
1033 const struct config_options *opts)
1035 int comment = 0;
1036 size_t baselen = 0;
1037 struct strbuf *var = &cs->var;
1038 int error_return = 0;
1039 char *error_msg = NULL;
1041 /* U+FEFF Byte Order Mark in UTF8 */
1042 const char *bomptr = utf8_bom;
1044 /* For the parser event callback */
1045 struct parse_event_data event_data = {
1046 CONFIG_EVENT_EOF, 0, opts
1049 for (;;) {
1050 int c;
1052 c = get_next_char(cs);
1053 if (bomptr && *bomptr) {
1054 /* We are at the file beginning; skip UTF8-encoded BOM
1055 * if present. Sane editors won't put this in on their
1056 * own, but e.g. Windows Notepad will do it happily. */
1057 if (c == (*bomptr & 0377)) {
1058 bomptr++;
1059 continue;
1060 } else {
1061 /* Do not tolerate partial BOM. */
1062 if (bomptr != utf8_bom)
1063 break;
1064 /* No BOM at file beginning. Cool. */
1065 bomptr = NULL;
1068 if (c == '\n') {
1069 if (cs->eof) {
1070 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1071 return -1;
1072 return 0;
1074 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1075 return -1;
1076 comment = 0;
1077 continue;
1079 if (comment)
1080 continue;
1081 if (isspace(c)) {
1082 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1083 return -1;
1084 continue;
1086 if (c == '#' || c == ';') {
1087 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1088 return -1;
1089 comment = 1;
1090 continue;
1092 if (c == '[') {
1093 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1094 return -1;
1096 /* Reset prior to determining a new stem */
1097 strbuf_reset(var);
1098 if (get_base_var(cs, var) < 0 || var->len < 1)
1099 break;
1100 strbuf_addch(var, '.');
1101 baselen = var->len;
1102 continue;
1104 if (!isalpha(c))
1105 break;
1107 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1108 return -1;
1111 * Truncate the var name back to the section header
1112 * stem prior to grabbing the suffix part of the name
1113 * and the value.
1115 strbuf_setlen(var, baselen);
1116 strbuf_addch(var, tolower(c));
1117 if (get_value(cs, kvi, fn, data, var) < 0)
1118 break;
1121 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1122 return -1;
1124 switch (cs->origin_type) {
1125 case CONFIG_ORIGIN_BLOB:
1126 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1127 cs->linenr, cs->name);
1128 break;
1129 case CONFIG_ORIGIN_FILE:
1130 error_msg = xstrfmt(_("bad config line %d in file %s"),
1131 cs->linenr, cs->name);
1132 break;
1133 case CONFIG_ORIGIN_STDIN:
1134 error_msg = xstrfmt(_("bad config line %d in standard input"),
1135 cs->linenr);
1136 break;
1137 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1138 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1139 cs->linenr, cs->name);
1140 break;
1141 case CONFIG_ORIGIN_CMDLINE:
1142 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1143 cs->linenr, cs->name);
1144 break;
1145 default:
1146 error_msg = xstrfmt(_("bad config line %d in %s"),
1147 cs->linenr, cs->name);
1150 switch (opts && opts->error_action ?
1151 opts->error_action :
1152 cs->default_error_action) {
1153 case CONFIG_ERROR_DIE:
1154 die("%s", error_msg);
1155 break;
1156 case CONFIG_ERROR_ERROR:
1157 error_return = error("%s", error_msg);
1158 break;
1159 case CONFIG_ERROR_SILENT:
1160 error_return = -1;
1161 break;
1162 case CONFIG_ERROR_UNSET:
1163 BUG("config error action unset");
1166 free(error_msg);
1167 return error_return;
1170 NORETURN
1171 static void die_bad_number(const char *name, const char *value,
1172 const struct key_value_info *kvi)
1174 const char *error_type = (errno == ERANGE) ?
1175 N_("out of range") : N_("invalid unit");
1176 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1178 if (!kvi)
1179 BUG("kvi should not be NULL");
1181 if (!value)
1182 value = "";
1184 if (!kvi->filename)
1185 die(_(bad_numeric), value, name, _(error_type));
1187 switch (kvi->origin_type) {
1188 case CONFIG_ORIGIN_BLOB:
1189 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1190 value, name, kvi->filename, _(error_type));
1191 case CONFIG_ORIGIN_FILE:
1192 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1193 value, name, kvi->filename, _(error_type));
1194 case CONFIG_ORIGIN_STDIN:
1195 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1196 value, name, _(error_type));
1197 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1198 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1199 value, name, kvi->filename, _(error_type));
1200 case CONFIG_ORIGIN_CMDLINE:
1201 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1202 value, name, kvi->filename, _(error_type));
1203 default:
1204 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1205 value, name, kvi->filename, _(error_type));
1209 int git_config_int(const char *name, const char *value,
1210 const struct key_value_info *kvi)
1212 int ret;
1213 if (!git_parse_int(value, &ret))
1214 die_bad_number(name, value, kvi);
1215 return ret;
1218 int64_t git_config_int64(const char *name, const char *value,
1219 const struct key_value_info *kvi)
1221 int64_t ret;
1222 if (!git_parse_int64(value, &ret))
1223 die_bad_number(name, value, kvi);
1224 return ret;
1227 unsigned long git_config_ulong(const char *name, const char *value,
1228 const struct key_value_info *kvi)
1230 unsigned long ret;
1231 if (!git_parse_ulong(value, &ret))
1232 die_bad_number(name, value, kvi);
1233 return ret;
1236 ssize_t git_config_ssize_t(const char *name, const char *value,
1237 const struct key_value_info *kvi)
1239 ssize_t ret;
1240 if (!git_parse_ssize_t(value, &ret))
1241 die_bad_number(name, value, kvi);
1242 return ret;
1245 static const struct fsync_component_name {
1246 const char *name;
1247 enum fsync_component component_bits;
1248 } fsync_component_names[] = {
1249 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1250 { "pack", FSYNC_COMPONENT_PACK },
1251 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1252 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1253 { "index", FSYNC_COMPONENT_INDEX },
1254 { "objects", FSYNC_COMPONENTS_OBJECTS },
1255 { "reference", FSYNC_COMPONENT_REFERENCE },
1256 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1257 { "committed", FSYNC_COMPONENTS_COMMITTED },
1258 { "added", FSYNC_COMPONENTS_ADDED },
1259 { "all", FSYNC_COMPONENTS_ALL },
1262 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1264 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1265 enum fsync_component positive = 0, negative = 0;
1267 while (string) {
1268 int i;
1269 size_t len;
1270 const char *ep;
1271 int negated = 0;
1272 int found = 0;
1274 string = string + strspn(string, ", \t\n\r");
1275 ep = strchrnul(string, ',');
1276 len = ep - string;
1277 if (!strcmp(string, "none")) {
1278 current = FSYNC_COMPONENT_NONE;
1279 goto next_name;
1282 if (*string == '-') {
1283 negated = 1;
1284 string++;
1285 len--;
1286 if (!len)
1287 warning(_("invalid value for variable %s"), var);
1290 if (!len)
1291 break;
1293 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1294 const struct fsync_component_name *n = &fsync_component_names[i];
1296 if (strncmp(n->name, string, len))
1297 continue;
1299 found = 1;
1300 if (negated)
1301 negative |= n->component_bits;
1302 else
1303 positive |= n->component_bits;
1306 if (!found) {
1307 char *component = xstrndup(string, len);
1308 warning(_("ignoring unknown core.fsync component '%s'"), component);
1309 free(component);
1312 next_name:
1313 string = ep;
1316 return (current & ~negative) | positive;
1319 int git_config_bool_or_int(const char *name, const char *value,
1320 const struct key_value_info *kvi, int *is_bool)
1322 int v = git_parse_maybe_bool_text(value);
1323 if (0 <= v) {
1324 *is_bool = 1;
1325 return v;
1327 *is_bool = 0;
1328 return git_config_int(name, value, kvi);
1331 int git_config_bool(const char *name, const char *value)
1333 int v = git_parse_maybe_bool(value);
1334 if (v < 0)
1335 die(_("bad boolean config value '%s' for '%s'"), value, name);
1336 return v;
1339 int git_config_string(const char **dest, const char *var, const char *value)
1341 if (!value)
1342 return config_error_nonbool(var);
1343 *dest = xstrdup(value);
1344 return 0;
1347 int git_config_pathname(const char **dest, const char *var, const char *value)
1349 if (!value)
1350 return config_error_nonbool(var);
1351 *dest = interpolate_path(value, 0);
1352 if (!*dest)
1353 die(_("failed to expand user dir in: '%s'"), value);
1354 return 0;
1357 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1359 if (!value)
1360 return config_error_nonbool(var);
1361 if (parse_expiry_date(value, timestamp))
1362 return error(_("'%s' for '%s' is not a valid timestamp"),
1363 value, var);
1364 return 0;
1367 int git_config_color(char *dest, const char *var, const char *value)
1369 if (!value)
1370 return config_error_nonbool(var);
1371 if (color_parse(value, dest) < 0)
1372 return -1;
1373 return 0;
1376 static int git_default_core_config(const char *var, const char *value,
1377 const struct config_context *ctx, void *cb)
1379 /* This needs a better name */
1380 if (!strcmp(var, "core.filemode")) {
1381 trust_executable_bit = git_config_bool(var, value);
1382 return 0;
1384 if (!strcmp(var, "core.trustctime")) {
1385 trust_ctime = git_config_bool(var, value);
1386 return 0;
1388 if (!strcmp(var, "core.checkstat")) {
1389 if (!value)
1390 return config_error_nonbool(var);
1391 if (!strcasecmp(value, "default"))
1392 check_stat = 1;
1393 else if (!strcasecmp(value, "minimal"))
1394 check_stat = 0;
1397 if (!strcmp(var, "core.quotepath")) {
1398 quote_path_fully = git_config_bool(var, value);
1399 return 0;
1402 if (!strcmp(var, "core.symlinks")) {
1403 has_symlinks = git_config_bool(var, value);
1404 return 0;
1407 if (!strcmp(var, "core.ignorecase")) {
1408 ignore_case = git_config_bool(var, value);
1409 return 0;
1412 if (!strcmp(var, "core.attributesfile"))
1413 return git_config_pathname(&git_attributes_file, var, value);
1415 if (!strcmp(var, "core.hookspath"))
1416 return git_config_pathname(&git_hooks_path, var, value);
1418 if (!strcmp(var, "core.bare")) {
1419 is_bare_repository_cfg = git_config_bool(var, value);
1420 return 0;
1423 if (!strcmp(var, "core.ignorestat")) {
1424 assume_unchanged = git_config_bool(var, value);
1425 return 0;
1428 if (!strcmp(var, "core.prefersymlinkrefs")) {
1429 prefer_symlink_refs = git_config_bool(var, value);
1430 return 0;
1433 if (!strcmp(var, "core.logallrefupdates")) {
1434 if (value && !strcasecmp(value, "always"))
1435 log_all_ref_updates = LOG_REFS_ALWAYS;
1436 else if (git_config_bool(var, value))
1437 log_all_ref_updates = LOG_REFS_NORMAL;
1438 else
1439 log_all_ref_updates = LOG_REFS_NONE;
1440 return 0;
1443 if (!strcmp(var, "core.warnambiguousrefs")) {
1444 warn_ambiguous_refs = git_config_bool(var, value);
1445 return 0;
1448 if (!strcmp(var, "core.abbrev")) {
1449 if (!value)
1450 return config_error_nonbool(var);
1451 if (!strcasecmp(value, "auto"))
1452 default_abbrev = -1;
1453 else if (!git_parse_maybe_bool_text(value))
1454 default_abbrev = the_hash_algo->hexsz;
1455 else {
1456 int abbrev = git_config_int(var, value, ctx->kvi);
1457 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1458 return error(_("abbrev length out of range: %d"), abbrev);
1459 default_abbrev = abbrev;
1461 return 0;
1464 if (!strcmp(var, "core.disambiguate"))
1465 return set_disambiguate_hint_config(var, value);
1467 if (!strcmp(var, "core.loosecompression")) {
1468 int level = git_config_int(var, value, ctx->kvi);
1469 if (level == -1)
1470 level = Z_DEFAULT_COMPRESSION;
1471 else if (level < 0 || level > Z_BEST_COMPRESSION)
1472 die(_("bad zlib compression level %d"), level);
1473 zlib_compression_level = level;
1474 zlib_compression_seen = 1;
1475 return 0;
1478 if (!strcmp(var, "core.compression")) {
1479 int level = git_config_int(var, value, ctx->kvi);
1480 if (level == -1)
1481 level = Z_DEFAULT_COMPRESSION;
1482 else if (level < 0 || level > Z_BEST_COMPRESSION)
1483 die(_("bad zlib compression level %d"), level);
1484 if (!zlib_compression_seen)
1485 zlib_compression_level = level;
1486 if (!pack_compression_seen)
1487 pack_compression_level = level;
1488 return 0;
1491 if (!strcmp(var, "core.packedgitwindowsize")) {
1492 int pgsz_x2 = getpagesize() * 2;
1493 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1495 /* This value must be multiple of (pagesize * 2) */
1496 packed_git_window_size /= pgsz_x2;
1497 if (packed_git_window_size < 1)
1498 packed_git_window_size = 1;
1499 packed_git_window_size *= pgsz_x2;
1500 return 0;
1503 if (!strcmp(var, "core.bigfilethreshold")) {
1504 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1505 return 0;
1508 if (!strcmp(var, "core.packedgitlimit")) {
1509 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1510 return 0;
1513 if (!strcmp(var, "core.deltabasecachelimit")) {
1514 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1515 return 0;
1518 if (!strcmp(var, "core.autocrlf")) {
1519 if (value && !strcasecmp(value, "input")) {
1520 auto_crlf = AUTO_CRLF_INPUT;
1521 return 0;
1523 auto_crlf = git_config_bool(var, value);
1524 return 0;
1527 if (!strcmp(var, "core.safecrlf")) {
1528 int eol_rndtrp_die;
1529 if (value && !strcasecmp(value, "warn")) {
1530 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1531 return 0;
1533 eol_rndtrp_die = git_config_bool(var, value);
1534 global_conv_flags_eol = eol_rndtrp_die ?
1535 CONV_EOL_RNDTRP_DIE : 0;
1536 return 0;
1539 if (!strcmp(var, "core.eol")) {
1540 if (value && !strcasecmp(value, "lf"))
1541 core_eol = EOL_LF;
1542 else if (value && !strcasecmp(value, "crlf"))
1543 core_eol = EOL_CRLF;
1544 else if (value && !strcasecmp(value, "native"))
1545 core_eol = EOL_NATIVE;
1546 else
1547 core_eol = EOL_UNSET;
1548 return 0;
1551 if (!strcmp(var, "core.checkroundtripencoding")) {
1552 if (!value)
1553 return config_error_nonbool(var);
1554 check_roundtrip_encoding = xstrdup(value);
1555 return 0;
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 if (!value)
1570 return config_error_nonbool(var);
1571 else if (!strcasecmp(value, "auto"))
1572 auto_comment_line_char = 1;
1573 else if (value[0] && !value[1]) {
1574 comment_line_char = value[0];
1575 auto_comment_line_char = 0;
1576 } else
1577 return error(_("core.commentChar should only be one ASCII character"));
1578 return 0;
1581 if (!strcmp(var, "core.askpass"))
1582 return git_config_string(&askpass_program, var, value);
1584 if (!strcmp(var, "core.excludesfile"))
1585 return git_config_pathname(&excludes_file, var, value);
1587 if (!strcmp(var, "core.whitespace")) {
1588 if (!value)
1589 return config_error_nonbool(var);
1590 whitespace_rule_cfg = parse_whitespace_rule(value);
1591 return 0;
1594 if (!strcmp(var, "core.fsync")) {
1595 if (!value)
1596 return config_error_nonbool(var);
1597 fsync_components = parse_fsync_components(var, value);
1598 return 0;
1601 if (!strcmp(var, "core.fsyncmethod")) {
1602 if (!value)
1603 return config_error_nonbool(var);
1604 if (!strcmp(value, "fsync"))
1605 fsync_method = FSYNC_METHOD_FSYNC;
1606 else if (!strcmp(value, "writeout-only"))
1607 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1608 else if (!strcmp(value, "batch"))
1609 fsync_method = FSYNC_METHOD_BATCH;
1610 else
1611 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1615 if (!strcmp(var, "core.fsyncobjectfiles")) {
1616 if (fsync_object_files < 0)
1617 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1618 fsync_object_files = git_config_bool(var, value);
1619 return 0;
1622 if (!strcmp(var, "core.preloadindex")) {
1623 core_preload_index = git_config_bool(var, value);
1624 return 0;
1627 if (!strcmp(var, "core.createobject")) {
1628 if (!value)
1629 return config_error_nonbool(var);
1630 if (!strcmp(value, "rename"))
1631 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1632 else if (!strcmp(value, "link"))
1633 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1634 else
1635 die(_("invalid mode for object creation: %s"), value);
1636 return 0;
1639 if (!strcmp(var, "core.sparsecheckout")) {
1640 core_apply_sparse_checkout = git_config_bool(var, value);
1641 return 0;
1644 if (!strcmp(var, "core.sparsecheckoutcone")) {
1645 core_sparse_checkout_cone = git_config_bool(var, value);
1646 return 0;
1649 if (!strcmp(var, "core.precomposeunicode")) {
1650 precomposed_unicode = git_config_bool(var, value);
1651 return 0;
1654 if (!strcmp(var, "core.protecthfs")) {
1655 protect_hfs = git_config_bool(var, value);
1656 return 0;
1659 if (!strcmp(var, "core.protectntfs")) {
1660 protect_ntfs = git_config_bool(var, value);
1661 return 0;
1664 if (!strcmp(var, "core.maxtreedepth")) {
1665 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1666 return 0;
1669 /* Add other config variables here and to Documentation/config.txt. */
1670 return platform_core_config(var, value, ctx, cb);
1673 static int git_default_sparse_config(const char *var, const char *value)
1675 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1676 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1677 return 0;
1680 /* Add other config variables here and to Documentation/config/sparse.txt. */
1681 return 0;
1684 static int git_default_i18n_config(const char *var, const char *value)
1686 if (!strcmp(var, "i18n.commitencoding"))
1687 return git_config_string(&git_commit_encoding, var, value);
1689 if (!strcmp(var, "i18n.logoutputencoding"))
1690 return git_config_string(&git_log_output_encoding, var, value);
1692 /* Add other config variables here and to Documentation/config.txt. */
1693 return 0;
1696 static int git_default_branch_config(const char *var, const char *value)
1698 if (!strcmp(var, "branch.autosetupmerge")) {
1699 if (value && !strcmp(value, "always")) {
1700 git_branch_track = BRANCH_TRACK_ALWAYS;
1701 return 0;
1702 } else if (value && !strcmp(value, "inherit")) {
1703 git_branch_track = BRANCH_TRACK_INHERIT;
1704 return 0;
1705 } else if (value && !strcmp(value, "simple")) {
1706 git_branch_track = BRANCH_TRACK_SIMPLE;
1707 return 0;
1709 git_branch_track = git_config_bool(var, value);
1710 return 0;
1712 if (!strcmp(var, "branch.autosetuprebase")) {
1713 if (!value)
1714 return config_error_nonbool(var);
1715 else if (!strcmp(value, "never"))
1716 autorebase = AUTOREBASE_NEVER;
1717 else if (!strcmp(value, "local"))
1718 autorebase = AUTOREBASE_LOCAL;
1719 else if (!strcmp(value, "remote"))
1720 autorebase = AUTOREBASE_REMOTE;
1721 else if (!strcmp(value, "always"))
1722 autorebase = AUTOREBASE_ALWAYS;
1723 else
1724 return error(_("malformed value for %s"), var);
1725 return 0;
1728 /* Add other config variables here and to Documentation/config.txt. */
1729 return 0;
1732 static int git_default_push_config(const char *var, const char *value)
1734 if (!strcmp(var, "push.default")) {
1735 if (!value)
1736 return config_error_nonbool(var);
1737 else if (!strcmp(value, "nothing"))
1738 push_default = PUSH_DEFAULT_NOTHING;
1739 else if (!strcmp(value, "matching"))
1740 push_default = PUSH_DEFAULT_MATCHING;
1741 else if (!strcmp(value, "simple"))
1742 push_default = PUSH_DEFAULT_SIMPLE;
1743 else if (!strcmp(value, "upstream"))
1744 push_default = PUSH_DEFAULT_UPSTREAM;
1745 else if (!strcmp(value, "tracking")) /* deprecated */
1746 push_default = PUSH_DEFAULT_UPSTREAM;
1747 else if (!strcmp(value, "current"))
1748 push_default = PUSH_DEFAULT_CURRENT;
1749 else {
1750 error(_("malformed value for %s: %s"), var, value);
1751 return error(_("must be one of nothing, matching, simple, "
1752 "upstream or current"));
1754 return 0;
1757 /* Add other config variables here and to Documentation/config.txt. */
1758 return 0;
1761 static int git_default_mailmap_config(const char *var, const char *value)
1763 if (!strcmp(var, "mailmap.file"))
1764 return git_config_pathname(&git_mailmap_file, var, value);
1765 if (!strcmp(var, "mailmap.blob"))
1766 return git_config_string(&git_mailmap_blob, var, value);
1768 /* Add other config variables here and to Documentation/config.txt. */
1769 return 0;
1772 static int git_default_attr_config(const char *var, const char *value)
1774 if (!strcmp(var, "attr.tree"))
1775 return git_config_string(&git_attr_tree, var, value);
1778 * Add other attribute related config variables here and to
1779 * Documentation/config/attr.txt.
1781 return 0;
1784 int git_default_config(const char *var, const char *value,
1785 const struct config_context *ctx, void *cb)
1787 if (starts_with(var, "core."))
1788 return git_default_core_config(var, value, ctx, cb);
1790 if (starts_with(var, "user.") ||
1791 starts_with(var, "author.") ||
1792 starts_with(var, "committer."))
1793 return git_ident_config(var, value, ctx, cb);
1795 if (starts_with(var, "i18n."))
1796 return git_default_i18n_config(var, value);
1798 if (starts_with(var, "branch."))
1799 return git_default_branch_config(var, value);
1801 if (starts_with(var, "push."))
1802 return git_default_push_config(var, value);
1804 if (starts_with(var, "mailmap."))
1805 return git_default_mailmap_config(var, value);
1807 if (starts_with(var, "attr."))
1808 return git_default_attr_config(var, value);
1810 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1811 return git_default_advice_config(var, value);
1813 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1814 pager_use_color = git_config_bool(var,value);
1815 return 0;
1818 if (!strcmp(var, "pack.packsizelimit")) {
1819 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1820 return 0;
1823 if (!strcmp(var, "pack.compression")) {
1824 int level = git_config_int(var, value, ctx->kvi);
1825 if (level == -1)
1826 level = Z_DEFAULT_COMPRESSION;
1827 else if (level < 0 || level > Z_BEST_COMPRESSION)
1828 die(_("bad pack compression level %d"), level);
1829 pack_compression_level = level;
1830 pack_compression_seen = 1;
1831 return 0;
1834 if (starts_with(var, "sparse."))
1835 return git_default_sparse_config(var, value);
1837 /* Add other config variables here and to Documentation/config.txt. */
1838 return 0;
1842 * All source specific fields in the union, die_on_error, name and the callbacks
1843 * fgetc, ungetc, ftell of top need to be initialized before calling
1844 * this function.
1846 static int do_config_from(struct config_source *top, config_fn_t fn,
1847 void *data, enum config_scope scope,
1848 const struct config_options *opts)
1850 struct key_value_info kvi = KVI_INIT;
1851 int ret;
1853 /* push config-file parsing state stack */
1854 top->linenr = 1;
1855 top->eof = 0;
1856 top->total_len = 0;
1857 strbuf_init(&top->value, 1024);
1858 strbuf_init(&top->var, 1024);
1859 kvi_from_source(top, scope, &kvi);
1861 ret = git_parse_source(top, fn, &kvi, data, opts);
1863 strbuf_release(&top->value);
1864 strbuf_release(&top->var);
1866 return ret;
1869 static int do_config_from_file(config_fn_t fn,
1870 const enum config_origin_type origin_type,
1871 const char *name, const char *path, FILE *f,
1872 void *data, enum config_scope scope,
1873 const struct config_options *opts)
1875 struct config_source top = CONFIG_SOURCE_INIT;
1876 int ret;
1878 top.u.file = f;
1879 top.origin_type = origin_type;
1880 top.name = name;
1881 top.path = path;
1882 top.default_error_action = CONFIG_ERROR_DIE;
1883 top.do_fgetc = config_file_fgetc;
1884 top.do_ungetc = config_file_ungetc;
1885 top.do_ftell = config_file_ftell;
1887 flockfile(f);
1888 ret = do_config_from(&top, fn, data, scope, opts);
1889 funlockfile(f);
1890 return ret;
1893 static int git_config_from_stdin(config_fn_t fn, void *data,
1894 enum config_scope scope)
1896 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1897 data, scope, NULL);
1900 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1901 void *data, enum config_scope scope,
1902 const struct config_options *opts)
1904 int ret = -1;
1905 FILE *f;
1907 if (!filename)
1908 BUG("filename cannot be NULL");
1909 f = fopen_or_warn(filename, "r");
1910 if (f) {
1911 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1912 filename, f, data, scope, opts);
1913 fclose(f);
1915 return ret;
1918 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1920 return git_config_from_file_with_options(fn, filename, data,
1921 CONFIG_SCOPE_UNKNOWN, NULL);
1924 int git_config_from_mem(config_fn_t fn,
1925 const enum config_origin_type origin_type,
1926 const char *name, const char *buf, size_t len,
1927 void *data, enum config_scope scope,
1928 const struct config_options *opts)
1930 struct config_source top = CONFIG_SOURCE_INIT;
1932 top.u.buf.buf = buf;
1933 top.u.buf.len = len;
1934 top.u.buf.pos = 0;
1935 top.origin_type = origin_type;
1936 top.name = name;
1937 top.path = NULL;
1938 top.default_error_action = CONFIG_ERROR_ERROR;
1939 top.do_fgetc = config_buf_fgetc;
1940 top.do_ungetc = config_buf_ungetc;
1941 top.do_ftell = config_buf_ftell;
1943 return do_config_from(&top, fn, data, scope, opts);
1946 int git_config_from_blob_oid(config_fn_t fn,
1947 const char *name,
1948 struct repository *repo,
1949 const struct object_id *oid,
1950 void *data,
1951 enum config_scope scope)
1953 enum object_type type;
1954 char *buf;
1955 unsigned long size;
1956 int ret;
1958 buf = repo_read_object_file(repo, oid, &type, &size);
1959 if (!buf)
1960 return error(_("unable to load config blob object '%s'"), name);
1961 if (type != OBJ_BLOB) {
1962 free(buf);
1963 return error(_("reference '%s' does not point to a blob"), name);
1966 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1967 data, scope, NULL);
1968 free(buf);
1970 return ret;
1973 static int git_config_from_blob_ref(config_fn_t fn,
1974 struct repository *repo,
1975 const char *name,
1976 void *data,
1977 enum config_scope scope)
1979 struct object_id oid;
1981 if (repo_get_oid(repo, name, &oid) < 0)
1982 return error(_("unable to resolve config blob '%s'"), name);
1983 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
1986 char *git_system_config(void)
1988 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1989 if (!system_config)
1990 system_config = system_path(ETC_GITCONFIG);
1991 normalize_path_copy(system_config, system_config);
1992 return system_config;
1995 void git_global_config(char **user_out, char **xdg_out)
1997 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1998 char *xdg_config = NULL;
2000 if (!user_config) {
2001 user_config = interpolate_path("~/.gitconfig", 0);
2002 xdg_config = xdg_config_home("config");
2005 *user_out = user_config;
2006 *xdg_out = xdg_config;
2009 int git_config_system(void)
2011 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2014 static int do_git_config_sequence(const struct config_options *opts,
2015 const struct repository *repo,
2016 config_fn_t fn, void *data)
2018 int ret = 0;
2019 char *system_config = git_system_config();
2020 char *xdg_config = NULL;
2021 char *user_config = NULL;
2022 char *repo_config;
2023 char *worktree_config;
2026 * Ensure that either:
2027 * - the git_dir and commondir are both set, or
2028 * - the git_dir and commondir are both NULL
2030 if (!opts->git_dir != !opts->commondir)
2031 BUG("only one of commondir and git_dir is non-NULL");
2033 if (opts->commondir) {
2034 repo_config = mkpathdup("%s/config", opts->commondir);
2035 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2036 } else {
2037 repo_config = NULL;
2038 worktree_config = NULL;
2041 if (git_config_system() && system_config &&
2042 !access_or_die(system_config, R_OK,
2043 opts->system_gently ? ACCESS_EACCES_OK : 0))
2044 ret += git_config_from_file_with_options(fn, system_config,
2045 data, CONFIG_SCOPE_SYSTEM,
2046 NULL);
2048 git_global_config(&user_config, &xdg_config);
2050 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2051 ret += git_config_from_file_with_options(fn, xdg_config, data,
2052 CONFIG_SCOPE_GLOBAL, NULL);
2054 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2055 ret += git_config_from_file_with_options(fn, user_config, data,
2056 CONFIG_SCOPE_GLOBAL, NULL);
2058 if (!opts->ignore_repo && repo_config &&
2059 !access_or_die(repo_config, R_OK, 0))
2060 ret += git_config_from_file_with_options(fn, repo_config, data,
2061 CONFIG_SCOPE_LOCAL, NULL);
2063 if (!opts->ignore_worktree && worktree_config &&
2064 repo && repo->repository_format_worktree_config &&
2065 !access_or_die(worktree_config, R_OK, 0)) {
2066 ret += git_config_from_file_with_options(fn, worktree_config, data,
2067 CONFIG_SCOPE_WORKTREE,
2068 NULL);
2071 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2072 die(_("unable to parse command-line config"));
2074 free(system_config);
2075 free(xdg_config);
2076 free(user_config);
2077 free(repo_config);
2078 free(worktree_config);
2079 return ret;
2082 int config_with_options(config_fn_t fn, void *data,
2083 struct git_config_source *config_source,
2084 struct repository *repo,
2085 const struct config_options *opts)
2087 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2088 int ret;
2090 if (opts->respect_includes) {
2091 inc.fn = fn;
2092 inc.data = data;
2093 inc.opts = opts;
2094 inc.repo = repo;
2095 inc.config_source = config_source;
2096 fn = git_config_include;
2097 data = &inc;
2101 * If we have a specific filename, use it. Otherwise, follow the
2102 * regular lookup sequence.
2104 if (config_source && config_source->use_stdin) {
2105 ret = git_config_from_stdin(fn, data, config_source->scope);
2106 } else if (config_source && config_source->file) {
2107 ret = git_config_from_file_with_options(fn, config_source->file,
2108 data, config_source->scope,
2109 NULL);
2110 } else if (config_source && config_source->blob) {
2111 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2112 data, config_source->scope);
2113 } else {
2114 ret = do_git_config_sequence(opts, repo, fn, data);
2117 if (inc.remote_urls) {
2118 string_list_clear(inc.remote_urls, 0);
2119 FREE_AND_NULL(inc.remote_urls);
2121 return ret;
2124 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2126 int i, value_index;
2127 struct string_list *values;
2128 struct config_set_element *entry;
2129 struct configset_list *list = &set->list;
2130 struct config_context ctx = CONFIG_CONTEXT_INIT;
2132 for (i = 0; i < list->nr; i++) {
2133 entry = list->items[i].e;
2134 value_index = list->items[i].value_index;
2135 values = &entry->value_list;
2137 ctx.kvi = values->items[value_index].util;
2138 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2139 git_die_config_linenr(entry->key,
2140 ctx.kvi->filename,
2141 ctx.kvi->linenr);
2145 void read_early_config(config_fn_t cb, void *data)
2147 struct config_options opts = {0};
2148 struct strbuf commondir = STRBUF_INIT;
2149 struct strbuf gitdir = STRBUF_INIT;
2151 opts.respect_includes = 1;
2153 if (have_git_dir()) {
2154 opts.commondir = get_git_common_dir();
2155 opts.git_dir = get_git_dir();
2157 * When setup_git_directory() was not yet asked to discover the
2158 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2159 * is any repository config we should use (but unlike
2160 * setup_git_directory_gently(), no global state is changed, most
2161 * notably, the current working directory is still the same after the
2162 * call).
2164 } else if (!discover_git_directory(&commondir, &gitdir)) {
2165 opts.commondir = commondir.buf;
2166 opts.git_dir = gitdir.buf;
2169 config_with_options(cb, data, NULL, NULL, &opts);
2171 strbuf_release(&commondir);
2172 strbuf_release(&gitdir);
2176 * Read config but only enumerate system and global settings.
2177 * Omit any repo-local, worktree-local, or command-line settings.
2179 void read_very_early_config(config_fn_t cb, void *data)
2181 struct config_options opts = { 0 };
2183 opts.respect_includes = 1;
2184 opts.ignore_repo = 1;
2185 opts.ignore_worktree = 1;
2186 opts.ignore_cmdline = 1;
2187 opts.system_gently = 1;
2189 config_with_options(cb, data, NULL, NULL, &opts);
2192 RESULT_MUST_BE_USED
2193 static int configset_find_element(struct config_set *set, const char *key,
2194 struct config_set_element **dest)
2196 struct config_set_element k;
2197 struct config_set_element *found_entry;
2198 char *normalized_key;
2199 int ret;
2202 * `key` may come from the user, so normalize it before using it
2203 * for querying entries from the hashmap.
2205 ret = git_config_parse_key(key, &normalized_key, NULL);
2206 if (ret)
2207 return ret;
2209 hashmap_entry_init(&k.ent, strhash(normalized_key));
2210 k.key = normalized_key;
2211 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2212 free(normalized_key);
2213 *dest = found_entry;
2214 return 0;
2217 static int configset_add_value(const struct key_value_info *kvi_p,
2218 struct config_set *set, const char *key,
2219 const char *value)
2221 struct config_set_element *e;
2222 struct string_list_item *si;
2223 struct configset_list_item *l_item;
2224 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2225 int ret;
2227 ret = configset_find_element(set, key, &e);
2228 if (ret)
2229 return ret;
2231 * Since the keys are being fed by git_config*() callback mechanism, they
2232 * are already normalized. So simply add them without any further munging.
2234 if (!e) {
2235 e = xmalloc(sizeof(*e));
2236 hashmap_entry_init(&e->ent, strhash(key));
2237 e->key = xstrdup(key);
2238 string_list_init_dup(&e->value_list);
2239 hashmap_add(&set->config_hash, &e->ent);
2241 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2243 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2244 l_item = &set->list.items[set->list.nr++];
2245 l_item->e = e;
2246 l_item->value_index = e->value_list.nr - 1;
2248 *kv_info = *kvi_p;
2249 si->util = kv_info;
2251 return 0;
2254 static int config_set_element_cmp(const void *cmp_data UNUSED,
2255 const struct hashmap_entry *eptr,
2256 const struct hashmap_entry *entry_or_key,
2257 const void *keydata UNUSED)
2259 const struct config_set_element *e1, *e2;
2261 e1 = container_of(eptr, const struct config_set_element, ent);
2262 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2264 return strcmp(e1->key, e2->key);
2267 void git_configset_init(struct config_set *set)
2269 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2270 set->hash_initialized = 1;
2271 set->list.nr = 0;
2272 set->list.alloc = 0;
2273 set->list.items = NULL;
2276 void git_configset_clear(struct config_set *set)
2278 struct config_set_element *entry;
2279 struct hashmap_iter iter;
2280 if (!set->hash_initialized)
2281 return;
2283 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2284 ent /* member name */) {
2285 free(entry->key);
2286 string_list_clear(&entry->value_list, 1);
2288 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2289 set->hash_initialized = 0;
2290 free(set->list.items);
2291 set->list.nr = 0;
2292 set->list.alloc = 0;
2293 set->list.items = NULL;
2296 static int config_set_callback(const char *key, const char *value,
2297 const struct config_context *ctx,
2298 void *cb)
2300 struct config_set *set = cb;
2301 configset_add_value(ctx->kvi, set, key, value);
2302 return 0;
2305 int git_configset_add_file(struct config_set *set, const char *filename)
2307 return git_config_from_file(config_set_callback, filename, set);
2310 int git_configset_get_value(struct config_set *set, const char *key,
2311 const char **value, struct key_value_info *kvi)
2313 const struct string_list *values = NULL;
2314 int ret;
2315 struct string_list_item item;
2317 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2318 * queried key in the files of the configset, the value returned will be the last
2319 * value in the value list for that key.
2321 if ((ret = git_configset_get_value_multi(set, key, &values)))
2322 return ret;
2324 assert(values->nr > 0);
2325 item = values->items[values->nr - 1];
2326 *value = item.string;
2327 if (kvi)
2328 *kvi = *((struct key_value_info *)item.util);
2329 return 0;
2332 int git_configset_get_value_multi(struct config_set *set, const char *key,
2333 const struct string_list **dest)
2335 struct config_set_element *e;
2336 int ret;
2338 if ((ret = configset_find_element(set, key, &e)))
2339 return ret;
2340 else if (!e)
2341 return 1;
2342 *dest = &e->value_list;
2344 return 0;
2347 static int check_multi_string(struct string_list_item *item, void *util)
2349 return item->string ? 0 : config_error_nonbool(util);
2352 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2353 const struct string_list **dest)
2355 int ret;
2357 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2358 return ret;
2359 if ((ret = for_each_string_list((struct string_list *)*dest,
2360 check_multi_string, (void *)key)))
2361 return ret;
2363 return 0;
2366 int git_configset_get(struct config_set *set, const char *key)
2368 struct config_set_element *e;
2369 int ret;
2371 if ((ret = configset_find_element(set, key, &e)))
2372 return ret;
2373 else if (!e)
2374 return 1;
2375 return 0;
2378 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2380 const char *value;
2381 if (!git_configset_get_value(set, key, &value, NULL))
2382 return git_config_string((const char **)dest, key, value);
2383 else
2384 return 1;
2387 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2388 const char **dest)
2390 const char *value;
2391 if (!git_configset_get_value(set, key, &value, NULL)) {
2392 if (!value)
2393 return config_error_nonbool(key);
2394 *dest = value;
2395 return 0;
2396 } else {
2397 return 1;
2401 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2403 const char *value;
2404 struct key_value_info kvi;
2406 if (!git_configset_get_value(set, key, &value, &kvi)) {
2407 *dest = git_config_int(key, value, &kvi);
2408 return 0;
2409 } else
2410 return 1;
2413 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2415 const char *value;
2416 struct key_value_info kvi;
2418 if (!git_configset_get_value(set, key, &value, &kvi)) {
2419 *dest = git_config_ulong(key, value, &kvi);
2420 return 0;
2421 } else
2422 return 1;
2425 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2427 const char *value;
2428 if (!git_configset_get_value(set, key, &value, NULL)) {
2429 *dest = git_config_bool(key, value);
2430 return 0;
2431 } else
2432 return 1;
2435 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2436 int *is_bool, int *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_bool_or_int(key, value, &kvi, is_bool);
2443 return 0;
2444 } else
2445 return 1;
2448 int git_configset_get_maybe_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_parse_maybe_bool(value);
2453 if (*dest == -1)
2454 return -1;
2455 return 0;
2456 } else
2457 return 1;
2460 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2462 const char *value;
2463 if (!git_configset_get_value(set, key, &value, NULL))
2464 return git_config_pathname(dest, key, value);
2465 else
2466 return 1;
2469 /* Functions use to read configuration from a repository */
2470 static void repo_read_config(struct repository *repo)
2472 struct config_options opts = { 0 };
2474 opts.respect_includes = 1;
2475 opts.commondir = repo->commondir;
2476 opts.git_dir = repo->gitdir;
2478 if (!repo->config)
2479 CALLOC_ARRAY(repo->config, 1);
2480 else
2481 git_configset_clear(repo->config);
2483 git_configset_init(repo->config);
2484 if (config_with_options(config_set_callback, repo->config, NULL,
2485 repo, &opts) < 0)
2487 * config_with_options() normally returns only
2488 * zero, as most errors are fatal, and
2489 * non-fatal potential errors are guarded by "if"
2490 * statements that are entered only when no error is
2491 * possible.
2493 * If we ever encounter a non-fatal error, it means
2494 * something went really wrong and we should stop
2495 * immediately.
2497 die(_("unknown error occurred while reading the configuration files"));
2500 static void git_config_check_init(struct repository *repo)
2502 if (repo->config && repo->config->hash_initialized)
2503 return;
2504 repo_read_config(repo);
2507 static void repo_config_clear(struct repository *repo)
2509 if (!repo->config || !repo->config->hash_initialized)
2510 return;
2511 git_configset_clear(repo->config);
2514 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2516 git_config_check_init(repo);
2517 configset_iter(repo->config, fn, data);
2520 int repo_config_get(struct repository *repo, const char *key)
2522 git_config_check_init(repo);
2523 return git_configset_get(repo->config, key);
2526 int repo_config_get_value(struct repository *repo,
2527 const char *key, const char **value)
2529 git_config_check_init(repo);
2530 return git_configset_get_value(repo->config, key, value, NULL);
2533 int repo_config_get_value_multi(struct repository *repo, const char *key,
2534 const struct string_list **dest)
2536 git_config_check_init(repo);
2537 return git_configset_get_value_multi(repo->config, key, dest);
2540 int repo_config_get_string_multi(struct repository *repo, const char *key,
2541 const struct string_list **dest)
2543 git_config_check_init(repo);
2544 return git_configset_get_string_multi(repo->config, key, dest);
2547 int repo_config_get_string(struct repository *repo,
2548 const char *key, char **dest)
2550 int ret;
2551 git_config_check_init(repo);
2552 ret = git_configset_get_string(repo->config, key, dest);
2553 if (ret < 0)
2554 git_die_config(key, NULL);
2555 return ret;
2558 int repo_config_get_string_tmp(struct repository *repo,
2559 const char *key, const char **dest)
2561 int ret;
2562 git_config_check_init(repo);
2563 ret = git_configset_get_string_tmp(repo->config, key, dest);
2564 if (ret < 0)
2565 git_die_config(key, NULL);
2566 return ret;
2569 int repo_config_get_int(struct repository *repo,
2570 const char *key, int *dest)
2572 git_config_check_init(repo);
2573 return git_configset_get_int(repo->config, key, dest);
2576 int repo_config_get_ulong(struct repository *repo,
2577 const char *key, unsigned long *dest)
2579 git_config_check_init(repo);
2580 return git_configset_get_ulong(repo->config, key, dest);
2583 int repo_config_get_bool(struct repository *repo,
2584 const char *key, int *dest)
2586 git_config_check_init(repo);
2587 return git_configset_get_bool(repo->config, key, dest);
2590 int repo_config_get_bool_or_int(struct repository *repo,
2591 const char *key, int *is_bool, int *dest)
2593 git_config_check_init(repo);
2594 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2597 int repo_config_get_maybe_bool(struct repository *repo,
2598 const char *key, int *dest)
2600 git_config_check_init(repo);
2601 return git_configset_get_maybe_bool(repo->config, key, dest);
2604 int repo_config_get_pathname(struct repository *repo,
2605 const char *key, const char **dest)
2607 int ret;
2608 git_config_check_init(repo);
2609 ret = git_configset_get_pathname(repo->config, key, dest);
2610 if (ret < 0)
2611 git_die_config(key, NULL);
2612 return ret;
2615 /* Read values into protected_config. */
2616 static void read_protected_config(void)
2618 struct config_options opts = {
2619 .respect_includes = 1,
2620 .ignore_repo = 1,
2621 .ignore_worktree = 1,
2622 .system_gently = 1,
2625 git_configset_init(&protected_config);
2626 config_with_options(config_set_callback, &protected_config, NULL,
2627 NULL, &opts);
2630 void git_protected_config(config_fn_t fn, void *data)
2632 if (!protected_config.hash_initialized)
2633 read_protected_config();
2634 configset_iter(&protected_config, fn, data);
2637 /* Functions used historically to read configuration from 'the_repository' */
2638 void git_config(config_fn_t fn, void *data)
2640 repo_config(the_repository, fn, data);
2643 void git_config_clear(void)
2645 repo_config_clear(the_repository);
2648 int git_config_get(const char *key)
2650 return repo_config_get(the_repository, key);
2653 int git_config_get_value(const char *key, const char **value)
2655 return repo_config_get_value(the_repository, key, value);
2658 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2660 return repo_config_get_value_multi(the_repository, key, dest);
2663 int git_config_get_string_multi(const char *key,
2664 const struct string_list **dest)
2666 return repo_config_get_string_multi(the_repository, key, dest);
2669 int git_config_get_string(const char *key, char **dest)
2671 return repo_config_get_string(the_repository, key, dest);
2674 int git_config_get_string_tmp(const char *key, const char **dest)
2676 return repo_config_get_string_tmp(the_repository, key, dest);
2679 int git_config_get_int(const char *key, int *dest)
2681 return repo_config_get_int(the_repository, key, dest);
2684 int git_config_get_ulong(const char *key, unsigned long *dest)
2686 return repo_config_get_ulong(the_repository, key, dest);
2689 int git_config_get_bool(const char *key, int *dest)
2691 return repo_config_get_bool(the_repository, key, dest);
2694 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2696 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2699 int git_config_get_maybe_bool(const char *key, int *dest)
2701 return repo_config_get_maybe_bool(the_repository, key, dest);
2704 int git_config_get_pathname(const char *key, const char **dest)
2706 return repo_config_get_pathname(the_repository, key, dest);
2709 int git_config_get_expiry(const char *key, const char **output)
2711 int ret = git_config_get_string(key, (char **)output);
2712 if (ret)
2713 return ret;
2714 if (strcmp(*output, "now")) {
2715 timestamp_t now = approxidate("now");
2716 if (approxidate(*output) >= now)
2717 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2719 return ret;
2722 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2724 const char *expiry_string;
2725 intmax_t days;
2726 timestamp_t when;
2728 if (git_config_get_string_tmp(key, &expiry_string))
2729 return 1; /* no such thing */
2731 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2732 const int scale = 86400;
2733 *expiry = now - days * scale;
2734 return 0;
2737 if (!parse_expiry_date(expiry_string, &when)) {
2738 *expiry = when;
2739 return 0;
2741 return -1; /* thing exists but cannot be parsed */
2744 int git_config_get_split_index(void)
2746 int val;
2748 if (!git_config_get_maybe_bool("core.splitindex", &val))
2749 return val;
2751 return -1; /* default value */
2754 int git_config_get_max_percent_split_change(void)
2756 int val = -1;
2758 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2759 if (0 <= val && val <= 100)
2760 return val;
2762 return error(_("splitIndex.maxPercentChange value '%d' "
2763 "should be between 0 and 100"), val);
2766 return -1; /* default value */
2769 int git_config_get_index_threads(int *dest)
2771 int is_bool, val;
2773 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2774 if (val) {
2775 *dest = val;
2776 return 0;
2779 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2780 if (is_bool)
2781 *dest = val ? 0 : 1;
2782 else
2783 *dest = val;
2784 return 0;
2787 return 1;
2790 NORETURN
2791 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2793 if (!filename)
2794 die(_("unable to parse '%s' from command-line config"), key);
2795 else
2796 die(_("bad config variable '%s' in file '%s' at line %d"),
2797 key, filename, linenr);
2800 NORETURN __attribute__((format(printf, 2, 3)))
2801 void git_die_config(const char *key, const char *err, ...)
2803 const struct string_list *values;
2804 struct key_value_info *kv_info;
2805 report_fn error_fn = get_error_routine();
2807 if (err) {
2808 va_list params;
2809 va_start(params, err);
2810 error_fn(err, params);
2811 va_end(params);
2813 if (git_config_get_value_multi(key, &values))
2814 BUG("for key '%s' we must have a value to report on", key);
2815 kv_info = values->items[values->nr - 1].util;
2816 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2820 * Find all the stuff for git_config_set() below.
2823 struct config_store_data {
2824 size_t baselen;
2825 char *key;
2826 int do_not_match;
2827 const char *fixed_value;
2828 regex_t *value_pattern;
2829 int multi_replace;
2830 struct {
2831 size_t begin, end;
2832 enum config_event_t type;
2833 int is_keys_section;
2834 } *parsed;
2835 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2836 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2838 #define CONFIG_STORE_INIT { 0 }
2840 static void config_store_data_clear(struct config_store_data *store)
2842 free(store->key);
2843 if (store->value_pattern != NULL &&
2844 store->value_pattern != CONFIG_REGEX_NONE) {
2845 regfree(store->value_pattern);
2846 free(store->value_pattern);
2848 free(store->parsed);
2849 free(store->seen);
2850 memset(store, 0, sizeof(*store));
2853 static int matches(const char *key, const char *value,
2854 const struct config_store_data *store)
2856 if (strcmp(key, store->key))
2857 return 0; /* not ours */
2858 if (store->fixed_value)
2859 return !strcmp(store->fixed_value, value);
2860 if (!store->value_pattern)
2861 return 1; /* always matches */
2862 if (store->value_pattern == CONFIG_REGEX_NONE)
2863 return 0; /* never matches */
2865 return store->do_not_match ^
2866 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2869 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2870 struct config_source *cs, void *data)
2872 struct config_store_data *store = data;
2874 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2875 store->parsed[store->parsed_nr].begin = begin;
2876 store->parsed[store->parsed_nr].end = end;
2877 store->parsed[store->parsed_nr].type = type;
2879 if (type == CONFIG_EVENT_SECTION) {
2880 int (*cmpfn)(const char *, const char *, size_t);
2882 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2883 return error(_("invalid section name '%s'"), cs->var.buf);
2885 if (cs->subsection_case_sensitive)
2886 cmpfn = strncasecmp;
2887 else
2888 cmpfn = strncmp;
2890 /* Is this the section we were looking for? */
2891 store->is_keys_section =
2892 store->parsed[store->parsed_nr].is_keys_section =
2893 cs->var.len - 1 == store->baselen &&
2894 !cmpfn(cs->var.buf, store->key, store->baselen);
2895 if (store->is_keys_section) {
2896 store->section_seen = 1;
2897 ALLOC_GROW(store->seen, store->seen_nr + 1,
2898 store->seen_alloc);
2899 store->seen[store->seen_nr] = store->parsed_nr;
2903 store->parsed_nr++;
2905 return 0;
2908 static int store_aux(const char *key, const char *value,
2909 const struct config_context *ctx UNUSED, void *cb)
2911 struct config_store_data *store = cb;
2913 if (store->key_seen) {
2914 if (matches(key, value, store)) {
2915 if (store->seen_nr == 1 && store->multi_replace == 0) {
2916 warning(_("%s has multiple values"), key);
2919 ALLOC_GROW(store->seen, store->seen_nr + 1,
2920 store->seen_alloc);
2922 store->seen[store->seen_nr] = store->parsed_nr;
2923 store->seen_nr++;
2925 } else if (store->is_keys_section) {
2927 * Do not increment matches yet: this may not be a match, but we
2928 * are in the desired section.
2930 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2931 store->seen[store->seen_nr] = store->parsed_nr;
2932 store->section_seen = 1;
2934 if (matches(key, value, store)) {
2935 store->seen_nr++;
2936 store->key_seen = 1;
2940 return 0;
2943 static int write_error(const char *filename)
2945 error(_("failed to write new configuration file %s"), filename);
2947 /* Same error code as "failed to rename". */
2948 return 4;
2951 static struct strbuf store_create_section(const char *key,
2952 const struct config_store_data *store)
2954 const char *dot;
2955 size_t i;
2956 struct strbuf sb = STRBUF_INIT;
2958 dot = memchr(key, '.', store->baselen);
2959 if (dot) {
2960 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2961 for (i = dot - key + 1; i < store->baselen; i++) {
2962 if (key[i] == '"' || key[i] == '\\')
2963 strbuf_addch(&sb, '\\');
2964 strbuf_addch(&sb, key[i]);
2966 strbuf_addstr(&sb, "\"]\n");
2967 } else {
2968 strbuf_addch(&sb, '[');
2969 strbuf_add(&sb, key, store->baselen);
2970 strbuf_addstr(&sb, "]\n");
2973 return sb;
2976 static ssize_t write_section(int fd, const char *key,
2977 const struct config_store_data *store)
2979 struct strbuf sb = store_create_section(key, store);
2980 ssize_t ret;
2982 ret = write_in_full(fd, sb.buf, sb.len);
2983 strbuf_release(&sb);
2985 return ret;
2988 static ssize_t write_pair(int fd, const char *key, const char *value,
2989 const struct config_store_data *store)
2991 int i;
2992 ssize_t ret;
2993 const char *quote = "";
2994 struct strbuf sb = STRBUF_INIT;
2997 * Check to see if the value needs to be surrounded with a dq pair.
2998 * Note that problematic characters are always backslash-quoted; this
2999 * check is about not losing leading or trailing SP and strings that
3000 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3001 * configuration parser.
3003 if (value[0] == ' ')
3004 quote = "\"";
3005 for (i = 0; value[i]; i++)
3006 if (value[i] == ';' || value[i] == '#')
3007 quote = "\"";
3008 if (i && value[i - 1] == ' ')
3009 quote = "\"";
3011 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3013 for (i = 0; value[i]; i++)
3014 switch (value[i]) {
3015 case '\n':
3016 strbuf_addstr(&sb, "\\n");
3017 break;
3018 case '\t':
3019 strbuf_addstr(&sb, "\\t");
3020 break;
3021 case '"':
3022 case '\\':
3023 strbuf_addch(&sb, '\\');
3024 /* fallthrough */
3025 default:
3026 strbuf_addch(&sb, value[i]);
3027 break;
3029 strbuf_addf(&sb, "%s\n", quote);
3031 ret = write_in_full(fd, sb.buf, sb.len);
3032 strbuf_release(&sb);
3034 return ret;
3038 * If we are about to unset the last key(s) in a section, and if there are
3039 * no comments surrounding (or included in) the section, we will want to
3040 * extend begin/end to remove the entire section.
3042 * Note: the parameter `seen_ptr` points to the index into the store.seen
3043 * array. * This index may be incremented if a section has more than one
3044 * entry (which all are to be removed).
3046 static void maybe_remove_section(struct config_store_data *store,
3047 size_t *begin_offset, size_t *end_offset,
3048 int *seen_ptr)
3050 size_t begin;
3051 int i, seen, section_seen = 0;
3054 * First, ensure that this is the first key, and that there are no
3055 * comments before the entry nor before the section header.
3057 seen = *seen_ptr;
3058 for (i = store->seen[seen]; i > 0; i--) {
3059 enum config_event_t type = store->parsed[i - 1].type;
3061 if (type == CONFIG_EVENT_COMMENT)
3062 /* There is a comment before this entry or section */
3063 return;
3064 if (type == CONFIG_EVENT_ENTRY) {
3065 if (!section_seen)
3066 /* This is not the section's first entry. */
3067 return;
3068 /* We encountered no comment before the section. */
3069 break;
3071 if (type == CONFIG_EVENT_SECTION) {
3072 if (!store->parsed[i - 1].is_keys_section)
3073 break;
3074 section_seen = 1;
3077 begin = store->parsed[i].begin;
3080 * Next, make sure that we are removing the last key(s) in the section,
3081 * and that there are no comments that are possibly about the current
3082 * section.
3084 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3085 enum config_event_t type = store->parsed[i].type;
3087 if (type == CONFIG_EVENT_COMMENT)
3088 return;
3089 if (type == CONFIG_EVENT_SECTION) {
3090 if (store->parsed[i].is_keys_section)
3091 continue;
3092 break;
3094 if (type == CONFIG_EVENT_ENTRY) {
3095 if (++seen < store->seen_nr &&
3096 i == store->seen[seen])
3097 /* We want to remove this entry, too */
3098 continue;
3099 /* There is another entry in this section. */
3100 return;
3105 * We are really removing the last entry/entries from this section, and
3106 * there are no enclosed or surrounding comments. Remove the entire,
3107 * now-empty section.
3109 *seen_ptr = seen;
3110 *begin_offset = begin;
3111 if (i < store->parsed_nr)
3112 *end_offset = store->parsed[i].begin;
3113 else
3114 *end_offset = store->parsed[store->parsed_nr - 1].end;
3117 int git_config_set_in_file_gently(const char *config_filename,
3118 const char *key, const char *value)
3120 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3123 void git_config_set_in_file(const char *config_filename,
3124 const char *key, const char *value)
3126 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3129 int git_config_set_gently(const char *key, const char *value)
3131 return git_config_set_multivar_gently(key, value, NULL, 0);
3134 int repo_config_set_worktree_gently(struct repository *r,
3135 const char *key, const char *value)
3137 /* Only use worktree-specific config if it is already enabled. */
3138 if (r->repository_format_worktree_config) {
3139 char *file = repo_git_path(r, "config.worktree");
3140 int ret = git_config_set_multivar_in_file_gently(
3141 file, key, value, NULL, 0);
3142 free(file);
3143 return ret;
3145 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3148 void git_config_set(const char *key, const char *value)
3150 git_config_set_multivar(key, value, NULL, 0);
3152 trace2_cmd_set_config(key, value);
3156 * If value==NULL, unset in (remove from) config,
3157 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3158 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3159 * (only add a new one)
3160 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3161 * key/values are removed before a single new pair is written. If the
3162 * flag is not present, then replace only the first match.
3164 * Returns 0 on success.
3166 * This function does this:
3168 * - it locks the config file by creating ".git/config.lock"
3170 * - it then parses the config using store_aux() as validator to find
3171 * the position on the key/value pair to replace. If it is to be unset,
3172 * it must be found exactly once.
3174 * - the config file is mmap()ed and the part before the match (if any) is
3175 * written to the lock file, then the changed part and the rest.
3177 * - the config file is removed and the lock file rename()d to it.
3180 int git_config_set_multivar_in_file_gently(const char *config_filename,
3181 const char *key, const char *value,
3182 const char *value_pattern,
3183 unsigned flags)
3185 int fd = -1, in_fd = -1;
3186 int ret;
3187 struct lock_file lock = LOCK_INIT;
3188 char *filename_buf = NULL;
3189 char *contents = NULL;
3190 size_t contents_sz;
3191 struct config_store_data store = CONFIG_STORE_INIT;
3193 /* parse-key returns negative; flip the sign to feed exit(3) */
3194 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3195 if (ret)
3196 goto out_free;
3198 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3200 if (!config_filename)
3201 config_filename = filename_buf = git_pathdup("config");
3204 * The lock serves a purpose in addition to locking: the new
3205 * contents of .git/config will be written into it.
3207 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3208 if (fd < 0) {
3209 error_errno(_("could not lock config file %s"), config_filename);
3210 ret = CONFIG_NO_LOCK;
3211 goto out_free;
3215 * If .git/config does not exist yet, write a minimal version.
3217 in_fd = open(config_filename, O_RDONLY);
3218 if ( in_fd < 0 ) {
3219 if ( ENOENT != errno ) {
3220 error_errno(_("opening %s"), config_filename);
3221 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3222 goto out_free;
3224 /* if nothing to unset, error out */
3225 if (!value) {
3226 ret = CONFIG_NOTHING_SET;
3227 goto out_free;
3230 free(store.key);
3231 store.key = xstrdup(key);
3232 if (write_section(fd, key, &store) < 0 ||
3233 write_pair(fd, key, value, &store) < 0)
3234 goto write_err_out;
3235 } else {
3236 struct stat st;
3237 size_t copy_begin, copy_end;
3238 int i, new_line = 0;
3239 struct config_options opts;
3241 if (!value_pattern)
3242 store.value_pattern = NULL;
3243 else if (value_pattern == CONFIG_REGEX_NONE)
3244 store.value_pattern = CONFIG_REGEX_NONE;
3245 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3246 store.fixed_value = value_pattern;
3247 else {
3248 if (value_pattern[0] == '!') {
3249 store.do_not_match = 1;
3250 value_pattern++;
3251 } else
3252 store.do_not_match = 0;
3254 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3255 if (regcomp(store.value_pattern, value_pattern,
3256 REG_EXTENDED)) {
3257 error(_("invalid pattern: %s"), value_pattern);
3258 FREE_AND_NULL(store.value_pattern);
3259 ret = CONFIG_INVALID_PATTERN;
3260 goto out_free;
3264 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3265 store.parsed[0].end = 0;
3267 memset(&opts, 0, sizeof(opts));
3268 opts.event_fn = store_aux_event;
3269 opts.event_fn_data = &store;
3272 * After this, store.parsed will contain offsets of all the
3273 * parsed elements, and store.seen will contain a list of
3274 * matches, as indices into store.parsed.
3276 * As a side effect, we make sure to transform only a valid
3277 * existing config file.
3279 if (git_config_from_file_with_options(store_aux,
3280 config_filename,
3281 &store, CONFIG_SCOPE_UNKNOWN,
3282 &opts)) {
3283 error(_("invalid config file %s"), config_filename);
3284 ret = CONFIG_INVALID_FILE;
3285 goto out_free;
3288 /* if nothing to unset, or too many matches, error out */
3289 if ((store.seen_nr == 0 && value == NULL) ||
3290 (store.seen_nr > 1 && !store.multi_replace)) {
3291 ret = CONFIG_NOTHING_SET;
3292 goto out_free;
3295 if (fstat(in_fd, &st) == -1) {
3296 error_errno(_("fstat on %s failed"), config_filename);
3297 ret = CONFIG_INVALID_FILE;
3298 goto out_free;
3301 contents_sz = xsize_t(st.st_size);
3302 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3303 MAP_PRIVATE, in_fd, 0);
3304 if (contents == MAP_FAILED) {
3305 if (errno == ENODEV && S_ISDIR(st.st_mode))
3306 errno = EISDIR;
3307 error_errno(_("unable to mmap '%s'%s"),
3308 config_filename, mmap_os_err());
3309 ret = CONFIG_INVALID_FILE;
3310 contents = NULL;
3311 goto out_free;
3313 close(in_fd);
3314 in_fd = -1;
3316 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3317 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3318 ret = CONFIG_NO_WRITE;
3319 goto out_free;
3322 if (store.seen_nr == 0) {
3323 if (!store.seen_alloc) {
3324 /* Did not see key nor section */
3325 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3326 store.seen[0] = store.parsed_nr
3327 - !!store.parsed_nr;
3329 store.seen_nr = 1;
3332 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3333 size_t replace_end;
3334 int j = store.seen[i];
3336 new_line = 0;
3337 if (!store.key_seen) {
3338 copy_end = store.parsed[j].end;
3339 /* include '\n' when copying section header */
3340 if (copy_end > 0 && copy_end < contents_sz &&
3341 contents[copy_end - 1] != '\n' &&
3342 contents[copy_end] == '\n')
3343 copy_end++;
3344 replace_end = copy_end;
3345 } else {
3346 replace_end = store.parsed[j].end;
3347 copy_end = store.parsed[j].begin;
3348 if (!value)
3349 maybe_remove_section(&store,
3350 &copy_end,
3351 &replace_end, &i);
3353 * Swallow preceding white-space on the same
3354 * line.
3356 while (copy_end > 0 ) {
3357 char c = contents[copy_end - 1];
3359 if (isspace(c) && c != '\n')
3360 copy_end--;
3361 else
3362 break;
3366 if (copy_end > 0 && contents[copy_end-1] != '\n')
3367 new_line = 1;
3369 /* write the first part of the config */
3370 if (copy_end > copy_begin) {
3371 if (write_in_full(fd, contents + copy_begin,
3372 copy_end - copy_begin) < 0)
3373 goto write_err_out;
3374 if (new_line &&
3375 write_str_in_full(fd, "\n") < 0)
3376 goto write_err_out;
3378 copy_begin = replace_end;
3381 /* write the pair (value == NULL means unset) */
3382 if (value) {
3383 if (!store.section_seen) {
3384 if (write_section(fd, key, &store) < 0)
3385 goto write_err_out;
3387 if (write_pair(fd, key, value, &store) < 0)
3388 goto write_err_out;
3391 /* write the rest of the config */
3392 if (copy_begin < contents_sz)
3393 if (write_in_full(fd, contents + copy_begin,
3394 contents_sz - copy_begin) < 0)
3395 goto write_err_out;
3397 munmap(contents, contents_sz);
3398 contents = NULL;
3401 if (commit_lock_file(&lock) < 0) {
3402 error_errno(_("could not write config file %s"), config_filename);
3403 ret = CONFIG_NO_WRITE;
3404 goto out_free;
3407 ret = 0;
3409 /* Invalidate the config cache */
3410 git_config_clear();
3412 out_free:
3413 rollback_lock_file(&lock);
3414 free(filename_buf);
3415 if (contents)
3416 munmap(contents, contents_sz);
3417 if (in_fd >= 0)
3418 close(in_fd);
3419 config_store_data_clear(&store);
3420 return ret;
3422 write_err_out:
3423 ret = write_error(get_lock_file_path(&lock));
3424 goto out_free;
3428 void git_config_set_multivar_in_file(const char *config_filename,
3429 const char *key, const char *value,
3430 const char *value_pattern, unsigned flags)
3432 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3433 value_pattern, flags))
3434 return;
3435 if (value)
3436 die(_("could not set '%s' to '%s'"), key, value);
3437 else
3438 die(_("could not unset '%s'"), key);
3441 int git_config_set_multivar_gently(const char *key, const char *value,
3442 const char *value_pattern, unsigned flags)
3444 return repo_config_set_multivar_gently(the_repository, key, value,
3445 value_pattern, flags);
3448 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3449 const char *value,
3450 const char *value_pattern, unsigned flags)
3452 char *file = repo_git_path(r, "config");
3453 int res = git_config_set_multivar_in_file_gently(file,
3454 key, value,
3455 value_pattern,
3456 flags);
3457 free(file);
3458 return res;
3461 void git_config_set_multivar(const char *key, const char *value,
3462 const char *value_pattern, unsigned flags)
3464 git_config_set_multivar_in_file(git_path("config"),
3465 key, value, value_pattern,
3466 flags);
3469 static size_t section_name_match (const char *buf, const char *name)
3471 size_t i = 0, j = 0;
3472 int dot = 0;
3473 if (buf[i] != '[')
3474 return 0;
3475 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3476 if (!dot && isspace(buf[i])) {
3477 dot = 1;
3478 if (name[j++] != '.')
3479 break;
3480 for (i++; isspace(buf[i]); i++)
3481 ; /* do nothing */
3482 if (buf[i] != '"')
3483 break;
3484 continue;
3486 if (buf[i] == '\\' && dot)
3487 i++;
3488 else if (buf[i] == '"' && dot) {
3489 for (i++; isspace(buf[i]); i++)
3490 ; /* do_nothing */
3491 break;
3493 if (buf[i] != name[j++])
3494 break;
3496 if (buf[i] == ']' && name[j] == 0) {
3498 * We match, now just find the right length offset by
3499 * gobbling up any whitespace after it, as well
3501 i++;
3502 for (; buf[i] && isspace(buf[i]); i++)
3503 ; /* do nothing */
3504 return i;
3506 return 0;
3509 static int section_name_is_ok(const char *name)
3511 /* Empty section names are bogus. */
3512 if (!*name)
3513 return 0;
3516 * Before a dot, we must be alphanumeric or dash. After the first dot,
3517 * anything goes, so we can stop checking.
3519 for (; *name && *name != '.'; name++)
3520 if (*name != '-' && !isalnum(*name))
3521 return 0;
3522 return 1;
3525 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3527 /* if new_name == NULL, the section is removed instead */
3528 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3529 const char *old_name,
3530 const char *new_name, int copy)
3532 int ret = 0, remove = 0;
3533 char *filename_buf = NULL;
3534 struct lock_file lock = LOCK_INIT;
3535 int out_fd;
3536 struct strbuf buf = STRBUF_INIT;
3537 FILE *config_file = NULL;
3538 struct stat st;
3539 struct strbuf copystr = STRBUF_INIT;
3540 struct config_store_data store;
3541 uint32_t line_nr = 0;
3543 memset(&store, 0, sizeof(store));
3545 if (new_name && !section_name_is_ok(new_name)) {
3546 ret = error(_("invalid section name: %s"), new_name);
3547 goto out_no_rollback;
3550 if (!config_filename)
3551 config_filename = filename_buf = git_pathdup("config");
3553 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3554 if (out_fd < 0) {
3555 ret = error(_("could not lock config file %s"), config_filename);
3556 goto out;
3559 if (!(config_file = fopen(config_filename, "rb"))) {
3560 ret = warn_on_fopen_errors(config_filename);
3561 if (ret)
3562 goto out;
3563 /* no config file means nothing to rename, no error */
3564 goto commit_and_out;
3567 if (fstat(fileno(config_file), &st) == -1) {
3568 ret = error_errno(_("fstat on %s failed"), config_filename);
3569 goto out;
3572 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3573 ret = error_errno(_("chmod on %s failed"),
3574 get_lock_file_path(&lock));
3575 goto out;
3578 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3579 size_t i, length;
3580 int is_section = 0;
3581 char *output = buf.buf;
3583 line_nr++;
3585 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3586 ret = error(_("refusing to work with overly long line "
3587 "in '%s' on line %"PRIuMAX),
3588 config_filename, (uintmax_t)line_nr);
3589 goto out;
3592 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3593 ; /* do nothing */
3594 if (buf.buf[i] == '[') {
3595 /* it's a section */
3596 size_t offset;
3597 is_section = 1;
3600 * When encountering a new section under -c we
3601 * need to flush out any section we're already
3602 * coping and begin anew. There might be
3603 * multiple [branch "$name"] sections.
3605 if (copystr.len > 0) {
3606 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3607 ret = write_error(get_lock_file_path(&lock));
3608 goto out;
3610 strbuf_reset(&copystr);
3613 offset = section_name_match(&buf.buf[i], old_name);
3614 if (offset > 0) {
3615 ret++;
3616 if (!new_name) {
3617 remove = 1;
3618 continue;
3620 store.baselen = strlen(new_name);
3621 if (!copy) {
3622 if (write_section(out_fd, new_name, &store) < 0) {
3623 ret = write_error(get_lock_file_path(&lock));
3624 goto out;
3627 * We wrote out the new section, with
3628 * a newline, now skip the old
3629 * section's length
3631 output += offset + i;
3632 if (strlen(output) > 0) {
3634 * More content means there's
3635 * a declaration to put on the
3636 * next line; indent with a
3637 * tab
3639 output -= 1;
3640 output[0] = '\t';
3642 } else {
3643 strbuf_release(&copystr);
3644 copystr = store_create_section(new_name, &store);
3647 remove = 0;
3649 if (remove)
3650 continue;
3651 length = strlen(output);
3653 if (!is_section && copystr.len > 0) {
3654 strbuf_add(&copystr, output, length);
3657 if (write_in_full(out_fd, output, length) < 0) {
3658 ret = write_error(get_lock_file_path(&lock));
3659 goto out;
3664 * Copy a trailing section at the end of the config, won't be
3665 * flushed by the usual "flush because we have a new section
3666 * logic in the loop above.
3668 if (copystr.len > 0) {
3669 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3670 ret = write_error(get_lock_file_path(&lock));
3671 goto out;
3673 strbuf_reset(&copystr);
3676 fclose(config_file);
3677 config_file = NULL;
3678 commit_and_out:
3679 if (commit_lock_file(&lock) < 0)
3680 ret = error_errno(_("could not write config file %s"),
3681 config_filename);
3682 out:
3683 if (config_file)
3684 fclose(config_file);
3685 rollback_lock_file(&lock);
3686 out_no_rollback:
3687 free(filename_buf);
3688 config_store_data_clear(&store);
3689 strbuf_release(&buf);
3690 strbuf_release(&copystr);
3691 return ret;
3694 int git_config_rename_section_in_file(const char *config_filename,
3695 const char *old_name, const char *new_name)
3697 return git_config_copy_or_rename_section_in_file(config_filename,
3698 old_name, new_name, 0);
3701 int git_config_rename_section(const char *old_name, const char *new_name)
3703 return git_config_rename_section_in_file(NULL, old_name, new_name);
3706 int git_config_copy_section_in_file(const char *config_filename,
3707 const char *old_name, const char *new_name)
3709 return git_config_copy_or_rename_section_in_file(config_filename,
3710 old_name, new_name, 1);
3713 int git_config_copy_section(const char *old_name, const char *new_name)
3715 return git_config_copy_section_in_file(NULL, old_name, new_name);
3719 * Call this to report error for your variable that should not
3720 * get a boolean value (i.e. "[my] var" means "true").
3722 #undef config_error_nonbool
3723 int config_error_nonbool(const char *var)
3725 return error(_("missing value for '%s'"), var);
3728 int parse_config_key(const char *var,
3729 const char *section,
3730 const char **subsection, size_t *subsection_len,
3731 const char **key)
3733 const char *dot;
3735 /* Does it start with "section." ? */
3736 if (!skip_prefix(var, section, &var) || *var != '.')
3737 return -1;
3740 * Find the key; we don't know yet if we have a subsection, but we must
3741 * parse backwards from the end, since the subsection may have dots in
3742 * it, too.
3744 dot = strrchr(var, '.');
3745 *key = dot + 1;
3747 /* Did we have a subsection at all? */
3748 if (dot == var) {
3749 if (subsection) {
3750 *subsection = NULL;
3751 *subsection_len = 0;
3754 else {
3755 if (!subsection)
3756 return -1;
3757 *subsection = var + 1;
3758 *subsection_len = dot - *subsection;
3761 return 0;
3764 const char *config_origin_type_name(enum config_origin_type type)
3766 switch (type) {
3767 case CONFIG_ORIGIN_BLOB:
3768 return "blob";
3769 case CONFIG_ORIGIN_FILE:
3770 return "file";
3771 case CONFIG_ORIGIN_STDIN:
3772 return "standard input";
3773 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3774 return "submodule-blob";
3775 case CONFIG_ORIGIN_CMDLINE:
3776 return "command line";
3777 default:
3778 BUG("unknown config origin type");
3782 const char *config_scope_name(enum config_scope scope)
3784 switch (scope) {
3785 case CONFIG_SCOPE_SYSTEM:
3786 return "system";
3787 case CONFIG_SCOPE_GLOBAL:
3788 return "global";
3789 case CONFIG_SCOPE_LOCAL:
3790 return "local";
3791 case CONFIG_SCOPE_WORKTREE:
3792 return "worktree";
3793 case CONFIG_SCOPE_COMMAND:
3794 return "command";
3795 case CONFIG_SCOPE_SUBMODULE:
3796 return "submodule";
3797 default:
3798 return "unknown";
3802 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3804 int i;
3806 for (i = 0; i < nr_mapping; i++) {
3807 const char *name = mapping[i];
3809 if (name && !strcasecmp(var, name))
3810 return i;
3812 return -1;