Merge branch 'kn/ref-transaction-symref'
[git.git] / config.c
blobd57996240bb318a9548bc7342759e20d73fa6910
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "git-compat-util.h"
9 #include "abspath.h"
10 #include "advice.h"
11 #include "date.h"
12 #include "branch.h"
13 #include "config.h"
14 #include "parse.h"
15 #include "convert.h"
16 #include "environment.h"
17 #include "gettext.h"
18 #include "ident.h"
19 #include "repository.h"
20 #include "lockfile.h"
21 #include "mailmap.h"
22 #include "attr.h"
23 #include "exec-cmd.h"
24 #include "strbuf.h"
25 #include "quote.h"
26 #include "hashmap.h"
27 #include "string-list.h"
28 #include "object-name.h"
29 #include "object-store-ll.h"
30 #include "pager.h"
31 #include "path.h"
32 #include "utf8.h"
33 #include "color.h"
34 #include "refs.h"
35 #include "setup.h"
36 #include "strvec.h"
37 #include "trace2.h"
38 #include "wildmatch.h"
39 #include "ws.h"
40 #include "write-or-die.h"
42 struct config_source {
43 struct config_source *prev;
44 union {
45 FILE *file;
46 struct config_buf {
47 const char *buf;
48 size_t len;
49 size_t pos;
50 } buf;
51 } u;
52 enum config_origin_type origin_type;
53 const char *name;
54 const char *path;
55 enum config_error_action default_error_action;
56 int linenr;
57 int eof;
58 size_t total_len;
59 struct strbuf value;
60 struct strbuf var;
61 unsigned subsection_case_sensitive : 1;
63 int (*do_fgetc)(struct config_source *c);
64 int (*do_ungetc)(int c, struct config_source *conf);
65 long (*do_ftell)(struct config_source *c);
67 #define CONFIG_SOURCE_INIT { 0 }
69 static int pack_compression_seen;
70 static int zlib_compression_seen;
73 * Config that comes from trusted scopes, namely:
74 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
75 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
76 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
78 * This is declared here for code cleanliness, but unlike the other
79 * static variables, this does not hold config parser state.
81 static struct config_set protected_config;
83 static int config_file_fgetc(struct config_source *conf)
85 return getc_unlocked(conf->u.file);
88 static int config_file_ungetc(int c, struct config_source *conf)
90 return ungetc(c, conf->u.file);
93 static long config_file_ftell(struct config_source *conf)
95 return ftell(conf->u.file);
98 static int config_buf_fgetc(struct config_source *conf)
100 if (conf->u.buf.pos < conf->u.buf.len)
101 return conf->u.buf.buf[conf->u.buf.pos++];
103 return EOF;
106 static int config_buf_ungetc(int c, struct config_source *conf)
108 if (conf->u.buf.pos > 0) {
109 conf->u.buf.pos--;
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
111 BUG("config_buf can only ungetc the same character");
112 return c;
115 return EOF;
118 static long config_buf_ftell(struct config_source *conf)
120 return conf->u.buf.pos;
123 struct config_include_data {
124 int depth;
125 config_fn_t fn;
126 void *data;
127 const struct config_options *opts;
128 struct git_config_source *config_source;
129 struct repository *repo;
132 * All remote URLs discovered when reading all config files.
134 struct string_list *remote_urls;
136 #define CONFIG_INCLUDE_INIT { 0 }
138 static int git_config_include(const char *var, const char *value,
139 const struct config_context *ctx, void *data);
141 #define MAX_INCLUDE_DEPTH 10
142 static const char include_depth_advice[] = N_(
143 "exceeded maximum include depth (%d) while including\n"
144 " %s\n"
145 "from\n"
146 " %s\n"
147 "This might be due to circular includes.");
148 static int handle_path_include(const struct key_value_info *kvi,
149 const char *path,
150 struct config_include_data *inc)
152 int ret = 0;
153 struct strbuf buf = STRBUF_INIT;
154 char *expanded;
156 if (!path)
157 return config_error_nonbool("include.path");
159 expanded = interpolate_path(path, 0);
160 if (!expanded)
161 return error(_("could not expand include path '%s'"), path);
162 path = expanded;
165 * Use an absolute path as-is, but interpret relative paths
166 * based on the including config file.
168 if (!is_absolute_path(path)) {
169 char *slash;
171 if (!kvi || !kvi->path) {
172 ret = error(_("relative config includes must come from files"));
173 goto cleanup;
176 slash = find_last_dir_sep(kvi->path);
177 if (slash)
178 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
179 strbuf_addstr(&buf, path);
180 path = buf.buf;
183 if (!access_or_die(path, R_OK, 0)) {
184 if (++inc->depth > MAX_INCLUDE_DEPTH)
185 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
186 !kvi ? "<unknown>" :
187 kvi->filename ? kvi->filename :
188 "the command line");
189 ret = git_config_from_file_with_options(git_config_include, path, inc,
190 kvi->scope, NULL);
191 inc->depth--;
193 cleanup:
194 strbuf_release(&buf);
195 free(expanded);
196 return ret;
199 static void add_trailing_starstar_for_dir(struct strbuf *pat)
201 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
202 strbuf_addstr(pat, "**");
205 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
206 struct strbuf *pat)
208 struct strbuf path = STRBUF_INIT;
209 char *expanded;
210 int prefix = 0;
212 expanded = interpolate_path(pat->buf, 1);
213 if (expanded) {
214 strbuf_reset(pat);
215 strbuf_addstr(pat, expanded);
216 free(expanded);
219 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
220 const char *slash;
222 if (!kvi || !kvi->path)
223 return error(_("relative config include "
224 "conditionals must come from files"));
226 strbuf_realpath(&path, kvi->path, 1);
227 slash = find_last_dir_sep(path.buf);
228 if (!slash)
229 BUG("how is this possible?");
230 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
231 prefix = slash - path.buf + 1 /* slash */;
232 } else if (!is_absolute_path(pat->buf))
233 strbuf_insertstr(pat, 0, "**/");
235 add_trailing_starstar_for_dir(pat);
237 strbuf_release(&path);
238 return prefix;
241 static int include_by_gitdir(const struct key_value_info *kvi,
242 const struct config_options *opts,
243 const char *cond, size_t cond_len, int icase)
245 struct strbuf text = STRBUF_INIT;
246 struct strbuf pattern = STRBUF_INIT;
247 int ret = 0, prefix;
248 const char *git_dir;
249 int already_tried_absolute = 0;
251 if (opts->git_dir)
252 git_dir = opts->git_dir;
253 else
254 goto done;
256 strbuf_realpath(&text, git_dir, 1);
257 strbuf_add(&pattern, cond, cond_len);
258 prefix = prepare_include_condition_pattern(kvi, &pattern);
260 again:
261 if (prefix < 0)
262 goto done;
264 if (prefix > 0) {
266 * perform literal matching on the prefix part so that
267 * any wildcard character in it can't create side effects.
269 if (text.len < prefix)
270 goto done;
271 if (!icase && strncmp(pattern.buf, text.buf, prefix))
272 goto done;
273 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
274 goto done;
277 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
278 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
280 if (!ret && !already_tried_absolute) {
282 * We've tried e.g. matching gitdir:~/work, but if
283 * ~/work is a symlink to /mnt/storage/work
284 * strbuf_realpath() will expand it, so the rule won't
285 * match. Let's match against a
286 * strbuf_add_absolute_path() version of the path,
287 * which'll do the right thing
289 strbuf_reset(&text);
290 strbuf_add_absolute_path(&text, git_dir);
291 already_tried_absolute = 1;
292 goto again;
294 done:
295 strbuf_release(&pattern);
296 strbuf_release(&text);
297 return ret;
300 static int include_by_branch(const char *cond, size_t cond_len)
302 int flags;
303 int ret;
304 struct strbuf pattern = STRBUF_INIT;
305 const char *refname = !the_repository->gitdir ?
306 NULL : refs_resolve_ref_unsafe(get_main_ref_store(the_repository),
307 "HEAD", 0, NULL, &flags);
308 const char *shortname;
310 if (!refname || !(flags & REF_ISSYMREF) ||
311 !skip_prefix(refname, "refs/heads/", &shortname))
312 return 0;
314 strbuf_add(&pattern, cond, cond_len);
315 add_trailing_starstar_for_dir(&pattern);
316 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
317 strbuf_release(&pattern);
318 return ret;
321 static int add_remote_url(const char *var, const char *value,
322 const struct config_context *ctx UNUSED, void *data)
324 struct string_list *remote_urls = data;
325 const char *remote_name;
326 size_t remote_name_len;
327 const char *key;
329 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
330 &key) &&
331 remote_name &&
332 !strcmp(key, "url"))
333 string_list_append(remote_urls, value);
334 return 0;
337 static void populate_remote_urls(struct config_include_data *inc)
339 struct config_options opts;
341 opts = *inc->opts;
342 opts.unconditional_remote_url = 1;
344 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
345 string_list_init_dup(inc->remote_urls);
346 config_with_options(add_remote_url, inc->remote_urls,
347 inc->config_source, inc->repo, &opts);
350 static int forbid_remote_url(const char *var, const char *value UNUSED,
351 const struct config_context *ctx UNUSED,
352 void *data UNUSED)
354 const char *remote_name;
355 size_t remote_name_len;
356 const char *key;
358 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
359 &key) &&
360 remote_name &&
361 !strcmp(key, "url"))
362 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
363 return 0;
366 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
367 struct string_list *remote_urls)
369 struct strbuf pattern = STRBUF_INIT;
370 struct string_list_item *url_item;
371 int found = 0;
373 strbuf_add(&pattern, glob, glob_len);
374 for_each_string_list_item(url_item, remote_urls) {
375 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
376 found = 1;
377 break;
380 strbuf_release(&pattern);
381 return found;
384 static int include_by_remote_url(struct config_include_data *inc,
385 const char *cond, size_t cond_len)
387 if (inc->opts->unconditional_remote_url)
388 return 1;
389 if (!inc->remote_urls)
390 populate_remote_urls(inc);
391 return at_least_one_url_matches_glob(cond, cond_len,
392 inc->remote_urls);
395 static int include_condition_is_true(const struct key_value_info *kvi,
396 struct config_include_data *inc,
397 const char *cond, size_t cond_len)
399 const struct config_options *opts = inc->opts;
401 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
402 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
403 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
404 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
405 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
406 return include_by_branch(cond, cond_len);
407 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
408 &cond_len))
409 return include_by_remote_url(inc, cond, cond_len);
411 /* unknown conditionals are always false */
412 return 0;
415 static int git_config_include(const char *var, const char *value,
416 const struct config_context *ctx,
417 void *data)
419 struct config_include_data *inc = data;
420 const char *cond, *key;
421 size_t cond_len;
422 int ret;
425 * Pass along all values, including "include" directives; this makes it
426 * possible to query information on the includes themselves.
428 ret = inc->fn(var, value, ctx, inc->data);
429 if (ret < 0)
430 return ret;
432 if (!strcmp(var, "include.path"))
433 ret = handle_path_include(ctx->kvi, value, inc);
435 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
436 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
437 !strcmp(key, "path")) {
438 config_fn_t old_fn = inc->fn;
440 if (inc->opts->unconditional_remote_url)
441 inc->fn = forbid_remote_url;
442 ret = handle_path_include(ctx->kvi, value, inc);
443 inc->fn = old_fn;
446 return ret;
449 static void git_config_push_split_parameter(const char *key, const char *value)
451 struct strbuf env = STRBUF_INIT;
452 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
453 if (old && *old) {
454 strbuf_addstr(&env, old);
455 strbuf_addch(&env, ' ');
457 sq_quote_buf(&env, key);
458 strbuf_addch(&env, '=');
459 if (value)
460 sq_quote_buf(&env, value);
461 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
462 strbuf_release(&env);
465 void git_config_push_parameter(const char *text)
467 const char *value;
470 * When we see:
472 * section.subsection=with=equals.key=value
474 * we cannot tell if it means:
476 * [section "subsection=with=equals"]
477 * key = value
479 * or:
481 * [section]
482 * subsection = with=equals.key=value
484 * We parse left-to-right for the first "=", meaning we'll prefer to
485 * keep the value intact over the subsection. This is historical, but
486 * also sensible since values are more likely to contain odd or
487 * untrusted input than a section name.
489 * A missing equals is explicitly allowed (as a bool-only entry).
491 value = strchr(text, '=');
492 if (value) {
493 char *key = xmemdupz(text, value - text);
494 git_config_push_split_parameter(key, value + 1);
495 free(key);
496 } else {
497 git_config_push_split_parameter(text, NULL);
501 void git_config_push_env(const char *spec)
503 char *key;
504 const char *env_name;
505 const char *env_value;
507 env_name = strrchr(spec, '=');
508 if (!env_name)
509 die(_("invalid config format: %s"), spec);
510 key = xmemdupz(spec, env_name - spec);
511 env_name++;
512 if (!*env_name)
513 die(_("missing environment variable name for configuration '%.*s'"),
514 (int)(env_name - spec - 1), spec);
516 env_value = getenv(env_name);
517 if (!env_value)
518 die(_("missing environment variable '%s' for configuration '%.*s'"),
519 env_name, (int)(env_name - spec - 1), spec);
521 git_config_push_split_parameter(key, env_value);
522 free(key);
525 static inline int iskeychar(int c)
527 return isalnum(c) || c == '-';
531 * Auxiliary function to sanity-check and split the key into the section
532 * identifier and variable name.
534 * Returns 0 on success, -1 when there is an invalid character in the key and
535 * -2 if there is no section name in the key.
537 * store_key - pointer to char* which will hold a copy of the key with
538 * lowercase section and variable name
539 * baselen - pointer to size_t which will hold the length of the
540 * section + subsection part, can be NULL
542 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
544 size_t i, baselen;
545 int dot;
546 const char *last_dot = strrchr(key, '.');
549 * Since "key" actually contains the section name and the real
550 * key name separated by a dot, we have to know where the dot is.
553 if (last_dot == NULL || last_dot == key) {
554 error(_("key does not contain a section: %s"), key);
555 return -CONFIG_NO_SECTION_OR_NAME;
558 if (!last_dot[1]) {
559 error(_("key does not contain variable name: %s"), key);
560 return -CONFIG_NO_SECTION_OR_NAME;
563 baselen = last_dot - key;
564 if (baselen_)
565 *baselen_ = baselen;
568 * Validate the key and while at it, lower case it for matching.
570 *store_key = xmallocz(strlen(key));
572 dot = 0;
573 for (i = 0; key[i]; i++) {
574 unsigned char c = key[i];
575 if (c == '.')
576 dot = 1;
577 /* Leave the extended basename untouched.. */
578 if (!dot || i > baselen) {
579 if (!iskeychar(c) ||
580 (i == baselen + 1 && !isalpha(c))) {
581 error(_("invalid key: %s"), key);
582 goto out_free_ret_1;
584 c = tolower(c);
585 } else if (c == '\n') {
586 error(_("invalid key (newline): %s"), key);
587 goto out_free_ret_1;
589 (*store_key)[i] = c;
592 return 0;
594 out_free_ret_1:
595 FREE_AND_NULL(*store_key);
596 return -CONFIG_INVALID_KEY;
599 static int config_parse_pair(const char *key, const char *value,
600 struct key_value_info *kvi,
601 config_fn_t fn, void *data)
603 char *canonical_name;
604 int ret;
605 struct config_context ctx = {
606 .kvi = kvi,
609 if (!strlen(key))
610 return error(_("empty config key"));
611 if (git_config_parse_key(key, &canonical_name, NULL))
612 return -1;
614 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
615 free(canonical_name);
616 return ret;
620 /* for values read from `git_config_from_parameters()` */
621 void kvi_from_param(struct key_value_info *out)
623 out->filename = NULL;
624 out->linenr = -1;
625 out->origin_type = CONFIG_ORIGIN_CMDLINE;
626 out->scope = CONFIG_SCOPE_COMMAND;
627 out->path = NULL;
630 int git_config_parse_parameter(const char *text,
631 config_fn_t fn, void *data)
633 const char *value;
634 struct strbuf **pair;
635 int ret;
636 struct key_value_info kvi = KVI_INIT;
638 kvi_from_param(&kvi);
640 pair = strbuf_split_str(text, '=', 2);
641 if (!pair[0])
642 return error(_("bogus config parameter: %s"), text);
644 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
645 strbuf_setlen(pair[0], pair[0]->len - 1);
646 value = pair[1] ? pair[1]->buf : "";
647 } else {
648 value = NULL;
651 strbuf_trim(pair[0]);
652 if (!pair[0]->len) {
653 strbuf_list_free(pair);
654 return error(_("bogus config parameter: %s"), text);
657 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
658 strbuf_list_free(pair);
659 return ret;
662 static int parse_config_env_list(char *env, struct key_value_info *kvi,
663 config_fn_t fn, void *data)
665 char *cur = env;
666 while (cur && *cur) {
667 const char *key = sq_dequote_step(cur, &cur);
668 if (!key)
669 return error(_("bogus format in %s"),
670 CONFIG_DATA_ENVIRONMENT);
672 if (!cur || isspace(*cur)) {
673 /* old-style 'key=value' */
674 if (git_config_parse_parameter(key, fn, data) < 0)
675 return -1;
677 else if (*cur == '=') {
678 /* new-style 'key'='value' */
679 const char *value;
681 cur++;
682 if (*cur == '\'') {
683 /* quoted value */
684 value = sq_dequote_step(cur, &cur);
685 if (!value || (cur && !isspace(*cur))) {
686 return error(_("bogus format in %s"),
687 CONFIG_DATA_ENVIRONMENT);
689 } else if (!*cur || isspace(*cur)) {
690 /* implicit bool: 'key'= */
691 value = NULL;
692 } else {
693 return error(_("bogus format in %s"),
694 CONFIG_DATA_ENVIRONMENT);
697 if (config_parse_pair(key, value, kvi, fn, data) < 0)
698 return -1;
700 else {
701 /* unknown format */
702 return error(_("bogus format in %s"),
703 CONFIG_DATA_ENVIRONMENT);
706 if (cur) {
707 while (isspace(*cur))
708 cur++;
711 return 0;
714 int git_config_from_parameters(config_fn_t fn, void *data)
716 const char *env;
717 struct strbuf envvar = STRBUF_INIT;
718 struct strvec to_free = STRVEC_INIT;
719 int ret = 0;
720 char *envw = NULL;
721 struct key_value_info kvi = KVI_INIT;
723 kvi_from_param(&kvi);
724 env = getenv(CONFIG_COUNT_ENVIRONMENT);
725 if (env) {
726 unsigned long count;
727 char *endp;
728 int i;
730 count = strtoul(env, &endp, 10);
731 if (*endp) {
732 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
733 goto out;
735 if (count > INT_MAX) {
736 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
737 goto out;
740 for (i = 0; i < count; i++) {
741 const char *key, *value;
743 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
744 key = getenv_safe(&to_free, envvar.buf);
745 if (!key) {
746 ret = error(_("missing config key %s"), envvar.buf);
747 goto out;
749 strbuf_reset(&envvar);
751 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
752 value = getenv_safe(&to_free, envvar.buf);
753 if (!value) {
754 ret = error(_("missing config value %s"), envvar.buf);
755 goto out;
757 strbuf_reset(&envvar);
759 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
760 ret = -1;
761 goto out;
766 env = getenv(CONFIG_DATA_ENVIRONMENT);
767 if (env) {
768 /* sq_dequote will write over it */
769 envw = xstrdup(env);
770 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
771 ret = -1;
772 goto out;
776 out:
777 strbuf_release(&envvar);
778 strvec_clear(&to_free);
779 free(envw);
780 return ret;
783 static int get_next_char(struct config_source *cs)
785 int c = cs->do_fgetc(cs);
787 if (c == '\r') {
788 /* DOS like systems */
789 c = cs->do_fgetc(cs);
790 if (c != '\n') {
791 if (c != EOF)
792 cs->do_ungetc(c, cs);
793 c = '\r';
797 if (c != EOF && ++cs->total_len > INT_MAX) {
799 * This is an absurdly long config file; refuse to parse
800 * further in order to protect downstream code from integer
801 * overflows. Note that we can't return an error specifically,
802 * but we can mark EOF and put trash in the return value,
803 * which will trigger a parse error.
805 cs->eof = 1;
806 return 0;
809 if (c == '\n')
810 cs->linenr++;
811 if (c == EOF) {
812 cs->eof = 1;
813 cs->linenr++;
814 c = '\n';
816 return c;
819 static char *parse_value(struct config_source *cs)
821 int quote = 0, comment = 0;
822 size_t trim_len = 0;
824 strbuf_reset(&cs->value);
825 for (;;) {
826 int c = get_next_char(cs);
827 if (c == '\n') {
828 if (quote) {
829 cs->linenr--;
830 return NULL;
832 if (trim_len)
833 strbuf_setlen(&cs->value, trim_len);
834 return cs->value.buf;
836 if (comment)
837 continue;
838 if (isspace(c) && !quote) {
839 if (!trim_len)
840 trim_len = cs->value.len;
841 if (cs->value.len)
842 strbuf_addch(&cs->value, c);
843 continue;
845 if (!quote) {
846 if (c == ';' || c == '#') {
847 comment = 1;
848 continue;
851 if (trim_len)
852 trim_len = 0;
853 if (c == '\\') {
854 c = get_next_char(cs);
855 switch (c) {
856 case '\n':
857 continue;
858 case 't':
859 c = '\t';
860 break;
861 case 'b':
862 c = '\b';
863 break;
864 case 'n':
865 c = '\n';
866 break;
867 /* Some characters escape as themselves */
868 case '\\': case '"':
869 break;
870 /* Reject unknown escape sequences */
871 default:
872 return NULL;
874 strbuf_addch(&cs->value, c);
875 continue;
877 if (c == '"') {
878 quote = 1 - quote;
879 continue;
881 strbuf_addch(&cs->value, c);
885 static int get_value(struct config_source *cs, struct key_value_info *kvi,
886 config_fn_t fn, void *data, struct strbuf *name)
888 int c;
889 char *value;
890 int ret;
891 struct config_context ctx = {
892 .kvi = kvi,
895 /* Get the full name */
896 for (;;) {
897 c = get_next_char(cs);
898 if (cs->eof)
899 break;
900 if (!iskeychar(c))
901 break;
902 strbuf_addch(name, tolower(c));
905 while (c == ' ' || c == '\t')
906 c = get_next_char(cs);
908 value = NULL;
909 if (c != '\n') {
910 if (c != '=')
911 return -1;
912 value = parse_value(cs);
913 if (!value)
914 return -1;
917 * We already consumed the \n, but we need linenr to point to
918 * the line we just parsed during the call to fn to get
919 * accurate line number in error messages.
921 cs->linenr--;
922 kvi->linenr = cs->linenr;
923 ret = fn(name->buf, value, &ctx, data);
924 if (ret >= 0)
925 cs->linenr++;
926 return ret;
929 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
930 int c)
932 cs->subsection_case_sensitive = 0;
933 do {
934 if (c == '\n')
935 goto error_incomplete_line;
936 c = get_next_char(cs);
937 } while (isspace(c));
939 /* We require the format to be '[base "extension"]' */
940 if (c != '"')
941 return -1;
942 strbuf_addch(name, '.');
944 for (;;) {
945 int c = get_next_char(cs);
946 if (c == '\n')
947 goto error_incomplete_line;
948 if (c == '"')
949 break;
950 if (c == '\\') {
951 c = get_next_char(cs);
952 if (c == '\n')
953 goto error_incomplete_line;
955 strbuf_addch(name, c);
958 /* Final ']' */
959 if (get_next_char(cs) != ']')
960 return -1;
961 return 0;
962 error_incomplete_line:
963 cs->linenr--;
964 return -1;
967 static int get_base_var(struct config_source *cs, struct strbuf *name)
969 cs->subsection_case_sensitive = 1;
970 for (;;) {
971 int c = get_next_char(cs);
972 if (cs->eof)
973 return -1;
974 if (c == ']')
975 return 0;
976 if (isspace(c))
977 return get_extended_base_var(cs, name, c);
978 if (!iskeychar(c) && c != '.')
979 return -1;
980 strbuf_addch(name, tolower(c));
984 struct parse_event_data {
985 enum config_event_t previous_type;
986 size_t previous_offset;
987 const struct config_options *opts;
990 static int do_event(struct config_source *cs, enum config_event_t type,
991 struct parse_event_data *data)
993 size_t offset;
995 if (!data->opts || !data->opts->event_fn)
996 return 0;
998 if (type == CONFIG_EVENT_WHITESPACE &&
999 data->previous_type == type)
1000 return 0;
1002 offset = cs->do_ftell(cs);
1004 * At EOF, the parser always "inserts" an extra '\n', therefore
1005 * the end offset of the event is the current file position, otherwise
1006 * we will already have advanced to the next event.
1008 if (type != CONFIG_EVENT_EOF)
1009 offset--;
1011 if (data->previous_type != CONFIG_EVENT_EOF &&
1012 data->opts->event_fn(data->previous_type, data->previous_offset,
1013 offset, cs, data->opts->event_fn_data) < 0)
1014 return -1;
1016 data->previous_type = type;
1017 data->previous_offset = offset;
1019 return 0;
1022 static void kvi_from_source(struct config_source *cs,
1023 enum config_scope scope,
1024 struct key_value_info *out)
1026 out->filename = strintern(cs->name);
1027 out->origin_type = cs->origin_type;
1028 out->linenr = cs->linenr;
1029 out->scope = scope;
1030 out->path = cs->path;
1033 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1034 struct key_value_info *kvi, void *data,
1035 const struct config_options *opts)
1037 int comment = 0;
1038 size_t baselen = 0;
1039 struct strbuf *var = &cs->var;
1040 int error_return = 0;
1041 char *error_msg = NULL;
1043 /* U+FEFF Byte Order Mark in UTF8 */
1044 const char *bomptr = utf8_bom;
1046 /* For the parser event callback */
1047 struct parse_event_data event_data = {
1048 CONFIG_EVENT_EOF, 0, opts
1051 for (;;) {
1052 int c;
1054 c = get_next_char(cs);
1055 if (bomptr && *bomptr) {
1056 /* We are at the file beginning; skip UTF8-encoded BOM
1057 * if present. Sane editors won't put this in on their
1058 * own, but e.g. Windows Notepad will do it happily. */
1059 if (c == (*bomptr & 0377)) {
1060 bomptr++;
1061 continue;
1062 } else {
1063 /* Do not tolerate partial BOM. */
1064 if (bomptr != utf8_bom)
1065 break;
1066 /* No BOM at file beginning. Cool. */
1067 bomptr = NULL;
1070 if (c == '\n') {
1071 if (cs->eof) {
1072 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1073 return -1;
1074 return 0;
1076 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1077 return -1;
1078 comment = 0;
1079 continue;
1081 if (comment)
1082 continue;
1083 if (isspace(c)) {
1084 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1085 return -1;
1086 continue;
1088 if (c == '#' || c == ';') {
1089 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1090 return -1;
1091 comment = 1;
1092 continue;
1094 if (c == '[') {
1095 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1096 return -1;
1098 /* Reset prior to determining a new stem */
1099 strbuf_reset(var);
1100 if (get_base_var(cs, var) < 0 || var->len < 1)
1101 break;
1102 strbuf_addch(var, '.');
1103 baselen = var->len;
1104 continue;
1106 if (!isalpha(c))
1107 break;
1109 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1110 return -1;
1113 * Truncate the var name back to the section header
1114 * stem prior to grabbing the suffix part of the name
1115 * and the value.
1117 strbuf_setlen(var, baselen);
1118 strbuf_addch(var, tolower(c));
1119 if (get_value(cs, kvi, fn, data, var) < 0)
1120 break;
1123 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1124 return -1;
1126 switch (cs->origin_type) {
1127 case CONFIG_ORIGIN_BLOB:
1128 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1129 cs->linenr, cs->name);
1130 break;
1131 case CONFIG_ORIGIN_FILE:
1132 error_msg = xstrfmt(_("bad config line %d in file %s"),
1133 cs->linenr, cs->name);
1134 break;
1135 case CONFIG_ORIGIN_STDIN:
1136 error_msg = xstrfmt(_("bad config line %d in standard input"),
1137 cs->linenr);
1138 break;
1139 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1140 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1141 cs->linenr, cs->name);
1142 break;
1143 case CONFIG_ORIGIN_CMDLINE:
1144 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1145 cs->linenr, cs->name);
1146 break;
1147 default:
1148 error_msg = xstrfmt(_("bad config line %d in %s"),
1149 cs->linenr, cs->name);
1152 switch (opts && opts->error_action ?
1153 opts->error_action :
1154 cs->default_error_action) {
1155 case CONFIG_ERROR_DIE:
1156 die("%s", error_msg);
1157 break;
1158 case CONFIG_ERROR_ERROR:
1159 error_return = error("%s", error_msg);
1160 break;
1161 case CONFIG_ERROR_SILENT:
1162 error_return = -1;
1163 break;
1164 case CONFIG_ERROR_UNSET:
1165 BUG("config error action unset");
1168 free(error_msg);
1169 return error_return;
1172 NORETURN
1173 static void die_bad_number(const char *name, const char *value,
1174 const struct key_value_info *kvi)
1176 const char *error_type = (errno == ERANGE) ?
1177 N_("out of range") : N_("invalid unit");
1178 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1180 if (!kvi)
1181 BUG("kvi should not be NULL");
1183 if (!value)
1184 value = "";
1186 if (!kvi->filename)
1187 die(_(bad_numeric), value, name, _(error_type));
1189 switch (kvi->origin_type) {
1190 case CONFIG_ORIGIN_BLOB:
1191 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1192 value, name, kvi->filename, _(error_type));
1193 case CONFIG_ORIGIN_FILE:
1194 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1195 value, name, kvi->filename, _(error_type));
1196 case CONFIG_ORIGIN_STDIN:
1197 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1198 value, name, _(error_type));
1199 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1200 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1201 value, name, kvi->filename, _(error_type));
1202 case CONFIG_ORIGIN_CMDLINE:
1203 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1204 value, name, kvi->filename, _(error_type));
1205 default:
1206 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1207 value, name, kvi->filename, _(error_type));
1211 int git_config_int(const char *name, const char *value,
1212 const struct key_value_info *kvi)
1214 int ret;
1215 if (!git_parse_int(value, &ret))
1216 die_bad_number(name, value, kvi);
1217 return ret;
1220 int64_t git_config_int64(const char *name, const char *value,
1221 const struct key_value_info *kvi)
1223 int64_t ret;
1224 if (!git_parse_int64(value, &ret))
1225 die_bad_number(name, value, kvi);
1226 return ret;
1229 unsigned long git_config_ulong(const char *name, const char *value,
1230 const struct key_value_info *kvi)
1232 unsigned long ret;
1233 if (!git_parse_ulong(value, &ret))
1234 die_bad_number(name, value, kvi);
1235 return ret;
1238 ssize_t git_config_ssize_t(const char *name, const char *value,
1239 const struct key_value_info *kvi)
1241 ssize_t ret;
1242 if (!git_parse_ssize_t(value, &ret))
1243 die_bad_number(name, value, kvi);
1244 return ret;
1247 static const struct fsync_component_name {
1248 const char *name;
1249 enum fsync_component component_bits;
1250 } fsync_component_names[] = {
1251 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1252 { "pack", FSYNC_COMPONENT_PACK },
1253 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1254 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1255 { "index", FSYNC_COMPONENT_INDEX },
1256 { "objects", FSYNC_COMPONENTS_OBJECTS },
1257 { "reference", FSYNC_COMPONENT_REFERENCE },
1258 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1259 { "committed", FSYNC_COMPONENTS_COMMITTED },
1260 { "added", FSYNC_COMPONENTS_ADDED },
1261 { "all", FSYNC_COMPONENTS_ALL },
1264 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1266 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1267 enum fsync_component positive = 0, negative = 0;
1269 while (string) {
1270 int i;
1271 size_t len;
1272 const char *ep;
1273 int negated = 0;
1274 int found = 0;
1276 string = string + strspn(string, ", \t\n\r");
1277 ep = strchrnul(string, ',');
1278 len = ep - string;
1279 if (!strcmp(string, "none")) {
1280 current = FSYNC_COMPONENT_NONE;
1281 goto next_name;
1284 if (*string == '-') {
1285 negated = 1;
1286 string++;
1287 len--;
1288 if (!len)
1289 warning(_("invalid value for variable %s"), var);
1292 if (!len)
1293 break;
1295 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1296 const struct fsync_component_name *n = &fsync_component_names[i];
1298 if (strncmp(n->name, string, len))
1299 continue;
1301 found = 1;
1302 if (negated)
1303 negative |= n->component_bits;
1304 else
1305 positive |= n->component_bits;
1308 if (!found) {
1309 char *component = xstrndup(string, len);
1310 warning(_("ignoring unknown core.fsync component '%s'"), component);
1311 free(component);
1314 next_name:
1315 string = ep;
1318 return (current & ~negative) | positive;
1321 int git_config_bool_or_int(const char *name, const char *value,
1322 const struct key_value_info *kvi, int *is_bool)
1324 int v = git_parse_maybe_bool_text(value);
1325 if (0 <= v) {
1326 *is_bool = 1;
1327 return v;
1329 *is_bool = 0;
1330 return git_config_int(name, value, kvi);
1333 int git_config_bool(const char *name, const char *value)
1335 int v = git_parse_maybe_bool(value);
1336 if (v < 0)
1337 die(_("bad boolean config value '%s' for '%s'"), value, name);
1338 return v;
1341 int git_config_string(const char **dest, const char *var, const char *value)
1343 if (!value)
1344 return config_error_nonbool(var);
1345 *dest = xstrdup(value);
1346 return 0;
1349 int git_config_pathname(const char **dest, const char *var, const char *value)
1351 if (!value)
1352 return config_error_nonbool(var);
1353 *dest = interpolate_path(value, 0);
1354 if (!*dest)
1355 die(_("failed to expand user dir in: '%s'"), value);
1356 return 0;
1359 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1361 if (!value)
1362 return config_error_nonbool(var);
1363 if (parse_expiry_date(value, timestamp))
1364 return error(_("'%s' for '%s' is not a valid timestamp"),
1365 value, var);
1366 return 0;
1369 int git_config_color(char *dest, const char *var, const char *value)
1371 if (!value)
1372 return config_error_nonbool(var);
1373 if (color_parse(value, dest) < 0)
1374 return -1;
1375 return 0;
1378 static int git_default_core_config(const char *var, const char *value,
1379 const struct config_context *ctx, void *cb)
1381 /* This needs a better name */
1382 if (!strcmp(var, "core.filemode")) {
1383 trust_executable_bit = git_config_bool(var, value);
1384 return 0;
1386 if (!strcmp(var, "core.trustctime")) {
1387 trust_ctime = git_config_bool(var, value);
1388 return 0;
1390 if (!strcmp(var, "core.checkstat")) {
1391 if (!value)
1392 return config_error_nonbool(var);
1393 if (!strcasecmp(value, "default"))
1394 check_stat = 1;
1395 else if (!strcasecmp(value, "minimal"))
1396 check_stat = 0;
1397 else
1398 return error(_("invalid value for '%s': '%s'"),
1399 var, value);
1402 if (!strcmp(var, "core.quotepath")) {
1403 quote_path_fully = git_config_bool(var, value);
1404 return 0;
1407 if (!strcmp(var, "core.symlinks")) {
1408 has_symlinks = git_config_bool(var, value);
1409 return 0;
1412 if (!strcmp(var, "core.ignorecase")) {
1413 ignore_case = git_config_bool(var, value);
1414 return 0;
1417 if (!strcmp(var, "core.attributesfile"))
1418 return git_config_pathname(&git_attributes_file, var, value);
1420 if (!strcmp(var, "core.hookspath")) {
1421 if (ctx->kvi && ctx->kvi->scope == CONFIG_SCOPE_LOCAL &&
1422 git_env_bool("GIT_CLONE_PROTECTION_ACTIVE", 0))
1423 die(_("active `core.hooksPath` found in the local "
1424 "repository config:\n\t%s\nFor security "
1425 "reasons, this is disallowed by default.\nIf "
1426 "this is intentional and the hook should "
1427 "actually be run, please\nrun the command "
1428 "again with "
1429 "`GIT_CLONE_PROTECTION_ACTIVE=false`"),
1430 value);
1431 return git_config_pathname(&git_hooks_path, var, value);
1434 if (!strcmp(var, "core.bare")) {
1435 is_bare_repository_cfg = git_config_bool(var, value);
1436 return 0;
1439 if (!strcmp(var, "core.ignorestat")) {
1440 assume_unchanged = git_config_bool(var, value);
1441 return 0;
1444 if (!strcmp(var, "core.prefersymlinkrefs")) {
1445 prefer_symlink_refs = git_config_bool(var, value);
1446 return 0;
1449 if (!strcmp(var, "core.logallrefupdates")) {
1450 if (value && !strcasecmp(value, "always"))
1451 log_all_ref_updates = LOG_REFS_ALWAYS;
1452 else if (git_config_bool(var, value))
1453 log_all_ref_updates = LOG_REFS_NORMAL;
1454 else
1455 log_all_ref_updates = LOG_REFS_NONE;
1456 return 0;
1459 if (!strcmp(var, "core.warnambiguousrefs")) {
1460 warn_ambiguous_refs = git_config_bool(var, value);
1461 return 0;
1464 if (!strcmp(var, "core.abbrev")) {
1465 if (!value)
1466 return config_error_nonbool(var);
1467 if (!strcasecmp(value, "auto"))
1468 default_abbrev = -1;
1469 else if (!git_parse_maybe_bool_text(value))
1470 default_abbrev = the_hash_algo->hexsz;
1471 else {
1472 int abbrev = git_config_int(var, value, ctx->kvi);
1473 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1474 return error(_("abbrev length out of range: %d"), abbrev);
1475 default_abbrev = abbrev;
1477 return 0;
1480 if (!strcmp(var, "core.disambiguate"))
1481 return set_disambiguate_hint_config(var, value);
1483 if (!strcmp(var, "core.loosecompression")) {
1484 int level = git_config_int(var, value, ctx->kvi);
1485 if (level == -1)
1486 level = Z_DEFAULT_COMPRESSION;
1487 else if (level < 0 || level > Z_BEST_COMPRESSION)
1488 die(_("bad zlib compression level %d"), level);
1489 zlib_compression_level = level;
1490 zlib_compression_seen = 1;
1491 return 0;
1494 if (!strcmp(var, "core.compression")) {
1495 int level = git_config_int(var, value, ctx->kvi);
1496 if (level == -1)
1497 level = Z_DEFAULT_COMPRESSION;
1498 else if (level < 0 || level > Z_BEST_COMPRESSION)
1499 die(_("bad zlib compression level %d"), level);
1500 if (!zlib_compression_seen)
1501 zlib_compression_level = level;
1502 if (!pack_compression_seen)
1503 pack_compression_level = level;
1504 return 0;
1507 if (!strcmp(var, "core.packedgitwindowsize")) {
1508 int pgsz_x2 = getpagesize() * 2;
1509 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1511 /* This value must be multiple of (pagesize * 2) */
1512 packed_git_window_size /= pgsz_x2;
1513 if (packed_git_window_size < 1)
1514 packed_git_window_size = 1;
1515 packed_git_window_size *= pgsz_x2;
1516 return 0;
1519 if (!strcmp(var, "core.bigfilethreshold")) {
1520 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1521 return 0;
1524 if (!strcmp(var, "core.packedgitlimit")) {
1525 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1526 return 0;
1529 if (!strcmp(var, "core.deltabasecachelimit")) {
1530 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1531 return 0;
1534 if (!strcmp(var, "core.autocrlf")) {
1535 if (value && !strcasecmp(value, "input")) {
1536 auto_crlf = AUTO_CRLF_INPUT;
1537 return 0;
1539 auto_crlf = git_config_bool(var, value);
1540 return 0;
1543 if (!strcmp(var, "core.safecrlf")) {
1544 int eol_rndtrp_die;
1545 if (value && !strcasecmp(value, "warn")) {
1546 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1547 return 0;
1549 eol_rndtrp_die = git_config_bool(var, value);
1550 global_conv_flags_eol = eol_rndtrp_die ?
1551 CONV_EOL_RNDTRP_DIE : 0;
1552 return 0;
1555 if (!strcmp(var, "core.eol")) {
1556 if (value && !strcasecmp(value, "lf"))
1557 core_eol = EOL_LF;
1558 else if (value && !strcasecmp(value, "crlf"))
1559 core_eol = EOL_CRLF;
1560 else if (value && !strcasecmp(value, "native"))
1561 core_eol = EOL_NATIVE;
1562 else
1563 core_eol = EOL_UNSET;
1564 return 0;
1567 if (!strcmp(var, "core.checkroundtripencoding"))
1568 return git_config_string(&check_roundtrip_encoding, var, value);
1570 if (!strcmp(var, "core.notesref")) {
1571 if (!value)
1572 return config_error_nonbool(var);
1573 notes_ref_name = xstrdup(value);
1574 return 0;
1577 if (!strcmp(var, "core.editor"))
1578 return git_config_string(&editor_program, var, value);
1580 if (!strcmp(var, "core.commentchar") ||
1581 !strcmp(var, "core.commentstring")) {
1582 if (!value)
1583 return config_error_nonbool(var);
1584 else if (!strcasecmp(value, "auto"))
1585 auto_comment_line_char = 1;
1586 else if (value[0]) {
1587 if (strchr(value, '\n'))
1588 return error(_("%s cannot contain newline"), var);
1589 comment_line_str = xstrdup(value);
1590 auto_comment_line_char = 0;
1591 } else
1592 return error(_("%s must have at least one character"), var);
1593 return 0;
1596 if (!strcmp(var, "core.askpass"))
1597 return git_config_string(&askpass_program, var, value);
1599 if (!strcmp(var, "core.excludesfile")) {
1600 free((char *)excludes_file);
1601 return git_config_pathname(&excludes_file, var, value);
1604 if (!strcmp(var, "core.whitespace")) {
1605 if (!value)
1606 return config_error_nonbool(var);
1607 whitespace_rule_cfg = parse_whitespace_rule(value);
1608 return 0;
1611 if (!strcmp(var, "core.fsync")) {
1612 if (!value)
1613 return config_error_nonbool(var);
1614 fsync_components = parse_fsync_components(var, value);
1615 return 0;
1618 if (!strcmp(var, "core.fsyncmethod")) {
1619 if (!value)
1620 return config_error_nonbool(var);
1621 if (!strcmp(value, "fsync"))
1622 fsync_method = FSYNC_METHOD_FSYNC;
1623 else if (!strcmp(value, "writeout-only"))
1624 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1625 else if (!strcmp(value, "batch"))
1626 fsync_method = FSYNC_METHOD_BATCH;
1627 else
1628 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1632 if (!strcmp(var, "core.fsyncobjectfiles")) {
1633 if (fsync_object_files < 0)
1634 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1635 fsync_object_files = git_config_bool(var, value);
1636 return 0;
1639 if (!strcmp(var, "core.preloadindex")) {
1640 core_preload_index = git_config_bool(var, value);
1641 return 0;
1644 if (!strcmp(var, "core.createobject")) {
1645 if (!value)
1646 return config_error_nonbool(var);
1647 if (!strcmp(value, "rename"))
1648 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1649 else if (!strcmp(value, "link"))
1650 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1651 else
1652 die(_("invalid mode for object creation: %s"), value);
1653 return 0;
1656 if (!strcmp(var, "core.sparsecheckout")) {
1657 core_apply_sparse_checkout = git_config_bool(var, value);
1658 return 0;
1661 if (!strcmp(var, "core.sparsecheckoutcone")) {
1662 core_sparse_checkout_cone = git_config_bool(var, value);
1663 return 0;
1666 if (!strcmp(var, "core.precomposeunicode")) {
1667 precomposed_unicode = git_config_bool(var, value);
1668 return 0;
1671 if (!strcmp(var, "core.protecthfs")) {
1672 protect_hfs = git_config_bool(var, value);
1673 return 0;
1676 if (!strcmp(var, "core.protectntfs")) {
1677 protect_ntfs = git_config_bool(var, value);
1678 return 0;
1681 if (!strcmp(var, "core.maxtreedepth")) {
1682 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1683 return 0;
1686 /* Add other config variables here and to Documentation/config.txt. */
1687 return platform_core_config(var, value, ctx, cb);
1690 static int git_default_sparse_config(const char *var, const char *value)
1692 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1693 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1694 return 0;
1697 /* Add other config variables here and to Documentation/config/sparse.txt. */
1698 return 0;
1701 static int git_default_i18n_config(const char *var, const char *value)
1703 if (!strcmp(var, "i18n.commitencoding"))
1704 return git_config_string(&git_commit_encoding, var, value);
1706 if (!strcmp(var, "i18n.logoutputencoding"))
1707 return git_config_string(&git_log_output_encoding, var, value);
1709 /* Add other config variables here and to Documentation/config.txt. */
1710 return 0;
1713 static int git_default_branch_config(const char *var, const char *value)
1715 if (!strcmp(var, "branch.autosetupmerge")) {
1716 if (value && !strcmp(value, "always")) {
1717 git_branch_track = BRANCH_TRACK_ALWAYS;
1718 return 0;
1719 } else if (value && !strcmp(value, "inherit")) {
1720 git_branch_track = BRANCH_TRACK_INHERIT;
1721 return 0;
1722 } else if (value && !strcmp(value, "simple")) {
1723 git_branch_track = BRANCH_TRACK_SIMPLE;
1724 return 0;
1726 git_branch_track = git_config_bool(var, value);
1727 return 0;
1729 if (!strcmp(var, "branch.autosetuprebase")) {
1730 if (!value)
1731 return config_error_nonbool(var);
1732 else if (!strcmp(value, "never"))
1733 autorebase = AUTOREBASE_NEVER;
1734 else if (!strcmp(value, "local"))
1735 autorebase = AUTOREBASE_LOCAL;
1736 else if (!strcmp(value, "remote"))
1737 autorebase = AUTOREBASE_REMOTE;
1738 else if (!strcmp(value, "always"))
1739 autorebase = AUTOREBASE_ALWAYS;
1740 else
1741 return error(_("malformed value for %s"), var);
1742 return 0;
1745 /* Add other config variables here and to Documentation/config.txt. */
1746 return 0;
1749 static int git_default_push_config(const char *var, const char *value)
1751 if (!strcmp(var, "push.default")) {
1752 if (!value)
1753 return config_error_nonbool(var);
1754 else if (!strcmp(value, "nothing"))
1755 push_default = PUSH_DEFAULT_NOTHING;
1756 else if (!strcmp(value, "matching"))
1757 push_default = PUSH_DEFAULT_MATCHING;
1758 else if (!strcmp(value, "simple"))
1759 push_default = PUSH_DEFAULT_SIMPLE;
1760 else if (!strcmp(value, "upstream"))
1761 push_default = PUSH_DEFAULT_UPSTREAM;
1762 else if (!strcmp(value, "tracking")) /* deprecated */
1763 push_default = PUSH_DEFAULT_UPSTREAM;
1764 else if (!strcmp(value, "current"))
1765 push_default = PUSH_DEFAULT_CURRENT;
1766 else {
1767 error(_("malformed value for %s: %s"), var, value);
1768 return error(_("must be one of nothing, matching, simple, "
1769 "upstream or current"));
1771 return 0;
1774 /* Add other config variables here and to Documentation/config.txt. */
1775 return 0;
1778 static int git_default_mailmap_config(const char *var, const char *value)
1780 if (!strcmp(var, "mailmap.file"))
1781 return git_config_pathname(&git_mailmap_file, var, value);
1782 if (!strcmp(var, "mailmap.blob"))
1783 return git_config_string(&git_mailmap_blob, var, value);
1785 /* Add other config variables here and to Documentation/config.txt. */
1786 return 0;
1789 static int git_default_attr_config(const char *var, const char *value)
1791 if (!strcmp(var, "attr.tree"))
1792 return git_config_string(&git_attr_tree, var, value);
1795 * Add other attribute related config variables here and to
1796 * Documentation/config/attr.txt.
1798 return 0;
1801 int git_default_config(const char *var, const char *value,
1802 const struct config_context *ctx, void *cb)
1804 if (starts_with(var, "core."))
1805 return git_default_core_config(var, value, ctx, cb);
1807 if (starts_with(var, "user.") ||
1808 starts_with(var, "author.") ||
1809 starts_with(var, "committer."))
1810 return git_ident_config(var, value, ctx, cb);
1812 if (starts_with(var, "i18n."))
1813 return git_default_i18n_config(var, value);
1815 if (starts_with(var, "branch."))
1816 return git_default_branch_config(var, value);
1818 if (starts_with(var, "push."))
1819 return git_default_push_config(var, value);
1821 if (starts_with(var, "mailmap."))
1822 return git_default_mailmap_config(var, value);
1824 if (starts_with(var, "attr."))
1825 return git_default_attr_config(var, value);
1827 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1828 return git_default_advice_config(var, value);
1830 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1831 pager_use_color = git_config_bool(var,value);
1832 return 0;
1835 if (!strcmp(var, "pack.packsizelimit")) {
1836 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1837 return 0;
1840 if (!strcmp(var, "pack.compression")) {
1841 int level = git_config_int(var, value, ctx->kvi);
1842 if (level == -1)
1843 level = Z_DEFAULT_COMPRESSION;
1844 else if (level < 0 || level > Z_BEST_COMPRESSION)
1845 die(_("bad pack compression level %d"), level);
1846 pack_compression_level = level;
1847 pack_compression_seen = 1;
1848 return 0;
1851 if (starts_with(var, "sparse."))
1852 return git_default_sparse_config(var, value);
1854 /* Add other config variables here and to Documentation/config.txt. */
1855 return 0;
1859 * All source specific fields in the union, die_on_error, name and the callbacks
1860 * fgetc, ungetc, ftell of top need to be initialized before calling
1861 * this function.
1863 static int do_config_from(struct config_source *top, config_fn_t fn,
1864 void *data, enum config_scope scope,
1865 const struct config_options *opts)
1867 struct key_value_info kvi = KVI_INIT;
1868 int ret;
1870 /* push config-file parsing state stack */
1871 top->linenr = 1;
1872 top->eof = 0;
1873 top->total_len = 0;
1874 strbuf_init(&top->value, 1024);
1875 strbuf_init(&top->var, 1024);
1876 kvi_from_source(top, scope, &kvi);
1878 ret = git_parse_source(top, fn, &kvi, data, opts);
1880 strbuf_release(&top->value);
1881 strbuf_release(&top->var);
1883 return ret;
1886 static int do_config_from_file(config_fn_t fn,
1887 const enum config_origin_type origin_type,
1888 const char *name, const char *path, FILE *f,
1889 void *data, enum config_scope scope,
1890 const struct config_options *opts)
1892 struct config_source top = CONFIG_SOURCE_INIT;
1893 int ret;
1895 top.u.file = f;
1896 top.origin_type = origin_type;
1897 top.name = name;
1898 top.path = path;
1899 top.default_error_action = CONFIG_ERROR_DIE;
1900 top.do_fgetc = config_file_fgetc;
1901 top.do_ungetc = config_file_ungetc;
1902 top.do_ftell = config_file_ftell;
1904 flockfile(f);
1905 ret = do_config_from(&top, fn, data, scope, opts);
1906 funlockfile(f);
1907 return ret;
1910 static int git_config_from_stdin(config_fn_t fn, void *data,
1911 enum config_scope scope)
1913 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1914 data, scope, NULL);
1917 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1918 void *data, enum config_scope scope,
1919 const struct config_options *opts)
1921 int ret = -1;
1922 FILE *f;
1924 if (!filename)
1925 BUG("filename cannot be NULL");
1926 f = fopen_or_warn(filename, "r");
1927 if (f) {
1928 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1929 filename, f, data, scope, opts);
1930 fclose(f);
1932 return ret;
1935 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1937 return git_config_from_file_with_options(fn, filename, data,
1938 CONFIG_SCOPE_UNKNOWN, NULL);
1941 int git_config_from_mem(config_fn_t fn,
1942 const enum config_origin_type origin_type,
1943 const char *name, const char *buf, size_t len,
1944 void *data, enum config_scope scope,
1945 const struct config_options *opts)
1947 struct config_source top = CONFIG_SOURCE_INIT;
1949 top.u.buf.buf = buf;
1950 top.u.buf.len = len;
1951 top.u.buf.pos = 0;
1952 top.origin_type = origin_type;
1953 top.name = name;
1954 top.path = NULL;
1955 top.default_error_action = CONFIG_ERROR_ERROR;
1956 top.do_fgetc = config_buf_fgetc;
1957 top.do_ungetc = config_buf_ungetc;
1958 top.do_ftell = config_buf_ftell;
1960 return do_config_from(&top, fn, data, scope, opts);
1963 int git_config_from_blob_oid(config_fn_t fn,
1964 const char *name,
1965 struct repository *repo,
1966 const struct object_id *oid,
1967 void *data,
1968 enum config_scope scope)
1970 enum object_type type;
1971 char *buf;
1972 unsigned long size;
1973 int ret;
1975 buf = repo_read_object_file(repo, oid, &type, &size);
1976 if (!buf)
1977 return error(_("unable to load config blob object '%s'"), name);
1978 if (type != OBJ_BLOB) {
1979 free(buf);
1980 return error(_("reference '%s' does not point to a blob"), name);
1983 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1984 data, scope, NULL);
1985 free(buf);
1987 return ret;
1990 static int git_config_from_blob_ref(config_fn_t fn,
1991 struct repository *repo,
1992 const char *name,
1993 void *data,
1994 enum config_scope scope)
1996 struct object_id oid;
1998 if (repo_get_oid(repo, name, &oid) < 0)
1999 return error(_("unable to resolve config blob '%s'"), name);
2000 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
2003 char *git_system_config(void)
2005 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2006 if (!system_config)
2007 system_config = system_path(ETC_GITCONFIG);
2008 normalize_path_copy(system_config, system_config);
2009 return system_config;
2012 char *git_global_config(void)
2014 char *user_config, *xdg_config;
2016 git_global_config_paths(&user_config, &xdg_config);
2017 if (!user_config) {
2018 free(xdg_config);
2019 return NULL;
2022 if (access_or_warn(user_config, R_OK, 0) && xdg_config &&
2023 !access_or_warn(xdg_config, R_OK, 0)) {
2024 free(user_config);
2025 return xdg_config;
2026 } else {
2027 free(xdg_config);
2028 return user_config;
2032 void git_global_config_paths(char **user_out, char **xdg_out)
2034 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2035 char *xdg_config = NULL;
2037 if (!user_config) {
2038 user_config = interpolate_path("~/.gitconfig", 0);
2039 xdg_config = xdg_config_home("config");
2042 *user_out = user_config;
2043 *xdg_out = xdg_config;
2046 int git_config_system(void)
2048 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2051 static int do_git_config_sequence(const struct config_options *opts,
2052 const struct repository *repo,
2053 config_fn_t fn, void *data)
2055 int ret = 0;
2056 char *system_config = git_system_config();
2057 char *xdg_config = NULL;
2058 char *user_config = NULL;
2059 char *repo_config;
2060 char *worktree_config;
2063 * Ensure that either:
2064 * - the git_dir and commondir are both set, or
2065 * - the git_dir and commondir are both NULL
2067 if (!opts->git_dir != !opts->commondir)
2068 BUG("only one of commondir and git_dir is non-NULL");
2070 if (opts->commondir) {
2071 repo_config = mkpathdup("%s/config", opts->commondir);
2072 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2073 } else {
2074 repo_config = NULL;
2075 worktree_config = NULL;
2078 if (git_config_system() && system_config &&
2079 !access_or_die(system_config, R_OK,
2080 opts->system_gently ? ACCESS_EACCES_OK : 0))
2081 ret += git_config_from_file_with_options(fn, system_config,
2082 data, CONFIG_SCOPE_SYSTEM,
2083 NULL);
2085 git_global_config_paths(&user_config, &xdg_config);
2087 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2088 ret += git_config_from_file_with_options(fn, xdg_config, data,
2089 CONFIG_SCOPE_GLOBAL, NULL);
2091 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2092 ret += git_config_from_file_with_options(fn, user_config, data,
2093 CONFIG_SCOPE_GLOBAL, NULL);
2095 if (!opts->ignore_repo && repo_config &&
2096 !access_or_die(repo_config, R_OK, 0))
2097 ret += git_config_from_file_with_options(fn, repo_config, data,
2098 CONFIG_SCOPE_LOCAL, NULL);
2100 if (!opts->ignore_worktree && worktree_config &&
2101 repo && repo->repository_format_worktree_config &&
2102 !access_or_die(worktree_config, R_OK, 0)) {
2103 ret += git_config_from_file_with_options(fn, worktree_config, data,
2104 CONFIG_SCOPE_WORKTREE,
2105 NULL);
2108 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2109 die(_("unable to parse command-line config"));
2111 free(system_config);
2112 free(xdg_config);
2113 free(user_config);
2114 free(repo_config);
2115 free(worktree_config);
2116 return ret;
2119 int config_with_options(config_fn_t fn, void *data,
2120 struct git_config_source *config_source,
2121 struct repository *repo,
2122 const struct config_options *opts)
2124 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2125 int ret;
2127 if (opts->respect_includes) {
2128 inc.fn = fn;
2129 inc.data = data;
2130 inc.opts = opts;
2131 inc.repo = repo;
2132 inc.config_source = config_source;
2133 fn = git_config_include;
2134 data = &inc;
2138 * If we have a specific filename, use it. Otherwise, follow the
2139 * regular lookup sequence.
2141 if (config_source && config_source->use_stdin) {
2142 ret = git_config_from_stdin(fn, data, config_source->scope);
2143 } else if (config_source && config_source->file) {
2144 ret = git_config_from_file_with_options(fn, config_source->file,
2145 data, config_source->scope,
2146 NULL);
2147 } else if (config_source && config_source->blob) {
2148 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2149 data, config_source->scope);
2150 } else {
2151 ret = do_git_config_sequence(opts, repo, fn, data);
2154 if (inc.remote_urls) {
2155 string_list_clear(inc.remote_urls, 0);
2156 FREE_AND_NULL(inc.remote_urls);
2158 return ret;
2161 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2163 int i, value_index;
2164 struct string_list *values;
2165 struct config_set_element *entry;
2166 struct configset_list *list = &set->list;
2167 struct config_context ctx = CONFIG_CONTEXT_INIT;
2169 for (i = 0; i < list->nr; i++) {
2170 entry = list->items[i].e;
2171 value_index = list->items[i].value_index;
2172 values = &entry->value_list;
2174 ctx.kvi = values->items[value_index].util;
2175 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2176 git_die_config_linenr(entry->key,
2177 ctx.kvi->filename,
2178 ctx.kvi->linenr);
2182 void read_early_config(config_fn_t cb, void *data)
2184 struct config_options opts = {0};
2185 struct strbuf commondir = STRBUF_INIT;
2186 struct strbuf gitdir = STRBUF_INIT;
2188 opts.respect_includes = 1;
2190 if (have_git_dir()) {
2191 opts.commondir = get_git_common_dir();
2192 opts.git_dir = get_git_dir();
2194 * When setup_git_directory() was not yet asked to discover the
2195 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2196 * is any repository config we should use (but unlike
2197 * setup_git_directory_gently(), no global state is changed, most
2198 * notably, the current working directory is still the same after the
2199 * call).
2201 } else if (!discover_git_directory(&commondir, &gitdir)) {
2202 opts.commondir = commondir.buf;
2203 opts.git_dir = gitdir.buf;
2206 config_with_options(cb, data, NULL, NULL, &opts);
2208 strbuf_release(&commondir);
2209 strbuf_release(&gitdir);
2213 * Read config but only enumerate system and global settings.
2214 * Omit any repo-local, worktree-local, or command-line settings.
2216 void read_very_early_config(config_fn_t cb, void *data)
2218 struct config_options opts = { 0 };
2220 opts.respect_includes = 1;
2221 opts.ignore_repo = 1;
2222 opts.ignore_worktree = 1;
2223 opts.ignore_cmdline = 1;
2224 opts.system_gently = 1;
2226 config_with_options(cb, data, NULL, NULL, &opts);
2229 RESULT_MUST_BE_USED
2230 static int configset_find_element(struct config_set *set, const char *key,
2231 struct config_set_element **dest)
2233 struct config_set_element k;
2234 struct config_set_element *found_entry;
2235 char *normalized_key;
2236 int ret;
2239 * `key` may come from the user, so normalize it before using it
2240 * for querying entries from the hashmap.
2242 ret = git_config_parse_key(key, &normalized_key, NULL);
2243 if (ret)
2244 return ret;
2246 hashmap_entry_init(&k.ent, strhash(normalized_key));
2247 k.key = normalized_key;
2248 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2249 free(normalized_key);
2250 *dest = found_entry;
2251 return 0;
2254 static int configset_add_value(const struct key_value_info *kvi_p,
2255 struct config_set *set, const char *key,
2256 const char *value)
2258 struct config_set_element *e;
2259 struct string_list_item *si;
2260 struct configset_list_item *l_item;
2261 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2262 int ret;
2264 ret = configset_find_element(set, key, &e);
2265 if (ret)
2266 return ret;
2268 * Since the keys are being fed by git_config*() callback mechanism, they
2269 * are already normalized. So simply add them without any further munging.
2271 if (!e) {
2272 e = xmalloc(sizeof(*e));
2273 hashmap_entry_init(&e->ent, strhash(key));
2274 e->key = xstrdup(key);
2275 string_list_init_dup(&e->value_list);
2276 hashmap_add(&set->config_hash, &e->ent);
2278 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2280 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2281 l_item = &set->list.items[set->list.nr++];
2282 l_item->e = e;
2283 l_item->value_index = e->value_list.nr - 1;
2285 *kv_info = *kvi_p;
2286 si->util = kv_info;
2288 return 0;
2291 static int config_set_element_cmp(const void *cmp_data UNUSED,
2292 const struct hashmap_entry *eptr,
2293 const struct hashmap_entry *entry_or_key,
2294 const void *keydata UNUSED)
2296 const struct config_set_element *e1, *e2;
2298 e1 = container_of(eptr, const struct config_set_element, ent);
2299 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2301 return strcmp(e1->key, e2->key);
2304 void git_configset_init(struct config_set *set)
2306 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2307 set->hash_initialized = 1;
2308 set->list.nr = 0;
2309 set->list.alloc = 0;
2310 set->list.items = NULL;
2313 void git_configset_clear(struct config_set *set)
2315 struct config_set_element *entry;
2316 struct hashmap_iter iter;
2317 if (!set->hash_initialized)
2318 return;
2320 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2321 ent /* member name */) {
2322 free(entry->key);
2323 string_list_clear(&entry->value_list, 1);
2325 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2326 set->hash_initialized = 0;
2327 free(set->list.items);
2328 set->list.nr = 0;
2329 set->list.alloc = 0;
2330 set->list.items = NULL;
2333 static int config_set_callback(const char *key, const char *value,
2334 const struct config_context *ctx,
2335 void *cb)
2337 struct config_set *set = cb;
2338 configset_add_value(ctx->kvi, set, key, value);
2339 return 0;
2342 int git_configset_add_file(struct config_set *set, const char *filename)
2344 return git_config_from_file(config_set_callback, filename, set);
2347 int git_configset_get_value(struct config_set *set, const char *key,
2348 const char **value, struct key_value_info *kvi)
2350 const struct string_list *values = NULL;
2351 int ret;
2352 struct string_list_item item;
2354 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2355 * queried key in the files of the configset, the value returned will be the last
2356 * value in the value list for that key.
2358 if ((ret = git_configset_get_value_multi(set, key, &values)))
2359 return ret;
2361 assert(values->nr > 0);
2362 item = values->items[values->nr - 1];
2363 *value = item.string;
2364 if (kvi)
2365 *kvi = *((struct key_value_info *)item.util);
2366 return 0;
2369 int git_configset_get_value_multi(struct config_set *set, const char *key,
2370 const struct string_list **dest)
2372 struct config_set_element *e;
2373 int ret;
2375 if ((ret = configset_find_element(set, key, &e)))
2376 return ret;
2377 else if (!e)
2378 return 1;
2379 *dest = &e->value_list;
2381 return 0;
2384 static int check_multi_string(struct string_list_item *item, void *util)
2386 return item->string ? 0 : config_error_nonbool(util);
2389 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2390 const struct string_list **dest)
2392 int ret;
2394 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2395 return ret;
2396 if ((ret = for_each_string_list((struct string_list *)*dest,
2397 check_multi_string, (void *)key)))
2398 return ret;
2400 return 0;
2403 int git_configset_get(struct config_set *set, const char *key)
2405 struct config_set_element *e;
2406 int ret;
2408 if ((ret = configset_find_element(set, key, &e)))
2409 return ret;
2410 else if (!e)
2411 return 1;
2412 return 0;
2415 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2417 const char *value;
2418 if (!git_configset_get_value(set, key, &value, NULL))
2419 return git_config_string((const char **)dest, key, value);
2420 else
2421 return 1;
2424 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2425 const char **dest)
2427 const char *value;
2428 if (!git_configset_get_value(set, key, &value, NULL)) {
2429 if (!value)
2430 return config_error_nonbool(key);
2431 *dest = value;
2432 return 0;
2433 } else {
2434 return 1;
2438 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2440 const char *value;
2441 struct key_value_info kvi;
2443 if (!git_configset_get_value(set, key, &value, &kvi)) {
2444 *dest = git_config_int(key, value, &kvi);
2445 return 0;
2446 } else
2447 return 1;
2450 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2452 const char *value;
2453 struct key_value_info kvi;
2455 if (!git_configset_get_value(set, key, &value, &kvi)) {
2456 *dest = git_config_ulong(key, value, &kvi);
2457 return 0;
2458 } else
2459 return 1;
2462 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2464 const char *value;
2465 if (!git_configset_get_value(set, key, &value, NULL)) {
2466 *dest = git_config_bool(key, value);
2467 return 0;
2468 } else
2469 return 1;
2472 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2473 int *is_bool, int *dest)
2475 const char *value;
2476 struct key_value_info kvi;
2478 if (!git_configset_get_value(set, key, &value, &kvi)) {
2479 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2480 return 0;
2481 } else
2482 return 1;
2485 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2487 const char *value;
2488 if (!git_configset_get_value(set, key, &value, NULL)) {
2489 *dest = git_parse_maybe_bool(value);
2490 if (*dest == -1)
2491 return -1;
2492 return 0;
2493 } else
2494 return 1;
2497 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2499 const char *value;
2500 if (!git_configset_get_value(set, key, &value, NULL))
2501 return git_config_pathname(dest, key, value);
2502 else
2503 return 1;
2506 /* Functions use to read configuration from a repository */
2507 static void repo_read_config(struct repository *repo)
2509 struct config_options opts = { 0 };
2511 opts.respect_includes = 1;
2512 opts.commondir = repo->commondir;
2513 opts.git_dir = repo->gitdir;
2515 if (!repo->config)
2516 CALLOC_ARRAY(repo->config, 1);
2517 else
2518 git_configset_clear(repo->config);
2520 git_configset_init(repo->config);
2521 if (config_with_options(config_set_callback, repo->config, NULL,
2522 repo, &opts) < 0)
2524 * config_with_options() normally returns only
2525 * zero, as most errors are fatal, and
2526 * non-fatal potential errors are guarded by "if"
2527 * statements that are entered only when no error is
2528 * possible.
2530 * If we ever encounter a non-fatal error, it means
2531 * something went really wrong and we should stop
2532 * immediately.
2534 die(_("unknown error occurred while reading the configuration files"));
2537 static void git_config_check_init(struct repository *repo)
2539 if (repo->config && repo->config->hash_initialized)
2540 return;
2541 repo_read_config(repo);
2544 static void repo_config_clear(struct repository *repo)
2546 if (!repo->config || !repo->config->hash_initialized)
2547 return;
2548 git_configset_clear(repo->config);
2551 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2553 git_config_check_init(repo);
2554 configset_iter(repo->config, fn, data);
2557 int repo_config_get(struct repository *repo, const char *key)
2559 git_config_check_init(repo);
2560 return git_configset_get(repo->config, key);
2563 int repo_config_get_value(struct repository *repo,
2564 const char *key, const char **value)
2566 git_config_check_init(repo);
2567 return git_configset_get_value(repo->config, key, value, NULL);
2570 int repo_config_get_value_multi(struct repository *repo, const char *key,
2571 const struct string_list **dest)
2573 git_config_check_init(repo);
2574 return git_configset_get_value_multi(repo->config, key, dest);
2577 int repo_config_get_string_multi(struct repository *repo, const char *key,
2578 const struct string_list **dest)
2580 git_config_check_init(repo);
2581 return git_configset_get_string_multi(repo->config, key, dest);
2584 int repo_config_get_string(struct repository *repo,
2585 const char *key, char **dest)
2587 int ret;
2588 git_config_check_init(repo);
2589 ret = git_configset_get_string(repo->config, key, dest);
2590 if (ret < 0)
2591 git_die_config(key, NULL);
2592 return ret;
2595 int repo_config_get_string_tmp(struct repository *repo,
2596 const char *key, const char **dest)
2598 int ret;
2599 git_config_check_init(repo);
2600 ret = git_configset_get_string_tmp(repo->config, key, dest);
2601 if (ret < 0)
2602 git_die_config(key, NULL);
2603 return ret;
2606 int repo_config_get_int(struct repository *repo,
2607 const char *key, int *dest)
2609 git_config_check_init(repo);
2610 return git_configset_get_int(repo->config, key, dest);
2613 int repo_config_get_ulong(struct repository *repo,
2614 const char *key, unsigned long *dest)
2616 git_config_check_init(repo);
2617 return git_configset_get_ulong(repo->config, key, dest);
2620 int repo_config_get_bool(struct repository *repo,
2621 const char *key, int *dest)
2623 git_config_check_init(repo);
2624 return git_configset_get_bool(repo->config, key, dest);
2627 int repo_config_get_bool_or_int(struct repository *repo,
2628 const char *key, int *is_bool, int *dest)
2630 git_config_check_init(repo);
2631 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2634 int repo_config_get_maybe_bool(struct repository *repo,
2635 const char *key, int *dest)
2637 git_config_check_init(repo);
2638 return git_configset_get_maybe_bool(repo->config, key, dest);
2641 int repo_config_get_pathname(struct repository *repo,
2642 const char *key, const char **dest)
2644 int ret;
2645 git_config_check_init(repo);
2646 ret = git_configset_get_pathname(repo->config, key, dest);
2647 if (ret < 0)
2648 git_die_config(key, NULL);
2649 return ret;
2652 /* Read values into protected_config. */
2653 static void read_protected_config(void)
2655 struct config_options opts = {
2656 .respect_includes = 1,
2657 .ignore_repo = 1,
2658 .ignore_worktree = 1,
2659 .system_gently = 1,
2662 git_configset_init(&protected_config);
2663 config_with_options(config_set_callback, &protected_config, NULL,
2664 NULL, &opts);
2667 void git_protected_config(config_fn_t fn, void *data)
2669 if (!protected_config.hash_initialized)
2670 read_protected_config();
2671 configset_iter(&protected_config, fn, data);
2674 /* Functions used historically to read configuration from 'the_repository' */
2675 void git_config(config_fn_t fn, void *data)
2677 repo_config(the_repository, fn, data);
2680 void git_config_clear(void)
2682 repo_config_clear(the_repository);
2685 int git_config_get(const char *key)
2687 return repo_config_get(the_repository, key);
2690 int git_config_get_value(const char *key, const char **value)
2692 return repo_config_get_value(the_repository, key, value);
2695 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2697 return repo_config_get_value_multi(the_repository, key, dest);
2700 int git_config_get_string_multi(const char *key,
2701 const struct string_list **dest)
2703 return repo_config_get_string_multi(the_repository, key, dest);
2706 int git_config_get_string(const char *key, char **dest)
2708 return repo_config_get_string(the_repository, key, dest);
2711 int git_config_get_string_tmp(const char *key, const char **dest)
2713 return repo_config_get_string_tmp(the_repository, key, dest);
2716 int git_config_get_int(const char *key, int *dest)
2718 return repo_config_get_int(the_repository, key, dest);
2721 int git_config_get_ulong(const char *key, unsigned long *dest)
2723 return repo_config_get_ulong(the_repository, key, dest);
2726 int git_config_get_bool(const char *key, int *dest)
2728 return repo_config_get_bool(the_repository, key, dest);
2731 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2733 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2736 int git_config_get_maybe_bool(const char *key, int *dest)
2738 return repo_config_get_maybe_bool(the_repository, key, dest);
2741 int git_config_get_pathname(const char *key, const char **dest)
2743 return repo_config_get_pathname(the_repository, key, dest);
2746 int git_config_get_expiry(const char *key, const char **output)
2748 int ret = git_config_get_string(key, (char **)output);
2749 if (ret)
2750 return ret;
2751 if (strcmp(*output, "now")) {
2752 timestamp_t now = approxidate("now");
2753 if (approxidate(*output) >= now)
2754 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2756 return ret;
2759 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2761 const char *expiry_string;
2762 intmax_t days;
2763 timestamp_t when;
2765 if (git_config_get_string_tmp(key, &expiry_string))
2766 return 1; /* no such thing */
2768 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2769 const int scale = 86400;
2770 *expiry = now - days * scale;
2771 return 0;
2774 if (!parse_expiry_date(expiry_string, &when)) {
2775 *expiry = when;
2776 return 0;
2778 return -1; /* thing exists but cannot be parsed */
2781 int git_config_get_split_index(void)
2783 int val;
2785 if (!git_config_get_maybe_bool("core.splitindex", &val))
2786 return val;
2788 return -1; /* default value */
2791 int git_config_get_max_percent_split_change(void)
2793 int val = -1;
2795 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2796 if (0 <= val && val <= 100)
2797 return val;
2799 return error(_("splitIndex.maxPercentChange value '%d' "
2800 "should be between 0 and 100"), val);
2803 return -1; /* default value */
2806 int git_config_get_index_threads(int *dest)
2808 int is_bool, val;
2810 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2811 if (val) {
2812 *dest = val;
2813 return 0;
2816 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2817 if (is_bool)
2818 *dest = val ? 0 : 1;
2819 else
2820 *dest = val;
2821 return 0;
2824 return 1;
2827 NORETURN
2828 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2830 if (!filename)
2831 die(_("unable to parse '%s' from command-line config"), key);
2832 else
2833 die(_("bad config variable '%s' in file '%s' at line %d"),
2834 key, filename, linenr);
2837 NORETURN __attribute__((format(printf, 2, 3)))
2838 void git_die_config(const char *key, const char *err, ...)
2840 const struct string_list *values;
2841 struct key_value_info *kv_info;
2842 report_fn error_fn = get_error_routine();
2844 if (err) {
2845 va_list params;
2846 va_start(params, err);
2847 error_fn(err, params);
2848 va_end(params);
2850 if (git_config_get_value_multi(key, &values))
2851 BUG("for key '%s' we must have a value to report on", key);
2852 kv_info = values->items[values->nr - 1].util;
2853 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2857 * Find all the stuff for git_config_set() below.
2860 struct config_store_data {
2861 size_t baselen;
2862 char *key;
2863 int do_not_match;
2864 const char *fixed_value;
2865 regex_t *value_pattern;
2866 int multi_replace;
2867 struct {
2868 size_t begin, end;
2869 enum config_event_t type;
2870 int is_keys_section;
2871 } *parsed;
2872 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2873 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2875 #define CONFIG_STORE_INIT { 0 }
2877 static void config_store_data_clear(struct config_store_data *store)
2879 free(store->key);
2880 if (store->value_pattern != NULL &&
2881 store->value_pattern != CONFIG_REGEX_NONE) {
2882 regfree(store->value_pattern);
2883 free(store->value_pattern);
2885 free(store->parsed);
2886 free(store->seen);
2887 memset(store, 0, sizeof(*store));
2890 static int matches(const char *key, const char *value,
2891 const struct config_store_data *store)
2893 if (strcmp(key, store->key))
2894 return 0; /* not ours */
2895 if (store->fixed_value)
2896 return !strcmp(store->fixed_value, value);
2897 if (!store->value_pattern)
2898 return 1; /* always matches */
2899 if (store->value_pattern == CONFIG_REGEX_NONE)
2900 return 0; /* never matches */
2902 return store->do_not_match ^
2903 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2906 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2907 struct config_source *cs, void *data)
2909 struct config_store_data *store = data;
2911 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2912 store->parsed[store->parsed_nr].begin = begin;
2913 store->parsed[store->parsed_nr].end = end;
2914 store->parsed[store->parsed_nr].type = type;
2916 if (type == CONFIG_EVENT_SECTION) {
2917 int (*cmpfn)(const char *, const char *, size_t);
2919 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2920 return error(_("invalid section name '%s'"), cs->var.buf);
2922 if (cs->subsection_case_sensitive)
2923 cmpfn = strncasecmp;
2924 else
2925 cmpfn = strncmp;
2927 /* Is this the section we were looking for? */
2928 store->is_keys_section =
2929 store->parsed[store->parsed_nr].is_keys_section =
2930 cs->var.len - 1 == store->baselen &&
2931 !cmpfn(cs->var.buf, store->key, store->baselen);
2932 if (store->is_keys_section) {
2933 store->section_seen = 1;
2934 ALLOC_GROW(store->seen, store->seen_nr + 1,
2935 store->seen_alloc);
2936 store->seen[store->seen_nr] = store->parsed_nr;
2940 store->parsed_nr++;
2942 return 0;
2945 static int store_aux(const char *key, const char *value,
2946 const struct config_context *ctx UNUSED, void *cb)
2948 struct config_store_data *store = cb;
2950 if (store->key_seen) {
2951 if (matches(key, value, store)) {
2952 if (store->seen_nr == 1 && store->multi_replace == 0) {
2953 warning(_("%s has multiple values"), key);
2956 ALLOC_GROW(store->seen, store->seen_nr + 1,
2957 store->seen_alloc);
2959 store->seen[store->seen_nr] = store->parsed_nr;
2960 store->seen_nr++;
2962 } else if (store->is_keys_section) {
2964 * Do not increment matches yet: this may not be a match, but we
2965 * are in the desired section.
2967 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2968 store->seen[store->seen_nr] = store->parsed_nr;
2969 store->section_seen = 1;
2971 if (matches(key, value, store)) {
2972 store->seen_nr++;
2973 store->key_seen = 1;
2977 return 0;
2980 static int write_error(const char *filename)
2982 error(_("failed to write new configuration file %s"), filename);
2984 /* Same error code as "failed to rename". */
2985 return 4;
2988 static struct strbuf store_create_section(const char *key,
2989 const struct config_store_data *store)
2991 const char *dot;
2992 size_t i;
2993 struct strbuf sb = STRBUF_INIT;
2995 dot = memchr(key, '.', store->baselen);
2996 if (dot) {
2997 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2998 for (i = dot - key + 1; i < store->baselen; i++) {
2999 if (key[i] == '"' || key[i] == '\\')
3000 strbuf_addch(&sb, '\\');
3001 strbuf_addch(&sb, key[i]);
3003 strbuf_addstr(&sb, "\"]\n");
3004 } else {
3005 strbuf_addch(&sb, '[');
3006 strbuf_add(&sb, key, store->baselen);
3007 strbuf_addstr(&sb, "]\n");
3010 return sb;
3013 static ssize_t write_section(int fd, const char *key,
3014 const struct config_store_data *store)
3016 struct strbuf sb = store_create_section(key, store);
3017 ssize_t ret;
3019 ret = write_in_full(fd, sb.buf, sb.len);
3020 strbuf_release(&sb);
3022 return ret;
3025 static ssize_t write_pair(int fd, const char *key, const char *value,
3026 const char *comment,
3027 const struct config_store_data *store)
3029 int i;
3030 ssize_t ret;
3031 const char *quote = "";
3032 struct strbuf sb = STRBUF_INIT;
3035 * Check to see if the value needs to be surrounded with a dq pair.
3036 * Note that problematic characters are always backslash-quoted; this
3037 * check is about not losing leading or trailing SP and strings that
3038 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3039 * configuration parser.
3041 if (value[0] == ' ')
3042 quote = "\"";
3043 for (i = 0; value[i]; i++)
3044 if (value[i] == ';' || value[i] == '#')
3045 quote = "\"";
3046 if (i && value[i - 1] == ' ')
3047 quote = "\"";
3049 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3051 for (i = 0; value[i]; i++)
3052 switch (value[i]) {
3053 case '\n':
3054 strbuf_addstr(&sb, "\\n");
3055 break;
3056 case '\t':
3057 strbuf_addstr(&sb, "\\t");
3058 break;
3059 case '"':
3060 case '\\':
3061 strbuf_addch(&sb, '\\');
3062 /* fallthrough */
3063 default:
3064 strbuf_addch(&sb, value[i]);
3065 break;
3068 if (comment)
3069 strbuf_addf(&sb, "%s%s\n", quote, comment);
3070 else
3071 strbuf_addf(&sb, "%s\n", quote);
3073 ret = write_in_full(fd, sb.buf, sb.len);
3074 strbuf_release(&sb);
3076 return ret;
3080 * If we are about to unset the last key(s) in a section, and if there are
3081 * no comments surrounding (or included in) the section, we will want to
3082 * extend begin/end to remove the entire section.
3084 * Note: the parameter `seen_ptr` points to the index into the store.seen
3085 * array. * This index may be incremented if a section has more than one
3086 * entry (which all are to be removed).
3088 static void maybe_remove_section(struct config_store_data *store,
3089 size_t *begin_offset, size_t *end_offset,
3090 int *seen_ptr)
3092 size_t begin;
3093 int i, seen, section_seen = 0;
3096 * First, ensure that this is the first key, and that there are no
3097 * comments before the entry nor before the section header.
3099 seen = *seen_ptr;
3100 for (i = store->seen[seen]; i > 0; i--) {
3101 enum config_event_t type = store->parsed[i - 1].type;
3103 if (type == CONFIG_EVENT_COMMENT)
3104 /* There is a comment before this entry or section */
3105 return;
3106 if (type == CONFIG_EVENT_ENTRY) {
3107 if (!section_seen)
3108 /* This is not the section's first entry. */
3109 return;
3110 /* We encountered no comment before the section. */
3111 break;
3113 if (type == CONFIG_EVENT_SECTION) {
3114 if (!store->parsed[i - 1].is_keys_section)
3115 break;
3116 section_seen = 1;
3119 begin = store->parsed[i].begin;
3122 * Next, make sure that we are removing the last key(s) in the section,
3123 * and that there are no comments that are possibly about the current
3124 * section.
3126 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3127 enum config_event_t type = store->parsed[i].type;
3129 if (type == CONFIG_EVENT_COMMENT)
3130 return;
3131 if (type == CONFIG_EVENT_SECTION) {
3132 if (store->parsed[i].is_keys_section)
3133 continue;
3134 break;
3136 if (type == CONFIG_EVENT_ENTRY) {
3137 if (++seen < store->seen_nr &&
3138 i == store->seen[seen])
3139 /* We want to remove this entry, too */
3140 continue;
3141 /* There is another entry in this section. */
3142 return;
3147 * We are really removing the last entry/entries from this section, and
3148 * there are no enclosed or surrounding comments. Remove the entire,
3149 * now-empty section.
3151 *seen_ptr = seen;
3152 *begin_offset = begin;
3153 if (i < store->parsed_nr)
3154 *end_offset = store->parsed[i].begin;
3155 else
3156 *end_offset = store->parsed[store->parsed_nr - 1].end;
3159 int git_config_set_in_file_gently(const char *config_filename,
3160 const char *key, const char *comment, const char *value)
3162 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, comment, 0);
3165 void git_config_set_in_file(const char *config_filename,
3166 const char *key, const char *value)
3168 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3171 int git_config_set_gently(const char *key, const char *value)
3173 return git_config_set_multivar_gently(key, value, NULL, 0);
3176 int repo_config_set_worktree_gently(struct repository *r,
3177 const char *key, const char *value)
3179 /* Only use worktree-specific config if it is already enabled. */
3180 if (r->repository_format_worktree_config) {
3181 char *file = repo_git_path(r, "config.worktree");
3182 int ret = git_config_set_multivar_in_file_gently(
3183 file, key, value, NULL, NULL, 0);
3184 free(file);
3185 return ret;
3187 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3190 void git_config_set(const char *key, const char *value)
3192 git_config_set_multivar(key, value, NULL, 0);
3194 trace2_cmd_set_config(key, value);
3197 char *git_config_prepare_comment_string(const char *comment)
3199 size_t leading_blanks;
3200 char *prepared;
3202 if (!comment)
3203 return NULL;
3205 if (strchr(comment, '\n'))
3206 die(_("no multi-line comment allowed: '%s'"), comment);
3209 * If it begins with one or more leading whitespace characters
3210 * followed by '#", the comment string is used as-is.
3212 * If it begins with '#', a SP is inserted between the comment
3213 * and the value the comment is about.
3215 * Otherwise, the value is followed by a SP followed by '#'
3216 * followed by SP and then the comment string comes.
3219 leading_blanks = strspn(comment, " \t");
3220 if (leading_blanks && comment[leading_blanks] == '#')
3221 prepared = xstrdup(comment); /* use it as-is */
3222 else if (comment[0] == '#')
3223 prepared = xstrfmt(" %s", comment);
3224 else
3225 prepared = xstrfmt(" # %s", comment);
3227 return prepared;
3230 static void validate_comment_string(const char *comment)
3232 size_t leading_blanks;
3234 if (!comment)
3235 return;
3237 * The front-end must have massaged the comment string
3238 * properly before calling us.
3240 if (strchr(comment, '\n'))
3241 BUG("multi-line comments are not permitted: '%s'", comment);
3243 leading_blanks = strspn(comment, " \t");
3244 if (!leading_blanks || comment[leading_blanks] != '#')
3245 BUG("comment must begin with one or more SP followed by '#': '%s'",
3246 comment);
3250 * If value==NULL, unset in (remove from) config,
3251 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3252 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3253 * (only add a new one)
3254 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3255 * key/values are removed before a single new pair is written. If the
3256 * flag is not present, then replace only the first match.
3258 * Returns 0 on success.
3260 * This function does this:
3262 * - it locks the config file by creating ".git/config.lock"
3264 * - it then parses the config using store_aux() as validator to find
3265 * the position on the key/value pair to replace. If it is to be unset,
3266 * it must be found exactly once.
3268 * - the config file is mmap()ed and the part before the match (if any) is
3269 * written to the lock file, then the changed part and the rest.
3271 * - the config file is removed and the lock file rename()d to it.
3274 int git_config_set_multivar_in_file_gently(const char *config_filename,
3275 const char *key, const char *value,
3276 const char *value_pattern,
3277 const char *comment,
3278 unsigned flags)
3280 int fd = -1, in_fd = -1;
3281 int ret;
3282 struct lock_file lock = LOCK_INIT;
3283 char *filename_buf = NULL;
3284 char *contents = NULL;
3285 size_t contents_sz;
3286 struct config_store_data store = CONFIG_STORE_INIT;
3288 validate_comment_string(comment);
3290 /* parse-key returns negative; flip the sign to feed exit(3) */
3291 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3292 if (ret)
3293 goto out_free;
3295 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3297 if (!config_filename)
3298 config_filename = filename_buf = git_pathdup("config");
3301 * The lock serves a purpose in addition to locking: the new
3302 * contents of .git/config will be written into it.
3304 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3305 if (fd < 0) {
3306 error_errno(_("could not lock config file %s"), config_filename);
3307 ret = CONFIG_NO_LOCK;
3308 goto out_free;
3312 * If .git/config does not exist yet, write a minimal version.
3314 in_fd = open(config_filename, O_RDONLY);
3315 if ( in_fd < 0 ) {
3316 if ( ENOENT != errno ) {
3317 error_errno(_("opening %s"), config_filename);
3318 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3319 goto out_free;
3321 /* if nothing to unset, error out */
3322 if (!value) {
3323 ret = CONFIG_NOTHING_SET;
3324 goto out_free;
3327 free(store.key);
3328 store.key = xstrdup(key);
3329 if (write_section(fd, key, &store) < 0 ||
3330 write_pair(fd, key, value, comment, &store) < 0)
3331 goto write_err_out;
3332 } else {
3333 struct stat st;
3334 size_t copy_begin, copy_end;
3335 int i, new_line = 0;
3336 struct config_options opts;
3338 if (!value_pattern)
3339 store.value_pattern = NULL;
3340 else if (value_pattern == CONFIG_REGEX_NONE)
3341 store.value_pattern = CONFIG_REGEX_NONE;
3342 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3343 store.fixed_value = value_pattern;
3344 else {
3345 if (value_pattern[0] == '!') {
3346 store.do_not_match = 1;
3347 value_pattern++;
3348 } else
3349 store.do_not_match = 0;
3351 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3352 if (regcomp(store.value_pattern, value_pattern,
3353 REG_EXTENDED)) {
3354 error(_("invalid pattern: %s"), value_pattern);
3355 FREE_AND_NULL(store.value_pattern);
3356 ret = CONFIG_INVALID_PATTERN;
3357 goto out_free;
3361 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3362 store.parsed[0].end = 0;
3364 memset(&opts, 0, sizeof(opts));
3365 opts.event_fn = store_aux_event;
3366 opts.event_fn_data = &store;
3369 * After this, store.parsed will contain offsets of all the
3370 * parsed elements, and store.seen will contain a list of
3371 * matches, as indices into store.parsed.
3373 * As a side effect, we make sure to transform only a valid
3374 * existing config file.
3376 if (git_config_from_file_with_options(store_aux,
3377 config_filename,
3378 &store, CONFIG_SCOPE_UNKNOWN,
3379 &opts)) {
3380 error(_("invalid config file %s"), config_filename);
3381 ret = CONFIG_INVALID_FILE;
3382 goto out_free;
3385 /* if nothing to unset, or too many matches, error out */
3386 if ((store.seen_nr == 0 && value == NULL) ||
3387 (store.seen_nr > 1 && !store.multi_replace)) {
3388 ret = CONFIG_NOTHING_SET;
3389 goto out_free;
3392 if (fstat(in_fd, &st) == -1) {
3393 error_errno(_("fstat on %s failed"), config_filename);
3394 ret = CONFIG_INVALID_FILE;
3395 goto out_free;
3398 contents_sz = xsize_t(st.st_size);
3399 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3400 MAP_PRIVATE, in_fd, 0);
3401 if (contents == MAP_FAILED) {
3402 if (errno == ENODEV && S_ISDIR(st.st_mode))
3403 errno = EISDIR;
3404 error_errno(_("unable to mmap '%s'%s"),
3405 config_filename, mmap_os_err());
3406 ret = CONFIG_INVALID_FILE;
3407 contents = NULL;
3408 goto out_free;
3410 close(in_fd);
3411 in_fd = -1;
3413 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3414 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3415 ret = CONFIG_NO_WRITE;
3416 goto out_free;
3419 if (store.seen_nr == 0) {
3420 if (!store.seen_alloc) {
3421 /* Did not see key nor section */
3422 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3423 store.seen[0] = store.parsed_nr
3424 - !!store.parsed_nr;
3426 store.seen_nr = 1;
3429 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3430 size_t replace_end;
3431 int j = store.seen[i];
3433 new_line = 0;
3434 if (!store.key_seen) {
3435 copy_end = store.parsed[j].end;
3436 /* include '\n' when copying section header */
3437 if (copy_end > 0 && copy_end < contents_sz &&
3438 contents[copy_end - 1] != '\n' &&
3439 contents[copy_end] == '\n')
3440 copy_end++;
3441 replace_end = copy_end;
3442 } else {
3443 replace_end = store.parsed[j].end;
3444 copy_end = store.parsed[j].begin;
3445 if (!value)
3446 maybe_remove_section(&store,
3447 &copy_end,
3448 &replace_end, &i);
3450 * Swallow preceding white-space on the same
3451 * line.
3453 while (copy_end > 0 ) {
3454 char c = contents[copy_end - 1];
3456 if (isspace(c) && c != '\n')
3457 copy_end--;
3458 else
3459 break;
3463 if (copy_end > 0 && contents[copy_end-1] != '\n')
3464 new_line = 1;
3466 /* write the first part of the config */
3467 if (copy_end > copy_begin) {
3468 if (write_in_full(fd, contents + copy_begin,
3469 copy_end - copy_begin) < 0)
3470 goto write_err_out;
3471 if (new_line &&
3472 write_str_in_full(fd, "\n") < 0)
3473 goto write_err_out;
3475 copy_begin = replace_end;
3478 /* write the pair (value == NULL means unset) */
3479 if (value) {
3480 if (!store.section_seen) {
3481 if (write_section(fd, key, &store) < 0)
3482 goto write_err_out;
3484 if (write_pair(fd, key, value, comment, &store) < 0)
3485 goto write_err_out;
3488 /* write the rest of the config */
3489 if (copy_begin < contents_sz)
3490 if (write_in_full(fd, contents + copy_begin,
3491 contents_sz - copy_begin) < 0)
3492 goto write_err_out;
3494 munmap(contents, contents_sz);
3495 contents = NULL;
3498 if (commit_lock_file(&lock) < 0) {
3499 error_errno(_("could not write config file %s"), config_filename);
3500 ret = CONFIG_NO_WRITE;
3501 goto out_free;
3504 ret = 0;
3506 /* Invalidate the config cache */
3507 git_config_clear();
3509 out_free:
3510 rollback_lock_file(&lock);
3511 free(filename_buf);
3512 if (contents)
3513 munmap(contents, contents_sz);
3514 if (in_fd >= 0)
3515 close(in_fd);
3516 config_store_data_clear(&store);
3517 return ret;
3519 write_err_out:
3520 ret = write_error(get_lock_file_path(&lock));
3521 goto out_free;
3524 void git_config_set_multivar_in_file(const char *config_filename,
3525 const char *key, const char *value,
3526 const char *value_pattern, unsigned flags)
3528 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3529 value_pattern, NULL, flags))
3530 return;
3531 if (value)
3532 die(_("could not set '%s' to '%s'"), key, value);
3533 else
3534 die(_("could not unset '%s'"), key);
3537 int git_config_set_multivar_gently(const char *key, const char *value,
3538 const char *value_pattern, unsigned flags)
3540 return repo_config_set_multivar_gently(the_repository, key, value,
3541 value_pattern, flags);
3544 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3545 const char *value,
3546 const char *value_pattern, unsigned flags)
3548 char *file = repo_git_path(r, "config");
3549 int res = git_config_set_multivar_in_file_gently(file,
3550 key, value,
3551 value_pattern,
3552 NULL, flags);
3553 free(file);
3554 return res;
3557 void git_config_set_multivar(const char *key, const char *value,
3558 const char *value_pattern, unsigned flags)
3560 git_config_set_multivar_in_file(git_path("config"),
3561 key, value, value_pattern,
3562 flags);
3565 static size_t section_name_match (const char *buf, const char *name)
3567 size_t i = 0, j = 0;
3568 int dot = 0;
3569 if (buf[i] != '[')
3570 return 0;
3571 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3572 if (!dot && isspace(buf[i])) {
3573 dot = 1;
3574 if (name[j++] != '.')
3575 break;
3576 for (i++; isspace(buf[i]); i++)
3577 ; /* do nothing */
3578 if (buf[i] != '"')
3579 break;
3580 continue;
3582 if (buf[i] == '\\' && dot)
3583 i++;
3584 else if (buf[i] == '"' && dot) {
3585 for (i++; isspace(buf[i]); i++)
3586 ; /* do_nothing */
3587 break;
3589 if (buf[i] != name[j++])
3590 break;
3592 if (buf[i] == ']' && name[j] == 0) {
3594 * We match, now just find the right length offset by
3595 * gobbling up any whitespace after it, as well
3597 i++;
3598 for (; buf[i] && isspace(buf[i]); i++)
3599 ; /* do nothing */
3600 return i;
3602 return 0;
3605 static int section_name_is_ok(const char *name)
3607 /* Empty section names are bogus. */
3608 if (!*name)
3609 return 0;
3612 * Before a dot, we must be alphanumeric or dash. After the first dot,
3613 * anything goes, so we can stop checking.
3615 for (; *name && *name != '.'; name++)
3616 if (*name != '-' && !isalnum(*name))
3617 return 0;
3618 return 1;
3621 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3623 /* if new_name == NULL, the section is removed instead */
3624 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3625 const char *old_name,
3626 const char *new_name, int copy)
3628 int ret = 0, remove = 0;
3629 char *filename_buf = NULL;
3630 struct lock_file lock = LOCK_INIT;
3631 int out_fd;
3632 struct strbuf buf = STRBUF_INIT;
3633 FILE *config_file = NULL;
3634 struct stat st;
3635 struct strbuf copystr = STRBUF_INIT;
3636 struct config_store_data store;
3637 uint32_t line_nr = 0;
3639 memset(&store, 0, sizeof(store));
3641 if (new_name && !section_name_is_ok(new_name)) {
3642 ret = error(_("invalid section name: %s"), new_name);
3643 goto out_no_rollback;
3646 if (!config_filename)
3647 config_filename = filename_buf = git_pathdup("config");
3649 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3650 if (out_fd < 0) {
3651 ret = error(_("could not lock config file %s"), config_filename);
3652 goto out;
3655 if (!(config_file = fopen(config_filename, "rb"))) {
3656 ret = warn_on_fopen_errors(config_filename);
3657 if (ret)
3658 goto out;
3659 /* no config file means nothing to rename, no error */
3660 goto commit_and_out;
3663 if (fstat(fileno(config_file), &st) == -1) {
3664 ret = error_errno(_("fstat on %s failed"), config_filename);
3665 goto out;
3668 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3669 ret = error_errno(_("chmod on %s failed"),
3670 get_lock_file_path(&lock));
3671 goto out;
3674 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3675 size_t i, length;
3676 int is_section = 0;
3677 char *output = buf.buf;
3679 line_nr++;
3681 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3682 ret = error(_("refusing to work with overly long line "
3683 "in '%s' on line %"PRIuMAX),
3684 config_filename, (uintmax_t)line_nr);
3685 goto out;
3688 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3689 ; /* do nothing */
3690 if (buf.buf[i] == '[') {
3691 /* it's a section */
3692 size_t offset;
3693 is_section = 1;
3696 * When encountering a new section under -c we
3697 * need to flush out any section we're already
3698 * coping and begin anew. There might be
3699 * multiple [branch "$name"] sections.
3701 if (copystr.len > 0) {
3702 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3703 ret = write_error(get_lock_file_path(&lock));
3704 goto out;
3706 strbuf_reset(&copystr);
3709 offset = section_name_match(&buf.buf[i], old_name);
3710 if (offset > 0) {
3711 ret++;
3712 if (!new_name) {
3713 remove = 1;
3714 continue;
3716 store.baselen = strlen(new_name);
3717 if (!copy) {
3718 if (write_section(out_fd, new_name, &store) < 0) {
3719 ret = write_error(get_lock_file_path(&lock));
3720 goto out;
3723 * We wrote out the new section, with
3724 * a newline, now skip the old
3725 * section's length
3727 output += offset + i;
3728 if (strlen(output) > 0) {
3730 * More content means there's
3731 * a declaration to put on the
3732 * next line; indent with a
3733 * tab
3735 output -= 1;
3736 output[0] = '\t';
3738 } else {
3739 strbuf_release(&copystr);
3740 copystr = store_create_section(new_name, &store);
3743 remove = 0;
3745 if (remove)
3746 continue;
3747 length = strlen(output);
3749 if (!is_section && copystr.len > 0) {
3750 strbuf_add(&copystr, output, length);
3753 if (write_in_full(out_fd, output, length) < 0) {
3754 ret = write_error(get_lock_file_path(&lock));
3755 goto out;
3760 * Copy a trailing section at the end of the config, won't be
3761 * flushed by the usual "flush because we have a new section
3762 * logic in the loop above.
3764 if (copystr.len > 0) {
3765 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3766 ret = write_error(get_lock_file_path(&lock));
3767 goto out;
3769 strbuf_reset(&copystr);
3772 fclose(config_file);
3773 config_file = NULL;
3774 commit_and_out:
3775 if (commit_lock_file(&lock) < 0)
3776 ret = error_errno(_("could not write config file %s"),
3777 config_filename);
3778 out:
3779 if (config_file)
3780 fclose(config_file);
3781 rollback_lock_file(&lock);
3782 out_no_rollback:
3783 free(filename_buf);
3784 config_store_data_clear(&store);
3785 strbuf_release(&buf);
3786 strbuf_release(&copystr);
3787 return ret;
3790 int git_config_rename_section_in_file(const char *config_filename,
3791 const char *old_name, const char *new_name)
3793 return git_config_copy_or_rename_section_in_file(config_filename,
3794 old_name, new_name, 0);
3797 int git_config_rename_section(const char *old_name, const char *new_name)
3799 return git_config_rename_section_in_file(NULL, old_name, new_name);
3802 int git_config_copy_section_in_file(const char *config_filename,
3803 const char *old_name, const char *new_name)
3805 return git_config_copy_or_rename_section_in_file(config_filename,
3806 old_name, new_name, 1);
3809 int git_config_copy_section(const char *old_name, const char *new_name)
3811 return git_config_copy_section_in_file(NULL, old_name, new_name);
3815 * Call this to report error for your variable that should not
3816 * get a boolean value (i.e. "[my] var" means "true").
3818 #undef config_error_nonbool
3819 int config_error_nonbool(const char *var)
3821 return error(_("missing value for '%s'"), var);
3824 int parse_config_key(const char *var,
3825 const char *section,
3826 const char **subsection, size_t *subsection_len,
3827 const char **key)
3829 const char *dot;
3831 /* Does it start with "section." ? */
3832 if (!skip_prefix(var, section, &var) || *var != '.')
3833 return -1;
3836 * Find the key; we don't know yet if we have a subsection, but we must
3837 * parse backwards from the end, since the subsection may have dots in
3838 * it, too.
3840 dot = strrchr(var, '.');
3841 *key = dot + 1;
3843 /* Did we have a subsection at all? */
3844 if (dot == var) {
3845 if (subsection) {
3846 *subsection = NULL;
3847 *subsection_len = 0;
3850 else {
3851 if (!subsection)
3852 return -1;
3853 *subsection = var + 1;
3854 *subsection_len = dot - *subsection;
3857 return 0;
3860 const char *config_origin_type_name(enum config_origin_type type)
3862 switch (type) {
3863 case CONFIG_ORIGIN_BLOB:
3864 return "blob";
3865 case CONFIG_ORIGIN_FILE:
3866 return "file";
3867 case CONFIG_ORIGIN_STDIN:
3868 return "standard input";
3869 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3870 return "submodule-blob";
3871 case CONFIG_ORIGIN_CMDLINE:
3872 return "command line";
3873 default:
3874 BUG("unknown config origin type");
3878 const char *config_scope_name(enum config_scope scope)
3880 switch (scope) {
3881 case CONFIG_SCOPE_SYSTEM:
3882 return "system";
3883 case CONFIG_SCOPE_GLOBAL:
3884 return "global";
3885 case CONFIG_SCOPE_LOCAL:
3886 return "local";
3887 case CONFIG_SCOPE_WORKTREE:
3888 return "worktree";
3889 case CONFIG_SCOPE_COMMAND:
3890 return "command";
3891 case CONFIG_SCOPE_SUBMODULE:
3892 return "submodule";
3893 default:
3894 return "unknown";
3898 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3900 int i;
3902 for (i = 0; i < nr_mapping; i++) {
3903 const char *name = mapping[i];
3905 if (name && !strcasecmp(var, name))
3906 return i;
3908 return -1;