Merge branch 'tb/enable-cruft-packs-by-default'
[git.git] / config.c
blob43b0d3fb573330f01c2d48378a9fc2ea3f426fe3
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "abspath.h"
10 #include "advice.h"
11 #include "alloc.h"
12 #include "date.h"
13 #include "branch.h"
14 #include "config.h"
15 #include "convert.h"
16 #include "environment.h"
17 #include "gettext.h"
18 #include "ident.h"
19 #include "repository.h"
20 #include "lockfile.h"
21 #include "mailmap.h"
22 #include "exec-cmd.h"
23 #include "strbuf.h"
24 #include "quote.h"
25 #include "hashmap.h"
26 #include "string-list.h"
27 #include "object-name.h"
28 #include "object-store.h"
29 #include "pager.h"
30 #include "utf8.h"
31 #include "dir.h"
32 #include "color.h"
33 #include "replace-object.h"
34 #include "refs.h"
35 #include "setup.h"
36 #include "trace2.h"
37 #include "worktree.h"
38 #include "wrapper.h"
39 #include "write-or-die.h"
41 struct config_source {
42 struct config_source *prev;
43 union {
44 FILE *file;
45 struct config_buf {
46 const char *buf;
47 size_t len;
48 size_t pos;
49 } buf;
50 } u;
51 enum config_origin_type origin_type;
52 const char *name;
53 const char *path;
54 enum config_error_action default_error_action;
55 int linenr;
56 int eof;
57 size_t total_len;
58 struct strbuf value;
59 struct strbuf var;
60 unsigned subsection_case_sensitive : 1;
62 int (*do_fgetc)(struct config_source *c);
63 int (*do_ungetc)(int c, struct config_source *conf);
64 long (*do_ftell)(struct config_source *c);
66 #define CONFIG_SOURCE_INIT { 0 }
68 struct config_reader {
70 * These members record the "current" config source, which can be
71 * accessed by parsing callbacks.
73 * The "source" variable will be non-NULL only when we are actually
74 * parsing a real config source (file, blob, cmdline, etc).
76 * The "config_kvi" variable will be non-NULL only when we are feeding
77 * cached config from a configset into a callback.
79 * They cannot be non-NULL at the same time. If they are both NULL, then
80 * we aren't parsing anything (and depending on the function looking at
81 * the variables, it's either a bug for it to be called in the first
82 * place, or it's a function which can be reused for non-config
83 * purposes, and should fall back to some sane behavior).
85 struct config_source *source;
86 struct key_value_info *config_kvi;
88 * The "scope" of the current config source being parsed (repo, global,
89 * etc). Like "source", this is only set when parsing a config source.
90 * It's not part of "source" because it transcends a single file (i.e.,
91 * a file included from .git/config is still in "repo" scope).
93 * When iterating through a configset, the equivalent value is
94 * "config_kvi.scope" (see above).
96 enum config_scope parsing_scope;
99 * Where possible, prefer to accept "struct config_reader" as an arg than to use
100 * "the_reader". "the_reader" should only be used if that is infeasible, e.g. in
101 * a public function.
103 static struct config_reader the_reader;
105 static inline void config_reader_push_source(struct config_reader *reader,
106 struct config_source *top)
108 if (reader->config_kvi)
109 BUG("source should not be set while iterating a config set");
110 top->prev = reader->source;
111 reader->source = top;
114 static inline struct config_source *config_reader_pop_source(struct config_reader *reader)
116 struct config_source *ret;
117 if (!reader->source)
118 BUG("tried to pop config source, but we weren't reading config");
119 ret = reader->source;
120 reader->source = reader->source->prev;
121 return ret;
124 static inline void config_reader_set_kvi(struct config_reader *reader,
125 struct key_value_info *kvi)
127 if (kvi && (reader->source || reader->parsing_scope))
128 BUG("kvi should not be set while parsing a config source");
129 reader->config_kvi = kvi;
132 static inline void config_reader_set_scope(struct config_reader *reader,
133 enum config_scope scope)
135 if (scope && reader->config_kvi)
136 BUG("scope should only be set when iterating through a config source");
137 reader->parsing_scope = scope;
140 static int pack_compression_seen;
141 static int zlib_compression_seen;
144 * Config that comes from trusted scopes, namely:
145 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
146 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
147 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
149 * This is declared here for code cleanliness, but unlike the other
150 * static variables, this does not hold config parser state.
152 static struct config_set protected_config;
154 static int config_file_fgetc(struct config_source *conf)
156 return getc_unlocked(conf->u.file);
159 static int config_file_ungetc(int c, struct config_source *conf)
161 return ungetc(c, conf->u.file);
164 static long config_file_ftell(struct config_source *conf)
166 return ftell(conf->u.file);
170 static int config_buf_fgetc(struct config_source *conf)
172 if (conf->u.buf.pos < conf->u.buf.len)
173 return conf->u.buf.buf[conf->u.buf.pos++];
175 return EOF;
178 static int config_buf_ungetc(int c, struct config_source *conf)
180 if (conf->u.buf.pos > 0) {
181 conf->u.buf.pos--;
182 if (conf->u.buf.buf[conf->u.buf.pos] != c)
183 BUG("config_buf can only ungetc the same character");
184 return c;
187 return EOF;
190 static long config_buf_ftell(struct config_source *conf)
192 return conf->u.buf.pos;
195 struct config_include_data {
196 int depth;
197 config_fn_t fn;
198 void *data;
199 const struct config_options *opts;
200 struct git_config_source *config_source;
201 struct config_reader *config_reader;
204 * All remote URLs discovered when reading all config files.
206 struct string_list *remote_urls;
208 #define CONFIG_INCLUDE_INIT { 0 }
210 static int git_config_include(const char *var, const char *value, void *data);
212 #define MAX_INCLUDE_DEPTH 10
213 static const char include_depth_advice[] = N_(
214 "exceeded maximum include depth (%d) while including\n"
215 " %s\n"
216 "from\n"
217 " %s\n"
218 "This might be due to circular includes.");
219 static int handle_path_include(struct config_source *cs, const char *path,
220 struct config_include_data *inc)
222 int ret = 0;
223 struct strbuf buf = STRBUF_INIT;
224 char *expanded;
226 if (!path)
227 return config_error_nonbool("include.path");
229 expanded = interpolate_path(path, 0);
230 if (!expanded)
231 return error(_("could not expand include path '%s'"), path);
232 path = expanded;
235 * Use an absolute path as-is, but interpret relative paths
236 * based on the including config file.
238 if (!is_absolute_path(path)) {
239 char *slash;
241 if (!cs || !cs->path) {
242 ret = error(_("relative config includes must come from files"));
243 goto cleanup;
246 slash = find_last_dir_sep(cs->path);
247 if (slash)
248 strbuf_add(&buf, cs->path, slash - cs->path + 1);
249 strbuf_addstr(&buf, path);
250 path = buf.buf;
253 if (!access_or_die(path, R_OK, 0)) {
254 if (++inc->depth > MAX_INCLUDE_DEPTH)
255 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
256 !cs ? "<unknown>" :
257 cs->name ? cs->name :
258 "the command line");
259 ret = git_config_from_file(git_config_include, path, inc);
260 inc->depth--;
262 cleanup:
263 strbuf_release(&buf);
264 free(expanded);
265 return ret;
268 static void add_trailing_starstar_for_dir(struct strbuf *pat)
270 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
271 strbuf_addstr(pat, "**");
274 static int prepare_include_condition_pattern(struct config_source *cs,
275 struct strbuf *pat)
277 struct strbuf path = STRBUF_INIT;
278 char *expanded;
279 int prefix = 0;
281 expanded = interpolate_path(pat->buf, 1);
282 if (expanded) {
283 strbuf_reset(pat);
284 strbuf_addstr(pat, expanded);
285 free(expanded);
288 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
289 const char *slash;
291 if (!cs || !cs->path)
292 return error(_("relative config include "
293 "conditionals must come from files"));
295 strbuf_realpath(&path, cs->path, 1);
296 slash = find_last_dir_sep(path.buf);
297 if (!slash)
298 BUG("how is this possible?");
299 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
300 prefix = slash - path.buf + 1 /* slash */;
301 } else if (!is_absolute_path(pat->buf))
302 strbuf_insertstr(pat, 0, "**/");
304 add_trailing_starstar_for_dir(pat);
306 strbuf_release(&path);
307 return prefix;
310 static int include_by_gitdir(struct config_source *cs,
311 const struct config_options *opts,
312 const char *cond, size_t cond_len, int icase)
314 struct strbuf text = STRBUF_INIT;
315 struct strbuf pattern = STRBUF_INIT;
316 int ret = 0, prefix;
317 const char *git_dir;
318 int already_tried_absolute = 0;
320 if (opts->git_dir)
321 git_dir = opts->git_dir;
322 else
323 goto done;
325 strbuf_realpath(&text, git_dir, 1);
326 strbuf_add(&pattern, cond, cond_len);
327 prefix = prepare_include_condition_pattern(cs, &pattern);
329 again:
330 if (prefix < 0)
331 goto done;
333 if (prefix > 0) {
335 * perform literal matching on the prefix part so that
336 * any wildcard character in it can't create side effects.
338 if (text.len < prefix)
339 goto done;
340 if (!icase && strncmp(pattern.buf, text.buf, prefix))
341 goto done;
342 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
343 goto done;
346 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
347 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
349 if (!ret && !already_tried_absolute) {
351 * We've tried e.g. matching gitdir:~/work, but if
352 * ~/work is a symlink to /mnt/storage/work
353 * strbuf_realpath() will expand it, so the rule won't
354 * match. Let's match against a
355 * strbuf_add_absolute_path() version of the path,
356 * which'll do the right thing
358 strbuf_reset(&text);
359 strbuf_add_absolute_path(&text, git_dir);
360 already_tried_absolute = 1;
361 goto again;
363 done:
364 strbuf_release(&pattern);
365 strbuf_release(&text);
366 return ret;
369 static int include_by_branch(const char *cond, size_t cond_len)
371 int flags;
372 int ret;
373 struct strbuf pattern = STRBUF_INIT;
374 const char *refname = !the_repository->gitdir ?
375 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
376 const char *shortname;
378 if (!refname || !(flags & REF_ISSYMREF) ||
379 !skip_prefix(refname, "refs/heads/", &shortname))
380 return 0;
382 strbuf_add(&pattern, cond, cond_len);
383 add_trailing_starstar_for_dir(&pattern);
384 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
385 strbuf_release(&pattern);
386 return ret;
389 static int add_remote_url(const char *var, const char *value, void *data)
391 struct string_list *remote_urls = data;
392 const char *remote_name;
393 size_t remote_name_len;
394 const char *key;
396 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
397 &key) &&
398 remote_name &&
399 !strcmp(key, "url"))
400 string_list_append(remote_urls, value);
401 return 0;
404 static void populate_remote_urls(struct config_include_data *inc)
406 struct config_options opts;
408 enum config_scope store_scope = inc->config_reader->parsing_scope;
410 opts = *inc->opts;
411 opts.unconditional_remote_url = 1;
413 config_reader_set_scope(inc->config_reader, 0);
415 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
416 string_list_init_dup(inc->remote_urls);
417 config_with_options(add_remote_url, inc->remote_urls, inc->config_source, &opts);
419 config_reader_set_scope(inc->config_reader, store_scope);
422 static int forbid_remote_url(const char *var, const char *value UNUSED,
423 void *data UNUSED)
425 const char *remote_name;
426 size_t remote_name_len;
427 const char *key;
429 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
430 &key) &&
431 remote_name &&
432 !strcmp(key, "url"))
433 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
434 return 0;
437 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
438 struct string_list *remote_urls)
440 struct strbuf pattern = STRBUF_INIT;
441 struct string_list_item *url_item;
442 int found = 0;
444 strbuf_add(&pattern, glob, glob_len);
445 for_each_string_list_item(url_item, remote_urls) {
446 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
447 found = 1;
448 break;
451 strbuf_release(&pattern);
452 return found;
455 static int include_by_remote_url(struct config_include_data *inc,
456 const char *cond, size_t cond_len)
458 if (inc->opts->unconditional_remote_url)
459 return 1;
460 if (!inc->remote_urls)
461 populate_remote_urls(inc);
462 return at_least_one_url_matches_glob(cond, cond_len,
463 inc->remote_urls);
466 static int include_condition_is_true(struct config_source *cs,
467 struct config_include_data *inc,
468 const char *cond, size_t cond_len)
470 const struct config_options *opts = inc->opts;
472 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
473 return include_by_gitdir(cs, opts, cond, cond_len, 0);
474 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
475 return include_by_gitdir(cs, opts, cond, cond_len, 1);
476 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
477 return include_by_branch(cond, cond_len);
478 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
479 &cond_len))
480 return include_by_remote_url(inc, cond, cond_len);
482 /* unknown conditionals are always false */
483 return 0;
486 static int git_config_include(const char *var, const char *value, void *data)
488 struct config_include_data *inc = data;
489 struct config_source *cs = inc->config_reader->source;
490 const char *cond, *key;
491 size_t cond_len;
492 int ret;
495 * Pass along all values, including "include" directives; this makes it
496 * possible to query information on the includes themselves.
498 ret = inc->fn(var, value, inc->data);
499 if (ret < 0)
500 return ret;
502 if (!strcmp(var, "include.path"))
503 ret = handle_path_include(cs, value, inc);
505 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
506 cond && include_condition_is_true(cs, inc, cond, cond_len) &&
507 !strcmp(key, "path")) {
508 config_fn_t old_fn = inc->fn;
510 if (inc->opts->unconditional_remote_url)
511 inc->fn = forbid_remote_url;
512 ret = handle_path_include(cs, value, inc);
513 inc->fn = old_fn;
516 return ret;
519 static void git_config_push_split_parameter(const char *key, const char *value)
521 struct strbuf env = STRBUF_INIT;
522 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
523 if (old && *old) {
524 strbuf_addstr(&env, old);
525 strbuf_addch(&env, ' ');
527 sq_quote_buf(&env, key);
528 strbuf_addch(&env, '=');
529 if (value)
530 sq_quote_buf(&env, value);
531 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
532 strbuf_release(&env);
535 void git_config_push_parameter(const char *text)
537 const char *value;
540 * When we see:
542 * section.subsection=with=equals.key=value
544 * we cannot tell if it means:
546 * [section "subsection=with=equals"]
547 * key = value
549 * or:
551 * [section]
552 * subsection = with=equals.key=value
554 * We parse left-to-right for the first "=", meaning we'll prefer to
555 * keep the value intact over the subsection. This is historical, but
556 * also sensible since values are more likely to contain odd or
557 * untrusted input than a section name.
559 * A missing equals is explicitly allowed (as a bool-only entry).
561 value = strchr(text, '=');
562 if (value) {
563 char *key = xmemdupz(text, value - text);
564 git_config_push_split_parameter(key, value + 1);
565 free(key);
566 } else {
567 git_config_push_split_parameter(text, NULL);
571 void git_config_push_env(const char *spec)
573 char *key;
574 const char *env_name;
575 const char *env_value;
577 env_name = strrchr(spec, '=');
578 if (!env_name)
579 die(_("invalid config format: %s"), spec);
580 key = xmemdupz(spec, env_name - spec);
581 env_name++;
582 if (!*env_name)
583 die(_("missing environment variable name for configuration '%.*s'"),
584 (int)(env_name - spec - 1), spec);
586 env_value = getenv(env_name);
587 if (!env_value)
588 die(_("missing environment variable '%s' for configuration '%.*s'"),
589 env_name, (int)(env_name - spec - 1), spec);
591 git_config_push_split_parameter(key, env_value);
592 free(key);
595 static inline int iskeychar(int c)
597 return isalnum(c) || c == '-';
601 * Auxiliary function to sanity-check and split the key into the section
602 * identifier and variable name.
604 * Returns 0 on success, -1 when there is an invalid character in the key and
605 * -2 if there is no section name in the key.
607 * store_key - pointer to char* which will hold a copy of the key with
608 * lowercase section and variable name
609 * baselen - pointer to size_t which will hold the length of the
610 * section + subsection part, can be NULL
612 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
614 size_t i, baselen;
615 int dot;
616 const char *last_dot = strrchr(key, '.');
619 * Since "key" actually contains the section name and the real
620 * key name separated by a dot, we have to know where the dot is.
623 if (last_dot == NULL || last_dot == key) {
624 error(_("key does not contain a section: %s"), key);
625 return -CONFIG_NO_SECTION_OR_NAME;
628 if (!last_dot[1]) {
629 error(_("key does not contain variable name: %s"), key);
630 return -CONFIG_NO_SECTION_OR_NAME;
633 baselen = last_dot - key;
634 if (baselen_)
635 *baselen_ = baselen;
638 * Validate the key and while at it, lower case it for matching.
640 *store_key = xmallocz(strlen(key));
642 dot = 0;
643 for (i = 0; key[i]; i++) {
644 unsigned char c = key[i];
645 if (c == '.')
646 dot = 1;
647 /* Leave the extended basename untouched.. */
648 if (!dot || i > baselen) {
649 if (!iskeychar(c) ||
650 (i == baselen + 1 && !isalpha(c))) {
651 error(_("invalid key: %s"), key);
652 goto out_free_ret_1;
654 c = tolower(c);
655 } else if (c == '\n') {
656 error(_("invalid key (newline): %s"), key);
657 goto out_free_ret_1;
659 (*store_key)[i] = c;
662 return 0;
664 out_free_ret_1:
665 FREE_AND_NULL(*store_key);
666 return -CONFIG_INVALID_KEY;
669 static int config_parse_pair(const char *key, const char *value,
670 config_fn_t fn, void *data)
672 char *canonical_name;
673 int ret;
675 if (!strlen(key))
676 return error(_("empty config key"));
677 if (git_config_parse_key(key, &canonical_name, NULL))
678 return -1;
680 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
681 free(canonical_name);
682 return ret;
685 int git_config_parse_parameter(const char *text,
686 config_fn_t fn, void *data)
688 const char *value;
689 struct strbuf **pair;
690 int ret;
692 pair = strbuf_split_str(text, '=', 2);
693 if (!pair[0])
694 return error(_("bogus config parameter: %s"), text);
696 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
697 strbuf_setlen(pair[0], pair[0]->len - 1);
698 value = pair[1] ? pair[1]->buf : "";
699 } else {
700 value = NULL;
703 strbuf_trim(pair[0]);
704 if (!pair[0]->len) {
705 strbuf_list_free(pair);
706 return error(_("bogus config parameter: %s"), text);
709 ret = config_parse_pair(pair[0]->buf, value, fn, data);
710 strbuf_list_free(pair);
711 return ret;
714 static int parse_config_env_list(char *env, config_fn_t fn, void *data)
716 char *cur = env;
717 while (cur && *cur) {
718 const char *key = sq_dequote_step(cur, &cur);
719 if (!key)
720 return error(_("bogus format in %s"),
721 CONFIG_DATA_ENVIRONMENT);
723 if (!cur || isspace(*cur)) {
724 /* old-style 'key=value' */
725 if (git_config_parse_parameter(key, fn, data) < 0)
726 return -1;
728 else if (*cur == '=') {
729 /* new-style 'key'='value' */
730 const char *value;
732 cur++;
733 if (*cur == '\'') {
734 /* quoted value */
735 value = sq_dequote_step(cur, &cur);
736 if (!value || (cur && !isspace(*cur))) {
737 return error(_("bogus format in %s"),
738 CONFIG_DATA_ENVIRONMENT);
740 } else if (!*cur || isspace(*cur)) {
741 /* implicit bool: 'key'= */
742 value = NULL;
743 } else {
744 return error(_("bogus format in %s"),
745 CONFIG_DATA_ENVIRONMENT);
748 if (config_parse_pair(key, value, fn, data) < 0)
749 return -1;
751 else {
752 /* unknown format */
753 return error(_("bogus format in %s"),
754 CONFIG_DATA_ENVIRONMENT);
757 if (cur) {
758 while (isspace(*cur))
759 cur++;
762 return 0;
765 int git_config_from_parameters(config_fn_t fn, void *data)
767 const char *env;
768 struct strbuf envvar = STRBUF_INIT;
769 struct strvec to_free = STRVEC_INIT;
770 int ret = 0;
771 char *envw = NULL;
772 struct config_source source = CONFIG_SOURCE_INIT;
774 source.origin_type = CONFIG_ORIGIN_CMDLINE;
775 config_reader_push_source(&the_reader, &source);
777 env = getenv(CONFIG_COUNT_ENVIRONMENT);
778 if (env) {
779 unsigned long count;
780 char *endp;
781 int i;
783 count = strtoul(env, &endp, 10);
784 if (*endp) {
785 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
786 goto out;
788 if (count > INT_MAX) {
789 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
790 goto out;
793 for (i = 0; i < count; i++) {
794 const char *key, *value;
796 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
797 key = getenv_safe(&to_free, envvar.buf);
798 if (!key) {
799 ret = error(_("missing config key %s"), envvar.buf);
800 goto out;
802 strbuf_reset(&envvar);
804 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
805 value = getenv_safe(&to_free, envvar.buf);
806 if (!value) {
807 ret = error(_("missing config value %s"), envvar.buf);
808 goto out;
810 strbuf_reset(&envvar);
812 if (config_parse_pair(key, value, fn, data) < 0) {
813 ret = -1;
814 goto out;
819 env = getenv(CONFIG_DATA_ENVIRONMENT);
820 if (env) {
821 /* sq_dequote will write over it */
822 envw = xstrdup(env);
823 if (parse_config_env_list(envw, fn, data) < 0) {
824 ret = -1;
825 goto out;
829 out:
830 strbuf_release(&envvar);
831 strvec_clear(&to_free);
832 free(envw);
833 config_reader_pop_source(&the_reader);
834 return ret;
837 static int get_next_char(struct config_source *cs)
839 int c = cs->do_fgetc(cs);
841 if (c == '\r') {
842 /* DOS like systems */
843 c = cs->do_fgetc(cs);
844 if (c != '\n') {
845 if (c != EOF)
846 cs->do_ungetc(c, cs);
847 c = '\r';
851 if (c != EOF && ++cs->total_len > INT_MAX) {
853 * This is an absurdly long config file; refuse to parse
854 * further in order to protect downstream code from integer
855 * overflows. Note that we can't return an error specifically,
856 * but we can mark EOF and put trash in the return value,
857 * which will trigger a parse error.
859 cs->eof = 1;
860 return 0;
863 if (c == '\n')
864 cs->linenr++;
865 if (c == EOF) {
866 cs->eof = 1;
867 cs->linenr++;
868 c = '\n';
870 return c;
873 static char *parse_value(struct config_source *cs)
875 int quote = 0, comment = 0, space = 0;
877 strbuf_reset(&cs->value);
878 for (;;) {
879 int c = get_next_char(cs);
880 if (c == '\n') {
881 if (quote) {
882 cs->linenr--;
883 return NULL;
885 return cs->value.buf;
887 if (comment)
888 continue;
889 if (isspace(c) && !quote) {
890 if (cs->value.len)
891 space++;
892 continue;
894 if (!quote) {
895 if (c == ';' || c == '#') {
896 comment = 1;
897 continue;
900 for (; space; space--)
901 strbuf_addch(&cs->value, ' ');
902 if (c == '\\') {
903 c = get_next_char(cs);
904 switch (c) {
905 case '\n':
906 continue;
907 case 't':
908 c = '\t';
909 break;
910 case 'b':
911 c = '\b';
912 break;
913 case 'n':
914 c = '\n';
915 break;
916 /* Some characters escape as themselves */
917 case '\\': case '"':
918 break;
919 /* Reject unknown escape sequences */
920 default:
921 return NULL;
923 strbuf_addch(&cs->value, c);
924 continue;
926 if (c == '"') {
927 quote = 1-quote;
928 continue;
930 strbuf_addch(&cs->value, c);
934 static int get_value(struct config_source *cs, config_fn_t fn, void *data,
935 struct strbuf *name)
937 int c;
938 char *value;
939 int ret;
941 /* Get the full name */
942 for (;;) {
943 c = get_next_char(cs);
944 if (cs->eof)
945 break;
946 if (!iskeychar(c))
947 break;
948 strbuf_addch(name, tolower(c));
951 while (c == ' ' || c == '\t')
952 c = get_next_char(cs);
954 value = NULL;
955 if (c != '\n') {
956 if (c != '=')
957 return -1;
958 value = parse_value(cs);
959 if (!value)
960 return -1;
963 * We already consumed the \n, but we need linenr to point to
964 * the line we just parsed during the call to fn to get
965 * accurate line number in error messages.
967 cs->linenr--;
968 ret = fn(name->buf, value, data);
969 if (ret >= 0)
970 cs->linenr++;
971 return ret;
974 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
975 int c)
977 cs->subsection_case_sensitive = 0;
978 do {
979 if (c == '\n')
980 goto error_incomplete_line;
981 c = get_next_char(cs);
982 } while (isspace(c));
984 /* We require the format to be '[base "extension"]' */
985 if (c != '"')
986 return -1;
987 strbuf_addch(name, '.');
989 for (;;) {
990 int c = get_next_char(cs);
991 if (c == '\n')
992 goto error_incomplete_line;
993 if (c == '"')
994 break;
995 if (c == '\\') {
996 c = get_next_char(cs);
997 if (c == '\n')
998 goto error_incomplete_line;
1000 strbuf_addch(name, c);
1003 /* Final ']' */
1004 if (get_next_char(cs) != ']')
1005 return -1;
1006 return 0;
1007 error_incomplete_line:
1008 cs->linenr--;
1009 return -1;
1012 static int get_base_var(struct config_source *cs, struct strbuf *name)
1014 cs->subsection_case_sensitive = 1;
1015 for (;;) {
1016 int c = get_next_char(cs);
1017 if (cs->eof)
1018 return -1;
1019 if (c == ']')
1020 return 0;
1021 if (isspace(c))
1022 return get_extended_base_var(cs, name, c);
1023 if (!iskeychar(c) && c != '.')
1024 return -1;
1025 strbuf_addch(name, tolower(c));
1029 struct parse_event_data {
1030 enum config_event_t previous_type;
1031 size_t previous_offset;
1032 const struct config_options *opts;
1035 static int do_event(struct config_source *cs, enum config_event_t type,
1036 struct parse_event_data *data)
1038 size_t offset;
1040 if (!data->opts || !data->opts->event_fn)
1041 return 0;
1043 if (type == CONFIG_EVENT_WHITESPACE &&
1044 data->previous_type == type)
1045 return 0;
1047 offset = cs->do_ftell(cs);
1049 * At EOF, the parser always "inserts" an extra '\n', therefore
1050 * the end offset of the event is the current file position, otherwise
1051 * we will already have advanced to the next event.
1053 if (type != CONFIG_EVENT_EOF)
1054 offset--;
1056 if (data->previous_type != CONFIG_EVENT_EOF &&
1057 data->opts->event_fn(data->previous_type, data->previous_offset,
1058 offset, data->opts->event_fn_data) < 0)
1059 return -1;
1061 data->previous_type = type;
1062 data->previous_offset = offset;
1064 return 0;
1067 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1068 void *data, const struct config_options *opts)
1070 int comment = 0;
1071 size_t baselen = 0;
1072 struct strbuf *var = &cs->var;
1073 int error_return = 0;
1074 char *error_msg = NULL;
1076 /* U+FEFF Byte Order Mark in UTF8 */
1077 const char *bomptr = utf8_bom;
1079 /* For the parser event callback */
1080 struct parse_event_data event_data = {
1081 CONFIG_EVENT_EOF, 0, opts
1084 for (;;) {
1085 int c;
1087 c = get_next_char(cs);
1088 if (bomptr && *bomptr) {
1089 /* We are at the file beginning; skip UTF8-encoded BOM
1090 * if present. Sane editors won't put this in on their
1091 * own, but e.g. Windows Notepad will do it happily. */
1092 if (c == (*bomptr & 0377)) {
1093 bomptr++;
1094 continue;
1095 } else {
1096 /* Do not tolerate partial BOM. */
1097 if (bomptr != utf8_bom)
1098 break;
1099 /* No BOM at file beginning. Cool. */
1100 bomptr = NULL;
1103 if (c == '\n') {
1104 if (cs->eof) {
1105 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1106 return -1;
1107 return 0;
1109 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1110 return -1;
1111 comment = 0;
1112 continue;
1114 if (comment)
1115 continue;
1116 if (isspace(c)) {
1117 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1118 return -1;
1119 continue;
1121 if (c == '#' || c == ';') {
1122 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1123 return -1;
1124 comment = 1;
1125 continue;
1127 if (c == '[') {
1128 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1129 return -1;
1131 /* Reset prior to determining a new stem */
1132 strbuf_reset(var);
1133 if (get_base_var(cs, var) < 0 || var->len < 1)
1134 break;
1135 strbuf_addch(var, '.');
1136 baselen = var->len;
1137 continue;
1139 if (!isalpha(c))
1140 break;
1142 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1143 return -1;
1146 * Truncate the var name back to the section header
1147 * stem prior to grabbing the suffix part of the name
1148 * and the value.
1150 strbuf_setlen(var, baselen);
1151 strbuf_addch(var, tolower(c));
1152 if (get_value(cs, fn, data, var) < 0)
1153 break;
1156 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1157 return -1;
1159 switch (cs->origin_type) {
1160 case CONFIG_ORIGIN_BLOB:
1161 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1162 cs->linenr, cs->name);
1163 break;
1164 case CONFIG_ORIGIN_FILE:
1165 error_msg = xstrfmt(_("bad config line %d in file %s"),
1166 cs->linenr, cs->name);
1167 break;
1168 case CONFIG_ORIGIN_STDIN:
1169 error_msg = xstrfmt(_("bad config line %d in standard input"),
1170 cs->linenr);
1171 break;
1172 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1173 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1174 cs->linenr, cs->name);
1175 break;
1176 case CONFIG_ORIGIN_CMDLINE:
1177 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1178 cs->linenr, cs->name);
1179 break;
1180 default:
1181 error_msg = xstrfmt(_("bad config line %d in %s"),
1182 cs->linenr, cs->name);
1185 switch (opts && opts->error_action ?
1186 opts->error_action :
1187 cs->default_error_action) {
1188 case CONFIG_ERROR_DIE:
1189 die("%s", error_msg);
1190 break;
1191 case CONFIG_ERROR_ERROR:
1192 error_return = error("%s", error_msg);
1193 break;
1194 case CONFIG_ERROR_SILENT:
1195 error_return = -1;
1196 break;
1197 case CONFIG_ERROR_UNSET:
1198 BUG("config error action unset");
1201 free(error_msg);
1202 return error_return;
1205 static uintmax_t get_unit_factor(const char *end)
1207 if (!*end)
1208 return 1;
1209 else if (!strcasecmp(end, "k"))
1210 return 1024;
1211 else if (!strcasecmp(end, "m"))
1212 return 1024 * 1024;
1213 else if (!strcasecmp(end, "g"))
1214 return 1024 * 1024 * 1024;
1215 return 0;
1218 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1220 if (value && *value) {
1221 char *end;
1222 intmax_t val;
1223 intmax_t factor;
1225 if (max < 0)
1226 BUG("max must be a positive integer");
1228 errno = 0;
1229 val = strtoimax(value, &end, 0);
1230 if (errno == ERANGE)
1231 return 0;
1232 if (end == value) {
1233 errno = EINVAL;
1234 return 0;
1236 factor = get_unit_factor(end);
1237 if (!factor) {
1238 errno = EINVAL;
1239 return 0;
1241 if ((val < 0 && -max / factor > val) ||
1242 (val > 0 && max / factor < val)) {
1243 errno = ERANGE;
1244 return 0;
1246 val *= factor;
1247 *ret = val;
1248 return 1;
1250 errno = EINVAL;
1251 return 0;
1254 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1256 if (value && *value) {
1257 char *end;
1258 uintmax_t val;
1259 uintmax_t factor;
1261 /* negative values would be accepted by strtoumax */
1262 if (strchr(value, '-')) {
1263 errno = EINVAL;
1264 return 0;
1266 errno = 0;
1267 val = strtoumax(value, &end, 0);
1268 if (errno == ERANGE)
1269 return 0;
1270 if (end == value) {
1271 errno = EINVAL;
1272 return 0;
1274 factor = get_unit_factor(end);
1275 if (!factor) {
1276 errno = EINVAL;
1277 return 0;
1279 if (unsigned_mult_overflows(factor, val) ||
1280 factor * val > max) {
1281 errno = ERANGE;
1282 return 0;
1284 val *= factor;
1285 *ret = val;
1286 return 1;
1288 errno = EINVAL;
1289 return 0;
1292 int git_parse_int(const char *value, int *ret)
1294 intmax_t tmp;
1295 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1296 return 0;
1297 *ret = tmp;
1298 return 1;
1301 static int git_parse_int64(const char *value, int64_t *ret)
1303 intmax_t tmp;
1304 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1305 return 0;
1306 *ret = tmp;
1307 return 1;
1310 int git_parse_ulong(const char *value, unsigned long *ret)
1312 uintmax_t tmp;
1313 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1314 return 0;
1315 *ret = tmp;
1316 return 1;
1319 int git_parse_ssize_t(const char *value, ssize_t *ret)
1321 intmax_t tmp;
1322 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1323 return 0;
1324 *ret = tmp;
1325 return 1;
1328 static int reader_config_name(struct config_reader *reader, const char **out);
1329 static int reader_origin_type(struct config_reader *reader,
1330 enum config_origin_type *type);
1331 NORETURN
1332 static void die_bad_number(struct config_reader *reader, const char *name,
1333 const char *value)
1335 const char *error_type = (errno == ERANGE) ?
1336 N_("out of range") : N_("invalid unit");
1337 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1338 const char *config_name = NULL;
1339 enum config_origin_type config_origin = CONFIG_ORIGIN_UNKNOWN;
1341 if (!value)
1342 value = "";
1344 /* Ignoring the return value is okay since we handle missing values. */
1345 reader_config_name(reader, &config_name);
1346 reader_origin_type(reader, &config_origin);
1348 if (!config_name)
1349 die(_(bad_numeric), value, name, _(error_type));
1351 switch (config_origin) {
1352 case CONFIG_ORIGIN_BLOB:
1353 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1354 value, name, config_name, _(error_type));
1355 case CONFIG_ORIGIN_FILE:
1356 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1357 value, name, config_name, _(error_type));
1358 case CONFIG_ORIGIN_STDIN:
1359 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1360 value, name, _(error_type));
1361 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1362 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1363 value, name, config_name, _(error_type));
1364 case CONFIG_ORIGIN_CMDLINE:
1365 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1366 value, name, config_name, _(error_type));
1367 default:
1368 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1369 value, name, config_name, _(error_type));
1373 int git_config_int(const char *name, const char *value)
1375 int ret;
1376 if (!git_parse_int(value, &ret))
1377 die_bad_number(&the_reader, name, value);
1378 return ret;
1381 int64_t git_config_int64(const char *name, const char *value)
1383 int64_t ret;
1384 if (!git_parse_int64(value, &ret))
1385 die_bad_number(&the_reader, name, value);
1386 return ret;
1389 unsigned long git_config_ulong(const char *name, const char *value)
1391 unsigned long ret;
1392 if (!git_parse_ulong(value, &ret))
1393 die_bad_number(&the_reader, name, value);
1394 return ret;
1397 ssize_t git_config_ssize_t(const char *name, const char *value)
1399 ssize_t ret;
1400 if (!git_parse_ssize_t(value, &ret))
1401 die_bad_number(&the_reader, name, value);
1402 return ret;
1405 static int git_parse_maybe_bool_text(const char *value)
1407 if (!value)
1408 return 1;
1409 if (!*value)
1410 return 0;
1411 if (!strcasecmp(value, "true")
1412 || !strcasecmp(value, "yes")
1413 || !strcasecmp(value, "on"))
1414 return 1;
1415 if (!strcasecmp(value, "false")
1416 || !strcasecmp(value, "no")
1417 || !strcasecmp(value, "off"))
1418 return 0;
1419 return -1;
1422 static const struct fsync_component_name {
1423 const char *name;
1424 enum fsync_component component_bits;
1425 } fsync_component_names[] = {
1426 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1427 { "pack", FSYNC_COMPONENT_PACK },
1428 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1429 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1430 { "index", FSYNC_COMPONENT_INDEX },
1431 { "objects", FSYNC_COMPONENTS_OBJECTS },
1432 { "reference", FSYNC_COMPONENT_REFERENCE },
1433 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1434 { "committed", FSYNC_COMPONENTS_COMMITTED },
1435 { "added", FSYNC_COMPONENTS_ADDED },
1436 { "all", FSYNC_COMPONENTS_ALL },
1439 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1441 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1442 enum fsync_component positive = 0, negative = 0;
1444 while (string) {
1445 int i;
1446 size_t len;
1447 const char *ep;
1448 int negated = 0;
1449 int found = 0;
1451 string = string + strspn(string, ", \t\n\r");
1452 ep = strchrnul(string, ',');
1453 len = ep - string;
1454 if (!strcmp(string, "none")) {
1455 current = FSYNC_COMPONENT_NONE;
1456 goto next_name;
1459 if (*string == '-') {
1460 negated = 1;
1461 string++;
1462 len--;
1463 if (!len)
1464 warning(_("invalid value for variable %s"), var);
1467 if (!len)
1468 break;
1470 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1471 const struct fsync_component_name *n = &fsync_component_names[i];
1473 if (strncmp(n->name, string, len))
1474 continue;
1476 found = 1;
1477 if (negated)
1478 negative |= n->component_bits;
1479 else
1480 positive |= n->component_bits;
1483 if (!found) {
1484 char *component = xstrndup(string, len);
1485 warning(_("ignoring unknown core.fsync component '%s'"), component);
1486 free(component);
1489 next_name:
1490 string = ep;
1493 return (current & ~negative) | positive;
1496 int git_parse_maybe_bool(const char *value)
1498 int v = git_parse_maybe_bool_text(value);
1499 if (0 <= v)
1500 return v;
1501 if (git_parse_int(value, &v))
1502 return !!v;
1503 return -1;
1506 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1508 int v = git_parse_maybe_bool_text(value);
1509 if (0 <= v) {
1510 *is_bool = 1;
1511 return v;
1513 *is_bool = 0;
1514 return git_config_int(name, value);
1517 int git_config_bool(const char *name, const char *value)
1519 int v = git_parse_maybe_bool(value);
1520 if (v < 0)
1521 die(_("bad boolean config value '%s' for '%s'"), value, name);
1522 return v;
1525 int git_config_string(const char **dest, const char *var, const char *value)
1527 if (!value)
1528 return config_error_nonbool(var);
1529 *dest = xstrdup(value);
1530 return 0;
1533 int git_config_pathname(const char **dest, const char *var, const char *value)
1535 if (!value)
1536 return config_error_nonbool(var);
1537 *dest = interpolate_path(value, 0);
1538 if (!*dest)
1539 die(_("failed to expand user dir in: '%s'"), value);
1540 return 0;
1543 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1545 if (!value)
1546 return config_error_nonbool(var);
1547 if (parse_expiry_date(value, timestamp))
1548 return error(_("'%s' for '%s' is not a valid timestamp"),
1549 value, var);
1550 return 0;
1553 int git_config_color(char *dest, const char *var, const char *value)
1555 if (!value)
1556 return config_error_nonbool(var);
1557 if (color_parse(value, dest) < 0)
1558 return -1;
1559 return 0;
1562 static int git_default_core_config(const char *var, const char *value, void *cb)
1564 /* This needs a better name */
1565 if (!strcmp(var, "core.filemode")) {
1566 trust_executable_bit = git_config_bool(var, value);
1567 return 0;
1569 if (!strcmp(var, "core.trustctime")) {
1570 trust_ctime = git_config_bool(var, value);
1571 return 0;
1573 if (!strcmp(var, "core.checkstat")) {
1574 if (!strcasecmp(value, "default"))
1575 check_stat = 1;
1576 else if (!strcasecmp(value, "minimal"))
1577 check_stat = 0;
1580 if (!strcmp(var, "core.quotepath")) {
1581 quote_path_fully = git_config_bool(var, value);
1582 return 0;
1585 if (!strcmp(var, "core.symlinks")) {
1586 has_symlinks = git_config_bool(var, value);
1587 return 0;
1590 if (!strcmp(var, "core.ignorecase")) {
1591 ignore_case = git_config_bool(var, value);
1592 return 0;
1595 if (!strcmp(var, "core.attributesfile"))
1596 return git_config_pathname(&git_attributes_file, var, value);
1598 if (!strcmp(var, "core.hookspath"))
1599 return git_config_pathname(&git_hooks_path, var, value);
1601 if (!strcmp(var, "core.bare")) {
1602 is_bare_repository_cfg = git_config_bool(var, value);
1603 return 0;
1606 if (!strcmp(var, "core.ignorestat")) {
1607 assume_unchanged = git_config_bool(var, value);
1608 return 0;
1611 if (!strcmp(var, "core.prefersymlinkrefs")) {
1612 prefer_symlink_refs = git_config_bool(var, value);
1613 return 0;
1616 if (!strcmp(var, "core.logallrefupdates")) {
1617 if (value && !strcasecmp(value, "always"))
1618 log_all_ref_updates = LOG_REFS_ALWAYS;
1619 else if (git_config_bool(var, value))
1620 log_all_ref_updates = LOG_REFS_NORMAL;
1621 else
1622 log_all_ref_updates = LOG_REFS_NONE;
1623 return 0;
1626 if (!strcmp(var, "core.warnambiguousrefs")) {
1627 warn_ambiguous_refs = git_config_bool(var, value);
1628 return 0;
1631 if (!strcmp(var, "core.abbrev")) {
1632 if (!value)
1633 return config_error_nonbool(var);
1634 if (!strcasecmp(value, "auto"))
1635 default_abbrev = -1;
1636 else if (!git_parse_maybe_bool_text(value))
1637 default_abbrev = the_hash_algo->hexsz;
1638 else {
1639 int abbrev = git_config_int(var, value);
1640 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1641 return error(_("abbrev length out of range: %d"), abbrev);
1642 default_abbrev = abbrev;
1644 return 0;
1647 if (!strcmp(var, "core.disambiguate"))
1648 return set_disambiguate_hint_config(var, value);
1650 if (!strcmp(var, "core.loosecompression")) {
1651 int level = git_config_int(var, value);
1652 if (level == -1)
1653 level = Z_DEFAULT_COMPRESSION;
1654 else if (level < 0 || level > Z_BEST_COMPRESSION)
1655 die(_("bad zlib compression level %d"), level);
1656 zlib_compression_level = level;
1657 zlib_compression_seen = 1;
1658 return 0;
1661 if (!strcmp(var, "core.compression")) {
1662 int level = git_config_int(var, value);
1663 if (level == -1)
1664 level = Z_DEFAULT_COMPRESSION;
1665 else if (level < 0 || level > Z_BEST_COMPRESSION)
1666 die(_("bad zlib compression level %d"), level);
1667 if (!zlib_compression_seen)
1668 zlib_compression_level = level;
1669 if (!pack_compression_seen)
1670 pack_compression_level = level;
1671 return 0;
1674 if (!strcmp(var, "core.packedgitwindowsize")) {
1675 int pgsz_x2 = getpagesize() * 2;
1676 packed_git_window_size = git_config_ulong(var, value);
1678 /* This value must be multiple of (pagesize * 2) */
1679 packed_git_window_size /= pgsz_x2;
1680 if (packed_git_window_size < 1)
1681 packed_git_window_size = 1;
1682 packed_git_window_size *= pgsz_x2;
1683 return 0;
1686 if (!strcmp(var, "core.bigfilethreshold")) {
1687 big_file_threshold = git_config_ulong(var, value);
1688 return 0;
1691 if (!strcmp(var, "core.packedgitlimit")) {
1692 packed_git_limit = git_config_ulong(var, value);
1693 return 0;
1696 if (!strcmp(var, "core.deltabasecachelimit")) {
1697 delta_base_cache_limit = git_config_ulong(var, value);
1698 return 0;
1701 if (!strcmp(var, "core.autocrlf")) {
1702 if (value && !strcasecmp(value, "input")) {
1703 auto_crlf = AUTO_CRLF_INPUT;
1704 return 0;
1706 auto_crlf = git_config_bool(var, value);
1707 return 0;
1710 if (!strcmp(var, "core.safecrlf")) {
1711 int eol_rndtrp_die;
1712 if (value && !strcasecmp(value, "warn")) {
1713 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1714 return 0;
1716 eol_rndtrp_die = git_config_bool(var, value);
1717 global_conv_flags_eol = eol_rndtrp_die ?
1718 CONV_EOL_RNDTRP_DIE : 0;
1719 return 0;
1722 if (!strcmp(var, "core.eol")) {
1723 if (value && !strcasecmp(value, "lf"))
1724 core_eol = EOL_LF;
1725 else if (value && !strcasecmp(value, "crlf"))
1726 core_eol = EOL_CRLF;
1727 else if (value && !strcasecmp(value, "native"))
1728 core_eol = EOL_NATIVE;
1729 else
1730 core_eol = EOL_UNSET;
1731 return 0;
1734 if (!strcmp(var, "core.checkroundtripencoding")) {
1735 check_roundtrip_encoding = xstrdup(value);
1736 return 0;
1739 if (!strcmp(var, "core.notesref")) {
1740 notes_ref_name = xstrdup(value);
1741 return 0;
1744 if (!strcmp(var, "core.editor"))
1745 return git_config_string(&editor_program, var, value);
1747 if (!strcmp(var, "core.commentchar")) {
1748 if (!value)
1749 return config_error_nonbool(var);
1750 else if (!strcasecmp(value, "auto"))
1751 auto_comment_line_char = 1;
1752 else if (value[0] && !value[1]) {
1753 comment_line_char = value[0];
1754 auto_comment_line_char = 0;
1755 } else
1756 return error(_("core.commentChar should only be one ASCII character"));
1757 return 0;
1760 if (!strcmp(var, "core.askpass"))
1761 return git_config_string(&askpass_program, var, value);
1763 if (!strcmp(var, "core.excludesfile"))
1764 return git_config_pathname(&excludes_file, var, value);
1766 if (!strcmp(var, "core.whitespace")) {
1767 if (!value)
1768 return config_error_nonbool(var);
1769 whitespace_rule_cfg = parse_whitespace_rule(value);
1770 return 0;
1773 if (!strcmp(var, "core.fsync")) {
1774 if (!value)
1775 return config_error_nonbool(var);
1776 fsync_components = parse_fsync_components(var, value);
1777 return 0;
1780 if (!strcmp(var, "core.fsyncmethod")) {
1781 if (!value)
1782 return config_error_nonbool(var);
1783 if (!strcmp(value, "fsync"))
1784 fsync_method = FSYNC_METHOD_FSYNC;
1785 else if (!strcmp(value, "writeout-only"))
1786 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1787 else if (!strcmp(value, "batch"))
1788 fsync_method = FSYNC_METHOD_BATCH;
1789 else
1790 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1794 if (!strcmp(var, "core.fsyncobjectfiles")) {
1795 if (fsync_object_files < 0)
1796 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1797 fsync_object_files = git_config_bool(var, value);
1798 return 0;
1801 if (!strcmp(var, "core.preloadindex")) {
1802 core_preload_index = git_config_bool(var, value);
1803 return 0;
1806 if (!strcmp(var, "core.createobject")) {
1807 if (!strcmp(value, "rename"))
1808 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1809 else if (!strcmp(value, "link"))
1810 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1811 else
1812 die(_("invalid mode for object creation: %s"), value);
1813 return 0;
1816 if (!strcmp(var, "core.sparsecheckout")) {
1817 core_apply_sparse_checkout = git_config_bool(var, value);
1818 return 0;
1821 if (!strcmp(var, "core.sparsecheckoutcone")) {
1822 core_sparse_checkout_cone = git_config_bool(var, value);
1823 return 0;
1826 if (!strcmp(var, "core.precomposeunicode")) {
1827 precomposed_unicode = git_config_bool(var, value);
1828 return 0;
1831 if (!strcmp(var, "core.protecthfs")) {
1832 protect_hfs = git_config_bool(var, value);
1833 return 0;
1836 if (!strcmp(var, "core.protectntfs")) {
1837 protect_ntfs = git_config_bool(var, value);
1838 return 0;
1841 if (!strcmp(var, "core.usereplacerefs")) {
1842 read_replace_refs = git_config_bool(var, value);
1843 return 0;
1846 /* Add other config variables here and to Documentation/config.txt. */
1847 return platform_core_config(var, value, cb);
1850 static int git_default_sparse_config(const char *var, const char *value)
1852 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1853 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1854 return 0;
1857 /* Add other config variables here and to Documentation/config/sparse.txt. */
1858 return 0;
1861 static int git_default_i18n_config(const char *var, const char *value)
1863 if (!strcmp(var, "i18n.commitencoding"))
1864 return git_config_string(&git_commit_encoding, var, value);
1866 if (!strcmp(var, "i18n.logoutputencoding"))
1867 return git_config_string(&git_log_output_encoding, var, value);
1869 /* Add other config variables here and to Documentation/config.txt. */
1870 return 0;
1873 static int git_default_branch_config(const char *var, const char *value)
1875 if (!strcmp(var, "branch.autosetupmerge")) {
1876 if (value && !strcmp(value, "always")) {
1877 git_branch_track = BRANCH_TRACK_ALWAYS;
1878 return 0;
1879 } else if (value && !strcmp(value, "inherit")) {
1880 git_branch_track = BRANCH_TRACK_INHERIT;
1881 return 0;
1882 } else if (value && !strcmp(value, "simple")) {
1883 git_branch_track = BRANCH_TRACK_SIMPLE;
1884 return 0;
1886 git_branch_track = git_config_bool(var, value);
1887 return 0;
1889 if (!strcmp(var, "branch.autosetuprebase")) {
1890 if (!value)
1891 return config_error_nonbool(var);
1892 else if (!strcmp(value, "never"))
1893 autorebase = AUTOREBASE_NEVER;
1894 else if (!strcmp(value, "local"))
1895 autorebase = AUTOREBASE_LOCAL;
1896 else if (!strcmp(value, "remote"))
1897 autorebase = AUTOREBASE_REMOTE;
1898 else if (!strcmp(value, "always"))
1899 autorebase = AUTOREBASE_ALWAYS;
1900 else
1901 return error(_("malformed value for %s"), var);
1902 return 0;
1905 /* Add other config variables here and to Documentation/config.txt. */
1906 return 0;
1909 static int git_default_push_config(const char *var, const char *value)
1911 if (!strcmp(var, "push.default")) {
1912 if (!value)
1913 return config_error_nonbool(var);
1914 else if (!strcmp(value, "nothing"))
1915 push_default = PUSH_DEFAULT_NOTHING;
1916 else if (!strcmp(value, "matching"))
1917 push_default = PUSH_DEFAULT_MATCHING;
1918 else if (!strcmp(value, "simple"))
1919 push_default = PUSH_DEFAULT_SIMPLE;
1920 else if (!strcmp(value, "upstream"))
1921 push_default = PUSH_DEFAULT_UPSTREAM;
1922 else if (!strcmp(value, "tracking")) /* deprecated */
1923 push_default = PUSH_DEFAULT_UPSTREAM;
1924 else if (!strcmp(value, "current"))
1925 push_default = PUSH_DEFAULT_CURRENT;
1926 else {
1927 error(_("malformed value for %s: %s"), var, value);
1928 return error(_("must be one of nothing, matching, simple, "
1929 "upstream or current"));
1931 return 0;
1934 /* Add other config variables here and to Documentation/config.txt. */
1935 return 0;
1938 static int git_default_mailmap_config(const char *var, const char *value)
1940 if (!strcmp(var, "mailmap.file"))
1941 return git_config_pathname(&git_mailmap_file, var, value);
1942 if (!strcmp(var, "mailmap.blob"))
1943 return git_config_string(&git_mailmap_blob, var, value);
1945 /* Add other config variables here and to Documentation/config.txt. */
1946 return 0;
1949 int git_default_config(const char *var, const char *value, void *cb)
1951 if (starts_with(var, "core."))
1952 return git_default_core_config(var, value, cb);
1954 if (starts_with(var, "user.") ||
1955 starts_with(var, "author.") ||
1956 starts_with(var, "committer."))
1957 return git_ident_config(var, value, cb);
1959 if (starts_with(var, "i18n."))
1960 return git_default_i18n_config(var, value);
1962 if (starts_with(var, "branch."))
1963 return git_default_branch_config(var, value);
1965 if (starts_with(var, "push."))
1966 return git_default_push_config(var, value);
1968 if (starts_with(var, "mailmap."))
1969 return git_default_mailmap_config(var, value);
1971 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1972 return git_default_advice_config(var, value);
1974 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1975 pager_use_color = git_config_bool(var,value);
1976 return 0;
1979 if (!strcmp(var, "pack.packsizelimit")) {
1980 pack_size_limit_cfg = git_config_ulong(var, value);
1981 return 0;
1984 if (!strcmp(var, "pack.compression")) {
1985 int level = git_config_int(var, value);
1986 if (level == -1)
1987 level = Z_DEFAULT_COMPRESSION;
1988 else if (level < 0 || level > Z_BEST_COMPRESSION)
1989 die(_("bad pack compression level %d"), level);
1990 pack_compression_level = level;
1991 pack_compression_seen = 1;
1992 return 0;
1995 if (starts_with(var, "sparse."))
1996 return git_default_sparse_config(var, value);
1998 /* Add other config variables here and to Documentation/config.txt. */
1999 return 0;
2003 * All source specific fields in the union, die_on_error, name and the callbacks
2004 * fgetc, ungetc, ftell of top need to be initialized before calling
2005 * this function.
2007 static int do_config_from(struct config_reader *reader,
2008 struct config_source *top, config_fn_t fn, void *data,
2009 const struct config_options *opts)
2011 int ret;
2013 /* push config-file parsing state stack */
2014 top->linenr = 1;
2015 top->eof = 0;
2016 top->total_len = 0;
2017 strbuf_init(&top->value, 1024);
2018 strbuf_init(&top->var, 1024);
2019 config_reader_push_source(reader, top);
2021 ret = git_parse_source(top, fn, data, opts);
2023 /* pop config-file parsing state stack */
2024 strbuf_release(&top->value);
2025 strbuf_release(&top->var);
2026 config_reader_pop_source(reader);
2028 return ret;
2031 static int do_config_from_file(struct config_reader *reader,
2032 config_fn_t fn,
2033 const enum config_origin_type origin_type,
2034 const char *name, const char *path, FILE *f,
2035 void *data, const struct config_options *opts)
2037 struct config_source top = CONFIG_SOURCE_INIT;
2038 int ret;
2040 top.u.file = f;
2041 top.origin_type = origin_type;
2042 top.name = name;
2043 top.path = path;
2044 top.default_error_action = CONFIG_ERROR_DIE;
2045 top.do_fgetc = config_file_fgetc;
2046 top.do_ungetc = config_file_ungetc;
2047 top.do_ftell = config_file_ftell;
2049 flockfile(f);
2050 ret = do_config_from(reader, &top, fn, data, opts);
2051 funlockfile(f);
2052 return ret;
2055 static int git_config_from_stdin(config_fn_t fn, void *data)
2057 return do_config_from_file(&the_reader, fn, CONFIG_ORIGIN_STDIN, "",
2058 NULL, stdin, data, NULL);
2061 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
2062 void *data,
2063 const struct config_options *opts)
2065 int ret = -1;
2066 FILE *f;
2068 if (!filename)
2069 BUG("filename cannot be NULL");
2070 f = fopen_or_warn(filename, "r");
2071 if (f) {
2072 ret = do_config_from_file(&the_reader, fn, CONFIG_ORIGIN_FILE,
2073 filename, filename, f, data, opts);
2074 fclose(f);
2076 return ret;
2079 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
2081 return git_config_from_file_with_options(fn, filename, data, NULL);
2084 int git_config_from_mem(config_fn_t fn,
2085 const enum config_origin_type origin_type,
2086 const char *name, const char *buf, size_t len,
2087 void *data, const struct config_options *opts)
2089 struct config_source top = CONFIG_SOURCE_INIT;
2091 top.u.buf.buf = buf;
2092 top.u.buf.len = len;
2093 top.u.buf.pos = 0;
2094 top.origin_type = origin_type;
2095 top.name = name;
2096 top.path = NULL;
2097 top.default_error_action = CONFIG_ERROR_ERROR;
2098 top.do_fgetc = config_buf_fgetc;
2099 top.do_ungetc = config_buf_ungetc;
2100 top.do_ftell = config_buf_ftell;
2102 return do_config_from(&the_reader, &top, fn, data, opts);
2105 int git_config_from_blob_oid(config_fn_t fn,
2106 const char *name,
2107 struct repository *repo,
2108 const struct object_id *oid,
2109 void *data)
2111 enum object_type type;
2112 char *buf;
2113 unsigned long size;
2114 int ret;
2116 buf = repo_read_object_file(repo, oid, &type, &size);
2117 if (!buf)
2118 return error(_("unable to load config blob object '%s'"), name);
2119 if (type != OBJ_BLOB) {
2120 free(buf);
2121 return error(_("reference '%s' does not point to a blob"), name);
2124 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
2125 data, NULL);
2126 free(buf);
2128 return ret;
2131 static int git_config_from_blob_ref(config_fn_t fn,
2132 struct repository *repo,
2133 const char *name,
2134 void *data)
2136 struct object_id oid;
2138 if (repo_get_oid(repo, name, &oid) < 0)
2139 return error(_("unable to resolve config blob '%s'"), name);
2140 return git_config_from_blob_oid(fn, name, repo, &oid, data);
2143 char *git_system_config(void)
2145 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2146 if (!system_config)
2147 system_config = system_path(ETC_GITCONFIG);
2148 normalize_path_copy(system_config, system_config);
2149 return system_config;
2152 void git_global_config(char **user_out, char **xdg_out)
2154 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2155 char *xdg_config = NULL;
2157 if (!user_config) {
2158 user_config = interpolate_path("~/.gitconfig", 0);
2159 xdg_config = xdg_config_home("config");
2162 *user_out = user_config;
2163 *xdg_out = xdg_config;
2167 * Parse environment variable 'k' as a boolean (in various
2168 * possible spellings); if missing, use the default value 'def'.
2170 int git_env_bool(const char *k, int def)
2172 const char *v = getenv(k);
2173 return v ? git_config_bool(k, v) : def;
2177 * Parse environment variable 'k' as ulong with possibly a unit
2178 * suffix; if missing, use the default value 'val'.
2180 unsigned long git_env_ulong(const char *k, unsigned long val)
2182 const char *v = getenv(k);
2183 if (v && !git_parse_ulong(v, &val))
2184 die(_("failed to parse %s"), k);
2185 return val;
2188 int git_config_system(void)
2190 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2193 static int do_git_config_sequence(struct config_reader *reader,
2194 const struct config_options *opts,
2195 config_fn_t fn, void *data)
2197 int ret = 0;
2198 char *system_config = git_system_config();
2199 char *xdg_config = NULL;
2200 char *user_config = NULL;
2201 char *repo_config;
2202 enum config_scope prev_parsing_scope = reader->parsing_scope;
2204 if (opts->commondir)
2205 repo_config = mkpathdup("%s/config", opts->commondir);
2206 else if (opts->git_dir)
2207 BUG("git_dir without commondir");
2208 else
2209 repo_config = NULL;
2211 config_reader_set_scope(reader, CONFIG_SCOPE_SYSTEM);
2212 if (git_config_system() && system_config &&
2213 !access_or_die(system_config, R_OK,
2214 opts->system_gently ? ACCESS_EACCES_OK : 0))
2215 ret += git_config_from_file(fn, system_config, data);
2217 config_reader_set_scope(reader, CONFIG_SCOPE_GLOBAL);
2218 git_global_config(&user_config, &xdg_config);
2220 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2221 ret += git_config_from_file(fn, xdg_config, data);
2223 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2224 ret += git_config_from_file(fn, user_config, data);
2226 config_reader_set_scope(reader, CONFIG_SCOPE_LOCAL);
2227 if (!opts->ignore_repo && repo_config &&
2228 !access_or_die(repo_config, R_OK, 0))
2229 ret += git_config_from_file(fn, repo_config, data);
2231 config_reader_set_scope(reader, CONFIG_SCOPE_WORKTREE);
2232 if (!opts->ignore_worktree && repository_format_worktree_config) {
2233 char *path = git_pathdup("config.worktree");
2234 if (!access_or_die(path, R_OK, 0))
2235 ret += git_config_from_file(fn, path, data);
2236 free(path);
2239 config_reader_set_scope(reader, CONFIG_SCOPE_COMMAND);
2240 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2241 die(_("unable to parse command-line config"));
2243 config_reader_set_scope(reader, prev_parsing_scope);
2244 free(system_config);
2245 free(xdg_config);
2246 free(user_config);
2247 free(repo_config);
2248 return ret;
2251 int config_with_options(config_fn_t fn, void *data,
2252 struct git_config_source *config_source,
2253 const struct config_options *opts)
2255 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2256 enum config_scope prev_scope = the_reader.parsing_scope;
2257 int ret;
2259 if (opts->respect_includes) {
2260 inc.fn = fn;
2261 inc.data = data;
2262 inc.opts = opts;
2263 inc.config_source = config_source;
2264 inc.config_reader = &the_reader;
2265 fn = git_config_include;
2266 data = &inc;
2269 if (config_source)
2270 config_reader_set_scope(&the_reader, config_source->scope);
2273 * If we have a specific filename, use it. Otherwise, follow the
2274 * regular lookup sequence.
2276 if (config_source && config_source->use_stdin) {
2277 ret = git_config_from_stdin(fn, data);
2278 } else if (config_source && config_source->file) {
2279 ret = git_config_from_file(fn, config_source->file, data);
2280 } else if (config_source && config_source->blob) {
2281 struct repository *repo = config_source->repo ?
2282 config_source->repo : the_repository;
2283 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2284 data);
2285 } else {
2286 ret = do_git_config_sequence(&the_reader, opts, fn, data);
2289 if (inc.remote_urls) {
2290 string_list_clear(inc.remote_urls, 0);
2291 FREE_AND_NULL(inc.remote_urls);
2293 config_reader_set_scope(&the_reader, prev_scope);
2294 return ret;
2297 static void configset_iter(struct config_reader *reader, struct config_set *set,
2298 config_fn_t fn, void *data)
2300 int i, value_index;
2301 struct string_list *values;
2302 struct config_set_element *entry;
2303 struct configset_list *list = &set->list;
2305 for (i = 0; i < list->nr; i++) {
2306 entry = list->items[i].e;
2307 value_index = list->items[i].value_index;
2308 values = &entry->value_list;
2310 config_reader_set_kvi(reader, values->items[value_index].util);
2312 if (fn(entry->key, values->items[value_index].string, data) < 0)
2313 git_die_config_linenr(entry->key,
2314 reader->config_kvi->filename,
2315 reader->config_kvi->linenr);
2317 config_reader_set_kvi(reader, NULL);
2321 void read_early_config(config_fn_t cb, void *data)
2323 struct config_options opts = {0};
2324 struct strbuf commondir = STRBUF_INIT;
2325 struct strbuf gitdir = STRBUF_INIT;
2327 opts.respect_includes = 1;
2329 if (have_git_dir()) {
2330 opts.commondir = get_git_common_dir();
2331 opts.git_dir = get_git_dir();
2333 * When setup_git_directory() was not yet asked to discover the
2334 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2335 * is any repository config we should use (but unlike
2336 * setup_git_directory_gently(), no global state is changed, most
2337 * notably, the current working directory is still the same after the
2338 * call).
2340 } else if (!discover_git_directory(&commondir, &gitdir)) {
2341 opts.commondir = commondir.buf;
2342 opts.git_dir = gitdir.buf;
2345 config_with_options(cb, data, NULL, &opts);
2347 strbuf_release(&commondir);
2348 strbuf_release(&gitdir);
2352 * Read config but only enumerate system and global settings.
2353 * Omit any repo-local, worktree-local, or command-line settings.
2355 void read_very_early_config(config_fn_t cb, void *data)
2357 struct config_options opts = { 0 };
2359 opts.respect_includes = 1;
2360 opts.ignore_repo = 1;
2361 opts.ignore_worktree = 1;
2362 opts.ignore_cmdline = 1;
2363 opts.system_gently = 1;
2365 config_with_options(cb, data, NULL, &opts);
2368 RESULT_MUST_BE_USED
2369 static int configset_find_element(struct config_set *set, const char *key,
2370 struct config_set_element **dest)
2372 struct config_set_element k;
2373 struct config_set_element *found_entry;
2374 char *normalized_key;
2375 int ret;
2378 * `key` may come from the user, so normalize it before using it
2379 * for querying entries from the hashmap.
2381 ret = git_config_parse_key(key, &normalized_key, NULL);
2382 if (ret)
2383 return ret;
2385 hashmap_entry_init(&k.ent, strhash(normalized_key));
2386 k.key = normalized_key;
2387 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2388 free(normalized_key);
2389 *dest = found_entry;
2390 return 0;
2393 static int configset_add_value(struct config_reader *reader,
2394 struct config_set *set, const char *key,
2395 const char *value)
2397 struct config_set_element *e;
2398 struct string_list_item *si;
2399 struct configset_list_item *l_item;
2400 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2401 int ret;
2403 ret = configset_find_element(set, key, &e);
2404 if (ret)
2405 return ret;
2407 * Since the keys are being fed by git_config*() callback mechanism, they
2408 * are already normalized. So simply add them without any further munging.
2410 if (!e) {
2411 e = xmalloc(sizeof(*e));
2412 hashmap_entry_init(&e->ent, strhash(key));
2413 e->key = xstrdup(key);
2414 string_list_init_dup(&e->value_list);
2415 hashmap_add(&set->config_hash, &e->ent);
2417 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2419 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2420 l_item = &set->list.items[set->list.nr++];
2421 l_item->e = e;
2422 l_item->value_index = e->value_list.nr - 1;
2424 if (!reader->source)
2425 BUG("configset_add_value has no source");
2426 if (reader->source->name) {
2427 kv_info->filename = strintern(reader->source->name);
2428 kv_info->linenr = reader->source->linenr;
2429 kv_info->origin_type = reader->source->origin_type;
2430 } else {
2431 /* for values read from `git_config_from_parameters()` */
2432 kv_info->filename = NULL;
2433 kv_info->linenr = -1;
2434 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
2436 kv_info->scope = reader->parsing_scope;
2437 si->util = kv_info;
2439 return 0;
2442 static int config_set_element_cmp(const void *cmp_data UNUSED,
2443 const struct hashmap_entry *eptr,
2444 const struct hashmap_entry *entry_or_key,
2445 const void *keydata UNUSED)
2447 const struct config_set_element *e1, *e2;
2449 e1 = container_of(eptr, const struct config_set_element, ent);
2450 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2452 return strcmp(e1->key, e2->key);
2455 void git_configset_init(struct config_set *set)
2457 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2458 set->hash_initialized = 1;
2459 set->list.nr = 0;
2460 set->list.alloc = 0;
2461 set->list.items = NULL;
2464 void git_configset_clear(struct config_set *set)
2466 struct config_set_element *entry;
2467 struct hashmap_iter iter;
2468 if (!set->hash_initialized)
2469 return;
2471 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2472 ent /* member name */) {
2473 free(entry->key);
2474 string_list_clear(&entry->value_list, 1);
2476 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2477 set->hash_initialized = 0;
2478 free(set->list.items);
2479 set->list.nr = 0;
2480 set->list.alloc = 0;
2481 set->list.items = NULL;
2484 struct configset_add_data {
2485 struct config_set *config_set;
2486 struct config_reader *config_reader;
2488 #define CONFIGSET_ADD_INIT { 0 }
2490 static int config_set_callback(const char *key, const char *value, void *cb)
2492 struct configset_add_data *data = cb;
2493 configset_add_value(data->config_reader, data->config_set, key, value);
2494 return 0;
2497 int git_configset_add_file(struct config_set *set, const char *filename)
2499 struct configset_add_data data = CONFIGSET_ADD_INIT;
2500 data.config_reader = &the_reader;
2501 data.config_set = set;
2502 return git_config_from_file(config_set_callback, filename, &data);
2505 int git_configset_get_value(struct config_set *set, const char *key, const char **value)
2507 const struct string_list *values = NULL;
2508 int ret;
2511 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2512 * queried key in the files of the configset, the value returned will be the last
2513 * value in the value list for that key.
2515 if ((ret = git_configset_get_value_multi(set, key, &values)))
2516 return ret;
2518 assert(values->nr > 0);
2519 *value = values->items[values->nr - 1].string;
2520 return 0;
2523 int git_configset_get_value_multi(struct config_set *set, const char *key,
2524 const struct string_list **dest)
2526 struct config_set_element *e;
2527 int ret;
2529 if ((ret = configset_find_element(set, key, &e)))
2530 return ret;
2531 else if (!e)
2532 return 1;
2533 *dest = &e->value_list;
2535 return 0;
2538 static int check_multi_string(struct string_list_item *item, void *util)
2540 return item->string ? 0 : config_error_nonbool(util);
2543 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2544 const struct string_list **dest)
2546 int ret;
2548 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2549 return ret;
2550 if ((ret = for_each_string_list((struct string_list *)*dest,
2551 check_multi_string, (void *)key)))
2552 return ret;
2554 return 0;
2557 int git_configset_get(struct config_set *set, const char *key)
2559 struct config_set_element *e;
2560 int ret;
2562 if ((ret = configset_find_element(set, key, &e)))
2563 return ret;
2564 else if (!e)
2565 return 1;
2566 return 0;
2569 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2571 const char *value;
2572 if (!git_configset_get_value(set, key, &value))
2573 return git_config_string((const char **)dest, key, value);
2574 else
2575 return 1;
2578 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2579 const char **dest)
2581 const char *value;
2582 if (!git_configset_get_value(set, key, &value)) {
2583 if (!value)
2584 return config_error_nonbool(key);
2585 *dest = value;
2586 return 0;
2587 } else {
2588 return 1;
2592 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2594 const char *value;
2595 if (!git_configset_get_value(set, key, &value)) {
2596 *dest = git_config_int(key, value);
2597 return 0;
2598 } else
2599 return 1;
2602 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2604 const char *value;
2605 if (!git_configset_get_value(set, key, &value)) {
2606 *dest = git_config_ulong(key, value);
2607 return 0;
2608 } else
2609 return 1;
2612 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2614 const char *value;
2615 if (!git_configset_get_value(set, key, &value)) {
2616 *dest = git_config_bool(key, value);
2617 return 0;
2618 } else
2619 return 1;
2622 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2623 int *is_bool, int *dest)
2625 const char *value;
2626 if (!git_configset_get_value(set, key, &value)) {
2627 *dest = git_config_bool_or_int(key, value, is_bool);
2628 return 0;
2629 } else
2630 return 1;
2633 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2635 const char *value;
2636 if (!git_configset_get_value(set, key, &value)) {
2637 *dest = git_parse_maybe_bool(value);
2638 if (*dest == -1)
2639 return -1;
2640 return 0;
2641 } else
2642 return 1;
2645 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2647 const char *value;
2648 if (!git_configset_get_value(set, key, &value))
2649 return git_config_pathname(dest, key, value);
2650 else
2651 return 1;
2654 /* Functions use to read configuration from a repository */
2655 static void repo_read_config(struct repository *repo)
2657 struct config_options opts = { 0 };
2658 struct configset_add_data data = CONFIGSET_ADD_INIT;
2660 opts.respect_includes = 1;
2661 opts.commondir = repo->commondir;
2662 opts.git_dir = repo->gitdir;
2664 if (!repo->config)
2665 CALLOC_ARRAY(repo->config, 1);
2666 else
2667 git_configset_clear(repo->config);
2669 git_configset_init(repo->config);
2670 data.config_set = repo->config;
2671 data.config_reader = &the_reader;
2673 if (config_with_options(config_set_callback, &data, NULL, &opts) < 0)
2675 * config_with_options() normally returns only
2676 * zero, as most errors are fatal, and
2677 * non-fatal potential errors are guarded by "if"
2678 * statements that are entered only when no error is
2679 * possible.
2681 * If we ever encounter a non-fatal error, it means
2682 * something went really wrong and we should stop
2683 * immediately.
2685 die(_("unknown error occurred while reading the configuration files"));
2688 static void git_config_check_init(struct repository *repo)
2690 if (repo->config && repo->config->hash_initialized)
2691 return;
2692 repo_read_config(repo);
2695 static void repo_config_clear(struct repository *repo)
2697 if (!repo->config || !repo->config->hash_initialized)
2698 return;
2699 git_configset_clear(repo->config);
2702 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2704 git_config_check_init(repo);
2705 configset_iter(&the_reader, repo->config, fn, data);
2708 int repo_config_get(struct repository *repo, const char *key)
2710 git_config_check_init(repo);
2711 return git_configset_get(repo->config, key);
2714 int repo_config_get_value(struct repository *repo,
2715 const char *key, const char **value)
2717 git_config_check_init(repo);
2718 return git_configset_get_value(repo->config, key, value);
2721 int repo_config_get_value_multi(struct repository *repo, const char *key,
2722 const struct string_list **dest)
2724 git_config_check_init(repo);
2725 return git_configset_get_value_multi(repo->config, key, dest);
2728 int repo_config_get_string_multi(struct repository *repo, const char *key,
2729 const struct string_list **dest)
2731 git_config_check_init(repo);
2732 return git_configset_get_string_multi(repo->config, key, dest);
2735 int repo_config_get_string(struct repository *repo,
2736 const char *key, char **dest)
2738 int ret;
2739 git_config_check_init(repo);
2740 ret = git_configset_get_string(repo->config, key, dest);
2741 if (ret < 0)
2742 git_die_config(key, NULL);
2743 return ret;
2746 int repo_config_get_string_tmp(struct repository *repo,
2747 const char *key, const char **dest)
2749 int ret;
2750 git_config_check_init(repo);
2751 ret = git_configset_get_string_tmp(repo->config, key, dest);
2752 if (ret < 0)
2753 git_die_config(key, NULL);
2754 return ret;
2757 int repo_config_get_int(struct repository *repo,
2758 const char *key, int *dest)
2760 git_config_check_init(repo);
2761 return git_configset_get_int(repo->config, key, dest);
2764 int repo_config_get_ulong(struct repository *repo,
2765 const char *key, unsigned long *dest)
2767 git_config_check_init(repo);
2768 return git_configset_get_ulong(repo->config, key, dest);
2771 int repo_config_get_bool(struct repository *repo,
2772 const char *key, int *dest)
2774 git_config_check_init(repo);
2775 return git_configset_get_bool(repo->config, key, dest);
2778 int repo_config_get_bool_or_int(struct repository *repo,
2779 const char *key, int *is_bool, int *dest)
2781 git_config_check_init(repo);
2782 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2785 int repo_config_get_maybe_bool(struct repository *repo,
2786 const char *key, int *dest)
2788 git_config_check_init(repo);
2789 return git_configset_get_maybe_bool(repo->config, key, dest);
2792 int repo_config_get_pathname(struct repository *repo,
2793 const char *key, const char **dest)
2795 int ret;
2796 git_config_check_init(repo);
2797 ret = git_configset_get_pathname(repo->config, key, dest);
2798 if (ret < 0)
2799 git_die_config(key, NULL);
2800 return ret;
2803 /* Read values into protected_config. */
2804 static void read_protected_config(void)
2806 struct config_options opts = {
2807 .respect_includes = 1,
2808 .ignore_repo = 1,
2809 .ignore_worktree = 1,
2810 .system_gently = 1,
2812 struct configset_add_data data = CONFIGSET_ADD_INIT;
2814 git_configset_init(&protected_config);
2815 data.config_set = &protected_config;
2816 data.config_reader = &the_reader;
2817 config_with_options(config_set_callback, &data, NULL, &opts);
2820 void git_protected_config(config_fn_t fn, void *data)
2822 if (!protected_config.hash_initialized)
2823 read_protected_config();
2824 configset_iter(&the_reader, &protected_config, fn, data);
2827 /* Functions used historically to read configuration from 'the_repository' */
2828 void git_config(config_fn_t fn, void *data)
2830 repo_config(the_repository, fn, data);
2833 void git_config_clear(void)
2835 repo_config_clear(the_repository);
2838 int git_config_get(const char *key)
2840 return repo_config_get(the_repository, key);
2843 int git_config_get_value(const char *key, const char **value)
2845 return repo_config_get_value(the_repository, key, value);
2848 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2850 return repo_config_get_value_multi(the_repository, key, dest);
2853 int git_config_get_string_multi(const char *key,
2854 const struct string_list **dest)
2856 return repo_config_get_string_multi(the_repository, key, dest);
2859 int git_config_get_string(const char *key, char **dest)
2861 return repo_config_get_string(the_repository, key, dest);
2864 int git_config_get_string_tmp(const char *key, const char **dest)
2866 return repo_config_get_string_tmp(the_repository, key, dest);
2869 int git_config_get_int(const char *key, int *dest)
2871 return repo_config_get_int(the_repository, key, dest);
2874 int git_config_get_ulong(const char *key, unsigned long *dest)
2876 return repo_config_get_ulong(the_repository, key, dest);
2879 int git_config_get_bool(const char *key, int *dest)
2881 return repo_config_get_bool(the_repository, key, dest);
2884 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2886 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2889 int git_config_get_maybe_bool(const char *key, int *dest)
2891 return repo_config_get_maybe_bool(the_repository, key, dest);
2894 int git_config_get_pathname(const char *key, const char **dest)
2896 return repo_config_get_pathname(the_repository, key, dest);
2899 int git_config_get_expiry(const char *key, const char **output)
2901 int ret = git_config_get_string(key, (char **)output);
2902 if (ret)
2903 return ret;
2904 if (strcmp(*output, "now")) {
2905 timestamp_t now = approxidate("now");
2906 if (approxidate(*output) >= now)
2907 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2909 return ret;
2912 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2914 const char *expiry_string;
2915 intmax_t days;
2916 timestamp_t when;
2918 if (git_config_get_string_tmp(key, &expiry_string))
2919 return 1; /* no such thing */
2921 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2922 const int scale = 86400;
2923 *expiry = now - days * scale;
2924 return 0;
2927 if (!parse_expiry_date(expiry_string, &when)) {
2928 *expiry = when;
2929 return 0;
2931 return -1; /* thing exists but cannot be parsed */
2934 int git_config_get_split_index(void)
2936 int val;
2938 if (!git_config_get_maybe_bool("core.splitindex", &val))
2939 return val;
2941 return -1; /* default value */
2944 int git_config_get_max_percent_split_change(void)
2946 int val = -1;
2948 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2949 if (0 <= val && val <= 100)
2950 return val;
2952 return error(_("splitIndex.maxPercentChange value '%d' "
2953 "should be between 0 and 100"), val);
2956 return -1; /* default value */
2959 int git_config_get_index_threads(int *dest)
2961 int is_bool, val;
2963 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2964 if (val) {
2965 *dest = val;
2966 return 0;
2969 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2970 if (is_bool)
2971 *dest = val ? 0 : 1;
2972 else
2973 *dest = val;
2974 return 0;
2977 return 1;
2980 NORETURN
2981 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2983 if (!filename)
2984 die(_("unable to parse '%s' from command-line config"), key);
2985 else
2986 die(_("bad config variable '%s' in file '%s' at line %d"),
2987 key, filename, linenr);
2990 NORETURN __attribute__((format(printf, 2, 3)))
2991 void git_die_config(const char *key, const char *err, ...)
2993 const struct string_list *values;
2994 struct key_value_info *kv_info;
2995 report_fn error_fn = get_error_routine();
2997 if (err) {
2998 va_list params;
2999 va_start(params, err);
3000 error_fn(err, params);
3001 va_end(params);
3003 if (git_config_get_value_multi(key, &values))
3004 BUG("for key '%s' we must have a value to report on", key);
3005 kv_info = values->items[values->nr - 1].util;
3006 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
3010 * Find all the stuff for git_config_set() below.
3013 struct config_store_data {
3014 struct config_reader *config_reader;
3015 size_t baselen;
3016 char *key;
3017 int do_not_match;
3018 const char *fixed_value;
3019 regex_t *value_pattern;
3020 int multi_replace;
3021 struct {
3022 size_t begin, end;
3023 enum config_event_t type;
3024 int is_keys_section;
3025 } *parsed;
3026 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
3027 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
3029 #define CONFIG_STORE_INIT { 0 }
3031 static void config_store_data_clear(struct config_store_data *store)
3033 free(store->key);
3034 if (store->value_pattern != NULL &&
3035 store->value_pattern != CONFIG_REGEX_NONE) {
3036 regfree(store->value_pattern);
3037 free(store->value_pattern);
3039 free(store->parsed);
3040 free(store->seen);
3041 memset(store, 0, sizeof(*store));
3044 static int matches(const char *key, const char *value,
3045 const struct config_store_data *store)
3047 if (strcmp(key, store->key))
3048 return 0; /* not ours */
3049 if (store->fixed_value)
3050 return !strcmp(store->fixed_value, value);
3051 if (!store->value_pattern)
3052 return 1; /* always matches */
3053 if (store->value_pattern == CONFIG_REGEX_NONE)
3054 return 0; /* never matches */
3056 return store->do_not_match ^
3057 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
3060 static int store_aux_event(enum config_event_t type,
3061 size_t begin, size_t end, void *data)
3063 struct config_store_data *store = data;
3064 struct config_source *cs = store->config_reader->source;
3066 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
3067 store->parsed[store->parsed_nr].begin = begin;
3068 store->parsed[store->parsed_nr].end = end;
3069 store->parsed[store->parsed_nr].type = type;
3071 if (type == CONFIG_EVENT_SECTION) {
3072 int (*cmpfn)(const char *, const char *, size_t);
3074 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
3075 return error(_("invalid section name '%s'"), cs->var.buf);
3077 if (cs->subsection_case_sensitive)
3078 cmpfn = strncasecmp;
3079 else
3080 cmpfn = strncmp;
3082 /* Is this the section we were looking for? */
3083 store->is_keys_section =
3084 store->parsed[store->parsed_nr].is_keys_section =
3085 cs->var.len - 1 == store->baselen &&
3086 !cmpfn(cs->var.buf, store->key, store->baselen);
3087 if (store->is_keys_section) {
3088 store->section_seen = 1;
3089 ALLOC_GROW(store->seen, store->seen_nr + 1,
3090 store->seen_alloc);
3091 store->seen[store->seen_nr] = store->parsed_nr;
3095 store->parsed_nr++;
3097 return 0;
3100 static int store_aux(const char *key, const char *value, void *cb)
3102 struct config_store_data *store = cb;
3104 if (store->key_seen) {
3105 if (matches(key, value, store)) {
3106 if (store->seen_nr == 1 && store->multi_replace == 0) {
3107 warning(_("%s has multiple values"), key);
3110 ALLOC_GROW(store->seen, store->seen_nr + 1,
3111 store->seen_alloc);
3113 store->seen[store->seen_nr] = store->parsed_nr;
3114 store->seen_nr++;
3116 } else if (store->is_keys_section) {
3118 * Do not increment matches yet: this may not be a match, but we
3119 * are in the desired section.
3121 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
3122 store->seen[store->seen_nr] = store->parsed_nr;
3123 store->section_seen = 1;
3125 if (matches(key, value, store)) {
3126 store->seen_nr++;
3127 store->key_seen = 1;
3131 return 0;
3134 static int write_error(const char *filename)
3136 error(_("failed to write new configuration file %s"), filename);
3138 /* Same error code as "failed to rename". */
3139 return 4;
3142 static struct strbuf store_create_section(const char *key,
3143 const struct config_store_data *store)
3145 const char *dot;
3146 size_t i;
3147 struct strbuf sb = STRBUF_INIT;
3149 dot = memchr(key, '.', store->baselen);
3150 if (dot) {
3151 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
3152 for (i = dot - key + 1; i < store->baselen; i++) {
3153 if (key[i] == '"' || key[i] == '\\')
3154 strbuf_addch(&sb, '\\');
3155 strbuf_addch(&sb, key[i]);
3157 strbuf_addstr(&sb, "\"]\n");
3158 } else {
3159 strbuf_addch(&sb, '[');
3160 strbuf_add(&sb, key, store->baselen);
3161 strbuf_addstr(&sb, "]\n");
3164 return sb;
3167 static ssize_t write_section(int fd, const char *key,
3168 const struct config_store_data *store)
3170 struct strbuf sb = store_create_section(key, store);
3171 ssize_t ret;
3173 ret = write_in_full(fd, sb.buf, sb.len);
3174 strbuf_release(&sb);
3176 return ret;
3179 static ssize_t write_pair(int fd, const char *key, const char *value,
3180 const struct config_store_data *store)
3182 int i;
3183 ssize_t ret;
3184 const char *quote = "";
3185 struct strbuf sb = STRBUF_INIT;
3188 * Check to see if the value needs to be surrounded with a dq pair.
3189 * Note that problematic characters are always backslash-quoted; this
3190 * check is about not losing leading or trailing SP and strings that
3191 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3192 * configuration parser.
3194 if (value[0] == ' ')
3195 quote = "\"";
3196 for (i = 0; value[i]; i++)
3197 if (value[i] == ';' || value[i] == '#')
3198 quote = "\"";
3199 if (i && value[i - 1] == ' ')
3200 quote = "\"";
3202 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3204 for (i = 0; value[i]; i++)
3205 switch (value[i]) {
3206 case '\n':
3207 strbuf_addstr(&sb, "\\n");
3208 break;
3209 case '\t':
3210 strbuf_addstr(&sb, "\\t");
3211 break;
3212 case '"':
3213 case '\\':
3214 strbuf_addch(&sb, '\\');
3215 /* fallthrough */
3216 default:
3217 strbuf_addch(&sb, value[i]);
3218 break;
3220 strbuf_addf(&sb, "%s\n", quote);
3222 ret = write_in_full(fd, sb.buf, sb.len);
3223 strbuf_release(&sb);
3225 return ret;
3229 * If we are about to unset the last key(s) in a section, and if there are
3230 * no comments surrounding (or included in) the section, we will want to
3231 * extend begin/end to remove the entire section.
3233 * Note: the parameter `seen_ptr` points to the index into the store.seen
3234 * array. * This index may be incremented if a section has more than one
3235 * entry (which all are to be removed).
3237 static void maybe_remove_section(struct config_store_data *store,
3238 size_t *begin_offset, size_t *end_offset,
3239 int *seen_ptr)
3241 size_t begin;
3242 int i, seen, section_seen = 0;
3245 * First, ensure that this is the first key, and that there are no
3246 * comments before the entry nor before the section header.
3248 seen = *seen_ptr;
3249 for (i = store->seen[seen]; i > 0; i--) {
3250 enum config_event_t type = store->parsed[i - 1].type;
3252 if (type == CONFIG_EVENT_COMMENT)
3253 /* There is a comment before this entry or section */
3254 return;
3255 if (type == CONFIG_EVENT_ENTRY) {
3256 if (!section_seen)
3257 /* This is not the section's first entry. */
3258 return;
3259 /* We encountered no comment before the section. */
3260 break;
3262 if (type == CONFIG_EVENT_SECTION) {
3263 if (!store->parsed[i - 1].is_keys_section)
3264 break;
3265 section_seen = 1;
3268 begin = store->parsed[i].begin;
3271 * Next, make sure that we are removing the last key(s) in the section,
3272 * and that there are no comments that are possibly about the current
3273 * section.
3275 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3276 enum config_event_t type = store->parsed[i].type;
3278 if (type == CONFIG_EVENT_COMMENT)
3279 return;
3280 if (type == CONFIG_EVENT_SECTION) {
3281 if (store->parsed[i].is_keys_section)
3282 continue;
3283 break;
3285 if (type == CONFIG_EVENT_ENTRY) {
3286 if (++seen < store->seen_nr &&
3287 i == store->seen[seen])
3288 /* We want to remove this entry, too */
3289 continue;
3290 /* There is another entry in this section. */
3291 return;
3296 * We are really removing the last entry/entries from this section, and
3297 * there are no enclosed or surrounding comments. Remove the entire,
3298 * now-empty section.
3300 *seen_ptr = seen;
3301 *begin_offset = begin;
3302 if (i < store->parsed_nr)
3303 *end_offset = store->parsed[i].begin;
3304 else
3305 *end_offset = store->parsed[store->parsed_nr - 1].end;
3308 int git_config_set_in_file_gently(const char *config_filename,
3309 const char *key, const char *value)
3311 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3314 void git_config_set_in_file(const char *config_filename,
3315 const char *key, const char *value)
3317 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3320 int git_config_set_gently(const char *key, const char *value)
3322 return git_config_set_multivar_gently(key, value, NULL, 0);
3325 int repo_config_set_worktree_gently(struct repository *r,
3326 const char *key, const char *value)
3328 /* Only use worktree-specific config if it is already enabled. */
3329 if (repository_format_worktree_config) {
3330 char *file = repo_git_path(r, "config.worktree");
3331 int ret = git_config_set_multivar_in_file_gently(
3332 file, key, value, NULL, 0);
3333 free(file);
3334 return ret;
3336 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3339 void git_config_set(const char *key, const char *value)
3341 git_config_set_multivar(key, value, NULL, 0);
3343 trace2_cmd_set_config(key, value);
3347 * If value==NULL, unset in (remove from) config,
3348 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3349 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3350 * (only add a new one)
3351 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3352 * key/values are removed before a single new pair is written. If the
3353 * flag is not present, then replace only the first match.
3355 * Returns 0 on success.
3357 * This function does this:
3359 * - it locks the config file by creating ".git/config.lock"
3361 * - it then parses the config using store_aux() as validator to find
3362 * the position on the key/value pair to replace. If it is to be unset,
3363 * it must be found exactly once.
3365 * - the config file is mmap()ed and the part before the match (if any) is
3366 * written to the lock file, then the changed part and the rest.
3368 * - the config file is removed and the lock file rename()d to it.
3371 int git_config_set_multivar_in_file_gently(const char *config_filename,
3372 const char *key, const char *value,
3373 const char *value_pattern,
3374 unsigned flags)
3376 int fd = -1, in_fd = -1;
3377 int ret;
3378 struct lock_file lock = LOCK_INIT;
3379 char *filename_buf = NULL;
3380 char *contents = NULL;
3381 size_t contents_sz;
3382 struct config_store_data store = CONFIG_STORE_INIT;
3384 store.config_reader = &the_reader;
3386 /* parse-key returns negative; flip the sign to feed exit(3) */
3387 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3388 if (ret)
3389 goto out_free;
3391 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3393 if (!config_filename)
3394 config_filename = filename_buf = git_pathdup("config");
3397 * The lock serves a purpose in addition to locking: the new
3398 * contents of .git/config will be written into it.
3400 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3401 if (fd < 0) {
3402 error_errno(_("could not lock config file %s"), config_filename);
3403 ret = CONFIG_NO_LOCK;
3404 goto out_free;
3408 * If .git/config does not exist yet, write a minimal version.
3410 in_fd = open(config_filename, O_RDONLY);
3411 if ( in_fd < 0 ) {
3412 if ( ENOENT != errno ) {
3413 error_errno(_("opening %s"), config_filename);
3414 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3415 goto out_free;
3417 /* if nothing to unset, error out */
3418 if (!value) {
3419 ret = CONFIG_NOTHING_SET;
3420 goto out_free;
3423 free(store.key);
3424 store.key = xstrdup(key);
3425 if (write_section(fd, key, &store) < 0 ||
3426 write_pair(fd, key, value, &store) < 0)
3427 goto write_err_out;
3428 } else {
3429 struct stat st;
3430 size_t copy_begin, copy_end;
3431 int i, new_line = 0;
3432 struct config_options opts;
3434 if (!value_pattern)
3435 store.value_pattern = NULL;
3436 else if (value_pattern == CONFIG_REGEX_NONE)
3437 store.value_pattern = CONFIG_REGEX_NONE;
3438 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3439 store.fixed_value = value_pattern;
3440 else {
3441 if (value_pattern[0] == '!') {
3442 store.do_not_match = 1;
3443 value_pattern++;
3444 } else
3445 store.do_not_match = 0;
3447 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3448 if (regcomp(store.value_pattern, value_pattern,
3449 REG_EXTENDED)) {
3450 error(_("invalid pattern: %s"), value_pattern);
3451 FREE_AND_NULL(store.value_pattern);
3452 ret = CONFIG_INVALID_PATTERN;
3453 goto out_free;
3457 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3458 store.parsed[0].end = 0;
3460 memset(&opts, 0, sizeof(opts));
3461 opts.event_fn = store_aux_event;
3462 opts.event_fn_data = &store;
3465 * After this, store.parsed will contain offsets of all the
3466 * parsed elements, and store.seen will contain a list of
3467 * matches, as indices into store.parsed.
3469 * As a side effect, we make sure to transform only a valid
3470 * existing config file.
3472 if (git_config_from_file_with_options(store_aux,
3473 config_filename,
3474 &store, &opts)) {
3475 error(_("invalid config file %s"), config_filename);
3476 ret = CONFIG_INVALID_FILE;
3477 goto out_free;
3480 /* if nothing to unset, or too many matches, error out */
3481 if ((store.seen_nr == 0 && value == NULL) ||
3482 (store.seen_nr > 1 && !store.multi_replace)) {
3483 ret = CONFIG_NOTHING_SET;
3484 goto out_free;
3487 if (fstat(in_fd, &st) == -1) {
3488 error_errno(_("fstat on %s failed"), config_filename);
3489 ret = CONFIG_INVALID_FILE;
3490 goto out_free;
3493 contents_sz = xsize_t(st.st_size);
3494 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3495 MAP_PRIVATE, in_fd, 0);
3496 if (contents == MAP_FAILED) {
3497 if (errno == ENODEV && S_ISDIR(st.st_mode))
3498 errno = EISDIR;
3499 error_errno(_("unable to mmap '%s'%s"),
3500 config_filename, mmap_os_err());
3501 ret = CONFIG_INVALID_FILE;
3502 contents = NULL;
3503 goto out_free;
3505 close(in_fd);
3506 in_fd = -1;
3508 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3509 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3510 ret = CONFIG_NO_WRITE;
3511 goto out_free;
3514 if (store.seen_nr == 0) {
3515 if (!store.seen_alloc) {
3516 /* Did not see key nor section */
3517 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3518 store.seen[0] = store.parsed_nr
3519 - !!store.parsed_nr;
3521 store.seen_nr = 1;
3524 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3525 size_t replace_end;
3526 int j = store.seen[i];
3528 new_line = 0;
3529 if (!store.key_seen) {
3530 copy_end = store.parsed[j].end;
3531 /* include '\n' when copying section header */
3532 if (copy_end > 0 && copy_end < contents_sz &&
3533 contents[copy_end - 1] != '\n' &&
3534 contents[copy_end] == '\n')
3535 copy_end++;
3536 replace_end = copy_end;
3537 } else {
3538 replace_end = store.parsed[j].end;
3539 copy_end = store.parsed[j].begin;
3540 if (!value)
3541 maybe_remove_section(&store,
3542 &copy_end,
3543 &replace_end, &i);
3545 * Swallow preceding white-space on the same
3546 * line.
3548 while (copy_end > 0 ) {
3549 char c = contents[copy_end - 1];
3551 if (isspace(c) && c != '\n')
3552 copy_end--;
3553 else
3554 break;
3558 if (copy_end > 0 && contents[copy_end-1] != '\n')
3559 new_line = 1;
3561 /* write the first part of the config */
3562 if (copy_end > copy_begin) {
3563 if (write_in_full(fd, contents + copy_begin,
3564 copy_end - copy_begin) < 0)
3565 goto write_err_out;
3566 if (new_line &&
3567 write_str_in_full(fd, "\n") < 0)
3568 goto write_err_out;
3570 copy_begin = replace_end;
3573 /* write the pair (value == NULL means unset) */
3574 if (value) {
3575 if (!store.section_seen) {
3576 if (write_section(fd, key, &store) < 0)
3577 goto write_err_out;
3579 if (write_pair(fd, key, value, &store) < 0)
3580 goto write_err_out;
3583 /* write the rest of the config */
3584 if (copy_begin < contents_sz)
3585 if (write_in_full(fd, contents + copy_begin,
3586 contents_sz - copy_begin) < 0)
3587 goto write_err_out;
3589 munmap(contents, contents_sz);
3590 contents = NULL;
3593 if (commit_lock_file(&lock) < 0) {
3594 error_errno(_("could not write config file %s"), config_filename);
3595 ret = CONFIG_NO_WRITE;
3596 goto out_free;
3599 ret = 0;
3601 /* Invalidate the config cache */
3602 git_config_clear();
3604 out_free:
3605 rollback_lock_file(&lock);
3606 free(filename_buf);
3607 if (contents)
3608 munmap(contents, contents_sz);
3609 if (in_fd >= 0)
3610 close(in_fd);
3611 config_store_data_clear(&store);
3612 return ret;
3614 write_err_out:
3615 ret = write_error(get_lock_file_path(&lock));
3616 goto out_free;
3620 void git_config_set_multivar_in_file(const char *config_filename,
3621 const char *key, const char *value,
3622 const char *value_pattern, unsigned flags)
3624 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3625 value_pattern, flags))
3626 return;
3627 if (value)
3628 die(_("could not set '%s' to '%s'"), key, value);
3629 else
3630 die(_("could not unset '%s'"), key);
3633 int git_config_set_multivar_gently(const char *key, const char *value,
3634 const char *value_pattern, unsigned flags)
3636 return repo_config_set_multivar_gently(the_repository, key, value,
3637 value_pattern, flags);
3640 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3641 const char *value,
3642 const char *value_pattern, unsigned flags)
3644 char *file = repo_git_path(r, "config");
3645 int res = git_config_set_multivar_in_file_gently(file,
3646 key, value,
3647 value_pattern,
3648 flags);
3649 free(file);
3650 return res;
3653 void git_config_set_multivar(const char *key, const char *value,
3654 const char *value_pattern, unsigned flags)
3656 git_config_set_multivar_in_file(git_path("config"),
3657 key, value, value_pattern,
3658 flags);
3661 static size_t section_name_match (const char *buf, const char *name)
3663 size_t i = 0, j = 0;
3664 int dot = 0;
3665 if (buf[i] != '[')
3666 return 0;
3667 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3668 if (!dot && isspace(buf[i])) {
3669 dot = 1;
3670 if (name[j++] != '.')
3671 break;
3672 for (i++; isspace(buf[i]); i++)
3673 ; /* do nothing */
3674 if (buf[i] != '"')
3675 break;
3676 continue;
3678 if (buf[i] == '\\' && dot)
3679 i++;
3680 else if (buf[i] == '"' && dot) {
3681 for (i++; isspace(buf[i]); i++)
3682 ; /* do_nothing */
3683 break;
3685 if (buf[i] != name[j++])
3686 break;
3688 if (buf[i] == ']' && name[j] == 0) {
3690 * We match, now just find the right length offset by
3691 * gobbling up any whitespace after it, as well
3693 i++;
3694 for (; buf[i] && isspace(buf[i]); i++)
3695 ; /* do nothing */
3696 return i;
3698 return 0;
3701 static int section_name_is_ok(const char *name)
3703 /* Empty section names are bogus. */
3704 if (!*name)
3705 return 0;
3708 * Before a dot, we must be alphanumeric or dash. After the first dot,
3709 * anything goes, so we can stop checking.
3711 for (; *name && *name != '.'; name++)
3712 if (*name != '-' && !isalnum(*name))
3713 return 0;
3714 return 1;
3717 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3719 /* if new_name == NULL, the section is removed instead */
3720 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3721 const char *old_name,
3722 const char *new_name, int copy)
3724 int ret = 0, remove = 0;
3725 char *filename_buf = NULL;
3726 struct lock_file lock = LOCK_INIT;
3727 int out_fd;
3728 struct strbuf buf = STRBUF_INIT;
3729 FILE *config_file = NULL;
3730 struct stat st;
3731 struct strbuf copystr = STRBUF_INIT;
3732 struct config_store_data store;
3733 uint32_t line_nr = 0;
3735 memset(&store, 0, sizeof(store));
3737 if (new_name && !section_name_is_ok(new_name)) {
3738 ret = error(_("invalid section name: %s"), new_name);
3739 goto out_no_rollback;
3742 if (!config_filename)
3743 config_filename = filename_buf = git_pathdup("config");
3745 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3746 if (out_fd < 0) {
3747 ret = error(_("could not lock config file %s"), config_filename);
3748 goto out;
3751 if (!(config_file = fopen(config_filename, "rb"))) {
3752 ret = warn_on_fopen_errors(config_filename);
3753 if (ret)
3754 goto out;
3755 /* no config file means nothing to rename, no error */
3756 goto commit_and_out;
3759 if (fstat(fileno(config_file), &st) == -1) {
3760 ret = error_errno(_("fstat on %s failed"), config_filename);
3761 goto out;
3764 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3765 ret = error_errno(_("chmod on %s failed"),
3766 get_lock_file_path(&lock));
3767 goto out;
3770 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3771 size_t i, length;
3772 int is_section = 0;
3773 char *output = buf.buf;
3775 line_nr++;
3777 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3778 ret = error(_("refusing to work with overly long line "
3779 "in '%s' on line %"PRIuMAX),
3780 config_filename, (uintmax_t)line_nr);
3781 goto out;
3784 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3785 ; /* do nothing */
3786 if (buf.buf[i] == '[') {
3787 /* it's a section */
3788 size_t offset;
3789 is_section = 1;
3792 * When encountering a new section under -c we
3793 * need to flush out any section we're already
3794 * coping and begin anew. There might be
3795 * multiple [branch "$name"] sections.
3797 if (copystr.len > 0) {
3798 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3799 ret = write_error(get_lock_file_path(&lock));
3800 goto out;
3802 strbuf_reset(&copystr);
3805 offset = section_name_match(&buf.buf[i], old_name);
3806 if (offset > 0) {
3807 ret++;
3808 if (!new_name) {
3809 remove = 1;
3810 continue;
3812 store.baselen = strlen(new_name);
3813 if (!copy) {
3814 if (write_section(out_fd, new_name, &store) < 0) {
3815 ret = write_error(get_lock_file_path(&lock));
3816 goto out;
3819 * We wrote out the new section, with
3820 * a newline, now skip the old
3821 * section's length
3823 output += offset + i;
3824 if (strlen(output) > 0) {
3826 * More content means there's
3827 * a declaration to put on the
3828 * next line; indent with a
3829 * tab
3831 output -= 1;
3832 output[0] = '\t';
3834 } else {
3835 copystr = store_create_section(new_name, &store);
3838 remove = 0;
3840 if (remove)
3841 continue;
3842 length = strlen(output);
3844 if (!is_section && copystr.len > 0) {
3845 strbuf_add(&copystr, output, length);
3848 if (write_in_full(out_fd, output, length) < 0) {
3849 ret = write_error(get_lock_file_path(&lock));
3850 goto out;
3855 * Copy a trailing section at the end of the config, won't be
3856 * flushed by the usual "flush because we have a new section
3857 * logic in the loop above.
3859 if (copystr.len > 0) {
3860 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3861 ret = write_error(get_lock_file_path(&lock));
3862 goto out;
3864 strbuf_reset(&copystr);
3867 fclose(config_file);
3868 config_file = NULL;
3869 commit_and_out:
3870 if (commit_lock_file(&lock) < 0)
3871 ret = error_errno(_("could not write config file %s"),
3872 config_filename);
3873 out:
3874 if (config_file)
3875 fclose(config_file);
3876 rollback_lock_file(&lock);
3877 out_no_rollback:
3878 free(filename_buf);
3879 config_store_data_clear(&store);
3880 strbuf_release(&buf);
3881 return ret;
3884 int git_config_rename_section_in_file(const char *config_filename,
3885 const char *old_name, const char *new_name)
3887 return git_config_copy_or_rename_section_in_file(config_filename,
3888 old_name, new_name, 0);
3891 int git_config_rename_section(const char *old_name, const char *new_name)
3893 return git_config_rename_section_in_file(NULL, old_name, new_name);
3896 int git_config_copy_section_in_file(const char *config_filename,
3897 const char *old_name, const char *new_name)
3899 return git_config_copy_or_rename_section_in_file(config_filename,
3900 old_name, new_name, 1);
3903 int git_config_copy_section(const char *old_name, const char *new_name)
3905 return git_config_copy_section_in_file(NULL, old_name, new_name);
3909 * Call this to report error for your variable that should not
3910 * get a boolean value (i.e. "[my] var" means "true").
3912 #undef config_error_nonbool
3913 int config_error_nonbool(const char *var)
3915 return error(_("missing value for '%s'"), var);
3918 int parse_config_key(const char *var,
3919 const char *section,
3920 const char **subsection, size_t *subsection_len,
3921 const char **key)
3923 const char *dot;
3925 /* Does it start with "section." ? */
3926 if (!skip_prefix(var, section, &var) || *var != '.')
3927 return -1;
3930 * Find the key; we don't know yet if we have a subsection, but we must
3931 * parse backwards from the end, since the subsection may have dots in
3932 * it, too.
3934 dot = strrchr(var, '.');
3935 *key = dot + 1;
3937 /* Did we have a subsection at all? */
3938 if (dot == var) {
3939 if (subsection) {
3940 *subsection = NULL;
3941 *subsection_len = 0;
3944 else {
3945 if (!subsection)
3946 return -1;
3947 *subsection = var + 1;
3948 *subsection_len = dot - *subsection;
3951 return 0;
3954 static int reader_origin_type(struct config_reader *reader,
3955 enum config_origin_type *type)
3957 if (the_reader.config_kvi)
3958 *type = reader->config_kvi->origin_type;
3959 else if(the_reader.source)
3960 *type = reader->source->origin_type;
3961 else
3962 return 1;
3963 return 0;
3966 const char *current_config_origin_type(void)
3968 enum config_origin_type type = CONFIG_ORIGIN_UNKNOWN;
3970 if (reader_origin_type(&the_reader, &type))
3971 BUG("current_config_origin_type called outside config callback");
3973 switch (type) {
3974 case CONFIG_ORIGIN_BLOB:
3975 return "blob";
3976 case CONFIG_ORIGIN_FILE:
3977 return "file";
3978 case CONFIG_ORIGIN_STDIN:
3979 return "standard input";
3980 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3981 return "submodule-blob";
3982 case CONFIG_ORIGIN_CMDLINE:
3983 return "command line";
3984 default:
3985 BUG("unknown config origin type");
3989 const char *config_scope_name(enum config_scope scope)
3991 switch (scope) {
3992 case CONFIG_SCOPE_SYSTEM:
3993 return "system";
3994 case CONFIG_SCOPE_GLOBAL:
3995 return "global";
3996 case CONFIG_SCOPE_LOCAL:
3997 return "local";
3998 case CONFIG_SCOPE_WORKTREE:
3999 return "worktree";
4000 case CONFIG_SCOPE_COMMAND:
4001 return "command";
4002 case CONFIG_SCOPE_SUBMODULE:
4003 return "submodule";
4004 default:
4005 return "unknown";
4009 static int reader_config_name(struct config_reader *reader, const char **out)
4011 if (the_reader.config_kvi)
4012 *out = reader->config_kvi->filename;
4013 else if (the_reader.source)
4014 *out = reader->source->name;
4015 else
4016 return 1;
4017 return 0;
4020 const char *current_config_name(void)
4022 const char *name;
4023 if (reader_config_name(&the_reader, &name))
4024 BUG("current_config_name called outside config callback");
4025 return name ? name : "";
4028 enum config_scope current_config_scope(void)
4030 if (the_reader.config_kvi)
4031 return the_reader.config_kvi->scope;
4032 else
4033 return the_reader.parsing_scope;
4036 int current_config_line(void)
4038 if (the_reader.config_kvi)
4039 return the_reader.config_kvi->linenr;
4040 else
4041 return the_reader.source->linenr;
4044 int lookup_config(const char **mapping, int nr_mapping, const char *var)
4046 int i;
4048 for (i = 0; i < nr_mapping; i++) {
4049 const char *name = mapping[i];
4051 if (name && !strcasecmp(var, name))
4052 return i;
4054 return -1;