compat/fsmonitor: fix socket path in networked SHA256 repos
[git/gitster.git] / config.c
blob7951029644836c09bdf704577b60b0054d686d7b
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
9 #define USE_THE_REPOSITORY_VARIABLE
11 #include "git-compat-util.h"
12 #include "abspath.h"
13 #include "advice.h"
14 #include "date.h"
15 #include "branch.h"
16 #include "config.h"
17 #include "parse.h"
18 #include "convert.h"
19 #include "environment.h"
20 #include "gettext.h"
21 #include "ident.h"
22 #include "repository.h"
23 #include "lockfile.h"
24 #include "mailmap.h"
25 #include "attr.h"
26 #include "exec-cmd.h"
27 #include "strbuf.h"
28 #include "quote.h"
29 #include "hashmap.h"
30 #include "string-list.h"
31 #include "object-name.h"
32 #include "object-store-ll.h"
33 #include "pager.h"
34 #include "path.h"
35 #include "utf8.h"
36 #include "color.h"
37 #include "refs.h"
38 #include "setup.h"
39 #include "strvec.h"
40 #include "trace2.h"
41 #include "wildmatch.h"
42 #include "ws.h"
43 #include "write-or-die.h"
45 struct config_source {
46 struct config_source *prev;
47 union {
48 FILE *file;
49 struct config_buf {
50 const char *buf;
51 size_t len;
52 size_t pos;
53 } buf;
54 } u;
55 enum config_origin_type origin_type;
56 const char *name;
57 const char *path;
58 enum config_error_action default_error_action;
59 int linenr;
60 int eof;
61 size_t total_len;
62 struct strbuf value;
63 struct strbuf var;
64 unsigned subsection_case_sensitive : 1;
66 int (*do_fgetc)(struct config_source *c);
67 int (*do_ungetc)(int c, struct config_source *conf);
68 long (*do_ftell)(struct config_source *c);
70 #define CONFIG_SOURCE_INIT { 0 }
72 static int pack_compression_seen;
73 static int zlib_compression_seen;
76 * Config that comes from trusted scopes, namely:
77 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
78 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
79 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
81 * This is declared here for code cleanliness, but unlike the other
82 * static variables, this does not hold config parser state.
84 static struct config_set protected_config;
86 static int config_file_fgetc(struct config_source *conf)
88 return getc_unlocked(conf->u.file);
91 static int config_file_ungetc(int c, struct config_source *conf)
93 return ungetc(c, conf->u.file);
96 static long config_file_ftell(struct config_source *conf)
98 return ftell(conf->u.file);
101 static int config_buf_fgetc(struct config_source *conf)
103 if (conf->u.buf.pos < conf->u.buf.len)
104 return conf->u.buf.buf[conf->u.buf.pos++];
106 return EOF;
109 static int config_buf_ungetc(int c, struct config_source *conf)
111 if (conf->u.buf.pos > 0) {
112 conf->u.buf.pos--;
113 if (conf->u.buf.buf[conf->u.buf.pos] != c)
114 BUG("config_buf can only ungetc the same character");
115 return c;
118 return EOF;
121 static long config_buf_ftell(struct config_source *conf)
123 return conf->u.buf.pos;
126 struct config_include_data {
127 int depth;
128 config_fn_t fn;
129 void *data;
130 const struct config_options *opts;
131 const struct git_config_source *config_source;
132 struct repository *repo;
135 * All remote URLs discovered when reading all config files.
137 struct string_list *remote_urls;
139 #define CONFIG_INCLUDE_INIT { 0 }
141 static int git_config_include(const char *var, const char *value,
142 const struct config_context *ctx, void *data);
144 #define MAX_INCLUDE_DEPTH 10
145 static const char include_depth_advice[] = N_(
146 "exceeded maximum include depth (%d) while including\n"
147 " %s\n"
148 "from\n"
149 " %s\n"
150 "This might be due to circular includes.");
151 static int handle_path_include(const struct key_value_info *kvi,
152 const char *path,
153 struct config_include_data *inc)
155 int ret = 0;
156 struct strbuf buf = STRBUF_INIT;
157 char *expanded;
159 if (!path)
160 return config_error_nonbool("include.path");
162 expanded = interpolate_path(path, 0);
163 if (!expanded)
164 return error(_("could not expand include path '%s'"), path);
165 path = expanded;
168 * Use an absolute path as-is, but interpret relative paths
169 * based on the including config file.
171 if (!is_absolute_path(path)) {
172 char *slash;
174 if (!kvi || !kvi->path) {
175 ret = error(_("relative config includes must come from files"));
176 goto cleanup;
179 slash = find_last_dir_sep(kvi->path);
180 if (slash)
181 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
182 strbuf_addstr(&buf, path);
183 path = buf.buf;
186 if (!access_or_die(path, R_OK, 0)) {
187 if (++inc->depth > MAX_INCLUDE_DEPTH)
188 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
189 !kvi ? "<unknown>" :
190 kvi->filename ? kvi->filename :
191 "the command line");
192 ret = git_config_from_file_with_options(git_config_include, path, inc,
193 kvi->scope, NULL);
194 inc->depth--;
196 cleanup:
197 strbuf_release(&buf);
198 free(expanded);
199 return ret;
202 static void add_trailing_starstar_for_dir(struct strbuf *pat)
204 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
205 strbuf_addstr(pat, "**");
208 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
209 struct strbuf *pat)
211 struct strbuf path = STRBUF_INIT;
212 char *expanded;
213 int prefix = 0;
215 expanded = interpolate_path(pat->buf, 1);
216 if (expanded) {
217 strbuf_reset(pat);
218 strbuf_addstr(pat, expanded);
219 free(expanded);
222 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
223 const char *slash;
225 if (!kvi || !kvi->path)
226 return error(_("relative config include "
227 "conditionals must come from files"));
229 strbuf_realpath(&path, kvi->path, 1);
230 slash = find_last_dir_sep(path.buf);
231 if (!slash)
232 BUG("how is this possible?");
233 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
234 prefix = slash - path.buf + 1 /* slash */;
235 } else if (!is_absolute_path(pat->buf))
236 strbuf_insertstr(pat, 0, "**/");
238 add_trailing_starstar_for_dir(pat);
240 strbuf_release(&path);
241 return prefix;
244 static int include_by_gitdir(const struct key_value_info *kvi,
245 const struct config_options *opts,
246 const char *cond, size_t cond_len, int icase)
248 struct strbuf text = STRBUF_INIT;
249 struct strbuf pattern = STRBUF_INIT;
250 int ret = 0, prefix;
251 const char *git_dir;
252 int already_tried_absolute = 0;
254 if (opts->git_dir)
255 git_dir = opts->git_dir;
256 else
257 goto done;
259 strbuf_realpath(&text, git_dir, 1);
260 strbuf_add(&pattern, cond, cond_len);
261 prefix = prepare_include_condition_pattern(kvi, &pattern);
263 again:
264 if (prefix < 0)
265 goto done;
267 if (prefix > 0) {
269 * perform literal matching on the prefix part so that
270 * any wildcard character in it can't create side effects.
272 if (text.len < prefix)
273 goto done;
274 if (!icase && strncmp(pattern.buf, text.buf, prefix))
275 goto done;
276 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
277 goto done;
280 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
281 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
283 if (!ret && !already_tried_absolute) {
285 * We've tried e.g. matching gitdir:~/work, but if
286 * ~/work is a symlink to /mnt/storage/work
287 * strbuf_realpath() will expand it, so the rule won't
288 * match. Let's match against a
289 * strbuf_add_absolute_path() version of the path,
290 * which'll do the right thing
292 strbuf_reset(&text);
293 strbuf_add_absolute_path(&text, git_dir);
294 already_tried_absolute = 1;
295 goto again;
297 done:
298 strbuf_release(&pattern);
299 strbuf_release(&text);
300 return ret;
303 static int include_by_branch(const char *cond, size_t cond_len)
305 int flags;
306 int ret;
307 struct strbuf pattern = STRBUF_INIT;
308 const char *refname = !the_repository->gitdir ?
309 NULL : refs_resolve_ref_unsafe(get_main_ref_store(the_repository),
310 "HEAD", 0, NULL, &flags);
311 const char *shortname;
313 if (!refname || !(flags & REF_ISSYMREF) ||
314 !skip_prefix(refname, "refs/heads/", &shortname))
315 return 0;
317 strbuf_add(&pattern, cond, cond_len);
318 add_trailing_starstar_for_dir(&pattern);
319 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
320 strbuf_release(&pattern);
321 return ret;
324 static int add_remote_url(const char *var, const char *value,
325 const struct config_context *ctx UNUSED, void *data)
327 struct string_list *remote_urls = data;
328 const char *remote_name;
329 size_t remote_name_len;
330 const char *key;
332 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
333 &key) &&
334 remote_name &&
335 !strcmp(key, "url"))
336 string_list_append(remote_urls, value);
337 return 0;
340 static void populate_remote_urls(struct config_include_data *inc)
342 struct config_options opts;
344 opts = *inc->opts;
345 opts.unconditional_remote_url = 1;
347 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
348 string_list_init_dup(inc->remote_urls);
349 config_with_options(add_remote_url, inc->remote_urls,
350 inc->config_source, inc->repo, &opts);
353 static int forbid_remote_url(const char *var, const char *value UNUSED,
354 const struct config_context *ctx UNUSED,
355 void *data UNUSED)
357 const char *remote_name;
358 size_t remote_name_len;
359 const char *key;
361 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
362 &key) &&
363 remote_name &&
364 !strcmp(key, "url"))
365 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
366 return 0;
369 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
370 struct string_list *remote_urls)
372 struct strbuf pattern = STRBUF_INIT;
373 struct string_list_item *url_item;
374 int found = 0;
376 strbuf_add(&pattern, glob, glob_len);
377 for_each_string_list_item(url_item, remote_urls) {
378 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
379 found = 1;
380 break;
383 strbuf_release(&pattern);
384 return found;
387 static int include_by_remote_url(struct config_include_data *inc,
388 const char *cond, size_t cond_len)
390 if (inc->opts->unconditional_remote_url)
391 return 1;
392 if (!inc->remote_urls)
393 populate_remote_urls(inc);
394 return at_least_one_url_matches_glob(cond, cond_len,
395 inc->remote_urls);
398 static int include_condition_is_true(const struct key_value_info *kvi,
399 struct config_include_data *inc,
400 const char *cond, size_t cond_len)
402 const struct config_options *opts = inc->opts;
404 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
405 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
406 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
407 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
408 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
409 return include_by_branch(cond, cond_len);
410 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
411 &cond_len))
412 return include_by_remote_url(inc, cond, cond_len);
414 /* unknown conditionals are always false */
415 return 0;
418 static int git_config_include(const char *var, const char *value,
419 const struct config_context *ctx,
420 void *data)
422 struct config_include_data *inc = data;
423 const char *cond, *key;
424 size_t cond_len;
425 int ret;
428 * Pass along all values, including "include" directives; this makes it
429 * possible to query information on the includes themselves.
431 ret = inc->fn(var, value, ctx, inc->data);
432 if (ret < 0)
433 return ret;
435 if (!strcmp(var, "include.path"))
436 ret = handle_path_include(ctx->kvi, value, inc);
438 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
439 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
440 !strcmp(key, "path")) {
441 config_fn_t old_fn = inc->fn;
443 if (inc->opts->unconditional_remote_url)
444 inc->fn = forbid_remote_url;
445 ret = handle_path_include(ctx->kvi, value, inc);
446 inc->fn = old_fn;
449 return ret;
452 static void git_config_push_split_parameter(const char *key, const char *value)
454 struct strbuf env = STRBUF_INIT;
455 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
456 if (old && *old) {
457 strbuf_addstr(&env, old);
458 strbuf_addch(&env, ' ');
460 sq_quote_buf(&env, key);
461 strbuf_addch(&env, '=');
462 if (value)
463 sq_quote_buf(&env, value);
464 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
465 strbuf_release(&env);
468 void git_config_push_parameter(const char *text)
470 const char *value;
473 * When we see:
475 * section.subsection=with=equals.key=value
477 * we cannot tell if it means:
479 * [section "subsection=with=equals"]
480 * key = value
482 * or:
484 * [section]
485 * subsection = with=equals.key=value
487 * We parse left-to-right for the first "=", meaning we'll prefer to
488 * keep the value intact over the subsection. This is historical, but
489 * also sensible since values are more likely to contain odd or
490 * untrusted input than a section name.
492 * A missing equals is explicitly allowed (as a bool-only entry).
494 value = strchr(text, '=');
495 if (value) {
496 char *key = xmemdupz(text, value - text);
497 git_config_push_split_parameter(key, value + 1);
498 free(key);
499 } else {
500 git_config_push_split_parameter(text, NULL);
504 void git_config_push_env(const char *spec)
506 char *key;
507 const char *env_name;
508 const char *env_value;
510 env_name = strrchr(spec, '=');
511 if (!env_name)
512 die(_("invalid config format: %s"), spec);
513 key = xmemdupz(spec, env_name - spec);
514 env_name++;
515 if (!*env_name)
516 die(_("missing environment variable name for configuration '%.*s'"),
517 (int)(env_name - spec - 1), spec);
519 env_value = getenv(env_name);
520 if (!env_value)
521 die(_("missing environment variable '%s' for configuration '%.*s'"),
522 env_name, (int)(env_name - spec - 1), spec);
524 git_config_push_split_parameter(key, env_value);
525 free(key);
528 static inline int iskeychar(int c)
530 return isalnum(c) || c == '-';
534 * Auxiliary function to sanity-check and split the key into the section
535 * identifier and variable name.
537 * Returns 0 on success, -1 when there is an invalid character in the key and
538 * -2 if there is no section name in the key.
540 * store_key - pointer to char* which will hold a copy of the key with
541 * lowercase section and variable name
542 * baselen - pointer to size_t which will hold the length of the
543 * section + subsection part, can be NULL
545 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
547 size_t i, baselen;
548 int dot;
549 const char *last_dot = strrchr(key, '.');
552 * Since "key" actually contains the section name and the real
553 * key name separated by a dot, we have to know where the dot is.
556 if (last_dot == NULL || last_dot == key) {
557 error(_("key does not contain a section: %s"), key);
558 return -CONFIG_NO_SECTION_OR_NAME;
561 if (!last_dot[1]) {
562 error(_("key does not contain variable name: %s"), key);
563 return -CONFIG_NO_SECTION_OR_NAME;
566 baselen = last_dot - key;
567 if (baselen_)
568 *baselen_ = baselen;
571 * Validate the key and while at it, lower case it for matching.
573 *store_key = xmallocz(strlen(key));
575 dot = 0;
576 for (i = 0; key[i]; i++) {
577 unsigned char c = key[i];
578 if (c == '.')
579 dot = 1;
580 /* Leave the extended basename untouched.. */
581 if (!dot || i > baselen) {
582 if (!iskeychar(c) ||
583 (i == baselen + 1 && !isalpha(c))) {
584 error(_("invalid key: %s"), key);
585 goto out_free_ret_1;
587 c = tolower(c);
588 } else if (c == '\n') {
589 error(_("invalid key (newline): %s"), key);
590 goto out_free_ret_1;
592 (*store_key)[i] = c;
595 return 0;
597 out_free_ret_1:
598 FREE_AND_NULL(*store_key);
599 return -CONFIG_INVALID_KEY;
602 static int config_parse_pair(const char *key, const char *value,
603 struct key_value_info *kvi,
604 config_fn_t fn, void *data)
606 char *canonical_name;
607 int ret;
608 struct config_context ctx = {
609 .kvi = kvi,
612 if (!strlen(key))
613 return error(_("empty config key"));
614 if (git_config_parse_key(key, &canonical_name, NULL))
615 return -1;
617 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
618 free(canonical_name);
619 return ret;
623 /* for values read from `git_config_from_parameters()` */
624 void kvi_from_param(struct key_value_info *out)
626 out->filename = NULL;
627 out->linenr = -1;
628 out->origin_type = CONFIG_ORIGIN_CMDLINE;
629 out->scope = CONFIG_SCOPE_COMMAND;
630 out->path = NULL;
633 int git_config_parse_parameter(const char *text,
634 config_fn_t fn, void *data)
636 const char *value;
637 struct strbuf **pair;
638 int ret;
639 struct key_value_info kvi = KVI_INIT;
641 kvi_from_param(&kvi);
643 pair = strbuf_split_str(text, '=', 2);
644 if (!pair[0])
645 return error(_("bogus config parameter: %s"), text);
647 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
648 strbuf_setlen(pair[0], pair[0]->len - 1);
649 value = pair[1] ? pair[1]->buf : "";
650 } else {
651 value = NULL;
654 strbuf_trim(pair[0]);
655 if (!pair[0]->len) {
656 strbuf_list_free(pair);
657 return error(_("bogus config parameter: %s"), text);
660 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
661 strbuf_list_free(pair);
662 return ret;
665 static int parse_config_env_list(char *env, struct key_value_info *kvi,
666 config_fn_t fn, void *data)
668 char *cur = env;
669 while (cur && *cur) {
670 const char *key = sq_dequote_step(cur, &cur);
671 if (!key)
672 return error(_("bogus format in %s"),
673 CONFIG_DATA_ENVIRONMENT);
675 if (!cur || isspace(*cur)) {
676 /* old-style 'key=value' */
677 if (git_config_parse_parameter(key, fn, data) < 0)
678 return -1;
680 else if (*cur == '=') {
681 /* new-style 'key'='value' */
682 const char *value;
684 cur++;
685 if (*cur == '\'') {
686 /* quoted value */
687 value = sq_dequote_step(cur, &cur);
688 if (!value || (cur && !isspace(*cur))) {
689 return error(_("bogus format in %s"),
690 CONFIG_DATA_ENVIRONMENT);
692 } else if (!*cur || isspace(*cur)) {
693 /* implicit bool: 'key'= */
694 value = NULL;
695 } else {
696 return error(_("bogus format in %s"),
697 CONFIG_DATA_ENVIRONMENT);
700 if (config_parse_pair(key, value, kvi, fn, data) < 0)
701 return -1;
703 else {
704 /* unknown format */
705 return error(_("bogus format in %s"),
706 CONFIG_DATA_ENVIRONMENT);
709 if (cur) {
710 while (isspace(*cur))
711 cur++;
714 return 0;
717 int git_config_from_parameters(config_fn_t fn, void *data)
719 const char *env;
720 struct strbuf envvar = STRBUF_INIT;
721 struct strvec to_free = STRVEC_INIT;
722 int ret = 0;
723 char *envw = NULL;
724 struct key_value_info kvi = KVI_INIT;
726 kvi_from_param(&kvi);
727 env = getenv(CONFIG_COUNT_ENVIRONMENT);
728 if (env) {
729 unsigned long count;
730 char *endp;
731 int i;
733 count = strtoul(env, &endp, 10);
734 if (*endp) {
735 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
736 goto out;
738 if (count > INT_MAX) {
739 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
740 goto out;
743 for (i = 0; i < count; i++) {
744 const char *key, *value;
746 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
747 key = getenv_safe(&to_free, envvar.buf);
748 if (!key) {
749 ret = error(_("missing config key %s"), envvar.buf);
750 goto out;
752 strbuf_reset(&envvar);
754 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
755 value = getenv_safe(&to_free, envvar.buf);
756 if (!value) {
757 ret = error(_("missing config value %s"), envvar.buf);
758 goto out;
760 strbuf_reset(&envvar);
762 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
763 ret = -1;
764 goto out;
769 env = getenv(CONFIG_DATA_ENVIRONMENT);
770 if (env) {
771 /* sq_dequote will write over it */
772 envw = xstrdup(env);
773 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
774 ret = -1;
775 goto out;
779 out:
780 strbuf_release(&envvar);
781 strvec_clear(&to_free);
782 free(envw);
783 return ret;
786 static int get_next_char(struct config_source *cs)
788 int c = cs->do_fgetc(cs);
790 if (c == '\r') {
791 /* DOS like systems */
792 c = cs->do_fgetc(cs);
793 if (c != '\n') {
794 if (c != EOF)
795 cs->do_ungetc(c, cs);
796 c = '\r';
800 if (c != EOF && ++cs->total_len > INT_MAX) {
802 * This is an absurdly long config file; refuse to parse
803 * further in order to protect downstream code from integer
804 * overflows. Note that we can't return an error specifically,
805 * but we can mark EOF and put trash in the return value,
806 * which will trigger a parse error.
808 cs->eof = 1;
809 return 0;
812 if (c == '\n')
813 cs->linenr++;
814 if (c == EOF) {
815 cs->eof = 1;
816 cs->linenr++;
817 c = '\n';
819 return c;
822 static char *parse_value(struct config_source *cs)
824 int quote = 0, comment = 0;
825 size_t trim_len = 0;
827 strbuf_reset(&cs->value);
828 for (;;) {
829 int c = get_next_char(cs);
830 if (c == '\n') {
831 if (quote) {
832 cs->linenr--;
833 return NULL;
835 if (trim_len)
836 strbuf_setlen(&cs->value, trim_len);
837 return cs->value.buf;
839 if (comment)
840 continue;
841 if (isspace(c) && !quote) {
842 if (!trim_len)
843 trim_len = cs->value.len;
844 if (cs->value.len)
845 strbuf_addch(&cs->value, c);
846 continue;
848 if (!quote) {
849 if (c == ';' || c == '#') {
850 comment = 1;
851 continue;
854 if (trim_len)
855 trim_len = 0;
856 if (c == '\\') {
857 c = get_next_char(cs);
858 switch (c) {
859 case '\n':
860 continue;
861 case 't':
862 c = '\t';
863 break;
864 case 'b':
865 c = '\b';
866 break;
867 case 'n':
868 c = '\n';
869 break;
870 /* Some characters escape as themselves */
871 case '\\': case '"':
872 break;
873 /* Reject unknown escape sequences */
874 default:
875 return NULL;
877 strbuf_addch(&cs->value, c);
878 continue;
880 if (c == '"') {
881 quote = 1 - quote;
882 continue;
884 strbuf_addch(&cs->value, c);
888 static int get_value(struct config_source *cs, struct key_value_info *kvi,
889 config_fn_t fn, void *data, struct strbuf *name)
891 int c;
892 char *value;
893 int ret;
894 struct config_context ctx = {
895 .kvi = kvi,
898 /* Get the full name */
899 for (;;) {
900 c = get_next_char(cs);
901 if (cs->eof)
902 break;
903 if (!iskeychar(c))
904 break;
905 strbuf_addch(name, tolower(c));
908 while (c == ' ' || c == '\t')
909 c = get_next_char(cs);
911 value = NULL;
912 if (c != '\n') {
913 if (c != '=')
914 return -1;
915 value = parse_value(cs);
916 if (!value)
917 return -1;
920 * We already consumed the \n, but we need linenr to point to
921 * the line we just parsed during the call to fn to get
922 * accurate line number in error messages.
924 cs->linenr--;
925 kvi->linenr = cs->linenr;
926 ret = fn(name->buf, value, &ctx, data);
927 if (ret >= 0)
928 cs->linenr++;
929 return ret;
932 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
933 int c)
935 cs->subsection_case_sensitive = 0;
936 do {
937 if (c == '\n')
938 goto error_incomplete_line;
939 c = get_next_char(cs);
940 } while (isspace(c));
942 /* We require the format to be '[base "extension"]' */
943 if (c != '"')
944 return -1;
945 strbuf_addch(name, '.');
947 for (;;) {
948 int c = get_next_char(cs);
949 if (c == '\n')
950 goto error_incomplete_line;
951 if (c == '"')
952 break;
953 if (c == '\\') {
954 c = get_next_char(cs);
955 if (c == '\n')
956 goto error_incomplete_line;
958 strbuf_addch(name, c);
961 /* Final ']' */
962 if (get_next_char(cs) != ']')
963 return -1;
964 return 0;
965 error_incomplete_line:
966 cs->linenr--;
967 return -1;
970 static int get_base_var(struct config_source *cs, struct strbuf *name)
972 cs->subsection_case_sensitive = 1;
973 for (;;) {
974 int c = get_next_char(cs);
975 if (cs->eof)
976 return -1;
977 if (c == ']')
978 return 0;
979 if (isspace(c))
980 return get_extended_base_var(cs, name, c);
981 if (!iskeychar(c) && c != '.')
982 return -1;
983 strbuf_addch(name, tolower(c));
987 struct parse_event_data {
988 enum config_event_t previous_type;
989 size_t previous_offset;
990 const struct config_options *opts;
993 static int do_event(struct config_source *cs, enum config_event_t type,
994 struct parse_event_data *data)
996 size_t offset;
998 if (!data->opts || !data->opts->event_fn)
999 return 0;
1001 if (type == CONFIG_EVENT_WHITESPACE &&
1002 data->previous_type == type)
1003 return 0;
1005 offset = cs->do_ftell(cs);
1007 * At EOF, the parser always "inserts" an extra '\n', therefore
1008 * the end offset of the event is the current file position, otherwise
1009 * we will already have advanced to the next event.
1011 if (type != CONFIG_EVENT_EOF)
1012 offset--;
1014 if (data->previous_type != CONFIG_EVENT_EOF &&
1015 data->opts->event_fn(data->previous_type, data->previous_offset,
1016 offset, cs, data->opts->event_fn_data) < 0)
1017 return -1;
1019 data->previous_type = type;
1020 data->previous_offset = offset;
1022 return 0;
1025 static void kvi_from_source(struct config_source *cs,
1026 enum config_scope scope,
1027 struct key_value_info *out)
1029 out->filename = strintern(cs->name);
1030 out->origin_type = cs->origin_type;
1031 out->linenr = cs->linenr;
1032 out->scope = scope;
1033 out->path = cs->path;
1036 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1037 struct key_value_info *kvi, void *data,
1038 const struct config_options *opts)
1040 int comment = 0;
1041 size_t baselen = 0;
1042 struct strbuf *var = &cs->var;
1043 int error_return = 0;
1044 char *error_msg = NULL;
1046 /* U+FEFF Byte Order Mark in UTF8 */
1047 const char *bomptr = utf8_bom;
1049 /* For the parser event callback */
1050 struct parse_event_data event_data = {
1051 CONFIG_EVENT_EOF, 0, opts
1054 for (;;) {
1055 int c;
1057 c = get_next_char(cs);
1058 if (bomptr && *bomptr) {
1059 /* We are at the file beginning; skip UTF8-encoded BOM
1060 * if present. Sane editors won't put this in on their
1061 * own, but e.g. Windows Notepad will do it happily. */
1062 if (c == (*bomptr & 0377)) {
1063 bomptr++;
1064 continue;
1065 } else {
1066 /* Do not tolerate partial BOM. */
1067 if (bomptr != utf8_bom)
1068 break;
1069 /* No BOM at file beginning. Cool. */
1070 bomptr = NULL;
1073 if (c == '\n') {
1074 if (cs->eof) {
1075 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1076 return -1;
1077 return 0;
1079 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1080 return -1;
1081 comment = 0;
1082 continue;
1084 if (comment)
1085 continue;
1086 if (isspace(c)) {
1087 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1088 return -1;
1089 continue;
1091 if (c == '#' || c == ';') {
1092 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1093 return -1;
1094 comment = 1;
1095 continue;
1097 if (c == '[') {
1098 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1099 return -1;
1101 /* Reset prior to determining a new stem */
1102 strbuf_reset(var);
1103 if (get_base_var(cs, var) < 0 || var->len < 1)
1104 break;
1105 strbuf_addch(var, '.');
1106 baselen = var->len;
1107 continue;
1109 if (!isalpha(c))
1110 break;
1112 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1113 return -1;
1116 * Truncate the var name back to the section header
1117 * stem prior to grabbing the suffix part of the name
1118 * and the value.
1120 strbuf_setlen(var, baselen);
1121 strbuf_addch(var, tolower(c));
1122 if (get_value(cs, kvi, fn, data, var) < 0)
1123 break;
1126 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1127 return -1;
1129 switch (cs->origin_type) {
1130 case CONFIG_ORIGIN_BLOB:
1131 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1132 cs->linenr, cs->name);
1133 break;
1134 case CONFIG_ORIGIN_FILE:
1135 error_msg = xstrfmt(_("bad config line %d in file %s"),
1136 cs->linenr, cs->name);
1137 break;
1138 case CONFIG_ORIGIN_STDIN:
1139 error_msg = xstrfmt(_("bad config line %d in standard input"),
1140 cs->linenr);
1141 break;
1142 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1143 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1144 cs->linenr, cs->name);
1145 break;
1146 case CONFIG_ORIGIN_CMDLINE:
1147 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1148 cs->linenr, cs->name);
1149 break;
1150 default:
1151 error_msg = xstrfmt(_("bad config line %d in %s"),
1152 cs->linenr, cs->name);
1155 switch (opts && opts->error_action ?
1156 opts->error_action :
1157 cs->default_error_action) {
1158 case CONFIG_ERROR_DIE:
1159 die("%s", error_msg);
1160 break;
1161 case CONFIG_ERROR_ERROR:
1162 error_return = error("%s", error_msg);
1163 break;
1164 case CONFIG_ERROR_SILENT:
1165 error_return = -1;
1166 break;
1167 case CONFIG_ERROR_UNSET:
1168 BUG("config error action unset");
1171 free(error_msg);
1172 return error_return;
1175 NORETURN
1176 static void die_bad_number(const char *name, const char *value,
1177 const struct key_value_info *kvi)
1179 const char *error_type = (errno == ERANGE) ?
1180 N_("out of range") : N_("invalid unit");
1181 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1183 if (!kvi)
1184 BUG("kvi should not be NULL");
1186 if (!value)
1187 value = "";
1189 if (!kvi->filename)
1190 die(_(bad_numeric), value, name, _(error_type));
1192 switch (kvi->origin_type) {
1193 case CONFIG_ORIGIN_BLOB:
1194 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1195 value, name, kvi->filename, _(error_type));
1196 case CONFIG_ORIGIN_FILE:
1197 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1198 value, name, kvi->filename, _(error_type));
1199 case CONFIG_ORIGIN_STDIN:
1200 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1201 value, name, _(error_type));
1202 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1203 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1204 value, name, kvi->filename, _(error_type));
1205 case CONFIG_ORIGIN_CMDLINE:
1206 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1207 value, name, kvi->filename, _(error_type));
1208 default:
1209 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1210 value, name, kvi->filename, _(error_type));
1214 int git_config_int(const char *name, const char *value,
1215 const struct key_value_info *kvi)
1217 int ret;
1218 if (!git_parse_int(value, &ret))
1219 die_bad_number(name, value, kvi);
1220 return ret;
1223 int64_t git_config_int64(const char *name, const char *value,
1224 const struct key_value_info *kvi)
1226 int64_t ret;
1227 if (!git_parse_int64(value, &ret))
1228 die_bad_number(name, value, kvi);
1229 return ret;
1232 unsigned long git_config_ulong(const char *name, const char *value,
1233 const struct key_value_info *kvi)
1235 unsigned long ret;
1236 if (!git_parse_ulong(value, &ret))
1237 die_bad_number(name, value, kvi);
1238 return ret;
1241 ssize_t git_config_ssize_t(const char *name, const char *value,
1242 const struct key_value_info *kvi)
1244 ssize_t ret;
1245 if (!git_parse_ssize_t(value, &ret))
1246 die_bad_number(name, value, kvi);
1247 return ret;
1250 static const struct fsync_component_name {
1251 const char *name;
1252 enum fsync_component component_bits;
1253 } fsync_component_names[] = {
1254 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1255 { "pack", FSYNC_COMPONENT_PACK },
1256 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1257 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1258 { "index", FSYNC_COMPONENT_INDEX },
1259 { "objects", FSYNC_COMPONENTS_OBJECTS },
1260 { "reference", FSYNC_COMPONENT_REFERENCE },
1261 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1262 { "committed", FSYNC_COMPONENTS_COMMITTED },
1263 { "added", FSYNC_COMPONENTS_ADDED },
1264 { "all", FSYNC_COMPONENTS_ALL },
1267 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1269 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1270 enum fsync_component positive = 0, negative = 0;
1272 while (string) {
1273 int i;
1274 size_t len;
1275 const char *ep;
1276 int negated = 0;
1277 int found = 0;
1279 string = string + strspn(string, ", \t\n\r");
1280 ep = strchrnul(string, ',');
1281 len = ep - string;
1282 if (!strcmp(string, "none")) {
1283 current = FSYNC_COMPONENT_NONE;
1284 goto next_name;
1287 if (*string == '-') {
1288 negated = 1;
1289 string++;
1290 len--;
1291 if (!len)
1292 warning(_("invalid value for variable %s"), var);
1295 if (!len)
1296 break;
1298 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1299 const struct fsync_component_name *n = &fsync_component_names[i];
1301 if (strncmp(n->name, string, len))
1302 continue;
1304 found = 1;
1305 if (negated)
1306 negative |= n->component_bits;
1307 else
1308 positive |= n->component_bits;
1311 if (!found) {
1312 char *component = xstrndup(string, len);
1313 warning(_("ignoring unknown core.fsync component '%s'"), component);
1314 free(component);
1317 next_name:
1318 string = ep;
1321 return (current & ~negative) | positive;
1324 int git_config_bool_or_int(const char *name, const char *value,
1325 const struct key_value_info *kvi, int *is_bool)
1327 int v = git_parse_maybe_bool_text(value);
1328 if (0 <= v) {
1329 *is_bool = 1;
1330 return v;
1332 *is_bool = 0;
1333 return git_config_int(name, value, kvi);
1336 int git_config_bool(const char *name, const char *value)
1338 int v = git_parse_maybe_bool(value);
1339 if (v < 0)
1340 die(_("bad boolean config value '%s' for '%s'"), value, name);
1341 return v;
1344 int git_config_string(char **dest, const char *var, const char *value)
1346 if (!value)
1347 return config_error_nonbool(var);
1348 *dest = xstrdup(value);
1349 return 0;
1352 int git_config_pathname(char **dest, const char *var, const char *value)
1354 if (!value)
1355 return config_error_nonbool(var);
1356 *dest = interpolate_path(value, 0);
1357 if (!*dest)
1358 die(_("failed to expand user dir in: '%s'"), value);
1359 return 0;
1362 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1364 if (!value)
1365 return config_error_nonbool(var);
1366 if (parse_expiry_date(value, timestamp))
1367 return error(_("'%s' for '%s' is not a valid timestamp"),
1368 value, var);
1369 return 0;
1372 int git_config_color(char *dest, const char *var, const char *value)
1374 if (!value)
1375 return config_error_nonbool(var);
1376 if (color_parse(value, dest) < 0)
1377 return -1;
1378 return 0;
1381 static int git_default_core_config(const char *var, const char *value,
1382 const struct config_context *ctx, void *cb)
1384 /* This needs a better name */
1385 if (!strcmp(var, "core.filemode")) {
1386 trust_executable_bit = git_config_bool(var, value);
1387 return 0;
1389 if (!strcmp(var, "core.trustctime")) {
1390 trust_ctime = git_config_bool(var, value);
1391 return 0;
1393 if (!strcmp(var, "core.checkstat")) {
1394 if (!value)
1395 return config_error_nonbool(var);
1396 if (!strcasecmp(value, "default"))
1397 check_stat = 1;
1398 else if (!strcasecmp(value, "minimal"))
1399 check_stat = 0;
1400 else
1401 return error(_("invalid value for '%s': '%s'"),
1402 var, value);
1405 if (!strcmp(var, "core.quotepath")) {
1406 quote_path_fully = git_config_bool(var, value);
1407 return 0;
1410 if (!strcmp(var, "core.symlinks")) {
1411 has_symlinks = git_config_bool(var, value);
1412 return 0;
1415 if (!strcmp(var, "core.ignorecase")) {
1416 ignore_case = git_config_bool(var, value);
1417 return 0;
1420 if (!strcmp(var, "core.attributesfile")) {
1421 FREE_AND_NULL(git_attributes_file);
1422 return git_config_pathname(&git_attributes_file, var, value);
1425 if (!strcmp(var, "core.hookspath")) {
1426 FREE_AND_NULL(git_hooks_path);
1427 return git_config_pathname(&git_hooks_path, var, value);
1430 if (!strcmp(var, "core.bare")) {
1431 is_bare_repository_cfg = git_config_bool(var, value);
1432 return 0;
1435 if (!strcmp(var, "core.ignorestat")) {
1436 assume_unchanged = git_config_bool(var, value);
1437 return 0;
1440 if (!strcmp(var, "core.prefersymlinkrefs")) {
1441 prefer_symlink_refs = git_config_bool(var, value);
1442 return 0;
1445 if (!strcmp(var, "core.logallrefupdates")) {
1446 if (value && !strcasecmp(value, "always"))
1447 log_all_ref_updates = LOG_REFS_ALWAYS;
1448 else if (git_config_bool(var, value))
1449 log_all_ref_updates = LOG_REFS_NORMAL;
1450 else
1451 log_all_ref_updates = LOG_REFS_NONE;
1452 return 0;
1455 if (!strcmp(var, "core.warnambiguousrefs")) {
1456 warn_ambiguous_refs = git_config_bool(var, value);
1457 return 0;
1460 if (!strcmp(var, "core.abbrev")) {
1461 if (!value)
1462 return config_error_nonbool(var);
1463 if (!strcasecmp(value, "auto"))
1464 default_abbrev = -1;
1465 else if (!git_parse_maybe_bool_text(value))
1466 default_abbrev = the_hash_algo->hexsz;
1467 else {
1468 int abbrev = git_config_int(var, value, ctx->kvi);
1469 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1470 return error(_("abbrev length out of range: %d"), abbrev);
1471 default_abbrev = abbrev;
1473 return 0;
1476 if (!strcmp(var, "core.disambiguate"))
1477 return set_disambiguate_hint_config(var, value);
1479 if (!strcmp(var, "core.loosecompression")) {
1480 int level = git_config_int(var, value, ctx->kvi);
1481 if (level == -1)
1482 level = Z_DEFAULT_COMPRESSION;
1483 else if (level < 0 || level > Z_BEST_COMPRESSION)
1484 die(_("bad zlib compression level %d"), level);
1485 zlib_compression_level = level;
1486 zlib_compression_seen = 1;
1487 return 0;
1490 if (!strcmp(var, "core.compression")) {
1491 int level = git_config_int(var, value, ctx->kvi);
1492 if (level == -1)
1493 level = Z_DEFAULT_COMPRESSION;
1494 else if (level < 0 || level > Z_BEST_COMPRESSION)
1495 die(_("bad zlib compression level %d"), level);
1496 if (!zlib_compression_seen)
1497 zlib_compression_level = level;
1498 if (!pack_compression_seen)
1499 pack_compression_level = level;
1500 return 0;
1503 if (!strcmp(var, "core.packedgitwindowsize")) {
1504 int pgsz_x2 = getpagesize() * 2;
1505 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1507 /* This value must be multiple of (pagesize * 2) */
1508 packed_git_window_size /= pgsz_x2;
1509 if (packed_git_window_size < 1)
1510 packed_git_window_size = 1;
1511 packed_git_window_size *= pgsz_x2;
1512 return 0;
1515 if (!strcmp(var, "core.bigfilethreshold")) {
1516 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1517 return 0;
1520 if (!strcmp(var, "core.packedgitlimit")) {
1521 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1522 return 0;
1525 if (!strcmp(var, "core.deltabasecachelimit")) {
1526 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1527 return 0;
1530 if (!strcmp(var, "core.autocrlf")) {
1531 if (value && !strcasecmp(value, "input")) {
1532 auto_crlf = AUTO_CRLF_INPUT;
1533 return 0;
1535 auto_crlf = git_config_bool(var, value);
1536 return 0;
1539 if (!strcmp(var, "core.safecrlf")) {
1540 int eol_rndtrp_die;
1541 if (value && !strcasecmp(value, "warn")) {
1542 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1543 return 0;
1545 eol_rndtrp_die = git_config_bool(var, value);
1546 global_conv_flags_eol = eol_rndtrp_die ?
1547 CONV_EOL_RNDTRP_DIE : 0;
1548 return 0;
1551 if (!strcmp(var, "core.eol")) {
1552 if (value && !strcasecmp(value, "lf"))
1553 core_eol = EOL_LF;
1554 else if (value && !strcasecmp(value, "crlf"))
1555 core_eol = EOL_CRLF;
1556 else if (value && !strcasecmp(value, "native"))
1557 core_eol = EOL_NATIVE;
1558 else
1559 core_eol = EOL_UNSET;
1560 return 0;
1563 if (!strcmp(var, "core.checkroundtripencoding")) {
1564 FREE_AND_NULL(check_roundtrip_encoding);
1565 return git_config_string(&check_roundtrip_encoding, var, value);
1568 if (!strcmp(var, "core.notesref")) {
1569 if (!value)
1570 return config_error_nonbool(var);
1571 notes_ref_name = xstrdup(value);
1572 return 0;
1575 if (!strcmp(var, "core.editor")) {
1576 FREE_AND_NULL(editor_program);
1577 return git_config_string(&editor_program, var, value);
1580 if (!strcmp(var, "core.commentchar") ||
1581 !strcmp(var, "core.commentstring")) {
1582 if (!value)
1583 return config_error_nonbool(var);
1584 else if (!strcasecmp(value, "auto"))
1585 auto_comment_line_char = 1;
1586 else if (value[0]) {
1587 if (strchr(value, '\n'))
1588 return error(_("%s cannot contain newline"), var);
1589 comment_line_str = xstrdup(value);
1590 auto_comment_line_char = 0;
1591 } else
1592 return error(_("%s must have at least one character"), var);
1593 return 0;
1596 if (!strcmp(var, "core.askpass")) {
1597 FREE_AND_NULL(askpass_program);
1598 return git_config_string(&askpass_program, var, value);
1601 if (!strcmp(var, "core.excludesfile")) {
1602 FREE_AND_NULL(excludes_file);
1603 return git_config_pathname(&excludes_file, var, value);
1606 if (!strcmp(var, "core.whitespace")) {
1607 if (!value)
1608 return config_error_nonbool(var);
1609 whitespace_rule_cfg = parse_whitespace_rule(value);
1610 return 0;
1613 if (!strcmp(var, "core.fsync")) {
1614 if (!value)
1615 return config_error_nonbool(var);
1616 fsync_components = parse_fsync_components(var, value);
1617 return 0;
1620 if (!strcmp(var, "core.fsyncmethod")) {
1621 if (!value)
1622 return config_error_nonbool(var);
1623 if (!strcmp(value, "fsync"))
1624 fsync_method = FSYNC_METHOD_FSYNC;
1625 else if (!strcmp(value, "writeout-only"))
1626 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1627 else if (!strcmp(value, "batch"))
1628 fsync_method = FSYNC_METHOD_BATCH;
1629 else
1630 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1634 if (!strcmp(var, "core.fsyncobjectfiles")) {
1635 if (fsync_object_files < 0)
1636 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1637 fsync_object_files = git_config_bool(var, value);
1638 return 0;
1641 if (!strcmp(var, "core.preloadindex")) {
1642 core_preload_index = git_config_bool(var, value);
1643 return 0;
1646 if (!strcmp(var, "core.createobject")) {
1647 if (!value)
1648 return config_error_nonbool(var);
1649 if (!strcmp(value, "rename"))
1650 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1651 else if (!strcmp(value, "link"))
1652 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1653 else
1654 die(_("invalid mode for object creation: %s"), value);
1655 return 0;
1658 if (!strcmp(var, "core.sparsecheckout")) {
1659 core_apply_sparse_checkout = git_config_bool(var, value);
1660 return 0;
1663 if (!strcmp(var, "core.sparsecheckoutcone")) {
1664 core_sparse_checkout_cone = git_config_bool(var, value);
1665 return 0;
1668 if (!strcmp(var, "core.precomposeunicode")) {
1669 precomposed_unicode = git_config_bool(var, value);
1670 return 0;
1673 if (!strcmp(var, "core.protecthfs")) {
1674 protect_hfs = git_config_bool(var, value);
1675 return 0;
1678 if (!strcmp(var, "core.protectntfs")) {
1679 protect_ntfs = git_config_bool(var, value);
1680 return 0;
1683 if (!strcmp(var, "core.maxtreedepth")) {
1684 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1685 return 0;
1688 /* Add other config variables here and to Documentation/config.txt. */
1689 return platform_core_config(var, value, ctx, cb);
1692 static int git_default_sparse_config(const char *var, const char *value)
1694 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1695 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1696 return 0;
1699 /* Add other config variables here and to Documentation/config/sparse.txt. */
1700 return 0;
1703 static int git_default_i18n_config(const char *var, const char *value)
1705 if (!strcmp(var, "i18n.commitencoding")) {
1706 FREE_AND_NULL(git_commit_encoding);
1707 return git_config_string(&git_commit_encoding, var, value);
1710 if (!strcmp(var, "i18n.logoutputencoding")) {
1711 FREE_AND_NULL(git_log_output_encoding);
1712 return git_config_string(&git_log_output_encoding, var, value);
1715 /* Add other config variables here and to Documentation/config.txt. */
1716 return 0;
1719 static int git_default_branch_config(const char *var, const char *value)
1721 if (!strcmp(var, "branch.autosetupmerge")) {
1722 if (value && !strcmp(value, "always")) {
1723 git_branch_track = BRANCH_TRACK_ALWAYS;
1724 return 0;
1725 } else if (value && !strcmp(value, "inherit")) {
1726 git_branch_track = BRANCH_TRACK_INHERIT;
1727 return 0;
1728 } else if (value && !strcmp(value, "simple")) {
1729 git_branch_track = BRANCH_TRACK_SIMPLE;
1730 return 0;
1732 git_branch_track = git_config_bool(var, value);
1733 return 0;
1735 if (!strcmp(var, "branch.autosetuprebase")) {
1736 if (!value)
1737 return config_error_nonbool(var);
1738 else if (!strcmp(value, "never"))
1739 autorebase = AUTOREBASE_NEVER;
1740 else if (!strcmp(value, "local"))
1741 autorebase = AUTOREBASE_LOCAL;
1742 else if (!strcmp(value, "remote"))
1743 autorebase = AUTOREBASE_REMOTE;
1744 else if (!strcmp(value, "always"))
1745 autorebase = AUTOREBASE_ALWAYS;
1746 else
1747 return error(_("malformed value for %s"), var);
1748 return 0;
1751 /* Add other config variables here and to Documentation/config.txt. */
1752 return 0;
1755 static int git_default_push_config(const char *var, const char *value)
1757 if (!strcmp(var, "push.default")) {
1758 if (!value)
1759 return config_error_nonbool(var);
1760 else if (!strcmp(value, "nothing"))
1761 push_default = PUSH_DEFAULT_NOTHING;
1762 else if (!strcmp(value, "matching"))
1763 push_default = PUSH_DEFAULT_MATCHING;
1764 else if (!strcmp(value, "simple"))
1765 push_default = PUSH_DEFAULT_SIMPLE;
1766 else if (!strcmp(value, "upstream"))
1767 push_default = PUSH_DEFAULT_UPSTREAM;
1768 else if (!strcmp(value, "tracking")) /* deprecated */
1769 push_default = PUSH_DEFAULT_UPSTREAM;
1770 else if (!strcmp(value, "current"))
1771 push_default = PUSH_DEFAULT_CURRENT;
1772 else {
1773 error(_("malformed value for %s: %s"), var, value);
1774 return error(_("must be one of nothing, matching, simple, "
1775 "upstream or current"));
1777 return 0;
1780 /* Add other config variables here and to Documentation/config.txt. */
1781 return 0;
1784 static int git_default_mailmap_config(const char *var, const char *value)
1786 if (!strcmp(var, "mailmap.file")) {
1787 FREE_AND_NULL(git_mailmap_file);
1788 return git_config_pathname(&git_mailmap_file, var, value);
1791 if (!strcmp(var, "mailmap.blob")) {
1792 FREE_AND_NULL(git_mailmap_blob);
1793 return git_config_string(&git_mailmap_blob, var, value);
1796 /* Add other config variables here and to Documentation/config.txt. */
1797 return 0;
1800 static int git_default_attr_config(const char *var, const char *value)
1802 if (!strcmp(var, "attr.tree")) {
1803 FREE_AND_NULL(git_attr_tree);
1804 return git_config_string(&git_attr_tree, var, value);
1808 * Add other attribute related config variables here and to
1809 * Documentation/config/attr.txt.
1811 return 0;
1814 int git_default_config(const char *var, const char *value,
1815 const struct config_context *ctx, void *cb)
1817 if (starts_with(var, "core."))
1818 return git_default_core_config(var, value, ctx, cb);
1820 if (starts_with(var, "user.") ||
1821 starts_with(var, "author.") ||
1822 starts_with(var, "committer."))
1823 return git_ident_config(var, value, ctx, cb);
1825 if (starts_with(var, "i18n."))
1826 return git_default_i18n_config(var, value);
1828 if (starts_with(var, "branch."))
1829 return git_default_branch_config(var, value);
1831 if (starts_with(var, "push."))
1832 return git_default_push_config(var, value);
1834 if (starts_with(var, "mailmap."))
1835 return git_default_mailmap_config(var, value);
1837 if (starts_with(var, "attr."))
1838 return git_default_attr_config(var, value);
1840 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1841 return git_default_advice_config(var, value);
1843 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1844 pager_use_color = git_config_bool(var,value);
1845 return 0;
1848 if (!strcmp(var, "pack.packsizelimit")) {
1849 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1850 return 0;
1853 if (!strcmp(var, "pack.compression")) {
1854 int level = git_config_int(var, value, ctx->kvi);
1855 if (level == -1)
1856 level = Z_DEFAULT_COMPRESSION;
1857 else if (level < 0 || level > Z_BEST_COMPRESSION)
1858 die(_("bad pack compression level %d"), level);
1859 pack_compression_level = level;
1860 pack_compression_seen = 1;
1861 return 0;
1864 if (starts_with(var, "sparse."))
1865 return git_default_sparse_config(var, value);
1867 /* Add other config variables here and to Documentation/config.txt. */
1868 return 0;
1872 * All source specific fields in the union, die_on_error, name and the callbacks
1873 * fgetc, ungetc, ftell of top need to be initialized before calling
1874 * this function.
1876 static int do_config_from(struct config_source *top, config_fn_t fn,
1877 void *data, enum config_scope scope,
1878 const struct config_options *opts)
1880 struct key_value_info kvi = KVI_INIT;
1881 int ret;
1883 /* push config-file parsing state stack */
1884 top->linenr = 1;
1885 top->eof = 0;
1886 top->total_len = 0;
1887 strbuf_init(&top->value, 1024);
1888 strbuf_init(&top->var, 1024);
1889 kvi_from_source(top, scope, &kvi);
1891 ret = git_parse_source(top, fn, &kvi, data, opts);
1893 strbuf_release(&top->value);
1894 strbuf_release(&top->var);
1896 return ret;
1899 static int do_config_from_file(config_fn_t fn,
1900 const enum config_origin_type origin_type,
1901 const char *name, const char *path, FILE *f,
1902 void *data, enum config_scope scope,
1903 const struct config_options *opts)
1905 struct config_source top = CONFIG_SOURCE_INIT;
1906 int ret;
1908 top.u.file = f;
1909 top.origin_type = origin_type;
1910 top.name = name;
1911 top.path = path;
1912 top.default_error_action = CONFIG_ERROR_DIE;
1913 top.do_fgetc = config_file_fgetc;
1914 top.do_ungetc = config_file_ungetc;
1915 top.do_ftell = config_file_ftell;
1917 flockfile(f);
1918 ret = do_config_from(&top, fn, data, scope, opts);
1919 funlockfile(f);
1920 return ret;
1923 static int git_config_from_stdin(config_fn_t fn, void *data,
1924 enum config_scope scope)
1926 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1927 data, scope, NULL);
1930 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1931 void *data, enum config_scope scope,
1932 const struct config_options *opts)
1934 int ret = -1;
1935 FILE *f;
1937 if (!filename)
1938 BUG("filename cannot be NULL");
1939 f = fopen_or_warn(filename, "r");
1940 if (f) {
1941 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1942 filename, f, data, scope, opts);
1943 fclose(f);
1945 return ret;
1948 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1950 return git_config_from_file_with_options(fn, filename, data,
1951 CONFIG_SCOPE_UNKNOWN, NULL);
1954 int git_config_from_mem(config_fn_t fn,
1955 const enum config_origin_type origin_type,
1956 const char *name, const char *buf, size_t len,
1957 void *data, enum config_scope scope,
1958 const struct config_options *opts)
1960 struct config_source top = CONFIG_SOURCE_INIT;
1962 top.u.buf.buf = buf;
1963 top.u.buf.len = len;
1964 top.u.buf.pos = 0;
1965 top.origin_type = origin_type;
1966 top.name = name;
1967 top.path = NULL;
1968 top.default_error_action = CONFIG_ERROR_ERROR;
1969 top.do_fgetc = config_buf_fgetc;
1970 top.do_ungetc = config_buf_ungetc;
1971 top.do_ftell = config_buf_ftell;
1973 return do_config_from(&top, fn, data, scope, opts);
1976 int git_config_from_blob_oid(config_fn_t fn,
1977 const char *name,
1978 struct repository *repo,
1979 const struct object_id *oid,
1980 void *data,
1981 enum config_scope scope)
1983 enum object_type type;
1984 char *buf;
1985 unsigned long size;
1986 int ret;
1988 buf = repo_read_object_file(repo, oid, &type, &size);
1989 if (!buf)
1990 return error(_("unable to load config blob object '%s'"), name);
1991 if (type != OBJ_BLOB) {
1992 free(buf);
1993 return error(_("reference '%s' does not point to a blob"), name);
1996 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1997 data, scope, NULL);
1998 free(buf);
2000 return ret;
2003 static int git_config_from_blob_ref(config_fn_t fn,
2004 struct repository *repo,
2005 const char *name,
2006 void *data,
2007 enum config_scope scope)
2009 struct object_id oid;
2011 if (repo_get_oid(repo, name, &oid) < 0)
2012 return error(_("unable to resolve config blob '%s'"), name);
2013 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
2016 char *git_system_config(void)
2018 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2019 if (!system_config)
2020 system_config = system_path(ETC_GITCONFIG);
2021 normalize_path_copy(system_config, system_config);
2022 return system_config;
2025 char *git_global_config(void)
2027 char *user_config, *xdg_config;
2029 git_global_config_paths(&user_config, &xdg_config);
2030 if (!user_config) {
2031 free(xdg_config);
2032 return NULL;
2035 if (access_or_warn(user_config, R_OK, 0) && xdg_config &&
2036 !access_or_warn(xdg_config, R_OK, 0)) {
2037 free(user_config);
2038 return xdg_config;
2039 } else {
2040 free(xdg_config);
2041 return user_config;
2045 void git_global_config_paths(char **user_out, char **xdg_out)
2047 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2048 char *xdg_config = NULL;
2050 if (!user_config) {
2051 user_config = interpolate_path("~/.gitconfig", 0);
2052 xdg_config = xdg_config_home("config");
2055 *user_out = user_config;
2056 *xdg_out = xdg_config;
2059 int git_config_system(void)
2061 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2064 static int do_git_config_sequence(const struct config_options *opts,
2065 const struct repository *repo,
2066 config_fn_t fn, void *data)
2068 int ret = 0;
2069 char *system_config = git_system_config();
2070 char *xdg_config = NULL;
2071 char *user_config = NULL;
2072 char *repo_config;
2073 char *worktree_config;
2076 * Ensure that either:
2077 * - the git_dir and commondir are both set, or
2078 * - the git_dir and commondir are both NULL
2080 if (!opts->git_dir != !opts->commondir)
2081 BUG("only one of commondir and git_dir is non-NULL");
2083 if (opts->commondir) {
2084 repo_config = mkpathdup("%s/config", opts->commondir);
2085 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2086 } else {
2087 repo_config = NULL;
2088 worktree_config = NULL;
2091 if (git_config_system() && system_config &&
2092 !access_or_die(system_config, R_OK,
2093 opts->system_gently ? ACCESS_EACCES_OK : 0))
2094 ret += git_config_from_file_with_options(fn, system_config,
2095 data, CONFIG_SCOPE_SYSTEM,
2096 NULL);
2098 git_global_config_paths(&user_config, &xdg_config);
2100 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2101 ret += git_config_from_file_with_options(fn, xdg_config, data,
2102 CONFIG_SCOPE_GLOBAL, NULL);
2104 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2105 ret += git_config_from_file_with_options(fn, user_config, data,
2106 CONFIG_SCOPE_GLOBAL, NULL);
2108 if (!opts->ignore_repo && repo_config &&
2109 !access_or_die(repo_config, R_OK, 0))
2110 ret += git_config_from_file_with_options(fn, repo_config, data,
2111 CONFIG_SCOPE_LOCAL, NULL);
2113 if (!opts->ignore_worktree && worktree_config &&
2114 repo && repo->repository_format_worktree_config &&
2115 !access_or_die(worktree_config, R_OK, 0)) {
2116 ret += git_config_from_file_with_options(fn, worktree_config, data,
2117 CONFIG_SCOPE_WORKTREE,
2118 NULL);
2121 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2122 die(_("unable to parse command-line config"));
2124 free(system_config);
2125 free(xdg_config);
2126 free(user_config);
2127 free(repo_config);
2128 free(worktree_config);
2129 return ret;
2132 int config_with_options(config_fn_t fn, void *data,
2133 const struct git_config_source *config_source,
2134 struct repository *repo,
2135 const struct config_options *opts)
2137 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2138 int ret;
2140 if (opts->respect_includes) {
2141 inc.fn = fn;
2142 inc.data = data;
2143 inc.opts = opts;
2144 inc.repo = repo;
2145 inc.config_source = config_source;
2146 fn = git_config_include;
2147 data = &inc;
2151 * If we have a specific filename, use it. Otherwise, follow the
2152 * regular lookup sequence.
2154 if (config_source && config_source->use_stdin) {
2155 ret = git_config_from_stdin(fn, data, config_source->scope);
2156 } else if (config_source && config_source->file) {
2157 ret = git_config_from_file_with_options(fn, config_source->file,
2158 data, config_source->scope,
2159 NULL);
2160 } else if (config_source && config_source->blob) {
2161 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2162 data, config_source->scope);
2163 } else {
2164 ret = do_git_config_sequence(opts, repo, fn, data);
2167 if (inc.remote_urls) {
2168 string_list_clear(inc.remote_urls, 0);
2169 FREE_AND_NULL(inc.remote_urls);
2171 return ret;
2174 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2176 int i, value_index;
2177 struct string_list *values;
2178 struct config_set_element *entry;
2179 struct configset_list *list = &set->list;
2180 struct config_context ctx = CONFIG_CONTEXT_INIT;
2182 for (i = 0; i < list->nr; i++) {
2183 entry = list->items[i].e;
2184 value_index = list->items[i].value_index;
2185 values = &entry->value_list;
2187 ctx.kvi = values->items[value_index].util;
2188 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2189 git_die_config_linenr(entry->key,
2190 ctx.kvi->filename,
2191 ctx.kvi->linenr);
2195 void read_early_config(config_fn_t cb, void *data)
2197 struct config_options opts = {0};
2198 struct strbuf commondir = STRBUF_INIT;
2199 struct strbuf gitdir = STRBUF_INIT;
2201 opts.respect_includes = 1;
2203 if (have_git_dir()) {
2204 opts.commondir = get_git_common_dir();
2205 opts.git_dir = get_git_dir();
2207 * When setup_git_directory() was not yet asked to discover the
2208 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2209 * is any repository config we should use (but unlike
2210 * setup_git_directory_gently(), no global state is changed, most
2211 * notably, the current working directory is still the same after the
2212 * call).
2214 } else if (!discover_git_directory(&commondir, &gitdir)) {
2215 opts.commondir = commondir.buf;
2216 opts.git_dir = gitdir.buf;
2219 config_with_options(cb, data, NULL, NULL, &opts);
2221 strbuf_release(&commondir);
2222 strbuf_release(&gitdir);
2226 * Read config but only enumerate system and global settings.
2227 * Omit any repo-local, worktree-local, or command-line settings.
2229 void read_very_early_config(config_fn_t cb, void *data)
2231 struct config_options opts = { 0 };
2233 opts.respect_includes = 1;
2234 opts.ignore_repo = 1;
2235 opts.ignore_worktree = 1;
2236 opts.ignore_cmdline = 1;
2237 opts.system_gently = 1;
2239 config_with_options(cb, data, NULL, NULL, &opts);
2242 RESULT_MUST_BE_USED
2243 static int configset_find_element(struct config_set *set, const char *key,
2244 struct config_set_element **dest)
2246 struct config_set_element k;
2247 struct config_set_element *found_entry;
2248 char *normalized_key;
2249 int ret;
2252 * `key` may come from the user, so normalize it before using it
2253 * for querying entries from the hashmap.
2255 ret = git_config_parse_key(key, &normalized_key, NULL);
2256 if (ret)
2257 return ret;
2259 hashmap_entry_init(&k.ent, strhash(normalized_key));
2260 k.key = normalized_key;
2261 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2262 free(normalized_key);
2263 *dest = found_entry;
2264 return 0;
2267 static int configset_add_value(const struct key_value_info *kvi_p,
2268 struct config_set *set, const char *key,
2269 const char *value)
2271 struct config_set_element *e;
2272 struct string_list_item *si;
2273 struct configset_list_item *l_item;
2274 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2275 int ret;
2277 ret = configset_find_element(set, key, &e);
2278 if (ret)
2279 return ret;
2281 * Since the keys are being fed by git_config*() callback mechanism, they
2282 * are already normalized. So simply add them without any further munging.
2284 if (!e) {
2285 e = xmalloc(sizeof(*e));
2286 hashmap_entry_init(&e->ent, strhash(key));
2287 e->key = xstrdup(key);
2288 string_list_init_dup(&e->value_list);
2289 hashmap_add(&set->config_hash, &e->ent);
2291 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2293 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2294 l_item = &set->list.items[set->list.nr++];
2295 l_item->e = e;
2296 l_item->value_index = e->value_list.nr - 1;
2298 *kv_info = *kvi_p;
2299 si->util = kv_info;
2301 return 0;
2304 static int config_set_element_cmp(const void *cmp_data UNUSED,
2305 const struct hashmap_entry *eptr,
2306 const struct hashmap_entry *entry_or_key,
2307 const void *keydata UNUSED)
2309 const struct config_set_element *e1, *e2;
2311 e1 = container_of(eptr, const struct config_set_element, ent);
2312 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2314 return strcmp(e1->key, e2->key);
2317 void git_configset_init(struct config_set *set)
2319 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2320 set->hash_initialized = 1;
2321 set->list.nr = 0;
2322 set->list.alloc = 0;
2323 set->list.items = NULL;
2326 void git_configset_clear(struct config_set *set)
2328 struct config_set_element *entry;
2329 struct hashmap_iter iter;
2330 if (!set->hash_initialized)
2331 return;
2333 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2334 ent /* member name */) {
2335 free(entry->key);
2336 string_list_clear(&entry->value_list, 1);
2338 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2339 set->hash_initialized = 0;
2340 free(set->list.items);
2341 set->list.nr = 0;
2342 set->list.alloc = 0;
2343 set->list.items = NULL;
2346 static int config_set_callback(const char *key, const char *value,
2347 const struct config_context *ctx,
2348 void *cb)
2350 struct config_set *set = cb;
2351 configset_add_value(ctx->kvi, set, key, value);
2352 return 0;
2355 int git_configset_add_file(struct config_set *set, const char *filename)
2357 return git_config_from_file(config_set_callback, filename, set);
2360 int git_configset_get_value(struct config_set *set, const char *key,
2361 const char **value, struct key_value_info *kvi)
2363 const struct string_list *values = NULL;
2364 int ret;
2365 struct string_list_item item;
2367 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2368 * queried key in the files of the configset, the value returned will be the last
2369 * value in the value list for that key.
2371 if ((ret = git_configset_get_value_multi(set, key, &values)))
2372 return ret;
2374 assert(values->nr > 0);
2375 item = values->items[values->nr - 1];
2376 *value = item.string;
2377 if (kvi)
2378 *kvi = *((struct key_value_info *)item.util);
2379 return 0;
2382 int git_configset_get_value_multi(struct config_set *set, const char *key,
2383 const struct string_list **dest)
2385 struct config_set_element *e;
2386 int ret;
2388 if ((ret = configset_find_element(set, key, &e)))
2389 return ret;
2390 else if (!e)
2391 return 1;
2392 *dest = &e->value_list;
2394 return 0;
2397 static int check_multi_string(struct string_list_item *item, void *util)
2399 return item->string ? 0 : config_error_nonbool(util);
2402 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2403 const struct string_list **dest)
2405 int ret;
2407 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2408 return ret;
2409 if ((ret = for_each_string_list((struct string_list *)*dest,
2410 check_multi_string, (void *)key)))
2411 return ret;
2413 return 0;
2416 int git_configset_get(struct config_set *set, const char *key)
2418 struct config_set_element *e;
2419 int ret;
2421 if ((ret = configset_find_element(set, key, &e)))
2422 return ret;
2423 else if (!e)
2424 return 1;
2425 return 0;
2428 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2430 const char *value;
2431 if (!git_configset_get_value(set, key, &value, NULL))
2432 return git_config_string(dest, key, value);
2433 else
2434 return 1;
2437 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2438 const char **dest)
2440 const char *value;
2441 if (!git_configset_get_value(set, key, &value, NULL)) {
2442 if (!value)
2443 return config_error_nonbool(key);
2444 *dest = value;
2445 return 0;
2446 } else {
2447 return 1;
2451 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2453 const char *value;
2454 struct key_value_info kvi;
2456 if (!git_configset_get_value(set, key, &value, &kvi)) {
2457 *dest = git_config_int(key, value, &kvi);
2458 return 0;
2459 } else
2460 return 1;
2463 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2465 const char *value;
2466 struct key_value_info kvi;
2468 if (!git_configset_get_value(set, key, &value, &kvi)) {
2469 *dest = git_config_ulong(key, value, &kvi);
2470 return 0;
2471 } else
2472 return 1;
2475 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2477 const char *value;
2478 if (!git_configset_get_value(set, key, &value, NULL)) {
2479 *dest = git_config_bool(key, value);
2480 return 0;
2481 } else
2482 return 1;
2485 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2486 int *is_bool, int *dest)
2488 const char *value;
2489 struct key_value_info kvi;
2491 if (!git_configset_get_value(set, key, &value, &kvi)) {
2492 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2493 return 0;
2494 } else
2495 return 1;
2498 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2500 const char *value;
2501 if (!git_configset_get_value(set, key, &value, NULL)) {
2502 *dest = git_parse_maybe_bool(value);
2503 if (*dest == -1)
2504 return -1;
2505 return 0;
2506 } else
2507 return 1;
2510 int git_configset_get_pathname(struct config_set *set, const char *key, char **dest)
2512 const char *value;
2513 if (!git_configset_get_value(set, key, &value, NULL))
2514 return git_config_pathname(dest, key, value);
2515 else
2516 return 1;
2519 /* Functions use to read configuration from a repository */
2520 static void repo_read_config(struct repository *repo)
2522 struct config_options opts = { 0 };
2524 opts.respect_includes = 1;
2525 opts.commondir = repo->commondir;
2526 opts.git_dir = repo->gitdir;
2528 if (!repo->config)
2529 CALLOC_ARRAY(repo->config, 1);
2530 else
2531 git_configset_clear(repo->config);
2533 git_configset_init(repo->config);
2534 if (config_with_options(config_set_callback, repo->config, NULL,
2535 repo, &opts) < 0)
2537 * config_with_options() normally returns only
2538 * zero, as most errors are fatal, and
2539 * non-fatal potential errors are guarded by "if"
2540 * statements that are entered only when no error is
2541 * possible.
2543 * If we ever encounter a non-fatal error, it means
2544 * something went really wrong and we should stop
2545 * immediately.
2547 die(_("unknown error occurred while reading the configuration files"));
2550 static void git_config_check_init(struct repository *repo)
2552 if (repo->config && repo->config->hash_initialized)
2553 return;
2554 repo_read_config(repo);
2557 static void repo_config_clear(struct repository *repo)
2559 if (!repo->config || !repo->config->hash_initialized)
2560 return;
2561 git_configset_clear(repo->config);
2564 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2566 git_config_check_init(repo);
2567 configset_iter(repo->config, fn, data);
2570 int repo_config_get(struct repository *repo, const char *key)
2572 git_config_check_init(repo);
2573 return git_configset_get(repo->config, key);
2576 int repo_config_get_value(struct repository *repo,
2577 const char *key, const char **value)
2579 git_config_check_init(repo);
2580 return git_configset_get_value(repo->config, key, value, NULL);
2583 int repo_config_get_value_multi(struct repository *repo, const char *key,
2584 const struct string_list **dest)
2586 git_config_check_init(repo);
2587 return git_configset_get_value_multi(repo->config, key, dest);
2590 int repo_config_get_string_multi(struct repository *repo, const char *key,
2591 const struct string_list **dest)
2593 git_config_check_init(repo);
2594 return git_configset_get_string_multi(repo->config, key, dest);
2597 int repo_config_get_string(struct repository *repo,
2598 const char *key, char **dest)
2600 int ret;
2601 git_config_check_init(repo);
2602 ret = git_configset_get_string(repo->config, key, dest);
2603 if (ret < 0)
2604 git_die_config(key, NULL);
2605 return ret;
2608 int repo_config_get_string_tmp(struct repository *repo,
2609 const char *key, const char **dest)
2611 int ret;
2612 git_config_check_init(repo);
2613 ret = git_configset_get_string_tmp(repo->config, key, dest);
2614 if (ret < 0)
2615 git_die_config(key, NULL);
2616 return ret;
2619 int repo_config_get_int(struct repository *repo,
2620 const char *key, int *dest)
2622 git_config_check_init(repo);
2623 return git_configset_get_int(repo->config, key, dest);
2626 int repo_config_get_ulong(struct repository *repo,
2627 const char *key, unsigned long *dest)
2629 git_config_check_init(repo);
2630 return git_configset_get_ulong(repo->config, key, dest);
2633 int repo_config_get_bool(struct repository *repo,
2634 const char *key, int *dest)
2636 git_config_check_init(repo);
2637 return git_configset_get_bool(repo->config, key, dest);
2640 int repo_config_get_bool_or_int(struct repository *repo,
2641 const char *key, int *is_bool, int *dest)
2643 git_config_check_init(repo);
2644 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2647 int repo_config_get_maybe_bool(struct repository *repo,
2648 const char *key, int *dest)
2650 git_config_check_init(repo);
2651 return git_configset_get_maybe_bool(repo->config, key, dest);
2654 int repo_config_get_pathname(struct repository *repo,
2655 const char *key, char **dest)
2657 int ret;
2658 git_config_check_init(repo);
2659 ret = git_configset_get_pathname(repo->config, key, dest);
2660 if (ret < 0)
2661 git_die_config(key, NULL);
2662 return ret;
2665 /* Read values into protected_config. */
2666 static void read_protected_config(void)
2668 struct config_options opts = {
2669 .respect_includes = 1,
2670 .ignore_repo = 1,
2671 .ignore_worktree = 1,
2672 .system_gently = 1,
2675 git_configset_init(&protected_config);
2676 config_with_options(config_set_callback, &protected_config, NULL,
2677 NULL, &opts);
2680 void git_protected_config(config_fn_t fn, void *data)
2682 if (!protected_config.hash_initialized)
2683 read_protected_config();
2684 configset_iter(&protected_config, fn, data);
2687 /* Functions used historically to read configuration from 'the_repository' */
2688 void git_config(config_fn_t fn, void *data)
2690 repo_config(the_repository, fn, data);
2693 void git_config_clear(void)
2695 repo_config_clear(the_repository);
2698 int git_config_get(const char *key)
2700 return repo_config_get(the_repository, key);
2703 int git_config_get_value(const char *key, const char **value)
2705 return repo_config_get_value(the_repository, key, value);
2708 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2710 return repo_config_get_value_multi(the_repository, key, dest);
2713 int git_config_get_string_multi(const char *key,
2714 const struct string_list **dest)
2716 return repo_config_get_string_multi(the_repository, key, dest);
2719 int git_config_get_string(const char *key, char **dest)
2721 return repo_config_get_string(the_repository, key, dest);
2724 int git_config_get_string_tmp(const char *key, const char **dest)
2726 return repo_config_get_string_tmp(the_repository, key, dest);
2729 int git_config_get_int(const char *key, int *dest)
2731 return repo_config_get_int(the_repository, key, dest);
2734 int git_config_get_ulong(const char *key, unsigned long *dest)
2736 return repo_config_get_ulong(the_repository, key, dest);
2739 int git_config_get_bool(const char *key, int *dest)
2741 return repo_config_get_bool(the_repository, key, dest);
2744 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2746 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2749 int git_config_get_maybe_bool(const char *key, int *dest)
2751 return repo_config_get_maybe_bool(the_repository, key, dest);
2754 int git_config_get_pathname(const char *key, char **dest)
2756 return repo_config_get_pathname(the_repository, key, dest);
2759 int git_config_get_expiry(const char *key, const char **output)
2761 int ret = git_config_get_string(key, (char **)output);
2762 if (ret)
2763 return ret;
2764 if (strcmp(*output, "now")) {
2765 timestamp_t now = approxidate("now");
2766 if (approxidate(*output) >= now)
2767 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2769 return ret;
2772 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2774 const char *expiry_string;
2775 intmax_t days;
2776 timestamp_t when;
2778 if (git_config_get_string_tmp(key, &expiry_string))
2779 return 1; /* no such thing */
2781 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2782 const int scale = 86400;
2783 *expiry = now - days * scale;
2784 return 0;
2787 if (!parse_expiry_date(expiry_string, &when)) {
2788 *expiry = when;
2789 return 0;
2791 return -1; /* thing exists but cannot be parsed */
2794 int git_config_get_split_index(void)
2796 int val;
2798 if (!git_config_get_maybe_bool("core.splitindex", &val))
2799 return val;
2801 return -1; /* default value */
2804 int git_config_get_max_percent_split_change(void)
2806 int val = -1;
2808 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2809 if (0 <= val && val <= 100)
2810 return val;
2812 return error(_("splitIndex.maxPercentChange value '%d' "
2813 "should be between 0 and 100"), val);
2816 return -1; /* default value */
2819 int git_config_get_index_threads(int *dest)
2821 int is_bool, val;
2823 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2824 if (val) {
2825 *dest = val;
2826 return 0;
2829 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2830 if (is_bool)
2831 *dest = val ? 0 : 1;
2832 else
2833 *dest = val;
2834 return 0;
2837 return 1;
2840 NORETURN
2841 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2843 if (!filename)
2844 die(_("unable to parse '%s' from command-line config"), key);
2845 else
2846 die(_("bad config variable '%s' in file '%s' at line %d"),
2847 key, filename, linenr);
2850 NORETURN __attribute__((format(printf, 2, 3)))
2851 void git_die_config(const char *key, const char *err, ...)
2853 const struct string_list *values;
2854 struct key_value_info *kv_info;
2855 report_fn error_fn = get_error_routine();
2857 if (err) {
2858 va_list params;
2859 va_start(params, err);
2860 error_fn(err, params);
2861 va_end(params);
2863 if (git_config_get_value_multi(key, &values))
2864 BUG("for key '%s' we must have a value to report on", key);
2865 kv_info = values->items[values->nr - 1].util;
2866 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2870 * Find all the stuff for git_config_set() below.
2873 struct config_store_data {
2874 size_t baselen;
2875 char *key;
2876 int do_not_match;
2877 const char *fixed_value;
2878 regex_t *value_pattern;
2879 int multi_replace;
2880 struct {
2881 size_t begin, end;
2882 enum config_event_t type;
2883 int is_keys_section;
2884 } *parsed;
2885 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2886 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2888 #define CONFIG_STORE_INIT { 0 }
2890 static void config_store_data_clear(struct config_store_data *store)
2892 free(store->key);
2893 if (store->value_pattern != NULL &&
2894 store->value_pattern != CONFIG_REGEX_NONE) {
2895 regfree(store->value_pattern);
2896 free(store->value_pattern);
2898 free(store->parsed);
2899 free(store->seen);
2900 memset(store, 0, sizeof(*store));
2903 static int matches(const char *key, const char *value,
2904 const struct config_store_data *store)
2906 if (strcmp(key, store->key))
2907 return 0; /* not ours */
2908 if (store->fixed_value)
2909 return !strcmp(store->fixed_value, value);
2910 if (!store->value_pattern)
2911 return 1; /* always matches */
2912 if (store->value_pattern == CONFIG_REGEX_NONE)
2913 return 0; /* never matches */
2915 return store->do_not_match ^
2916 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2919 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2920 struct config_source *cs, void *data)
2922 struct config_store_data *store = data;
2924 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2925 store->parsed[store->parsed_nr].begin = begin;
2926 store->parsed[store->parsed_nr].end = end;
2927 store->parsed[store->parsed_nr].type = type;
2929 if (type == CONFIG_EVENT_SECTION) {
2930 int (*cmpfn)(const char *, const char *, size_t);
2932 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2933 return error(_("invalid section name '%s'"), cs->var.buf);
2935 if (cs->subsection_case_sensitive)
2936 cmpfn = strncasecmp;
2937 else
2938 cmpfn = strncmp;
2940 /* Is this the section we were looking for? */
2941 store->is_keys_section =
2942 store->parsed[store->parsed_nr].is_keys_section =
2943 cs->var.len - 1 == store->baselen &&
2944 !cmpfn(cs->var.buf, store->key, store->baselen);
2945 if (store->is_keys_section) {
2946 store->section_seen = 1;
2947 ALLOC_GROW(store->seen, store->seen_nr + 1,
2948 store->seen_alloc);
2949 store->seen[store->seen_nr] = store->parsed_nr;
2953 store->parsed_nr++;
2955 return 0;
2958 static int store_aux(const char *key, const char *value,
2959 const struct config_context *ctx UNUSED, void *cb)
2961 struct config_store_data *store = cb;
2963 if (store->key_seen) {
2964 if (matches(key, value, store)) {
2965 if (store->seen_nr == 1 && store->multi_replace == 0) {
2966 warning(_("%s has multiple values"), key);
2969 ALLOC_GROW(store->seen, store->seen_nr + 1,
2970 store->seen_alloc);
2972 store->seen[store->seen_nr] = store->parsed_nr;
2973 store->seen_nr++;
2975 } else if (store->is_keys_section) {
2977 * Do not increment matches yet: this may not be a match, but we
2978 * are in the desired section.
2980 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2981 store->seen[store->seen_nr] = store->parsed_nr;
2982 store->section_seen = 1;
2984 if (matches(key, value, store)) {
2985 store->seen_nr++;
2986 store->key_seen = 1;
2990 return 0;
2993 static int write_error(const char *filename)
2995 error(_("failed to write new configuration file %s"), filename);
2997 /* Same error code as "failed to rename". */
2998 return 4;
3001 static struct strbuf store_create_section(const char *key,
3002 const struct config_store_data *store)
3004 const char *dot;
3005 size_t i;
3006 struct strbuf sb = STRBUF_INIT;
3008 dot = memchr(key, '.', store->baselen);
3009 if (dot) {
3010 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
3011 for (i = dot - key + 1; i < store->baselen; i++) {
3012 if (key[i] == '"' || key[i] == '\\')
3013 strbuf_addch(&sb, '\\');
3014 strbuf_addch(&sb, key[i]);
3016 strbuf_addstr(&sb, "\"]\n");
3017 } else {
3018 strbuf_addch(&sb, '[');
3019 strbuf_add(&sb, key, store->baselen);
3020 strbuf_addstr(&sb, "]\n");
3023 return sb;
3026 static ssize_t write_section(int fd, const char *key,
3027 const struct config_store_data *store)
3029 struct strbuf sb = store_create_section(key, store);
3030 ssize_t ret;
3032 ret = write_in_full(fd, sb.buf, sb.len);
3033 strbuf_release(&sb);
3035 return ret;
3038 static ssize_t write_pair(int fd, const char *key, const char *value,
3039 const char *comment,
3040 const struct config_store_data *store)
3042 int i;
3043 ssize_t ret;
3044 const char *quote = "";
3045 struct strbuf sb = STRBUF_INIT;
3048 * Check to see if the value needs to be surrounded with a dq pair.
3049 * Note that problematic characters are always backslash-quoted; this
3050 * check is about not losing leading or trailing SP and strings that
3051 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3052 * configuration parser.
3054 if (value[0] == ' ')
3055 quote = "\"";
3056 for (i = 0; value[i]; i++)
3057 if (value[i] == ';' || value[i] == '#')
3058 quote = "\"";
3059 if (i && value[i - 1] == ' ')
3060 quote = "\"";
3062 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3064 for (i = 0; value[i]; i++)
3065 switch (value[i]) {
3066 case '\n':
3067 strbuf_addstr(&sb, "\\n");
3068 break;
3069 case '\t':
3070 strbuf_addstr(&sb, "\\t");
3071 break;
3072 case '"':
3073 case '\\':
3074 strbuf_addch(&sb, '\\');
3075 /* fallthrough */
3076 default:
3077 strbuf_addch(&sb, value[i]);
3078 break;
3081 if (comment)
3082 strbuf_addf(&sb, "%s%s\n", quote, comment);
3083 else
3084 strbuf_addf(&sb, "%s\n", quote);
3086 ret = write_in_full(fd, sb.buf, sb.len);
3087 strbuf_release(&sb);
3089 return ret;
3093 * If we are about to unset the last key(s) in a section, and if there are
3094 * no comments surrounding (or included in) the section, we will want to
3095 * extend begin/end to remove the entire section.
3097 * Note: the parameter `seen_ptr` points to the index into the store.seen
3098 * array. * This index may be incremented if a section has more than one
3099 * entry (which all are to be removed).
3101 static void maybe_remove_section(struct config_store_data *store,
3102 size_t *begin_offset, size_t *end_offset,
3103 int *seen_ptr)
3105 size_t begin;
3106 int i, seen, section_seen = 0;
3109 * First, ensure that this is the first key, and that there are no
3110 * comments before the entry nor before the section header.
3112 seen = *seen_ptr;
3113 for (i = store->seen[seen]; i > 0; i--) {
3114 enum config_event_t type = store->parsed[i - 1].type;
3116 if (type == CONFIG_EVENT_COMMENT)
3117 /* There is a comment before this entry or section */
3118 return;
3119 if (type == CONFIG_EVENT_ENTRY) {
3120 if (!section_seen)
3121 /* This is not the section's first entry. */
3122 return;
3123 /* We encountered no comment before the section. */
3124 break;
3126 if (type == CONFIG_EVENT_SECTION) {
3127 if (!store->parsed[i - 1].is_keys_section)
3128 break;
3129 section_seen = 1;
3132 begin = store->parsed[i].begin;
3135 * Next, make sure that we are removing the last key(s) in the section,
3136 * and that there are no comments that are possibly about the current
3137 * section.
3139 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3140 enum config_event_t type = store->parsed[i].type;
3142 if (type == CONFIG_EVENT_COMMENT)
3143 return;
3144 if (type == CONFIG_EVENT_SECTION) {
3145 if (store->parsed[i].is_keys_section)
3146 continue;
3147 break;
3149 if (type == CONFIG_EVENT_ENTRY) {
3150 if (++seen < store->seen_nr &&
3151 i == store->seen[seen])
3152 /* We want to remove this entry, too */
3153 continue;
3154 /* There is another entry in this section. */
3155 return;
3160 * We are really removing the last entry/entries from this section, and
3161 * there are no enclosed or surrounding comments. Remove the entire,
3162 * now-empty section.
3164 *seen_ptr = seen;
3165 *begin_offset = begin;
3166 if (i < store->parsed_nr)
3167 *end_offset = store->parsed[i].begin;
3168 else
3169 *end_offset = store->parsed[store->parsed_nr - 1].end;
3172 int git_config_set_in_file_gently(const char *config_filename,
3173 const char *key, const char *comment, const char *value)
3175 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, comment, 0);
3178 void git_config_set_in_file(const char *config_filename,
3179 const char *key, const char *value)
3181 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3184 int git_config_set_gently(const char *key, const char *value)
3186 return git_config_set_multivar_gently(key, value, NULL, 0);
3189 int repo_config_set_worktree_gently(struct repository *r,
3190 const char *key, const char *value)
3192 /* Only use worktree-specific config if it is already enabled. */
3193 if (r->repository_format_worktree_config) {
3194 char *file = repo_git_path(r, "config.worktree");
3195 int ret = git_config_set_multivar_in_file_gently(
3196 file, key, value, NULL, NULL, 0);
3197 free(file);
3198 return ret;
3200 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3203 void git_config_set(const char *key, const char *value)
3205 git_config_set_multivar(key, value, NULL, 0);
3207 trace2_cmd_set_config(key, value);
3210 char *git_config_prepare_comment_string(const char *comment)
3212 size_t leading_blanks;
3213 char *prepared;
3215 if (!comment)
3216 return NULL;
3218 if (strchr(comment, '\n'))
3219 die(_("no multi-line comment allowed: '%s'"), comment);
3222 * If it begins with one or more leading whitespace characters
3223 * followed by '#", the comment string is used as-is.
3225 * If it begins with '#', a SP is inserted between the comment
3226 * and the value the comment is about.
3228 * Otherwise, the value is followed by a SP followed by '#'
3229 * followed by SP and then the comment string comes.
3232 leading_blanks = strspn(comment, " \t");
3233 if (leading_blanks && comment[leading_blanks] == '#')
3234 prepared = xstrdup(comment); /* use it as-is */
3235 else if (comment[0] == '#')
3236 prepared = xstrfmt(" %s", comment);
3237 else
3238 prepared = xstrfmt(" # %s", comment);
3240 return prepared;
3243 static void validate_comment_string(const char *comment)
3245 size_t leading_blanks;
3247 if (!comment)
3248 return;
3250 * The front-end must have massaged the comment string
3251 * properly before calling us.
3253 if (strchr(comment, '\n'))
3254 BUG("multi-line comments are not permitted: '%s'", comment);
3256 leading_blanks = strspn(comment, " \t");
3257 if (!leading_blanks || comment[leading_blanks] != '#')
3258 BUG("comment must begin with one or more SP followed by '#': '%s'",
3259 comment);
3263 * If value==NULL, unset in (remove from) config,
3264 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3265 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3266 * (only add a new one)
3267 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3268 * key/values are removed before a single new pair is written. If the
3269 * flag is not present, then replace only the first match.
3271 * Returns 0 on success.
3273 * This function does this:
3275 * - it locks the config file by creating ".git/config.lock"
3277 * - it then parses the config using store_aux() as validator to find
3278 * the position on the key/value pair to replace. If it is to be unset,
3279 * it must be found exactly once.
3281 * - the config file is mmap()ed and the part before the match (if any) is
3282 * written to the lock file, then the changed part and the rest.
3284 * - the config file is removed and the lock file rename()d to it.
3287 int git_config_set_multivar_in_file_gently(const char *config_filename,
3288 const char *key, const char *value,
3289 const char *value_pattern,
3290 const char *comment,
3291 unsigned flags)
3293 int fd = -1, in_fd = -1;
3294 int ret;
3295 struct lock_file lock = LOCK_INIT;
3296 char *filename_buf = NULL;
3297 char *contents = NULL;
3298 size_t contents_sz;
3299 struct config_store_data store = CONFIG_STORE_INIT;
3301 validate_comment_string(comment);
3303 /* parse-key returns negative; flip the sign to feed exit(3) */
3304 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3305 if (ret)
3306 goto out_free;
3308 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3310 if (!config_filename)
3311 config_filename = filename_buf = git_pathdup("config");
3314 * The lock serves a purpose in addition to locking: the new
3315 * contents of .git/config will be written into it.
3317 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3318 if (fd < 0) {
3319 error_errno(_("could not lock config file %s"), config_filename);
3320 ret = CONFIG_NO_LOCK;
3321 goto out_free;
3325 * If .git/config does not exist yet, write a minimal version.
3327 in_fd = open(config_filename, O_RDONLY);
3328 if ( in_fd < 0 ) {
3329 if ( ENOENT != errno ) {
3330 error_errno(_("opening %s"), config_filename);
3331 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3332 goto out_free;
3334 /* if nothing to unset, error out */
3335 if (!value) {
3336 ret = CONFIG_NOTHING_SET;
3337 goto out_free;
3340 free(store.key);
3341 store.key = xstrdup(key);
3342 if (write_section(fd, key, &store) < 0 ||
3343 write_pair(fd, key, value, comment, &store) < 0)
3344 goto write_err_out;
3345 } else {
3346 struct stat st;
3347 size_t copy_begin, copy_end;
3348 int i, new_line = 0;
3349 struct config_options opts;
3351 if (!value_pattern)
3352 store.value_pattern = NULL;
3353 else if (value_pattern == CONFIG_REGEX_NONE)
3354 store.value_pattern = CONFIG_REGEX_NONE;
3355 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3356 store.fixed_value = value_pattern;
3357 else {
3358 if (value_pattern[0] == '!') {
3359 store.do_not_match = 1;
3360 value_pattern++;
3361 } else
3362 store.do_not_match = 0;
3364 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3365 if (regcomp(store.value_pattern, value_pattern,
3366 REG_EXTENDED)) {
3367 error(_("invalid pattern: %s"), value_pattern);
3368 FREE_AND_NULL(store.value_pattern);
3369 ret = CONFIG_INVALID_PATTERN;
3370 goto out_free;
3374 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3375 store.parsed[0].end = 0;
3377 memset(&opts, 0, sizeof(opts));
3378 opts.event_fn = store_aux_event;
3379 opts.event_fn_data = &store;
3382 * After this, store.parsed will contain offsets of all the
3383 * parsed elements, and store.seen will contain a list of
3384 * matches, as indices into store.parsed.
3386 * As a side effect, we make sure to transform only a valid
3387 * existing config file.
3389 if (git_config_from_file_with_options(store_aux,
3390 config_filename,
3391 &store, CONFIG_SCOPE_UNKNOWN,
3392 &opts)) {
3393 error(_("invalid config file %s"), config_filename);
3394 ret = CONFIG_INVALID_FILE;
3395 goto out_free;
3398 /* if nothing to unset, or too many matches, error out */
3399 if ((store.seen_nr == 0 && value == NULL) ||
3400 (store.seen_nr > 1 && !store.multi_replace)) {
3401 ret = CONFIG_NOTHING_SET;
3402 goto out_free;
3405 if (fstat(in_fd, &st) == -1) {
3406 error_errno(_("fstat on %s failed"), config_filename);
3407 ret = CONFIG_INVALID_FILE;
3408 goto out_free;
3411 contents_sz = xsize_t(st.st_size);
3412 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3413 MAP_PRIVATE, in_fd, 0);
3414 if (contents == MAP_FAILED) {
3415 if (errno == ENODEV && S_ISDIR(st.st_mode))
3416 errno = EISDIR;
3417 error_errno(_("unable to mmap '%s'%s"),
3418 config_filename, mmap_os_err());
3419 ret = CONFIG_INVALID_FILE;
3420 contents = NULL;
3421 goto out_free;
3423 close(in_fd);
3424 in_fd = -1;
3426 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3427 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3428 ret = CONFIG_NO_WRITE;
3429 goto out_free;
3432 if (store.seen_nr == 0) {
3433 if (!store.seen_alloc) {
3434 /* Did not see key nor section */
3435 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3436 store.seen[0] = store.parsed_nr
3437 - !!store.parsed_nr;
3439 store.seen_nr = 1;
3442 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3443 size_t replace_end;
3444 int j = store.seen[i];
3446 new_line = 0;
3447 if (!store.key_seen) {
3448 copy_end = store.parsed[j].end;
3449 /* include '\n' when copying section header */
3450 if (copy_end > 0 && copy_end < contents_sz &&
3451 contents[copy_end - 1] != '\n' &&
3452 contents[copy_end] == '\n')
3453 copy_end++;
3454 replace_end = copy_end;
3455 } else {
3456 replace_end = store.parsed[j].end;
3457 copy_end = store.parsed[j].begin;
3458 if (!value)
3459 maybe_remove_section(&store,
3460 &copy_end,
3461 &replace_end, &i);
3463 * Swallow preceding white-space on the same
3464 * line.
3466 while (copy_end > 0 ) {
3467 char c = contents[copy_end - 1];
3469 if (isspace(c) && c != '\n')
3470 copy_end--;
3471 else
3472 break;
3476 if (copy_end > 0 && contents[copy_end-1] != '\n')
3477 new_line = 1;
3479 /* write the first part of the config */
3480 if (copy_end > copy_begin) {
3481 if (write_in_full(fd, contents + copy_begin,
3482 copy_end - copy_begin) < 0)
3483 goto write_err_out;
3484 if (new_line &&
3485 write_str_in_full(fd, "\n") < 0)
3486 goto write_err_out;
3488 copy_begin = replace_end;
3491 /* write the pair (value == NULL means unset) */
3492 if (value) {
3493 if (!store.section_seen) {
3494 if (write_section(fd, key, &store) < 0)
3495 goto write_err_out;
3497 if (write_pair(fd, key, value, comment, &store) < 0)
3498 goto write_err_out;
3501 /* write the rest of the config */
3502 if (copy_begin < contents_sz)
3503 if (write_in_full(fd, contents + copy_begin,
3504 contents_sz - copy_begin) < 0)
3505 goto write_err_out;
3507 munmap(contents, contents_sz);
3508 contents = NULL;
3511 if (commit_lock_file(&lock) < 0) {
3512 error_errno(_("could not write config file %s"), config_filename);
3513 ret = CONFIG_NO_WRITE;
3514 goto out_free;
3517 ret = 0;
3519 /* Invalidate the config cache */
3520 git_config_clear();
3522 out_free:
3523 rollback_lock_file(&lock);
3524 free(filename_buf);
3525 if (contents)
3526 munmap(contents, contents_sz);
3527 if (in_fd >= 0)
3528 close(in_fd);
3529 config_store_data_clear(&store);
3530 return ret;
3532 write_err_out:
3533 ret = write_error(get_lock_file_path(&lock));
3534 goto out_free;
3537 void git_config_set_multivar_in_file(const char *config_filename,
3538 const char *key, const char *value,
3539 const char *value_pattern, unsigned flags)
3541 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3542 value_pattern, NULL, flags))
3543 return;
3544 if (value)
3545 die(_("could not set '%s' to '%s'"), key, value);
3546 else
3547 die(_("could not unset '%s'"), key);
3550 int git_config_set_multivar_gently(const char *key, const char *value,
3551 const char *value_pattern, unsigned flags)
3553 return repo_config_set_multivar_gently(the_repository, key, value,
3554 value_pattern, flags);
3557 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3558 const char *value,
3559 const char *value_pattern, unsigned flags)
3561 char *file = repo_git_path(r, "config");
3562 int res = git_config_set_multivar_in_file_gently(file,
3563 key, value,
3564 value_pattern,
3565 NULL, flags);
3566 free(file);
3567 return res;
3570 void git_config_set_multivar(const char *key, const char *value,
3571 const char *value_pattern, unsigned flags)
3573 git_config_set_multivar_in_file(git_path("config"),
3574 key, value, value_pattern,
3575 flags);
3578 static size_t section_name_match (const char *buf, const char *name)
3580 size_t i = 0, j = 0;
3581 int dot = 0;
3582 if (buf[i] != '[')
3583 return 0;
3584 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3585 if (!dot && isspace(buf[i])) {
3586 dot = 1;
3587 if (name[j++] != '.')
3588 break;
3589 for (i++; isspace(buf[i]); i++)
3590 ; /* do nothing */
3591 if (buf[i] != '"')
3592 break;
3593 continue;
3595 if (buf[i] == '\\' && dot)
3596 i++;
3597 else if (buf[i] == '"' && dot) {
3598 for (i++; isspace(buf[i]); i++)
3599 ; /* do_nothing */
3600 break;
3602 if (buf[i] != name[j++])
3603 break;
3605 if (buf[i] == ']' && name[j] == 0) {
3607 * We match, now just find the right length offset by
3608 * gobbling up any whitespace after it, as well
3610 i++;
3611 for (; buf[i] && isspace(buf[i]); i++)
3612 ; /* do nothing */
3613 return i;
3615 return 0;
3618 static int section_name_is_ok(const char *name)
3620 /* Empty section names are bogus. */
3621 if (!*name)
3622 return 0;
3625 * Before a dot, we must be alphanumeric or dash. After the first dot,
3626 * anything goes, so we can stop checking.
3628 for (; *name && *name != '.'; name++)
3629 if (*name != '-' && !isalnum(*name))
3630 return 0;
3631 return 1;
3634 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3636 /* if new_name == NULL, the section is removed instead */
3637 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3638 const char *old_name,
3639 const char *new_name, int copy)
3641 int ret = 0, remove = 0;
3642 char *filename_buf = NULL;
3643 struct lock_file lock = LOCK_INIT;
3644 int out_fd;
3645 struct strbuf buf = STRBUF_INIT;
3646 FILE *config_file = NULL;
3647 struct stat st;
3648 struct strbuf copystr = STRBUF_INIT;
3649 struct config_store_data store;
3650 uint32_t line_nr = 0;
3652 memset(&store, 0, sizeof(store));
3654 if (new_name && !section_name_is_ok(new_name)) {
3655 ret = error(_("invalid section name: %s"), new_name);
3656 goto out_no_rollback;
3659 if (!config_filename)
3660 config_filename = filename_buf = git_pathdup("config");
3662 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3663 if (out_fd < 0) {
3664 ret = error(_("could not lock config file %s"), config_filename);
3665 goto out;
3668 if (!(config_file = fopen(config_filename, "rb"))) {
3669 ret = warn_on_fopen_errors(config_filename);
3670 if (ret)
3671 goto out;
3672 /* no config file means nothing to rename, no error */
3673 goto commit_and_out;
3676 if (fstat(fileno(config_file), &st) == -1) {
3677 ret = error_errno(_("fstat on %s failed"), config_filename);
3678 goto out;
3681 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3682 ret = error_errno(_("chmod on %s failed"),
3683 get_lock_file_path(&lock));
3684 goto out;
3687 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3688 size_t i, length;
3689 int is_section = 0;
3690 char *output = buf.buf;
3692 line_nr++;
3694 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3695 ret = error(_("refusing to work with overly long line "
3696 "in '%s' on line %"PRIuMAX),
3697 config_filename, (uintmax_t)line_nr);
3698 goto out;
3701 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3702 ; /* do nothing */
3703 if (buf.buf[i] == '[') {
3704 /* it's a section */
3705 size_t offset;
3706 is_section = 1;
3709 * When encountering a new section under -c we
3710 * need to flush out any section we're already
3711 * coping and begin anew. There might be
3712 * multiple [branch "$name"] sections.
3714 if (copystr.len > 0) {
3715 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3716 ret = write_error(get_lock_file_path(&lock));
3717 goto out;
3719 strbuf_reset(&copystr);
3722 offset = section_name_match(&buf.buf[i], old_name);
3723 if (offset > 0) {
3724 ret++;
3725 if (!new_name) {
3726 remove = 1;
3727 continue;
3729 store.baselen = strlen(new_name);
3730 if (!copy) {
3731 if (write_section(out_fd, new_name, &store) < 0) {
3732 ret = write_error(get_lock_file_path(&lock));
3733 goto out;
3736 * We wrote out the new section, with
3737 * a newline, now skip the old
3738 * section's length
3740 output += offset + i;
3741 if (strlen(output) > 0) {
3743 * More content means there's
3744 * a declaration to put on the
3745 * next line; indent with a
3746 * tab
3748 output -= 1;
3749 output[0] = '\t';
3751 } else {
3752 strbuf_release(&copystr);
3753 copystr = store_create_section(new_name, &store);
3756 remove = 0;
3758 if (remove)
3759 continue;
3760 length = strlen(output);
3762 if (!is_section && copystr.len > 0) {
3763 strbuf_add(&copystr, output, length);
3766 if (write_in_full(out_fd, output, length) < 0) {
3767 ret = write_error(get_lock_file_path(&lock));
3768 goto out;
3773 * Copy a trailing section at the end of the config, won't be
3774 * flushed by the usual "flush because we have a new section
3775 * logic in the loop above.
3777 if (copystr.len > 0) {
3778 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3779 ret = write_error(get_lock_file_path(&lock));
3780 goto out;
3782 strbuf_reset(&copystr);
3785 fclose(config_file);
3786 config_file = NULL;
3787 commit_and_out:
3788 if (commit_lock_file(&lock) < 0)
3789 ret = error_errno(_("could not write config file %s"),
3790 config_filename);
3791 out:
3792 if (config_file)
3793 fclose(config_file);
3794 rollback_lock_file(&lock);
3795 out_no_rollback:
3796 free(filename_buf);
3797 config_store_data_clear(&store);
3798 strbuf_release(&buf);
3799 strbuf_release(&copystr);
3800 return ret;
3803 int git_config_rename_section_in_file(const char *config_filename,
3804 const char *old_name, const char *new_name)
3806 return git_config_copy_or_rename_section_in_file(config_filename,
3807 old_name, new_name, 0);
3810 int git_config_rename_section(const char *old_name, const char *new_name)
3812 return git_config_rename_section_in_file(NULL, old_name, new_name);
3815 int git_config_copy_section_in_file(const char *config_filename,
3816 const char *old_name, const char *new_name)
3818 return git_config_copy_or_rename_section_in_file(config_filename,
3819 old_name, new_name, 1);
3822 int git_config_copy_section(const char *old_name, const char *new_name)
3824 return git_config_copy_section_in_file(NULL, old_name, new_name);
3828 * Call this to report error for your variable that should not
3829 * get a boolean value (i.e. "[my] var" means "true").
3831 #undef config_error_nonbool
3832 int config_error_nonbool(const char *var)
3834 return error(_("missing value for '%s'"), var);
3837 int parse_config_key(const char *var,
3838 const char *section,
3839 const char **subsection, size_t *subsection_len,
3840 const char **key)
3842 const char *dot;
3844 /* Does it start with "section." ? */
3845 if (!skip_prefix(var, section, &var) || *var != '.')
3846 return -1;
3849 * Find the key; we don't know yet if we have a subsection, but we must
3850 * parse backwards from the end, since the subsection may have dots in
3851 * it, too.
3853 dot = strrchr(var, '.');
3854 *key = dot + 1;
3856 /* Did we have a subsection at all? */
3857 if (dot == var) {
3858 if (subsection) {
3859 *subsection = NULL;
3860 *subsection_len = 0;
3863 else {
3864 if (!subsection)
3865 return -1;
3866 *subsection = var + 1;
3867 *subsection_len = dot - *subsection;
3870 return 0;
3873 const char *config_origin_type_name(enum config_origin_type type)
3875 switch (type) {
3876 case CONFIG_ORIGIN_BLOB:
3877 return "blob";
3878 case CONFIG_ORIGIN_FILE:
3879 return "file";
3880 case CONFIG_ORIGIN_STDIN:
3881 return "standard input";
3882 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3883 return "submodule-blob";
3884 case CONFIG_ORIGIN_CMDLINE:
3885 return "command line";
3886 default:
3887 BUG("unknown config origin type");
3891 const char *config_scope_name(enum config_scope scope)
3893 switch (scope) {
3894 case CONFIG_SCOPE_SYSTEM:
3895 return "system";
3896 case CONFIG_SCOPE_GLOBAL:
3897 return "global";
3898 case CONFIG_SCOPE_LOCAL:
3899 return "local";
3900 case CONFIG_SCOPE_WORKTREE:
3901 return "worktree";
3902 case CONFIG_SCOPE_COMMAND:
3903 return "command";
3904 case CONFIG_SCOPE_SUBMODULE:
3905 return "submodule";
3906 default:
3907 return "unknown";
3911 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3913 int i;
3915 for (i = 0; i < nr_mapping; i++) {
3916 const char *name = mapping[i];
3918 if (name && !strcasecmp(var, name))
3919 return i;
3921 return -1;