Merge branch 'pw/diff-no-index-from-named-pipes'
[alt-git.git] / config.c
blob85c5f35132c36498d6a4bda3ce43a4d01f41e18f
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 "alloc.h"
12 #include "date.h"
13 #include "branch.h"
14 #include "config.h"
15 #include "convert.h"
16 #include "environment.h"
17 #include "gettext.h"
18 #include "ident.h"
19 #include "repository.h"
20 #include "lockfile.h"
21 #include "mailmap.h"
22 #include "exec-cmd.h"
23 #include "strbuf.h"
24 #include "quote.h"
25 #include "hashmap.h"
26 #include "string-list.h"
27 #include "object-name.h"
28 #include "object-store-ll.h"
29 #include "pager.h"
30 #include "path.h"
31 #include "utf8.h"
32 #include "dir.h"
33 #include "color.h"
34 #include "replace-object.h"
35 #include "refs.h"
36 #include "setup.h"
37 #include "strvec.h"
38 #include "trace2.h"
39 #include "wildmatch.h"
40 #include "worktree.h"
41 #include "ws.h"
42 #include "wrapper.h"
43 #include "write-or-die.h"
45 struct config_source {
46 struct config_source *prev;
47 union {
48 FILE *file;
49 struct config_buf {
50 const char *buf;
51 size_t len;
52 size_t pos;
53 } buf;
54 } u;
55 enum config_origin_type origin_type;
56 const char *name;
57 const char *path;
58 enum config_error_action default_error_action;
59 int linenr;
60 int eof;
61 size_t total_len;
62 struct strbuf value;
63 struct strbuf var;
64 unsigned subsection_case_sensitive : 1;
66 int (*do_fgetc)(struct config_source *c);
67 int (*do_ungetc)(int c, struct config_source *conf);
68 long (*do_ftell)(struct config_source *c);
70 #define CONFIG_SOURCE_INIT { 0 }
72 static int pack_compression_seen;
73 static int zlib_compression_seen;
76 * Config that comes from trusted scopes, namely:
77 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
78 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
79 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
81 * This is declared here for code cleanliness, but unlike the other
82 * static variables, this does not hold config parser state.
84 static struct config_set protected_config;
86 static int config_file_fgetc(struct config_source *conf)
88 return getc_unlocked(conf->u.file);
91 static int config_file_ungetc(int c, struct config_source *conf)
93 return ungetc(c, conf->u.file);
96 static long config_file_ftell(struct config_source *conf)
98 return ftell(conf->u.file);
102 static int config_buf_fgetc(struct config_source *conf)
104 if (conf->u.buf.pos < conf->u.buf.len)
105 return conf->u.buf.buf[conf->u.buf.pos++];
107 return EOF;
110 static int config_buf_ungetc(int c, struct config_source *conf)
112 if (conf->u.buf.pos > 0) {
113 conf->u.buf.pos--;
114 if (conf->u.buf.buf[conf->u.buf.pos] != c)
115 BUG("config_buf can only ungetc the same character");
116 return c;
119 return EOF;
122 static long config_buf_ftell(struct config_source *conf)
124 return conf->u.buf.pos;
127 struct config_include_data {
128 int depth;
129 config_fn_t fn;
130 void *data;
131 const struct config_options *opts;
132 struct git_config_source *config_source;
133 struct repository *repo;
136 * All remote URLs discovered when reading all config files.
138 struct string_list *remote_urls;
140 #define CONFIG_INCLUDE_INIT { 0 }
142 static int git_config_include(const char *var, const char *value,
143 const struct config_context *ctx, void *data);
145 #define MAX_INCLUDE_DEPTH 10
146 static const char include_depth_advice[] = N_(
147 "exceeded maximum include depth (%d) while including\n"
148 " %s\n"
149 "from\n"
150 " %s\n"
151 "This might be due to circular includes.");
152 static int handle_path_include(const struct key_value_info *kvi,
153 const char *path,
154 struct config_include_data *inc)
156 int ret = 0;
157 struct strbuf buf = STRBUF_INIT;
158 char *expanded;
160 if (!path)
161 return config_error_nonbool("include.path");
163 expanded = interpolate_path(path, 0);
164 if (!expanded)
165 return error(_("could not expand include path '%s'"), path);
166 path = expanded;
169 * Use an absolute path as-is, but interpret relative paths
170 * based on the including config file.
172 if (!is_absolute_path(path)) {
173 char *slash;
175 if (!kvi || !kvi->path) {
176 ret = error(_("relative config includes must come from files"));
177 goto cleanup;
180 slash = find_last_dir_sep(kvi->path);
181 if (slash)
182 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
183 strbuf_addstr(&buf, path);
184 path = buf.buf;
187 if (!access_or_die(path, R_OK, 0)) {
188 if (++inc->depth > MAX_INCLUDE_DEPTH)
189 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
190 !kvi ? "<unknown>" :
191 kvi->filename ? kvi->filename :
192 "the command line");
193 ret = git_config_from_file_with_options(git_config_include, path, inc,
194 kvi->scope, NULL);
195 inc->depth--;
197 cleanup:
198 strbuf_release(&buf);
199 free(expanded);
200 return ret;
203 static void add_trailing_starstar_for_dir(struct strbuf *pat)
205 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
206 strbuf_addstr(pat, "**");
209 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
210 struct strbuf *pat)
212 struct strbuf path = STRBUF_INIT;
213 char *expanded;
214 int prefix = 0;
216 expanded = interpolate_path(pat->buf, 1);
217 if (expanded) {
218 strbuf_reset(pat);
219 strbuf_addstr(pat, expanded);
220 free(expanded);
223 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
224 const char *slash;
226 if (!kvi || !kvi->path)
227 return error(_("relative config include "
228 "conditionals must come from files"));
230 strbuf_realpath(&path, kvi->path, 1);
231 slash = find_last_dir_sep(path.buf);
232 if (!slash)
233 BUG("how is this possible?");
234 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
235 prefix = slash - path.buf + 1 /* slash */;
236 } else if (!is_absolute_path(pat->buf))
237 strbuf_insertstr(pat, 0, "**/");
239 add_trailing_starstar_for_dir(pat);
241 strbuf_release(&path);
242 return prefix;
245 static int include_by_gitdir(const struct key_value_info *kvi,
246 const struct config_options *opts,
247 const char *cond, size_t cond_len, int icase)
249 struct strbuf text = STRBUF_INIT;
250 struct strbuf pattern = STRBUF_INIT;
251 int ret = 0, prefix;
252 const char *git_dir;
253 int already_tried_absolute = 0;
255 if (opts->git_dir)
256 git_dir = opts->git_dir;
257 else
258 goto done;
260 strbuf_realpath(&text, git_dir, 1);
261 strbuf_add(&pattern, cond, cond_len);
262 prefix = prepare_include_condition_pattern(kvi, &pattern);
264 again:
265 if (prefix < 0)
266 goto done;
268 if (prefix > 0) {
270 * perform literal matching on the prefix part so that
271 * any wildcard character in it can't create side effects.
273 if (text.len < prefix)
274 goto done;
275 if (!icase && strncmp(pattern.buf, text.buf, prefix))
276 goto done;
277 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
278 goto done;
281 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
282 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
284 if (!ret && !already_tried_absolute) {
286 * We've tried e.g. matching gitdir:~/work, but if
287 * ~/work is a symlink to /mnt/storage/work
288 * strbuf_realpath() will expand it, so the rule won't
289 * match. Let's match against a
290 * strbuf_add_absolute_path() version of the path,
291 * which'll do the right thing
293 strbuf_reset(&text);
294 strbuf_add_absolute_path(&text, git_dir);
295 already_tried_absolute = 1;
296 goto again;
298 done:
299 strbuf_release(&pattern);
300 strbuf_release(&text);
301 return ret;
304 static int include_by_branch(const char *cond, size_t cond_len)
306 int flags;
307 int ret;
308 struct strbuf pattern = STRBUF_INIT;
309 const char *refname = !the_repository->gitdir ?
310 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
311 const char *shortname;
313 if (!refname || !(flags & REF_ISSYMREF) ||
314 !skip_prefix(refname, "refs/heads/", &shortname))
315 return 0;
317 strbuf_add(&pattern, cond, cond_len);
318 add_trailing_starstar_for_dir(&pattern);
319 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
320 strbuf_release(&pattern);
321 return ret;
324 static int add_remote_url(const char *var, const char *value,
325 const struct config_context *ctx UNUSED, void *data)
327 struct string_list *remote_urls = data;
328 const char *remote_name;
329 size_t remote_name_len;
330 const char *key;
332 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
333 &key) &&
334 remote_name &&
335 !strcmp(key, "url"))
336 string_list_append(remote_urls, value);
337 return 0;
340 static void populate_remote_urls(struct config_include_data *inc)
342 struct config_options opts;
344 opts = *inc->opts;
345 opts.unconditional_remote_url = 1;
347 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
348 string_list_init_dup(inc->remote_urls);
349 config_with_options(add_remote_url, inc->remote_urls,
350 inc->config_source, inc->repo, &opts);
353 static int forbid_remote_url(const char *var, const char *value UNUSED,
354 const struct config_context *ctx UNUSED,
355 void *data UNUSED)
357 const char *remote_name;
358 size_t remote_name_len;
359 const char *key;
361 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
362 &key) &&
363 remote_name &&
364 !strcmp(key, "url"))
365 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
366 return 0;
369 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
370 struct string_list *remote_urls)
372 struct strbuf pattern = STRBUF_INIT;
373 struct string_list_item *url_item;
374 int found = 0;
376 strbuf_add(&pattern, glob, glob_len);
377 for_each_string_list_item(url_item, remote_urls) {
378 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
379 found = 1;
380 break;
383 strbuf_release(&pattern);
384 return found;
387 static int include_by_remote_url(struct config_include_data *inc,
388 const char *cond, size_t cond_len)
390 if (inc->opts->unconditional_remote_url)
391 return 1;
392 if (!inc->remote_urls)
393 populate_remote_urls(inc);
394 return at_least_one_url_matches_glob(cond, cond_len,
395 inc->remote_urls);
398 static int include_condition_is_true(const struct key_value_info *kvi,
399 struct config_include_data *inc,
400 const char *cond, size_t cond_len)
402 const struct config_options *opts = inc->opts;
404 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
405 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
406 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
407 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
408 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
409 return include_by_branch(cond, cond_len);
410 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
411 &cond_len))
412 return include_by_remote_url(inc, cond, cond_len);
414 /* unknown conditionals are always false */
415 return 0;
418 static int git_config_include(const char *var, const char *value,
419 const struct config_context *ctx,
420 void *data)
422 struct config_include_data *inc = data;
423 const char *cond, *key;
424 size_t cond_len;
425 int ret;
428 * Pass along all values, including "include" directives; this makes it
429 * possible to query information on the includes themselves.
431 ret = inc->fn(var, value, ctx, inc->data);
432 if (ret < 0)
433 return ret;
435 if (!strcmp(var, "include.path"))
436 ret = handle_path_include(ctx->kvi, value, inc);
438 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
439 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
440 !strcmp(key, "path")) {
441 config_fn_t old_fn = inc->fn;
443 if (inc->opts->unconditional_remote_url)
444 inc->fn = forbid_remote_url;
445 ret = handle_path_include(ctx->kvi, value, inc);
446 inc->fn = old_fn;
449 return ret;
452 static void git_config_push_split_parameter(const char *key, const char *value)
454 struct strbuf env = STRBUF_INIT;
455 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
456 if (old && *old) {
457 strbuf_addstr(&env, old);
458 strbuf_addch(&env, ' ');
460 sq_quote_buf(&env, key);
461 strbuf_addch(&env, '=');
462 if (value)
463 sq_quote_buf(&env, value);
464 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
465 strbuf_release(&env);
468 void git_config_push_parameter(const char *text)
470 const char *value;
473 * When we see:
475 * section.subsection=with=equals.key=value
477 * we cannot tell if it means:
479 * [section "subsection=with=equals"]
480 * key = value
482 * or:
484 * [section]
485 * subsection = with=equals.key=value
487 * We parse left-to-right for the first "=", meaning we'll prefer to
488 * keep the value intact over the subsection. This is historical, but
489 * also sensible since values are more likely to contain odd or
490 * untrusted input than a section name.
492 * A missing equals is explicitly allowed (as a bool-only entry).
494 value = strchr(text, '=');
495 if (value) {
496 char *key = xmemdupz(text, value - text);
497 git_config_push_split_parameter(key, value + 1);
498 free(key);
499 } else {
500 git_config_push_split_parameter(text, NULL);
504 void git_config_push_env(const char *spec)
506 char *key;
507 const char *env_name;
508 const char *env_value;
510 env_name = strrchr(spec, '=');
511 if (!env_name)
512 die(_("invalid config format: %s"), spec);
513 key = xmemdupz(spec, env_name - spec);
514 env_name++;
515 if (!*env_name)
516 die(_("missing environment variable name for configuration '%.*s'"),
517 (int)(env_name - spec - 1), spec);
519 env_value = getenv(env_name);
520 if (!env_value)
521 die(_("missing environment variable '%s' for configuration '%.*s'"),
522 env_name, (int)(env_name - spec - 1), spec);
524 git_config_push_split_parameter(key, env_value);
525 free(key);
528 static inline int iskeychar(int c)
530 return isalnum(c) || c == '-';
534 * Auxiliary function to sanity-check and split the key into the section
535 * identifier and variable name.
537 * Returns 0 on success, -1 when there is an invalid character in the key and
538 * -2 if there is no section name in the key.
540 * store_key - pointer to char* which will hold a copy of the key with
541 * lowercase section and variable name
542 * baselen - pointer to size_t which will hold the length of the
543 * section + subsection part, can be NULL
545 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
547 size_t i, baselen;
548 int dot;
549 const char *last_dot = strrchr(key, '.');
552 * Since "key" actually contains the section name and the real
553 * key name separated by a dot, we have to know where the dot is.
556 if (last_dot == NULL || last_dot == key) {
557 error(_("key does not contain a section: %s"), key);
558 return -CONFIG_NO_SECTION_OR_NAME;
561 if (!last_dot[1]) {
562 error(_("key does not contain variable name: %s"), key);
563 return -CONFIG_NO_SECTION_OR_NAME;
566 baselen = last_dot - key;
567 if (baselen_)
568 *baselen_ = baselen;
571 * Validate the key and while at it, lower case it for matching.
573 *store_key = xmallocz(strlen(key));
575 dot = 0;
576 for (i = 0; key[i]; i++) {
577 unsigned char c = key[i];
578 if (c == '.')
579 dot = 1;
580 /* Leave the extended basename untouched.. */
581 if (!dot || i > baselen) {
582 if (!iskeychar(c) ||
583 (i == baselen + 1 && !isalpha(c))) {
584 error(_("invalid key: %s"), key);
585 goto out_free_ret_1;
587 c = tolower(c);
588 } else if (c == '\n') {
589 error(_("invalid key (newline): %s"), key);
590 goto out_free_ret_1;
592 (*store_key)[i] = c;
595 return 0;
597 out_free_ret_1:
598 FREE_AND_NULL(*store_key);
599 return -CONFIG_INVALID_KEY;
602 static int config_parse_pair(const char *key, const char *value,
603 struct key_value_info *kvi,
604 config_fn_t fn, void *data)
606 char *canonical_name;
607 int ret;
608 struct config_context ctx = {
609 .kvi = kvi,
612 if (!strlen(key))
613 return error(_("empty config key"));
614 if (git_config_parse_key(key, &canonical_name, NULL))
615 return -1;
617 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
618 free(canonical_name);
619 return ret;
623 /* for values read from `git_config_from_parameters()` */
624 void kvi_from_param(struct key_value_info *out)
626 out->filename = NULL;
627 out->linenr = -1;
628 out->origin_type = CONFIG_ORIGIN_CMDLINE;
629 out->scope = CONFIG_SCOPE_COMMAND;
630 out->path = NULL;
633 int git_config_parse_parameter(const char *text,
634 config_fn_t fn, void *data)
636 const char *value;
637 struct strbuf **pair;
638 int ret;
639 struct key_value_info kvi = KVI_INIT;
641 kvi_from_param(&kvi);
643 pair = strbuf_split_str(text, '=', 2);
644 if (!pair[0])
645 return error(_("bogus config parameter: %s"), text);
647 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
648 strbuf_setlen(pair[0], pair[0]->len - 1);
649 value = pair[1] ? pair[1]->buf : "";
650 } else {
651 value = NULL;
654 strbuf_trim(pair[0]);
655 if (!pair[0]->len) {
656 strbuf_list_free(pair);
657 return error(_("bogus config parameter: %s"), text);
660 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
661 strbuf_list_free(pair);
662 return ret;
665 static int parse_config_env_list(char *env, struct key_value_info *kvi,
666 config_fn_t fn, void *data)
668 char *cur = env;
669 while (cur && *cur) {
670 const char *key = sq_dequote_step(cur, &cur);
671 if (!key)
672 return error(_("bogus format in %s"),
673 CONFIG_DATA_ENVIRONMENT);
675 if (!cur || isspace(*cur)) {
676 /* old-style 'key=value' */
677 if (git_config_parse_parameter(key, fn, data) < 0)
678 return -1;
680 else if (*cur == '=') {
681 /* new-style 'key'='value' */
682 const char *value;
684 cur++;
685 if (*cur == '\'') {
686 /* quoted value */
687 value = sq_dequote_step(cur, &cur);
688 if (!value || (cur && !isspace(*cur))) {
689 return error(_("bogus format in %s"),
690 CONFIG_DATA_ENVIRONMENT);
692 } else if (!*cur || isspace(*cur)) {
693 /* implicit bool: 'key'= */
694 value = NULL;
695 } else {
696 return error(_("bogus format in %s"),
697 CONFIG_DATA_ENVIRONMENT);
700 if (config_parse_pair(key, value, kvi, fn, data) < 0)
701 return -1;
703 else {
704 /* unknown format */
705 return error(_("bogus format in %s"),
706 CONFIG_DATA_ENVIRONMENT);
709 if (cur) {
710 while (isspace(*cur))
711 cur++;
714 return 0;
717 int git_config_from_parameters(config_fn_t fn, void *data)
719 const char *env;
720 struct strbuf envvar = STRBUF_INIT;
721 struct strvec to_free = STRVEC_INIT;
722 int ret = 0;
723 char *envw = NULL;
724 struct key_value_info kvi = KVI_INIT;
726 kvi_from_param(&kvi);
727 env = getenv(CONFIG_COUNT_ENVIRONMENT);
728 if (env) {
729 unsigned long count;
730 char *endp;
731 int i;
733 count = strtoul(env, &endp, 10);
734 if (*endp) {
735 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
736 goto out;
738 if (count > INT_MAX) {
739 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
740 goto out;
743 for (i = 0; i < count; i++) {
744 const char *key, *value;
746 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
747 key = getenv_safe(&to_free, envvar.buf);
748 if (!key) {
749 ret = error(_("missing config key %s"), envvar.buf);
750 goto out;
752 strbuf_reset(&envvar);
754 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
755 value = getenv_safe(&to_free, envvar.buf);
756 if (!value) {
757 ret = error(_("missing config value %s"), envvar.buf);
758 goto out;
760 strbuf_reset(&envvar);
762 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
763 ret = -1;
764 goto out;
769 env = getenv(CONFIG_DATA_ENVIRONMENT);
770 if (env) {
771 /* sq_dequote will write over it */
772 envw = xstrdup(env);
773 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
774 ret = -1;
775 goto out;
779 out:
780 strbuf_release(&envvar);
781 strvec_clear(&to_free);
782 free(envw);
783 return ret;
786 static int get_next_char(struct config_source *cs)
788 int c = cs->do_fgetc(cs);
790 if (c == '\r') {
791 /* DOS like systems */
792 c = cs->do_fgetc(cs);
793 if (c != '\n') {
794 if (c != EOF)
795 cs->do_ungetc(c, cs);
796 c = '\r';
800 if (c != EOF && ++cs->total_len > INT_MAX) {
802 * This is an absurdly long config file; refuse to parse
803 * further in order to protect downstream code from integer
804 * overflows. Note that we can't return an error specifically,
805 * but we can mark EOF and put trash in the return value,
806 * which will trigger a parse error.
808 cs->eof = 1;
809 return 0;
812 if (c == '\n')
813 cs->linenr++;
814 if (c == EOF) {
815 cs->eof = 1;
816 cs->linenr++;
817 c = '\n';
819 return c;
822 static char *parse_value(struct config_source *cs)
824 int quote = 0, comment = 0, space = 0;
826 strbuf_reset(&cs->value);
827 for (;;) {
828 int c = get_next_char(cs);
829 if (c == '\n') {
830 if (quote) {
831 cs->linenr--;
832 return NULL;
834 return cs->value.buf;
836 if (comment)
837 continue;
838 if (isspace(c) && !quote) {
839 if (cs->value.len)
840 space++;
841 continue;
843 if (!quote) {
844 if (c == ';' || c == '#') {
845 comment = 1;
846 continue;
849 for (; space; space--)
850 strbuf_addch(&cs->value, ' ');
851 if (c == '\\') {
852 c = get_next_char(cs);
853 switch (c) {
854 case '\n':
855 continue;
856 case 't':
857 c = '\t';
858 break;
859 case 'b':
860 c = '\b';
861 break;
862 case 'n':
863 c = '\n';
864 break;
865 /* Some characters escape as themselves */
866 case '\\': case '"':
867 break;
868 /* Reject unknown escape sequences */
869 default:
870 return NULL;
872 strbuf_addch(&cs->value, c);
873 continue;
875 if (c == '"') {
876 quote = 1-quote;
877 continue;
879 strbuf_addch(&cs->value, c);
883 static int get_value(struct config_source *cs, struct key_value_info *kvi,
884 config_fn_t fn, void *data, struct strbuf *name)
886 int c;
887 char *value;
888 int ret;
889 struct config_context ctx = {
890 .kvi = kvi,
893 /* Get the full name */
894 for (;;) {
895 c = get_next_char(cs);
896 if (cs->eof)
897 break;
898 if (!iskeychar(c))
899 break;
900 strbuf_addch(name, tolower(c));
903 while (c == ' ' || c == '\t')
904 c = get_next_char(cs);
906 value = NULL;
907 if (c != '\n') {
908 if (c != '=')
909 return -1;
910 value = parse_value(cs);
911 if (!value)
912 return -1;
915 * We already consumed the \n, but we need linenr to point to
916 * the line we just parsed during the call to fn to get
917 * accurate line number in error messages.
919 cs->linenr--;
920 kvi->linenr = cs->linenr;
921 ret = fn(name->buf, value, &ctx, data);
922 if (ret >= 0)
923 cs->linenr++;
924 return ret;
927 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
928 int c)
930 cs->subsection_case_sensitive = 0;
931 do {
932 if (c == '\n')
933 goto error_incomplete_line;
934 c = get_next_char(cs);
935 } while (isspace(c));
937 /* We require the format to be '[base "extension"]' */
938 if (c != '"')
939 return -1;
940 strbuf_addch(name, '.');
942 for (;;) {
943 int c = get_next_char(cs);
944 if (c == '\n')
945 goto error_incomplete_line;
946 if (c == '"')
947 break;
948 if (c == '\\') {
949 c = get_next_char(cs);
950 if (c == '\n')
951 goto error_incomplete_line;
953 strbuf_addch(name, c);
956 /* Final ']' */
957 if (get_next_char(cs) != ']')
958 return -1;
959 return 0;
960 error_incomplete_line:
961 cs->linenr--;
962 return -1;
965 static int get_base_var(struct config_source *cs, struct strbuf *name)
967 cs->subsection_case_sensitive = 1;
968 for (;;) {
969 int c = get_next_char(cs);
970 if (cs->eof)
971 return -1;
972 if (c == ']')
973 return 0;
974 if (isspace(c))
975 return get_extended_base_var(cs, name, c);
976 if (!iskeychar(c) && c != '.')
977 return -1;
978 strbuf_addch(name, tolower(c));
982 struct parse_event_data {
983 enum config_event_t previous_type;
984 size_t previous_offset;
985 const struct config_options *opts;
988 static int do_event(struct config_source *cs, enum config_event_t type,
989 struct parse_event_data *data)
991 size_t offset;
993 if (!data->opts || !data->opts->event_fn)
994 return 0;
996 if (type == CONFIG_EVENT_WHITESPACE &&
997 data->previous_type == type)
998 return 0;
1000 offset = cs->do_ftell(cs);
1002 * At EOF, the parser always "inserts" an extra '\n', therefore
1003 * the end offset of the event is the current file position, otherwise
1004 * we will already have advanced to the next event.
1006 if (type != CONFIG_EVENT_EOF)
1007 offset--;
1009 if (data->previous_type != CONFIG_EVENT_EOF &&
1010 data->opts->event_fn(data->previous_type, data->previous_offset,
1011 offset, cs, data->opts->event_fn_data) < 0)
1012 return -1;
1014 data->previous_type = type;
1015 data->previous_offset = offset;
1017 return 0;
1020 static void kvi_from_source(struct config_source *cs,
1021 enum config_scope scope,
1022 struct key_value_info *out)
1024 out->filename = strintern(cs->name);
1025 out->origin_type = cs->origin_type;
1026 out->linenr = cs->linenr;
1027 out->scope = scope;
1028 out->path = cs->path;
1031 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1032 struct key_value_info *kvi, void *data,
1033 const struct config_options *opts)
1035 int comment = 0;
1036 size_t baselen = 0;
1037 struct strbuf *var = &cs->var;
1038 int error_return = 0;
1039 char *error_msg = NULL;
1041 /* U+FEFF Byte Order Mark in UTF8 */
1042 const char *bomptr = utf8_bom;
1044 /* For the parser event callback */
1045 struct parse_event_data event_data = {
1046 CONFIG_EVENT_EOF, 0, opts
1049 for (;;) {
1050 int c;
1052 c = get_next_char(cs);
1053 if (bomptr && *bomptr) {
1054 /* We are at the file beginning; skip UTF8-encoded BOM
1055 * if present. Sane editors won't put this in on their
1056 * own, but e.g. Windows Notepad will do it happily. */
1057 if (c == (*bomptr & 0377)) {
1058 bomptr++;
1059 continue;
1060 } else {
1061 /* Do not tolerate partial BOM. */
1062 if (bomptr != utf8_bom)
1063 break;
1064 /* No BOM at file beginning. Cool. */
1065 bomptr = NULL;
1068 if (c == '\n') {
1069 if (cs->eof) {
1070 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1071 return -1;
1072 return 0;
1074 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1075 return -1;
1076 comment = 0;
1077 continue;
1079 if (comment)
1080 continue;
1081 if (isspace(c)) {
1082 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1083 return -1;
1084 continue;
1086 if (c == '#' || c == ';') {
1087 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1088 return -1;
1089 comment = 1;
1090 continue;
1092 if (c == '[') {
1093 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1094 return -1;
1096 /* Reset prior to determining a new stem */
1097 strbuf_reset(var);
1098 if (get_base_var(cs, var) < 0 || var->len < 1)
1099 break;
1100 strbuf_addch(var, '.');
1101 baselen = var->len;
1102 continue;
1104 if (!isalpha(c))
1105 break;
1107 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1108 return -1;
1111 * Truncate the var name back to the section header
1112 * stem prior to grabbing the suffix part of the name
1113 * and the value.
1115 strbuf_setlen(var, baselen);
1116 strbuf_addch(var, tolower(c));
1117 if (get_value(cs, kvi, fn, data, var) < 0)
1118 break;
1121 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1122 return -1;
1124 switch (cs->origin_type) {
1125 case CONFIG_ORIGIN_BLOB:
1126 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1127 cs->linenr, cs->name);
1128 break;
1129 case CONFIG_ORIGIN_FILE:
1130 error_msg = xstrfmt(_("bad config line %d in file %s"),
1131 cs->linenr, cs->name);
1132 break;
1133 case CONFIG_ORIGIN_STDIN:
1134 error_msg = xstrfmt(_("bad config line %d in standard input"),
1135 cs->linenr);
1136 break;
1137 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1138 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1139 cs->linenr, cs->name);
1140 break;
1141 case CONFIG_ORIGIN_CMDLINE:
1142 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1143 cs->linenr, cs->name);
1144 break;
1145 default:
1146 error_msg = xstrfmt(_("bad config line %d in %s"),
1147 cs->linenr, cs->name);
1150 switch (opts && opts->error_action ?
1151 opts->error_action :
1152 cs->default_error_action) {
1153 case CONFIG_ERROR_DIE:
1154 die("%s", error_msg);
1155 break;
1156 case CONFIG_ERROR_ERROR:
1157 error_return = error("%s", error_msg);
1158 break;
1159 case CONFIG_ERROR_SILENT:
1160 error_return = -1;
1161 break;
1162 case CONFIG_ERROR_UNSET:
1163 BUG("config error action unset");
1166 free(error_msg);
1167 return error_return;
1170 static uintmax_t get_unit_factor(const char *end)
1172 if (!*end)
1173 return 1;
1174 else if (!strcasecmp(end, "k"))
1175 return 1024;
1176 else if (!strcasecmp(end, "m"))
1177 return 1024 * 1024;
1178 else if (!strcasecmp(end, "g"))
1179 return 1024 * 1024 * 1024;
1180 return 0;
1183 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1185 if (value && *value) {
1186 char *end;
1187 intmax_t val;
1188 intmax_t factor;
1190 if (max < 0)
1191 BUG("max must be a positive integer");
1193 errno = 0;
1194 val = strtoimax(value, &end, 0);
1195 if (errno == ERANGE)
1196 return 0;
1197 if (end == value) {
1198 errno = EINVAL;
1199 return 0;
1201 factor = get_unit_factor(end);
1202 if (!factor) {
1203 errno = EINVAL;
1204 return 0;
1206 if ((val < 0 && -max / factor > val) ||
1207 (val > 0 && max / factor < val)) {
1208 errno = ERANGE;
1209 return 0;
1211 val *= factor;
1212 *ret = val;
1213 return 1;
1215 errno = EINVAL;
1216 return 0;
1219 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1221 if (value && *value) {
1222 char *end;
1223 uintmax_t val;
1224 uintmax_t factor;
1226 /* negative values would be accepted by strtoumax */
1227 if (strchr(value, '-')) {
1228 errno = EINVAL;
1229 return 0;
1231 errno = 0;
1232 val = strtoumax(value, &end, 0);
1233 if (errno == ERANGE)
1234 return 0;
1235 if (end == value) {
1236 errno = EINVAL;
1237 return 0;
1239 factor = get_unit_factor(end);
1240 if (!factor) {
1241 errno = EINVAL;
1242 return 0;
1244 if (unsigned_mult_overflows(factor, val) ||
1245 factor * val > max) {
1246 errno = ERANGE;
1247 return 0;
1249 val *= factor;
1250 *ret = val;
1251 return 1;
1253 errno = EINVAL;
1254 return 0;
1257 int git_parse_int(const char *value, int *ret)
1259 intmax_t tmp;
1260 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1261 return 0;
1262 *ret = tmp;
1263 return 1;
1266 static int git_parse_int64(const char *value, int64_t *ret)
1268 intmax_t tmp;
1269 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1270 return 0;
1271 *ret = tmp;
1272 return 1;
1275 int git_parse_ulong(const char *value, unsigned long *ret)
1277 uintmax_t tmp;
1278 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1279 return 0;
1280 *ret = tmp;
1281 return 1;
1284 int git_parse_ssize_t(const char *value, ssize_t *ret)
1286 intmax_t tmp;
1287 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1288 return 0;
1289 *ret = tmp;
1290 return 1;
1293 NORETURN
1294 static void die_bad_number(const char *name, const char *value,
1295 const struct key_value_info *kvi)
1297 const char *error_type = (errno == ERANGE) ?
1298 N_("out of range") : N_("invalid unit");
1299 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1301 if (!kvi)
1302 BUG("kvi should not be NULL");
1304 if (!value)
1305 value = "";
1307 if (!kvi->filename)
1308 die(_(bad_numeric), value, name, _(error_type));
1310 switch (kvi->origin_type) {
1311 case CONFIG_ORIGIN_BLOB:
1312 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1313 value, name, kvi->filename, _(error_type));
1314 case CONFIG_ORIGIN_FILE:
1315 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1316 value, name, kvi->filename, _(error_type));
1317 case CONFIG_ORIGIN_STDIN:
1318 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1319 value, name, _(error_type));
1320 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1321 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1322 value, name, kvi->filename, _(error_type));
1323 case CONFIG_ORIGIN_CMDLINE:
1324 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1325 value, name, kvi->filename, _(error_type));
1326 default:
1327 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1328 value, name, kvi->filename, _(error_type));
1332 int git_config_int(const char *name, const char *value,
1333 const struct key_value_info *kvi)
1335 int ret;
1336 if (!git_parse_int(value, &ret))
1337 die_bad_number(name, value, kvi);
1338 return ret;
1341 int64_t git_config_int64(const char *name, const char *value,
1342 const struct key_value_info *kvi)
1344 int64_t ret;
1345 if (!git_parse_int64(value, &ret))
1346 die_bad_number(name, value, kvi);
1347 return ret;
1350 unsigned long git_config_ulong(const char *name, const char *value,
1351 const struct key_value_info *kvi)
1353 unsigned long ret;
1354 if (!git_parse_ulong(value, &ret))
1355 die_bad_number(name, value, kvi);
1356 return ret;
1359 ssize_t git_config_ssize_t(const char *name, const char *value,
1360 const struct key_value_info *kvi)
1362 ssize_t ret;
1363 if (!git_parse_ssize_t(value, &ret))
1364 die_bad_number(name, value, kvi);
1365 return ret;
1368 static int git_parse_maybe_bool_text(const char *value)
1370 if (!value)
1371 return 1;
1372 if (!*value)
1373 return 0;
1374 if (!strcasecmp(value, "true")
1375 || !strcasecmp(value, "yes")
1376 || !strcasecmp(value, "on"))
1377 return 1;
1378 if (!strcasecmp(value, "false")
1379 || !strcasecmp(value, "no")
1380 || !strcasecmp(value, "off"))
1381 return 0;
1382 return -1;
1385 static const struct fsync_component_name {
1386 const char *name;
1387 enum fsync_component component_bits;
1388 } fsync_component_names[] = {
1389 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1390 { "pack", FSYNC_COMPONENT_PACK },
1391 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1392 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1393 { "index", FSYNC_COMPONENT_INDEX },
1394 { "objects", FSYNC_COMPONENTS_OBJECTS },
1395 { "reference", FSYNC_COMPONENT_REFERENCE },
1396 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1397 { "committed", FSYNC_COMPONENTS_COMMITTED },
1398 { "added", FSYNC_COMPONENTS_ADDED },
1399 { "all", FSYNC_COMPONENTS_ALL },
1402 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1404 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1405 enum fsync_component positive = 0, negative = 0;
1407 while (string) {
1408 int i;
1409 size_t len;
1410 const char *ep;
1411 int negated = 0;
1412 int found = 0;
1414 string = string + strspn(string, ", \t\n\r");
1415 ep = strchrnul(string, ',');
1416 len = ep - string;
1417 if (!strcmp(string, "none")) {
1418 current = FSYNC_COMPONENT_NONE;
1419 goto next_name;
1422 if (*string == '-') {
1423 negated = 1;
1424 string++;
1425 len--;
1426 if (!len)
1427 warning(_("invalid value for variable %s"), var);
1430 if (!len)
1431 break;
1433 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1434 const struct fsync_component_name *n = &fsync_component_names[i];
1436 if (strncmp(n->name, string, len))
1437 continue;
1439 found = 1;
1440 if (negated)
1441 negative |= n->component_bits;
1442 else
1443 positive |= n->component_bits;
1446 if (!found) {
1447 char *component = xstrndup(string, len);
1448 warning(_("ignoring unknown core.fsync component '%s'"), component);
1449 free(component);
1452 next_name:
1453 string = ep;
1456 return (current & ~negative) | positive;
1459 int git_parse_maybe_bool(const char *value)
1461 int v = git_parse_maybe_bool_text(value);
1462 if (0 <= v)
1463 return v;
1464 if (git_parse_int(value, &v))
1465 return !!v;
1466 return -1;
1469 int git_config_bool_or_int(const char *name, const char *value,
1470 const struct key_value_info *kvi, int *is_bool)
1472 int v = git_parse_maybe_bool_text(value);
1473 if (0 <= v) {
1474 *is_bool = 1;
1475 return v;
1477 *is_bool = 0;
1478 return git_config_int(name, value, kvi);
1481 int git_config_bool(const char *name, const char *value)
1483 int v = git_parse_maybe_bool(value);
1484 if (v < 0)
1485 die(_("bad boolean config value '%s' for '%s'"), value, name);
1486 return v;
1489 int git_config_string(const char **dest, const char *var, const char *value)
1491 if (!value)
1492 return config_error_nonbool(var);
1493 *dest = xstrdup(value);
1494 return 0;
1497 int git_config_pathname(const char **dest, const char *var, const char *value)
1499 if (!value)
1500 return config_error_nonbool(var);
1501 *dest = interpolate_path(value, 0);
1502 if (!*dest)
1503 die(_("failed to expand user dir in: '%s'"), value);
1504 return 0;
1507 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1509 if (!value)
1510 return config_error_nonbool(var);
1511 if (parse_expiry_date(value, timestamp))
1512 return error(_("'%s' for '%s' is not a valid timestamp"),
1513 value, var);
1514 return 0;
1517 int git_config_color(char *dest, const char *var, const char *value)
1519 if (!value)
1520 return config_error_nonbool(var);
1521 if (color_parse(value, dest) < 0)
1522 return -1;
1523 return 0;
1526 static int git_default_core_config(const char *var, const char *value,
1527 const struct config_context *ctx, void *cb)
1529 /* This needs a better name */
1530 if (!strcmp(var, "core.filemode")) {
1531 trust_executable_bit = git_config_bool(var, value);
1532 return 0;
1534 if (!strcmp(var, "core.trustctime")) {
1535 trust_ctime = git_config_bool(var, value);
1536 return 0;
1538 if (!strcmp(var, "core.checkstat")) {
1539 if (!strcasecmp(value, "default"))
1540 check_stat = 1;
1541 else if (!strcasecmp(value, "minimal"))
1542 check_stat = 0;
1545 if (!strcmp(var, "core.quotepath")) {
1546 quote_path_fully = git_config_bool(var, value);
1547 return 0;
1550 if (!strcmp(var, "core.symlinks")) {
1551 has_symlinks = git_config_bool(var, value);
1552 return 0;
1555 if (!strcmp(var, "core.ignorecase")) {
1556 ignore_case = git_config_bool(var, value);
1557 return 0;
1560 if (!strcmp(var, "core.attributesfile"))
1561 return git_config_pathname(&git_attributes_file, var, value);
1563 if (!strcmp(var, "core.hookspath"))
1564 return git_config_pathname(&git_hooks_path, var, value);
1566 if (!strcmp(var, "core.bare")) {
1567 is_bare_repository_cfg = git_config_bool(var, value);
1568 return 0;
1571 if (!strcmp(var, "core.ignorestat")) {
1572 assume_unchanged = git_config_bool(var, value);
1573 return 0;
1576 if (!strcmp(var, "core.prefersymlinkrefs")) {
1577 prefer_symlink_refs = git_config_bool(var, value);
1578 return 0;
1581 if (!strcmp(var, "core.logallrefupdates")) {
1582 if (value && !strcasecmp(value, "always"))
1583 log_all_ref_updates = LOG_REFS_ALWAYS;
1584 else if (git_config_bool(var, value))
1585 log_all_ref_updates = LOG_REFS_NORMAL;
1586 else
1587 log_all_ref_updates = LOG_REFS_NONE;
1588 return 0;
1591 if (!strcmp(var, "core.warnambiguousrefs")) {
1592 warn_ambiguous_refs = git_config_bool(var, value);
1593 return 0;
1596 if (!strcmp(var, "core.abbrev")) {
1597 if (!value)
1598 return config_error_nonbool(var);
1599 if (!strcasecmp(value, "auto"))
1600 default_abbrev = -1;
1601 else if (!git_parse_maybe_bool_text(value))
1602 default_abbrev = the_hash_algo->hexsz;
1603 else {
1604 int abbrev = git_config_int(var, value, ctx->kvi);
1605 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1606 return error(_("abbrev length out of range: %d"), abbrev);
1607 default_abbrev = abbrev;
1609 return 0;
1612 if (!strcmp(var, "core.disambiguate"))
1613 return set_disambiguate_hint_config(var, value);
1615 if (!strcmp(var, "core.loosecompression")) {
1616 int level = git_config_int(var, value, ctx->kvi);
1617 if (level == -1)
1618 level = Z_DEFAULT_COMPRESSION;
1619 else if (level < 0 || level > Z_BEST_COMPRESSION)
1620 die(_("bad zlib compression level %d"), level);
1621 zlib_compression_level = level;
1622 zlib_compression_seen = 1;
1623 return 0;
1626 if (!strcmp(var, "core.compression")) {
1627 int level = git_config_int(var, value, ctx->kvi);
1628 if (level == -1)
1629 level = Z_DEFAULT_COMPRESSION;
1630 else if (level < 0 || level > Z_BEST_COMPRESSION)
1631 die(_("bad zlib compression level %d"), level);
1632 if (!zlib_compression_seen)
1633 zlib_compression_level = level;
1634 if (!pack_compression_seen)
1635 pack_compression_level = level;
1636 return 0;
1639 if (!strcmp(var, "core.packedgitwindowsize")) {
1640 int pgsz_x2 = getpagesize() * 2;
1641 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1643 /* This value must be multiple of (pagesize * 2) */
1644 packed_git_window_size /= pgsz_x2;
1645 if (packed_git_window_size < 1)
1646 packed_git_window_size = 1;
1647 packed_git_window_size *= pgsz_x2;
1648 return 0;
1651 if (!strcmp(var, "core.bigfilethreshold")) {
1652 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1653 return 0;
1656 if (!strcmp(var, "core.packedgitlimit")) {
1657 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1658 return 0;
1661 if (!strcmp(var, "core.deltabasecachelimit")) {
1662 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1663 return 0;
1666 if (!strcmp(var, "core.autocrlf")) {
1667 if (value && !strcasecmp(value, "input")) {
1668 auto_crlf = AUTO_CRLF_INPUT;
1669 return 0;
1671 auto_crlf = git_config_bool(var, value);
1672 return 0;
1675 if (!strcmp(var, "core.safecrlf")) {
1676 int eol_rndtrp_die;
1677 if (value && !strcasecmp(value, "warn")) {
1678 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1679 return 0;
1681 eol_rndtrp_die = git_config_bool(var, value);
1682 global_conv_flags_eol = eol_rndtrp_die ?
1683 CONV_EOL_RNDTRP_DIE : 0;
1684 return 0;
1687 if (!strcmp(var, "core.eol")) {
1688 if (value && !strcasecmp(value, "lf"))
1689 core_eol = EOL_LF;
1690 else if (value && !strcasecmp(value, "crlf"))
1691 core_eol = EOL_CRLF;
1692 else if (value && !strcasecmp(value, "native"))
1693 core_eol = EOL_NATIVE;
1694 else
1695 core_eol = EOL_UNSET;
1696 return 0;
1699 if (!strcmp(var, "core.checkroundtripencoding")) {
1700 check_roundtrip_encoding = xstrdup(value);
1701 return 0;
1704 if (!strcmp(var, "core.notesref")) {
1705 notes_ref_name = xstrdup(value);
1706 return 0;
1709 if (!strcmp(var, "core.editor"))
1710 return git_config_string(&editor_program, var, value);
1712 if (!strcmp(var, "core.commentchar")) {
1713 if (!value)
1714 return config_error_nonbool(var);
1715 else if (!strcasecmp(value, "auto"))
1716 auto_comment_line_char = 1;
1717 else if (value[0] && !value[1]) {
1718 comment_line_char = value[0];
1719 auto_comment_line_char = 0;
1720 } else
1721 return error(_("core.commentChar should only be one ASCII character"));
1722 return 0;
1725 if (!strcmp(var, "core.askpass"))
1726 return git_config_string(&askpass_program, var, value);
1728 if (!strcmp(var, "core.excludesfile"))
1729 return git_config_pathname(&excludes_file, var, value);
1731 if (!strcmp(var, "core.whitespace")) {
1732 if (!value)
1733 return config_error_nonbool(var);
1734 whitespace_rule_cfg = parse_whitespace_rule(value);
1735 return 0;
1738 if (!strcmp(var, "core.fsync")) {
1739 if (!value)
1740 return config_error_nonbool(var);
1741 fsync_components = parse_fsync_components(var, value);
1742 return 0;
1745 if (!strcmp(var, "core.fsyncmethod")) {
1746 if (!value)
1747 return config_error_nonbool(var);
1748 if (!strcmp(value, "fsync"))
1749 fsync_method = FSYNC_METHOD_FSYNC;
1750 else if (!strcmp(value, "writeout-only"))
1751 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1752 else if (!strcmp(value, "batch"))
1753 fsync_method = FSYNC_METHOD_BATCH;
1754 else
1755 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1759 if (!strcmp(var, "core.fsyncobjectfiles")) {
1760 if (fsync_object_files < 0)
1761 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1762 fsync_object_files = git_config_bool(var, value);
1763 return 0;
1766 if (!strcmp(var, "core.preloadindex")) {
1767 core_preload_index = git_config_bool(var, value);
1768 return 0;
1771 if (!strcmp(var, "core.createobject")) {
1772 if (!strcmp(value, "rename"))
1773 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1774 else if (!strcmp(value, "link"))
1775 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1776 else
1777 die(_("invalid mode for object creation: %s"), value);
1778 return 0;
1781 if (!strcmp(var, "core.sparsecheckout")) {
1782 core_apply_sparse_checkout = git_config_bool(var, value);
1783 return 0;
1786 if (!strcmp(var, "core.sparsecheckoutcone")) {
1787 core_sparse_checkout_cone = git_config_bool(var, value);
1788 return 0;
1791 if (!strcmp(var, "core.precomposeunicode")) {
1792 precomposed_unicode = git_config_bool(var, value);
1793 return 0;
1796 if (!strcmp(var, "core.protecthfs")) {
1797 protect_hfs = git_config_bool(var, value);
1798 return 0;
1801 if (!strcmp(var, "core.protectntfs")) {
1802 protect_ntfs = git_config_bool(var, value);
1803 return 0;
1806 /* Add other config variables here and to Documentation/config.txt. */
1807 return platform_core_config(var, value, ctx, cb);
1810 static int git_default_sparse_config(const char *var, const char *value)
1812 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1813 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1814 return 0;
1817 /* Add other config variables here and to Documentation/config/sparse.txt. */
1818 return 0;
1821 static int git_default_i18n_config(const char *var, const char *value)
1823 if (!strcmp(var, "i18n.commitencoding"))
1824 return git_config_string(&git_commit_encoding, var, value);
1826 if (!strcmp(var, "i18n.logoutputencoding"))
1827 return git_config_string(&git_log_output_encoding, var, value);
1829 /* Add other config variables here and to Documentation/config.txt. */
1830 return 0;
1833 static int git_default_branch_config(const char *var, const char *value)
1835 if (!strcmp(var, "branch.autosetupmerge")) {
1836 if (value && !strcmp(value, "always")) {
1837 git_branch_track = BRANCH_TRACK_ALWAYS;
1838 return 0;
1839 } else if (value && !strcmp(value, "inherit")) {
1840 git_branch_track = BRANCH_TRACK_INHERIT;
1841 return 0;
1842 } else if (value && !strcmp(value, "simple")) {
1843 git_branch_track = BRANCH_TRACK_SIMPLE;
1844 return 0;
1846 git_branch_track = git_config_bool(var, value);
1847 return 0;
1849 if (!strcmp(var, "branch.autosetuprebase")) {
1850 if (!value)
1851 return config_error_nonbool(var);
1852 else if (!strcmp(value, "never"))
1853 autorebase = AUTOREBASE_NEVER;
1854 else if (!strcmp(value, "local"))
1855 autorebase = AUTOREBASE_LOCAL;
1856 else if (!strcmp(value, "remote"))
1857 autorebase = AUTOREBASE_REMOTE;
1858 else if (!strcmp(value, "always"))
1859 autorebase = AUTOREBASE_ALWAYS;
1860 else
1861 return error(_("malformed value for %s"), var);
1862 return 0;
1865 /* Add other config variables here and to Documentation/config.txt. */
1866 return 0;
1869 static int git_default_push_config(const char *var, const char *value)
1871 if (!strcmp(var, "push.default")) {
1872 if (!value)
1873 return config_error_nonbool(var);
1874 else if (!strcmp(value, "nothing"))
1875 push_default = PUSH_DEFAULT_NOTHING;
1876 else if (!strcmp(value, "matching"))
1877 push_default = PUSH_DEFAULT_MATCHING;
1878 else if (!strcmp(value, "simple"))
1879 push_default = PUSH_DEFAULT_SIMPLE;
1880 else if (!strcmp(value, "upstream"))
1881 push_default = PUSH_DEFAULT_UPSTREAM;
1882 else if (!strcmp(value, "tracking")) /* deprecated */
1883 push_default = PUSH_DEFAULT_UPSTREAM;
1884 else if (!strcmp(value, "current"))
1885 push_default = PUSH_DEFAULT_CURRENT;
1886 else {
1887 error(_("malformed value for %s: %s"), var, value);
1888 return error(_("must be one of nothing, matching, simple, "
1889 "upstream or current"));
1891 return 0;
1894 /* Add other config variables here and to Documentation/config.txt. */
1895 return 0;
1898 static int git_default_mailmap_config(const char *var, const char *value)
1900 if (!strcmp(var, "mailmap.file"))
1901 return git_config_pathname(&git_mailmap_file, var, value);
1902 if (!strcmp(var, "mailmap.blob"))
1903 return git_config_string(&git_mailmap_blob, var, value);
1905 /* Add other config variables here and to Documentation/config.txt. */
1906 return 0;
1909 int git_default_config(const char *var, const char *value,
1910 const struct config_context *ctx, void *cb)
1912 if (starts_with(var, "core."))
1913 return git_default_core_config(var, value, ctx, cb);
1915 if (starts_with(var, "user.") ||
1916 starts_with(var, "author.") ||
1917 starts_with(var, "committer."))
1918 return git_ident_config(var, value, ctx, cb);
1920 if (starts_with(var, "i18n."))
1921 return git_default_i18n_config(var, value);
1923 if (starts_with(var, "branch."))
1924 return git_default_branch_config(var, value);
1926 if (starts_with(var, "push."))
1927 return git_default_push_config(var, value);
1929 if (starts_with(var, "mailmap."))
1930 return git_default_mailmap_config(var, value);
1932 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1933 return git_default_advice_config(var, value);
1935 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1936 pager_use_color = git_config_bool(var,value);
1937 return 0;
1940 if (!strcmp(var, "pack.packsizelimit")) {
1941 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1942 return 0;
1945 if (!strcmp(var, "pack.compression")) {
1946 int level = git_config_int(var, value, ctx->kvi);
1947 if (level == -1)
1948 level = Z_DEFAULT_COMPRESSION;
1949 else if (level < 0 || level > Z_BEST_COMPRESSION)
1950 die(_("bad pack compression level %d"), level);
1951 pack_compression_level = level;
1952 pack_compression_seen = 1;
1953 return 0;
1956 if (starts_with(var, "sparse."))
1957 return git_default_sparse_config(var, value);
1959 /* Add other config variables here and to Documentation/config.txt. */
1960 return 0;
1964 * All source specific fields in the union, die_on_error, name and the callbacks
1965 * fgetc, ungetc, ftell of top need to be initialized before calling
1966 * this function.
1968 static int do_config_from(struct config_source *top, config_fn_t fn,
1969 void *data, enum config_scope scope,
1970 const struct config_options *opts)
1972 struct key_value_info kvi = KVI_INIT;
1973 int ret;
1975 /* push config-file parsing state stack */
1976 top->linenr = 1;
1977 top->eof = 0;
1978 top->total_len = 0;
1979 strbuf_init(&top->value, 1024);
1980 strbuf_init(&top->var, 1024);
1981 kvi_from_source(top, scope, &kvi);
1983 ret = git_parse_source(top, fn, &kvi, data, opts);
1985 strbuf_release(&top->value);
1986 strbuf_release(&top->var);
1988 return ret;
1991 static int do_config_from_file(config_fn_t fn,
1992 const enum config_origin_type origin_type,
1993 const char *name, const char *path, FILE *f,
1994 void *data, enum config_scope scope,
1995 const struct config_options *opts)
1997 struct config_source top = CONFIG_SOURCE_INIT;
1998 int ret;
2000 top.u.file = f;
2001 top.origin_type = origin_type;
2002 top.name = name;
2003 top.path = path;
2004 top.default_error_action = CONFIG_ERROR_DIE;
2005 top.do_fgetc = config_file_fgetc;
2006 top.do_ungetc = config_file_ungetc;
2007 top.do_ftell = config_file_ftell;
2009 flockfile(f);
2010 ret = do_config_from(&top, fn, data, scope, opts);
2011 funlockfile(f);
2012 return ret;
2015 static int git_config_from_stdin(config_fn_t fn, void *data,
2016 enum config_scope scope)
2018 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
2019 data, scope, NULL);
2022 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
2023 void *data, enum config_scope scope,
2024 const struct config_options *opts)
2026 int ret = -1;
2027 FILE *f;
2029 if (!filename)
2030 BUG("filename cannot be NULL");
2031 f = fopen_or_warn(filename, "r");
2032 if (f) {
2033 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
2034 filename, f, data, scope, opts);
2035 fclose(f);
2037 return ret;
2040 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
2042 return git_config_from_file_with_options(fn, filename, data,
2043 CONFIG_SCOPE_UNKNOWN, NULL);
2046 int git_config_from_mem(config_fn_t fn,
2047 const enum config_origin_type origin_type,
2048 const char *name, const char *buf, size_t len,
2049 void *data, enum config_scope scope,
2050 const struct config_options *opts)
2052 struct config_source top = CONFIG_SOURCE_INIT;
2054 top.u.buf.buf = buf;
2055 top.u.buf.len = len;
2056 top.u.buf.pos = 0;
2057 top.origin_type = origin_type;
2058 top.name = name;
2059 top.path = NULL;
2060 top.default_error_action = CONFIG_ERROR_ERROR;
2061 top.do_fgetc = config_buf_fgetc;
2062 top.do_ungetc = config_buf_ungetc;
2063 top.do_ftell = config_buf_ftell;
2065 return do_config_from(&top, fn, data, scope, opts);
2068 int git_config_from_blob_oid(config_fn_t fn,
2069 const char *name,
2070 struct repository *repo,
2071 const struct object_id *oid,
2072 void *data,
2073 enum config_scope scope)
2075 enum object_type type;
2076 char *buf;
2077 unsigned long size;
2078 int ret;
2080 buf = repo_read_object_file(repo, oid, &type, &size);
2081 if (!buf)
2082 return error(_("unable to load config blob object '%s'"), name);
2083 if (type != OBJ_BLOB) {
2084 free(buf);
2085 return error(_("reference '%s' does not point to a blob"), name);
2088 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
2089 data, scope, NULL);
2090 free(buf);
2092 return ret;
2095 static int git_config_from_blob_ref(config_fn_t fn,
2096 struct repository *repo,
2097 const char *name,
2098 void *data,
2099 enum config_scope scope)
2101 struct object_id oid;
2103 if (repo_get_oid(repo, name, &oid) < 0)
2104 return error(_("unable to resolve config blob '%s'"), name);
2105 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
2108 char *git_system_config(void)
2110 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2111 if (!system_config)
2112 system_config = system_path(ETC_GITCONFIG);
2113 normalize_path_copy(system_config, system_config);
2114 return system_config;
2117 void git_global_config(char **user_out, char **xdg_out)
2119 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2120 char *xdg_config = NULL;
2122 if (!user_config) {
2123 user_config = interpolate_path("~/.gitconfig", 0);
2124 xdg_config = xdg_config_home("config");
2127 *user_out = user_config;
2128 *xdg_out = xdg_config;
2132 * Parse environment variable 'k' as a boolean (in various
2133 * possible spellings); if missing, use the default value 'def'.
2135 int git_env_bool(const char *k, int def)
2137 const char *v = getenv(k);
2138 return v ? git_config_bool(k, v) : def;
2142 * Parse environment variable 'k' as ulong with possibly a unit
2143 * suffix; if missing, use the default value 'val'.
2145 unsigned long git_env_ulong(const char *k, unsigned long val)
2147 const char *v = getenv(k);
2148 if (v && !git_parse_ulong(v, &val))
2149 die(_("failed to parse %s"), k);
2150 return val;
2153 int git_config_system(void)
2155 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2158 static int do_git_config_sequence(const struct config_options *opts,
2159 const struct repository *repo,
2160 config_fn_t fn, void *data)
2162 int ret = 0;
2163 char *system_config = git_system_config();
2164 char *xdg_config = NULL;
2165 char *user_config = NULL;
2166 char *repo_config;
2167 char *worktree_config;
2170 * Ensure that either:
2171 * - the git_dir and commondir are both set, or
2172 * - the git_dir and commondir are both NULL
2174 if (!opts->git_dir != !opts->commondir)
2175 BUG("only one of commondir and git_dir is non-NULL");
2177 if (opts->commondir) {
2178 repo_config = mkpathdup("%s/config", opts->commondir);
2179 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2180 } else {
2181 repo_config = NULL;
2182 worktree_config = NULL;
2185 if (git_config_system() && system_config &&
2186 !access_or_die(system_config, R_OK,
2187 opts->system_gently ? ACCESS_EACCES_OK : 0))
2188 ret += git_config_from_file_with_options(fn, system_config,
2189 data, CONFIG_SCOPE_SYSTEM,
2190 NULL);
2192 git_global_config(&user_config, &xdg_config);
2194 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2195 ret += git_config_from_file_with_options(fn, xdg_config, data,
2196 CONFIG_SCOPE_GLOBAL, NULL);
2198 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2199 ret += git_config_from_file_with_options(fn, user_config, data,
2200 CONFIG_SCOPE_GLOBAL, NULL);
2202 if (!opts->ignore_repo && repo_config &&
2203 !access_or_die(repo_config, R_OK, 0))
2204 ret += git_config_from_file_with_options(fn, repo_config, data,
2205 CONFIG_SCOPE_LOCAL, NULL);
2207 if (!opts->ignore_worktree && worktree_config &&
2208 repo && repo->repository_format_worktree_config &&
2209 !access_or_die(worktree_config, R_OK, 0)) {
2210 ret += git_config_from_file_with_options(fn, worktree_config, data,
2211 CONFIG_SCOPE_WORKTREE,
2212 NULL);
2215 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2216 die(_("unable to parse command-line config"));
2218 free(system_config);
2219 free(xdg_config);
2220 free(user_config);
2221 free(repo_config);
2222 free(worktree_config);
2223 return ret;
2226 int config_with_options(config_fn_t fn, void *data,
2227 struct git_config_source *config_source,
2228 struct repository *repo,
2229 const struct config_options *opts)
2231 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2232 int ret;
2234 if (opts->respect_includes) {
2235 inc.fn = fn;
2236 inc.data = data;
2237 inc.opts = opts;
2238 inc.repo = repo;
2239 inc.config_source = config_source;
2240 fn = git_config_include;
2241 data = &inc;
2245 * If we have a specific filename, use it. Otherwise, follow the
2246 * regular lookup sequence.
2248 if (config_source && config_source->use_stdin) {
2249 ret = git_config_from_stdin(fn, data, config_source->scope);
2250 } else if (config_source && config_source->file) {
2251 ret = git_config_from_file_with_options(fn, config_source->file,
2252 data, config_source->scope,
2253 NULL);
2254 } else if (config_source && config_source->blob) {
2255 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2256 data, config_source->scope);
2257 } else {
2258 ret = do_git_config_sequence(opts, repo, fn, data);
2261 if (inc.remote_urls) {
2262 string_list_clear(inc.remote_urls, 0);
2263 FREE_AND_NULL(inc.remote_urls);
2265 return ret;
2268 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2270 int i, value_index;
2271 struct string_list *values;
2272 struct config_set_element *entry;
2273 struct configset_list *list = &set->list;
2274 struct config_context ctx = CONFIG_CONTEXT_INIT;
2276 for (i = 0; i < list->nr; i++) {
2277 entry = list->items[i].e;
2278 value_index = list->items[i].value_index;
2279 values = &entry->value_list;
2281 ctx.kvi = values->items[value_index].util;
2282 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2283 git_die_config_linenr(entry->key,
2284 ctx.kvi->filename,
2285 ctx.kvi->linenr);
2289 void read_early_config(config_fn_t cb, void *data)
2291 struct config_options opts = {0};
2292 struct strbuf commondir = STRBUF_INIT;
2293 struct strbuf gitdir = STRBUF_INIT;
2295 opts.respect_includes = 1;
2297 if (have_git_dir()) {
2298 opts.commondir = get_git_common_dir();
2299 opts.git_dir = get_git_dir();
2301 * When setup_git_directory() was not yet asked to discover the
2302 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2303 * is any repository config we should use (but unlike
2304 * setup_git_directory_gently(), no global state is changed, most
2305 * notably, the current working directory is still the same after the
2306 * call).
2308 } else if (!discover_git_directory(&commondir, &gitdir)) {
2309 opts.commondir = commondir.buf;
2310 opts.git_dir = gitdir.buf;
2313 config_with_options(cb, data, NULL, NULL, &opts);
2315 strbuf_release(&commondir);
2316 strbuf_release(&gitdir);
2320 * Read config but only enumerate system and global settings.
2321 * Omit any repo-local, worktree-local, or command-line settings.
2323 void read_very_early_config(config_fn_t cb, void *data)
2325 struct config_options opts = { 0 };
2327 opts.respect_includes = 1;
2328 opts.ignore_repo = 1;
2329 opts.ignore_worktree = 1;
2330 opts.ignore_cmdline = 1;
2331 opts.system_gently = 1;
2333 config_with_options(cb, data, NULL, NULL, &opts);
2336 RESULT_MUST_BE_USED
2337 static int configset_find_element(struct config_set *set, const char *key,
2338 struct config_set_element **dest)
2340 struct config_set_element k;
2341 struct config_set_element *found_entry;
2342 char *normalized_key;
2343 int ret;
2346 * `key` may come from the user, so normalize it before using it
2347 * for querying entries from the hashmap.
2349 ret = git_config_parse_key(key, &normalized_key, NULL);
2350 if (ret)
2351 return ret;
2353 hashmap_entry_init(&k.ent, strhash(normalized_key));
2354 k.key = normalized_key;
2355 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2356 free(normalized_key);
2357 *dest = found_entry;
2358 return 0;
2361 static int configset_add_value(const struct key_value_info *kvi_p,
2362 struct config_set *set, const char *key,
2363 const char *value)
2365 struct config_set_element *e;
2366 struct string_list_item *si;
2367 struct configset_list_item *l_item;
2368 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2369 int ret;
2371 ret = configset_find_element(set, key, &e);
2372 if (ret)
2373 return ret;
2375 * Since the keys are being fed by git_config*() callback mechanism, they
2376 * are already normalized. So simply add them without any further munging.
2378 if (!e) {
2379 e = xmalloc(sizeof(*e));
2380 hashmap_entry_init(&e->ent, strhash(key));
2381 e->key = xstrdup(key);
2382 string_list_init_dup(&e->value_list);
2383 hashmap_add(&set->config_hash, &e->ent);
2385 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2387 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2388 l_item = &set->list.items[set->list.nr++];
2389 l_item->e = e;
2390 l_item->value_index = e->value_list.nr - 1;
2392 *kv_info = *kvi_p;
2393 si->util = kv_info;
2395 return 0;
2398 static int config_set_element_cmp(const void *cmp_data UNUSED,
2399 const struct hashmap_entry *eptr,
2400 const struct hashmap_entry *entry_or_key,
2401 const void *keydata UNUSED)
2403 const struct config_set_element *e1, *e2;
2405 e1 = container_of(eptr, const struct config_set_element, ent);
2406 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2408 return strcmp(e1->key, e2->key);
2411 void git_configset_init(struct config_set *set)
2413 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2414 set->hash_initialized = 1;
2415 set->list.nr = 0;
2416 set->list.alloc = 0;
2417 set->list.items = NULL;
2420 void git_configset_clear(struct config_set *set)
2422 struct config_set_element *entry;
2423 struct hashmap_iter iter;
2424 if (!set->hash_initialized)
2425 return;
2427 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2428 ent /* member name */) {
2429 free(entry->key);
2430 string_list_clear(&entry->value_list, 1);
2432 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2433 set->hash_initialized = 0;
2434 free(set->list.items);
2435 set->list.nr = 0;
2436 set->list.alloc = 0;
2437 set->list.items = NULL;
2440 static int config_set_callback(const char *key, const char *value,
2441 const struct config_context *ctx,
2442 void *cb)
2444 struct config_set *set = cb;
2445 configset_add_value(ctx->kvi, set, key, value);
2446 return 0;
2449 int git_configset_add_file(struct config_set *set, const char *filename)
2451 return git_config_from_file(config_set_callback, filename, set);
2454 int git_configset_get_value(struct config_set *set, const char *key,
2455 const char **value, struct key_value_info *kvi)
2457 const struct string_list *values = NULL;
2458 int ret;
2459 struct string_list_item item;
2461 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2462 * queried key in the files of the configset, the value returned will be the last
2463 * value in the value list for that key.
2465 if ((ret = git_configset_get_value_multi(set, key, &values)))
2466 return ret;
2468 assert(values->nr > 0);
2469 item = values->items[values->nr - 1];
2470 *value = item.string;
2471 if (kvi)
2472 *kvi = *((struct key_value_info *)item.util);
2473 return 0;
2476 int git_configset_get_value_multi(struct config_set *set, const char *key,
2477 const struct string_list **dest)
2479 struct config_set_element *e;
2480 int ret;
2482 if ((ret = configset_find_element(set, key, &e)))
2483 return ret;
2484 else if (!e)
2485 return 1;
2486 *dest = &e->value_list;
2488 return 0;
2491 static int check_multi_string(struct string_list_item *item, void *util)
2493 return item->string ? 0 : config_error_nonbool(util);
2496 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2497 const struct string_list **dest)
2499 int ret;
2501 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2502 return ret;
2503 if ((ret = for_each_string_list((struct string_list *)*dest,
2504 check_multi_string, (void *)key)))
2505 return ret;
2507 return 0;
2510 int git_configset_get(struct config_set *set, const char *key)
2512 struct config_set_element *e;
2513 int ret;
2515 if ((ret = configset_find_element(set, key, &e)))
2516 return ret;
2517 else if (!e)
2518 return 1;
2519 return 0;
2522 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2524 const char *value;
2525 if (!git_configset_get_value(set, key, &value, NULL))
2526 return git_config_string((const char **)dest, key, value);
2527 else
2528 return 1;
2531 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2532 const char **dest)
2534 const char *value;
2535 if (!git_configset_get_value(set, key, &value, NULL)) {
2536 if (!value)
2537 return config_error_nonbool(key);
2538 *dest = value;
2539 return 0;
2540 } else {
2541 return 1;
2545 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2547 const char *value;
2548 struct key_value_info kvi;
2550 if (!git_configset_get_value(set, key, &value, &kvi)) {
2551 *dest = git_config_int(key, value, &kvi);
2552 return 0;
2553 } else
2554 return 1;
2557 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2559 const char *value;
2560 struct key_value_info kvi;
2562 if (!git_configset_get_value(set, key, &value, &kvi)) {
2563 *dest = git_config_ulong(key, value, &kvi);
2564 return 0;
2565 } else
2566 return 1;
2569 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2571 const char *value;
2572 if (!git_configset_get_value(set, key, &value, NULL)) {
2573 *dest = git_config_bool(key, value);
2574 return 0;
2575 } else
2576 return 1;
2579 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2580 int *is_bool, int *dest)
2582 const char *value;
2583 struct key_value_info kvi;
2585 if (!git_configset_get_value(set, key, &value, &kvi)) {
2586 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2587 return 0;
2588 } else
2589 return 1;
2592 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2594 const char *value;
2595 if (!git_configset_get_value(set, key, &value, NULL)) {
2596 *dest = git_parse_maybe_bool(value);
2597 if (*dest == -1)
2598 return -1;
2599 return 0;
2600 } else
2601 return 1;
2604 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2606 const char *value;
2607 if (!git_configset_get_value(set, key, &value, NULL))
2608 return git_config_pathname(dest, key, value);
2609 else
2610 return 1;
2613 /* Functions use to read configuration from a repository */
2614 static void repo_read_config(struct repository *repo)
2616 struct config_options opts = { 0 };
2618 opts.respect_includes = 1;
2619 opts.commondir = repo->commondir;
2620 opts.git_dir = repo->gitdir;
2622 if (!repo->config)
2623 CALLOC_ARRAY(repo->config, 1);
2624 else
2625 git_configset_clear(repo->config);
2627 git_configset_init(repo->config);
2628 if (config_with_options(config_set_callback, repo->config, NULL,
2629 repo, &opts) < 0)
2631 * config_with_options() normally returns only
2632 * zero, as most errors are fatal, and
2633 * non-fatal potential errors are guarded by "if"
2634 * statements that are entered only when no error is
2635 * possible.
2637 * If we ever encounter a non-fatal error, it means
2638 * something went really wrong and we should stop
2639 * immediately.
2641 die(_("unknown error occurred while reading the configuration files"));
2644 static void git_config_check_init(struct repository *repo)
2646 if (repo->config && repo->config->hash_initialized)
2647 return;
2648 repo_read_config(repo);
2651 static void repo_config_clear(struct repository *repo)
2653 if (!repo->config || !repo->config->hash_initialized)
2654 return;
2655 git_configset_clear(repo->config);
2658 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2660 git_config_check_init(repo);
2661 configset_iter(repo->config, fn, data);
2664 int repo_config_get(struct repository *repo, const char *key)
2666 git_config_check_init(repo);
2667 return git_configset_get(repo->config, key);
2670 int repo_config_get_value(struct repository *repo,
2671 const char *key, const char **value)
2673 git_config_check_init(repo);
2674 return git_configset_get_value(repo->config, key, value, NULL);
2677 int repo_config_get_value_multi(struct repository *repo, const char *key,
2678 const struct string_list **dest)
2680 git_config_check_init(repo);
2681 return git_configset_get_value_multi(repo->config, key, dest);
2684 int repo_config_get_string_multi(struct repository *repo, const char *key,
2685 const struct string_list **dest)
2687 git_config_check_init(repo);
2688 return git_configset_get_string_multi(repo->config, key, dest);
2691 int repo_config_get_string(struct repository *repo,
2692 const char *key, char **dest)
2694 int ret;
2695 git_config_check_init(repo);
2696 ret = git_configset_get_string(repo->config, key, dest);
2697 if (ret < 0)
2698 git_die_config(key, NULL);
2699 return ret;
2702 int repo_config_get_string_tmp(struct repository *repo,
2703 const char *key, const char **dest)
2705 int ret;
2706 git_config_check_init(repo);
2707 ret = git_configset_get_string_tmp(repo->config, key, dest);
2708 if (ret < 0)
2709 git_die_config(key, NULL);
2710 return ret;
2713 int repo_config_get_int(struct repository *repo,
2714 const char *key, int *dest)
2716 git_config_check_init(repo);
2717 return git_configset_get_int(repo->config, key, dest);
2720 int repo_config_get_ulong(struct repository *repo,
2721 const char *key, unsigned long *dest)
2723 git_config_check_init(repo);
2724 return git_configset_get_ulong(repo->config, key, dest);
2727 int repo_config_get_bool(struct repository *repo,
2728 const char *key, int *dest)
2730 git_config_check_init(repo);
2731 return git_configset_get_bool(repo->config, key, dest);
2734 int repo_config_get_bool_or_int(struct repository *repo,
2735 const char *key, int *is_bool, int *dest)
2737 git_config_check_init(repo);
2738 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2741 int repo_config_get_maybe_bool(struct repository *repo,
2742 const char *key, int *dest)
2744 git_config_check_init(repo);
2745 return git_configset_get_maybe_bool(repo->config, key, dest);
2748 int repo_config_get_pathname(struct repository *repo,
2749 const char *key, const char **dest)
2751 int ret;
2752 git_config_check_init(repo);
2753 ret = git_configset_get_pathname(repo->config, key, dest);
2754 if (ret < 0)
2755 git_die_config(key, NULL);
2756 return ret;
2759 /* Read values into protected_config. */
2760 static void read_protected_config(void)
2762 struct config_options opts = {
2763 .respect_includes = 1,
2764 .ignore_repo = 1,
2765 .ignore_worktree = 1,
2766 .system_gently = 1,
2769 git_configset_init(&protected_config);
2770 config_with_options(config_set_callback, &protected_config, NULL,
2771 NULL, &opts);
2774 void git_protected_config(config_fn_t fn, void *data)
2776 if (!protected_config.hash_initialized)
2777 read_protected_config();
2778 configset_iter(&protected_config, fn, data);
2781 /* Functions used historically to read configuration from 'the_repository' */
2782 void git_config(config_fn_t fn, void *data)
2784 repo_config(the_repository, fn, data);
2787 void git_config_clear(void)
2789 repo_config_clear(the_repository);
2792 int git_config_get(const char *key)
2794 return repo_config_get(the_repository, key);
2797 int git_config_get_value(const char *key, const char **value)
2799 return repo_config_get_value(the_repository, key, value);
2802 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2804 return repo_config_get_value_multi(the_repository, key, dest);
2807 int git_config_get_string_multi(const char *key,
2808 const struct string_list **dest)
2810 return repo_config_get_string_multi(the_repository, key, dest);
2813 int git_config_get_string(const char *key, char **dest)
2815 return repo_config_get_string(the_repository, key, dest);
2818 int git_config_get_string_tmp(const char *key, const char **dest)
2820 return repo_config_get_string_tmp(the_repository, key, dest);
2823 int git_config_get_int(const char *key, int *dest)
2825 return repo_config_get_int(the_repository, key, dest);
2828 int git_config_get_ulong(const char *key, unsigned long *dest)
2830 return repo_config_get_ulong(the_repository, key, dest);
2833 int git_config_get_bool(const char *key, int *dest)
2835 return repo_config_get_bool(the_repository, key, dest);
2838 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2840 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2843 int git_config_get_maybe_bool(const char *key, int *dest)
2845 return repo_config_get_maybe_bool(the_repository, key, dest);
2848 int git_config_get_pathname(const char *key, const char **dest)
2850 return repo_config_get_pathname(the_repository, key, dest);
2853 int git_config_get_expiry(const char *key, const char **output)
2855 int ret = git_config_get_string(key, (char **)output);
2856 if (ret)
2857 return ret;
2858 if (strcmp(*output, "now")) {
2859 timestamp_t now = approxidate("now");
2860 if (approxidate(*output) >= now)
2861 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2863 return ret;
2866 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2868 const char *expiry_string;
2869 intmax_t days;
2870 timestamp_t when;
2872 if (git_config_get_string_tmp(key, &expiry_string))
2873 return 1; /* no such thing */
2875 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2876 const int scale = 86400;
2877 *expiry = now - days * scale;
2878 return 0;
2881 if (!parse_expiry_date(expiry_string, &when)) {
2882 *expiry = when;
2883 return 0;
2885 return -1; /* thing exists but cannot be parsed */
2888 int git_config_get_split_index(void)
2890 int val;
2892 if (!git_config_get_maybe_bool("core.splitindex", &val))
2893 return val;
2895 return -1; /* default value */
2898 int git_config_get_max_percent_split_change(void)
2900 int val = -1;
2902 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2903 if (0 <= val && val <= 100)
2904 return val;
2906 return error(_("splitIndex.maxPercentChange value '%d' "
2907 "should be between 0 and 100"), val);
2910 return -1; /* default value */
2913 int git_config_get_index_threads(int *dest)
2915 int is_bool, val;
2917 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2918 if (val) {
2919 *dest = val;
2920 return 0;
2923 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2924 if (is_bool)
2925 *dest = val ? 0 : 1;
2926 else
2927 *dest = val;
2928 return 0;
2931 return 1;
2934 NORETURN
2935 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2937 if (!filename)
2938 die(_("unable to parse '%s' from command-line config"), key);
2939 else
2940 die(_("bad config variable '%s' in file '%s' at line %d"),
2941 key, filename, linenr);
2944 NORETURN __attribute__((format(printf, 2, 3)))
2945 void git_die_config(const char *key, const char *err, ...)
2947 const struct string_list *values;
2948 struct key_value_info *kv_info;
2949 report_fn error_fn = get_error_routine();
2951 if (err) {
2952 va_list params;
2953 va_start(params, err);
2954 error_fn(err, params);
2955 va_end(params);
2957 if (git_config_get_value_multi(key, &values))
2958 BUG("for key '%s' we must have a value to report on", key);
2959 kv_info = values->items[values->nr - 1].util;
2960 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2964 * Find all the stuff for git_config_set() below.
2967 struct config_store_data {
2968 size_t baselen;
2969 char *key;
2970 int do_not_match;
2971 const char *fixed_value;
2972 regex_t *value_pattern;
2973 int multi_replace;
2974 struct {
2975 size_t begin, end;
2976 enum config_event_t type;
2977 int is_keys_section;
2978 } *parsed;
2979 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2980 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2982 #define CONFIG_STORE_INIT { 0 }
2984 static void config_store_data_clear(struct config_store_data *store)
2986 free(store->key);
2987 if (store->value_pattern != NULL &&
2988 store->value_pattern != CONFIG_REGEX_NONE) {
2989 regfree(store->value_pattern);
2990 free(store->value_pattern);
2992 free(store->parsed);
2993 free(store->seen);
2994 memset(store, 0, sizeof(*store));
2997 static int matches(const char *key, const char *value,
2998 const struct config_store_data *store)
3000 if (strcmp(key, store->key))
3001 return 0; /* not ours */
3002 if (store->fixed_value)
3003 return !strcmp(store->fixed_value, value);
3004 if (!store->value_pattern)
3005 return 1; /* always matches */
3006 if (store->value_pattern == CONFIG_REGEX_NONE)
3007 return 0; /* never matches */
3009 return store->do_not_match ^
3010 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
3013 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
3014 struct config_source *cs, void *data)
3016 struct config_store_data *store = data;
3018 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
3019 store->parsed[store->parsed_nr].begin = begin;
3020 store->parsed[store->parsed_nr].end = end;
3021 store->parsed[store->parsed_nr].type = type;
3023 if (type == CONFIG_EVENT_SECTION) {
3024 int (*cmpfn)(const char *, const char *, size_t);
3026 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
3027 return error(_("invalid section name '%s'"), cs->var.buf);
3029 if (cs->subsection_case_sensitive)
3030 cmpfn = strncasecmp;
3031 else
3032 cmpfn = strncmp;
3034 /* Is this the section we were looking for? */
3035 store->is_keys_section =
3036 store->parsed[store->parsed_nr].is_keys_section =
3037 cs->var.len - 1 == store->baselen &&
3038 !cmpfn(cs->var.buf, store->key, store->baselen);
3039 if (store->is_keys_section) {
3040 store->section_seen = 1;
3041 ALLOC_GROW(store->seen, store->seen_nr + 1,
3042 store->seen_alloc);
3043 store->seen[store->seen_nr] = store->parsed_nr;
3047 store->parsed_nr++;
3049 return 0;
3052 static int store_aux(const char *key, const char *value,
3053 const struct config_context *ctx UNUSED, void *cb)
3055 struct config_store_data *store = cb;
3057 if (store->key_seen) {
3058 if (matches(key, value, store)) {
3059 if (store->seen_nr == 1 && store->multi_replace == 0) {
3060 warning(_("%s has multiple values"), key);
3063 ALLOC_GROW(store->seen, store->seen_nr + 1,
3064 store->seen_alloc);
3066 store->seen[store->seen_nr] = store->parsed_nr;
3067 store->seen_nr++;
3069 } else if (store->is_keys_section) {
3071 * Do not increment matches yet: this may not be a match, but we
3072 * are in the desired section.
3074 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
3075 store->seen[store->seen_nr] = store->parsed_nr;
3076 store->section_seen = 1;
3078 if (matches(key, value, store)) {
3079 store->seen_nr++;
3080 store->key_seen = 1;
3084 return 0;
3087 static int write_error(const char *filename)
3089 error(_("failed to write new configuration file %s"), filename);
3091 /* Same error code as "failed to rename". */
3092 return 4;
3095 static struct strbuf store_create_section(const char *key,
3096 const struct config_store_data *store)
3098 const char *dot;
3099 size_t i;
3100 struct strbuf sb = STRBUF_INIT;
3102 dot = memchr(key, '.', store->baselen);
3103 if (dot) {
3104 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
3105 for (i = dot - key + 1; i < store->baselen; i++) {
3106 if (key[i] == '"' || key[i] == '\\')
3107 strbuf_addch(&sb, '\\');
3108 strbuf_addch(&sb, key[i]);
3110 strbuf_addstr(&sb, "\"]\n");
3111 } else {
3112 strbuf_addch(&sb, '[');
3113 strbuf_add(&sb, key, store->baselen);
3114 strbuf_addstr(&sb, "]\n");
3117 return sb;
3120 static ssize_t write_section(int fd, const char *key,
3121 const struct config_store_data *store)
3123 struct strbuf sb = store_create_section(key, store);
3124 ssize_t ret;
3126 ret = write_in_full(fd, sb.buf, sb.len);
3127 strbuf_release(&sb);
3129 return ret;
3132 static ssize_t write_pair(int fd, const char *key, const char *value,
3133 const struct config_store_data *store)
3135 int i;
3136 ssize_t ret;
3137 const char *quote = "";
3138 struct strbuf sb = STRBUF_INIT;
3141 * Check to see if the value needs to be surrounded with a dq pair.
3142 * Note that problematic characters are always backslash-quoted; this
3143 * check is about not losing leading or trailing SP and strings that
3144 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3145 * configuration parser.
3147 if (value[0] == ' ')
3148 quote = "\"";
3149 for (i = 0; value[i]; i++)
3150 if (value[i] == ';' || value[i] == '#')
3151 quote = "\"";
3152 if (i && value[i - 1] == ' ')
3153 quote = "\"";
3155 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3157 for (i = 0; value[i]; i++)
3158 switch (value[i]) {
3159 case '\n':
3160 strbuf_addstr(&sb, "\\n");
3161 break;
3162 case '\t':
3163 strbuf_addstr(&sb, "\\t");
3164 break;
3165 case '"':
3166 case '\\':
3167 strbuf_addch(&sb, '\\');
3168 /* fallthrough */
3169 default:
3170 strbuf_addch(&sb, value[i]);
3171 break;
3173 strbuf_addf(&sb, "%s\n", quote);
3175 ret = write_in_full(fd, sb.buf, sb.len);
3176 strbuf_release(&sb);
3178 return ret;
3182 * If we are about to unset the last key(s) in a section, and if there are
3183 * no comments surrounding (or included in) the section, we will want to
3184 * extend begin/end to remove the entire section.
3186 * Note: the parameter `seen_ptr` points to the index into the store.seen
3187 * array. * This index may be incremented if a section has more than one
3188 * entry (which all are to be removed).
3190 static void maybe_remove_section(struct config_store_data *store,
3191 size_t *begin_offset, size_t *end_offset,
3192 int *seen_ptr)
3194 size_t begin;
3195 int i, seen, section_seen = 0;
3198 * First, ensure that this is the first key, and that there are no
3199 * comments before the entry nor before the section header.
3201 seen = *seen_ptr;
3202 for (i = store->seen[seen]; i > 0; i--) {
3203 enum config_event_t type = store->parsed[i - 1].type;
3205 if (type == CONFIG_EVENT_COMMENT)
3206 /* There is a comment before this entry or section */
3207 return;
3208 if (type == CONFIG_EVENT_ENTRY) {
3209 if (!section_seen)
3210 /* This is not the section's first entry. */
3211 return;
3212 /* We encountered no comment before the section. */
3213 break;
3215 if (type == CONFIG_EVENT_SECTION) {
3216 if (!store->parsed[i - 1].is_keys_section)
3217 break;
3218 section_seen = 1;
3221 begin = store->parsed[i].begin;
3224 * Next, make sure that we are removing the last key(s) in the section,
3225 * and that there are no comments that are possibly about the current
3226 * section.
3228 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3229 enum config_event_t type = store->parsed[i].type;
3231 if (type == CONFIG_EVENT_COMMENT)
3232 return;
3233 if (type == CONFIG_EVENT_SECTION) {
3234 if (store->parsed[i].is_keys_section)
3235 continue;
3236 break;
3238 if (type == CONFIG_EVENT_ENTRY) {
3239 if (++seen < store->seen_nr &&
3240 i == store->seen[seen])
3241 /* We want to remove this entry, too */
3242 continue;
3243 /* There is another entry in this section. */
3244 return;
3249 * We are really removing the last entry/entries from this section, and
3250 * there are no enclosed or surrounding comments. Remove the entire,
3251 * now-empty section.
3253 *seen_ptr = seen;
3254 *begin_offset = begin;
3255 if (i < store->parsed_nr)
3256 *end_offset = store->parsed[i].begin;
3257 else
3258 *end_offset = store->parsed[store->parsed_nr - 1].end;
3261 int git_config_set_in_file_gently(const char *config_filename,
3262 const char *key, const char *value)
3264 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3267 void git_config_set_in_file(const char *config_filename,
3268 const char *key, const char *value)
3270 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3273 int git_config_set_gently(const char *key, const char *value)
3275 return git_config_set_multivar_gently(key, value, NULL, 0);
3278 int repo_config_set_worktree_gently(struct repository *r,
3279 const char *key, const char *value)
3281 /* Only use worktree-specific config if it is already enabled. */
3282 if (r->repository_format_worktree_config) {
3283 char *file = repo_git_path(r, "config.worktree");
3284 int ret = git_config_set_multivar_in_file_gently(
3285 file, key, value, NULL, 0);
3286 free(file);
3287 return ret;
3289 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3292 void git_config_set(const char *key, const char *value)
3294 git_config_set_multivar(key, value, NULL, 0);
3296 trace2_cmd_set_config(key, value);
3300 * If value==NULL, unset in (remove from) config,
3301 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3302 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3303 * (only add a new one)
3304 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3305 * key/values are removed before a single new pair is written. If the
3306 * flag is not present, then replace only the first match.
3308 * Returns 0 on success.
3310 * This function does this:
3312 * - it locks the config file by creating ".git/config.lock"
3314 * - it then parses the config using store_aux() as validator to find
3315 * the position on the key/value pair to replace. If it is to be unset,
3316 * it must be found exactly once.
3318 * - the config file is mmap()ed and the part before the match (if any) is
3319 * written to the lock file, then the changed part and the rest.
3321 * - the config file is removed and the lock file rename()d to it.
3324 int git_config_set_multivar_in_file_gently(const char *config_filename,
3325 const char *key, const char *value,
3326 const char *value_pattern,
3327 unsigned flags)
3329 int fd = -1, in_fd = -1;
3330 int ret;
3331 struct lock_file lock = LOCK_INIT;
3332 char *filename_buf = NULL;
3333 char *contents = NULL;
3334 size_t contents_sz;
3335 struct config_store_data store = CONFIG_STORE_INIT;
3337 /* parse-key returns negative; flip the sign to feed exit(3) */
3338 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3339 if (ret)
3340 goto out_free;
3342 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3344 if (!config_filename)
3345 config_filename = filename_buf = git_pathdup("config");
3348 * The lock serves a purpose in addition to locking: the new
3349 * contents of .git/config will be written into it.
3351 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3352 if (fd < 0) {
3353 error_errno(_("could not lock config file %s"), config_filename);
3354 ret = CONFIG_NO_LOCK;
3355 goto out_free;
3359 * If .git/config does not exist yet, write a minimal version.
3361 in_fd = open(config_filename, O_RDONLY);
3362 if ( in_fd < 0 ) {
3363 if ( ENOENT != errno ) {
3364 error_errno(_("opening %s"), config_filename);
3365 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3366 goto out_free;
3368 /* if nothing to unset, error out */
3369 if (!value) {
3370 ret = CONFIG_NOTHING_SET;
3371 goto out_free;
3374 free(store.key);
3375 store.key = xstrdup(key);
3376 if (write_section(fd, key, &store) < 0 ||
3377 write_pair(fd, key, value, &store) < 0)
3378 goto write_err_out;
3379 } else {
3380 struct stat st;
3381 size_t copy_begin, copy_end;
3382 int i, new_line = 0;
3383 struct config_options opts;
3385 if (!value_pattern)
3386 store.value_pattern = NULL;
3387 else if (value_pattern == CONFIG_REGEX_NONE)
3388 store.value_pattern = CONFIG_REGEX_NONE;
3389 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3390 store.fixed_value = value_pattern;
3391 else {
3392 if (value_pattern[0] == '!') {
3393 store.do_not_match = 1;
3394 value_pattern++;
3395 } else
3396 store.do_not_match = 0;
3398 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3399 if (regcomp(store.value_pattern, value_pattern,
3400 REG_EXTENDED)) {
3401 error(_("invalid pattern: %s"), value_pattern);
3402 FREE_AND_NULL(store.value_pattern);
3403 ret = CONFIG_INVALID_PATTERN;
3404 goto out_free;
3408 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3409 store.parsed[0].end = 0;
3411 memset(&opts, 0, sizeof(opts));
3412 opts.event_fn = store_aux_event;
3413 opts.event_fn_data = &store;
3416 * After this, store.parsed will contain offsets of all the
3417 * parsed elements, and store.seen will contain a list of
3418 * matches, as indices into store.parsed.
3420 * As a side effect, we make sure to transform only a valid
3421 * existing config file.
3423 if (git_config_from_file_with_options(store_aux,
3424 config_filename,
3425 &store, CONFIG_SCOPE_UNKNOWN,
3426 &opts)) {
3427 error(_("invalid config file %s"), config_filename);
3428 ret = CONFIG_INVALID_FILE;
3429 goto out_free;
3432 /* if nothing to unset, or too many matches, error out */
3433 if ((store.seen_nr == 0 && value == NULL) ||
3434 (store.seen_nr > 1 && !store.multi_replace)) {
3435 ret = CONFIG_NOTHING_SET;
3436 goto out_free;
3439 if (fstat(in_fd, &st) == -1) {
3440 error_errno(_("fstat on %s failed"), config_filename);
3441 ret = CONFIG_INVALID_FILE;
3442 goto out_free;
3445 contents_sz = xsize_t(st.st_size);
3446 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3447 MAP_PRIVATE, in_fd, 0);
3448 if (contents == MAP_FAILED) {
3449 if (errno == ENODEV && S_ISDIR(st.st_mode))
3450 errno = EISDIR;
3451 error_errno(_("unable to mmap '%s'%s"),
3452 config_filename, mmap_os_err());
3453 ret = CONFIG_INVALID_FILE;
3454 contents = NULL;
3455 goto out_free;
3457 close(in_fd);
3458 in_fd = -1;
3460 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3461 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3462 ret = CONFIG_NO_WRITE;
3463 goto out_free;
3466 if (store.seen_nr == 0) {
3467 if (!store.seen_alloc) {
3468 /* Did not see key nor section */
3469 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3470 store.seen[0] = store.parsed_nr
3471 - !!store.parsed_nr;
3473 store.seen_nr = 1;
3476 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3477 size_t replace_end;
3478 int j = store.seen[i];
3480 new_line = 0;
3481 if (!store.key_seen) {
3482 copy_end = store.parsed[j].end;
3483 /* include '\n' when copying section header */
3484 if (copy_end > 0 && copy_end < contents_sz &&
3485 contents[copy_end - 1] != '\n' &&
3486 contents[copy_end] == '\n')
3487 copy_end++;
3488 replace_end = copy_end;
3489 } else {
3490 replace_end = store.parsed[j].end;
3491 copy_end = store.parsed[j].begin;
3492 if (!value)
3493 maybe_remove_section(&store,
3494 &copy_end,
3495 &replace_end, &i);
3497 * Swallow preceding white-space on the same
3498 * line.
3500 while (copy_end > 0 ) {
3501 char c = contents[copy_end - 1];
3503 if (isspace(c) && c != '\n')
3504 copy_end--;
3505 else
3506 break;
3510 if (copy_end > 0 && contents[copy_end-1] != '\n')
3511 new_line = 1;
3513 /* write the first part of the config */
3514 if (copy_end > copy_begin) {
3515 if (write_in_full(fd, contents + copy_begin,
3516 copy_end - copy_begin) < 0)
3517 goto write_err_out;
3518 if (new_line &&
3519 write_str_in_full(fd, "\n") < 0)
3520 goto write_err_out;
3522 copy_begin = replace_end;
3525 /* write the pair (value == NULL means unset) */
3526 if (value) {
3527 if (!store.section_seen) {
3528 if (write_section(fd, key, &store) < 0)
3529 goto write_err_out;
3531 if (write_pair(fd, key, value, &store) < 0)
3532 goto write_err_out;
3535 /* write the rest of the config */
3536 if (copy_begin < contents_sz)
3537 if (write_in_full(fd, contents + copy_begin,
3538 contents_sz - copy_begin) < 0)
3539 goto write_err_out;
3541 munmap(contents, contents_sz);
3542 contents = NULL;
3545 if (commit_lock_file(&lock) < 0) {
3546 error_errno(_("could not write config file %s"), config_filename);
3547 ret = CONFIG_NO_WRITE;
3548 goto out_free;
3551 ret = 0;
3553 /* Invalidate the config cache */
3554 git_config_clear();
3556 out_free:
3557 rollback_lock_file(&lock);
3558 free(filename_buf);
3559 if (contents)
3560 munmap(contents, contents_sz);
3561 if (in_fd >= 0)
3562 close(in_fd);
3563 config_store_data_clear(&store);
3564 return ret;
3566 write_err_out:
3567 ret = write_error(get_lock_file_path(&lock));
3568 goto out_free;
3572 void git_config_set_multivar_in_file(const char *config_filename,
3573 const char *key, const char *value,
3574 const char *value_pattern, unsigned flags)
3576 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3577 value_pattern, flags))
3578 return;
3579 if (value)
3580 die(_("could not set '%s' to '%s'"), key, value);
3581 else
3582 die(_("could not unset '%s'"), key);
3585 int git_config_set_multivar_gently(const char *key, const char *value,
3586 const char *value_pattern, unsigned flags)
3588 return repo_config_set_multivar_gently(the_repository, key, value,
3589 value_pattern, flags);
3592 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3593 const char *value,
3594 const char *value_pattern, unsigned flags)
3596 char *file = repo_git_path(r, "config");
3597 int res = git_config_set_multivar_in_file_gently(file,
3598 key, value,
3599 value_pattern,
3600 flags);
3601 free(file);
3602 return res;
3605 void git_config_set_multivar(const char *key, const char *value,
3606 const char *value_pattern, unsigned flags)
3608 git_config_set_multivar_in_file(git_path("config"),
3609 key, value, value_pattern,
3610 flags);
3613 static size_t section_name_match (const char *buf, const char *name)
3615 size_t i = 0, j = 0;
3616 int dot = 0;
3617 if (buf[i] != '[')
3618 return 0;
3619 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3620 if (!dot && isspace(buf[i])) {
3621 dot = 1;
3622 if (name[j++] != '.')
3623 break;
3624 for (i++; isspace(buf[i]); i++)
3625 ; /* do nothing */
3626 if (buf[i] != '"')
3627 break;
3628 continue;
3630 if (buf[i] == '\\' && dot)
3631 i++;
3632 else if (buf[i] == '"' && dot) {
3633 for (i++; isspace(buf[i]); i++)
3634 ; /* do_nothing */
3635 break;
3637 if (buf[i] != name[j++])
3638 break;
3640 if (buf[i] == ']' && name[j] == 0) {
3642 * We match, now just find the right length offset by
3643 * gobbling up any whitespace after it, as well
3645 i++;
3646 for (; buf[i] && isspace(buf[i]); i++)
3647 ; /* do nothing */
3648 return i;
3650 return 0;
3653 static int section_name_is_ok(const char *name)
3655 /* Empty section names are bogus. */
3656 if (!*name)
3657 return 0;
3660 * Before a dot, we must be alphanumeric or dash. After the first dot,
3661 * anything goes, so we can stop checking.
3663 for (; *name && *name != '.'; name++)
3664 if (*name != '-' && !isalnum(*name))
3665 return 0;
3666 return 1;
3669 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3671 /* if new_name == NULL, the section is removed instead */
3672 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3673 const char *old_name,
3674 const char *new_name, int copy)
3676 int ret = 0, remove = 0;
3677 char *filename_buf = NULL;
3678 struct lock_file lock = LOCK_INIT;
3679 int out_fd;
3680 struct strbuf buf = STRBUF_INIT;
3681 FILE *config_file = NULL;
3682 struct stat st;
3683 struct strbuf copystr = STRBUF_INIT;
3684 struct config_store_data store;
3685 uint32_t line_nr = 0;
3687 memset(&store, 0, sizeof(store));
3689 if (new_name && !section_name_is_ok(new_name)) {
3690 ret = error(_("invalid section name: %s"), new_name);
3691 goto out_no_rollback;
3694 if (!config_filename)
3695 config_filename = filename_buf = git_pathdup("config");
3697 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3698 if (out_fd < 0) {
3699 ret = error(_("could not lock config file %s"), config_filename);
3700 goto out;
3703 if (!(config_file = fopen(config_filename, "rb"))) {
3704 ret = warn_on_fopen_errors(config_filename);
3705 if (ret)
3706 goto out;
3707 /* no config file means nothing to rename, no error */
3708 goto commit_and_out;
3711 if (fstat(fileno(config_file), &st) == -1) {
3712 ret = error_errno(_("fstat on %s failed"), config_filename);
3713 goto out;
3716 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3717 ret = error_errno(_("chmod on %s failed"),
3718 get_lock_file_path(&lock));
3719 goto out;
3722 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3723 size_t i, length;
3724 int is_section = 0;
3725 char *output = buf.buf;
3727 line_nr++;
3729 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3730 ret = error(_("refusing to work with overly long line "
3731 "in '%s' on line %"PRIuMAX),
3732 config_filename, (uintmax_t)line_nr);
3733 goto out;
3736 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3737 ; /* do nothing */
3738 if (buf.buf[i] == '[') {
3739 /* it's a section */
3740 size_t offset;
3741 is_section = 1;
3744 * When encountering a new section under -c we
3745 * need to flush out any section we're already
3746 * coping and begin anew. There might be
3747 * multiple [branch "$name"] sections.
3749 if (copystr.len > 0) {
3750 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3751 ret = write_error(get_lock_file_path(&lock));
3752 goto out;
3754 strbuf_reset(&copystr);
3757 offset = section_name_match(&buf.buf[i], old_name);
3758 if (offset > 0) {
3759 ret++;
3760 if (!new_name) {
3761 remove = 1;
3762 continue;
3764 store.baselen = strlen(new_name);
3765 if (!copy) {
3766 if (write_section(out_fd, new_name, &store) < 0) {
3767 ret = write_error(get_lock_file_path(&lock));
3768 goto out;
3771 * We wrote out the new section, with
3772 * a newline, now skip the old
3773 * section's length
3775 output += offset + i;
3776 if (strlen(output) > 0) {
3778 * More content means there's
3779 * a declaration to put on the
3780 * next line; indent with a
3781 * tab
3783 output -= 1;
3784 output[0] = '\t';
3786 } else {
3787 strbuf_release(&copystr);
3788 copystr = store_create_section(new_name, &store);
3791 remove = 0;
3793 if (remove)
3794 continue;
3795 length = strlen(output);
3797 if (!is_section && copystr.len > 0) {
3798 strbuf_add(&copystr, output, length);
3801 if (write_in_full(out_fd, output, length) < 0) {
3802 ret = write_error(get_lock_file_path(&lock));
3803 goto out;
3808 * Copy a trailing section at the end of the config, won't be
3809 * flushed by the usual "flush because we have a new section
3810 * logic in the loop above.
3812 if (copystr.len > 0) {
3813 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3814 ret = write_error(get_lock_file_path(&lock));
3815 goto out;
3817 strbuf_reset(&copystr);
3820 fclose(config_file);
3821 config_file = NULL;
3822 commit_and_out:
3823 if (commit_lock_file(&lock) < 0)
3824 ret = error_errno(_("could not write config file %s"),
3825 config_filename);
3826 out:
3827 if (config_file)
3828 fclose(config_file);
3829 rollback_lock_file(&lock);
3830 out_no_rollback:
3831 free(filename_buf);
3832 config_store_data_clear(&store);
3833 strbuf_release(&buf);
3834 strbuf_release(&copystr);
3835 return ret;
3838 int git_config_rename_section_in_file(const char *config_filename,
3839 const char *old_name, const char *new_name)
3841 return git_config_copy_or_rename_section_in_file(config_filename,
3842 old_name, new_name, 0);
3845 int git_config_rename_section(const char *old_name, const char *new_name)
3847 return git_config_rename_section_in_file(NULL, old_name, new_name);
3850 int git_config_copy_section_in_file(const char *config_filename,
3851 const char *old_name, const char *new_name)
3853 return git_config_copy_or_rename_section_in_file(config_filename,
3854 old_name, new_name, 1);
3857 int git_config_copy_section(const char *old_name, const char *new_name)
3859 return git_config_copy_section_in_file(NULL, old_name, new_name);
3863 * Call this to report error for your variable that should not
3864 * get a boolean value (i.e. "[my] var" means "true").
3866 #undef config_error_nonbool
3867 int config_error_nonbool(const char *var)
3869 return error(_("missing value for '%s'"), var);
3872 int parse_config_key(const char *var,
3873 const char *section,
3874 const char **subsection, size_t *subsection_len,
3875 const char **key)
3877 const char *dot;
3879 /* Does it start with "section." ? */
3880 if (!skip_prefix(var, section, &var) || *var != '.')
3881 return -1;
3884 * Find the key; we don't know yet if we have a subsection, but we must
3885 * parse backwards from the end, since the subsection may have dots in
3886 * it, too.
3888 dot = strrchr(var, '.');
3889 *key = dot + 1;
3891 /* Did we have a subsection at all? */
3892 if (dot == var) {
3893 if (subsection) {
3894 *subsection = NULL;
3895 *subsection_len = 0;
3898 else {
3899 if (!subsection)
3900 return -1;
3901 *subsection = var + 1;
3902 *subsection_len = dot - *subsection;
3905 return 0;
3908 const char *config_origin_type_name(enum config_origin_type type)
3910 switch (type) {
3911 case CONFIG_ORIGIN_BLOB:
3912 return "blob";
3913 case CONFIG_ORIGIN_FILE:
3914 return "file";
3915 case CONFIG_ORIGIN_STDIN:
3916 return "standard input";
3917 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3918 return "submodule-blob";
3919 case CONFIG_ORIGIN_CMDLINE:
3920 return "command line";
3921 default:
3922 BUG("unknown config origin type");
3926 const char *config_scope_name(enum config_scope scope)
3928 switch (scope) {
3929 case CONFIG_SCOPE_SYSTEM:
3930 return "system";
3931 case CONFIG_SCOPE_GLOBAL:
3932 return "global";
3933 case CONFIG_SCOPE_LOCAL:
3934 return "local";
3935 case CONFIG_SCOPE_WORKTREE:
3936 return "worktree";
3937 case CONFIG_SCOPE_COMMAND:
3938 return "command";
3939 case CONFIG_SCOPE_SUBMODULE:
3940 return "submodule";
3941 default:
3942 return "unknown";
3946 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3948 int i;
3950 for (i = 0; i < nr_mapping; i++) {
3951 const char *name = mapping[i];
3953 if (name && !strcasecmp(var, name))
3954 return i;
3956 return -1;