doc: git-clone fix discrepancy between asciidoc and asciidoctor
[alt-git.git] / config.c
blob3cfeb3d8bd99f4ca15d0f3a06cd4b1fe932f7f47
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "git-compat-util.h"
9 #include "abspath.h"
10 #include "advice.h"
11 #include "date.h"
12 #include "branch.h"
13 #include "config.h"
14 #include "parse.h"
15 #include "convert.h"
16 #include "environment.h"
17 #include "gettext.h"
18 #include "ident.h"
19 #include "repository.h"
20 #include "lockfile.h"
21 #include "mailmap.h"
22 #include "attr.h"
23 #include "exec-cmd.h"
24 #include "strbuf.h"
25 #include "quote.h"
26 #include "hashmap.h"
27 #include "string-list.h"
28 #include "object-name.h"
29 #include "object-store-ll.h"
30 #include "pager.h"
31 #include "path.h"
32 #include "utf8.h"
33 #include "color.h"
34 #include "refs.h"
35 #include "setup.h"
36 #include "strvec.h"
37 #include "trace2.h"
38 #include "wildmatch.h"
39 #include "ws.h"
40 #include "write-or-die.h"
42 struct config_source {
43 struct config_source *prev;
44 union {
45 FILE *file;
46 struct config_buf {
47 const char *buf;
48 size_t len;
49 size_t pos;
50 } buf;
51 } u;
52 enum config_origin_type origin_type;
53 const char *name;
54 const char *path;
55 enum config_error_action default_error_action;
56 int linenr;
57 int eof;
58 size_t total_len;
59 struct strbuf value;
60 struct strbuf var;
61 unsigned subsection_case_sensitive : 1;
63 int (*do_fgetc)(struct config_source *c);
64 int (*do_ungetc)(int c, struct config_source *conf);
65 long (*do_ftell)(struct config_source *c);
67 #define CONFIG_SOURCE_INIT { 0 }
69 static int pack_compression_seen;
70 static int zlib_compression_seen;
73 * Config that comes from trusted scopes, namely:
74 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
75 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
76 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
78 * This is declared here for code cleanliness, but unlike the other
79 * static variables, this does not hold config parser state.
81 static struct config_set protected_config;
83 static int config_file_fgetc(struct config_source *conf)
85 return getc_unlocked(conf->u.file);
88 static int config_file_ungetc(int c, struct config_source *conf)
90 return ungetc(c, conf->u.file);
93 static long config_file_ftell(struct config_source *conf)
95 return ftell(conf->u.file);
98 static int config_buf_fgetc(struct config_source *conf)
100 if (conf->u.buf.pos < conf->u.buf.len)
101 return conf->u.buf.buf[conf->u.buf.pos++];
103 return EOF;
106 static int config_buf_ungetc(int c, struct config_source *conf)
108 if (conf->u.buf.pos > 0) {
109 conf->u.buf.pos--;
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
111 BUG("config_buf can only ungetc the same character");
112 return c;
115 return EOF;
118 static long config_buf_ftell(struct config_source *conf)
120 return conf->u.buf.pos;
123 struct config_include_data {
124 int depth;
125 config_fn_t fn;
126 void *data;
127 const struct config_options *opts;
128 struct git_config_source *config_source;
129 struct repository *repo;
132 * All remote URLs discovered when reading all config files.
134 struct string_list *remote_urls;
136 #define CONFIG_INCLUDE_INIT { 0 }
138 static int git_config_include(const char *var, const char *value,
139 const struct config_context *ctx, void *data);
141 #define MAX_INCLUDE_DEPTH 10
142 static const char include_depth_advice[] = N_(
143 "exceeded maximum include depth (%d) while including\n"
144 " %s\n"
145 "from\n"
146 " %s\n"
147 "This might be due to circular includes.");
148 static int handle_path_include(const struct key_value_info *kvi,
149 const char *path,
150 struct config_include_data *inc)
152 int ret = 0;
153 struct strbuf buf = STRBUF_INIT;
154 char *expanded;
156 if (!path)
157 return config_error_nonbool("include.path");
159 expanded = interpolate_path(path, 0);
160 if (!expanded)
161 return error(_("could not expand include path '%s'"), path);
162 path = expanded;
165 * Use an absolute path as-is, but interpret relative paths
166 * based on the including config file.
168 if (!is_absolute_path(path)) {
169 char *slash;
171 if (!kvi || !kvi->path) {
172 ret = error(_("relative config includes must come from files"));
173 goto cleanup;
176 slash = find_last_dir_sep(kvi->path);
177 if (slash)
178 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
179 strbuf_addstr(&buf, path);
180 path = buf.buf;
183 if (!access_or_die(path, R_OK, 0)) {
184 if (++inc->depth > MAX_INCLUDE_DEPTH)
185 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
186 !kvi ? "<unknown>" :
187 kvi->filename ? kvi->filename :
188 "the command line");
189 ret = git_config_from_file_with_options(git_config_include, path, inc,
190 kvi->scope, NULL);
191 inc->depth--;
193 cleanup:
194 strbuf_release(&buf);
195 free(expanded);
196 return ret;
199 static void add_trailing_starstar_for_dir(struct strbuf *pat)
201 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
202 strbuf_addstr(pat, "**");
205 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
206 struct strbuf *pat)
208 struct strbuf path = STRBUF_INIT;
209 char *expanded;
210 int prefix = 0;
212 expanded = interpolate_path(pat->buf, 1);
213 if (expanded) {
214 strbuf_reset(pat);
215 strbuf_addstr(pat, expanded);
216 free(expanded);
219 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
220 const char *slash;
222 if (!kvi || !kvi->path)
223 return error(_("relative config include "
224 "conditionals must come from files"));
226 strbuf_realpath(&path, kvi->path, 1);
227 slash = find_last_dir_sep(path.buf);
228 if (!slash)
229 BUG("how is this possible?");
230 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
231 prefix = slash - path.buf + 1 /* slash */;
232 } else if (!is_absolute_path(pat->buf))
233 strbuf_insertstr(pat, 0, "**/");
235 add_trailing_starstar_for_dir(pat);
237 strbuf_release(&path);
238 return prefix;
241 static int include_by_gitdir(const struct key_value_info *kvi,
242 const struct config_options *opts,
243 const char *cond, size_t cond_len, int icase)
245 struct strbuf text = STRBUF_INIT;
246 struct strbuf pattern = STRBUF_INIT;
247 int ret = 0, prefix;
248 const char *git_dir;
249 int already_tried_absolute = 0;
251 if (opts->git_dir)
252 git_dir = opts->git_dir;
253 else
254 goto done;
256 strbuf_realpath(&text, git_dir, 1);
257 strbuf_add(&pattern, cond, cond_len);
258 prefix = prepare_include_condition_pattern(kvi, &pattern);
260 again:
261 if (prefix < 0)
262 goto done;
264 if (prefix > 0) {
266 * perform literal matching on the prefix part so that
267 * any wildcard character in it can't create side effects.
269 if (text.len < prefix)
270 goto done;
271 if (!icase && strncmp(pattern.buf, text.buf, prefix))
272 goto done;
273 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
274 goto done;
277 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
278 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
280 if (!ret && !already_tried_absolute) {
282 * We've tried e.g. matching gitdir:~/work, but if
283 * ~/work is a symlink to /mnt/storage/work
284 * strbuf_realpath() will expand it, so the rule won't
285 * match. Let's match against a
286 * strbuf_add_absolute_path() version of the path,
287 * which'll do the right thing
289 strbuf_reset(&text);
290 strbuf_add_absolute_path(&text, git_dir);
291 already_tried_absolute = 1;
292 goto again;
294 done:
295 strbuf_release(&pattern);
296 strbuf_release(&text);
297 return ret;
300 static int include_by_branch(const char *cond, size_t cond_len)
302 int flags;
303 int ret;
304 struct strbuf pattern = STRBUF_INIT;
305 const char *refname = !the_repository->gitdir ?
306 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
307 const char *shortname;
309 if (!refname || !(flags & REF_ISSYMREF) ||
310 !skip_prefix(refname, "refs/heads/", &shortname))
311 return 0;
313 strbuf_add(&pattern, cond, cond_len);
314 add_trailing_starstar_for_dir(&pattern);
315 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
316 strbuf_release(&pattern);
317 return ret;
320 static int add_remote_url(const char *var, const char *value,
321 const struct config_context *ctx UNUSED, void *data)
323 struct string_list *remote_urls = data;
324 const char *remote_name;
325 size_t remote_name_len;
326 const char *key;
328 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
329 &key) &&
330 remote_name &&
331 !strcmp(key, "url"))
332 string_list_append(remote_urls, value);
333 return 0;
336 static void populate_remote_urls(struct config_include_data *inc)
338 struct config_options opts;
340 opts = *inc->opts;
341 opts.unconditional_remote_url = 1;
343 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
344 string_list_init_dup(inc->remote_urls);
345 config_with_options(add_remote_url, inc->remote_urls,
346 inc->config_source, inc->repo, &opts);
349 static int forbid_remote_url(const char *var, const char *value UNUSED,
350 const struct config_context *ctx UNUSED,
351 void *data UNUSED)
353 const char *remote_name;
354 size_t remote_name_len;
355 const char *key;
357 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
358 &key) &&
359 remote_name &&
360 !strcmp(key, "url"))
361 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
362 return 0;
365 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
366 struct string_list *remote_urls)
368 struct strbuf pattern = STRBUF_INIT;
369 struct string_list_item *url_item;
370 int found = 0;
372 strbuf_add(&pattern, glob, glob_len);
373 for_each_string_list_item(url_item, remote_urls) {
374 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
375 found = 1;
376 break;
379 strbuf_release(&pattern);
380 return found;
383 static int include_by_remote_url(struct config_include_data *inc,
384 const char *cond, size_t cond_len)
386 if (inc->opts->unconditional_remote_url)
387 return 1;
388 if (!inc->remote_urls)
389 populate_remote_urls(inc);
390 return at_least_one_url_matches_glob(cond, cond_len,
391 inc->remote_urls);
394 static int include_condition_is_true(const struct key_value_info *kvi,
395 struct config_include_data *inc,
396 const char *cond, size_t cond_len)
398 const struct config_options *opts = inc->opts;
400 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
401 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
402 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
403 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
404 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
405 return include_by_branch(cond, cond_len);
406 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
407 &cond_len))
408 return include_by_remote_url(inc, cond, cond_len);
410 /* unknown conditionals are always false */
411 return 0;
414 static int git_config_include(const char *var, const char *value,
415 const struct config_context *ctx,
416 void *data)
418 struct config_include_data *inc = data;
419 const char *cond, *key;
420 size_t cond_len;
421 int ret;
424 * Pass along all values, including "include" directives; this makes it
425 * possible to query information on the includes themselves.
427 ret = inc->fn(var, value, ctx, inc->data);
428 if (ret < 0)
429 return ret;
431 if (!strcmp(var, "include.path"))
432 ret = handle_path_include(ctx->kvi, value, inc);
434 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
435 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
436 !strcmp(key, "path")) {
437 config_fn_t old_fn = inc->fn;
439 if (inc->opts->unconditional_remote_url)
440 inc->fn = forbid_remote_url;
441 ret = handle_path_include(ctx->kvi, value, inc);
442 inc->fn = old_fn;
445 return ret;
448 static void git_config_push_split_parameter(const char *key, const char *value)
450 struct strbuf env = STRBUF_INIT;
451 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
452 if (old && *old) {
453 strbuf_addstr(&env, old);
454 strbuf_addch(&env, ' ');
456 sq_quote_buf(&env, key);
457 strbuf_addch(&env, '=');
458 if (value)
459 sq_quote_buf(&env, value);
460 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
461 strbuf_release(&env);
464 void git_config_push_parameter(const char *text)
466 const char *value;
469 * When we see:
471 * section.subsection=with=equals.key=value
473 * we cannot tell if it means:
475 * [section "subsection=with=equals"]
476 * key = value
478 * or:
480 * [section]
481 * subsection = with=equals.key=value
483 * We parse left-to-right for the first "=", meaning we'll prefer to
484 * keep the value intact over the subsection. This is historical, but
485 * also sensible since values are more likely to contain odd or
486 * untrusted input than a section name.
488 * A missing equals is explicitly allowed (as a bool-only entry).
490 value = strchr(text, '=');
491 if (value) {
492 char *key = xmemdupz(text, value - text);
493 git_config_push_split_parameter(key, value + 1);
494 free(key);
495 } else {
496 git_config_push_split_parameter(text, NULL);
500 void git_config_push_env(const char *spec)
502 char *key;
503 const char *env_name;
504 const char *env_value;
506 env_name = strrchr(spec, '=');
507 if (!env_name)
508 die(_("invalid config format: %s"), spec);
509 key = xmemdupz(spec, env_name - spec);
510 env_name++;
511 if (!*env_name)
512 die(_("missing environment variable name for configuration '%.*s'"),
513 (int)(env_name - spec - 1), spec);
515 env_value = getenv(env_name);
516 if (!env_value)
517 die(_("missing environment variable '%s' for configuration '%.*s'"),
518 env_name, (int)(env_name - spec - 1), spec);
520 git_config_push_split_parameter(key, env_value);
521 free(key);
524 static inline int iskeychar(int c)
526 return isalnum(c) || c == '-';
530 * Auxiliary function to sanity-check and split the key into the section
531 * identifier and variable name.
533 * Returns 0 on success, -1 when there is an invalid character in the key and
534 * -2 if there is no section name in the key.
536 * store_key - pointer to char* which will hold a copy of the key with
537 * lowercase section and variable name
538 * baselen - pointer to size_t which will hold the length of the
539 * section + subsection part, can be NULL
541 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
543 size_t i, baselen;
544 int dot;
545 const char *last_dot = strrchr(key, '.');
548 * Since "key" actually contains the section name and the real
549 * key name separated by a dot, we have to know where the dot is.
552 if (last_dot == NULL || last_dot == key) {
553 error(_("key does not contain a section: %s"), key);
554 return -CONFIG_NO_SECTION_OR_NAME;
557 if (!last_dot[1]) {
558 error(_("key does not contain variable name: %s"), key);
559 return -CONFIG_NO_SECTION_OR_NAME;
562 baselen = last_dot - key;
563 if (baselen_)
564 *baselen_ = baselen;
567 * Validate the key and while at it, lower case it for matching.
569 *store_key = xmallocz(strlen(key));
571 dot = 0;
572 for (i = 0; key[i]; i++) {
573 unsigned char c = key[i];
574 if (c == '.')
575 dot = 1;
576 /* Leave the extended basename untouched.. */
577 if (!dot || i > baselen) {
578 if (!iskeychar(c) ||
579 (i == baselen + 1 && !isalpha(c))) {
580 error(_("invalid key: %s"), key);
581 goto out_free_ret_1;
583 c = tolower(c);
584 } else if (c == '\n') {
585 error(_("invalid key (newline): %s"), key);
586 goto out_free_ret_1;
588 (*store_key)[i] = c;
591 return 0;
593 out_free_ret_1:
594 FREE_AND_NULL(*store_key);
595 return -CONFIG_INVALID_KEY;
598 static int config_parse_pair(const char *key, const char *value,
599 struct key_value_info *kvi,
600 config_fn_t fn, void *data)
602 char *canonical_name;
603 int ret;
604 struct config_context ctx = {
605 .kvi = kvi,
608 if (!strlen(key))
609 return error(_("empty config key"));
610 if (git_config_parse_key(key, &canonical_name, NULL))
611 return -1;
613 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
614 free(canonical_name);
615 return ret;
619 /* for values read from `git_config_from_parameters()` */
620 void kvi_from_param(struct key_value_info *out)
622 out->filename = NULL;
623 out->linenr = -1;
624 out->origin_type = CONFIG_ORIGIN_CMDLINE;
625 out->scope = CONFIG_SCOPE_COMMAND;
626 out->path = NULL;
629 int git_config_parse_parameter(const char *text,
630 config_fn_t fn, void *data)
632 const char *value;
633 struct strbuf **pair;
634 int ret;
635 struct key_value_info kvi = KVI_INIT;
637 kvi_from_param(&kvi);
639 pair = strbuf_split_str(text, '=', 2);
640 if (!pair[0])
641 return error(_("bogus config parameter: %s"), text);
643 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
644 strbuf_setlen(pair[0], pair[0]->len - 1);
645 value = pair[1] ? pair[1]->buf : "";
646 } else {
647 value = NULL;
650 strbuf_trim(pair[0]);
651 if (!pair[0]->len) {
652 strbuf_list_free(pair);
653 return error(_("bogus config parameter: %s"), text);
656 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
657 strbuf_list_free(pair);
658 return ret;
661 static int parse_config_env_list(char *env, struct key_value_info *kvi,
662 config_fn_t fn, void *data)
664 char *cur = env;
665 while (cur && *cur) {
666 const char *key = sq_dequote_step(cur, &cur);
667 if (!key)
668 return error(_("bogus format in %s"),
669 CONFIG_DATA_ENVIRONMENT);
671 if (!cur || isspace(*cur)) {
672 /* old-style 'key=value' */
673 if (git_config_parse_parameter(key, fn, data) < 0)
674 return -1;
676 else if (*cur == '=') {
677 /* new-style 'key'='value' */
678 const char *value;
680 cur++;
681 if (*cur == '\'') {
682 /* quoted value */
683 value = sq_dequote_step(cur, &cur);
684 if (!value || (cur && !isspace(*cur))) {
685 return error(_("bogus format in %s"),
686 CONFIG_DATA_ENVIRONMENT);
688 } else if (!*cur || isspace(*cur)) {
689 /* implicit bool: 'key'= */
690 value = NULL;
691 } else {
692 return error(_("bogus format in %s"),
693 CONFIG_DATA_ENVIRONMENT);
696 if (config_parse_pair(key, value, kvi, fn, data) < 0)
697 return -1;
699 else {
700 /* unknown format */
701 return error(_("bogus format in %s"),
702 CONFIG_DATA_ENVIRONMENT);
705 if (cur) {
706 while (isspace(*cur))
707 cur++;
710 return 0;
713 int git_config_from_parameters(config_fn_t fn, void *data)
715 const char *env;
716 struct strbuf envvar = STRBUF_INIT;
717 struct strvec to_free = STRVEC_INIT;
718 int ret = 0;
719 char *envw = NULL;
720 struct key_value_info kvi = KVI_INIT;
722 kvi_from_param(&kvi);
723 env = getenv(CONFIG_COUNT_ENVIRONMENT);
724 if (env) {
725 unsigned long count;
726 char *endp;
727 int i;
729 count = strtoul(env, &endp, 10);
730 if (*endp) {
731 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
732 goto out;
734 if (count > INT_MAX) {
735 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
736 goto out;
739 for (i = 0; i < count; i++) {
740 const char *key, *value;
742 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
743 key = getenv_safe(&to_free, envvar.buf);
744 if (!key) {
745 ret = error(_("missing config key %s"), envvar.buf);
746 goto out;
748 strbuf_reset(&envvar);
750 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
751 value = getenv_safe(&to_free, envvar.buf);
752 if (!value) {
753 ret = error(_("missing config value %s"), envvar.buf);
754 goto out;
756 strbuf_reset(&envvar);
758 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
759 ret = -1;
760 goto out;
765 env = getenv(CONFIG_DATA_ENVIRONMENT);
766 if (env) {
767 /* sq_dequote will write over it */
768 envw = xstrdup(env);
769 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
770 ret = -1;
771 goto out;
775 out:
776 strbuf_release(&envvar);
777 strvec_clear(&to_free);
778 free(envw);
779 return ret;
782 static int get_next_char(struct config_source *cs)
784 int c = cs->do_fgetc(cs);
786 if (c == '\r') {
787 /* DOS like systems */
788 c = cs->do_fgetc(cs);
789 if (c != '\n') {
790 if (c != EOF)
791 cs->do_ungetc(c, cs);
792 c = '\r';
796 if (c != EOF && ++cs->total_len > INT_MAX) {
798 * This is an absurdly long config file; refuse to parse
799 * further in order to protect downstream code from integer
800 * overflows. Note that we can't return an error specifically,
801 * but we can mark EOF and put trash in the return value,
802 * which will trigger a parse error.
804 cs->eof = 1;
805 return 0;
808 if (c == '\n')
809 cs->linenr++;
810 if (c == EOF) {
811 cs->eof = 1;
812 cs->linenr++;
813 c = '\n';
815 return c;
818 static char *parse_value(struct config_source *cs)
820 int quote = 0, comment = 0, space = 0;
822 strbuf_reset(&cs->value);
823 for (;;) {
824 int c = get_next_char(cs);
825 if (c == '\n') {
826 if (quote) {
827 cs->linenr--;
828 return NULL;
830 return cs->value.buf;
832 if (comment)
833 continue;
834 if (isspace(c) && !quote) {
835 if (cs->value.len)
836 space++;
837 continue;
839 if (!quote) {
840 if (c == ';' || c == '#') {
841 comment = 1;
842 continue;
845 for (; space; space--)
846 strbuf_addch(&cs->value, ' ');
847 if (c == '\\') {
848 c = get_next_char(cs);
849 switch (c) {
850 case '\n':
851 continue;
852 case 't':
853 c = '\t';
854 break;
855 case 'b':
856 c = '\b';
857 break;
858 case 'n':
859 c = '\n';
860 break;
861 /* Some characters escape as themselves */
862 case '\\': case '"':
863 break;
864 /* Reject unknown escape sequences */
865 default:
866 return NULL;
868 strbuf_addch(&cs->value, c);
869 continue;
871 if (c == '"') {
872 quote = 1-quote;
873 continue;
875 strbuf_addch(&cs->value, c);
879 static int get_value(struct config_source *cs, struct key_value_info *kvi,
880 config_fn_t fn, void *data, struct strbuf *name)
882 int c;
883 char *value;
884 int ret;
885 struct config_context ctx = {
886 .kvi = kvi,
889 /* Get the full name */
890 for (;;) {
891 c = get_next_char(cs);
892 if (cs->eof)
893 break;
894 if (!iskeychar(c))
895 break;
896 strbuf_addch(name, tolower(c));
899 while (c == ' ' || c == '\t')
900 c = get_next_char(cs);
902 value = NULL;
903 if (c != '\n') {
904 if (c != '=')
905 return -1;
906 value = parse_value(cs);
907 if (!value)
908 return -1;
911 * We already consumed the \n, but we need linenr to point to
912 * the line we just parsed during the call to fn to get
913 * accurate line number in error messages.
915 cs->linenr--;
916 kvi->linenr = cs->linenr;
917 ret = fn(name->buf, value, &ctx, data);
918 if (ret >= 0)
919 cs->linenr++;
920 return ret;
923 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
924 int c)
926 cs->subsection_case_sensitive = 0;
927 do {
928 if (c == '\n')
929 goto error_incomplete_line;
930 c = get_next_char(cs);
931 } while (isspace(c));
933 /* We require the format to be '[base "extension"]' */
934 if (c != '"')
935 return -1;
936 strbuf_addch(name, '.');
938 for (;;) {
939 int c = get_next_char(cs);
940 if (c == '\n')
941 goto error_incomplete_line;
942 if (c == '"')
943 break;
944 if (c == '\\') {
945 c = get_next_char(cs);
946 if (c == '\n')
947 goto error_incomplete_line;
949 strbuf_addch(name, c);
952 /* Final ']' */
953 if (get_next_char(cs) != ']')
954 return -1;
955 return 0;
956 error_incomplete_line:
957 cs->linenr--;
958 return -1;
961 static int get_base_var(struct config_source *cs, struct strbuf *name)
963 cs->subsection_case_sensitive = 1;
964 for (;;) {
965 int c = get_next_char(cs);
966 if (cs->eof)
967 return -1;
968 if (c == ']')
969 return 0;
970 if (isspace(c))
971 return get_extended_base_var(cs, name, c);
972 if (!iskeychar(c) && c != '.')
973 return -1;
974 strbuf_addch(name, tolower(c));
978 struct parse_event_data {
979 enum config_event_t previous_type;
980 size_t previous_offset;
981 const struct config_options *opts;
984 static int do_event(struct config_source *cs, enum config_event_t type,
985 struct parse_event_data *data)
987 size_t offset;
989 if (!data->opts || !data->opts->event_fn)
990 return 0;
992 if (type == CONFIG_EVENT_WHITESPACE &&
993 data->previous_type == type)
994 return 0;
996 offset = cs->do_ftell(cs);
998 * At EOF, the parser always "inserts" an extra '\n', therefore
999 * the end offset of the event is the current file position, otherwise
1000 * we will already have advanced to the next event.
1002 if (type != CONFIG_EVENT_EOF)
1003 offset--;
1005 if (data->previous_type != CONFIG_EVENT_EOF &&
1006 data->opts->event_fn(data->previous_type, data->previous_offset,
1007 offset, cs, data->opts->event_fn_data) < 0)
1008 return -1;
1010 data->previous_type = type;
1011 data->previous_offset = offset;
1013 return 0;
1016 static void kvi_from_source(struct config_source *cs,
1017 enum config_scope scope,
1018 struct key_value_info *out)
1020 out->filename = strintern(cs->name);
1021 out->origin_type = cs->origin_type;
1022 out->linenr = cs->linenr;
1023 out->scope = scope;
1024 out->path = cs->path;
1027 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1028 struct key_value_info *kvi, void *data,
1029 const struct config_options *opts)
1031 int comment = 0;
1032 size_t baselen = 0;
1033 struct strbuf *var = &cs->var;
1034 int error_return = 0;
1035 char *error_msg = NULL;
1037 /* U+FEFF Byte Order Mark in UTF8 */
1038 const char *bomptr = utf8_bom;
1040 /* For the parser event callback */
1041 struct parse_event_data event_data = {
1042 CONFIG_EVENT_EOF, 0, opts
1045 for (;;) {
1046 int c;
1048 c = get_next_char(cs);
1049 if (bomptr && *bomptr) {
1050 /* We are at the file beginning; skip UTF8-encoded BOM
1051 * if present. Sane editors won't put this in on their
1052 * own, but e.g. Windows Notepad will do it happily. */
1053 if (c == (*bomptr & 0377)) {
1054 bomptr++;
1055 continue;
1056 } else {
1057 /* Do not tolerate partial BOM. */
1058 if (bomptr != utf8_bom)
1059 break;
1060 /* No BOM at file beginning. Cool. */
1061 bomptr = NULL;
1064 if (c == '\n') {
1065 if (cs->eof) {
1066 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1067 return -1;
1068 return 0;
1070 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1071 return -1;
1072 comment = 0;
1073 continue;
1075 if (comment)
1076 continue;
1077 if (isspace(c)) {
1078 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1079 return -1;
1080 continue;
1082 if (c == '#' || c == ';') {
1083 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1084 return -1;
1085 comment = 1;
1086 continue;
1088 if (c == '[') {
1089 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1090 return -1;
1092 /* Reset prior to determining a new stem */
1093 strbuf_reset(var);
1094 if (get_base_var(cs, var) < 0 || var->len < 1)
1095 break;
1096 strbuf_addch(var, '.');
1097 baselen = var->len;
1098 continue;
1100 if (!isalpha(c))
1101 break;
1103 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1104 return -1;
1107 * Truncate the var name back to the section header
1108 * stem prior to grabbing the suffix part of the name
1109 * and the value.
1111 strbuf_setlen(var, baselen);
1112 strbuf_addch(var, tolower(c));
1113 if (get_value(cs, kvi, fn, data, var) < 0)
1114 break;
1117 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1118 return -1;
1120 switch (cs->origin_type) {
1121 case CONFIG_ORIGIN_BLOB:
1122 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1123 cs->linenr, cs->name);
1124 break;
1125 case CONFIG_ORIGIN_FILE:
1126 error_msg = xstrfmt(_("bad config line %d in file %s"),
1127 cs->linenr, cs->name);
1128 break;
1129 case CONFIG_ORIGIN_STDIN:
1130 error_msg = xstrfmt(_("bad config line %d in standard input"),
1131 cs->linenr);
1132 break;
1133 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1134 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1135 cs->linenr, cs->name);
1136 break;
1137 case CONFIG_ORIGIN_CMDLINE:
1138 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1139 cs->linenr, cs->name);
1140 break;
1141 default:
1142 error_msg = xstrfmt(_("bad config line %d in %s"),
1143 cs->linenr, cs->name);
1146 switch (opts && opts->error_action ?
1147 opts->error_action :
1148 cs->default_error_action) {
1149 case CONFIG_ERROR_DIE:
1150 die("%s", error_msg);
1151 break;
1152 case CONFIG_ERROR_ERROR:
1153 error_return = error("%s", error_msg);
1154 break;
1155 case CONFIG_ERROR_SILENT:
1156 error_return = -1;
1157 break;
1158 case CONFIG_ERROR_UNSET:
1159 BUG("config error action unset");
1162 free(error_msg);
1163 return error_return;
1166 NORETURN
1167 static void die_bad_number(const char *name, const char *value,
1168 const struct key_value_info *kvi)
1170 const char *error_type = (errno == ERANGE) ?
1171 N_("out of range") : N_("invalid unit");
1172 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1174 if (!kvi)
1175 BUG("kvi should not be NULL");
1177 if (!value)
1178 value = "";
1180 if (!kvi->filename)
1181 die(_(bad_numeric), value, name, _(error_type));
1183 switch (kvi->origin_type) {
1184 case CONFIG_ORIGIN_BLOB:
1185 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1186 value, name, kvi->filename, _(error_type));
1187 case CONFIG_ORIGIN_FILE:
1188 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1189 value, name, kvi->filename, _(error_type));
1190 case CONFIG_ORIGIN_STDIN:
1191 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1192 value, name, _(error_type));
1193 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1194 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1195 value, name, kvi->filename, _(error_type));
1196 case CONFIG_ORIGIN_CMDLINE:
1197 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1198 value, name, kvi->filename, _(error_type));
1199 default:
1200 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1201 value, name, kvi->filename, _(error_type));
1205 int git_config_int(const char *name, const char *value,
1206 const struct key_value_info *kvi)
1208 int ret;
1209 if (!git_parse_int(value, &ret))
1210 die_bad_number(name, value, kvi);
1211 return ret;
1214 int64_t git_config_int64(const char *name, const char *value,
1215 const struct key_value_info *kvi)
1217 int64_t ret;
1218 if (!git_parse_int64(value, &ret))
1219 die_bad_number(name, value, kvi);
1220 return ret;
1223 unsigned long git_config_ulong(const char *name, const char *value,
1224 const struct key_value_info *kvi)
1226 unsigned long ret;
1227 if (!git_parse_ulong(value, &ret))
1228 die_bad_number(name, value, kvi);
1229 return ret;
1232 ssize_t git_config_ssize_t(const char *name, const char *value,
1233 const struct key_value_info *kvi)
1235 ssize_t ret;
1236 if (!git_parse_ssize_t(value, &ret))
1237 die_bad_number(name, value, kvi);
1238 return ret;
1241 static const struct fsync_component_name {
1242 const char *name;
1243 enum fsync_component component_bits;
1244 } fsync_component_names[] = {
1245 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1246 { "pack", FSYNC_COMPONENT_PACK },
1247 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1248 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1249 { "index", FSYNC_COMPONENT_INDEX },
1250 { "objects", FSYNC_COMPONENTS_OBJECTS },
1251 { "reference", FSYNC_COMPONENT_REFERENCE },
1252 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1253 { "committed", FSYNC_COMPONENTS_COMMITTED },
1254 { "added", FSYNC_COMPONENTS_ADDED },
1255 { "all", FSYNC_COMPONENTS_ALL },
1258 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1260 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1261 enum fsync_component positive = 0, negative = 0;
1263 while (string) {
1264 int i;
1265 size_t len;
1266 const char *ep;
1267 int negated = 0;
1268 int found = 0;
1270 string = string + strspn(string, ", \t\n\r");
1271 ep = strchrnul(string, ',');
1272 len = ep - string;
1273 if (!strcmp(string, "none")) {
1274 current = FSYNC_COMPONENT_NONE;
1275 goto next_name;
1278 if (*string == '-') {
1279 negated = 1;
1280 string++;
1281 len--;
1282 if (!len)
1283 warning(_("invalid value for variable %s"), var);
1286 if (!len)
1287 break;
1289 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1290 const struct fsync_component_name *n = &fsync_component_names[i];
1292 if (strncmp(n->name, string, len))
1293 continue;
1295 found = 1;
1296 if (negated)
1297 negative |= n->component_bits;
1298 else
1299 positive |= n->component_bits;
1302 if (!found) {
1303 char *component = xstrndup(string, len);
1304 warning(_("ignoring unknown core.fsync component '%s'"), component);
1305 free(component);
1308 next_name:
1309 string = ep;
1312 return (current & ~negative) | positive;
1315 int git_config_bool_or_int(const char *name, const char *value,
1316 const struct key_value_info *kvi, int *is_bool)
1318 int v = git_parse_maybe_bool_text(value);
1319 if (0 <= v) {
1320 *is_bool = 1;
1321 return v;
1323 *is_bool = 0;
1324 return git_config_int(name, value, kvi);
1327 int git_config_bool(const char *name, const char *value)
1329 int v = git_parse_maybe_bool(value);
1330 if (v < 0)
1331 die(_("bad boolean config value '%s' for '%s'"), value, name);
1332 return v;
1335 int git_config_string(const char **dest, const char *var, const char *value)
1337 if (!value)
1338 return config_error_nonbool(var);
1339 *dest = xstrdup(value);
1340 return 0;
1343 int git_config_pathname(const char **dest, const char *var, const char *value)
1345 if (!value)
1346 return config_error_nonbool(var);
1347 *dest = interpolate_path(value, 0);
1348 if (!*dest)
1349 die(_("failed to expand user dir in: '%s'"), value);
1350 return 0;
1353 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1355 if (!value)
1356 return config_error_nonbool(var);
1357 if (parse_expiry_date(value, timestamp))
1358 return error(_("'%s' for '%s' is not a valid timestamp"),
1359 value, var);
1360 return 0;
1363 int git_config_color(char *dest, const char *var, const char *value)
1365 if (!value)
1366 return config_error_nonbool(var);
1367 if (color_parse(value, dest) < 0)
1368 return -1;
1369 return 0;
1372 static int git_default_core_config(const char *var, const char *value,
1373 const struct config_context *ctx, void *cb)
1375 /* This needs a better name */
1376 if (!strcmp(var, "core.filemode")) {
1377 trust_executable_bit = git_config_bool(var, value);
1378 return 0;
1380 if (!strcmp(var, "core.trustctime")) {
1381 trust_ctime = git_config_bool(var, value);
1382 return 0;
1384 if (!strcmp(var, "core.checkstat")) {
1385 if (!value)
1386 return config_error_nonbool(var);
1387 if (!strcasecmp(value, "default"))
1388 check_stat = 1;
1389 else if (!strcasecmp(value, "minimal"))
1390 check_stat = 0;
1391 else
1392 return error(_("invalid value for '%s': '%s'"),
1393 var, value);
1396 if (!strcmp(var, "core.quotepath")) {
1397 quote_path_fully = git_config_bool(var, value);
1398 return 0;
1401 if (!strcmp(var, "core.symlinks")) {
1402 has_symlinks = git_config_bool(var, value);
1403 return 0;
1406 if (!strcmp(var, "core.ignorecase")) {
1407 ignore_case = git_config_bool(var, value);
1408 return 0;
1411 if (!strcmp(var, "core.attributesfile"))
1412 return git_config_pathname(&git_attributes_file, var, value);
1414 if (!strcmp(var, "core.hookspath"))
1415 return git_config_pathname(&git_hooks_path, var, value);
1417 if (!strcmp(var, "core.bare")) {
1418 is_bare_repository_cfg = git_config_bool(var, value);
1419 return 0;
1422 if (!strcmp(var, "core.ignorestat")) {
1423 assume_unchanged = git_config_bool(var, value);
1424 return 0;
1427 if (!strcmp(var, "core.prefersymlinkrefs")) {
1428 prefer_symlink_refs = git_config_bool(var, value);
1429 return 0;
1432 if (!strcmp(var, "core.logallrefupdates")) {
1433 if (value && !strcasecmp(value, "always"))
1434 log_all_ref_updates = LOG_REFS_ALWAYS;
1435 else if (git_config_bool(var, value))
1436 log_all_ref_updates = LOG_REFS_NORMAL;
1437 else
1438 log_all_ref_updates = LOG_REFS_NONE;
1439 return 0;
1442 if (!strcmp(var, "core.warnambiguousrefs")) {
1443 warn_ambiguous_refs = git_config_bool(var, value);
1444 return 0;
1447 if (!strcmp(var, "core.abbrev")) {
1448 if (!value)
1449 return config_error_nonbool(var);
1450 if (!strcasecmp(value, "auto"))
1451 default_abbrev = -1;
1452 else if (!git_parse_maybe_bool_text(value))
1453 default_abbrev = the_hash_algo->hexsz;
1454 else {
1455 int abbrev = git_config_int(var, value, ctx->kvi);
1456 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1457 return error(_("abbrev length out of range: %d"), abbrev);
1458 default_abbrev = abbrev;
1460 return 0;
1463 if (!strcmp(var, "core.disambiguate"))
1464 return set_disambiguate_hint_config(var, value);
1466 if (!strcmp(var, "core.loosecompression")) {
1467 int level = git_config_int(var, value, ctx->kvi);
1468 if (level == -1)
1469 level = Z_DEFAULT_COMPRESSION;
1470 else if (level < 0 || level > Z_BEST_COMPRESSION)
1471 die(_("bad zlib compression level %d"), level);
1472 zlib_compression_level = level;
1473 zlib_compression_seen = 1;
1474 return 0;
1477 if (!strcmp(var, "core.compression")) {
1478 int level = git_config_int(var, value, ctx->kvi);
1479 if (level == -1)
1480 level = Z_DEFAULT_COMPRESSION;
1481 else if (level < 0 || level > Z_BEST_COMPRESSION)
1482 die(_("bad zlib compression level %d"), level);
1483 if (!zlib_compression_seen)
1484 zlib_compression_level = level;
1485 if (!pack_compression_seen)
1486 pack_compression_level = level;
1487 return 0;
1490 if (!strcmp(var, "core.packedgitwindowsize")) {
1491 int pgsz_x2 = getpagesize() * 2;
1492 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1494 /* This value must be multiple of (pagesize * 2) */
1495 packed_git_window_size /= pgsz_x2;
1496 if (packed_git_window_size < 1)
1497 packed_git_window_size = 1;
1498 packed_git_window_size *= pgsz_x2;
1499 return 0;
1502 if (!strcmp(var, "core.bigfilethreshold")) {
1503 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1504 return 0;
1507 if (!strcmp(var, "core.packedgitlimit")) {
1508 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1509 return 0;
1512 if (!strcmp(var, "core.deltabasecachelimit")) {
1513 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1514 return 0;
1517 if (!strcmp(var, "core.autocrlf")) {
1518 if (value && !strcasecmp(value, "input")) {
1519 auto_crlf = AUTO_CRLF_INPUT;
1520 return 0;
1522 auto_crlf = git_config_bool(var, value);
1523 return 0;
1526 if (!strcmp(var, "core.safecrlf")) {
1527 int eol_rndtrp_die;
1528 if (value && !strcasecmp(value, "warn")) {
1529 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1530 return 0;
1532 eol_rndtrp_die = git_config_bool(var, value);
1533 global_conv_flags_eol = eol_rndtrp_die ?
1534 CONV_EOL_RNDTRP_DIE : 0;
1535 return 0;
1538 if (!strcmp(var, "core.eol")) {
1539 if (value && !strcasecmp(value, "lf"))
1540 core_eol = EOL_LF;
1541 else if (value && !strcasecmp(value, "crlf"))
1542 core_eol = EOL_CRLF;
1543 else if (value && !strcasecmp(value, "native"))
1544 core_eol = EOL_NATIVE;
1545 else
1546 core_eol = EOL_UNSET;
1547 return 0;
1550 if (!strcmp(var, "core.checkroundtripencoding"))
1551 return git_config_string(&check_roundtrip_encoding, var, value);
1553 if (!strcmp(var, "core.notesref")) {
1554 if (!value)
1555 return config_error_nonbool(var);
1556 notes_ref_name = xstrdup(value);
1557 return 0;
1560 if (!strcmp(var, "core.editor"))
1561 return git_config_string(&editor_program, var, value);
1563 if (!strcmp(var, "core.commentchar")) {
1564 if (!value)
1565 return config_error_nonbool(var);
1566 else if (!strcasecmp(value, "auto"))
1567 auto_comment_line_char = 1;
1568 else if (value[0] && !value[1]) {
1569 comment_line_char = value[0];
1570 auto_comment_line_char = 0;
1571 } else
1572 return error(_("core.commentChar should only be one ASCII character"));
1573 return 0;
1576 if (!strcmp(var, "core.askpass"))
1577 return git_config_string(&askpass_program, var, value);
1579 if (!strcmp(var, "core.excludesfile"))
1580 return git_config_pathname(&excludes_file, var, value);
1582 if (!strcmp(var, "core.whitespace")) {
1583 if (!value)
1584 return config_error_nonbool(var);
1585 whitespace_rule_cfg = parse_whitespace_rule(value);
1586 return 0;
1589 if (!strcmp(var, "core.fsync")) {
1590 if (!value)
1591 return config_error_nonbool(var);
1592 fsync_components = parse_fsync_components(var, value);
1593 return 0;
1596 if (!strcmp(var, "core.fsyncmethod")) {
1597 if (!value)
1598 return config_error_nonbool(var);
1599 if (!strcmp(value, "fsync"))
1600 fsync_method = FSYNC_METHOD_FSYNC;
1601 else if (!strcmp(value, "writeout-only"))
1602 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1603 else if (!strcmp(value, "batch"))
1604 fsync_method = FSYNC_METHOD_BATCH;
1605 else
1606 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1610 if (!strcmp(var, "core.fsyncobjectfiles")) {
1611 if (fsync_object_files < 0)
1612 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1613 fsync_object_files = git_config_bool(var, value);
1614 return 0;
1617 if (!strcmp(var, "core.preloadindex")) {
1618 core_preload_index = git_config_bool(var, value);
1619 return 0;
1622 if (!strcmp(var, "core.createobject")) {
1623 if (!value)
1624 return config_error_nonbool(var);
1625 if (!strcmp(value, "rename"))
1626 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1627 else if (!strcmp(value, "link"))
1628 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1629 else
1630 die(_("invalid mode for object creation: %s"), value);
1631 return 0;
1634 if (!strcmp(var, "core.sparsecheckout")) {
1635 core_apply_sparse_checkout = git_config_bool(var, value);
1636 return 0;
1639 if (!strcmp(var, "core.sparsecheckoutcone")) {
1640 core_sparse_checkout_cone = git_config_bool(var, value);
1641 return 0;
1644 if (!strcmp(var, "core.precomposeunicode")) {
1645 precomposed_unicode = git_config_bool(var, value);
1646 return 0;
1649 if (!strcmp(var, "core.protecthfs")) {
1650 protect_hfs = git_config_bool(var, value);
1651 return 0;
1654 if (!strcmp(var, "core.protectntfs")) {
1655 protect_ntfs = git_config_bool(var, value);
1656 return 0;
1659 if (!strcmp(var, "core.maxtreedepth")) {
1660 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1661 return 0;
1664 /* Add other config variables here and to Documentation/config.txt. */
1665 return platform_core_config(var, value, ctx, cb);
1668 static int git_default_sparse_config(const char *var, const char *value)
1670 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1671 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1672 return 0;
1675 /* Add other config variables here and to Documentation/config/sparse.txt. */
1676 return 0;
1679 static int git_default_i18n_config(const char *var, const char *value)
1681 if (!strcmp(var, "i18n.commitencoding"))
1682 return git_config_string(&git_commit_encoding, var, value);
1684 if (!strcmp(var, "i18n.logoutputencoding"))
1685 return git_config_string(&git_log_output_encoding, var, value);
1687 /* Add other config variables here and to Documentation/config.txt. */
1688 return 0;
1691 static int git_default_branch_config(const char *var, const char *value)
1693 if (!strcmp(var, "branch.autosetupmerge")) {
1694 if (value && !strcmp(value, "always")) {
1695 git_branch_track = BRANCH_TRACK_ALWAYS;
1696 return 0;
1697 } else if (value && !strcmp(value, "inherit")) {
1698 git_branch_track = BRANCH_TRACK_INHERIT;
1699 return 0;
1700 } else if (value && !strcmp(value, "simple")) {
1701 git_branch_track = BRANCH_TRACK_SIMPLE;
1702 return 0;
1704 git_branch_track = git_config_bool(var, value);
1705 return 0;
1707 if (!strcmp(var, "branch.autosetuprebase")) {
1708 if (!value)
1709 return config_error_nonbool(var);
1710 else if (!strcmp(value, "never"))
1711 autorebase = AUTOREBASE_NEVER;
1712 else if (!strcmp(value, "local"))
1713 autorebase = AUTOREBASE_LOCAL;
1714 else if (!strcmp(value, "remote"))
1715 autorebase = AUTOREBASE_REMOTE;
1716 else if (!strcmp(value, "always"))
1717 autorebase = AUTOREBASE_ALWAYS;
1718 else
1719 return error(_("malformed value for %s"), var);
1720 return 0;
1723 /* Add other config variables here and to Documentation/config.txt. */
1724 return 0;
1727 static int git_default_push_config(const char *var, const char *value)
1729 if (!strcmp(var, "push.default")) {
1730 if (!value)
1731 return config_error_nonbool(var);
1732 else if (!strcmp(value, "nothing"))
1733 push_default = PUSH_DEFAULT_NOTHING;
1734 else if (!strcmp(value, "matching"))
1735 push_default = PUSH_DEFAULT_MATCHING;
1736 else if (!strcmp(value, "simple"))
1737 push_default = PUSH_DEFAULT_SIMPLE;
1738 else if (!strcmp(value, "upstream"))
1739 push_default = PUSH_DEFAULT_UPSTREAM;
1740 else if (!strcmp(value, "tracking")) /* deprecated */
1741 push_default = PUSH_DEFAULT_UPSTREAM;
1742 else if (!strcmp(value, "current"))
1743 push_default = PUSH_DEFAULT_CURRENT;
1744 else {
1745 error(_("malformed value for %s: %s"), var, value);
1746 return error(_("must be one of nothing, matching, simple, "
1747 "upstream or current"));
1749 return 0;
1752 /* Add other config variables here and to Documentation/config.txt. */
1753 return 0;
1756 static int git_default_mailmap_config(const char *var, const char *value)
1758 if (!strcmp(var, "mailmap.file"))
1759 return git_config_pathname(&git_mailmap_file, var, value);
1760 if (!strcmp(var, "mailmap.blob"))
1761 return git_config_string(&git_mailmap_blob, var, value);
1763 /* Add other config variables here and to Documentation/config.txt. */
1764 return 0;
1767 static int git_default_attr_config(const char *var, const char *value)
1769 if (!strcmp(var, "attr.tree"))
1770 return git_config_string(&git_attr_tree, var, value);
1773 * Add other attribute related config variables here and to
1774 * Documentation/config/attr.txt.
1776 return 0;
1779 int git_default_config(const char *var, const char *value,
1780 const struct config_context *ctx, void *cb)
1782 if (starts_with(var, "core."))
1783 return git_default_core_config(var, value, ctx, cb);
1785 if (starts_with(var, "user.") ||
1786 starts_with(var, "author.") ||
1787 starts_with(var, "committer."))
1788 return git_ident_config(var, value, ctx, cb);
1790 if (starts_with(var, "i18n."))
1791 return git_default_i18n_config(var, value);
1793 if (starts_with(var, "branch."))
1794 return git_default_branch_config(var, value);
1796 if (starts_with(var, "push."))
1797 return git_default_push_config(var, value);
1799 if (starts_with(var, "mailmap."))
1800 return git_default_mailmap_config(var, value);
1802 if (starts_with(var, "attr."))
1803 return git_default_attr_config(var, value);
1805 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1806 return git_default_advice_config(var, value);
1808 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1809 pager_use_color = git_config_bool(var,value);
1810 return 0;
1813 if (!strcmp(var, "pack.packsizelimit")) {
1814 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1815 return 0;
1818 if (!strcmp(var, "pack.compression")) {
1819 int level = git_config_int(var, value, ctx->kvi);
1820 if (level == -1)
1821 level = Z_DEFAULT_COMPRESSION;
1822 else if (level < 0 || level > Z_BEST_COMPRESSION)
1823 die(_("bad pack compression level %d"), level);
1824 pack_compression_level = level;
1825 pack_compression_seen = 1;
1826 return 0;
1829 if (starts_with(var, "sparse."))
1830 return git_default_sparse_config(var, value);
1832 /* Add other config variables here and to Documentation/config.txt. */
1833 return 0;
1837 * All source specific fields in the union, die_on_error, name and the callbacks
1838 * fgetc, ungetc, ftell of top need to be initialized before calling
1839 * this function.
1841 static int do_config_from(struct config_source *top, config_fn_t fn,
1842 void *data, enum config_scope scope,
1843 const struct config_options *opts)
1845 struct key_value_info kvi = KVI_INIT;
1846 int ret;
1848 /* push config-file parsing state stack */
1849 top->linenr = 1;
1850 top->eof = 0;
1851 top->total_len = 0;
1852 strbuf_init(&top->value, 1024);
1853 strbuf_init(&top->var, 1024);
1854 kvi_from_source(top, scope, &kvi);
1856 ret = git_parse_source(top, fn, &kvi, data, opts);
1858 strbuf_release(&top->value);
1859 strbuf_release(&top->var);
1861 return ret;
1864 static int do_config_from_file(config_fn_t fn,
1865 const enum config_origin_type origin_type,
1866 const char *name, const char *path, FILE *f,
1867 void *data, enum config_scope scope,
1868 const struct config_options *opts)
1870 struct config_source top = CONFIG_SOURCE_INIT;
1871 int ret;
1873 top.u.file = f;
1874 top.origin_type = origin_type;
1875 top.name = name;
1876 top.path = path;
1877 top.default_error_action = CONFIG_ERROR_DIE;
1878 top.do_fgetc = config_file_fgetc;
1879 top.do_ungetc = config_file_ungetc;
1880 top.do_ftell = config_file_ftell;
1882 flockfile(f);
1883 ret = do_config_from(&top, fn, data, scope, opts);
1884 funlockfile(f);
1885 return ret;
1888 static int git_config_from_stdin(config_fn_t fn, void *data,
1889 enum config_scope scope)
1891 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1892 data, scope, NULL);
1895 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1896 void *data, enum config_scope scope,
1897 const struct config_options *opts)
1899 int ret = -1;
1900 FILE *f;
1902 if (!filename)
1903 BUG("filename cannot be NULL");
1904 f = fopen_or_warn(filename, "r");
1905 if (f) {
1906 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1907 filename, f, data, scope, opts);
1908 fclose(f);
1910 return ret;
1913 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1915 return git_config_from_file_with_options(fn, filename, data,
1916 CONFIG_SCOPE_UNKNOWN, NULL);
1919 int git_config_from_mem(config_fn_t fn,
1920 const enum config_origin_type origin_type,
1921 const char *name, const char *buf, size_t len,
1922 void *data, enum config_scope scope,
1923 const struct config_options *opts)
1925 struct config_source top = CONFIG_SOURCE_INIT;
1927 top.u.buf.buf = buf;
1928 top.u.buf.len = len;
1929 top.u.buf.pos = 0;
1930 top.origin_type = origin_type;
1931 top.name = name;
1932 top.path = NULL;
1933 top.default_error_action = CONFIG_ERROR_ERROR;
1934 top.do_fgetc = config_buf_fgetc;
1935 top.do_ungetc = config_buf_ungetc;
1936 top.do_ftell = config_buf_ftell;
1938 return do_config_from(&top, fn, data, scope, opts);
1941 int git_config_from_blob_oid(config_fn_t fn,
1942 const char *name,
1943 struct repository *repo,
1944 const struct object_id *oid,
1945 void *data,
1946 enum config_scope scope)
1948 enum object_type type;
1949 char *buf;
1950 unsigned long size;
1951 int ret;
1953 buf = repo_read_object_file(repo, oid, &type, &size);
1954 if (!buf)
1955 return error(_("unable to load config blob object '%s'"), name);
1956 if (type != OBJ_BLOB) {
1957 free(buf);
1958 return error(_("reference '%s' does not point to a blob"), name);
1961 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1962 data, scope, NULL);
1963 free(buf);
1965 return ret;
1968 static int git_config_from_blob_ref(config_fn_t fn,
1969 struct repository *repo,
1970 const char *name,
1971 void *data,
1972 enum config_scope scope)
1974 struct object_id oid;
1976 if (repo_get_oid(repo, name, &oid) < 0)
1977 return error(_("unable to resolve config blob '%s'"), name);
1978 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
1981 char *git_system_config(void)
1983 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1984 if (!system_config)
1985 system_config = system_path(ETC_GITCONFIG);
1986 normalize_path_copy(system_config, system_config);
1987 return system_config;
1990 char *git_global_config(void)
1992 char *user_config, *xdg_config;
1994 git_global_config_paths(&user_config, &xdg_config);
1995 if (!user_config) {
1996 free(xdg_config);
1997 return NULL;
2000 if (access_or_warn(user_config, R_OK, 0) && xdg_config &&
2001 !access_or_warn(xdg_config, R_OK, 0)) {
2002 free(user_config);
2003 return xdg_config;
2004 } else {
2005 free(xdg_config);
2006 return user_config;
2010 void git_global_config_paths(char **user_out, char **xdg_out)
2012 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2013 char *xdg_config = NULL;
2015 if (!user_config) {
2016 user_config = interpolate_path("~/.gitconfig", 0);
2017 xdg_config = xdg_config_home("config");
2020 *user_out = user_config;
2021 *xdg_out = xdg_config;
2024 int git_config_system(void)
2026 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2029 static int do_git_config_sequence(const struct config_options *opts,
2030 const struct repository *repo,
2031 config_fn_t fn, void *data)
2033 int ret = 0;
2034 char *system_config = git_system_config();
2035 char *xdg_config = NULL;
2036 char *user_config = NULL;
2037 char *repo_config;
2038 char *worktree_config;
2041 * Ensure that either:
2042 * - the git_dir and commondir are both set, or
2043 * - the git_dir and commondir are both NULL
2045 if (!opts->git_dir != !opts->commondir)
2046 BUG("only one of commondir and git_dir is non-NULL");
2048 if (opts->commondir) {
2049 repo_config = mkpathdup("%s/config", opts->commondir);
2050 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2051 } else {
2052 repo_config = NULL;
2053 worktree_config = NULL;
2056 if (git_config_system() && system_config &&
2057 !access_or_die(system_config, R_OK,
2058 opts->system_gently ? ACCESS_EACCES_OK : 0))
2059 ret += git_config_from_file_with_options(fn, system_config,
2060 data, CONFIG_SCOPE_SYSTEM,
2061 NULL);
2063 git_global_config_paths(&user_config, &xdg_config);
2065 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2066 ret += git_config_from_file_with_options(fn, xdg_config, data,
2067 CONFIG_SCOPE_GLOBAL, NULL);
2069 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2070 ret += git_config_from_file_with_options(fn, user_config, data,
2071 CONFIG_SCOPE_GLOBAL, NULL);
2073 if (!opts->ignore_repo && repo_config &&
2074 !access_or_die(repo_config, R_OK, 0))
2075 ret += git_config_from_file_with_options(fn, repo_config, data,
2076 CONFIG_SCOPE_LOCAL, NULL);
2078 if (!opts->ignore_worktree && worktree_config &&
2079 repo && repo->repository_format_worktree_config &&
2080 !access_or_die(worktree_config, R_OK, 0)) {
2081 ret += git_config_from_file_with_options(fn, worktree_config, data,
2082 CONFIG_SCOPE_WORKTREE,
2083 NULL);
2086 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2087 die(_("unable to parse command-line config"));
2089 free(system_config);
2090 free(xdg_config);
2091 free(user_config);
2092 free(repo_config);
2093 free(worktree_config);
2094 return ret;
2097 int config_with_options(config_fn_t fn, void *data,
2098 struct git_config_source *config_source,
2099 struct repository *repo,
2100 const struct config_options *opts)
2102 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2103 int ret;
2105 if (opts->respect_includes) {
2106 inc.fn = fn;
2107 inc.data = data;
2108 inc.opts = opts;
2109 inc.repo = repo;
2110 inc.config_source = config_source;
2111 fn = git_config_include;
2112 data = &inc;
2116 * If we have a specific filename, use it. Otherwise, follow the
2117 * regular lookup sequence.
2119 if (config_source && config_source->use_stdin) {
2120 ret = git_config_from_stdin(fn, data, config_source->scope);
2121 } else if (config_source && config_source->file) {
2122 ret = git_config_from_file_with_options(fn, config_source->file,
2123 data, config_source->scope,
2124 NULL);
2125 } else if (config_source && config_source->blob) {
2126 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2127 data, config_source->scope);
2128 } else {
2129 ret = do_git_config_sequence(opts, repo, fn, data);
2132 if (inc.remote_urls) {
2133 string_list_clear(inc.remote_urls, 0);
2134 FREE_AND_NULL(inc.remote_urls);
2136 return ret;
2139 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2141 int i, value_index;
2142 struct string_list *values;
2143 struct config_set_element *entry;
2144 struct configset_list *list = &set->list;
2145 struct config_context ctx = CONFIG_CONTEXT_INIT;
2147 for (i = 0; i < list->nr; i++) {
2148 entry = list->items[i].e;
2149 value_index = list->items[i].value_index;
2150 values = &entry->value_list;
2152 ctx.kvi = values->items[value_index].util;
2153 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2154 git_die_config_linenr(entry->key,
2155 ctx.kvi->filename,
2156 ctx.kvi->linenr);
2160 void read_early_config(config_fn_t cb, void *data)
2162 struct config_options opts = {0};
2163 struct strbuf commondir = STRBUF_INIT;
2164 struct strbuf gitdir = STRBUF_INIT;
2166 opts.respect_includes = 1;
2168 if (have_git_dir()) {
2169 opts.commondir = get_git_common_dir();
2170 opts.git_dir = get_git_dir();
2172 * When setup_git_directory() was not yet asked to discover the
2173 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2174 * is any repository config we should use (but unlike
2175 * setup_git_directory_gently(), no global state is changed, most
2176 * notably, the current working directory is still the same after the
2177 * call).
2179 } else if (!discover_git_directory(&commondir, &gitdir)) {
2180 opts.commondir = commondir.buf;
2181 opts.git_dir = gitdir.buf;
2184 config_with_options(cb, data, NULL, NULL, &opts);
2186 strbuf_release(&commondir);
2187 strbuf_release(&gitdir);
2191 * Read config but only enumerate system and global settings.
2192 * Omit any repo-local, worktree-local, or command-line settings.
2194 void read_very_early_config(config_fn_t cb, void *data)
2196 struct config_options opts = { 0 };
2198 opts.respect_includes = 1;
2199 opts.ignore_repo = 1;
2200 opts.ignore_worktree = 1;
2201 opts.ignore_cmdline = 1;
2202 opts.system_gently = 1;
2204 config_with_options(cb, data, NULL, NULL, &opts);
2207 RESULT_MUST_BE_USED
2208 static int configset_find_element(struct config_set *set, const char *key,
2209 struct config_set_element **dest)
2211 struct config_set_element k;
2212 struct config_set_element *found_entry;
2213 char *normalized_key;
2214 int ret;
2217 * `key` may come from the user, so normalize it before using it
2218 * for querying entries from the hashmap.
2220 ret = git_config_parse_key(key, &normalized_key, NULL);
2221 if (ret)
2222 return ret;
2224 hashmap_entry_init(&k.ent, strhash(normalized_key));
2225 k.key = normalized_key;
2226 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2227 free(normalized_key);
2228 *dest = found_entry;
2229 return 0;
2232 static int configset_add_value(const struct key_value_info *kvi_p,
2233 struct config_set *set, const char *key,
2234 const char *value)
2236 struct config_set_element *e;
2237 struct string_list_item *si;
2238 struct configset_list_item *l_item;
2239 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2240 int ret;
2242 ret = configset_find_element(set, key, &e);
2243 if (ret)
2244 return ret;
2246 * Since the keys are being fed by git_config*() callback mechanism, they
2247 * are already normalized. So simply add them without any further munging.
2249 if (!e) {
2250 e = xmalloc(sizeof(*e));
2251 hashmap_entry_init(&e->ent, strhash(key));
2252 e->key = xstrdup(key);
2253 string_list_init_dup(&e->value_list);
2254 hashmap_add(&set->config_hash, &e->ent);
2256 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2258 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2259 l_item = &set->list.items[set->list.nr++];
2260 l_item->e = e;
2261 l_item->value_index = e->value_list.nr - 1;
2263 *kv_info = *kvi_p;
2264 si->util = kv_info;
2266 return 0;
2269 static int config_set_element_cmp(const void *cmp_data UNUSED,
2270 const struct hashmap_entry *eptr,
2271 const struct hashmap_entry *entry_or_key,
2272 const void *keydata UNUSED)
2274 const struct config_set_element *e1, *e2;
2276 e1 = container_of(eptr, const struct config_set_element, ent);
2277 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2279 return strcmp(e1->key, e2->key);
2282 void git_configset_init(struct config_set *set)
2284 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2285 set->hash_initialized = 1;
2286 set->list.nr = 0;
2287 set->list.alloc = 0;
2288 set->list.items = NULL;
2291 void git_configset_clear(struct config_set *set)
2293 struct config_set_element *entry;
2294 struct hashmap_iter iter;
2295 if (!set->hash_initialized)
2296 return;
2298 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2299 ent /* member name */) {
2300 free(entry->key);
2301 string_list_clear(&entry->value_list, 1);
2303 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2304 set->hash_initialized = 0;
2305 free(set->list.items);
2306 set->list.nr = 0;
2307 set->list.alloc = 0;
2308 set->list.items = NULL;
2311 static int config_set_callback(const char *key, const char *value,
2312 const struct config_context *ctx,
2313 void *cb)
2315 struct config_set *set = cb;
2316 configset_add_value(ctx->kvi, set, key, value);
2317 return 0;
2320 int git_configset_add_file(struct config_set *set, const char *filename)
2322 return git_config_from_file(config_set_callback, filename, set);
2325 int git_configset_get_value(struct config_set *set, const char *key,
2326 const char **value, struct key_value_info *kvi)
2328 const struct string_list *values = NULL;
2329 int ret;
2330 struct string_list_item item;
2332 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2333 * queried key in the files of the configset, the value returned will be the last
2334 * value in the value list for that key.
2336 if ((ret = git_configset_get_value_multi(set, key, &values)))
2337 return ret;
2339 assert(values->nr > 0);
2340 item = values->items[values->nr - 1];
2341 *value = item.string;
2342 if (kvi)
2343 *kvi = *((struct key_value_info *)item.util);
2344 return 0;
2347 int git_configset_get_value_multi(struct config_set *set, const char *key,
2348 const struct string_list **dest)
2350 struct config_set_element *e;
2351 int ret;
2353 if ((ret = configset_find_element(set, key, &e)))
2354 return ret;
2355 else if (!e)
2356 return 1;
2357 *dest = &e->value_list;
2359 return 0;
2362 static int check_multi_string(struct string_list_item *item, void *util)
2364 return item->string ? 0 : config_error_nonbool(util);
2367 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2368 const struct string_list **dest)
2370 int ret;
2372 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2373 return ret;
2374 if ((ret = for_each_string_list((struct string_list *)*dest,
2375 check_multi_string, (void *)key)))
2376 return ret;
2378 return 0;
2381 int git_configset_get(struct config_set *set, const char *key)
2383 struct config_set_element *e;
2384 int ret;
2386 if ((ret = configset_find_element(set, key, &e)))
2387 return ret;
2388 else if (!e)
2389 return 1;
2390 return 0;
2393 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2395 const char *value;
2396 if (!git_configset_get_value(set, key, &value, NULL))
2397 return git_config_string((const char **)dest, key, value);
2398 else
2399 return 1;
2402 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2403 const char **dest)
2405 const char *value;
2406 if (!git_configset_get_value(set, key, &value, NULL)) {
2407 if (!value)
2408 return config_error_nonbool(key);
2409 *dest = value;
2410 return 0;
2411 } else {
2412 return 1;
2416 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2418 const char *value;
2419 struct key_value_info kvi;
2421 if (!git_configset_get_value(set, key, &value, &kvi)) {
2422 *dest = git_config_int(key, value, &kvi);
2423 return 0;
2424 } else
2425 return 1;
2428 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2430 const char *value;
2431 struct key_value_info kvi;
2433 if (!git_configset_get_value(set, key, &value, &kvi)) {
2434 *dest = git_config_ulong(key, value, &kvi);
2435 return 0;
2436 } else
2437 return 1;
2440 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2442 const char *value;
2443 if (!git_configset_get_value(set, key, &value, NULL)) {
2444 *dest = git_config_bool(key, value);
2445 return 0;
2446 } else
2447 return 1;
2450 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2451 int *is_bool, int *dest)
2453 const char *value;
2454 struct key_value_info kvi;
2456 if (!git_configset_get_value(set, key, &value, &kvi)) {
2457 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2458 return 0;
2459 } else
2460 return 1;
2463 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2465 const char *value;
2466 if (!git_configset_get_value(set, key, &value, NULL)) {
2467 *dest = git_parse_maybe_bool(value);
2468 if (*dest == -1)
2469 return -1;
2470 return 0;
2471 } else
2472 return 1;
2475 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2477 const char *value;
2478 if (!git_configset_get_value(set, key, &value, NULL))
2479 return git_config_pathname(dest, key, value);
2480 else
2481 return 1;
2484 /* Functions use to read configuration from a repository */
2485 static void repo_read_config(struct repository *repo)
2487 struct config_options opts = { 0 };
2489 opts.respect_includes = 1;
2490 opts.commondir = repo->commondir;
2491 opts.git_dir = repo->gitdir;
2493 if (!repo->config)
2494 CALLOC_ARRAY(repo->config, 1);
2495 else
2496 git_configset_clear(repo->config);
2498 git_configset_init(repo->config);
2499 if (config_with_options(config_set_callback, repo->config, NULL,
2500 repo, &opts) < 0)
2502 * config_with_options() normally returns only
2503 * zero, as most errors are fatal, and
2504 * non-fatal potential errors are guarded by "if"
2505 * statements that are entered only when no error is
2506 * possible.
2508 * If we ever encounter a non-fatal error, it means
2509 * something went really wrong and we should stop
2510 * immediately.
2512 die(_("unknown error occurred while reading the configuration files"));
2515 static void git_config_check_init(struct repository *repo)
2517 if (repo->config && repo->config->hash_initialized)
2518 return;
2519 repo_read_config(repo);
2522 static void repo_config_clear(struct repository *repo)
2524 if (!repo->config || !repo->config->hash_initialized)
2525 return;
2526 git_configset_clear(repo->config);
2529 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2531 git_config_check_init(repo);
2532 configset_iter(repo->config, fn, data);
2535 int repo_config_get(struct repository *repo, const char *key)
2537 git_config_check_init(repo);
2538 return git_configset_get(repo->config, key);
2541 int repo_config_get_value(struct repository *repo,
2542 const char *key, const char **value)
2544 git_config_check_init(repo);
2545 return git_configset_get_value(repo->config, key, value, NULL);
2548 int repo_config_get_value_multi(struct repository *repo, const char *key,
2549 const struct string_list **dest)
2551 git_config_check_init(repo);
2552 return git_configset_get_value_multi(repo->config, key, dest);
2555 int repo_config_get_string_multi(struct repository *repo, const char *key,
2556 const struct string_list **dest)
2558 git_config_check_init(repo);
2559 return git_configset_get_string_multi(repo->config, key, dest);
2562 int repo_config_get_string(struct repository *repo,
2563 const char *key, char **dest)
2565 int ret;
2566 git_config_check_init(repo);
2567 ret = git_configset_get_string(repo->config, key, dest);
2568 if (ret < 0)
2569 git_die_config(key, NULL);
2570 return ret;
2573 int repo_config_get_string_tmp(struct repository *repo,
2574 const char *key, const char **dest)
2576 int ret;
2577 git_config_check_init(repo);
2578 ret = git_configset_get_string_tmp(repo->config, key, dest);
2579 if (ret < 0)
2580 git_die_config(key, NULL);
2581 return ret;
2584 int repo_config_get_int(struct repository *repo,
2585 const char *key, int *dest)
2587 git_config_check_init(repo);
2588 return git_configset_get_int(repo->config, key, dest);
2591 int repo_config_get_ulong(struct repository *repo,
2592 const char *key, unsigned long *dest)
2594 git_config_check_init(repo);
2595 return git_configset_get_ulong(repo->config, key, dest);
2598 int repo_config_get_bool(struct repository *repo,
2599 const char *key, int *dest)
2601 git_config_check_init(repo);
2602 return git_configset_get_bool(repo->config, key, dest);
2605 int repo_config_get_bool_or_int(struct repository *repo,
2606 const char *key, int *is_bool, int *dest)
2608 git_config_check_init(repo);
2609 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2612 int repo_config_get_maybe_bool(struct repository *repo,
2613 const char *key, int *dest)
2615 git_config_check_init(repo);
2616 return git_configset_get_maybe_bool(repo->config, key, dest);
2619 int repo_config_get_pathname(struct repository *repo,
2620 const char *key, const char **dest)
2622 int ret;
2623 git_config_check_init(repo);
2624 ret = git_configset_get_pathname(repo->config, key, dest);
2625 if (ret < 0)
2626 git_die_config(key, NULL);
2627 return ret;
2630 /* Read values into protected_config. */
2631 static void read_protected_config(void)
2633 struct config_options opts = {
2634 .respect_includes = 1,
2635 .ignore_repo = 1,
2636 .ignore_worktree = 1,
2637 .system_gently = 1,
2640 git_configset_init(&protected_config);
2641 config_with_options(config_set_callback, &protected_config, NULL,
2642 NULL, &opts);
2645 void git_protected_config(config_fn_t fn, void *data)
2647 if (!protected_config.hash_initialized)
2648 read_protected_config();
2649 configset_iter(&protected_config, fn, data);
2652 /* Functions used historically to read configuration from 'the_repository' */
2653 void git_config(config_fn_t fn, void *data)
2655 repo_config(the_repository, fn, data);
2658 void git_config_clear(void)
2660 repo_config_clear(the_repository);
2663 int git_config_get(const char *key)
2665 return repo_config_get(the_repository, key);
2668 int git_config_get_value(const char *key, const char **value)
2670 return repo_config_get_value(the_repository, key, value);
2673 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2675 return repo_config_get_value_multi(the_repository, key, dest);
2678 int git_config_get_string_multi(const char *key,
2679 const struct string_list **dest)
2681 return repo_config_get_string_multi(the_repository, key, dest);
2684 int git_config_get_string(const char *key, char **dest)
2686 return repo_config_get_string(the_repository, key, dest);
2689 int git_config_get_string_tmp(const char *key, const char **dest)
2691 return repo_config_get_string_tmp(the_repository, key, dest);
2694 int git_config_get_int(const char *key, int *dest)
2696 return repo_config_get_int(the_repository, key, dest);
2699 int git_config_get_ulong(const char *key, unsigned long *dest)
2701 return repo_config_get_ulong(the_repository, key, dest);
2704 int git_config_get_bool(const char *key, int *dest)
2706 return repo_config_get_bool(the_repository, key, dest);
2709 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2711 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2714 int git_config_get_maybe_bool(const char *key, int *dest)
2716 return repo_config_get_maybe_bool(the_repository, key, dest);
2719 int git_config_get_pathname(const char *key, const char **dest)
2721 return repo_config_get_pathname(the_repository, key, dest);
2724 int git_config_get_expiry(const char *key, const char **output)
2726 int ret = git_config_get_string(key, (char **)output);
2727 if (ret)
2728 return ret;
2729 if (strcmp(*output, "now")) {
2730 timestamp_t now = approxidate("now");
2731 if (approxidate(*output) >= now)
2732 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2734 return ret;
2737 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2739 const char *expiry_string;
2740 intmax_t days;
2741 timestamp_t when;
2743 if (git_config_get_string_tmp(key, &expiry_string))
2744 return 1; /* no such thing */
2746 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2747 const int scale = 86400;
2748 *expiry = now - days * scale;
2749 return 0;
2752 if (!parse_expiry_date(expiry_string, &when)) {
2753 *expiry = when;
2754 return 0;
2756 return -1; /* thing exists but cannot be parsed */
2759 int git_config_get_split_index(void)
2761 int val;
2763 if (!git_config_get_maybe_bool("core.splitindex", &val))
2764 return val;
2766 return -1; /* default value */
2769 int git_config_get_max_percent_split_change(void)
2771 int val = -1;
2773 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2774 if (0 <= val && val <= 100)
2775 return val;
2777 return error(_("splitIndex.maxPercentChange value '%d' "
2778 "should be between 0 and 100"), val);
2781 return -1; /* default value */
2784 int git_config_get_index_threads(int *dest)
2786 int is_bool, val;
2788 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2789 if (val) {
2790 *dest = val;
2791 return 0;
2794 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2795 if (is_bool)
2796 *dest = val ? 0 : 1;
2797 else
2798 *dest = val;
2799 return 0;
2802 return 1;
2805 NORETURN
2806 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2808 if (!filename)
2809 die(_("unable to parse '%s' from command-line config"), key);
2810 else
2811 die(_("bad config variable '%s' in file '%s' at line %d"),
2812 key, filename, linenr);
2815 NORETURN __attribute__((format(printf, 2, 3)))
2816 void git_die_config(const char *key, const char *err, ...)
2818 const struct string_list *values;
2819 struct key_value_info *kv_info;
2820 report_fn error_fn = get_error_routine();
2822 if (err) {
2823 va_list params;
2824 va_start(params, err);
2825 error_fn(err, params);
2826 va_end(params);
2828 if (git_config_get_value_multi(key, &values))
2829 BUG("for key '%s' we must have a value to report on", key);
2830 kv_info = values->items[values->nr - 1].util;
2831 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2835 * Find all the stuff for git_config_set() below.
2838 struct config_store_data {
2839 size_t baselen;
2840 char *key;
2841 int do_not_match;
2842 const char *fixed_value;
2843 regex_t *value_pattern;
2844 int multi_replace;
2845 struct {
2846 size_t begin, end;
2847 enum config_event_t type;
2848 int is_keys_section;
2849 } *parsed;
2850 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2851 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2853 #define CONFIG_STORE_INIT { 0 }
2855 static void config_store_data_clear(struct config_store_data *store)
2857 free(store->key);
2858 if (store->value_pattern != NULL &&
2859 store->value_pattern != CONFIG_REGEX_NONE) {
2860 regfree(store->value_pattern);
2861 free(store->value_pattern);
2863 free(store->parsed);
2864 free(store->seen);
2865 memset(store, 0, sizeof(*store));
2868 static int matches(const char *key, const char *value,
2869 const struct config_store_data *store)
2871 if (strcmp(key, store->key))
2872 return 0; /* not ours */
2873 if (store->fixed_value)
2874 return !strcmp(store->fixed_value, value);
2875 if (!store->value_pattern)
2876 return 1; /* always matches */
2877 if (store->value_pattern == CONFIG_REGEX_NONE)
2878 return 0; /* never matches */
2880 return store->do_not_match ^
2881 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2884 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2885 struct config_source *cs, void *data)
2887 struct config_store_data *store = data;
2889 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2890 store->parsed[store->parsed_nr].begin = begin;
2891 store->parsed[store->parsed_nr].end = end;
2892 store->parsed[store->parsed_nr].type = type;
2894 if (type == CONFIG_EVENT_SECTION) {
2895 int (*cmpfn)(const char *, const char *, size_t);
2897 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2898 return error(_("invalid section name '%s'"), cs->var.buf);
2900 if (cs->subsection_case_sensitive)
2901 cmpfn = strncasecmp;
2902 else
2903 cmpfn = strncmp;
2905 /* Is this the section we were looking for? */
2906 store->is_keys_section =
2907 store->parsed[store->parsed_nr].is_keys_section =
2908 cs->var.len - 1 == store->baselen &&
2909 !cmpfn(cs->var.buf, store->key, store->baselen);
2910 if (store->is_keys_section) {
2911 store->section_seen = 1;
2912 ALLOC_GROW(store->seen, store->seen_nr + 1,
2913 store->seen_alloc);
2914 store->seen[store->seen_nr] = store->parsed_nr;
2918 store->parsed_nr++;
2920 return 0;
2923 static int store_aux(const char *key, const char *value,
2924 const struct config_context *ctx UNUSED, void *cb)
2926 struct config_store_data *store = cb;
2928 if (store->key_seen) {
2929 if (matches(key, value, store)) {
2930 if (store->seen_nr == 1 && store->multi_replace == 0) {
2931 warning(_("%s has multiple values"), key);
2934 ALLOC_GROW(store->seen, store->seen_nr + 1,
2935 store->seen_alloc);
2937 store->seen[store->seen_nr] = store->parsed_nr;
2938 store->seen_nr++;
2940 } else if (store->is_keys_section) {
2942 * Do not increment matches yet: this may not be a match, but we
2943 * are in the desired section.
2945 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2946 store->seen[store->seen_nr] = store->parsed_nr;
2947 store->section_seen = 1;
2949 if (matches(key, value, store)) {
2950 store->seen_nr++;
2951 store->key_seen = 1;
2955 return 0;
2958 static int write_error(const char *filename)
2960 error(_("failed to write new configuration file %s"), filename);
2962 /* Same error code as "failed to rename". */
2963 return 4;
2966 static struct strbuf store_create_section(const char *key,
2967 const struct config_store_data *store)
2969 const char *dot;
2970 size_t i;
2971 struct strbuf sb = STRBUF_INIT;
2973 dot = memchr(key, '.', store->baselen);
2974 if (dot) {
2975 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2976 for (i = dot - key + 1; i < store->baselen; i++) {
2977 if (key[i] == '"' || key[i] == '\\')
2978 strbuf_addch(&sb, '\\');
2979 strbuf_addch(&sb, key[i]);
2981 strbuf_addstr(&sb, "\"]\n");
2982 } else {
2983 strbuf_addch(&sb, '[');
2984 strbuf_add(&sb, key, store->baselen);
2985 strbuf_addstr(&sb, "]\n");
2988 return sb;
2991 static ssize_t write_section(int fd, const char *key,
2992 const struct config_store_data *store)
2994 struct strbuf sb = store_create_section(key, store);
2995 ssize_t ret;
2997 ret = write_in_full(fd, sb.buf, sb.len);
2998 strbuf_release(&sb);
3000 return ret;
3003 static ssize_t write_pair(int fd, const char *key, const char *value,
3004 const struct config_store_data *store)
3006 int i;
3007 ssize_t ret;
3008 const char *quote = "";
3009 struct strbuf sb = STRBUF_INIT;
3012 * Check to see if the value needs to be surrounded with a dq pair.
3013 * Note that problematic characters are always backslash-quoted; this
3014 * check is about not losing leading or trailing SP and strings that
3015 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3016 * configuration parser.
3018 if (value[0] == ' ')
3019 quote = "\"";
3020 for (i = 0; value[i]; i++)
3021 if (value[i] == ';' || value[i] == '#')
3022 quote = "\"";
3023 if (i && value[i - 1] == ' ')
3024 quote = "\"";
3026 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3028 for (i = 0; value[i]; i++)
3029 switch (value[i]) {
3030 case '\n':
3031 strbuf_addstr(&sb, "\\n");
3032 break;
3033 case '\t':
3034 strbuf_addstr(&sb, "\\t");
3035 break;
3036 case '"':
3037 case '\\':
3038 strbuf_addch(&sb, '\\');
3039 /* fallthrough */
3040 default:
3041 strbuf_addch(&sb, value[i]);
3042 break;
3044 strbuf_addf(&sb, "%s\n", quote);
3046 ret = write_in_full(fd, sb.buf, sb.len);
3047 strbuf_release(&sb);
3049 return ret;
3053 * If we are about to unset the last key(s) in a section, and if there are
3054 * no comments surrounding (or included in) the section, we will want to
3055 * extend begin/end to remove the entire section.
3057 * Note: the parameter `seen_ptr` points to the index into the store.seen
3058 * array. * This index may be incremented if a section has more than one
3059 * entry (which all are to be removed).
3061 static void maybe_remove_section(struct config_store_data *store,
3062 size_t *begin_offset, size_t *end_offset,
3063 int *seen_ptr)
3065 size_t begin;
3066 int i, seen, section_seen = 0;
3069 * First, ensure that this is the first key, and that there are no
3070 * comments before the entry nor before the section header.
3072 seen = *seen_ptr;
3073 for (i = store->seen[seen]; i > 0; i--) {
3074 enum config_event_t type = store->parsed[i - 1].type;
3076 if (type == CONFIG_EVENT_COMMENT)
3077 /* There is a comment before this entry or section */
3078 return;
3079 if (type == CONFIG_EVENT_ENTRY) {
3080 if (!section_seen)
3081 /* This is not the section's first entry. */
3082 return;
3083 /* We encountered no comment before the section. */
3084 break;
3086 if (type == CONFIG_EVENT_SECTION) {
3087 if (!store->parsed[i - 1].is_keys_section)
3088 break;
3089 section_seen = 1;
3092 begin = store->parsed[i].begin;
3095 * Next, make sure that we are removing the last key(s) in the section,
3096 * and that there are no comments that are possibly about the current
3097 * section.
3099 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3100 enum config_event_t type = store->parsed[i].type;
3102 if (type == CONFIG_EVENT_COMMENT)
3103 return;
3104 if (type == CONFIG_EVENT_SECTION) {
3105 if (store->parsed[i].is_keys_section)
3106 continue;
3107 break;
3109 if (type == CONFIG_EVENT_ENTRY) {
3110 if (++seen < store->seen_nr &&
3111 i == store->seen[seen])
3112 /* We want to remove this entry, too */
3113 continue;
3114 /* There is another entry in this section. */
3115 return;
3120 * We are really removing the last entry/entries from this section, and
3121 * there are no enclosed or surrounding comments. Remove the entire,
3122 * now-empty section.
3124 *seen_ptr = seen;
3125 *begin_offset = begin;
3126 if (i < store->parsed_nr)
3127 *end_offset = store->parsed[i].begin;
3128 else
3129 *end_offset = store->parsed[store->parsed_nr - 1].end;
3132 int git_config_set_in_file_gently(const char *config_filename,
3133 const char *key, const char *value)
3135 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3138 void git_config_set_in_file(const char *config_filename,
3139 const char *key, const char *value)
3141 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3144 int git_config_set_gently(const char *key, const char *value)
3146 return git_config_set_multivar_gently(key, value, NULL, 0);
3149 int repo_config_set_worktree_gently(struct repository *r,
3150 const char *key, const char *value)
3152 /* Only use worktree-specific config if it is already enabled. */
3153 if (r->repository_format_worktree_config) {
3154 char *file = repo_git_path(r, "config.worktree");
3155 int ret = git_config_set_multivar_in_file_gently(
3156 file, key, value, NULL, 0);
3157 free(file);
3158 return ret;
3160 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3163 void git_config_set(const char *key, const char *value)
3165 git_config_set_multivar(key, value, NULL, 0);
3167 trace2_cmd_set_config(key, value);
3171 * If value==NULL, unset in (remove from) config,
3172 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3173 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3174 * (only add a new one)
3175 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3176 * key/values are removed before a single new pair is written. If the
3177 * flag is not present, then replace only the first match.
3179 * Returns 0 on success.
3181 * This function does this:
3183 * - it locks the config file by creating ".git/config.lock"
3185 * - it then parses the config using store_aux() as validator to find
3186 * the position on the key/value pair to replace. If it is to be unset,
3187 * it must be found exactly once.
3189 * - the config file is mmap()ed and the part before the match (if any) is
3190 * written to the lock file, then the changed part and the rest.
3192 * - the config file is removed and the lock file rename()d to it.
3195 int git_config_set_multivar_in_file_gently(const char *config_filename,
3196 const char *key, const char *value,
3197 const char *value_pattern,
3198 unsigned flags)
3200 int fd = -1, in_fd = -1;
3201 int ret;
3202 struct lock_file lock = LOCK_INIT;
3203 char *filename_buf = NULL;
3204 char *contents = NULL;
3205 size_t contents_sz;
3206 struct config_store_data store = CONFIG_STORE_INIT;
3208 /* parse-key returns negative; flip the sign to feed exit(3) */
3209 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3210 if (ret)
3211 goto out_free;
3213 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3215 if (!config_filename)
3216 config_filename = filename_buf = git_pathdup("config");
3219 * The lock serves a purpose in addition to locking: the new
3220 * contents of .git/config will be written into it.
3222 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3223 if (fd < 0) {
3224 error_errno(_("could not lock config file %s"), config_filename);
3225 ret = CONFIG_NO_LOCK;
3226 goto out_free;
3230 * If .git/config does not exist yet, write a minimal version.
3232 in_fd = open(config_filename, O_RDONLY);
3233 if ( in_fd < 0 ) {
3234 if ( ENOENT != errno ) {
3235 error_errno(_("opening %s"), config_filename);
3236 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3237 goto out_free;
3239 /* if nothing to unset, error out */
3240 if (!value) {
3241 ret = CONFIG_NOTHING_SET;
3242 goto out_free;
3245 free(store.key);
3246 store.key = xstrdup(key);
3247 if (write_section(fd, key, &store) < 0 ||
3248 write_pair(fd, key, value, &store) < 0)
3249 goto write_err_out;
3250 } else {
3251 struct stat st;
3252 size_t copy_begin, copy_end;
3253 int i, new_line = 0;
3254 struct config_options opts;
3256 if (!value_pattern)
3257 store.value_pattern = NULL;
3258 else if (value_pattern == CONFIG_REGEX_NONE)
3259 store.value_pattern = CONFIG_REGEX_NONE;
3260 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3261 store.fixed_value = value_pattern;
3262 else {
3263 if (value_pattern[0] == '!') {
3264 store.do_not_match = 1;
3265 value_pattern++;
3266 } else
3267 store.do_not_match = 0;
3269 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3270 if (regcomp(store.value_pattern, value_pattern,
3271 REG_EXTENDED)) {
3272 error(_("invalid pattern: %s"), value_pattern);
3273 FREE_AND_NULL(store.value_pattern);
3274 ret = CONFIG_INVALID_PATTERN;
3275 goto out_free;
3279 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3280 store.parsed[0].end = 0;
3282 memset(&opts, 0, sizeof(opts));
3283 opts.event_fn = store_aux_event;
3284 opts.event_fn_data = &store;
3287 * After this, store.parsed will contain offsets of all the
3288 * parsed elements, and store.seen will contain a list of
3289 * matches, as indices into store.parsed.
3291 * As a side effect, we make sure to transform only a valid
3292 * existing config file.
3294 if (git_config_from_file_with_options(store_aux,
3295 config_filename,
3296 &store, CONFIG_SCOPE_UNKNOWN,
3297 &opts)) {
3298 error(_("invalid config file %s"), config_filename);
3299 ret = CONFIG_INVALID_FILE;
3300 goto out_free;
3303 /* if nothing to unset, or too many matches, error out */
3304 if ((store.seen_nr == 0 && value == NULL) ||
3305 (store.seen_nr > 1 && !store.multi_replace)) {
3306 ret = CONFIG_NOTHING_SET;
3307 goto out_free;
3310 if (fstat(in_fd, &st) == -1) {
3311 error_errno(_("fstat on %s failed"), config_filename);
3312 ret = CONFIG_INVALID_FILE;
3313 goto out_free;
3316 contents_sz = xsize_t(st.st_size);
3317 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3318 MAP_PRIVATE, in_fd, 0);
3319 if (contents == MAP_FAILED) {
3320 if (errno == ENODEV && S_ISDIR(st.st_mode))
3321 errno = EISDIR;
3322 error_errno(_("unable to mmap '%s'%s"),
3323 config_filename, mmap_os_err());
3324 ret = CONFIG_INVALID_FILE;
3325 contents = NULL;
3326 goto out_free;
3328 close(in_fd);
3329 in_fd = -1;
3331 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3332 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3333 ret = CONFIG_NO_WRITE;
3334 goto out_free;
3337 if (store.seen_nr == 0) {
3338 if (!store.seen_alloc) {
3339 /* Did not see key nor section */
3340 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3341 store.seen[0] = store.parsed_nr
3342 - !!store.parsed_nr;
3344 store.seen_nr = 1;
3347 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3348 size_t replace_end;
3349 int j = store.seen[i];
3351 new_line = 0;
3352 if (!store.key_seen) {
3353 copy_end = store.parsed[j].end;
3354 /* include '\n' when copying section header */
3355 if (copy_end > 0 && copy_end < contents_sz &&
3356 contents[copy_end - 1] != '\n' &&
3357 contents[copy_end] == '\n')
3358 copy_end++;
3359 replace_end = copy_end;
3360 } else {
3361 replace_end = store.parsed[j].end;
3362 copy_end = store.parsed[j].begin;
3363 if (!value)
3364 maybe_remove_section(&store,
3365 &copy_end,
3366 &replace_end, &i);
3368 * Swallow preceding white-space on the same
3369 * line.
3371 while (copy_end > 0 ) {
3372 char c = contents[copy_end - 1];
3374 if (isspace(c) && c != '\n')
3375 copy_end--;
3376 else
3377 break;
3381 if (copy_end > 0 && contents[copy_end-1] != '\n')
3382 new_line = 1;
3384 /* write the first part of the config */
3385 if (copy_end > copy_begin) {
3386 if (write_in_full(fd, contents + copy_begin,
3387 copy_end - copy_begin) < 0)
3388 goto write_err_out;
3389 if (new_line &&
3390 write_str_in_full(fd, "\n") < 0)
3391 goto write_err_out;
3393 copy_begin = replace_end;
3396 /* write the pair (value == NULL means unset) */
3397 if (value) {
3398 if (!store.section_seen) {
3399 if (write_section(fd, key, &store) < 0)
3400 goto write_err_out;
3402 if (write_pair(fd, key, value, &store) < 0)
3403 goto write_err_out;
3406 /* write the rest of the config */
3407 if (copy_begin < contents_sz)
3408 if (write_in_full(fd, contents + copy_begin,
3409 contents_sz - copy_begin) < 0)
3410 goto write_err_out;
3412 munmap(contents, contents_sz);
3413 contents = NULL;
3416 if (commit_lock_file(&lock) < 0) {
3417 error_errno(_("could not write config file %s"), config_filename);
3418 ret = CONFIG_NO_WRITE;
3419 goto out_free;
3422 ret = 0;
3424 /* Invalidate the config cache */
3425 git_config_clear();
3427 out_free:
3428 rollback_lock_file(&lock);
3429 free(filename_buf);
3430 if (contents)
3431 munmap(contents, contents_sz);
3432 if (in_fd >= 0)
3433 close(in_fd);
3434 config_store_data_clear(&store);
3435 return ret;
3437 write_err_out:
3438 ret = write_error(get_lock_file_path(&lock));
3439 goto out_free;
3442 void git_config_set_multivar_in_file(const char *config_filename,
3443 const char *key, const char *value,
3444 const char *value_pattern, unsigned flags)
3446 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3447 value_pattern, flags))
3448 return;
3449 if (value)
3450 die(_("could not set '%s' to '%s'"), key, value);
3451 else
3452 die(_("could not unset '%s'"), key);
3455 int git_config_set_multivar_gently(const char *key, const char *value,
3456 const char *value_pattern, unsigned flags)
3458 return repo_config_set_multivar_gently(the_repository, key, value,
3459 value_pattern, flags);
3462 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3463 const char *value,
3464 const char *value_pattern, unsigned flags)
3466 char *file = repo_git_path(r, "config");
3467 int res = git_config_set_multivar_in_file_gently(file,
3468 key, value,
3469 value_pattern,
3470 flags);
3471 free(file);
3472 return res;
3475 void git_config_set_multivar(const char *key, const char *value,
3476 const char *value_pattern, unsigned flags)
3478 git_config_set_multivar_in_file(git_path("config"),
3479 key, value, value_pattern,
3480 flags);
3483 static size_t section_name_match (const char *buf, const char *name)
3485 size_t i = 0, j = 0;
3486 int dot = 0;
3487 if (buf[i] != '[')
3488 return 0;
3489 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3490 if (!dot && isspace(buf[i])) {
3491 dot = 1;
3492 if (name[j++] != '.')
3493 break;
3494 for (i++; isspace(buf[i]); i++)
3495 ; /* do nothing */
3496 if (buf[i] != '"')
3497 break;
3498 continue;
3500 if (buf[i] == '\\' && dot)
3501 i++;
3502 else if (buf[i] == '"' && dot) {
3503 for (i++; isspace(buf[i]); i++)
3504 ; /* do_nothing */
3505 break;
3507 if (buf[i] != name[j++])
3508 break;
3510 if (buf[i] == ']' && name[j] == 0) {
3512 * We match, now just find the right length offset by
3513 * gobbling up any whitespace after it, as well
3515 i++;
3516 for (; buf[i] && isspace(buf[i]); i++)
3517 ; /* do nothing */
3518 return i;
3520 return 0;
3523 static int section_name_is_ok(const char *name)
3525 /* Empty section names are bogus. */
3526 if (!*name)
3527 return 0;
3530 * Before a dot, we must be alphanumeric or dash. After the first dot,
3531 * anything goes, so we can stop checking.
3533 for (; *name && *name != '.'; name++)
3534 if (*name != '-' && !isalnum(*name))
3535 return 0;
3536 return 1;
3539 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3541 /* if new_name == NULL, the section is removed instead */
3542 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3543 const char *old_name,
3544 const char *new_name, int copy)
3546 int ret = 0, remove = 0;
3547 char *filename_buf = NULL;
3548 struct lock_file lock = LOCK_INIT;
3549 int out_fd;
3550 struct strbuf buf = STRBUF_INIT;
3551 FILE *config_file = NULL;
3552 struct stat st;
3553 struct strbuf copystr = STRBUF_INIT;
3554 struct config_store_data store;
3555 uint32_t line_nr = 0;
3557 memset(&store, 0, sizeof(store));
3559 if (new_name && !section_name_is_ok(new_name)) {
3560 ret = error(_("invalid section name: %s"), new_name);
3561 goto out_no_rollback;
3564 if (!config_filename)
3565 config_filename = filename_buf = git_pathdup("config");
3567 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3568 if (out_fd < 0) {
3569 ret = error(_("could not lock config file %s"), config_filename);
3570 goto out;
3573 if (!(config_file = fopen(config_filename, "rb"))) {
3574 ret = warn_on_fopen_errors(config_filename);
3575 if (ret)
3576 goto out;
3577 /* no config file means nothing to rename, no error */
3578 goto commit_and_out;
3581 if (fstat(fileno(config_file), &st) == -1) {
3582 ret = error_errno(_("fstat on %s failed"), config_filename);
3583 goto out;
3586 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3587 ret = error_errno(_("chmod on %s failed"),
3588 get_lock_file_path(&lock));
3589 goto out;
3592 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3593 size_t i, length;
3594 int is_section = 0;
3595 char *output = buf.buf;
3597 line_nr++;
3599 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3600 ret = error(_("refusing to work with overly long line "
3601 "in '%s' on line %"PRIuMAX),
3602 config_filename, (uintmax_t)line_nr);
3603 goto out;
3606 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3607 ; /* do nothing */
3608 if (buf.buf[i] == '[') {
3609 /* it's a section */
3610 size_t offset;
3611 is_section = 1;
3614 * When encountering a new section under -c we
3615 * need to flush out any section we're already
3616 * coping and begin anew. There might be
3617 * multiple [branch "$name"] sections.
3619 if (copystr.len > 0) {
3620 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3621 ret = write_error(get_lock_file_path(&lock));
3622 goto out;
3624 strbuf_reset(&copystr);
3627 offset = section_name_match(&buf.buf[i], old_name);
3628 if (offset > 0) {
3629 ret++;
3630 if (!new_name) {
3631 remove = 1;
3632 continue;
3634 store.baselen = strlen(new_name);
3635 if (!copy) {
3636 if (write_section(out_fd, new_name, &store) < 0) {
3637 ret = write_error(get_lock_file_path(&lock));
3638 goto out;
3641 * We wrote out the new section, with
3642 * a newline, now skip the old
3643 * section's length
3645 output += offset + i;
3646 if (strlen(output) > 0) {
3648 * More content means there's
3649 * a declaration to put on the
3650 * next line; indent with a
3651 * tab
3653 output -= 1;
3654 output[0] = '\t';
3656 } else {
3657 strbuf_release(&copystr);
3658 copystr = store_create_section(new_name, &store);
3661 remove = 0;
3663 if (remove)
3664 continue;
3665 length = strlen(output);
3667 if (!is_section && copystr.len > 0) {
3668 strbuf_add(&copystr, output, length);
3671 if (write_in_full(out_fd, output, length) < 0) {
3672 ret = write_error(get_lock_file_path(&lock));
3673 goto out;
3678 * Copy a trailing section at the end of the config, won't be
3679 * flushed by the usual "flush because we have a new section
3680 * logic in the loop above.
3682 if (copystr.len > 0) {
3683 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3684 ret = write_error(get_lock_file_path(&lock));
3685 goto out;
3687 strbuf_reset(&copystr);
3690 fclose(config_file);
3691 config_file = NULL;
3692 commit_and_out:
3693 if (commit_lock_file(&lock) < 0)
3694 ret = error_errno(_("could not write config file %s"),
3695 config_filename);
3696 out:
3697 if (config_file)
3698 fclose(config_file);
3699 rollback_lock_file(&lock);
3700 out_no_rollback:
3701 free(filename_buf);
3702 config_store_data_clear(&store);
3703 strbuf_release(&buf);
3704 strbuf_release(&copystr);
3705 return ret;
3708 int git_config_rename_section_in_file(const char *config_filename,
3709 const char *old_name, const char *new_name)
3711 return git_config_copy_or_rename_section_in_file(config_filename,
3712 old_name, new_name, 0);
3715 int git_config_rename_section(const char *old_name, const char *new_name)
3717 return git_config_rename_section_in_file(NULL, old_name, new_name);
3720 int git_config_copy_section_in_file(const char *config_filename,
3721 const char *old_name, const char *new_name)
3723 return git_config_copy_or_rename_section_in_file(config_filename,
3724 old_name, new_name, 1);
3727 int git_config_copy_section(const char *old_name, const char *new_name)
3729 return git_config_copy_section_in_file(NULL, old_name, new_name);
3733 * Call this to report error for your variable that should not
3734 * get a boolean value (i.e. "[my] var" means "true").
3736 #undef config_error_nonbool
3737 int config_error_nonbool(const char *var)
3739 return error(_("missing value for '%s'"), var);
3742 int parse_config_key(const char *var,
3743 const char *section,
3744 const char **subsection, size_t *subsection_len,
3745 const char **key)
3747 const char *dot;
3749 /* Does it start with "section." ? */
3750 if (!skip_prefix(var, section, &var) || *var != '.')
3751 return -1;
3754 * Find the key; we don't know yet if we have a subsection, but we must
3755 * parse backwards from the end, since the subsection may have dots in
3756 * it, too.
3758 dot = strrchr(var, '.');
3759 *key = dot + 1;
3761 /* Did we have a subsection at all? */
3762 if (dot == var) {
3763 if (subsection) {
3764 *subsection = NULL;
3765 *subsection_len = 0;
3768 else {
3769 if (!subsection)
3770 return -1;
3771 *subsection = var + 1;
3772 *subsection_len = dot - *subsection;
3775 return 0;
3778 const char *config_origin_type_name(enum config_origin_type type)
3780 switch (type) {
3781 case CONFIG_ORIGIN_BLOB:
3782 return "blob";
3783 case CONFIG_ORIGIN_FILE:
3784 return "file";
3785 case CONFIG_ORIGIN_STDIN:
3786 return "standard input";
3787 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3788 return "submodule-blob";
3789 case CONFIG_ORIGIN_CMDLINE:
3790 return "command line";
3791 default:
3792 BUG("unknown config origin type");
3796 const char *config_scope_name(enum config_scope scope)
3798 switch (scope) {
3799 case CONFIG_SCOPE_SYSTEM:
3800 return "system";
3801 case CONFIG_SCOPE_GLOBAL:
3802 return "global";
3803 case CONFIG_SCOPE_LOCAL:
3804 return "local";
3805 case CONFIG_SCOPE_WORKTREE:
3806 return "worktree";
3807 case CONFIG_SCOPE_COMMAND:
3808 return "command";
3809 case CONFIG_SCOPE_SUBMODULE:
3810 return "submodule";
3811 default:
3812 return "unknown";
3816 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3818 int i;
3820 for (i = 0; i < nr_mapping; i++) {
3821 const char *name = mapping[i];
3823 if (name && !strcasecmp(var, name))
3824 return i;
3826 return -1;