documentation: remove extraneous words
[git.git] / config.c
blob2ea39295cd6ee8060cab8b4822250bbc020d6d0a
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 "convert.h"
15 #include "environment.h"
16 #include "gettext.h"
17 #include "ident.h"
18 #include "repository.h"
19 #include "lockfile.h"
20 #include "mailmap.h"
21 #include "exec-cmd.h"
22 #include "strbuf.h"
23 #include "quote.h"
24 #include "hashmap.h"
25 #include "string-list.h"
26 #include "object-name.h"
27 #include "object-store-ll.h"
28 #include "pager.h"
29 #include "path.h"
30 #include "utf8.h"
31 #include "dir.h"
32 #include "color.h"
33 #include "replace-object.h"
34 #include "refs.h"
35 #include "setup.h"
36 #include "strvec.h"
37 #include "trace2.h"
38 #include "wildmatch.h"
39 #include "worktree.h"
40 #include "ws.h"
41 #include "write-or-die.h"
43 struct config_source {
44 struct config_source *prev;
45 union {
46 FILE *file;
47 struct config_buf {
48 const char *buf;
49 size_t len;
50 size_t pos;
51 } buf;
52 } u;
53 enum config_origin_type origin_type;
54 const char *name;
55 const char *path;
56 enum config_error_action default_error_action;
57 int linenr;
58 int eof;
59 size_t total_len;
60 struct strbuf value;
61 struct strbuf var;
62 unsigned subsection_case_sensitive : 1;
64 int (*do_fgetc)(struct config_source *c);
65 int (*do_ungetc)(int c, struct config_source *conf);
66 long (*do_ftell)(struct config_source *c);
68 #define CONFIG_SOURCE_INIT { 0 }
70 static int pack_compression_seen;
71 static int zlib_compression_seen;
74 * Config that comes from trusted scopes, namely:
75 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
76 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
77 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
79 * This is declared here for code cleanliness, but unlike the other
80 * static variables, this does not hold config parser state.
82 static struct config_set protected_config;
84 static int config_file_fgetc(struct config_source *conf)
86 return getc_unlocked(conf->u.file);
89 static int config_file_ungetc(int c, struct config_source *conf)
91 return ungetc(c, conf->u.file);
94 static long config_file_ftell(struct config_source *conf)
96 return ftell(conf->u.file);
100 static int config_buf_fgetc(struct config_source *conf)
102 if (conf->u.buf.pos < conf->u.buf.len)
103 return conf->u.buf.buf[conf->u.buf.pos++];
105 return EOF;
108 static int config_buf_ungetc(int c, struct config_source *conf)
110 if (conf->u.buf.pos > 0) {
111 conf->u.buf.pos--;
112 if (conf->u.buf.buf[conf->u.buf.pos] != c)
113 BUG("config_buf can only ungetc the same character");
114 return c;
117 return EOF;
120 static long config_buf_ftell(struct config_source *conf)
122 return conf->u.buf.pos;
125 struct config_include_data {
126 int depth;
127 config_fn_t fn;
128 void *data;
129 const struct config_options *opts;
130 struct git_config_source *config_source;
131 struct repository *repo;
134 * All remote URLs discovered when reading all config files.
136 struct string_list *remote_urls;
138 #define CONFIG_INCLUDE_INIT { 0 }
140 static int git_config_include(const char *var, const char *value,
141 const struct config_context *ctx, void *data);
143 #define MAX_INCLUDE_DEPTH 10
144 static const char include_depth_advice[] = N_(
145 "exceeded maximum include depth (%d) while including\n"
146 " %s\n"
147 "from\n"
148 " %s\n"
149 "This might be due to circular includes.");
150 static int handle_path_include(const struct key_value_info *kvi,
151 const char *path,
152 struct config_include_data *inc)
154 int ret = 0;
155 struct strbuf buf = STRBUF_INIT;
156 char *expanded;
158 if (!path)
159 return config_error_nonbool("include.path");
161 expanded = interpolate_path(path, 0);
162 if (!expanded)
163 return error(_("could not expand include path '%s'"), path);
164 path = expanded;
167 * Use an absolute path as-is, but interpret relative paths
168 * based on the including config file.
170 if (!is_absolute_path(path)) {
171 char *slash;
173 if (!kvi || !kvi->path) {
174 ret = error(_("relative config includes must come from files"));
175 goto cleanup;
178 slash = find_last_dir_sep(kvi->path);
179 if (slash)
180 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
181 strbuf_addstr(&buf, path);
182 path = buf.buf;
185 if (!access_or_die(path, R_OK, 0)) {
186 if (++inc->depth > MAX_INCLUDE_DEPTH)
187 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
188 !kvi ? "<unknown>" :
189 kvi->filename ? kvi->filename :
190 "the command line");
191 ret = git_config_from_file_with_options(git_config_include, path, inc,
192 kvi->scope, NULL);
193 inc->depth--;
195 cleanup:
196 strbuf_release(&buf);
197 free(expanded);
198 return ret;
201 static void add_trailing_starstar_for_dir(struct strbuf *pat)
203 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
204 strbuf_addstr(pat, "**");
207 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
208 struct strbuf *pat)
210 struct strbuf path = STRBUF_INIT;
211 char *expanded;
212 int prefix = 0;
214 expanded = interpolate_path(pat->buf, 1);
215 if (expanded) {
216 strbuf_reset(pat);
217 strbuf_addstr(pat, expanded);
218 free(expanded);
221 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
222 const char *slash;
224 if (!kvi || !kvi->path)
225 return error(_("relative config include "
226 "conditionals must come from files"));
228 strbuf_realpath(&path, kvi->path, 1);
229 slash = find_last_dir_sep(path.buf);
230 if (!slash)
231 BUG("how is this possible?");
232 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
233 prefix = slash - path.buf + 1 /* slash */;
234 } else if (!is_absolute_path(pat->buf))
235 strbuf_insertstr(pat, 0, "**/");
237 add_trailing_starstar_for_dir(pat);
239 strbuf_release(&path);
240 return prefix;
243 static int include_by_gitdir(const struct key_value_info *kvi,
244 const struct config_options *opts,
245 const char *cond, size_t cond_len, int icase)
247 struct strbuf text = STRBUF_INIT;
248 struct strbuf pattern = STRBUF_INIT;
249 int ret = 0, prefix;
250 const char *git_dir;
251 int already_tried_absolute = 0;
253 if (opts->git_dir)
254 git_dir = opts->git_dir;
255 else
256 goto done;
258 strbuf_realpath(&text, git_dir, 1);
259 strbuf_add(&pattern, cond, cond_len);
260 prefix = prepare_include_condition_pattern(kvi, &pattern);
262 again:
263 if (prefix < 0)
264 goto done;
266 if (prefix > 0) {
268 * perform literal matching on the prefix part so that
269 * any wildcard character in it can't create side effects.
271 if (text.len < prefix)
272 goto done;
273 if (!icase && strncmp(pattern.buf, text.buf, prefix))
274 goto done;
275 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
276 goto done;
279 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
280 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
282 if (!ret && !already_tried_absolute) {
284 * We've tried e.g. matching gitdir:~/work, but if
285 * ~/work is a symlink to /mnt/storage/work
286 * strbuf_realpath() will expand it, so the rule won't
287 * match. Let's match against a
288 * strbuf_add_absolute_path() version of the path,
289 * which'll do the right thing
291 strbuf_reset(&text);
292 strbuf_add_absolute_path(&text, git_dir);
293 already_tried_absolute = 1;
294 goto again;
296 done:
297 strbuf_release(&pattern);
298 strbuf_release(&text);
299 return ret;
302 static int include_by_branch(const char *cond, size_t cond_len)
304 int flags;
305 int ret;
306 struct strbuf pattern = STRBUF_INIT;
307 const char *refname = !the_repository->gitdir ?
308 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
309 const char *shortname;
311 if (!refname || !(flags & REF_ISSYMREF) ||
312 !skip_prefix(refname, "refs/heads/", &shortname))
313 return 0;
315 strbuf_add(&pattern, cond, cond_len);
316 add_trailing_starstar_for_dir(&pattern);
317 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
318 strbuf_release(&pattern);
319 return ret;
322 static int add_remote_url(const char *var, const char *value,
323 const struct config_context *ctx UNUSED, void *data)
325 struct string_list *remote_urls = data;
326 const char *remote_name;
327 size_t remote_name_len;
328 const char *key;
330 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
331 &key) &&
332 remote_name &&
333 !strcmp(key, "url"))
334 string_list_append(remote_urls, value);
335 return 0;
338 static void populate_remote_urls(struct config_include_data *inc)
340 struct config_options opts;
342 opts = *inc->opts;
343 opts.unconditional_remote_url = 1;
345 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
346 string_list_init_dup(inc->remote_urls);
347 config_with_options(add_remote_url, inc->remote_urls,
348 inc->config_source, inc->repo, &opts);
351 static int forbid_remote_url(const char *var, const char *value UNUSED,
352 const struct config_context *ctx UNUSED,
353 void *data UNUSED)
355 const char *remote_name;
356 size_t remote_name_len;
357 const char *key;
359 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
360 &key) &&
361 remote_name &&
362 !strcmp(key, "url"))
363 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
364 return 0;
367 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
368 struct string_list *remote_urls)
370 struct strbuf pattern = STRBUF_INIT;
371 struct string_list_item *url_item;
372 int found = 0;
374 strbuf_add(&pattern, glob, glob_len);
375 for_each_string_list_item(url_item, remote_urls) {
376 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
377 found = 1;
378 break;
381 strbuf_release(&pattern);
382 return found;
385 static int include_by_remote_url(struct config_include_data *inc,
386 const char *cond, size_t cond_len)
388 if (inc->opts->unconditional_remote_url)
389 return 1;
390 if (!inc->remote_urls)
391 populate_remote_urls(inc);
392 return at_least_one_url_matches_glob(cond, cond_len,
393 inc->remote_urls);
396 static int include_condition_is_true(const struct key_value_info *kvi,
397 struct config_include_data *inc,
398 const char *cond, size_t cond_len)
400 const struct config_options *opts = inc->opts;
402 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
403 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
404 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
405 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
406 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
407 return include_by_branch(cond, cond_len);
408 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
409 &cond_len))
410 return include_by_remote_url(inc, cond, cond_len);
412 /* unknown conditionals are always false */
413 return 0;
416 static int git_config_include(const char *var, const char *value,
417 const struct config_context *ctx,
418 void *data)
420 struct config_include_data *inc = data;
421 const char *cond, *key;
422 size_t cond_len;
423 int ret;
426 * Pass along all values, including "include" directives; this makes it
427 * possible to query information on the includes themselves.
429 ret = inc->fn(var, value, ctx, inc->data);
430 if (ret < 0)
431 return ret;
433 if (!strcmp(var, "include.path"))
434 ret = handle_path_include(ctx->kvi, value, inc);
436 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
437 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
438 !strcmp(key, "path")) {
439 config_fn_t old_fn = inc->fn;
441 if (inc->opts->unconditional_remote_url)
442 inc->fn = forbid_remote_url;
443 ret = handle_path_include(ctx->kvi, value, inc);
444 inc->fn = old_fn;
447 return ret;
450 static void git_config_push_split_parameter(const char *key, const char *value)
452 struct strbuf env = STRBUF_INIT;
453 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
454 if (old && *old) {
455 strbuf_addstr(&env, old);
456 strbuf_addch(&env, ' ');
458 sq_quote_buf(&env, key);
459 strbuf_addch(&env, '=');
460 if (value)
461 sq_quote_buf(&env, value);
462 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
463 strbuf_release(&env);
466 void git_config_push_parameter(const char *text)
468 const char *value;
471 * When we see:
473 * section.subsection=with=equals.key=value
475 * we cannot tell if it means:
477 * [section "subsection=with=equals"]
478 * key = value
480 * or:
482 * [section]
483 * subsection = with=equals.key=value
485 * We parse left-to-right for the first "=", meaning we'll prefer to
486 * keep the value intact over the subsection. This is historical, but
487 * also sensible since values are more likely to contain odd or
488 * untrusted input than a section name.
490 * A missing equals is explicitly allowed (as a bool-only entry).
492 value = strchr(text, '=');
493 if (value) {
494 char *key = xmemdupz(text, value - text);
495 git_config_push_split_parameter(key, value + 1);
496 free(key);
497 } else {
498 git_config_push_split_parameter(text, NULL);
502 void git_config_push_env(const char *spec)
504 char *key;
505 const char *env_name;
506 const char *env_value;
508 env_name = strrchr(spec, '=');
509 if (!env_name)
510 die(_("invalid config format: %s"), spec);
511 key = xmemdupz(spec, env_name - spec);
512 env_name++;
513 if (!*env_name)
514 die(_("missing environment variable name for configuration '%.*s'"),
515 (int)(env_name - spec - 1), spec);
517 env_value = getenv(env_name);
518 if (!env_value)
519 die(_("missing environment variable '%s' for configuration '%.*s'"),
520 env_name, (int)(env_name - spec - 1), spec);
522 git_config_push_split_parameter(key, env_value);
523 free(key);
526 static inline int iskeychar(int c)
528 return isalnum(c) || c == '-';
532 * Auxiliary function to sanity-check and split the key into the section
533 * identifier and variable name.
535 * Returns 0 on success, -1 when there is an invalid character in the key and
536 * -2 if there is no section name in the key.
538 * store_key - pointer to char* which will hold a copy of the key with
539 * lowercase section and variable name
540 * baselen - pointer to size_t which will hold the length of the
541 * section + subsection part, can be NULL
543 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
545 size_t i, baselen;
546 int dot;
547 const char *last_dot = strrchr(key, '.');
550 * Since "key" actually contains the section name and the real
551 * key name separated by a dot, we have to know where the dot is.
554 if (last_dot == NULL || last_dot == key) {
555 error(_("key does not contain a section: %s"), key);
556 return -CONFIG_NO_SECTION_OR_NAME;
559 if (!last_dot[1]) {
560 error(_("key does not contain variable name: %s"), key);
561 return -CONFIG_NO_SECTION_OR_NAME;
564 baselen = last_dot - key;
565 if (baselen_)
566 *baselen_ = baselen;
569 * Validate the key and while at it, lower case it for matching.
571 *store_key = xmallocz(strlen(key));
573 dot = 0;
574 for (i = 0; key[i]; i++) {
575 unsigned char c = key[i];
576 if (c == '.')
577 dot = 1;
578 /* Leave the extended basename untouched.. */
579 if (!dot || i > baselen) {
580 if (!iskeychar(c) ||
581 (i == baselen + 1 && !isalpha(c))) {
582 error(_("invalid key: %s"), key);
583 goto out_free_ret_1;
585 c = tolower(c);
586 } else if (c == '\n') {
587 error(_("invalid key (newline): %s"), key);
588 goto out_free_ret_1;
590 (*store_key)[i] = c;
593 return 0;
595 out_free_ret_1:
596 FREE_AND_NULL(*store_key);
597 return -CONFIG_INVALID_KEY;
600 static int config_parse_pair(const char *key, const char *value,
601 struct key_value_info *kvi,
602 config_fn_t fn, void *data)
604 char *canonical_name;
605 int ret;
606 struct config_context ctx = {
607 .kvi = kvi,
610 if (!strlen(key))
611 return error(_("empty config key"));
612 if (git_config_parse_key(key, &canonical_name, NULL))
613 return -1;
615 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
616 free(canonical_name);
617 return ret;
621 /* for values read from `git_config_from_parameters()` */
622 void kvi_from_param(struct key_value_info *out)
624 out->filename = NULL;
625 out->linenr = -1;
626 out->origin_type = CONFIG_ORIGIN_CMDLINE;
627 out->scope = CONFIG_SCOPE_COMMAND;
628 out->path = NULL;
631 int git_config_parse_parameter(const char *text,
632 config_fn_t fn, void *data)
634 const char *value;
635 struct strbuf **pair;
636 int ret;
637 struct key_value_info kvi = KVI_INIT;
639 kvi_from_param(&kvi);
641 pair = strbuf_split_str(text, '=', 2);
642 if (!pair[0])
643 return error(_("bogus config parameter: %s"), text);
645 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
646 strbuf_setlen(pair[0], pair[0]->len - 1);
647 value = pair[1] ? pair[1]->buf : "";
648 } else {
649 value = NULL;
652 strbuf_trim(pair[0]);
653 if (!pair[0]->len) {
654 strbuf_list_free(pair);
655 return error(_("bogus config parameter: %s"), text);
658 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
659 strbuf_list_free(pair);
660 return ret;
663 static int parse_config_env_list(char *env, struct key_value_info *kvi,
664 config_fn_t fn, void *data)
666 char *cur = env;
667 while (cur && *cur) {
668 const char *key = sq_dequote_step(cur, &cur);
669 if (!key)
670 return error(_("bogus format in %s"),
671 CONFIG_DATA_ENVIRONMENT);
673 if (!cur || isspace(*cur)) {
674 /* old-style 'key=value' */
675 if (git_config_parse_parameter(key, fn, data) < 0)
676 return -1;
678 else if (*cur == '=') {
679 /* new-style 'key'='value' */
680 const char *value;
682 cur++;
683 if (*cur == '\'') {
684 /* quoted value */
685 value = sq_dequote_step(cur, &cur);
686 if (!value || (cur && !isspace(*cur))) {
687 return error(_("bogus format in %s"),
688 CONFIG_DATA_ENVIRONMENT);
690 } else if (!*cur || isspace(*cur)) {
691 /* implicit bool: 'key'= */
692 value = NULL;
693 } else {
694 return error(_("bogus format in %s"),
695 CONFIG_DATA_ENVIRONMENT);
698 if (config_parse_pair(key, value, kvi, fn, data) < 0)
699 return -1;
701 else {
702 /* unknown format */
703 return error(_("bogus format in %s"),
704 CONFIG_DATA_ENVIRONMENT);
707 if (cur) {
708 while (isspace(*cur))
709 cur++;
712 return 0;
715 int git_config_from_parameters(config_fn_t fn, void *data)
717 const char *env;
718 struct strbuf envvar = STRBUF_INIT;
719 struct strvec to_free = STRVEC_INIT;
720 int ret = 0;
721 char *envw = NULL;
722 struct key_value_info kvi = KVI_INIT;
724 kvi_from_param(&kvi);
725 env = getenv(CONFIG_COUNT_ENVIRONMENT);
726 if (env) {
727 unsigned long count;
728 char *endp;
729 int i;
731 count = strtoul(env, &endp, 10);
732 if (*endp) {
733 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
734 goto out;
736 if (count > INT_MAX) {
737 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
738 goto out;
741 for (i = 0; i < count; i++) {
742 const char *key, *value;
744 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
745 key = getenv_safe(&to_free, envvar.buf);
746 if (!key) {
747 ret = error(_("missing config key %s"), envvar.buf);
748 goto out;
750 strbuf_reset(&envvar);
752 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
753 value = getenv_safe(&to_free, envvar.buf);
754 if (!value) {
755 ret = error(_("missing config value %s"), envvar.buf);
756 goto out;
758 strbuf_reset(&envvar);
760 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
761 ret = -1;
762 goto out;
767 env = getenv(CONFIG_DATA_ENVIRONMENT);
768 if (env) {
769 /* sq_dequote will write over it */
770 envw = xstrdup(env);
771 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
772 ret = -1;
773 goto out;
777 out:
778 strbuf_release(&envvar);
779 strvec_clear(&to_free);
780 free(envw);
781 return ret;
784 static int get_next_char(struct config_source *cs)
786 int c = cs->do_fgetc(cs);
788 if (c == '\r') {
789 /* DOS like systems */
790 c = cs->do_fgetc(cs);
791 if (c != '\n') {
792 if (c != EOF)
793 cs->do_ungetc(c, cs);
794 c = '\r';
798 if (c != EOF && ++cs->total_len > INT_MAX) {
800 * This is an absurdly long config file; refuse to parse
801 * further in order to protect downstream code from integer
802 * overflows. Note that we can't return an error specifically,
803 * but we can mark EOF and put trash in the return value,
804 * which will trigger a parse error.
806 cs->eof = 1;
807 return 0;
810 if (c == '\n')
811 cs->linenr++;
812 if (c == EOF) {
813 cs->eof = 1;
814 cs->linenr++;
815 c = '\n';
817 return c;
820 static char *parse_value(struct config_source *cs)
822 int quote = 0, comment = 0, space = 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 return cs->value.buf;
834 if (comment)
835 continue;
836 if (isspace(c) && !quote) {
837 if (cs->value.len)
838 space++;
839 continue;
841 if (!quote) {
842 if (c == ';' || c == '#') {
843 comment = 1;
844 continue;
847 for (; space; space--)
848 strbuf_addch(&cs->value, ' ');
849 if (c == '\\') {
850 c = get_next_char(cs);
851 switch (c) {
852 case '\n':
853 continue;
854 case 't':
855 c = '\t';
856 break;
857 case 'b':
858 c = '\b';
859 break;
860 case 'n':
861 c = '\n';
862 break;
863 /* Some characters escape as themselves */
864 case '\\': case '"':
865 break;
866 /* Reject unknown escape sequences */
867 default:
868 return NULL;
870 strbuf_addch(&cs->value, c);
871 continue;
873 if (c == '"') {
874 quote = 1-quote;
875 continue;
877 strbuf_addch(&cs->value, c);
881 static int get_value(struct config_source *cs, struct key_value_info *kvi,
882 config_fn_t fn, void *data, struct strbuf *name)
884 int c;
885 char *value;
886 int ret;
887 struct config_context ctx = {
888 .kvi = kvi,
891 /* Get the full name */
892 for (;;) {
893 c = get_next_char(cs);
894 if (cs->eof)
895 break;
896 if (!iskeychar(c))
897 break;
898 strbuf_addch(name, tolower(c));
901 while (c == ' ' || c == '\t')
902 c = get_next_char(cs);
904 value = NULL;
905 if (c != '\n') {
906 if (c != '=')
907 return -1;
908 value = parse_value(cs);
909 if (!value)
910 return -1;
913 * We already consumed the \n, but we need linenr to point to
914 * the line we just parsed during the call to fn to get
915 * accurate line number in error messages.
917 cs->linenr--;
918 kvi->linenr = cs->linenr;
919 ret = fn(name->buf, value, &ctx, data);
920 if (ret >= 0)
921 cs->linenr++;
922 return ret;
925 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
926 int c)
928 cs->subsection_case_sensitive = 0;
929 do {
930 if (c == '\n')
931 goto error_incomplete_line;
932 c = get_next_char(cs);
933 } while (isspace(c));
935 /* We require the format to be '[base "extension"]' */
936 if (c != '"')
937 return -1;
938 strbuf_addch(name, '.');
940 for (;;) {
941 int c = get_next_char(cs);
942 if (c == '\n')
943 goto error_incomplete_line;
944 if (c == '"')
945 break;
946 if (c == '\\') {
947 c = get_next_char(cs);
948 if (c == '\n')
949 goto error_incomplete_line;
951 strbuf_addch(name, c);
954 /* Final ']' */
955 if (get_next_char(cs) != ']')
956 return -1;
957 return 0;
958 error_incomplete_line:
959 cs->linenr--;
960 return -1;
963 static int get_base_var(struct config_source *cs, struct strbuf *name)
965 cs->subsection_case_sensitive = 1;
966 for (;;) {
967 int c = get_next_char(cs);
968 if (cs->eof)
969 return -1;
970 if (c == ']')
971 return 0;
972 if (isspace(c))
973 return get_extended_base_var(cs, name, c);
974 if (!iskeychar(c) && c != '.')
975 return -1;
976 strbuf_addch(name, tolower(c));
980 struct parse_event_data {
981 enum config_event_t previous_type;
982 size_t previous_offset;
983 const struct config_options *opts;
986 static int do_event(struct config_source *cs, enum config_event_t type,
987 struct parse_event_data *data)
989 size_t offset;
991 if (!data->opts || !data->opts->event_fn)
992 return 0;
994 if (type == CONFIG_EVENT_WHITESPACE &&
995 data->previous_type == type)
996 return 0;
998 offset = cs->do_ftell(cs);
1000 * At EOF, the parser always "inserts" an extra '\n', therefore
1001 * the end offset of the event is the current file position, otherwise
1002 * we will already have advanced to the next event.
1004 if (type != CONFIG_EVENT_EOF)
1005 offset--;
1007 if (data->previous_type != CONFIG_EVENT_EOF &&
1008 data->opts->event_fn(data->previous_type, data->previous_offset,
1009 offset, cs, data->opts->event_fn_data) < 0)
1010 return -1;
1012 data->previous_type = type;
1013 data->previous_offset = offset;
1015 return 0;
1018 static void kvi_from_source(struct config_source *cs,
1019 enum config_scope scope,
1020 struct key_value_info *out)
1022 out->filename = strintern(cs->name);
1023 out->origin_type = cs->origin_type;
1024 out->linenr = cs->linenr;
1025 out->scope = scope;
1026 out->path = cs->path;
1029 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1030 struct key_value_info *kvi, void *data,
1031 const struct config_options *opts)
1033 int comment = 0;
1034 size_t baselen = 0;
1035 struct strbuf *var = &cs->var;
1036 int error_return = 0;
1037 char *error_msg = NULL;
1039 /* U+FEFF Byte Order Mark in UTF8 */
1040 const char *bomptr = utf8_bom;
1042 /* For the parser event callback */
1043 struct parse_event_data event_data = {
1044 CONFIG_EVENT_EOF, 0, opts
1047 for (;;) {
1048 int c;
1050 c = get_next_char(cs);
1051 if (bomptr && *bomptr) {
1052 /* We are at the file beginning; skip UTF8-encoded BOM
1053 * if present. Sane editors won't put this in on their
1054 * own, but e.g. Windows Notepad will do it happily. */
1055 if (c == (*bomptr & 0377)) {
1056 bomptr++;
1057 continue;
1058 } else {
1059 /* Do not tolerate partial BOM. */
1060 if (bomptr != utf8_bom)
1061 break;
1062 /* No BOM at file beginning. Cool. */
1063 bomptr = NULL;
1066 if (c == '\n') {
1067 if (cs->eof) {
1068 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1069 return -1;
1070 return 0;
1072 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1073 return -1;
1074 comment = 0;
1075 continue;
1077 if (comment)
1078 continue;
1079 if (isspace(c)) {
1080 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1081 return -1;
1082 continue;
1084 if (c == '#' || c == ';') {
1085 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1086 return -1;
1087 comment = 1;
1088 continue;
1090 if (c == '[') {
1091 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1092 return -1;
1094 /* Reset prior to determining a new stem */
1095 strbuf_reset(var);
1096 if (get_base_var(cs, var) < 0 || var->len < 1)
1097 break;
1098 strbuf_addch(var, '.');
1099 baselen = var->len;
1100 continue;
1102 if (!isalpha(c))
1103 break;
1105 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1106 return -1;
1109 * Truncate the var name back to the section header
1110 * stem prior to grabbing the suffix part of the name
1111 * and the value.
1113 strbuf_setlen(var, baselen);
1114 strbuf_addch(var, tolower(c));
1115 if (get_value(cs, kvi, fn, data, var) < 0)
1116 break;
1119 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1120 return -1;
1122 switch (cs->origin_type) {
1123 case CONFIG_ORIGIN_BLOB:
1124 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1125 cs->linenr, cs->name);
1126 break;
1127 case CONFIG_ORIGIN_FILE:
1128 error_msg = xstrfmt(_("bad config line %d in file %s"),
1129 cs->linenr, cs->name);
1130 break;
1131 case CONFIG_ORIGIN_STDIN:
1132 error_msg = xstrfmt(_("bad config line %d in standard input"),
1133 cs->linenr);
1134 break;
1135 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1136 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1137 cs->linenr, cs->name);
1138 break;
1139 case CONFIG_ORIGIN_CMDLINE:
1140 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1141 cs->linenr, cs->name);
1142 break;
1143 default:
1144 error_msg = xstrfmt(_("bad config line %d in %s"),
1145 cs->linenr, cs->name);
1148 switch (opts && opts->error_action ?
1149 opts->error_action :
1150 cs->default_error_action) {
1151 case CONFIG_ERROR_DIE:
1152 die("%s", error_msg);
1153 break;
1154 case CONFIG_ERROR_ERROR:
1155 error_return = error("%s", error_msg);
1156 break;
1157 case CONFIG_ERROR_SILENT:
1158 error_return = -1;
1159 break;
1160 case CONFIG_ERROR_UNSET:
1161 BUG("config error action unset");
1164 free(error_msg);
1165 return error_return;
1168 static uintmax_t get_unit_factor(const char *end)
1170 if (!*end)
1171 return 1;
1172 else if (!strcasecmp(end, "k"))
1173 return 1024;
1174 else if (!strcasecmp(end, "m"))
1175 return 1024 * 1024;
1176 else if (!strcasecmp(end, "g"))
1177 return 1024 * 1024 * 1024;
1178 return 0;
1181 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1183 if (value && *value) {
1184 char *end;
1185 intmax_t val;
1186 intmax_t factor;
1188 if (max < 0)
1189 BUG("max must be a positive integer");
1191 errno = 0;
1192 val = strtoimax(value, &end, 0);
1193 if (errno == ERANGE)
1194 return 0;
1195 if (end == value) {
1196 errno = EINVAL;
1197 return 0;
1199 factor = get_unit_factor(end);
1200 if (!factor) {
1201 errno = EINVAL;
1202 return 0;
1204 if ((val < 0 && -max / factor > val) ||
1205 (val > 0 && max / factor < val)) {
1206 errno = ERANGE;
1207 return 0;
1209 val *= factor;
1210 *ret = val;
1211 return 1;
1213 errno = EINVAL;
1214 return 0;
1217 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1219 if (value && *value) {
1220 char *end;
1221 uintmax_t val;
1222 uintmax_t factor;
1224 /* negative values would be accepted by strtoumax */
1225 if (strchr(value, '-')) {
1226 errno = EINVAL;
1227 return 0;
1229 errno = 0;
1230 val = strtoumax(value, &end, 0);
1231 if (errno == ERANGE)
1232 return 0;
1233 if (end == value) {
1234 errno = EINVAL;
1235 return 0;
1237 factor = get_unit_factor(end);
1238 if (!factor) {
1239 errno = EINVAL;
1240 return 0;
1242 if (unsigned_mult_overflows(factor, val) ||
1243 factor * val > max) {
1244 errno = ERANGE;
1245 return 0;
1247 val *= factor;
1248 *ret = val;
1249 return 1;
1251 errno = EINVAL;
1252 return 0;
1255 int git_parse_int(const char *value, int *ret)
1257 intmax_t tmp;
1258 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1259 return 0;
1260 *ret = tmp;
1261 return 1;
1264 static int git_parse_int64(const char *value, int64_t *ret)
1266 intmax_t tmp;
1267 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1268 return 0;
1269 *ret = tmp;
1270 return 1;
1273 int git_parse_ulong(const char *value, unsigned long *ret)
1275 uintmax_t tmp;
1276 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1277 return 0;
1278 *ret = tmp;
1279 return 1;
1282 int git_parse_ssize_t(const char *value, ssize_t *ret)
1284 intmax_t tmp;
1285 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1286 return 0;
1287 *ret = tmp;
1288 return 1;
1291 NORETURN
1292 static void die_bad_number(const char *name, const char *value,
1293 const struct key_value_info *kvi)
1295 const char *error_type = (errno == ERANGE) ?
1296 N_("out of range") : N_("invalid unit");
1297 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1299 if (!kvi)
1300 BUG("kvi should not be NULL");
1302 if (!value)
1303 value = "";
1305 if (!kvi->filename)
1306 die(_(bad_numeric), value, name, _(error_type));
1308 switch (kvi->origin_type) {
1309 case CONFIG_ORIGIN_BLOB:
1310 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1311 value, name, kvi->filename, _(error_type));
1312 case CONFIG_ORIGIN_FILE:
1313 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1314 value, name, kvi->filename, _(error_type));
1315 case CONFIG_ORIGIN_STDIN:
1316 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1317 value, name, _(error_type));
1318 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1319 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1320 value, name, kvi->filename, _(error_type));
1321 case CONFIG_ORIGIN_CMDLINE:
1322 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1323 value, name, kvi->filename, _(error_type));
1324 default:
1325 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1326 value, name, kvi->filename, _(error_type));
1330 int git_config_int(const char *name, const char *value,
1331 const struct key_value_info *kvi)
1333 int ret;
1334 if (!git_parse_int(value, &ret))
1335 die_bad_number(name, value, kvi);
1336 return ret;
1339 int64_t git_config_int64(const char *name, const char *value,
1340 const struct key_value_info *kvi)
1342 int64_t ret;
1343 if (!git_parse_int64(value, &ret))
1344 die_bad_number(name, value, kvi);
1345 return ret;
1348 unsigned long git_config_ulong(const char *name, const char *value,
1349 const struct key_value_info *kvi)
1351 unsigned long ret;
1352 if (!git_parse_ulong(value, &ret))
1353 die_bad_number(name, value, kvi);
1354 return ret;
1357 ssize_t git_config_ssize_t(const char *name, const char *value,
1358 const struct key_value_info *kvi)
1360 ssize_t ret;
1361 if (!git_parse_ssize_t(value, &ret))
1362 die_bad_number(name, value, kvi);
1363 return ret;
1366 static int git_parse_maybe_bool_text(const char *value)
1368 if (!value)
1369 return 1;
1370 if (!*value)
1371 return 0;
1372 if (!strcasecmp(value, "true")
1373 || !strcasecmp(value, "yes")
1374 || !strcasecmp(value, "on"))
1375 return 1;
1376 if (!strcasecmp(value, "false")
1377 || !strcasecmp(value, "no")
1378 || !strcasecmp(value, "off"))
1379 return 0;
1380 return -1;
1383 static const struct fsync_component_name {
1384 const char *name;
1385 enum fsync_component component_bits;
1386 } fsync_component_names[] = {
1387 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1388 { "pack", FSYNC_COMPONENT_PACK },
1389 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1390 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1391 { "index", FSYNC_COMPONENT_INDEX },
1392 { "objects", FSYNC_COMPONENTS_OBJECTS },
1393 { "reference", FSYNC_COMPONENT_REFERENCE },
1394 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1395 { "committed", FSYNC_COMPONENTS_COMMITTED },
1396 { "added", FSYNC_COMPONENTS_ADDED },
1397 { "all", FSYNC_COMPONENTS_ALL },
1400 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1402 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1403 enum fsync_component positive = 0, negative = 0;
1405 while (string) {
1406 int i;
1407 size_t len;
1408 const char *ep;
1409 int negated = 0;
1410 int found = 0;
1412 string = string + strspn(string, ", \t\n\r");
1413 ep = strchrnul(string, ',');
1414 len = ep - string;
1415 if (!strcmp(string, "none")) {
1416 current = FSYNC_COMPONENT_NONE;
1417 goto next_name;
1420 if (*string == '-') {
1421 negated = 1;
1422 string++;
1423 len--;
1424 if (!len)
1425 warning(_("invalid value for variable %s"), var);
1428 if (!len)
1429 break;
1431 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1432 const struct fsync_component_name *n = &fsync_component_names[i];
1434 if (strncmp(n->name, string, len))
1435 continue;
1437 found = 1;
1438 if (negated)
1439 negative |= n->component_bits;
1440 else
1441 positive |= n->component_bits;
1444 if (!found) {
1445 char *component = xstrndup(string, len);
1446 warning(_("ignoring unknown core.fsync component '%s'"), component);
1447 free(component);
1450 next_name:
1451 string = ep;
1454 return (current & ~negative) | positive;
1457 int git_parse_maybe_bool(const char *value)
1459 int v = git_parse_maybe_bool_text(value);
1460 if (0 <= v)
1461 return v;
1462 if (git_parse_int(value, &v))
1463 return !!v;
1464 return -1;
1467 int git_config_bool_or_int(const char *name, const char *value,
1468 const struct key_value_info *kvi, int *is_bool)
1470 int v = git_parse_maybe_bool_text(value);
1471 if (0 <= v) {
1472 *is_bool = 1;
1473 return v;
1475 *is_bool = 0;
1476 return git_config_int(name, value, kvi);
1479 int git_config_bool(const char *name, const char *value)
1481 int v = git_parse_maybe_bool(value);
1482 if (v < 0)
1483 die(_("bad boolean config value '%s' for '%s'"), value, name);
1484 return v;
1487 int git_config_string(const char **dest, const char *var, const char *value)
1489 if (!value)
1490 return config_error_nonbool(var);
1491 *dest = xstrdup(value);
1492 return 0;
1495 int git_config_pathname(const char **dest, const char *var, const char *value)
1497 if (!value)
1498 return config_error_nonbool(var);
1499 *dest = interpolate_path(value, 0);
1500 if (!*dest)
1501 die(_("failed to expand user dir in: '%s'"), value);
1502 return 0;
1505 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1507 if (!value)
1508 return config_error_nonbool(var);
1509 if (parse_expiry_date(value, timestamp))
1510 return error(_("'%s' for '%s' is not a valid timestamp"),
1511 value, var);
1512 return 0;
1515 int git_config_color(char *dest, const char *var, const char *value)
1517 if (!value)
1518 return config_error_nonbool(var);
1519 if (color_parse(value, dest) < 0)
1520 return -1;
1521 return 0;
1524 static int git_default_core_config(const char *var, const char *value,
1525 const struct config_context *ctx, void *cb)
1527 /* This needs a better name */
1528 if (!strcmp(var, "core.filemode")) {
1529 trust_executable_bit = git_config_bool(var, value);
1530 return 0;
1532 if (!strcmp(var, "core.trustctime")) {
1533 trust_ctime = git_config_bool(var, value);
1534 return 0;
1536 if (!strcmp(var, "core.checkstat")) {
1537 if (!strcasecmp(value, "default"))
1538 check_stat = 1;
1539 else if (!strcasecmp(value, "minimal"))
1540 check_stat = 0;
1543 if (!strcmp(var, "core.quotepath")) {
1544 quote_path_fully = git_config_bool(var, value);
1545 return 0;
1548 if (!strcmp(var, "core.symlinks")) {
1549 has_symlinks = git_config_bool(var, value);
1550 return 0;
1553 if (!strcmp(var, "core.ignorecase")) {
1554 ignore_case = git_config_bool(var, value);
1555 return 0;
1558 if (!strcmp(var, "core.attributesfile"))
1559 return git_config_pathname(&git_attributes_file, var, value);
1561 if (!strcmp(var, "core.hookspath"))
1562 return git_config_pathname(&git_hooks_path, var, value);
1564 if (!strcmp(var, "core.bare")) {
1565 is_bare_repository_cfg = git_config_bool(var, value);
1566 return 0;
1569 if (!strcmp(var, "core.ignorestat")) {
1570 assume_unchanged = git_config_bool(var, value);
1571 return 0;
1574 if (!strcmp(var, "core.prefersymlinkrefs")) {
1575 prefer_symlink_refs = git_config_bool(var, value);
1576 return 0;
1579 if (!strcmp(var, "core.logallrefupdates")) {
1580 if (value && !strcasecmp(value, "always"))
1581 log_all_ref_updates = LOG_REFS_ALWAYS;
1582 else if (git_config_bool(var, value))
1583 log_all_ref_updates = LOG_REFS_NORMAL;
1584 else
1585 log_all_ref_updates = LOG_REFS_NONE;
1586 return 0;
1589 if (!strcmp(var, "core.warnambiguousrefs")) {
1590 warn_ambiguous_refs = git_config_bool(var, value);
1591 return 0;
1594 if (!strcmp(var, "core.abbrev")) {
1595 if (!value)
1596 return config_error_nonbool(var);
1597 if (!strcasecmp(value, "auto"))
1598 default_abbrev = -1;
1599 else if (!git_parse_maybe_bool_text(value))
1600 default_abbrev = the_hash_algo->hexsz;
1601 else {
1602 int abbrev = git_config_int(var, value, ctx->kvi);
1603 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1604 return error(_("abbrev length out of range: %d"), abbrev);
1605 default_abbrev = abbrev;
1607 return 0;
1610 if (!strcmp(var, "core.disambiguate"))
1611 return set_disambiguate_hint_config(var, value);
1613 if (!strcmp(var, "core.loosecompression")) {
1614 int level = git_config_int(var, value, ctx->kvi);
1615 if (level == -1)
1616 level = Z_DEFAULT_COMPRESSION;
1617 else if (level < 0 || level > Z_BEST_COMPRESSION)
1618 die(_("bad zlib compression level %d"), level);
1619 zlib_compression_level = level;
1620 zlib_compression_seen = 1;
1621 return 0;
1624 if (!strcmp(var, "core.compression")) {
1625 int level = git_config_int(var, value, ctx->kvi);
1626 if (level == -1)
1627 level = Z_DEFAULT_COMPRESSION;
1628 else if (level < 0 || level > Z_BEST_COMPRESSION)
1629 die(_("bad zlib compression level %d"), level);
1630 if (!zlib_compression_seen)
1631 zlib_compression_level = level;
1632 if (!pack_compression_seen)
1633 pack_compression_level = level;
1634 return 0;
1637 if (!strcmp(var, "core.packedgitwindowsize")) {
1638 int pgsz_x2 = getpagesize() * 2;
1639 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1641 /* This value must be multiple of (pagesize * 2) */
1642 packed_git_window_size /= pgsz_x2;
1643 if (packed_git_window_size < 1)
1644 packed_git_window_size = 1;
1645 packed_git_window_size *= pgsz_x2;
1646 return 0;
1649 if (!strcmp(var, "core.bigfilethreshold")) {
1650 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1651 return 0;
1654 if (!strcmp(var, "core.packedgitlimit")) {
1655 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1656 return 0;
1659 if (!strcmp(var, "core.deltabasecachelimit")) {
1660 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1661 return 0;
1664 if (!strcmp(var, "core.autocrlf")) {
1665 if (value && !strcasecmp(value, "input")) {
1666 auto_crlf = AUTO_CRLF_INPUT;
1667 return 0;
1669 auto_crlf = git_config_bool(var, value);
1670 return 0;
1673 if (!strcmp(var, "core.safecrlf")) {
1674 int eol_rndtrp_die;
1675 if (value && !strcasecmp(value, "warn")) {
1676 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1677 return 0;
1679 eol_rndtrp_die = git_config_bool(var, value);
1680 global_conv_flags_eol = eol_rndtrp_die ?
1681 CONV_EOL_RNDTRP_DIE : 0;
1682 return 0;
1685 if (!strcmp(var, "core.eol")) {
1686 if (value && !strcasecmp(value, "lf"))
1687 core_eol = EOL_LF;
1688 else if (value && !strcasecmp(value, "crlf"))
1689 core_eol = EOL_CRLF;
1690 else if (value && !strcasecmp(value, "native"))
1691 core_eol = EOL_NATIVE;
1692 else
1693 core_eol = EOL_UNSET;
1694 return 0;
1697 if (!strcmp(var, "core.checkroundtripencoding")) {
1698 check_roundtrip_encoding = xstrdup(value);
1699 return 0;
1702 if (!strcmp(var, "core.notesref")) {
1703 notes_ref_name = xstrdup(value);
1704 return 0;
1707 if (!strcmp(var, "core.editor"))
1708 return git_config_string(&editor_program, var, value);
1710 if (!strcmp(var, "core.commentchar")) {
1711 if (!value)
1712 return config_error_nonbool(var);
1713 else if (!strcasecmp(value, "auto"))
1714 auto_comment_line_char = 1;
1715 else if (value[0] && !value[1]) {
1716 comment_line_char = value[0];
1717 auto_comment_line_char = 0;
1718 } else
1719 return error(_("core.commentChar should only be one ASCII character"));
1720 return 0;
1723 if (!strcmp(var, "core.askpass"))
1724 return git_config_string(&askpass_program, var, value);
1726 if (!strcmp(var, "core.excludesfile"))
1727 return git_config_pathname(&excludes_file, var, value);
1729 if (!strcmp(var, "core.whitespace")) {
1730 if (!value)
1731 return config_error_nonbool(var);
1732 whitespace_rule_cfg = parse_whitespace_rule(value);
1733 return 0;
1736 if (!strcmp(var, "core.fsync")) {
1737 if (!value)
1738 return config_error_nonbool(var);
1739 fsync_components = parse_fsync_components(var, value);
1740 return 0;
1743 if (!strcmp(var, "core.fsyncmethod")) {
1744 if (!value)
1745 return config_error_nonbool(var);
1746 if (!strcmp(value, "fsync"))
1747 fsync_method = FSYNC_METHOD_FSYNC;
1748 else if (!strcmp(value, "writeout-only"))
1749 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1750 else if (!strcmp(value, "batch"))
1751 fsync_method = FSYNC_METHOD_BATCH;
1752 else
1753 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1757 if (!strcmp(var, "core.fsyncobjectfiles")) {
1758 if (fsync_object_files < 0)
1759 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1760 fsync_object_files = git_config_bool(var, value);
1761 return 0;
1764 if (!strcmp(var, "core.preloadindex")) {
1765 core_preload_index = git_config_bool(var, value);
1766 return 0;
1769 if (!strcmp(var, "core.createobject")) {
1770 if (!strcmp(value, "rename"))
1771 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1772 else if (!strcmp(value, "link"))
1773 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1774 else
1775 die(_("invalid mode for object creation: %s"), value);
1776 return 0;
1779 if (!strcmp(var, "core.sparsecheckout")) {
1780 core_apply_sparse_checkout = git_config_bool(var, value);
1781 return 0;
1784 if (!strcmp(var, "core.sparsecheckoutcone")) {
1785 core_sparse_checkout_cone = git_config_bool(var, value);
1786 return 0;
1789 if (!strcmp(var, "core.precomposeunicode")) {
1790 precomposed_unicode = git_config_bool(var, value);
1791 return 0;
1794 if (!strcmp(var, "core.protecthfs")) {
1795 protect_hfs = git_config_bool(var, value);
1796 return 0;
1799 if (!strcmp(var, "core.protectntfs")) {
1800 protect_ntfs = git_config_bool(var, value);
1801 return 0;
1804 if (!strcmp(var, "core.maxtreedepth")) {
1805 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1806 return 0;
1809 /* Add other config variables here and to Documentation/config.txt. */
1810 return platform_core_config(var, value, ctx, cb);
1813 static int git_default_sparse_config(const char *var, const char *value)
1815 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1816 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1817 return 0;
1820 /* Add other config variables here and to Documentation/config/sparse.txt. */
1821 return 0;
1824 static int git_default_i18n_config(const char *var, const char *value)
1826 if (!strcmp(var, "i18n.commitencoding"))
1827 return git_config_string(&git_commit_encoding, var, value);
1829 if (!strcmp(var, "i18n.logoutputencoding"))
1830 return git_config_string(&git_log_output_encoding, var, value);
1832 /* Add other config variables here and to Documentation/config.txt. */
1833 return 0;
1836 static int git_default_branch_config(const char *var, const char *value)
1838 if (!strcmp(var, "branch.autosetupmerge")) {
1839 if (value && !strcmp(value, "always")) {
1840 git_branch_track = BRANCH_TRACK_ALWAYS;
1841 return 0;
1842 } else if (value && !strcmp(value, "inherit")) {
1843 git_branch_track = BRANCH_TRACK_INHERIT;
1844 return 0;
1845 } else if (value && !strcmp(value, "simple")) {
1846 git_branch_track = BRANCH_TRACK_SIMPLE;
1847 return 0;
1849 git_branch_track = git_config_bool(var, value);
1850 return 0;
1852 if (!strcmp(var, "branch.autosetuprebase")) {
1853 if (!value)
1854 return config_error_nonbool(var);
1855 else if (!strcmp(value, "never"))
1856 autorebase = AUTOREBASE_NEVER;
1857 else if (!strcmp(value, "local"))
1858 autorebase = AUTOREBASE_LOCAL;
1859 else if (!strcmp(value, "remote"))
1860 autorebase = AUTOREBASE_REMOTE;
1861 else if (!strcmp(value, "always"))
1862 autorebase = AUTOREBASE_ALWAYS;
1863 else
1864 return error(_("malformed value for %s"), var);
1865 return 0;
1868 /* Add other config variables here and to Documentation/config.txt. */
1869 return 0;
1872 static int git_default_push_config(const char *var, const char *value)
1874 if (!strcmp(var, "push.default")) {
1875 if (!value)
1876 return config_error_nonbool(var);
1877 else if (!strcmp(value, "nothing"))
1878 push_default = PUSH_DEFAULT_NOTHING;
1879 else if (!strcmp(value, "matching"))
1880 push_default = PUSH_DEFAULT_MATCHING;
1881 else if (!strcmp(value, "simple"))
1882 push_default = PUSH_DEFAULT_SIMPLE;
1883 else if (!strcmp(value, "upstream"))
1884 push_default = PUSH_DEFAULT_UPSTREAM;
1885 else if (!strcmp(value, "tracking")) /* deprecated */
1886 push_default = PUSH_DEFAULT_UPSTREAM;
1887 else if (!strcmp(value, "current"))
1888 push_default = PUSH_DEFAULT_CURRENT;
1889 else {
1890 error(_("malformed value for %s: %s"), var, value);
1891 return error(_("must be one of nothing, matching, simple, "
1892 "upstream or current"));
1894 return 0;
1897 /* Add other config variables here and to Documentation/config.txt. */
1898 return 0;
1901 static int git_default_mailmap_config(const char *var, const char *value)
1903 if (!strcmp(var, "mailmap.file"))
1904 return git_config_pathname(&git_mailmap_file, var, value);
1905 if (!strcmp(var, "mailmap.blob"))
1906 return git_config_string(&git_mailmap_blob, var, value);
1908 /* Add other config variables here and to Documentation/config.txt. */
1909 return 0;
1912 int git_default_config(const char *var, const char *value,
1913 const struct config_context *ctx, void *cb)
1915 if (starts_with(var, "core."))
1916 return git_default_core_config(var, value, ctx, cb);
1918 if (starts_with(var, "user.") ||
1919 starts_with(var, "author.") ||
1920 starts_with(var, "committer."))
1921 return git_ident_config(var, value, ctx, cb);
1923 if (starts_with(var, "i18n."))
1924 return git_default_i18n_config(var, value);
1926 if (starts_with(var, "branch."))
1927 return git_default_branch_config(var, value);
1929 if (starts_with(var, "push."))
1930 return git_default_push_config(var, value);
1932 if (starts_with(var, "mailmap."))
1933 return git_default_mailmap_config(var, value);
1935 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1936 return git_default_advice_config(var, value);
1938 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1939 pager_use_color = git_config_bool(var,value);
1940 return 0;
1943 if (!strcmp(var, "pack.packsizelimit")) {
1944 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1945 return 0;
1948 if (!strcmp(var, "pack.compression")) {
1949 int level = git_config_int(var, value, ctx->kvi);
1950 if (level == -1)
1951 level = Z_DEFAULT_COMPRESSION;
1952 else if (level < 0 || level > Z_BEST_COMPRESSION)
1953 die(_("bad pack compression level %d"), level);
1954 pack_compression_level = level;
1955 pack_compression_seen = 1;
1956 return 0;
1959 if (starts_with(var, "sparse."))
1960 return git_default_sparse_config(var, value);
1962 /* Add other config variables here and to Documentation/config.txt. */
1963 return 0;
1967 * All source specific fields in the union, die_on_error, name and the callbacks
1968 * fgetc, ungetc, ftell of top need to be initialized before calling
1969 * this function.
1971 static int do_config_from(struct config_source *top, config_fn_t fn,
1972 void *data, enum config_scope scope,
1973 const struct config_options *opts)
1975 struct key_value_info kvi = KVI_INIT;
1976 int ret;
1978 /* push config-file parsing state stack */
1979 top->linenr = 1;
1980 top->eof = 0;
1981 top->total_len = 0;
1982 strbuf_init(&top->value, 1024);
1983 strbuf_init(&top->var, 1024);
1984 kvi_from_source(top, scope, &kvi);
1986 ret = git_parse_source(top, fn, &kvi, data, opts);
1988 strbuf_release(&top->value);
1989 strbuf_release(&top->var);
1991 return ret;
1994 static int do_config_from_file(config_fn_t fn,
1995 const enum config_origin_type origin_type,
1996 const char *name, const char *path, FILE *f,
1997 void *data, enum config_scope scope,
1998 const struct config_options *opts)
2000 struct config_source top = CONFIG_SOURCE_INIT;
2001 int ret;
2003 top.u.file = f;
2004 top.origin_type = origin_type;
2005 top.name = name;
2006 top.path = path;
2007 top.default_error_action = CONFIG_ERROR_DIE;
2008 top.do_fgetc = config_file_fgetc;
2009 top.do_ungetc = config_file_ungetc;
2010 top.do_ftell = config_file_ftell;
2012 flockfile(f);
2013 ret = do_config_from(&top, fn, data, scope, opts);
2014 funlockfile(f);
2015 return ret;
2018 static int git_config_from_stdin(config_fn_t fn, void *data,
2019 enum config_scope scope)
2021 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
2022 data, scope, NULL);
2025 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
2026 void *data, enum config_scope scope,
2027 const struct config_options *opts)
2029 int ret = -1;
2030 FILE *f;
2032 if (!filename)
2033 BUG("filename cannot be NULL");
2034 f = fopen_or_warn(filename, "r");
2035 if (f) {
2036 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
2037 filename, f, data, scope, opts);
2038 fclose(f);
2040 return ret;
2043 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
2045 return git_config_from_file_with_options(fn, filename, data,
2046 CONFIG_SCOPE_UNKNOWN, NULL);
2049 int git_config_from_mem(config_fn_t fn,
2050 const enum config_origin_type origin_type,
2051 const char *name, const char *buf, size_t len,
2052 void *data, enum config_scope scope,
2053 const struct config_options *opts)
2055 struct config_source top = CONFIG_SOURCE_INIT;
2057 top.u.buf.buf = buf;
2058 top.u.buf.len = len;
2059 top.u.buf.pos = 0;
2060 top.origin_type = origin_type;
2061 top.name = name;
2062 top.path = NULL;
2063 top.default_error_action = CONFIG_ERROR_ERROR;
2064 top.do_fgetc = config_buf_fgetc;
2065 top.do_ungetc = config_buf_ungetc;
2066 top.do_ftell = config_buf_ftell;
2068 return do_config_from(&top, fn, data, scope, opts);
2071 int git_config_from_blob_oid(config_fn_t fn,
2072 const char *name,
2073 struct repository *repo,
2074 const struct object_id *oid,
2075 void *data,
2076 enum config_scope scope)
2078 enum object_type type;
2079 char *buf;
2080 unsigned long size;
2081 int ret;
2083 buf = repo_read_object_file(repo, oid, &type, &size);
2084 if (!buf)
2085 return error(_("unable to load config blob object '%s'"), name);
2086 if (type != OBJ_BLOB) {
2087 free(buf);
2088 return error(_("reference '%s' does not point to a blob"), name);
2091 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
2092 data, scope, NULL);
2093 free(buf);
2095 return ret;
2098 static int git_config_from_blob_ref(config_fn_t fn,
2099 struct repository *repo,
2100 const char *name,
2101 void *data,
2102 enum config_scope scope)
2104 struct object_id oid;
2106 if (repo_get_oid(repo, name, &oid) < 0)
2107 return error(_("unable to resolve config blob '%s'"), name);
2108 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
2111 char *git_system_config(void)
2113 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2114 if (!system_config)
2115 system_config = system_path(ETC_GITCONFIG);
2116 normalize_path_copy(system_config, system_config);
2117 return system_config;
2120 void git_global_config(char **user_out, char **xdg_out)
2122 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2123 char *xdg_config = NULL;
2125 if (!user_config) {
2126 user_config = interpolate_path("~/.gitconfig", 0);
2127 xdg_config = xdg_config_home("config");
2130 *user_out = user_config;
2131 *xdg_out = xdg_config;
2135 * Parse environment variable 'k' as a boolean (in various
2136 * possible spellings); if missing, use the default value 'def'.
2138 int git_env_bool(const char *k, int def)
2140 const char *v = getenv(k);
2141 return v ? git_config_bool(k, v) : def;
2145 * Parse environment variable 'k' as ulong with possibly a unit
2146 * suffix; if missing, use the default value 'val'.
2148 unsigned long git_env_ulong(const char *k, unsigned long val)
2150 const char *v = getenv(k);
2151 if (v && !git_parse_ulong(v, &val))
2152 die(_("failed to parse %s"), k);
2153 return val;
2156 int git_config_system(void)
2158 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2161 static int do_git_config_sequence(const struct config_options *opts,
2162 const struct repository *repo,
2163 config_fn_t fn, void *data)
2165 int ret = 0;
2166 char *system_config = git_system_config();
2167 char *xdg_config = NULL;
2168 char *user_config = NULL;
2169 char *repo_config;
2170 char *worktree_config;
2173 * Ensure that either:
2174 * - the git_dir and commondir are both set, or
2175 * - the git_dir and commondir are both NULL
2177 if (!opts->git_dir != !opts->commondir)
2178 BUG("only one of commondir and git_dir is non-NULL");
2180 if (opts->commondir) {
2181 repo_config = mkpathdup("%s/config", opts->commondir);
2182 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2183 } else {
2184 repo_config = NULL;
2185 worktree_config = NULL;
2188 if (git_config_system() && system_config &&
2189 !access_or_die(system_config, R_OK,
2190 opts->system_gently ? ACCESS_EACCES_OK : 0))
2191 ret += git_config_from_file_with_options(fn, system_config,
2192 data, CONFIG_SCOPE_SYSTEM,
2193 NULL);
2195 git_global_config(&user_config, &xdg_config);
2197 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2198 ret += git_config_from_file_with_options(fn, xdg_config, data,
2199 CONFIG_SCOPE_GLOBAL, NULL);
2201 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2202 ret += git_config_from_file_with_options(fn, user_config, data,
2203 CONFIG_SCOPE_GLOBAL, NULL);
2205 if (!opts->ignore_repo && repo_config &&
2206 !access_or_die(repo_config, R_OK, 0))
2207 ret += git_config_from_file_with_options(fn, repo_config, data,
2208 CONFIG_SCOPE_LOCAL, NULL);
2210 if (!opts->ignore_worktree && worktree_config &&
2211 repo && repo->repository_format_worktree_config &&
2212 !access_or_die(worktree_config, R_OK, 0)) {
2213 ret += git_config_from_file_with_options(fn, worktree_config, data,
2214 CONFIG_SCOPE_WORKTREE,
2215 NULL);
2218 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2219 die(_("unable to parse command-line config"));
2221 free(system_config);
2222 free(xdg_config);
2223 free(user_config);
2224 free(repo_config);
2225 free(worktree_config);
2226 return ret;
2229 int config_with_options(config_fn_t fn, void *data,
2230 struct git_config_source *config_source,
2231 struct repository *repo,
2232 const struct config_options *opts)
2234 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2235 int ret;
2237 if (opts->respect_includes) {
2238 inc.fn = fn;
2239 inc.data = data;
2240 inc.opts = opts;
2241 inc.repo = repo;
2242 inc.config_source = config_source;
2243 fn = git_config_include;
2244 data = &inc;
2248 * If we have a specific filename, use it. Otherwise, follow the
2249 * regular lookup sequence.
2251 if (config_source && config_source->use_stdin) {
2252 ret = git_config_from_stdin(fn, data, config_source->scope);
2253 } else if (config_source && config_source->file) {
2254 ret = git_config_from_file_with_options(fn, config_source->file,
2255 data, config_source->scope,
2256 NULL);
2257 } else if (config_source && config_source->blob) {
2258 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2259 data, config_source->scope);
2260 } else {
2261 ret = do_git_config_sequence(opts, repo, fn, data);
2264 if (inc.remote_urls) {
2265 string_list_clear(inc.remote_urls, 0);
2266 FREE_AND_NULL(inc.remote_urls);
2268 return ret;
2271 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2273 int i, value_index;
2274 struct string_list *values;
2275 struct config_set_element *entry;
2276 struct configset_list *list = &set->list;
2277 struct config_context ctx = CONFIG_CONTEXT_INIT;
2279 for (i = 0; i < list->nr; i++) {
2280 entry = list->items[i].e;
2281 value_index = list->items[i].value_index;
2282 values = &entry->value_list;
2284 ctx.kvi = values->items[value_index].util;
2285 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2286 git_die_config_linenr(entry->key,
2287 ctx.kvi->filename,
2288 ctx.kvi->linenr);
2292 void read_early_config(config_fn_t cb, void *data)
2294 struct config_options opts = {0};
2295 struct strbuf commondir = STRBUF_INIT;
2296 struct strbuf gitdir = STRBUF_INIT;
2298 opts.respect_includes = 1;
2300 if (have_git_dir()) {
2301 opts.commondir = get_git_common_dir();
2302 opts.git_dir = get_git_dir();
2304 * When setup_git_directory() was not yet asked to discover the
2305 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2306 * is any repository config we should use (but unlike
2307 * setup_git_directory_gently(), no global state is changed, most
2308 * notably, the current working directory is still the same after the
2309 * call).
2311 } else if (!discover_git_directory(&commondir, &gitdir)) {
2312 opts.commondir = commondir.buf;
2313 opts.git_dir = gitdir.buf;
2316 config_with_options(cb, data, NULL, NULL, &opts);
2318 strbuf_release(&commondir);
2319 strbuf_release(&gitdir);
2323 * Read config but only enumerate system and global settings.
2324 * Omit any repo-local, worktree-local, or command-line settings.
2326 void read_very_early_config(config_fn_t cb, void *data)
2328 struct config_options opts = { 0 };
2330 opts.respect_includes = 1;
2331 opts.ignore_repo = 1;
2332 opts.ignore_worktree = 1;
2333 opts.ignore_cmdline = 1;
2334 opts.system_gently = 1;
2336 config_with_options(cb, data, NULL, NULL, &opts);
2339 RESULT_MUST_BE_USED
2340 static int configset_find_element(struct config_set *set, const char *key,
2341 struct config_set_element **dest)
2343 struct config_set_element k;
2344 struct config_set_element *found_entry;
2345 char *normalized_key;
2346 int ret;
2349 * `key` may come from the user, so normalize it before using it
2350 * for querying entries from the hashmap.
2352 ret = git_config_parse_key(key, &normalized_key, NULL);
2353 if (ret)
2354 return ret;
2356 hashmap_entry_init(&k.ent, strhash(normalized_key));
2357 k.key = normalized_key;
2358 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2359 free(normalized_key);
2360 *dest = found_entry;
2361 return 0;
2364 static int configset_add_value(const struct key_value_info *kvi_p,
2365 struct config_set *set, const char *key,
2366 const char *value)
2368 struct config_set_element *e;
2369 struct string_list_item *si;
2370 struct configset_list_item *l_item;
2371 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2372 int ret;
2374 ret = configset_find_element(set, key, &e);
2375 if (ret)
2376 return ret;
2378 * Since the keys are being fed by git_config*() callback mechanism, they
2379 * are already normalized. So simply add them without any further munging.
2381 if (!e) {
2382 e = xmalloc(sizeof(*e));
2383 hashmap_entry_init(&e->ent, strhash(key));
2384 e->key = xstrdup(key);
2385 string_list_init_dup(&e->value_list);
2386 hashmap_add(&set->config_hash, &e->ent);
2388 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2390 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2391 l_item = &set->list.items[set->list.nr++];
2392 l_item->e = e;
2393 l_item->value_index = e->value_list.nr - 1;
2395 *kv_info = *kvi_p;
2396 si->util = kv_info;
2398 return 0;
2401 static int config_set_element_cmp(const void *cmp_data UNUSED,
2402 const struct hashmap_entry *eptr,
2403 const struct hashmap_entry *entry_or_key,
2404 const void *keydata UNUSED)
2406 const struct config_set_element *e1, *e2;
2408 e1 = container_of(eptr, const struct config_set_element, ent);
2409 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2411 return strcmp(e1->key, e2->key);
2414 void git_configset_init(struct config_set *set)
2416 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2417 set->hash_initialized = 1;
2418 set->list.nr = 0;
2419 set->list.alloc = 0;
2420 set->list.items = NULL;
2423 void git_configset_clear(struct config_set *set)
2425 struct config_set_element *entry;
2426 struct hashmap_iter iter;
2427 if (!set->hash_initialized)
2428 return;
2430 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2431 ent /* member name */) {
2432 free(entry->key);
2433 string_list_clear(&entry->value_list, 1);
2435 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2436 set->hash_initialized = 0;
2437 free(set->list.items);
2438 set->list.nr = 0;
2439 set->list.alloc = 0;
2440 set->list.items = NULL;
2443 static int config_set_callback(const char *key, const char *value,
2444 const struct config_context *ctx,
2445 void *cb)
2447 struct config_set *set = cb;
2448 configset_add_value(ctx->kvi, set, key, value);
2449 return 0;
2452 int git_configset_add_file(struct config_set *set, const char *filename)
2454 return git_config_from_file(config_set_callback, filename, set);
2457 int git_configset_get_value(struct config_set *set, const char *key,
2458 const char **value, struct key_value_info *kvi)
2460 const struct string_list *values = NULL;
2461 int ret;
2462 struct string_list_item item;
2464 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2465 * queried key in the files of the configset, the value returned will be the last
2466 * value in the value list for that key.
2468 if ((ret = git_configset_get_value_multi(set, key, &values)))
2469 return ret;
2471 assert(values->nr > 0);
2472 item = values->items[values->nr - 1];
2473 *value = item.string;
2474 if (kvi)
2475 *kvi = *((struct key_value_info *)item.util);
2476 return 0;
2479 int git_configset_get_value_multi(struct config_set *set, const char *key,
2480 const struct string_list **dest)
2482 struct config_set_element *e;
2483 int ret;
2485 if ((ret = configset_find_element(set, key, &e)))
2486 return ret;
2487 else if (!e)
2488 return 1;
2489 *dest = &e->value_list;
2491 return 0;
2494 static int check_multi_string(struct string_list_item *item, void *util)
2496 return item->string ? 0 : config_error_nonbool(util);
2499 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2500 const struct string_list **dest)
2502 int ret;
2504 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2505 return ret;
2506 if ((ret = for_each_string_list((struct string_list *)*dest,
2507 check_multi_string, (void *)key)))
2508 return ret;
2510 return 0;
2513 int git_configset_get(struct config_set *set, const char *key)
2515 struct config_set_element *e;
2516 int ret;
2518 if ((ret = configset_find_element(set, key, &e)))
2519 return ret;
2520 else if (!e)
2521 return 1;
2522 return 0;
2525 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2527 const char *value;
2528 if (!git_configset_get_value(set, key, &value, NULL))
2529 return git_config_string((const char **)dest, key, value);
2530 else
2531 return 1;
2534 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2535 const char **dest)
2537 const char *value;
2538 if (!git_configset_get_value(set, key, &value, NULL)) {
2539 if (!value)
2540 return config_error_nonbool(key);
2541 *dest = value;
2542 return 0;
2543 } else {
2544 return 1;
2548 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2550 const char *value;
2551 struct key_value_info kvi;
2553 if (!git_configset_get_value(set, key, &value, &kvi)) {
2554 *dest = git_config_int(key, value, &kvi);
2555 return 0;
2556 } else
2557 return 1;
2560 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2562 const char *value;
2563 struct key_value_info kvi;
2565 if (!git_configset_get_value(set, key, &value, &kvi)) {
2566 *dest = git_config_ulong(key, value, &kvi);
2567 return 0;
2568 } else
2569 return 1;
2572 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2574 const char *value;
2575 if (!git_configset_get_value(set, key, &value, NULL)) {
2576 *dest = git_config_bool(key, value);
2577 return 0;
2578 } else
2579 return 1;
2582 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2583 int *is_bool, int *dest)
2585 const char *value;
2586 struct key_value_info kvi;
2588 if (!git_configset_get_value(set, key, &value, &kvi)) {
2589 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2590 return 0;
2591 } else
2592 return 1;
2595 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2597 const char *value;
2598 if (!git_configset_get_value(set, key, &value, NULL)) {
2599 *dest = git_parse_maybe_bool(value);
2600 if (*dest == -1)
2601 return -1;
2602 return 0;
2603 } else
2604 return 1;
2607 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2609 const char *value;
2610 if (!git_configset_get_value(set, key, &value, NULL))
2611 return git_config_pathname(dest, key, value);
2612 else
2613 return 1;
2616 /* Functions use to read configuration from a repository */
2617 static void repo_read_config(struct repository *repo)
2619 struct config_options opts = { 0 };
2621 opts.respect_includes = 1;
2622 opts.commondir = repo->commondir;
2623 opts.git_dir = repo->gitdir;
2625 if (!repo->config)
2626 CALLOC_ARRAY(repo->config, 1);
2627 else
2628 git_configset_clear(repo->config);
2630 git_configset_init(repo->config);
2631 if (config_with_options(config_set_callback, repo->config, NULL,
2632 repo, &opts) < 0)
2634 * config_with_options() normally returns only
2635 * zero, as most errors are fatal, and
2636 * non-fatal potential errors are guarded by "if"
2637 * statements that are entered only when no error is
2638 * possible.
2640 * If we ever encounter a non-fatal error, it means
2641 * something went really wrong and we should stop
2642 * immediately.
2644 die(_("unknown error occurred while reading the configuration files"));
2647 static void git_config_check_init(struct repository *repo)
2649 if (repo->config && repo->config->hash_initialized)
2650 return;
2651 repo_read_config(repo);
2654 static void repo_config_clear(struct repository *repo)
2656 if (!repo->config || !repo->config->hash_initialized)
2657 return;
2658 git_configset_clear(repo->config);
2661 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2663 git_config_check_init(repo);
2664 configset_iter(repo->config, fn, data);
2667 int repo_config_get(struct repository *repo, const char *key)
2669 git_config_check_init(repo);
2670 return git_configset_get(repo->config, key);
2673 int repo_config_get_value(struct repository *repo,
2674 const char *key, const char **value)
2676 git_config_check_init(repo);
2677 return git_configset_get_value(repo->config, key, value, NULL);
2680 int repo_config_get_value_multi(struct repository *repo, const char *key,
2681 const struct string_list **dest)
2683 git_config_check_init(repo);
2684 return git_configset_get_value_multi(repo->config, key, dest);
2687 int repo_config_get_string_multi(struct repository *repo, const char *key,
2688 const struct string_list **dest)
2690 git_config_check_init(repo);
2691 return git_configset_get_string_multi(repo->config, key, dest);
2694 int repo_config_get_string(struct repository *repo,
2695 const char *key, char **dest)
2697 int ret;
2698 git_config_check_init(repo);
2699 ret = git_configset_get_string(repo->config, key, dest);
2700 if (ret < 0)
2701 git_die_config(key, NULL);
2702 return ret;
2705 int repo_config_get_string_tmp(struct repository *repo,
2706 const char *key, const char **dest)
2708 int ret;
2709 git_config_check_init(repo);
2710 ret = git_configset_get_string_tmp(repo->config, key, dest);
2711 if (ret < 0)
2712 git_die_config(key, NULL);
2713 return ret;
2716 int repo_config_get_int(struct repository *repo,
2717 const char *key, int *dest)
2719 git_config_check_init(repo);
2720 return git_configset_get_int(repo->config, key, dest);
2723 int repo_config_get_ulong(struct repository *repo,
2724 const char *key, unsigned long *dest)
2726 git_config_check_init(repo);
2727 return git_configset_get_ulong(repo->config, key, dest);
2730 int repo_config_get_bool(struct repository *repo,
2731 const char *key, int *dest)
2733 git_config_check_init(repo);
2734 return git_configset_get_bool(repo->config, key, dest);
2737 int repo_config_get_bool_or_int(struct repository *repo,
2738 const char *key, int *is_bool, int *dest)
2740 git_config_check_init(repo);
2741 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2744 int repo_config_get_maybe_bool(struct repository *repo,
2745 const char *key, int *dest)
2747 git_config_check_init(repo);
2748 return git_configset_get_maybe_bool(repo->config, key, dest);
2751 int repo_config_get_pathname(struct repository *repo,
2752 const char *key, const char **dest)
2754 int ret;
2755 git_config_check_init(repo);
2756 ret = git_configset_get_pathname(repo->config, key, dest);
2757 if (ret < 0)
2758 git_die_config(key, NULL);
2759 return ret;
2762 /* Read values into protected_config. */
2763 static void read_protected_config(void)
2765 struct config_options opts = {
2766 .respect_includes = 1,
2767 .ignore_repo = 1,
2768 .ignore_worktree = 1,
2769 .system_gently = 1,
2772 git_configset_init(&protected_config);
2773 config_with_options(config_set_callback, &protected_config, NULL,
2774 NULL, &opts);
2777 void git_protected_config(config_fn_t fn, void *data)
2779 if (!protected_config.hash_initialized)
2780 read_protected_config();
2781 configset_iter(&protected_config, fn, data);
2784 /* Functions used historically to read configuration from 'the_repository' */
2785 void git_config(config_fn_t fn, void *data)
2787 repo_config(the_repository, fn, data);
2790 void git_config_clear(void)
2792 repo_config_clear(the_repository);
2795 int git_config_get(const char *key)
2797 return repo_config_get(the_repository, key);
2800 int git_config_get_value(const char *key, const char **value)
2802 return repo_config_get_value(the_repository, key, value);
2805 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2807 return repo_config_get_value_multi(the_repository, key, dest);
2810 int git_config_get_string_multi(const char *key,
2811 const struct string_list **dest)
2813 return repo_config_get_string_multi(the_repository, key, dest);
2816 int git_config_get_string(const char *key, char **dest)
2818 return repo_config_get_string(the_repository, key, dest);
2821 int git_config_get_string_tmp(const char *key, const char **dest)
2823 return repo_config_get_string_tmp(the_repository, key, dest);
2826 int git_config_get_int(const char *key, int *dest)
2828 return repo_config_get_int(the_repository, key, dest);
2831 int git_config_get_ulong(const char *key, unsigned long *dest)
2833 return repo_config_get_ulong(the_repository, key, dest);
2836 int git_config_get_bool(const char *key, int *dest)
2838 return repo_config_get_bool(the_repository, key, dest);
2841 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2843 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2846 int git_config_get_maybe_bool(const char *key, int *dest)
2848 return repo_config_get_maybe_bool(the_repository, key, dest);
2851 int git_config_get_pathname(const char *key, const char **dest)
2853 return repo_config_get_pathname(the_repository, key, dest);
2856 int git_config_get_expiry(const char *key, const char **output)
2858 int ret = git_config_get_string(key, (char **)output);
2859 if (ret)
2860 return ret;
2861 if (strcmp(*output, "now")) {
2862 timestamp_t now = approxidate("now");
2863 if (approxidate(*output) >= now)
2864 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2866 return ret;
2869 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2871 const char *expiry_string;
2872 intmax_t days;
2873 timestamp_t when;
2875 if (git_config_get_string_tmp(key, &expiry_string))
2876 return 1; /* no such thing */
2878 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2879 const int scale = 86400;
2880 *expiry = now - days * scale;
2881 return 0;
2884 if (!parse_expiry_date(expiry_string, &when)) {
2885 *expiry = when;
2886 return 0;
2888 return -1; /* thing exists but cannot be parsed */
2891 int git_config_get_split_index(void)
2893 int val;
2895 if (!git_config_get_maybe_bool("core.splitindex", &val))
2896 return val;
2898 return -1; /* default value */
2901 int git_config_get_max_percent_split_change(void)
2903 int val = -1;
2905 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2906 if (0 <= val && val <= 100)
2907 return val;
2909 return error(_("splitIndex.maxPercentChange value '%d' "
2910 "should be between 0 and 100"), val);
2913 return -1; /* default value */
2916 int git_config_get_index_threads(int *dest)
2918 int is_bool, val;
2920 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2921 if (val) {
2922 *dest = val;
2923 return 0;
2926 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2927 if (is_bool)
2928 *dest = val ? 0 : 1;
2929 else
2930 *dest = val;
2931 return 0;
2934 return 1;
2937 NORETURN
2938 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2940 if (!filename)
2941 die(_("unable to parse '%s' from command-line config"), key);
2942 else
2943 die(_("bad config variable '%s' in file '%s' at line %d"),
2944 key, filename, linenr);
2947 NORETURN __attribute__((format(printf, 2, 3)))
2948 void git_die_config(const char *key, const char *err, ...)
2950 const struct string_list *values;
2951 struct key_value_info *kv_info;
2952 report_fn error_fn = get_error_routine();
2954 if (err) {
2955 va_list params;
2956 va_start(params, err);
2957 error_fn(err, params);
2958 va_end(params);
2960 if (git_config_get_value_multi(key, &values))
2961 BUG("for key '%s' we must have a value to report on", key);
2962 kv_info = values->items[values->nr - 1].util;
2963 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2967 * Find all the stuff for git_config_set() below.
2970 struct config_store_data {
2971 size_t baselen;
2972 char *key;
2973 int do_not_match;
2974 const char *fixed_value;
2975 regex_t *value_pattern;
2976 int multi_replace;
2977 struct {
2978 size_t begin, end;
2979 enum config_event_t type;
2980 int is_keys_section;
2981 } *parsed;
2982 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2983 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2985 #define CONFIG_STORE_INIT { 0 }
2987 static void config_store_data_clear(struct config_store_data *store)
2989 free(store->key);
2990 if (store->value_pattern != NULL &&
2991 store->value_pattern != CONFIG_REGEX_NONE) {
2992 regfree(store->value_pattern);
2993 free(store->value_pattern);
2995 free(store->parsed);
2996 free(store->seen);
2997 memset(store, 0, sizeof(*store));
3000 static int matches(const char *key, const char *value,
3001 const struct config_store_data *store)
3003 if (strcmp(key, store->key))
3004 return 0; /* not ours */
3005 if (store->fixed_value)
3006 return !strcmp(store->fixed_value, value);
3007 if (!store->value_pattern)
3008 return 1; /* always matches */
3009 if (store->value_pattern == CONFIG_REGEX_NONE)
3010 return 0; /* never matches */
3012 return store->do_not_match ^
3013 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
3016 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
3017 struct config_source *cs, void *data)
3019 struct config_store_data *store = data;
3021 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
3022 store->parsed[store->parsed_nr].begin = begin;
3023 store->parsed[store->parsed_nr].end = end;
3024 store->parsed[store->parsed_nr].type = type;
3026 if (type == CONFIG_EVENT_SECTION) {
3027 int (*cmpfn)(const char *, const char *, size_t);
3029 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
3030 return error(_("invalid section name '%s'"), cs->var.buf);
3032 if (cs->subsection_case_sensitive)
3033 cmpfn = strncasecmp;
3034 else
3035 cmpfn = strncmp;
3037 /* Is this the section we were looking for? */
3038 store->is_keys_section =
3039 store->parsed[store->parsed_nr].is_keys_section =
3040 cs->var.len - 1 == store->baselen &&
3041 !cmpfn(cs->var.buf, store->key, store->baselen);
3042 if (store->is_keys_section) {
3043 store->section_seen = 1;
3044 ALLOC_GROW(store->seen, store->seen_nr + 1,
3045 store->seen_alloc);
3046 store->seen[store->seen_nr] = store->parsed_nr;
3050 store->parsed_nr++;
3052 return 0;
3055 static int store_aux(const char *key, const char *value,
3056 const struct config_context *ctx UNUSED, void *cb)
3058 struct config_store_data *store = cb;
3060 if (store->key_seen) {
3061 if (matches(key, value, store)) {
3062 if (store->seen_nr == 1 && store->multi_replace == 0) {
3063 warning(_("%s has multiple values"), key);
3066 ALLOC_GROW(store->seen, store->seen_nr + 1,
3067 store->seen_alloc);
3069 store->seen[store->seen_nr] = store->parsed_nr;
3070 store->seen_nr++;
3072 } else if (store->is_keys_section) {
3074 * Do not increment matches yet: this may not be a match, but we
3075 * are in the desired section.
3077 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
3078 store->seen[store->seen_nr] = store->parsed_nr;
3079 store->section_seen = 1;
3081 if (matches(key, value, store)) {
3082 store->seen_nr++;
3083 store->key_seen = 1;
3087 return 0;
3090 static int write_error(const char *filename)
3092 error(_("failed to write new configuration file %s"), filename);
3094 /* Same error code as "failed to rename". */
3095 return 4;
3098 static struct strbuf store_create_section(const char *key,
3099 const struct config_store_data *store)
3101 const char *dot;
3102 size_t i;
3103 struct strbuf sb = STRBUF_INIT;
3105 dot = memchr(key, '.', store->baselen);
3106 if (dot) {
3107 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
3108 for (i = dot - key + 1; i < store->baselen; i++) {
3109 if (key[i] == '"' || key[i] == '\\')
3110 strbuf_addch(&sb, '\\');
3111 strbuf_addch(&sb, key[i]);
3113 strbuf_addstr(&sb, "\"]\n");
3114 } else {
3115 strbuf_addch(&sb, '[');
3116 strbuf_add(&sb, key, store->baselen);
3117 strbuf_addstr(&sb, "]\n");
3120 return sb;
3123 static ssize_t write_section(int fd, const char *key,
3124 const struct config_store_data *store)
3126 struct strbuf sb = store_create_section(key, store);
3127 ssize_t ret;
3129 ret = write_in_full(fd, sb.buf, sb.len);
3130 strbuf_release(&sb);
3132 return ret;
3135 static ssize_t write_pair(int fd, const char *key, const char *value,
3136 const struct config_store_data *store)
3138 int i;
3139 ssize_t ret;
3140 const char *quote = "";
3141 struct strbuf sb = STRBUF_INIT;
3144 * Check to see if the value needs to be surrounded with a dq pair.
3145 * Note that problematic characters are always backslash-quoted; this
3146 * check is about not losing leading or trailing SP and strings that
3147 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3148 * configuration parser.
3150 if (value[0] == ' ')
3151 quote = "\"";
3152 for (i = 0; value[i]; i++)
3153 if (value[i] == ';' || value[i] == '#')
3154 quote = "\"";
3155 if (i && value[i - 1] == ' ')
3156 quote = "\"";
3158 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3160 for (i = 0; value[i]; i++)
3161 switch (value[i]) {
3162 case '\n':
3163 strbuf_addstr(&sb, "\\n");
3164 break;
3165 case '\t':
3166 strbuf_addstr(&sb, "\\t");
3167 break;
3168 case '"':
3169 case '\\':
3170 strbuf_addch(&sb, '\\');
3171 /* fallthrough */
3172 default:
3173 strbuf_addch(&sb, value[i]);
3174 break;
3176 strbuf_addf(&sb, "%s\n", quote);
3178 ret = write_in_full(fd, sb.buf, sb.len);
3179 strbuf_release(&sb);
3181 return ret;
3185 * If we are about to unset the last key(s) in a section, and if there are
3186 * no comments surrounding (or included in) the section, we will want to
3187 * extend begin/end to remove the entire section.
3189 * Note: the parameter `seen_ptr` points to the index into the store.seen
3190 * array. * This index may be incremented if a section has more than one
3191 * entry (which all are to be removed).
3193 static void maybe_remove_section(struct config_store_data *store,
3194 size_t *begin_offset, size_t *end_offset,
3195 int *seen_ptr)
3197 size_t begin;
3198 int i, seen, section_seen = 0;
3201 * First, ensure that this is the first key, and that there are no
3202 * comments before the entry nor before the section header.
3204 seen = *seen_ptr;
3205 for (i = store->seen[seen]; i > 0; i--) {
3206 enum config_event_t type = store->parsed[i - 1].type;
3208 if (type == CONFIG_EVENT_COMMENT)
3209 /* There is a comment before this entry or section */
3210 return;
3211 if (type == CONFIG_EVENT_ENTRY) {
3212 if (!section_seen)
3213 /* This is not the section's first entry. */
3214 return;
3215 /* We encountered no comment before the section. */
3216 break;
3218 if (type == CONFIG_EVENT_SECTION) {
3219 if (!store->parsed[i - 1].is_keys_section)
3220 break;
3221 section_seen = 1;
3224 begin = store->parsed[i].begin;
3227 * Next, make sure that we are removing the last key(s) in the section,
3228 * and that there are no comments that are possibly about the current
3229 * section.
3231 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3232 enum config_event_t type = store->parsed[i].type;
3234 if (type == CONFIG_EVENT_COMMENT)
3235 return;
3236 if (type == CONFIG_EVENT_SECTION) {
3237 if (store->parsed[i].is_keys_section)
3238 continue;
3239 break;
3241 if (type == CONFIG_EVENT_ENTRY) {
3242 if (++seen < store->seen_nr &&
3243 i == store->seen[seen])
3244 /* We want to remove this entry, too */
3245 continue;
3246 /* There is another entry in this section. */
3247 return;
3252 * We are really removing the last entry/entries from this section, and
3253 * there are no enclosed or surrounding comments. Remove the entire,
3254 * now-empty section.
3256 *seen_ptr = seen;
3257 *begin_offset = begin;
3258 if (i < store->parsed_nr)
3259 *end_offset = store->parsed[i].begin;
3260 else
3261 *end_offset = store->parsed[store->parsed_nr - 1].end;
3264 int git_config_set_in_file_gently(const char *config_filename,
3265 const char *key, const char *value)
3267 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3270 void git_config_set_in_file(const char *config_filename,
3271 const char *key, const char *value)
3273 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3276 int git_config_set_gently(const char *key, const char *value)
3278 return git_config_set_multivar_gently(key, value, NULL, 0);
3281 int repo_config_set_worktree_gently(struct repository *r,
3282 const char *key, const char *value)
3284 /* Only use worktree-specific config if it is already enabled. */
3285 if (r->repository_format_worktree_config) {
3286 char *file = repo_git_path(r, "config.worktree");
3287 int ret = git_config_set_multivar_in_file_gently(
3288 file, key, value, NULL, 0);
3289 free(file);
3290 return ret;
3292 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3295 void git_config_set(const char *key, const char *value)
3297 git_config_set_multivar(key, value, NULL, 0);
3299 trace2_cmd_set_config(key, value);
3303 * If value==NULL, unset in (remove from) config,
3304 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3305 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3306 * (only add a new one)
3307 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3308 * key/values are removed before a single new pair is written. If the
3309 * flag is not present, then replace only the first match.
3311 * Returns 0 on success.
3313 * This function does this:
3315 * - it locks the config file by creating ".git/config.lock"
3317 * - it then parses the config using store_aux() as validator to find
3318 * the position on the key/value pair to replace. If it is to be unset,
3319 * it must be found exactly once.
3321 * - the config file is mmap()ed and the part before the match (if any) is
3322 * written to the lock file, then the changed part and the rest.
3324 * - the config file is removed and the lock file rename()d to it.
3327 int git_config_set_multivar_in_file_gently(const char *config_filename,
3328 const char *key, const char *value,
3329 const char *value_pattern,
3330 unsigned flags)
3332 int fd = -1, in_fd = -1;
3333 int ret;
3334 struct lock_file lock = LOCK_INIT;
3335 char *filename_buf = NULL;
3336 char *contents = NULL;
3337 size_t contents_sz;
3338 struct config_store_data store = CONFIG_STORE_INIT;
3340 /* parse-key returns negative; flip the sign to feed exit(3) */
3341 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3342 if (ret)
3343 goto out_free;
3345 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3347 if (!config_filename)
3348 config_filename = filename_buf = git_pathdup("config");
3351 * The lock serves a purpose in addition to locking: the new
3352 * contents of .git/config will be written into it.
3354 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3355 if (fd < 0) {
3356 error_errno(_("could not lock config file %s"), config_filename);
3357 ret = CONFIG_NO_LOCK;
3358 goto out_free;
3362 * If .git/config does not exist yet, write a minimal version.
3364 in_fd = open(config_filename, O_RDONLY);
3365 if ( in_fd < 0 ) {
3366 if ( ENOENT != errno ) {
3367 error_errno(_("opening %s"), config_filename);
3368 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3369 goto out_free;
3371 /* if nothing to unset, error out */
3372 if (!value) {
3373 ret = CONFIG_NOTHING_SET;
3374 goto out_free;
3377 free(store.key);
3378 store.key = xstrdup(key);
3379 if (write_section(fd, key, &store) < 0 ||
3380 write_pair(fd, key, value, &store) < 0)
3381 goto write_err_out;
3382 } else {
3383 struct stat st;
3384 size_t copy_begin, copy_end;
3385 int i, new_line = 0;
3386 struct config_options opts;
3388 if (!value_pattern)
3389 store.value_pattern = NULL;
3390 else if (value_pattern == CONFIG_REGEX_NONE)
3391 store.value_pattern = CONFIG_REGEX_NONE;
3392 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3393 store.fixed_value = value_pattern;
3394 else {
3395 if (value_pattern[0] == '!') {
3396 store.do_not_match = 1;
3397 value_pattern++;
3398 } else
3399 store.do_not_match = 0;
3401 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3402 if (regcomp(store.value_pattern, value_pattern,
3403 REG_EXTENDED)) {
3404 error(_("invalid pattern: %s"), value_pattern);
3405 FREE_AND_NULL(store.value_pattern);
3406 ret = CONFIG_INVALID_PATTERN;
3407 goto out_free;
3411 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3412 store.parsed[0].end = 0;
3414 memset(&opts, 0, sizeof(opts));
3415 opts.event_fn = store_aux_event;
3416 opts.event_fn_data = &store;
3419 * After this, store.parsed will contain offsets of all the
3420 * parsed elements, and store.seen will contain a list of
3421 * matches, as indices into store.parsed.
3423 * As a side effect, we make sure to transform only a valid
3424 * existing config file.
3426 if (git_config_from_file_with_options(store_aux,
3427 config_filename,
3428 &store, CONFIG_SCOPE_UNKNOWN,
3429 &opts)) {
3430 error(_("invalid config file %s"), config_filename);
3431 ret = CONFIG_INVALID_FILE;
3432 goto out_free;
3435 /* if nothing to unset, or too many matches, error out */
3436 if ((store.seen_nr == 0 && value == NULL) ||
3437 (store.seen_nr > 1 && !store.multi_replace)) {
3438 ret = CONFIG_NOTHING_SET;
3439 goto out_free;
3442 if (fstat(in_fd, &st) == -1) {
3443 error_errno(_("fstat on %s failed"), config_filename);
3444 ret = CONFIG_INVALID_FILE;
3445 goto out_free;
3448 contents_sz = xsize_t(st.st_size);
3449 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3450 MAP_PRIVATE, in_fd, 0);
3451 if (contents == MAP_FAILED) {
3452 if (errno == ENODEV && S_ISDIR(st.st_mode))
3453 errno = EISDIR;
3454 error_errno(_("unable to mmap '%s'%s"),
3455 config_filename, mmap_os_err());
3456 ret = CONFIG_INVALID_FILE;
3457 contents = NULL;
3458 goto out_free;
3460 close(in_fd);
3461 in_fd = -1;
3463 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3464 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3465 ret = CONFIG_NO_WRITE;
3466 goto out_free;
3469 if (store.seen_nr == 0) {
3470 if (!store.seen_alloc) {
3471 /* Did not see key nor section */
3472 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3473 store.seen[0] = store.parsed_nr
3474 - !!store.parsed_nr;
3476 store.seen_nr = 1;
3479 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3480 size_t replace_end;
3481 int j = store.seen[i];
3483 new_line = 0;
3484 if (!store.key_seen) {
3485 copy_end = store.parsed[j].end;
3486 /* include '\n' when copying section header */
3487 if (copy_end > 0 && copy_end < contents_sz &&
3488 contents[copy_end - 1] != '\n' &&
3489 contents[copy_end] == '\n')
3490 copy_end++;
3491 replace_end = copy_end;
3492 } else {
3493 replace_end = store.parsed[j].end;
3494 copy_end = store.parsed[j].begin;
3495 if (!value)
3496 maybe_remove_section(&store,
3497 &copy_end,
3498 &replace_end, &i);
3500 * Swallow preceding white-space on the same
3501 * line.
3503 while (copy_end > 0 ) {
3504 char c = contents[copy_end - 1];
3506 if (isspace(c) && c != '\n')
3507 copy_end--;
3508 else
3509 break;
3513 if (copy_end > 0 && contents[copy_end-1] != '\n')
3514 new_line = 1;
3516 /* write the first part of the config */
3517 if (copy_end > copy_begin) {
3518 if (write_in_full(fd, contents + copy_begin,
3519 copy_end - copy_begin) < 0)
3520 goto write_err_out;
3521 if (new_line &&
3522 write_str_in_full(fd, "\n") < 0)
3523 goto write_err_out;
3525 copy_begin = replace_end;
3528 /* write the pair (value == NULL means unset) */
3529 if (value) {
3530 if (!store.section_seen) {
3531 if (write_section(fd, key, &store) < 0)
3532 goto write_err_out;
3534 if (write_pair(fd, key, value, &store) < 0)
3535 goto write_err_out;
3538 /* write the rest of the config */
3539 if (copy_begin < contents_sz)
3540 if (write_in_full(fd, contents + copy_begin,
3541 contents_sz - copy_begin) < 0)
3542 goto write_err_out;
3544 munmap(contents, contents_sz);
3545 contents = NULL;
3548 if (commit_lock_file(&lock) < 0) {
3549 error_errno(_("could not write config file %s"), config_filename);
3550 ret = CONFIG_NO_WRITE;
3551 goto out_free;
3554 ret = 0;
3556 /* Invalidate the config cache */
3557 git_config_clear();
3559 out_free:
3560 rollback_lock_file(&lock);
3561 free(filename_buf);
3562 if (contents)
3563 munmap(contents, contents_sz);
3564 if (in_fd >= 0)
3565 close(in_fd);
3566 config_store_data_clear(&store);
3567 return ret;
3569 write_err_out:
3570 ret = write_error(get_lock_file_path(&lock));
3571 goto out_free;
3575 void git_config_set_multivar_in_file(const char *config_filename,
3576 const char *key, const char *value,
3577 const char *value_pattern, unsigned flags)
3579 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3580 value_pattern, flags))
3581 return;
3582 if (value)
3583 die(_("could not set '%s' to '%s'"), key, value);
3584 else
3585 die(_("could not unset '%s'"), key);
3588 int git_config_set_multivar_gently(const char *key, const char *value,
3589 const char *value_pattern, unsigned flags)
3591 return repo_config_set_multivar_gently(the_repository, key, value,
3592 value_pattern, flags);
3595 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3596 const char *value,
3597 const char *value_pattern, unsigned flags)
3599 char *file = repo_git_path(r, "config");
3600 int res = git_config_set_multivar_in_file_gently(file,
3601 key, value,
3602 value_pattern,
3603 flags);
3604 free(file);
3605 return res;
3608 void git_config_set_multivar(const char *key, const char *value,
3609 const char *value_pattern, unsigned flags)
3611 git_config_set_multivar_in_file(git_path("config"),
3612 key, value, value_pattern,
3613 flags);
3616 static size_t section_name_match (const char *buf, const char *name)
3618 size_t i = 0, j = 0;
3619 int dot = 0;
3620 if (buf[i] != '[')
3621 return 0;
3622 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3623 if (!dot && isspace(buf[i])) {
3624 dot = 1;
3625 if (name[j++] != '.')
3626 break;
3627 for (i++; isspace(buf[i]); i++)
3628 ; /* do nothing */
3629 if (buf[i] != '"')
3630 break;
3631 continue;
3633 if (buf[i] == '\\' && dot)
3634 i++;
3635 else if (buf[i] == '"' && dot) {
3636 for (i++; isspace(buf[i]); i++)
3637 ; /* do_nothing */
3638 break;
3640 if (buf[i] != name[j++])
3641 break;
3643 if (buf[i] == ']' && name[j] == 0) {
3645 * We match, now just find the right length offset by
3646 * gobbling up any whitespace after it, as well
3648 i++;
3649 for (; buf[i] && isspace(buf[i]); i++)
3650 ; /* do nothing */
3651 return i;
3653 return 0;
3656 static int section_name_is_ok(const char *name)
3658 /* Empty section names are bogus. */
3659 if (!*name)
3660 return 0;
3663 * Before a dot, we must be alphanumeric or dash. After the first dot,
3664 * anything goes, so we can stop checking.
3666 for (; *name && *name != '.'; name++)
3667 if (*name != '-' && !isalnum(*name))
3668 return 0;
3669 return 1;
3672 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3674 /* if new_name == NULL, the section is removed instead */
3675 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3676 const char *old_name,
3677 const char *new_name, int copy)
3679 int ret = 0, remove = 0;
3680 char *filename_buf = NULL;
3681 struct lock_file lock = LOCK_INIT;
3682 int out_fd;
3683 struct strbuf buf = STRBUF_INIT;
3684 FILE *config_file = NULL;
3685 struct stat st;
3686 struct strbuf copystr = STRBUF_INIT;
3687 struct config_store_data store;
3688 uint32_t line_nr = 0;
3690 memset(&store, 0, sizeof(store));
3692 if (new_name && !section_name_is_ok(new_name)) {
3693 ret = error(_("invalid section name: %s"), new_name);
3694 goto out_no_rollback;
3697 if (!config_filename)
3698 config_filename = filename_buf = git_pathdup("config");
3700 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3701 if (out_fd < 0) {
3702 ret = error(_("could not lock config file %s"), config_filename);
3703 goto out;
3706 if (!(config_file = fopen(config_filename, "rb"))) {
3707 ret = warn_on_fopen_errors(config_filename);
3708 if (ret)
3709 goto out;
3710 /* no config file means nothing to rename, no error */
3711 goto commit_and_out;
3714 if (fstat(fileno(config_file), &st) == -1) {
3715 ret = error_errno(_("fstat on %s failed"), config_filename);
3716 goto out;
3719 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3720 ret = error_errno(_("chmod on %s failed"),
3721 get_lock_file_path(&lock));
3722 goto out;
3725 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3726 size_t i, length;
3727 int is_section = 0;
3728 char *output = buf.buf;
3730 line_nr++;
3732 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3733 ret = error(_("refusing to work with overly long line "
3734 "in '%s' on line %"PRIuMAX),
3735 config_filename, (uintmax_t)line_nr);
3736 goto out;
3739 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3740 ; /* do nothing */
3741 if (buf.buf[i] == '[') {
3742 /* it's a section */
3743 size_t offset;
3744 is_section = 1;
3747 * When encountering a new section under -c we
3748 * need to flush out any section we're already
3749 * coping and begin anew. There might be
3750 * multiple [branch "$name"] sections.
3752 if (copystr.len > 0) {
3753 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3754 ret = write_error(get_lock_file_path(&lock));
3755 goto out;
3757 strbuf_reset(&copystr);
3760 offset = section_name_match(&buf.buf[i], old_name);
3761 if (offset > 0) {
3762 ret++;
3763 if (!new_name) {
3764 remove = 1;
3765 continue;
3767 store.baselen = strlen(new_name);
3768 if (!copy) {
3769 if (write_section(out_fd, new_name, &store) < 0) {
3770 ret = write_error(get_lock_file_path(&lock));
3771 goto out;
3774 * We wrote out the new section, with
3775 * a newline, now skip the old
3776 * section's length
3778 output += offset + i;
3779 if (strlen(output) > 0) {
3781 * More content means there's
3782 * a declaration to put on the
3783 * next line; indent with a
3784 * tab
3786 output -= 1;
3787 output[0] = '\t';
3789 } else {
3790 strbuf_release(&copystr);
3791 copystr = store_create_section(new_name, &store);
3794 remove = 0;
3796 if (remove)
3797 continue;
3798 length = strlen(output);
3800 if (!is_section && copystr.len > 0) {
3801 strbuf_add(&copystr, output, length);
3804 if (write_in_full(out_fd, output, length) < 0) {
3805 ret = write_error(get_lock_file_path(&lock));
3806 goto out;
3811 * Copy a trailing section at the end of the config, won't be
3812 * flushed by the usual "flush because we have a new section
3813 * logic in the loop above.
3815 if (copystr.len > 0) {
3816 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3817 ret = write_error(get_lock_file_path(&lock));
3818 goto out;
3820 strbuf_reset(&copystr);
3823 fclose(config_file);
3824 config_file = NULL;
3825 commit_and_out:
3826 if (commit_lock_file(&lock) < 0)
3827 ret = error_errno(_("could not write config file %s"),
3828 config_filename);
3829 out:
3830 if (config_file)
3831 fclose(config_file);
3832 rollback_lock_file(&lock);
3833 out_no_rollback:
3834 free(filename_buf);
3835 config_store_data_clear(&store);
3836 strbuf_release(&buf);
3837 strbuf_release(&copystr);
3838 return ret;
3841 int git_config_rename_section_in_file(const char *config_filename,
3842 const char *old_name, const char *new_name)
3844 return git_config_copy_or_rename_section_in_file(config_filename,
3845 old_name, new_name, 0);
3848 int git_config_rename_section(const char *old_name, const char *new_name)
3850 return git_config_rename_section_in_file(NULL, old_name, new_name);
3853 int git_config_copy_section_in_file(const char *config_filename,
3854 const char *old_name, const char *new_name)
3856 return git_config_copy_or_rename_section_in_file(config_filename,
3857 old_name, new_name, 1);
3860 int git_config_copy_section(const char *old_name, const char *new_name)
3862 return git_config_copy_section_in_file(NULL, old_name, new_name);
3866 * Call this to report error for your variable that should not
3867 * get a boolean value (i.e. "[my] var" means "true").
3869 #undef config_error_nonbool
3870 int config_error_nonbool(const char *var)
3872 return error(_("missing value for '%s'"), var);
3875 int parse_config_key(const char *var,
3876 const char *section,
3877 const char **subsection, size_t *subsection_len,
3878 const char **key)
3880 const char *dot;
3882 /* Does it start with "section." ? */
3883 if (!skip_prefix(var, section, &var) || *var != '.')
3884 return -1;
3887 * Find the key; we don't know yet if we have a subsection, but we must
3888 * parse backwards from the end, since the subsection may have dots in
3889 * it, too.
3891 dot = strrchr(var, '.');
3892 *key = dot + 1;
3894 /* Did we have a subsection at all? */
3895 if (dot == var) {
3896 if (subsection) {
3897 *subsection = NULL;
3898 *subsection_len = 0;
3901 else {
3902 if (!subsection)
3903 return -1;
3904 *subsection = var + 1;
3905 *subsection_len = dot - *subsection;
3908 return 0;
3911 const char *config_origin_type_name(enum config_origin_type type)
3913 switch (type) {
3914 case CONFIG_ORIGIN_BLOB:
3915 return "blob";
3916 case CONFIG_ORIGIN_FILE:
3917 return "file";
3918 case CONFIG_ORIGIN_STDIN:
3919 return "standard input";
3920 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3921 return "submodule-blob";
3922 case CONFIG_ORIGIN_CMDLINE:
3923 return "command line";
3924 default:
3925 BUG("unknown config origin type");
3929 const char *config_scope_name(enum config_scope scope)
3931 switch (scope) {
3932 case CONFIG_SCOPE_SYSTEM:
3933 return "system";
3934 case CONFIG_SCOPE_GLOBAL:
3935 return "global";
3936 case CONFIG_SCOPE_LOCAL:
3937 return "local";
3938 case CONFIG_SCOPE_WORKTREE:
3939 return "worktree";
3940 case CONFIG_SCOPE_COMMAND:
3941 return "command";
3942 case CONFIG_SCOPE_SUBMODULE:
3943 return "submodule";
3944 default:
3945 return "unknown";
3949 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3951 int i;
3953 for (i = 0; i < nr_mapping; i++) {
3954 const char *name = mapping[i];
3956 if (name && !strcasecmp(var, name))
3957 return i;
3959 return -1;