Merge branch 'jc/clone-object-format-from-void'
[git.git] / config.c
blob493f47df8ae6a56ff1abf37090df20e2ee665b3e
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 "alloc.h"
11 #include "date.h"
12 #include "branch.h"
13 #include "config.h"
14 #include "environment.h"
15 #include "gettext.h"
16 #include "ident.h"
17 #include "repository.h"
18 #include "lockfile.h"
19 #include "exec-cmd.h"
20 #include "strbuf.h"
21 #include "quote.h"
22 #include "hashmap.h"
23 #include "string-list.h"
24 #include "object-store.h"
25 #include "utf8.h"
26 #include "dir.h"
27 #include "color.h"
28 #include "replace-object.h"
29 #include "refs.h"
30 #include "setup.h"
31 #include "worktree.h"
32 #include "wrapper.h"
33 #include "write-or-die.h"
35 struct config_source {
36 struct config_source *prev;
37 union {
38 FILE *file;
39 struct config_buf {
40 const char *buf;
41 size_t len;
42 size_t pos;
43 } buf;
44 } u;
45 enum config_origin_type origin_type;
46 const char *name;
47 const char *path;
48 enum config_error_action default_error_action;
49 int linenr;
50 int eof;
51 size_t total_len;
52 struct strbuf value;
53 struct strbuf var;
54 unsigned subsection_case_sensitive : 1;
56 int (*do_fgetc)(struct config_source *c);
57 int (*do_ungetc)(int c, struct config_source *conf);
58 long (*do_ftell)(struct config_source *c);
60 #define CONFIG_SOURCE_INIT { 0 }
62 struct config_reader {
64 * These members record the "current" config source, which can be
65 * accessed by parsing callbacks.
67 * The "source" variable will be non-NULL only when we are actually
68 * parsing a real config source (file, blob, cmdline, etc).
70 * The "config_kvi" variable will be non-NULL only when we are feeding
71 * cached config from a configset into a callback.
73 * They cannot be non-NULL at the same time. If they are both NULL, then
74 * we aren't parsing anything (and depending on the function looking at
75 * the variables, it's either a bug for it to be called in the first
76 * place, or it's a function which can be reused for non-config
77 * purposes, and should fall back to some sane behavior).
79 struct config_source *source;
80 struct key_value_info *config_kvi;
82 * The "scope" of the current config source being parsed (repo, global,
83 * etc). Like "source", this is only set when parsing a config source.
84 * It's not part of "source" because it transcends a single file (i.e.,
85 * a file included from .git/config is still in "repo" scope).
87 * When iterating through a configset, the equivalent value is
88 * "config_kvi.scope" (see above).
90 enum config_scope parsing_scope;
93 * Where possible, prefer to accept "struct config_reader" as an arg than to use
94 * "the_reader". "the_reader" should only be used if that is infeasible, e.g. in
95 * a public function.
97 static struct config_reader the_reader;
99 static inline void config_reader_push_source(struct config_reader *reader,
100 struct config_source *top)
102 if (reader->config_kvi)
103 BUG("source should not be set while iterating a config set");
104 top->prev = reader->source;
105 reader->source = top;
108 static inline struct config_source *config_reader_pop_source(struct config_reader *reader)
110 struct config_source *ret;
111 if (!reader->source)
112 BUG("tried to pop config source, but we weren't reading config");
113 ret = reader->source;
114 reader->source = reader->source->prev;
115 return ret;
118 static inline void config_reader_set_kvi(struct config_reader *reader,
119 struct key_value_info *kvi)
121 if (kvi && (reader->source || reader->parsing_scope))
122 BUG("kvi should not be set while parsing a config source");
123 reader->config_kvi = kvi;
126 static inline void config_reader_set_scope(struct config_reader *reader,
127 enum config_scope scope)
129 if (scope && reader->config_kvi)
130 BUG("scope should only be set when iterating through a config source");
131 reader->parsing_scope = scope;
134 static int pack_compression_seen;
135 static int zlib_compression_seen;
138 * Config that comes from trusted scopes, namely:
139 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
140 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
141 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
143 * This is declared here for code cleanliness, but unlike the other
144 * static variables, this does not hold config parser state.
146 static struct config_set protected_config;
148 static int config_file_fgetc(struct config_source *conf)
150 return getc_unlocked(conf->u.file);
153 static int config_file_ungetc(int c, struct config_source *conf)
155 return ungetc(c, conf->u.file);
158 static long config_file_ftell(struct config_source *conf)
160 return ftell(conf->u.file);
164 static int config_buf_fgetc(struct config_source *conf)
166 if (conf->u.buf.pos < conf->u.buf.len)
167 return conf->u.buf.buf[conf->u.buf.pos++];
169 return EOF;
172 static int config_buf_ungetc(int c, struct config_source *conf)
174 if (conf->u.buf.pos > 0) {
175 conf->u.buf.pos--;
176 if (conf->u.buf.buf[conf->u.buf.pos] != c)
177 BUG("config_buf can only ungetc the same character");
178 return c;
181 return EOF;
184 static long config_buf_ftell(struct config_source *conf)
186 return conf->u.buf.pos;
189 struct config_include_data {
190 int depth;
191 config_fn_t fn;
192 void *data;
193 const struct config_options *opts;
194 struct git_config_source *config_source;
195 struct config_reader *config_reader;
198 * All remote URLs discovered when reading all config files.
200 struct string_list *remote_urls;
202 #define CONFIG_INCLUDE_INIT { 0 }
204 static int git_config_include(const char *var, const char *value, void *data);
206 #define MAX_INCLUDE_DEPTH 10
207 static const char include_depth_advice[] = N_(
208 "exceeded maximum include depth (%d) while including\n"
209 " %s\n"
210 "from\n"
211 " %s\n"
212 "This might be due to circular includes.");
213 static int handle_path_include(struct config_source *cs, const char *path,
214 struct config_include_data *inc)
216 int ret = 0;
217 struct strbuf buf = STRBUF_INIT;
218 char *expanded;
220 if (!path)
221 return config_error_nonbool("include.path");
223 expanded = interpolate_path(path, 0);
224 if (!expanded)
225 return error(_("could not expand include path '%s'"), path);
226 path = expanded;
229 * Use an absolute path as-is, but interpret relative paths
230 * based on the including config file.
232 if (!is_absolute_path(path)) {
233 char *slash;
235 if (!cs || !cs->path) {
236 ret = error(_("relative config includes must come from files"));
237 goto cleanup;
240 slash = find_last_dir_sep(cs->path);
241 if (slash)
242 strbuf_add(&buf, cs->path, slash - cs->path + 1);
243 strbuf_addstr(&buf, path);
244 path = buf.buf;
247 if (!access_or_die(path, R_OK, 0)) {
248 if (++inc->depth > MAX_INCLUDE_DEPTH)
249 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
250 !cs ? "<unknown>" :
251 cs->name ? cs->name :
252 "the command line");
253 ret = git_config_from_file(git_config_include, path, inc);
254 inc->depth--;
256 cleanup:
257 strbuf_release(&buf);
258 free(expanded);
259 return ret;
262 static void add_trailing_starstar_for_dir(struct strbuf *pat)
264 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
265 strbuf_addstr(pat, "**");
268 static int prepare_include_condition_pattern(struct config_source *cs,
269 struct strbuf *pat)
271 struct strbuf path = STRBUF_INIT;
272 char *expanded;
273 int prefix = 0;
275 expanded = interpolate_path(pat->buf, 1);
276 if (expanded) {
277 strbuf_reset(pat);
278 strbuf_addstr(pat, expanded);
279 free(expanded);
282 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
283 const char *slash;
285 if (!cs || !cs->path)
286 return error(_("relative config include "
287 "conditionals must come from files"));
289 strbuf_realpath(&path, cs->path, 1);
290 slash = find_last_dir_sep(path.buf);
291 if (!slash)
292 BUG("how is this possible?");
293 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
294 prefix = slash - path.buf + 1 /* slash */;
295 } else if (!is_absolute_path(pat->buf))
296 strbuf_insertstr(pat, 0, "**/");
298 add_trailing_starstar_for_dir(pat);
300 strbuf_release(&path);
301 return prefix;
304 static int include_by_gitdir(struct config_source *cs,
305 const struct config_options *opts,
306 const char *cond, size_t cond_len, int icase)
308 struct strbuf text = STRBUF_INIT;
309 struct strbuf pattern = STRBUF_INIT;
310 int ret = 0, prefix;
311 const char *git_dir;
312 int already_tried_absolute = 0;
314 if (opts->git_dir)
315 git_dir = opts->git_dir;
316 else
317 goto done;
319 strbuf_realpath(&text, git_dir, 1);
320 strbuf_add(&pattern, cond, cond_len);
321 prefix = prepare_include_condition_pattern(cs, &pattern);
323 again:
324 if (prefix < 0)
325 goto done;
327 if (prefix > 0) {
329 * perform literal matching on the prefix part so that
330 * any wildcard character in it can't create side effects.
332 if (text.len < prefix)
333 goto done;
334 if (!icase && strncmp(pattern.buf, text.buf, prefix))
335 goto done;
336 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
337 goto done;
340 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
341 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
343 if (!ret && !already_tried_absolute) {
345 * We've tried e.g. matching gitdir:~/work, but if
346 * ~/work is a symlink to /mnt/storage/work
347 * strbuf_realpath() will expand it, so the rule won't
348 * match. Let's match against a
349 * strbuf_add_absolute_path() version of the path,
350 * which'll do the right thing
352 strbuf_reset(&text);
353 strbuf_add_absolute_path(&text, git_dir);
354 already_tried_absolute = 1;
355 goto again;
357 done:
358 strbuf_release(&pattern);
359 strbuf_release(&text);
360 return ret;
363 static int include_by_branch(const char *cond, size_t cond_len)
365 int flags;
366 int ret;
367 struct strbuf pattern = STRBUF_INIT;
368 const char *refname = !the_repository->gitdir ?
369 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
370 const char *shortname;
372 if (!refname || !(flags & REF_ISSYMREF) ||
373 !skip_prefix(refname, "refs/heads/", &shortname))
374 return 0;
376 strbuf_add(&pattern, cond, cond_len);
377 add_trailing_starstar_for_dir(&pattern);
378 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
379 strbuf_release(&pattern);
380 return ret;
383 static int add_remote_url(const char *var, const char *value, void *data)
385 struct string_list *remote_urls = data;
386 const char *remote_name;
387 size_t remote_name_len;
388 const char *key;
390 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
391 &key) &&
392 remote_name &&
393 !strcmp(key, "url"))
394 string_list_append(remote_urls, value);
395 return 0;
398 static void populate_remote_urls(struct config_include_data *inc)
400 struct config_options opts;
402 enum config_scope store_scope = inc->config_reader->parsing_scope;
404 opts = *inc->opts;
405 opts.unconditional_remote_url = 1;
407 config_reader_set_scope(inc->config_reader, 0);
409 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
410 string_list_init_dup(inc->remote_urls);
411 config_with_options(add_remote_url, inc->remote_urls, inc->config_source, &opts);
413 config_reader_set_scope(inc->config_reader, store_scope);
416 static int forbid_remote_url(const char *var, const char *value UNUSED,
417 void *data UNUSED)
419 const char *remote_name;
420 size_t remote_name_len;
421 const char *key;
423 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
424 &key) &&
425 remote_name &&
426 !strcmp(key, "url"))
427 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
428 return 0;
431 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
432 struct string_list *remote_urls)
434 struct strbuf pattern = STRBUF_INIT;
435 struct string_list_item *url_item;
436 int found = 0;
438 strbuf_add(&pattern, glob, glob_len);
439 for_each_string_list_item(url_item, remote_urls) {
440 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
441 found = 1;
442 break;
445 strbuf_release(&pattern);
446 return found;
449 static int include_by_remote_url(struct config_include_data *inc,
450 const char *cond, size_t cond_len)
452 if (inc->opts->unconditional_remote_url)
453 return 1;
454 if (!inc->remote_urls)
455 populate_remote_urls(inc);
456 return at_least_one_url_matches_glob(cond, cond_len,
457 inc->remote_urls);
460 static int include_condition_is_true(struct config_source *cs,
461 struct config_include_data *inc,
462 const char *cond, size_t cond_len)
464 const struct config_options *opts = inc->opts;
466 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
467 return include_by_gitdir(cs, opts, cond, cond_len, 0);
468 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
469 return include_by_gitdir(cs, opts, cond, cond_len, 1);
470 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
471 return include_by_branch(cond, cond_len);
472 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
473 &cond_len))
474 return include_by_remote_url(inc, cond, cond_len);
476 /* unknown conditionals are always false */
477 return 0;
480 static int git_config_include(const char *var, const char *value, void *data)
482 struct config_include_data *inc = data;
483 struct config_source *cs = inc->config_reader->source;
484 const char *cond, *key;
485 size_t cond_len;
486 int ret;
489 * Pass along all values, including "include" directives; this makes it
490 * possible to query information on the includes themselves.
492 ret = inc->fn(var, value, inc->data);
493 if (ret < 0)
494 return ret;
496 if (!strcmp(var, "include.path"))
497 ret = handle_path_include(cs, value, inc);
499 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
500 cond && include_condition_is_true(cs, inc, cond, cond_len) &&
501 !strcmp(key, "path")) {
502 config_fn_t old_fn = inc->fn;
504 if (inc->opts->unconditional_remote_url)
505 inc->fn = forbid_remote_url;
506 ret = handle_path_include(cs, value, inc);
507 inc->fn = old_fn;
510 return ret;
513 static void git_config_push_split_parameter(const char *key, const char *value)
515 struct strbuf env = STRBUF_INIT;
516 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
517 if (old && *old) {
518 strbuf_addstr(&env, old);
519 strbuf_addch(&env, ' ');
521 sq_quote_buf(&env, key);
522 strbuf_addch(&env, '=');
523 if (value)
524 sq_quote_buf(&env, value);
525 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
526 strbuf_release(&env);
529 void git_config_push_parameter(const char *text)
531 const char *value;
534 * When we see:
536 * section.subsection=with=equals.key=value
538 * we cannot tell if it means:
540 * [section "subsection=with=equals"]
541 * key = value
543 * or:
545 * [section]
546 * subsection = with=equals.key=value
548 * We parse left-to-right for the first "=", meaning we'll prefer to
549 * keep the value intact over the subsection. This is historical, but
550 * also sensible since values are more likely to contain odd or
551 * untrusted input than a section name.
553 * A missing equals is explicitly allowed (as a bool-only entry).
555 value = strchr(text, '=');
556 if (value) {
557 char *key = xmemdupz(text, value - text);
558 git_config_push_split_parameter(key, value + 1);
559 free(key);
560 } else {
561 git_config_push_split_parameter(text, NULL);
565 void git_config_push_env(const char *spec)
567 char *key;
568 const char *env_name;
569 const char *env_value;
571 env_name = strrchr(spec, '=');
572 if (!env_name)
573 die(_("invalid config format: %s"), spec);
574 key = xmemdupz(spec, env_name - spec);
575 env_name++;
576 if (!*env_name)
577 die(_("missing environment variable name for configuration '%.*s'"),
578 (int)(env_name - spec - 1), spec);
580 env_value = getenv(env_name);
581 if (!env_value)
582 die(_("missing environment variable '%s' for configuration '%.*s'"),
583 env_name, (int)(env_name - spec - 1), spec);
585 git_config_push_split_parameter(key, env_value);
586 free(key);
589 static inline int iskeychar(int c)
591 return isalnum(c) || c == '-';
595 * Auxiliary function to sanity-check and split the key into the section
596 * identifier and variable name.
598 * Returns 0 on success, -1 when there is an invalid character in the key and
599 * -2 if there is no section name in the key.
601 * store_key - pointer to char* which will hold a copy of the key with
602 * lowercase section and variable name
603 * baselen - pointer to size_t which will hold the length of the
604 * section + subsection part, can be NULL
606 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
608 size_t i, baselen;
609 int dot;
610 const char *last_dot = strrchr(key, '.');
613 * Since "key" actually contains the section name and the real
614 * key name separated by a dot, we have to know where the dot is.
617 if (last_dot == NULL || last_dot == key) {
618 error(_("key does not contain a section: %s"), key);
619 return -CONFIG_NO_SECTION_OR_NAME;
622 if (!last_dot[1]) {
623 error(_("key does not contain variable name: %s"), key);
624 return -CONFIG_NO_SECTION_OR_NAME;
627 baselen = last_dot - key;
628 if (baselen_)
629 *baselen_ = baselen;
632 * Validate the key and while at it, lower case it for matching.
634 *store_key = xmallocz(strlen(key));
636 dot = 0;
637 for (i = 0; key[i]; i++) {
638 unsigned char c = key[i];
639 if (c == '.')
640 dot = 1;
641 /* Leave the extended basename untouched.. */
642 if (!dot || i > baselen) {
643 if (!iskeychar(c) ||
644 (i == baselen + 1 && !isalpha(c))) {
645 error(_("invalid key: %s"), key);
646 goto out_free_ret_1;
648 c = tolower(c);
649 } else if (c == '\n') {
650 error(_("invalid key (newline): %s"), key);
651 goto out_free_ret_1;
653 (*store_key)[i] = c;
656 return 0;
658 out_free_ret_1:
659 FREE_AND_NULL(*store_key);
660 return -CONFIG_INVALID_KEY;
663 static int config_parse_pair(const char *key, const char *value,
664 config_fn_t fn, void *data)
666 char *canonical_name;
667 int ret;
669 if (!strlen(key))
670 return error(_("empty config key"));
671 if (git_config_parse_key(key, &canonical_name, NULL))
672 return -1;
674 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
675 free(canonical_name);
676 return ret;
679 int git_config_parse_parameter(const char *text,
680 config_fn_t fn, void *data)
682 const char *value;
683 struct strbuf **pair;
684 int ret;
686 pair = strbuf_split_str(text, '=', 2);
687 if (!pair[0])
688 return error(_("bogus config parameter: %s"), text);
690 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
691 strbuf_setlen(pair[0], pair[0]->len - 1);
692 value = pair[1] ? pair[1]->buf : "";
693 } else {
694 value = NULL;
697 strbuf_trim(pair[0]);
698 if (!pair[0]->len) {
699 strbuf_list_free(pair);
700 return error(_("bogus config parameter: %s"), text);
703 ret = config_parse_pair(pair[0]->buf, value, fn, data);
704 strbuf_list_free(pair);
705 return ret;
708 static int parse_config_env_list(char *env, config_fn_t fn, void *data)
710 char *cur = env;
711 while (cur && *cur) {
712 const char *key = sq_dequote_step(cur, &cur);
713 if (!key)
714 return error(_("bogus format in %s"),
715 CONFIG_DATA_ENVIRONMENT);
717 if (!cur || isspace(*cur)) {
718 /* old-style 'key=value' */
719 if (git_config_parse_parameter(key, fn, data) < 0)
720 return -1;
722 else if (*cur == '=') {
723 /* new-style 'key'='value' */
724 const char *value;
726 cur++;
727 if (*cur == '\'') {
728 /* quoted value */
729 value = sq_dequote_step(cur, &cur);
730 if (!value || (cur && !isspace(*cur))) {
731 return error(_("bogus format in %s"),
732 CONFIG_DATA_ENVIRONMENT);
734 } else if (!*cur || isspace(*cur)) {
735 /* implicit bool: 'key'= */
736 value = NULL;
737 } else {
738 return error(_("bogus format in %s"),
739 CONFIG_DATA_ENVIRONMENT);
742 if (config_parse_pair(key, value, fn, data) < 0)
743 return -1;
745 else {
746 /* unknown format */
747 return error(_("bogus format in %s"),
748 CONFIG_DATA_ENVIRONMENT);
751 if (cur) {
752 while (isspace(*cur))
753 cur++;
756 return 0;
759 int git_config_from_parameters(config_fn_t fn, void *data)
761 const char *env;
762 struct strbuf envvar = STRBUF_INIT;
763 struct strvec to_free = STRVEC_INIT;
764 int ret = 0;
765 char *envw = NULL;
766 struct config_source source = CONFIG_SOURCE_INIT;
768 source.origin_type = CONFIG_ORIGIN_CMDLINE;
769 config_reader_push_source(&the_reader, &source);
771 env = getenv(CONFIG_COUNT_ENVIRONMENT);
772 if (env) {
773 unsigned long count;
774 char *endp;
775 int i;
777 count = strtoul(env, &endp, 10);
778 if (*endp) {
779 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
780 goto out;
782 if (count > INT_MAX) {
783 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
784 goto out;
787 for (i = 0; i < count; i++) {
788 const char *key, *value;
790 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
791 key = getenv_safe(&to_free, envvar.buf);
792 if (!key) {
793 ret = error(_("missing config key %s"), envvar.buf);
794 goto out;
796 strbuf_reset(&envvar);
798 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
799 value = getenv_safe(&to_free, envvar.buf);
800 if (!value) {
801 ret = error(_("missing config value %s"), envvar.buf);
802 goto out;
804 strbuf_reset(&envvar);
806 if (config_parse_pair(key, value, fn, data) < 0) {
807 ret = -1;
808 goto out;
813 env = getenv(CONFIG_DATA_ENVIRONMENT);
814 if (env) {
815 /* sq_dequote will write over it */
816 envw = xstrdup(env);
817 if (parse_config_env_list(envw, fn, data) < 0) {
818 ret = -1;
819 goto out;
823 out:
824 strbuf_release(&envvar);
825 strvec_clear(&to_free);
826 free(envw);
827 config_reader_pop_source(&the_reader);
828 return ret;
831 static int get_next_char(struct config_source *cs)
833 int c = cs->do_fgetc(cs);
835 if (c == '\r') {
836 /* DOS like systems */
837 c = cs->do_fgetc(cs);
838 if (c != '\n') {
839 if (c != EOF)
840 cs->do_ungetc(c, cs);
841 c = '\r';
845 if (c != EOF && ++cs->total_len > INT_MAX) {
847 * This is an absurdly long config file; refuse to parse
848 * further in order to protect downstream code from integer
849 * overflows. Note that we can't return an error specifically,
850 * but we can mark EOF and put trash in the return value,
851 * which will trigger a parse error.
853 cs->eof = 1;
854 return 0;
857 if (c == '\n')
858 cs->linenr++;
859 if (c == EOF) {
860 cs->eof = 1;
861 cs->linenr++;
862 c = '\n';
864 return c;
867 static char *parse_value(struct config_source *cs)
869 int quote = 0, comment = 0, space = 0;
871 strbuf_reset(&cs->value);
872 for (;;) {
873 int c = get_next_char(cs);
874 if (c == '\n') {
875 if (quote) {
876 cs->linenr--;
877 return NULL;
879 return cs->value.buf;
881 if (comment)
882 continue;
883 if (isspace(c) && !quote) {
884 if (cs->value.len)
885 space++;
886 continue;
888 if (!quote) {
889 if (c == ';' || c == '#') {
890 comment = 1;
891 continue;
894 for (; space; space--)
895 strbuf_addch(&cs->value, ' ');
896 if (c == '\\') {
897 c = get_next_char(cs);
898 switch (c) {
899 case '\n':
900 continue;
901 case 't':
902 c = '\t';
903 break;
904 case 'b':
905 c = '\b';
906 break;
907 case 'n':
908 c = '\n';
909 break;
910 /* Some characters escape as themselves */
911 case '\\': case '"':
912 break;
913 /* Reject unknown escape sequences */
914 default:
915 return NULL;
917 strbuf_addch(&cs->value, c);
918 continue;
920 if (c == '"') {
921 quote = 1-quote;
922 continue;
924 strbuf_addch(&cs->value, c);
928 static int get_value(struct config_source *cs, config_fn_t fn, void *data,
929 struct strbuf *name)
931 int c;
932 char *value;
933 int ret;
935 /* Get the full name */
936 for (;;) {
937 c = get_next_char(cs);
938 if (cs->eof)
939 break;
940 if (!iskeychar(c))
941 break;
942 strbuf_addch(name, tolower(c));
945 while (c == ' ' || c == '\t')
946 c = get_next_char(cs);
948 value = NULL;
949 if (c != '\n') {
950 if (c != '=')
951 return -1;
952 value = parse_value(cs);
953 if (!value)
954 return -1;
957 * We already consumed the \n, but we need linenr to point to
958 * the line we just parsed during the call to fn to get
959 * accurate line number in error messages.
961 cs->linenr--;
962 ret = fn(name->buf, value, data);
963 if (ret >= 0)
964 cs->linenr++;
965 return ret;
968 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
969 int c)
971 cs->subsection_case_sensitive = 0;
972 do {
973 if (c == '\n')
974 goto error_incomplete_line;
975 c = get_next_char(cs);
976 } while (isspace(c));
978 /* We require the format to be '[base "extension"]' */
979 if (c != '"')
980 return -1;
981 strbuf_addch(name, '.');
983 for (;;) {
984 int c = get_next_char(cs);
985 if (c == '\n')
986 goto error_incomplete_line;
987 if (c == '"')
988 break;
989 if (c == '\\') {
990 c = get_next_char(cs);
991 if (c == '\n')
992 goto error_incomplete_line;
994 strbuf_addch(name, c);
997 /* Final ']' */
998 if (get_next_char(cs) != ']')
999 return -1;
1000 return 0;
1001 error_incomplete_line:
1002 cs->linenr--;
1003 return -1;
1006 static int get_base_var(struct config_source *cs, struct strbuf *name)
1008 cs->subsection_case_sensitive = 1;
1009 for (;;) {
1010 int c = get_next_char(cs);
1011 if (cs->eof)
1012 return -1;
1013 if (c == ']')
1014 return 0;
1015 if (isspace(c))
1016 return get_extended_base_var(cs, name, c);
1017 if (!iskeychar(c) && c != '.')
1018 return -1;
1019 strbuf_addch(name, tolower(c));
1023 struct parse_event_data {
1024 enum config_event_t previous_type;
1025 size_t previous_offset;
1026 const struct config_options *opts;
1029 static int do_event(struct config_source *cs, enum config_event_t type,
1030 struct parse_event_data *data)
1032 size_t offset;
1034 if (!data->opts || !data->opts->event_fn)
1035 return 0;
1037 if (type == CONFIG_EVENT_WHITESPACE &&
1038 data->previous_type == type)
1039 return 0;
1041 offset = cs->do_ftell(cs);
1043 * At EOF, the parser always "inserts" an extra '\n', therefore
1044 * the end offset of the event is the current file position, otherwise
1045 * we will already have advanced to the next event.
1047 if (type != CONFIG_EVENT_EOF)
1048 offset--;
1050 if (data->previous_type != CONFIG_EVENT_EOF &&
1051 data->opts->event_fn(data->previous_type, data->previous_offset,
1052 offset, data->opts->event_fn_data) < 0)
1053 return -1;
1055 data->previous_type = type;
1056 data->previous_offset = offset;
1058 return 0;
1061 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1062 void *data, const struct config_options *opts)
1064 int comment = 0;
1065 size_t baselen = 0;
1066 struct strbuf *var = &cs->var;
1067 int error_return = 0;
1068 char *error_msg = NULL;
1070 /* U+FEFF Byte Order Mark in UTF8 */
1071 const char *bomptr = utf8_bom;
1073 /* For the parser event callback */
1074 struct parse_event_data event_data = {
1075 CONFIG_EVENT_EOF, 0, opts
1078 for (;;) {
1079 int c;
1081 c = get_next_char(cs);
1082 if (bomptr && *bomptr) {
1083 /* We are at the file beginning; skip UTF8-encoded BOM
1084 * if present. Sane editors won't put this in on their
1085 * own, but e.g. Windows Notepad will do it happily. */
1086 if (c == (*bomptr & 0377)) {
1087 bomptr++;
1088 continue;
1089 } else {
1090 /* Do not tolerate partial BOM. */
1091 if (bomptr != utf8_bom)
1092 break;
1093 /* No BOM at file beginning. Cool. */
1094 bomptr = NULL;
1097 if (c == '\n') {
1098 if (cs->eof) {
1099 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1100 return -1;
1101 return 0;
1103 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1104 return -1;
1105 comment = 0;
1106 continue;
1108 if (comment)
1109 continue;
1110 if (isspace(c)) {
1111 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1112 return -1;
1113 continue;
1115 if (c == '#' || c == ';') {
1116 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1117 return -1;
1118 comment = 1;
1119 continue;
1121 if (c == '[') {
1122 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1123 return -1;
1125 /* Reset prior to determining a new stem */
1126 strbuf_reset(var);
1127 if (get_base_var(cs, var) < 0 || var->len < 1)
1128 break;
1129 strbuf_addch(var, '.');
1130 baselen = var->len;
1131 continue;
1133 if (!isalpha(c))
1134 break;
1136 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1137 return -1;
1140 * Truncate the var name back to the section header
1141 * stem prior to grabbing the suffix part of the name
1142 * and the value.
1144 strbuf_setlen(var, baselen);
1145 strbuf_addch(var, tolower(c));
1146 if (get_value(cs, fn, data, var) < 0)
1147 break;
1150 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1151 return -1;
1153 switch (cs->origin_type) {
1154 case CONFIG_ORIGIN_BLOB:
1155 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1156 cs->linenr, cs->name);
1157 break;
1158 case CONFIG_ORIGIN_FILE:
1159 error_msg = xstrfmt(_("bad config line %d in file %s"),
1160 cs->linenr, cs->name);
1161 break;
1162 case CONFIG_ORIGIN_STDIN:
1163 error_msg = xstrfmt(_("bad config line %d in standard input"),
1164 cs->linenr);
1165 break;
1166 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1167 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1168 cs->linenr, cs->name);
1169 break;
1170 case CONFIG_ORIGIN_CMDLINE:
1171 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1172 cs->linenr, cs->name);
1173 break;
1174 default:
1175 error_msg = xstrfmt(_("bad config line %d in %s"),
1176 cs->linenr, cs->name);
1179 switch (opts && opts->error_action ?
1180 opts->error_action :
1181 cs->default_error_action) {
1182 case CONFIG_ERROR_DIE:
1183 die("%s", error_msg);
1184 break;
1185 case CONFIG_ERROR_ERROR:
1186 error_return = error("%s", error_msg);
1187 break;
1188 case CONFIG_ERROR_SILENT:
1189 error_return = -1;
1190 break;
1191 case CONFIG_ERROR_UNSET:
1192 BUG("config error action unset");
1195 free(error_msg);
1196 return error_return;
1199 static uintmax_t get_unit_factor(const char *end)
1201 if (!*end)
1202 return 1;
1203 else if (!strcasecmp(end, "k"))
1204 return 1024;
1205 else if (!strcasecmp(end, "m"))
1206 return 1024 * 1024;
1207 else if (!strcasecmp(end, "g"))
1208 return 1024 * 1024 * 1024;
1209 return 0;
1212 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1214 if (value && *value) {
1215 char *end;
1216 intmax_t val;
1217 intmax_t factor;
1219 if (max < 0)
1220 BUG("max must be a positive integer");
1222 errno = 0;
1223 val = strtoimax(value, &end, 0);
1224 if (errno == ERANGE)
1225 return 0;
1226 if (end == value) {
1227 errno = EINVAL;
1228 return 0;
1230 factor = get_unit_factor(end);
1231 if (!factor) {
1232 errno = EINVAL;
1233 return 0;
1235 if ((val < 0 && -max / factor > val) ||
1236 (val > 0 && max / factor < val)) {
1237 errno = ERANGE;
1238 return 0;
1240 val *= factor;
1241 *ret = val;
1242 return 1;
1244 errno = EINVAL;
1245 return 0;
1248 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1250 if (value && *value) {
1251 char *end;
1252 uintmax_t val;
1253 uintmax_t factor;
1255 /* negative values would be accepted by strtoumax */
1256 if (strchr(value, '-')) {
1257 errno = EINVAL;
1258 return 0;
1260 errno = 0;
1261 val = strtoumax(value, &end, 0);
1262 if (errno == ERANGE)
1263 return 0;
1264 if (end == value) {
1265 errno = EINVAL;
1266 return 0;
1268 factor = get_unit_factor(end);
1269 if (!factor) {
1270 errno = EINVAL;
1271 return 0;
1273 if (unsigned_mult_overflows(factor, val) ||
1274 factor * val > max) {
1275 errno = ERANGE;
1276 return 0;
1278 val *= factor;
1279 *ret = val;
1280 return 1;
1282 errno = EINVAL;
1283 return 0;
1286 int git_parse_int(const char *value, int *ret)
1288 intmax_t tmp;
1289 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1290 return 0;
1291 *ret = tmp;
1292 return 1;
1295 static int git_parse_int64(const char *value, int64_t *ret)
1297 intmax_t tmp;
1298 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1299 return 0;
1300 *ret = tmp;
1301 return 1;
1304 int git_parse_ulong(const char *value, unsigned long *ret)
1306 uintmax_t tmp;
1307 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1308 return 0;
1309 *ret = tmp;
1310 return 1;
1313 int git_parse_ssize_t(const char *value, ssize_t *ret)
1315 intmax_t tmp;
1316 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1317 return 0;
1318 *ret = tmp;
1319 return 1;
1322 static int reader_config_name(struct config_reader *reader, const char **out);
1323 static int reader_origin_type(struct config_reader *reader,
1324 enum config_origin_type *type);
1325 NORETURN
1326 static void die_bad_number(struct config_reader *reader, const char *name,
1327 const char *value)
1329 const char *error_type = (errno == ERANGE) ?
1330 N_("out of range") : N_("invalid unit");
1331 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1332 const char *config_name = NULL;
1333 enum config_origin_type config_origin = CONFIG_ORIGIN_UNKNOWN;
1335 if (!value)
1336 value = "";
1338 /* Ignoring the return value is okay since we handle missing values. */
1339 reader_config_name(reader, &config_name);
1340 reader_origin_type(reader, &config_origin);
1342 if (!config_name)
1343 die(_(bad_numeric), value, name, _(error_type));
1345 switch (config_origin) {
1346 case CONFIG_ORIGIN_BLOB:
1347 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1348 value, name, config_name, _(error_type));
1349 case CONFIG_ORIGIN_FILE:
1350 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1351 value, name, config_name, _(error_type));
1352 case CONFIG_ORIGIN_STDIN:
1353 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1354 value, name, _(error_type));
1355 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1356 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1357 value, name, config_name, _(error_type));
1358 case CONFIG_ORIGIN_CMDLINE:
1359 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1360 value, name, config_name, _(error_type));
1361 default:
1362 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1363 value, name, config_name, _(error_type));
1367 int git_config_int(const char *name, const char *value)
1369 int ret;
1370 if (!git_parse_int(value, &ret))
1371 die_bad_number(&the_reader, name, value);
1372 return ret;
1375 int64_t git_config_int64(const char *name, const char *value)
1377 int64_t ret;
1378 if (!git_parse_int64(value, &ret))
1379 die_bad_number(&the_reader, name, value);
1380 return ret;
1383 unsigned long git_config_ulong(const char *name, const char *value)
1385 unsigned long ret;
1386 if (!git_parse_ulong(value, &ret))
1387 die_bad_number(&the_reader, name, value);
1388 return ret;
1391 ssize_t git_config_ssize_t(const char *name, const char *value)
1393 ssize_t ret;
1394 if (!git_parse_ssize_t(value, &ret))
1395 die_bad_number(&the_reader, name, value);
1396 return ret;
1399 static int git_parse_maybe_bool_text(const char *value)
1401 if (!value)
1402 return 1;
1403 if (!*value)
1404 return 0;
1405 if (!strcasecmp(value, "true")
1406 || !strcasecmp(value, "yes")
1407 || !strcasecmp(value, "on"))
1408 return 1;
1409 if (!strcasecmp(value, "false")
1410 || !strcasecmp(value, "no")
1411 || !strcasecmp(value, "off"))
1412 return 0;
1413 return -1;
1416 static const struct fsync_component_name {
1417 const char *name;
1418 enum fsync_component component_bits;
1419 } fsync_component_names[] = {
1420 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1421 { "pack", FSYNC_COMPONENT_PACK },
1422 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1423 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1424 { "index", FSYNC_COMPONENT_INDEX },
1425 { "objects", FSYNC_COMPONENTS_OBJECTS },
1426 { "reference", FSYNC_COMPONENT_REFERENCE },
1427 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1428 { "committed", FSYNC_COMPONENTS_COMMITTED },
1429 { "added", FSYNC_COMPONENTS_ADDED },
1430 { "all", FSYNC_COMPONENTS_ALL },
1433 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1435 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1436 enum fsync_component positive = 0, negative = 0;
1438 while (string) {
1439 int i;
1440 size_t len;
1441 const char *ep;
1442 int negated = 0;
1443 int found = 0;
1445 string = string + strspn(string, ", \t\n\r");
1446 ep = strchrnul(string, ',');
1447 len = ep - string;
1448 if (!strcmp(string, "none")) {
1449 current = FSYNC_COMPONENT_NONE;
1450 goto next_name;
1453 if (*string == '-') {
1454 negated = 1;
1455 string++;
1456 len--;
1457 if (!len)
1458 warning(_("invalid value for variable %s"), var);
1461 if (!len)
1462 break;
1464 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1465 const struct fsync_component_name *n = &fsync_component_names[i];
1467 if (strncmp(n->name, string, len))
1468 continue;
1470 found = 1;
1471 if (negated)
1472 negative |= n->component_bits;
1473 else
1474 positive |= n->component_bits;
1477 if (!found) {
1478 char *component = xstrndup(string, len);
1479 warning(_("ignoring unknown core.fsync component '%s'"), component);
1480 free(component);
1483 next_name:
1484 string = ep;
1487 return (current & ~negative) | positive;
1490 int git_parse_maybe_bool(const char *value)
1492 int v = git_parse_maybe_bool_text(value);
1493 if (0 <= v)
1494 return v;
1495 if (git_parse_int(value, &v))
1496 return !!v;
1497 return -1;
1500 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1502 int v = git_parse_maybe_bool_text(value);
1503 if (0 <= v) {
1504 *is_bool = 1;
1505 return v;
1507 *is_bool = 0;
1508 return git_config_int(name, value);
1511 int git_config_bool(const char *name, const char *value)
1513 int v = git_parse_maybe_bool(value);
1514 if (v < 0)
1515 die(_("bad boolean config value '%s' for '%s'"), value, name);
1516 return v;
1519 int git_config_string(const char **dest, const char *var, const char *value)
1521 if (!value)
1522 return config_error_nonbool(var);
1523 *dest = xstrdup(value);
1524 return 0;
1527 int git_config_pathname(const char **dest, const char *var, const char *value)
1529 if (!value)
1530 return config_error_nonbool(var);
1531 *dest = interpolate_path(value, 0);
1532 if (!*dest)
1533 die(_("failed to expand user dir in: '%s'"), value);
1534 return 0;
1537 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1539 if (!value)
1540 return config_error_nonbool(var);
1541 if (parse_expiry_date(value, timestamp))
1542 return error(_("'%s' for '%s' is not a valid timestamp"),
1543 value, var);
1544 return 0;
1547 int git_config_color(char *dest, const char *var, const char *value)
1549 if (!value)
1550 return config_error_nonbool(var);
1551 if (color_parse(value, dest) < 0)
1552 return -1;
1553 return 0;
1556 static int git_default_core_config(const char *var, const char *value, void *cb)
1558 /* This needs a better name */
1559 if (!strcmp(var, "core.filemode")) {
1560 trust_executable_bit = git_config_bool(var, value);
1561 return 0;
1563 if (!strcmp(var, "core.trustctime")) {
1564 trust_ctime = git_config_bool(var, value);
1565 return 0;
1567 if (!strcmp(var, "core.checkstat")) {
1568 if (!strcasecmp(value, "default"))
1569 check_stat = 1;
1570 else if (!strcasecmp(value, "minimal"))
1571 check_stat = 0;
1574 if (!strcmp(var, "core.quotepath")) {
1575 quote_path_fully = git_config_bool(var, value);
1576 return 0;
1579 if (!strcmp(var, "core.symlinks")) {
1580 has_symlinks = git_config_bool(var, value);
1581 return 0;
1584 if (!strcmp(var, "core.ignorecase")) {
1585 ignore_case = git_config_bool(var, value);
1586 return 0;
1589 if (!strcmp(var, "core.attributesfile"))
1590 return git_config_pathname(&git_attributes_file, var, value);
1592 if (!strcmp(var, "core.hookspath"))
1593 return git_config_pathname(&git_hooks_path, var, value);
1595 if (!strcmp(var, "core.bare")) {
1596 is_bare_repository_cfg = git_config_bool(var, value);
1597 return 0;
1600 if (!strcmp(var, "core.ignorestat")) {
1601 assume_unchanged = git_config_bool(var, value);
1602 return 0;
1605 if (!strcmp(var, "core.prefersymlinkrefs")) {
1606 prefer_symlink_refs = git_config_bool(var, value);
1607 return 0;
1610 if (!strcmp(var, "core.logallrefupdates")) {
1611 if (value && !strcasecmp(value, "always"))
1612 log_all_ref_updates = LOG_REFS_ALWAYS;
1613 else if (git_config_bool(var, value))
1614 log_all_ref_updates = LOG_REFS_NORMAL;
1615 else
1616 log_all_ref_updates = LOG_REFS_NONE;
1617 return 0;
1620 if (!strcmp(var, "core.warnambiguousrefs")) {
1621 warn_ambiguous_refs = git_config_bool(var, value);
1622 return 0;
1625 if (!strcmp(var, "core.abbrev")) {
1626 if (!value)
1627 return config_error_nonbool(var);
1628 if (!strcasecmp(value, "auto"))
1629 default_abbrev = -1;
1630 else if (!git_parse_maybe_bool_text(value))
1631 default_abbrev = the_hash_algo->hexsz;
1632 else {
1633 int abbrev = git_config_int(var, value);
1634 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1635 return error(_("abbrev length out of range: %d"), abbrev);
1636 default_abbrev = abbrev;
1638 return 0;
1641 if (!strcmp(var, "core.disambiguate"))
1642 return set_disambiguate_hint_config(var, value);
1644 if (!strcmp(var, "core.loosecompression")) {
1645 int level = git_config_int(var, value);
1646 if (level == -1)
1647 level = Z_DEFAULT_COMPRESSION;
1648 else if (level < 0 || level > Z_BEST_COMPRESSION)
1649 die(_("bad zlib compression level %d"), level);
1650 zlib_compression_level = level;
1651 zlib_compression_seen = 1;
1652 return 0;
1655 if (!strcmp(var, "core.compression")) {
1656 int level = git_config_int(var, value);
1657 if (level == -1)
1658 level = Z_DEFAULT_COMPRESSION;
1659 else if (level < 0 || level > Z_BEST_COMPRESSION)
1660 die(_("bad zlib compression level %d"), level);
1661 if (!zlib_compression_seen)
1662 zlib_compression_level = level;
1663 if (!pack_compression_seen)
1664 pack_compression_level = level;
1665 return 0;
1668 if (!strcmp(var, "core.packedgitwindowsize")) {
1669 int pgsz_x2 = getpagesize() * 2;
1670 packed_git_window_size = git_config_ulong(var, value);
1672 /* This value must be multiple of (pagesize * 2) */
1673 packed_git_window_size /= pgsz_x2;
1674 if (packed_git_window_size < 1)
1675 packed_git_window_size = 1;
1676 packed_git_window_size *= pgsz_x2;
1677 return 0;
1680 if (!strcmp(var, "core.bigfilethreshold")) {
1681 big_file_threshold = git_config_ulong(var, value);
1682 return 0;
1685 if (!strcmp(var, "core.packedgitlimit")) {
1686 packed_git_limit = git_config_ulong(var, value);
1687 return 0;
1690 if (!strcmp(var, "core.deltabasecachelimit")) {
1691 delta_base_cache_limit = git_config_ulong(var, value);
1692 return 0;
1695 if (!strcmp(var, "core.autocrlf")) {
1696 if (value && !strcasecmp(value, "input")) {
1697 auto_crlf = AUTO_CRLF_INPUT;
1698 return 0;
1700 auto_crlf = git_config_bool(var, value);
1701 return 0;
1704 if (!strcmp(var, "core.safecrlf")) {
1705 int eol_rndtrp_die;
1706 if (value && !strcasecmp(value, "warn")) {
1707 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1708 return 0;
1710 eol_rndtrp_die = git_config_bool(var, value);
1711 global_conv_flags_eol = eol_rndtrp_die ?
1712 CONV_EOL_RNDTRP_DIE : 0;
1713 return 0;
1716 if (!strcmp(var, "core.eol")) {
1717 if (value && !strcasecmp(value, "lf"))
1718 core_eol = EOL_LF;
1719 else if (value && !strcasecmp(value, "crlf"))
1720 core_eol = EOL_CRLF;
1721 else if (value && !strcasecmp(value, "native"))
1722 core_eol = EOL_NATIVE;
1723 else
1724 core_eol = EOL_UNSET;
1725 return 0;
1728 if (!strcmp(var, "core.checkroundtripencoding")) {
1729 check_roundtrip_encoding = xstrdup(value);
1730 return 0;
1733 if (!strcmp(var, "core.notesref")) {
1734 notes_ref_name = xstrdup(value);
1735 return 0;
1738 if (!strcmp(var, "core.editor"))
1739 return git_config_string(&editor_program, var, value);
1741 if (!strcmp(var, "core.commentchar")) {
1742 if (!value)
1743 return config_error_nonbool(var);
1744 else if (!strcasecmp(value, "auto"))
1745 auto_comment_line_char = 1;
1746 else if (value[0] && !value[1]) {
1747 comment_line_char = value[0];
1748 auto_comment_line_char = 0;
1749 } else
1750 return error(_("core.commentChar should only be one ASCII character"));
1751 return 0;
1754 if (!strcmp(var, "core.askpass"))
1755 return git_config_string(&askpass_program, var, value);
1757 if (!strcmp(var, "core.excludesfile"))
1758 return git_config_pathname(&excludes_file, var, value);
1760 if (!strcmp(var, "core.whitespace")) {
1761 if (!value)
1762 return config_error_nonbool(var);
1763 whitespace_rule_cfg = parse_whitespace_rule(value);
1764 return 0;
1767 if (!strcmp(var, "core.fsync")) {
1768 if (!value)
1769 return config_error_nonbool(var);
1770 fsync_components = parse_fsync_components(var, value);
1771 return 0;
1774 if (!strcmp(var, "core.fsyncmethod")) {
1775 if (!value)
1776 return config_error_nonbool(var);
1777 if (!strcmp(value, "fsync"))
1778 fsync_method = FSYNC_METHOD_FSYNC;
1779 else if (!strcmp(value, "writeout-only"))
1780 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1781 else if (!strcmp(value, "batch"))
1782 fsync_method = FSYNC_METHOD_BATCH;
1783 else
1784 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1788 if (!strcmp(var, "core.fsyncobjectfiles")) {
1789 if (fsync_object_files < 0)
1790 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1791 fsync_object_files = git_config_bool(var, value);
1792 return 0;
1795 if (!strcmp(var, "core.preloadindex")) {
1796 core_preload_index = git_config_bool(var, value);
1797 return 0;
1800 if (!strcmp(var, "core.createobject")) {
1801 if (!strcmp(value, "rename"))
1802 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1803 else if (!strcmp(value, "link"))
1804 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1805 else
1806 die(_("invalid mode for object creation: %s"), value);
1807 return 0;
1810 if (!strcmp(var, "core.sparsecheckout")) {
1811 core_apply_sparse_checkout = git_config_bool(var, value);
1812 return 0;
1815 if (!strcmp(var, "core.sparsecheckoutcone")) {
1816 core_sparse_checkout_cone = git_config_bool(var, value);
1817 return 0;
1820 if (!strcmp(var, "core.precomposeunicode")) {
1821 precomposed_unicode = git_config_bool(var, value);
1822 return 0;
1825 if (!strcmp(var, "core.protecthfs")) {
1826 protect_hfs = git_config_bool(var, value);
1827 return 0;
1830 if (!strcmp(var, "core.protectntfs")) {
1831 protect_ntfs = git_config_bool(var, value);
1832 return 0;
1835 if (!strcmp(var, "core.usereplacerefs")) {
1836 read_replace_refs = git_config_bool(var, value);
1837 return 0;
1840 /* Add other config variables here and to Documentation/config.txt. */
1841 return platform_core_config(var, value, cb);
1844 static int git_default_sparse_config(const char *var, const char *value)
1846 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1847 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1848 return 0;
1851 /* Add other config variables here and to Documentation/config/sparse.txt. */
1852 return 0;
1855 static int git_default_i18n_config(const char *var, const char *value)
1857 if (!strcmp(var, "i18n.commitencoding"))
1858 return git_config_string(&git_commit_encoding, var, value);
1860 if (!strcmp(var, "i18n.logoutputencoding"))
1861 return git_config_string(&git_log_output_encoding, var, value);
1863 /* Add other config variables here and to Documentation/config.txt. */
1864 return 0;
1867 static int git_default_branch_config(const char *var, const char *value)
1869 if (!strcmp(var, "branch.autosetupmerge")) {
1870 if (value && !strcmp(value, "always")) {
1871 git_branch_track = BRANCH_TRACK_ALWAYS;
1872 return 0;
1873 } else if (value && !strcmp(value, "inherit")) {
1874 git_branch_track = BRANCH_TRACK_INHERIT;
1875 return 0;
1876 } else if (value && !strcmp(value, "simple")) {
1877 git_branch_track = BRANCH_TRACK_SIMPLE;
1878 return 0;
1880 git_branch_track = git_config_bool(var, value);
1881 return 0;
1883 if (!strcmp(var, "branch.autosetuprebase")) {
1884 if (!value)
1885 return config_error_nonbool(var);
1886 else if (!strcmp(value, "never"))
1887 autorebase = AUTOREBASE_NEVER;
1888 else if (!strcmp(value, "local"))
1889 autorebase = AUTOREBASE_LOCAL;
1890 else if (!strcmp(value, "remote"))
1891 autorebase = AUTOREBASE_REMOTE;
1892 else if (!strcmp(value, "always"))
1893 autorebase = AUTOREBASE_ALWAYS;
1894 else
1895 return error(_("malformed value for %s"), var);
1896 return 0;
1899 /* Add other config variables here and to Documentation/config.txt. */
1900 return 0;
1903 static int git_default_push_config(const char *var, const char *value)
1905 if (!strcmp(var, "push.default")) {
1906 if (!value)
1907 return config_error_nonbool(var);
1908 else if (!strcmp(value, "nothing"))
1909 push_default = PUSH_DEFAULT_NOTHING;
1910 else if (!strcmp(value, "matching"))
1911 push_default = PUSH_DEFAULT_MATCHING;
1912 else if (!strcmp(value, "simple"))
1913 push_default = PUSH_DEFAULT_SIMPLE;
1914 else if (!strcmp(value, "upstream"))
1915 push_default = PUSH_DEFAULT_UPSTREAM;
1916 else if (!strcmp(value, "tracking")) /* deprecated */
1917 push_default = PUSH_DEFAULT_UPSTREAM;
1918 else if (!strcmp(value, "current"))
1919 push_default = PUSH_DEFAULT_CURRENT;
1920 else {
1921 error(_("malformed value for %s: %s"), var, value);
1922 return error(_("must be one of nothing, matching, simple, "
1923 "upstream or current"));
1925 return 0;
1928 /* Add other config variables here and to Documentation/config.txt. */
1929 return 0;
1932 static int git_default_mailmap_config(const char *var, const char *value)
1934 if (!strcmp(var, "mailmap.file"))
1935 return git_config_pathname(&git_mailmap_file, var, value);
1936 if (!strcmp(var, "mailmap.blob"))
1937 return git_config_string(&git_mailmap_blob, var, value);
1939 /* Add other config variables here and to Documentation/config.txt. */
1940 return 0;
1943 int git_default_config(const char *var, const char *value, void *cb)
1945 if (starts_with(var, "core."))
1946 return git_default_core_config(var, value, cb);
1948 if (starts_with(var, "user.") ||
1949 starts_with(var, "author.") ||
1950 starts_with(var, "committer."))
1951 return git_ident_config(var, value, cb);
1953 if (starts_with(var, "i18n."))
1954 return git_default_i18n_config(var, value);
1956 if (starts_with(var, "branch."))
1957 return git_default_branch_config(var, value);
1959 if (starts_with(var, "push."))
1960 return git_default_push_config(var, value);
1962 if (starts_with(var, "mailmap."))
1963 return git_default_mailmap_config(var, value);
1965 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1966 return git_default_advice_config(var, value);
1968 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1969 pager_use_color = git_config_bool(var,value);
1970 return 0;
1973 if (!strcmp(var, "pack.packsizelimit")) {
1974 pack_size_limit_cfg = git_config_ulong(var, value);
1975 return 0;
1978 if (!strcmp(var, "pack.compression")) {
1979 int level = git_config_int(var, value);
1980 if (level == -1)
1981 level = Z_DEFAULT_COMPRESSION;
1982 else if (level < 0 || level > Z_BEST_COMPRESSION)
1983 die(_("bad pack compression level %d"), level);
1984 pack_compression_level = level;
1985 pack_compression_seen = 1;
1986 return 0;
1989 if (starts_with(var, "sparse."))
1990 return git_default_sparse_config(var, value);
1992 /* Add other config variables here and to Documentation/config.txt. */
1993 return 0;
1997 * All source specific fields in the union, die_on_error, name and the callbacks
1998 * fgetc, ungetc, ftell of top need to be initialized before calling
1999 * this function.
2001 static int do_config_from(struct config_reader *reader,
2002 struct config_source *top, config_fn_t fn, void *data,
2003 const struct config_options *opts)
2005 int ret;
2007 /* push config-file parsing state stack */
2008 top->linenr = 1;
2009 top->eof = 0;
2010 top->total_len = 0;
2011 strbuf_init(&top->value, 1024);
2012 strbuf_init(&top->var, 1024);
2013 config_reader_push_source(reader, top);
2015 ret = git_parse_source(top, fn, data, opts);
2017 /* pop config-file parsing state stack */
2018 strbuf_release(&top->value);
2019 strbuf_release(&top->var);
2020 config_reader_pop_source(reader);
2022 return ret;
2025 static int do_config_from_file(struct config_reader *reader,
2026 config_fn_t fn,
2027 const enum config_origin_type origin_type,
2028 const char *name, const char *path, FILE *f,
2029 void *data, const struct config_options *opts)
2031 struct config_source top = CONFIG_SOURCE_INIT;
2032 int ret;
2034 top.u.file = f;
2035 top.origin_type = origin_type;
2036 top.name = name;
2037 top.path = path;
2038 top.default_error_action = CONFIG_ERROR_DIE;
2039 top.do_fgetc = config_file_fgetc;
2040 top.do_ungetc = config_file_ungetc;
2041 top.do_ftell = config_file_ftell;
2043 flockfile(f);
2044 ret = do_config_from(reader, &top, fn, data, opts);
2045 funlockfile(f);
2046 return ret;
2049 static int git_config_from_stdin(config_fn_t fn, void *data)
2051 return do_config_from_file(&the_reader, fn, CONFIG_ORIGIN_STDIN, "",
2052 NULL, stdin, data, NULL);
2055 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
2056 void *data,
2057 const struct config_options *opts)
2059 int ret = -1;
2060 FILE *f;
2062 if (!filename)
2063 BUG("filename cannot be NULL");
2064 f = fopen_or_warn(filename, "r");
2065 if (f) {
2066 ret = do_config_from_file(&the_reader, fn, CONFIG_ORIGIN_FILE,
2067 filename, filename, f, data, opts);
2068 fclose(f);
2070 return ret;
2073 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
2075 return git_config_from_file_with_options(fn, filename, data, NULL);
2078 int git_config_from_mem(config_fn_t fn,
2079 const enum config_origin_type origin_type,
2080 const char *name, const char *buf, size_t len,
2081 void *data, const struct config_options *opts)
2083 struct config_source top = CONFIG_SOURCE_INIT;
2085 top.u.buf.buf = buf;
2086 top.u.buf.len = len;
2087 top.u.buf.pos = 0;
2088 top.origin_type = origin_type;
2089 top.name = name;
2090 top.path = NULL;
2091 top.default_error_action = CONFIG_ERROR_ERROR;
2092 top.do_fgetc = config_buf_fgetc;
2093 top.do_ungetc = config_buf_ungetc;
2094 top.do_ftell = config_buf_ftell;
2096 return do_config_from(&the_reader, &top, fn, data, opts);
2099 int git_config_from_blob_oid(config_fn_t fn,
2100 const char *name,
2101 struct repository *repo,
2102 const struct object_id *oid,
2103 void *data)
2105 enum object_type type;
2106 char *buf;
2107 unsigned long size;
2108 int ret;
2110 buf = repo_read_object_file(repo, oid, &type, &size);
2111 if (!buf)
2112 return error(_("unable to load config blob object '%s'"), name);
2113 if (type != OBJ_BLOB) {
2114 free(buf);
2115 return error(_("reference '%s' does not point to a blob"), name);
2118 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
2119 data, NULL);
2120 free(buf);
2122 return ret;
2125 static int git_config_from_blob_ref(config_fn_t fn,
2126 struct repository *repo,
2127 const char *name,
2128 void *data)
2130 struct object_id oid;
2132 if (repo_get_oid(repo, name, &oid) < 0)
2133 return error(_("unable to resolve config blob '%s'"), name);
2134 return git_config_from_blob_oid(fn, name, repo, &oid, data);
2137 char *git_system_config(void)
2139 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2140 if (!system_config)
2141 system_config = system_path(ETC_GITCONFIG);
2142 normalize_path_copy(system_config, system_config);
2143 return system_config;
2146 void git_global_config(char **user_out, char **xdg_out)
2148 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2149 char *xdg_config = NULL;
2151 if (!user_config) {
2152 user_config = interpolate_path("~/.gitconfig", 0);
2153 xdg_config = xdg_config_home("config");
2156 *user_out = user_config;
2157 *xdg_out = xdg_config;
2161 * Parse environment variable 'k' as a boolean (in various
2162 * possible spellings); if missing, use the default value 'def'.
2164 int git_env_bool(const char *k, int def)
2166 const char *v = getenv(k);
2167 return v ? git_config_bool(k, v) : def;
2171 * Parse environment variable 'k' as ulong with possibly a unit
2172 * suffix; if missing, use the default value 'val'.
2174 unsigned long git_env_ulong(const char *k, unsigned long val)
2176 const char *v = getenv(k);
2177 if (v && !git_parse_ulong(v, &val))
2178 die(_("failed to parse %s"), k);
2179 return val;
2182 int git_config_system(void)
2184 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2187 static int do_git_config_sequence(struct config_reader *reader,
2188 const struct config_options *opts,
2189 config_fn_t fn, void *data)
2191 int ret = 0;
2192 char *system_config = git_system_config();
2193 char *xdg_config = NULL;
2194 char *user_config = NULL;
2195 char *repo_config;
2196 enum config_scope prev_parsing_scope = reader->parsing_scope;
2198 if (opts->commondir)
2199 repo_config = mkpathdup("%s/config", opts->commondir);
2200 else if (opts->git_dir)
2201 BUG("git_dir without commondir");
2202 else
2203 repo_config = NULL;
2205 config_reader_set_scope(reader, CONFIG_SCOPE_SYSTEM);
2206 if (git_config_system() && system_config &&
2207 !access_or_die(system_config, R_OK,
2208 opts->system_gently ? ACCESS_EACCES_OK : 0))
2209 ret += git_config_from_file(fn, system_config, data);
2211 config_reader_set_scope(reader, CONFIG_SCOPE_GLOBAL);
2212 git_global_config(&user_config, &xdg_config);
2214 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2215 ret += git_config_from_file(fn, xdg_config, data);
2217 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2218 ret += git_config_from_file(fn, user_config, data);
2220 config_reader_set_scope(reader, CONFIG_SCOPE_LOCAL);
2221 if (!opts->ignore_repo && repo_config &&
2222 !access_or_die(repo_config, R_OK, 0))
2223 ret += git_config_from_file(fn, repo_config, data);
2225 config_reader_set_scope(reader, CONFIG_SCOPE_WORKTREE);
2226 if (!opts->ignore_worktree && repository_format_worktree_config) {
2227 char *path = git_pathdup("config.worktree");
2228 if (!access_or_die(path, R_OK, 0))
2229 ret += git_config_from_file(fn, path, data);
2230 free(path);
2233 config_reader_set_scope(reader, CONFIG_SCOPE_COMMAND);
2234 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2235 die(_("unable to parse command-line config"));
2237 config_reader_set_scope(reader, prev_parsing_scope);
2238 free(system_config);
2239 free(xdg_config);
2240 free(user_config);
2241 free(repo_config);
2242 return ret;
2245 int config_with_options(config_fn_t fn, void *data,
2246 struct git_config_source *config_source,
2247 const struct config_options *opts)
2249 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2250 enum config_scope prev_scope = the_reader.parsing_scope;
2251 int ret;
2253 if (opts->respect_includes) {
2254 inc.fn = fn;
2255 inc.data = data;
2256 inc.opts = opts;
2257 inc.config_source = config_source;
2258 inc.config_reader = &the_reader;
2259 fn = git_config_include;
2260 data = &inc;
2263 if (config_source)
2264 config_reader_set_scope(&the_reader, config_source->scope);
2267 * If we have a specific filename, use it. Otherwise, follow the
2268 * regular lookup sequence.
2270 if (config_source && config_source->use_stdin) {
2271 ret = git_config_from_stdin(fn, data);
2272 } else if (config_source && config_source->file) {
2273 ret = git_config_from_file(fn, config_source->file, data);
2274 } else if (config_source && config_source->blob) {
2275 struct repository *repo = config_source->repo ?
2276 config_source->repo : the_repository;
2277 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2278 data);
2279 } else {
2280 ret = do_git_config_sequence(&the_reader, opts, fn, data);
2283 if (inc.remote_urls) {
2284 string_list_clear(inc.remote_urls, 0);
2285 FREE_AND_NULL(inc.remote_urls);
2287 config_reader_set_scope(&the_reader, prev_scope);
2288 return ret;
2291 static void configset_iter(struct config_reader *reader, struct config_set *set,
2292 config_fn_t fn, void *data)
2294 int i, value_index;
2295 struct string_list *values;
2296 struct config_set_element *entry;
2297 struct configset_list *list = &set->list;
2299 for (i = 0; i < list->nr; i++) {
2300 entry = list->items[i].e;
2301 value_index = list->items[i].value_index;
2302 values = &entry->value_list;
2304 config_reader_set_kvi(reader, values->items[value_index].util);
2306 if (fn(entry->key, values->items[value_index].string, data) < 0)
2307 git_die_config_linenr(entry->key,
2308 reader->config_kvi->filename,
2309 reader->config_kvi->linenr);
2311 config_reader_set_kvi(reader, NULL);
2315 void read_early_config(config_fn_t cb, void *data)
2317 struct config_options opts = {0};
2318 struct strbuf commondir = STRBUF_INIT;
2319 struct strbuf gitdir = STRBUF_INIT;
2321 opts.respect_includes = 1;
2323 if (have_git_dir()) {
2324 opts.commondir = get_git_common_dir();
2325 opts.git_dir = get_git_dir();
2327 * When setup_git_directory() was not yet asked to discover the
2328 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2329 * is any repository config we should use (but unlike
2330 * setup_git_directory_gently(), no global state is changed, most
2331 * notably, the current working directory is still the same after the
2332 * call).
2334 } else if (!discover_git_directory(&commondir, &gitdir)) {
2335 opts.commondir = commondir.buf;
2336 opts.git_dir = gitdir.buf;
2339 config_with_options(cb, data, NULL, &opts);
2341 strbuf_release(&commondir);
2342 strbuf_release(&gitdir);
2346 * Read config but only enumerate system and global settings.
2347 * Omit any repo-local, worktree-local, or command-line settings.
2349 void read_very_early_config(config_fn_t cb, void *data)
2351 struct config_options opts = { 0 };
2353 opts.respect_includes = 1;
2354 opts.ignore_repo = 1;
2355 opts.ignore_worktree = 1;
2356 opts.ignore_cmdline = 1;
2357 opts.system_gently = 1;
2359 config_with_options(cb, data, NULL, &opts);
2362 RESULT_MUST_BE_USED
2363 static int configset_find_element(struct config_set *set, const char *key,
2364 struct config_set_element **dest)
2366 struct config_set_element k;
2367 struct config_set_element *found_entry;
2368 char *normalized_key;
2369 int ret;
2372 * `key` may come from the user, so normalize it before using it
2373 * for querying entries from the hashmap.
2375 ret = git_config_parse_key(key, &normalized_key, NULL);
2376 if (ret)
2377 return ret;
2379 hashmap_entry_init(&k.ent, strhash(normalized_key));
2380 k.key = normalized_key;
2381 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2382 free(normalized_key);
2383 *dest = found_entry;
2384 return 0;
2387 static int configset_add_value(struct config_reader *reader,
2388 struct config_set *set, const char *key,
2389 const char *value)
2391 struct config_set_element *e;
2392 struct string_list_item *si;
2393 struct configset_list_item *l_item;
2394 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2395 int ret;
2397 ret = configset_find_element(set, key, &e);
2398 if (ret)
2399 return ret;
2401 * Since the keys are being fed by git_config*() callback mechanism, they
2402 * are already normalized. So simply add them without any further munging.
2404 if (!e) {
2405 e = xmalloc(sizeof(*e));
2406 hashmap_entry_init(&e->ent, strhash(key));
2407 e->key = xstrdup(key);
2408 string_list_init_dup(&e->value_list);
2409 hashmap_add(&set->config_hash, &e->ent);
2411 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2413 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2414 l_item = &set->list.items[set->list.nr++];
2415 l_item->e = e;
2416 l_item->value_index = e->value_list.nr - 1;
2418 if (!reader->source)
2419 BUG("configset_add_value has no source");
2420 if (reader->source->name) {
2421 kv_info->filename = strintern(reader->source->name);
2422 kv_info->linenr = reader->source->linenr;
2423 kv_info->origin_type = reader->source->origin_type;
2424 } else {
2425 /* for values read from `git_config_from_parameters()` */
2426 kv_info->filename = NULL;
2427 kv_info->linenr = -1;
2428 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
2430 kv_info->scope = reader->parsing_scope;
2431 si->util = kv_info;
2433 return 0;
2436 static int config_set_element_cmp(const void *cmp_data UNUSED,
2437 const struct hashmap_entry *eptr,
2438 const struct hashmap_entry *entry_or_key,
2439 const void *keydata UNUSED)
2441 const struct config_set_element *e1, *e2;
2443 e1 = container_of(eptr, const struct config_set_element, ent);
2444 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2446 return strcmp(e1->key, e2->key);
2449 void git_configset_init(struct config_set *set)
2451 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2452 set->hash_initialized = 1;
2453 set->list.nr = 0;
2454 set->list.alloc = 0;
2455 set->list.items = NULL;
2458 void git_configset_clear(struct config_set *set)
2460 struct config_set_element *entry;
2461 struct hashmap_iter iter;
2462 if (!set->hash_initialized)
2463 return;
2465 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2466 ent /* member name */) {
2467 free(entry->key);
2468 string_list_clear(&entry->value_list, 1);
2470 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2471 set->hash_initialized = 0;
2472 free(set->list.items);
2473 set->list.nr = 0;
2474 set->list.alloc = 0;
2475 set->list.items = NULL;
2478 struct configset_add_data {
2479 struct config_set *config_set;
2480 struct config_reader *config_reader;
2482 #define CONFIGSET_ADD_INIT { 0 }
2484 static int config_set_callback(const char *key, const char *value, void *cb)
2486 struct configset_add_data *data = cb;
2487 configset_add_value(data->config_reader, data->config_set, key, value);
2488 return 0;
2491 int git_configset_add_file(struct config_set *set, const char *filename)
2493 struct configset_add_data data = CONFIGSET_ADD_INIT;
2494 data.config_reader = &the_reader;
2495 data.config_set = set;
2496 return git_config_from_file(config_set_callback, filename, &data);
2499 int git_configset_get_value(struct config_set *set, const char *key, const char **value)
2501 const struct string_list *values = NULL;
2502 int ret;
2505 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2506 * queried key in the files of the configset, the value returned will be the last
2507 * value in the value list for that key.
2509 if ((ret = git_configset_get_value_multi(set, key, &values)))
2510 return ret;
2512 assert(values->nr > 0);
2513 *value = values->items[values->nr - 1].string;
2514 return 0;
2517 int git_configset_get_value_multi(struct config_set *set, const char *key,
2518 const struct string_list **dest)
2520 struct config_set_element *e;
2521 int ret;
2523 if ((ret = configset_find_element(set, key, &e)))
2524 return ret;
2525 else if (!e)
2526 return 1;
2527 *dest = &e->value_list;
2529 return 0;
2532 static int check_multi_string(struct string_list_item *item, void *util)
2534 return item->string ? 0 : config_error_nonbool(util);
2537 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2538 const struct string_list **dest)
2540 int ret;
2542 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2543 return ret;
2544 if ((ret = for_each_string_list((struct string_list *)*dest,
2545 check_multi_string, (void *)key)))
2546 return ret;
2548 return 0;
2551 int git_configset_get(struct config_set *set, const char *key)
2553 struct config_set_element *e;
2554 int ret;
2556 if ((ret = configset_find_element(set, key, &e)))
2557 return ret;
2558 else if (!e)
2559 return 1;
2560 return 0;
2563 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2565 const char *value;
2566 if (!git_configset_get_value(set, key, &value))
2567 return git_config_string((const char **)dest, key, value);
2568 else
2569 return 1;
2572 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2573 const char **dest)
2575 const char *value;
2576 if (!git_configset_get_value(set, key, &value)) {
2577 if (!value)
2578 return config_error_nonbool(key);
2579 *dest = value;
2580 return 0;
2581 } else {
2582 return 1;
2586 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2588 const char *value;
2589 if (!git_configset_get_value(set, key, &value)) {
2590 *dest = git_config_int(key, value);
2591 return 0;
2592 } else
2593 return 1;
2596 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2598 const char *value;
2599 if (!git_configset_get_value(set, key, &value)) {
2600 *dest = git_config_ulong(key, value);
2601 return 0;
2602 } else
2603 return 1;
2606 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2608 const char *value;
2609 if (!git_configset_get_value(set, key, &value)) {
2610 *dest = git_config_bool(key, value);
2611 return 0;
2612 } else
2613 return 1;
2616 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2617 int *is_bool, int *dest)
2619 const char *value;
2620 if (!git_configset_get_value(set, key, &value)) {
2621 *dest = git_config_bool_or_int(key, value, is_bool);
2622 return 0;
2623 } else
2624 return 1;
2627 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2629 const char *value;
2630 if (!git_configset_get_value(set, key, &value)) {
2631 *dest = git_parse_maybe_bool(value);
2632 if (*dest == -1)
2633 return -1;
2634 return 0;
2635 } else
2636 return 1;
2639 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2641 const char *value;
2642 if (!git_configset_get_value(set, key, &value))
2643 return git_config_pathname(dest, key, value);
2644 else
2645 return 1;
2648 /* Functions use to read configuration from a repository */
2649 static void repo_read_config(struct repository *repo)
2651 struct config_options opts = { 0 };
2652 struct configset_add_data data = CONFIGSET_ADD_INIT;
2654 opts.respect_includes = 1;
2655 opts.commondir = repo->commondir;
2656 opts.git_dir = repo->gitdir;
2658 if (!repo->config)
2659 CALLOC_ARRAY(repo->config, 1);
2660 else
2661 git_configset_clear(repo->config);
2663 git_configset_init(repo->config);
2664 data.config_set = repo->config;
2665 data.config_reader = &the_reader;
2667 if (config_with_options(config_set_callback, &data, NULL, &opts) < 0)
2669 * config_with_options() normally returns only
2670 * zero, as most errors are fatal, and
2671 * non-fatal potential errors are guarded by "if"
2672 * statements that are entered only when no error is
2673 * possible.
2675 * If we ever encounter a non-fatal error, it means
2676 * something went really wrong and we should stop
2677 * immediately.
2679 die(_("unknown error occurred while reading the configuration files"));
2682 static void git_config_check_init(struct repository *repo)
2684 if (repo->config && repo->config->hash_initialized)
2685 return;
2686 repo_read_config(repo);
2689 static void repo_config_clear(struct repository *repo)
2691 if (!repo->config || !repo->config->hash_initialized)
2692 return;
2693 git_configset_clear(repo->config);
2696 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2698 git_config_check_init(repo);
2699 configset_iter(&the_reader, repo->config, fn, data);
2702 int repo_config_get(struct repository *repo, const char *key)
2704 git_config_check_init(repo);
2705 return git_configset_get(repo->config, key);
2708 int repo_config_get_value(struct repository *repo,
2709 const char *key, const char **value)
2711 git_config_check_init(repo);
2712 return git_configset_get_value(repo->config, key, value);
2715 int repo_config_get_value_multi(struct repository *repo, const char *key,
2716 const struct string_list **dest)
2718 git_config_check_init(repo);
2719 return git_configset_get_value_multi(repo->config, key, dest);
2722 int repo_config_get_string_multi(struct repository *repo, const char *key,
2723 const struct string_list **dest)
2725 git_config_check_init(repo);
2726 return git_configset_get_string_multi(repo->config, key, dest);
2729 int repo_config_get_string(struct repository *repo,
2730 const char *key, char **dest)
2732 int ret;
2733 git_config_check_init(repo);
2734 ret = git_configset_get_string(repo->config, key, dest);
2735 if (ret < 0)
2736 git_die_config(key, NULL);
2737 return ret;
2740 int repo_config_get_string_tmp(struct repository *repo,
2741 const char *key, const char **dest)
2743 int ret;
2744 git_config_check_init(repo);
2745 ret = git_configset_get_string_tmp(repo->config, key, dest);
2746 if (ret < 0)
2747 git_die_config(key, NULL);
2748 return ret;
2751 int repo_config_get_int(struct repository *repo,
2752 const char *key, int *dest)
2754 git_config_check_init(repo);
2755 return git_configset_get_int(repo->config, key, dest);
2758 int repo_config_get_ulong(struct repository *repo,
2759 const char *key, unsigned long *dest)
2761 git_config_check_init(repo);
2762 return git_configset_get_ulong(repo->config, key, dest);
2765 int repo_config_get_bool(struct repository *repo,
2766 const char *key, int *dest)
2768 git_config_check_init(repo);
2769 return git_configset_get_bool(repo->config, key, dest);
2772 int repo_config_get_bool_or_int(struct repository *repo,
2773 const char *key, int *is_bool, int *dest)
2775 git_config_check_init(repo);
2776 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2779 int repo_config_get_maybe_bool(struct repository *repo,
2780 const char *key, int *dest)
2782 git_config_check_init(repo);
2783 return git_configset_get_maybe_bool(repo->config, key, dest);
2786 int repo_config_get_pathname(struct repository *repo,
2787 const char *key, const char **dest)
2789 int ret;
2790 git_config_check_init(repo);
2791 ret = git_configset_get_pathname(repo->config, key, dest);
2792 if (ret < 0)
2793 git_die_config(key, NULL);
2794 return ret;
2797 /* Read values into protected_config. */
2798 static void read_protected_config(void)
2800 struct config_options opts = {
2801 .respect_includes = 1,
2802 .ignore_repo = 1,
2803 .ignore_worktree = 1,
2804 .system_gently = 1,
2806 struct configset_add_data data = CONFIGSET_ADD_INIT;
2808 git_configset_init(&protected_config);
2809 data.config_set = &protected_config;
2810 data.config_reader = &the_reader;
2811 config_with_options(config_set_callback, &data, NULL, &opts);
2814 void git_protected_config(config_fn_t fn, void *data)
2816 if (!protected_config.hash_initialized)
2817 read_protected_config();
2818 configset_iter(&the_reader, &protected_config, fn, data);
2821 /* Functions used historically to read configuration from 'the_repository' */
2822 void git_config(config_fn_t fn, void *data)
2824 repo_config(the_repository, fn, data);
2827 void git_config_clear(void)
2829 repo_config_clear(the_repository);
2832 int git_config_get(const char *key)
2834 return repo_config_get(the_repository, key);
2837 int git_config_get_value(const char *key, const char **value)
2839 return repo_config_get_value(the_repository, key, value);
2842 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2844 return repo_config_get_value_multi(the_repository, key, dest);
2847 int git_config_get_string_multi(const char *key,
2848 const struct string_list **dest)
2850 return repo_config_get_string_multi(the_repository, key, dest);
2853 int git_config_get_string(const char *key, char **dest)
2855 return repo_config_get_string(the_repository, key, dest);
2858 int git_config_get_string_tmp(const char *key, const char **dest)
2860 return repo_config_get_string_tmp(the_repository, key, dest);
2863 int git_config_get_int(const char *key, int *dest)
2865 return repo_config_get_int(the_repository, key, dest);
2868 int git_config_get_ulong(const char *key, unsigned long *dest)
2870 return repo_config_get_ulong(the_repository, key, dest);
2873 int git_config_get_bool(const char *key, int *dest)
2875 return repo_config_get_bool(the_repository, key, dest);
2878 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2880 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2883 int git_config_get_maybe_bool(const char *key, int *dest)
2885 return repo_config_get_maybe_bool(the_repository, key, dest);
2888 int git_config_get_pathname(const char *key, const char **dest)
2890 return repo_config_get_pathname(the_repository, key, dest);
2893 int git_config_get_expiry(const char *key, const char **output)
2895 int ret = git_config_get_string(key, (char **)output);
2896 if (ret)
2897 return ret;
2898 if (strcmp(*output, "now")) {
2899 timestamp_t now = approxidate("now");
2900 if (approxidate(*output) >= now)
2901 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2903 return ret;
2906 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2908 const char *expiry_string;
2909 intmax_t days;
2910 timestamp_t when;
2912 if (git_config_get_string_tmp(key, &expiry_string))
2913 return 1; /* no such thing */
2915 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2916 const int scale = 86400;
2917 *expiry = now - days * scale;
2918 return 0;
2921 if (!parse_expiry_date(expiry_string, &when)) {
2922 *expiry = when;
2923 return 0;
2925 return -1; /* thing exists but cannot be parsed */
2928 int git_config_get_split_index(void)
2930 int val;
2932 if (!git_config_get_maybe_bool("core.splitindex", &val))
2933 return val;
2935 return -1; /* default value */
2938 int git_config_get_max_percent_split_change(void)
2940 int val = -1;
2942 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2943 if (0 <= val && val <= 100)
2944 return val;
2946 return error(_("splitIndex.maxPercentChange value '%d' "
2947 "should be between 0 and 100"), val);
2950 return -1; /* default value */
2953 int git_config_get_index_threads(int *dest)
2955 int is_bool, val;
2957 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2958 if (val) {
2959 *dest = val;
2960 return 0;
2963 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2964 if (is_bool)
2965 *dest = val ? 0 : 1;
2966 else
2967 *dest = val;
2968 return 0;
2971 return 1;
2974 NORETURN
2975 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2977 if (!filename)
2978 die(_("unable to parse '%s' from command-line config"), key);
2979 else
2980 die(_("bad config variable '%s' in file '%s' at line %d"),
2981 key, filename, linenr);
2984 NORETURN __attribute__((format(printf, 2, 3)))
2985 void git_die_config(const char *key, const char *err, ...)
2987 const struct string_list *values;
2988 struct key_value_info *kv_info;
2989 report_fn error_fn = get_error_routine();
2991 if (err) {
2992 va_list params;
2993 va_start(params, err);
2994 error_fn(err, params);
2995 va_end(params);
2997 if (git_config_get_value_multi(key, &values))
2998 BUG("for key '%s' we must have a value to report on", key);
2999 kv_info = values->items[values->nr - 1].util;
3000 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
3004 * Find all the stuff for git_config_set() below.
3007 struct config_store_data {
3008 struct config_reader *config_reader;
3009 size_t baselen;
3010 char *key;
3011 int do_not_match;
3012 const char *fixed_value;
3013 regex_t *value_pattern;
3014 int multi_replace;
3015 struct {
3016 size_t begin, end;
3017 enum config_event_t type;
3018 int is_keys_section;
3019 } *parsed;
3020 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
3021 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
3023 #define CONFIG_STORE_INIT { 0 }
3025 static void config_store_data_clear(struct config_store_data *store)
3027 free(store->key);
3028 if (store->value_pattern != NULL &&
3029 store->value_pattern != CONFIG_REGEX_NONE) {
3030 regfree(store->value_pattern);
3031 free(store->value_pattern);
3033 free(store->parsed);
3034 free(store->seen);
3035 memset(store, 0, sizeof(*store));
3038 static int matches(const char *key, const char *value,
3039 const struct config_store_data *store)
3041 if (strcmp(key, store->key))
3042 return 0; /* not ours */
3043 if (store->fixed_value)
3044 return !strcmp(store->fixed_value, value);
3045 if (!store->value_pattern)
3046 return 1; /* always matches */
3047 if (store->value_pattern == CONFIG_REGEX_NONE)
3048 return 0; /* never matches */
3050 return store->do_not_match ^
3051 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
3054 static int store_aux_event(enum config_event_t type,
3055 size_t begin, size_t end, void *data)
3057 struct config_store_data *store = data;
3058 struct config_source *cs = store->config_reader->source;
3060 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
3061 store->parsed[store->parsed_nr].begin = begin;
3062 store->parsed[store->parsed_nr].end = end;
3063 store->parsed[store->parsed_nr].type = type;
3065 if (type == CONFIG_EVENT_SECTION) {
3066 int (*cmpfn)(const char *, const char *, size_t);
3068 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
3069 return error(_("invalid section name '%s'"), cs->var.buf);
3071 if (cs->subsection_case_sensitive)
3072 cmpfn = strncasecmp;
3073 else
3074 cmpfn = strncmp;
3076 /* Is this the section we were looking for? */
3077 store->is_keys_section =
3078 store->parsed[store->parsed_nr].is_keys_section =
3079 cs->var.len - 1 == store->baselen &&
3080 !cmpfn(cs->var.buf, store->key, store->baselen);
3081 if (store->is_keys_section) {
3082 store->section_seen = 1;
3083 ALLOC_GROW(store->seen, store->seen_nr + 1,
3084 store->seen_alloc);
3085 store->seen[store->seen_nr] = store->parsed_nr;
3089 store->parsed_nr++;
3091 return 0;
3094 static int store_aux(const char *key, const char *value, void *cb)
3096 struct config_store_data *store = cb;
3098 if (store->key_seen) {
3099 if (matches(key, value, store)) {
3100 if (store->seen_nr == 1 && store->multi_replace == 0) {
3101 warning(_("%s has multiple values"), key);
3104 ALLOC_GROW(store->seen, store->seen_nr + 1,
3105 store->seen_alloc);
3107 store->seen[store->seen_nr] = store->parsed_nr;
3108 store->seen_nr++;
3110 } else if (store->is_keys_section) {
3112 * Do not increment matches yet: this may not be a match, but we
3113 * are in the desired section.
3115 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
3116 store->seen[store->seen_nr] = store->parsed_nr;
3117 store->section_seen = 1;
3119 if (matches(key, value, store)) {
3120 store->seen_nr++;
3121 store->key_seen = 1;
3125 return 0;
3128 static int write_error(const char *filename)
3130 error(_("failed to write new configuration file %s"), filename);
3132 /* Same error code as "failed to rename". */
3133 return 4;
3136 static struct strbuf store_create_section(const char *key,
3137 const struct config_store_data *store)
3139 const char *dot;
3140 size_t i;
3141 struct strbuf sb = STRBUF_INIT;
3143 dot = memchr(key, '.', store->baselen);
3144 if (dot) {
3145 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
3146 for (i = dot - key + 1; i < store->baselen; i++) {
3147 if (key[i] == '"' || key[i] == '\\')
3148 strbuf_addch(&sb, '\\');
3149 strbuf_addch(&sb, key[i]);
3151 strbuf_addstr(&sb, "\"]\n");
3152 } else {
3153 strbuf_addch(&sb, '[');
3154 strbuf_add(&sb, key, store->baselen);
3155 strbuf_addstr(&sb, "]\n");
3158 return sb;
3161 static ssize_t write_section(int fd, const char *key,
3162 const struct config_store_data *store)
3164 struct strbuf sb = store_create_section(key, store);
3165 ssize_t ret;
3167 ret = write_in_full(fd, sb.buf, sb.len);
3168 strbuf_release(&sb);
3170 return ret;
3173 static ssize_t write_pair(int fd, const char *key, const char *value,
3174 const struct config_store_data *store)
3176 int i;
3177 ssize_t ret;
3178 const char *quote = "";
3179 struct strbuf sb = STRBUF_INIT;
3182 * Check to see if the value needs to be surrounded with a dq pair.
3183 * Note that problematic characters are always backslash-quoted; this
3184 * check is about not losing leading or trailing SP and strings that
3185 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3186 * configuration parser.
3188 if (value[0] == ' ')
3189 quote = "\"";
3190 for (i = 0; value[i]; i++)
3191 if (value[i] == ';' || value[i] == '#')
3192 quote = "\"";
3193 if (i && value[i - 1] == ' ')
3194 quote = "\"";
3196 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3198 for (i = 0; value[i]; i++)
3199 switch (value[i]) {
3200 case '\n':
3201 strbuf_addstr(&sb, "\\n");
3202 break;
3203 case '\t':
3204 strbuf_addstr(&sb, "\\t");
3205 break;
3206 case '"':
3207 case '\\':
3208 strbuf_addch(&sb, '\\');
3209 /* fallthrough */
3210 default:
3211 strbuf_addch(&sb, value[i]);
3212 break;
3214 strbuf_addf(&sb, "%s\n", quote);
3216 ret = write_in_full(fd, sb.buf, sb.len);
3217 strbuf_release(&sb);
3219 return ret;
3223 * If we are about to unset the last key(s) in a section, and if there are
3224 * no comments surrounding (or included in) the section, we will want to
3225 * extend begin/end to remove the entire section.
3227 * Note: the parameter `seen_ptr` points to the index into the store.seen
3228 * array. * This index may be incremented if a section has more than one
3229 * entry (which all are to be removed).
3231 static void maybe_remove_section(struct config_store_data *store,
3232 size_t *begin_offset, size_t *end_offset,
3233 int *seen_ptr)
3235 size_t begin;
3236 int i, seen, section_seen = 0;
3239 * First, ensure that this is the first key, and that there are no
3240 * comments before the entry nor before the section header.
3242 seen = *seen_ptr;
3243 for (i = store->seen[seen]; i > 0; i--) {
3244 enum config_event_t type = store->parsed[i - 1].type;
3246 if (type == CONFIG_EVENT_COMMENT)
3247 /* There is a comment before this entry or section */
3248 return;
3249 if (type == CONFIG_EVENT_ENTRY) {
3250 if (!section_seen)
3251 /* This is not the section's first entry. */
3252 return;
3253 /* We encountered no comment before the section. */
3254 break;
3256 if (type == CONFIG_EVENT_SECTION) {
3257 if (!store->parsed[i - 1].is_keys_section)
3258 break;
3259 section_seen = 1;
3262 begin = store->parsed[i].begin;
3265 * Next, make sure that we are removing the last key(s) in the section,
3266 * and that there are no comments that are possibly about the current
3267 * section.
3269 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3270 enum config_event_t type = store->parsed[i].type;
3272 if (type == CONFIG_EVENT_COMMENT)
3273 return;
3274 if (type == CONFIG_EVENT_SECTION) {
3275 if (store->parsed[i].is_keys_section)
3276 continue;
3277 break;
3279 if (type == CONFIG_EVENT_ENTRY) {
3280 if (++seen < store->seen_nr &&
3281 i == store->seen[seen])
3282 /* We want to remove this entry, too */
3283 continue;
3284 /* There is another entry in this section. */
3285 return;
3290 * We are really removing the last entry/entries from this section, and
3291 * there are no enclosed or surrounding comments. Remove the entire,
3292 * now-empty section.
3294 *seen_ptr = seen;
3295 *begin_offset = begin;
3296 if (i < store->parsed_nr)
3297 *end_offset = store->parsed[i].begin;
3298 else
3299 *end_offset = store->parsed[store->parsed_nr - 1].end;
3302 int git_config_set_in_file_gently(const char *config_filename,
3303 const char *key, const char *value)
3305 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3308 void git_config_set_in_file(const char *config_filename,
3309 const char *key, const char *value)
3311 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3314 int git_config_set_gently(const char *key, const char *value)
3316 return git_config_set_multivar_gently(key, value, NULL, 0);
3319 int repo_config_set_worktree_gently(struct repository *r,
3320 const char *key, const char *value)
3322 /* Only use worktree-specific config if it is already enabled. */
3323 if (repository_format_worktree_config) {
3324 char *file = repo_git_path(r, "config.worktree");
3325 int ret = git_config_set_multivar_in_file_gently(
3326 file, key, value, NULL, 0);
3327 free(file);
3328 return ret;
3330 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3333 void git_config_set(const char *key, const char *value)
3335 git_config_set_multivar(key, value, NULL, 0);
3337 trace2_cmd_set_config(key, value);
3341 * If value==NULL, unset in (remove from) config,
3342 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3343 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3344 * (only add a new one)
3345 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3346 * key/values are removed before a single new pair is written. If the
3347 * flag is not present, then replace only the first match.
3349 * Returns 0 on success.
3351 * This function does this:
3353 * - it locks the config file by creating ".git/config.lock"
3355 * - it then parses the config using store_aux() as validator to find
3356 * the position on the key/value pair to replace. If it is to be unset,
3357 * it must be found exactly once.
3359 * - the config file is mmap()ed and the part before the match (if any) is
3360 * written to the lock file, then the changed part and the rest.
3362 * - the config file is removed and the lock file rename()d to it.
3365 int git_config_set_multivar_in_file_gently(const char *config_filename,
3366 const char *key, const char *value,
3367 const char *value_pattern,
3368 unsigned flags)
3370 int fd = -1, in_fd = -1;
3371 int ret;
3372 struct lock_file lock = LOCK_INIT;
3373 char *filename_buf = NULL;
3374 char *contents = NULL;
3375 size_t contents_sz;
3376 struct config_store_data store = CONFIG_STORE_INIT;
3378 store.config_reader = &the_reader;
3380 /* parse-key returns negative; flip the sign to feed exit(3) */
3381 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3382 if (ret)
3383 goto out_free;
3385 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3387 if (!config_filename)
3388 config_filename = filename_buf = git_pathdup("config");
3391 * The lock serves a purpose in addition to locking: the new
3392 * contents of .git/config will be written into it.
3394 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3395 if (fd < 0) {
3396 error_errno(_("could not lock config file %s"), config_filename);
3397 ret = CONFIG_NO_LOCK;
3398 goto out_free;
3402 * If .git/config does not exist yet, write a minimal version.
3404 in_fd = open(config_filename, O_RDONLY);
3405 if ( in_fd < 0 ) {
3406 if ( ENOENT != errno ) {
3407 error_errno(_("opening %s"), config_filename);
3408 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3409 goto out_free;
3411 /* if nothing to unset, error out */
3412 if (!value) {
3413 ret = CONFIG_NOTHING_SET;
3414 goto out_free;
3417 free(store.key);
3418 store.key = xstrdup(key);
3419 if (write_section(fd, key, &store) < 0 ||
3420 write_pair(fd, key, value, &store) < 0)
3421 goto write_err_out;
3422 } else {
3423 struct stat st;
3424 size_t copy_begin, copy_end;
3425 int i, new_line = 0;
3426 struct config_options opts;
3428 if (!value_pattern)
3429 store.value_pattern = NULL;
3430 else if (value_pattern == CONFIG_REGEX_NONE)
3431 store.value_pattern = CONFIG_REGEX_NONE;
3432 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3433 store.fixed_value = value_pattern;
3434 else {
3435 if (value_pattern[0] == '!') {
3436 store.do_not_match = 1;
3437 value_pattern++;
3438 } else
3439 store.do_not_match = 0;
3441 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3442 if (regcomp(store.value_pattern, value_pattern,
3443 REG_EXTENDED)) {
3444 error(_("invalid pattern: %s"), value_pattern);
3445 FREE_AND_NULL(store.value_pattern);
3446 ret = CONFIG_INVALID_PATTERN;
3447 goto out_free;
3451 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3452 store.parsed[0].end = 0;
3454 memset(&opts, 0, sizeof(opts));
3455 opts.event_fn = store_aux_event;
3456 opts.event_fn_data = &store;
3459 * After this, store.parsed will contain offsets of all the
3460 * parsed elements, and store.seen will contain a list of
3461 * matches, as indices into store.parsed.
3463 * As a side effect, we make sure to transform only a valid
3464 * existing config file.
3466 if (git_config_from_file_with_options(store_aux,
3467 config_filename,
3468 &store, &opts)) {
3469 error(_("invalid config file %s"), config_filename);
3470 ret = CONFIG_INVALID_FILE;
3471 goto out_free;
3474 /* if nothing to unset, or too many matches, error out */
3475 if ((store.seen_nr == 0 && value == NULL) ||
3476 (store.seen_nr > 1 && !store.multi_replace)) {
3477 ret = CONFIG_NOTHING_SET;
3478 goto out_free;
3481 if (fstat(in_fd, &st) == -1) {
3482 error_errno(_("fstat on %s failed"), config_filename);
3483 ret = CONFIG_INVALID_FILE;
3484 goto out_free;
3487 contents_sz = xsize_t(st.st_size);
3488 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3489 MAP_PRIVATE, in_fd, 0);
3490 if (contents == MAP_FAILED) {
3491 if (errno == ENODEV && S_ISDIR(st.st_mode))
3492 errno = EISDIR;
3493 error_errno(_("unable to mmap '%s'%s"),
3494 config_filename, mmap_os_err());
3495 ret = CONFIG_INVALID_FILE;
3496 contents = NULL;
3497 goto out_free;
3499 close(in_fd);
3500 in_fd = -1;
3502 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3503 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3504 ret = CONFIG_NO_WRITE;
3505 goto out_free;
3508 if (store.seen_nr == 0) {
3509 if (!store.seen_alloc) {
3510 /* Did not see key nor section */
3511 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3512 store.seen[0] = store.parsed_nr
3513 - !!store.parsed_nr;
3515 store.seen_nr = 1;
3518 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3519 size_t replace_end;
3520 int j = store.seen[i];
3522 new_line = 0;
3523 if (!store.key_seen) {
3524 copy_end = store.parsed[j].end;
3525 /* include '\n' when copying section header */
3526 if (copy_end > 0 && copy_end < contents_sz &&
3527 contents[copy_end - 1] != '\n' &&
3528 contents[copy_end] == '\n')
3529 copy_end++;
3530 replace_end = copy_end;
3531 } else {
3532 replace_end = store.parsed[j].end;
3533 copy_end = store.parsed[j].begin;
3534 if (!value)
3535 maybe_remove_section(&store,
3536 &copy_end,
3537 &replace_end, &i);
3539 * Swallow preceding white-space on the same
3540 * line.
3542 while (copy_end > 0 ) {
3543 char c = contents[copy_end - 1];
3545 if (isspace(c) && c != '\n')
3546 copy_end--;
3547 else
3548 break;
3552 if (copy_end > 0 && contents[copy_end-1] != '\n')
3553 new_line = 1;
3555 /* write the first part of the config */
3556 if (copy_end > copy_begin) {
3557 if (write_in_full(fd, contents + copy_begin,
3558 copy_end - copy_begin) < 0)
3559 goto write_err_out;
3560 if (new_line &&
3561 write_str_in_full(fd, "\n") < 0)
3562 goto write_err_out;
3564 copy_begin = replace_end;
3567 /* write the pair (value == NULL means unset) */
3568 if (value) {
3569 if (!store.section_seen) {
3570 if (write_section(fd, key, &store) < 0)
3571 goto write_err_out;
3573 if (write_pair(fd, key, value, &store) < 0)
3574 goto write_err_out;
3577 /* write the rest of the config */
3578 if (copy_begin < contents_sz)
3579 if (write_in_full(fd, contents + copy_begin,
3580 contents_sz - copy_begin) < 0)
3581 goto write_err_out;
3583 munmap(contents, contents_sz);
3584 contents = NULL;
3587 if (commit_lock_file(&lock) < 0) {
3588 error_errno(_("could not write config file %s"), config_filename);
3589 ret = CONFIG_NO_WRITE;
3590 goto out_free;
3593 ret = 0;
3595 /* Invalidate the config cache */
3596 git_config_clear();
3598 out_free:
3599 rollback_lock_file(&lock);
3600 free(filename_buf);
3601 if (contents)
3602 munmap(contents, contents_sz);
3603 if (in_fd >= 0)
3604 close(in_fd);
3605 config_store_data_clear(&store);
3606 return ret;
3608 write_err_out:
3609 ret = write_error(get_lock_file_path(&lock));
3610 goto out_free;
3614 void git_config_set_multivar_in_file(const char *config_filename,
3615 const char *key, const char *value,
3616 const char *value_pattern, unsigned flags)
3618 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3619 value_pattern, flags))
3620 return;
3621 if (value)
3622 die(_("could not set '%s' to '%s'"), key, value);
3623 else
3624 die(_("could not unset '%s'"), key);
3627 int git_config_set_multivar_gently(const char *key, const char *value,
3628 const char *value_pattern, unsigned flags)
3630 return repo_config_set_multivar_gently(the_repository, key, value,
3631 value_pattern, flags);
3634 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3635 const char *value,
3636 const char *value_pattern, unsigned flags)
3638 char *file = repo_git_path(r, "config");
3639 int res = git_config_set_multivar_in_file_gently(file,
3640 key, value,
3641 value_pattern,
3642 flags);
3643 free(file);
3644 return res;
3647 void git_config_set_multivar(const char *key, const char *value,
3648 const char *value_pattern, unsigned flags)
3650 git_config_set_multivar_in_file(git_path("config"),
3651 key, value, value_pattern,
3652 flags);
3655 static int section_name_match (const char *buf, const char *name)
3657 int i = 0, j = 0, dot = 0;
3658 if (buf[i] != '[')
3659 return 0;
3660 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3661 if (!dot && isspace(buf[i])) {
3662 dot = 1;
3663 if (name[j++] != '.')
3664 break;
3665 for (i++; isspace(buf[i]); i++)
3666 ; /* do nothing */
3667 if (buf[i] != '"')
3668 break;
3669 continue;
3671 if (buf[i] == '\\' && dot)
3672 i++;
3673 else if (buf[i] == '"' && dot) {
3674 for (i++; isspace(buf[i]); i++)
3675 ; /* do_nothing */
3676 break;
3678 if (buf[i] != name[j++])
3679 break;
3681 if (buf[i] == ']' && name[j] == 0) {
3683 * We match, now just find the right length offset by
3684 * gobbling up any whitespace after it, as well
3686 i++;
3687 for (; buf[i] && isspace(buf[i]); i++)
3688 ; /* do nothing */
3689 return i;
3691 return 0;
3694 static int section_name_is_ok(const char *name)
3696 /* Empty section names are bogus. */
3697 if (!*name)
3698 return 0;
3701 * Before a dot, we must be alphanumeric or dash. After the first dot,
3702 * anything goes, so we can stop checking.
3704 for (; *name && *name != '.'; name++)
3705 if (*name != '-' && !isalnum(*name))
3706 return 0;
3707 return 1;
3710 /* if new_name == NULL, the section is removed instead */
3711 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3712 const char *old_name,
3713 const char *new_name, int copy)
3715 int ret = 0, remove = 0;
3716 char *filename_buf = NULL;
3717 struct lock_file lock = LOCK_INIT;
3718 int out_fd;
3719 char buf[1024];
3720 FILE *config_file = NULL;
3721 struct stat st;
3722 struct strbuf copystr = STRBUF_INIT;
3723 struct config_store_data store;
3725 memset(&store, 0, sizeof(store));
3727 if (new_name && !section_name_is_ok(new_name)) {
3728 ret = error(_("invalid section name: %s"), new_name);
3729 goto out_no_rollback;
3732 if (!config_filename)
3733 config_filename = filename_buf = git_pathdup("config");
3735 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3736 if (out_fd < 0) {
3737 ret = error(_("could not lock config file %s"), config_filename);
3738 goto out;
3741 if (!(config_file = fopen(config_filename, "rb"))) {
3742 ret = warn_on_fopen_errors(config_filename);
3743 if (ret)
3744 goto out;
3745 /* no config file means nothing to rename, no error */
3746 goto commit_and_out;
3749 if (fstat(fileno(config_file), &st) == -1) {
3750 ret = error_errno(_("fstat on %s failed"), config_filename);
3751 goto out;
3754 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3755 ret = error_errno(_("chmod on %s failed"),
3756 get_lock_file_path(&lock));
3757 goto out;
3760 while (fgets(buf, sizeof(buf), config_file)) {
3761 unsigned i;
3762 int length;
3763 int is_section = 0;
3764 char *output = buf;
3765 for (i = 0; buf[i] && isspace(buf[i]); i++)
3766 ; /* do nothing */
3767 if (buf[i] == '[') {
3768 /* it's a section */
3769 int offset;
3770 is_section = 1;
3773 * When encountering a new section under -c we
3774 * need to flush out any section we're already
3775 * coping and begin anew. There might be
3776 * multiple [branch "$name"] sections.
3778 if (copystr.len > 0) {
3779 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3780 ret = write_error(get_lock_file_path(&lock));
3781 goto out;
3783 strbuf_reset(&copystr);
3786 offset = section_name_match(&buf[i], old_name);
3787 if (offset > 0) {
3788 ret++;
3789 if (!new_name) {
3790 remove = 1;
3791 continue;
3793 store.baselen = strlen(new_name);
3794 if (!copy) {
3795 if (write_section(out_fd, new_name, &store) < 0) {
3796 ret = write_error(get_lock_file_path(&lock));
3797 goto out;
3800 * We wrote out the new section, with
3801 * a newline, now skip the old
3802 * section's length
3804 output += offset + i;
3805 if (strlen(output) > 0) {
3807 * More content means there's
3808 * a declaration to put on the
3809 * next line; indent with a
3810 * tab
3812 output -= 1;
3813 output[0] = '\t';
3815 } else {
3816 copystr = store_create_section(new_name, &store);
3819 remove = 0;
3821 if (remove)
3822 continue;
3823 length = strlen(output);
3825 if (!is_section && copystr.len > 0) {
3826 strbuf_add(&copystr, output, length);
3829 if (write_in_full(out_fd, output, length) < 0) {
3830 ret = write_error(get_lock_file_path(&lock));
3831 goto out;
3836 * Copy a trailing section at the end of the config, won't be
3837 * flushed by the usual "flush because we have a new section
3838 * logic in the loop above.
3840 if (copystr.len > 0) {
3841 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3842 ret = write_error(get_lock_file_path(&lock));
3843 goto out;
3845 strbuf_reset(&copystr);
3848 fclose(config_file);
3849 config_file = NULL;
3850 commit_and_out:
3851 if (commit_lock_file(&lock) < 0)
3852 ret = error_errno(_("could not write config file %s"),
3853 config_filename);
3854 out:
3855 if (config_file)
3856 fclose(config_file);
3857 rollback_lock_file(&lock);
3858 out_no_rollback:
3859 free(filename_buf);
3860 config_store_data_clear(&store);
3861 return ret;
3864 int git_config_rename_section_in_file(const char *config_filename,
3865 const char *old_name, const char *new_name)
3867 return git_config_copy_or_rename_section_in_file(config_filename,
3868 old_name, new_name, 0);
3871 int git_config_rename_section(const char *old_name, const char *new_name)
3873 return git_config_rename_section_in_file(NULL, old_name, new_name);
3876 int git_config_copy_section_in_file(const char *config_filename,
3877 const char *old_name, const char *new_name)
3879 return git_config_copy_or_rename_section_in_file(config_filename,
3880 old_name, new_name, 1);
3883 int git_config_copy_section(const char *old_name, const char *new_name)
3885 return git_config_copy_section_in_file(NULL, old_name, new_name);
3889 * Call this to report error for your variable that should not
3890 * get a boolean value (i.e. "[my] var" means "true").
3892 #undef config_error_nonbool
3893 int config_error_nonbool(const char *var)
3895 return error(_("missing value for '%s'"), var);
3898 int parse_config_key(const char *var,
3899 const char *section,
3900 const char **subsection, size_t *subsection_len,
3901 const char **key)
3903 const char *dot;
3905 /* Does it start with "section." ? */
3906 if (!skip_prefix(var, section, &var) || *var != '.')
3907 return -1;
3910 * Find the key; we don't know yet if we have a subsection, but we must
3911 * parse backwards from the end, since the subsection may have dots in
3912 * it, too.
3914 dot = strrchr(var, '.');
3915 *key = dot + 1;
3917 /* Did we have a subsection at all? */
3918 if (dot == var) {
3919 if (subsection) {
3920 *subsection = NULL;
3921 *subsection_len = 0;
3924 else {
3925 if (!subsection)
3926 return -1;
3927 *subsection = var + 1;
3928 *subsection_len = dot - *subsection;
3931 return 0;
3934 static int reader_origin_type(struct config_reader *reader,
3935 enum config_origin_type *type)
3937 if (the_reader.config_kvi)
3938 *type = reader->config_kvi->origin_type;
3939 else if(the_reader.source)
3940 *type = reader->source->origin_type;
3941 else
3942 return 1;
3943 return 0;
3946 const char *current_config_origin_type(void)
3948 enum config_origin_type type = CONFIG_ORIGIN_UNKNOWN;
3950 if (reader_origin_type(&the_reader, &type))
3951 BUG("current_config_origin_type called outside config callback");
3953 switch (type) {
3954 case CONFIG_ORIGIN_BLOB:
3955 return "blob";
3956 case CONFIG_ORIGIN_FILE:
3957 return "file";
3958 case CONFIG_ORIGIN_STDIN:
3959 return "standard input";
3960 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3961 return "submodule-blob";
3962 case CONFIG_ORIGIN_CMDLINE:
3963 return "command line";
3964 default:
3965 BUG("unknown config origin type");
3969 const char *config_scope_name(enum config_scope scope)
3971 switch (scope) {
3972 case CONFIG_SCOPE_SYSTEM:
3973 return "system";
3974 case CONFIG_SCOPE_GLOBAL:
3975 return "global";
3976 case CONFIG_SCOPE_LOCAL:
3977 return "local";
3978 case CONFIG_SCOPE_WORKTREE:
3979 return "worktree";
3980 case CONFIG_SCOPE_COMMAND:
3981 return "command";
3982 case CONFIG_SCOPE_SUBMODULE:
3983 return "submodule";
3984 default:
3985 return "unknown";
3989 static int reader_config_name(struct config_reader *reader, const char **out)
3991 if (the_reader.config_kvi)
3992 *out = reader->config_kvi->filename;
3993 else if (the_reader.source)
3994 *out = reader->source->name;
3995 else
3996 return 1;
3997 return 0;
4000 const char *current_config_name(void)
4002 const char *name;
4003 if (reader_config_name(&the_reader, &name))
4004 BUG("current_config_name called outside config callback");
4005 return name ? name : "";
4008 enum config_scope current_config_scope(void)
4010 if (the_reader.config_kvi)
4011 return the_reader.config_kvi->scope;
4012 else
4013 return the_reader.parsing_scope;
4016 int current_config_line(void)
4018 if (the_reader.config_kvi)
4019 return the_reader.config_kvi->linenr;
4020 else
4021 return the_reader.source->linenr;
4024 int lookup_config(const char **mapping, int nr_mapping, const char *var)
4026 int i;
4028 for (i = 0; i < nr_mapping; i++) {
4029 const char *name = mapping[i];
4031 if (name && !strcasecmp(var, name))
4032 return i;
4034 return -1;