fill_tree_descriptor(): mark error message for translation
[git/gitster.git] / config.c
blobb330c7adb4a5efc3cac898391d4c722b019d95a1
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 "dir.h"
34 #include "color.h"
35 #include "replace-object.h"
36 #include "refs.h"
37 #include "setup.h"
38 #include "strvec.h"
39 #include "trace2.h"
40 #include "wildmatch.h"
41 #include "worktree.h"
42 #include "ws.h"
43 #include "write-or-die.h"
45 struct config_source {
46 struct config_source *prev;
47 union {
48 FILE *file;
49 struct config_buf {
50 const char *buf;
51 size_t len;
52 size_t pos;
53 } buf;
54 } u;
55 enum config_origin_type origin_type;
56 const char *name;
57 const char *path;
58 enum config_error_action default_error_action;
59 int linenr;
60 int eof;
61 size_t total_len;
62 struct strbuf value;
63 struct strbuf var;
64 unsigned subsection_case_sensitive : 1;
66 int (*do_fgetc)(struct config_source *c);
67 int (*do_ungetc)(int c, struct config_source *conf);
68 long (*do_ftell)(struct config_source *c);
70 #define CONFIG_SOURCE_INIT { 0 }
72 static int pack_compression_seen;
73 static int zlib_compression_seen;
76 * Config that comes from trusted scopes, namely:
77 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
78 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
79 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
81 * This is declared here for code cleanliness, but unlike the other
82 * static variables, this does not hold config parser state.
84 static struct config_set protected_config;
86 static int config_file_fgetc(struct config_source *conf)
88 return getc_unlocked(conf->u.file);
91 static int config_file_ungetc(int c, struct config_source *conf)
93 return ungetc(c, conf->u.file);
96 static long config_file_ftell(struct config_source *conf)
98 return ftell(conf->u.file);
102 static int config_buf_fgetc(struct config_source *conf)
104 if (conf->u.buf.pos < conf->u.buf.len)
105 return conf->u.buf.buf[conf->u.buf.pos++];
107 return EOF;
110 static int config_buf_ungetc(int c, struct config_source *conf)
112 if (conf->u.buf.pos > 0) {
113 conf->u.buf.pos--;
114 if (conf->u.buf.buf[conf->u.buf.pos] != c)
115 BUG("config_buf can only ungetc the same character");
116 return c;
119 return EOF;
122 static long config_buf_ftell(struct config_source *conf)
124 return conf->u.buf.pos;
127 struct config_include_data {
128 int depth;
129 config_fn_t fn;
130 void *data;
131 const struct config_options *opts;
132 struct git_config_source *config_source;
133 struct repository *repo;
136 * All remote URLs discovered when reading all config files.
138 struct string_list *remote_urls;
140 #define CONFIG_INCLUDE_INIT { 0 }
142 static int git_config_include(const char *var, const char *value,
143 const struct config_context *ctx, void *data);
145 #define MAX_INCLUDE_DEPTH 10
146 static const char include_depth_advice[] = N_(
147 "exceeded maximum include depth (%d) while including\n"
148 " %s\n"
149 "from\n"
150 " %s\n"
151 "This might be due to circular includes.");
152 static int handle_path_include(const struct key_value_info *kvi,
153 const char *path,
154 struct config_include_data *inc)
156 int ret = 0;
157 struct strbuf buf = STRBUF_INIT;
158 char *expanded;
160 if (!path)
161 return config_error_nonbool("include.path");
163 expanded = interpolate_path(path, 0);
164 if (!expanded)
165 return error(_("could not expand include path '%s'"), path);
166 path = expanded;
169 * Use an absolute path as-is, but interpret relative paths
170 * based on the including config file.
172 if (!is_absolute_path(path)) {
173 char *slash;
175 if (!kvi || !kvi->path) {
176 ret = error(_("relative config includes must come from files"));
177 goto cleanup;
180 slash = find_last_dir_sep(kvi->path);
181 if (slash)
182 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
183 strbuf_addstr(&buf, path);
184 path = buf.buf;
187 if (!access_or_die(path, R_OK, 0)) {
188 if (++inc->depth > MAX_INCLUDE_DEPTH)
189 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
190 !kvi ? "<unknown>" :
191 kvi->filename ? kvi->filename :
192 "the command line");
193 ret = git_config_from_file_with_options(git_config_include, path, inc,
194 kvi->scope, NULL);
195 inc->depth--;
197 cleanup:
198 strbuf_release(&buf);
199 free(expanded);
200 return ret;
203 static void add_trailing_starstar_for_dir(struct strbuf *pat)
205 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
206 strbuf_addstr(pat, "**");
209 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
210 struct strbuf *pat)
212 struct strbuf path = STRBUF_INIT;
213 char *expanded;
214 int prefix = 0;
216 expanded = interpolate_path(pat->buf, 1);
217 if (expanded) {
218 strbuf_reset(pat);
219 strbuf_addstr(pat, expanded);
220 free(expanded);
223 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
224 const char *slash;
226 if (!kvi || !kvi->path)
227 return error(_("relative config include "
228 "conditionals must come from files"));
230 strbuf_realpath(&path, kvi->path, 1);
231 slash = find_last_dir_sep(path.buf);
232 if (!slash)
233 BUG("how is this possible?");
234 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
235 prefix = slash - path.buf + 1 /* slash */;
236 } else if (!is_absolute_path(pat->buf))
237 strbuf_insertstr(pat, 0, "**/");
239 add_trailing_starstar_for_dir(pat);
241 strbuf_release(&path);
242 return prefix;
245 static int include_by_gitdir(const struct key_value_info *kvi,
246 const struct config_options *opts,
247 const char *cond, size_t cond_len, int icase)
249 struct strbuf text = STRBUF_INIT;
250 struct strbuf pattern = STRBUF_INIT;
251 int ret = 0, prefix;
252 const char *git_dir;
253 int already_tried_absolute = 0;
255 if (opts->git_dir)
256 git_dir = opts->git_dir;
257 else
258 goto done;
260 strbuf_realpath(&text, git_dir, 1);
261 strbuf_add(&pattern, cond, cond_len);
262 prefix = prepare_include_condition_pattern(kvi, &pattern);
264 again:
265 if (prefix < 0)
266 goto done;
268 if (prefix > 0) {
270 * perform literal matching on the prefix part so that
271 * any wildcard character in it can't create side effects.
273 if (text.len < prefix)
274 goto done;
275 if (!icase && strncmp(pattern.buf, text.buf, prefix))
276 goto done;
277 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
278 goto done;
281 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
282 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
284 if (!ret && !already_tried_absolute) {
286 * We've tried e.g. matching gitdir:~/work, but if
287 * ~/work is a symlink to /mnt/storage/work
288 * strbuf_realpath() will expand it, so the rule won't
289 * match. Let's match against a
290 * strbuf_add_absolute_path() version of the path,
291 * which'll do the right thing
293 strbuf_reset(&text);
294 strbuf_add_absolute_path(&text, git_dir);
295 already_tried_absolute = 1;
296 goto again;
298 done:
299 strbuf_release(&pattern);
300 strbuf_release(&text);
301 return ret;
304 static int include_by_branch(const char *cond, size_t cond_len)
306 int flags;
307 int ret;
308 struct strbuf pattern = STRBUF_INIT;
309 const char *refname = !the_repository->gitdir ?
310 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
311 const char *shortname;
313 if (!refname || !(flags & REF_ISSYMREF) ||
314 !skip_prefix(refname, "refs/heads/", &shortname))
315 return 0;
317 strbuf_add(&pattern, cond, cond_len);
318 add_trailing_starstar_for_dir(&pattern);
319 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
320 strbuf_release(&pattern);
321 return ret;
324 static int add_remote_url(const char *var, const char *value,
325 const struct config_context *ctx UNUSED, void *data)
327 struct string_list *remote_urls = data;
328 const char *remote_name;
329 size_t remote_name_len;
330 const char *key;
332 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
333 &key) &&
334 remote_name &&
335 !strcmp(key, "url"))
336 string_list_append(remote_urls, value);
337 return 0;
340 static void populate_remote_urls(struct config_include_data *inc)
342 struct config_options opts;
344 opts = *inc->opts;
345 opts.unconditional_remote_url = 1;
347 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
348 string_list_init_dup(inc->remote_urls);
349 config_with_options(add_remote_url, inc->remote_urls,
350 inc->config_source, inc->repo, &opts);
353 static int forbid_remote_url(const char *var, const char *value UNUSED,
354 const struct config_context *ctx UNUSED,
355 void *data UNUSED)
357 const char *remote_name;
358 size_t remote_name_len;
359 const char *key;
361 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
362 &key) &&
363 remote_name &&
364 !strcmp(key, "url"))
365 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
366 return 0;
369 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
370 struct string_list *remote_urls)
372 struct strbuf pattern = STRBUF_INIT;
373 struct string_list_item *url_item;
374 int found = 0;
376 strbuf_add(&pattern, glob, glob_len);
377 for_each_string_list_item(url_item, remote_urls) {
378 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
379 found = 1;
380 break;
383 strbuf_release(&pattern);
384 return found;
387 static int include_by_remote_url(struct config_include_data *inc,
388 const char *cond, size_t cond_len)
390 if (inc->opts->unconditional_remote_url)
391 return 1;
392 if (!inc->remote_urls)
393 populate_remote_urls(inc);
394 return at_least_one_url_matches_glob(cond, cond_len,
395 inc->remote_urls);
398 static int include_condition_is_true(const struct key_value_info *kvi,
399 struct config_include_data *inc,
400 const char *cond, size_t cond_len)
402 const struct config_options *opts = inc->opts;
404 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
405 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
406 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
407 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
408 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
409 return include_by_branch(cond, cond_len);
410 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
411 &cond_len))
412 return include_by_remote_url(inc, cond, cond_len);
414 /* unknown conditionals are always false */
415 return 0;
418 static int git_config_include(const char *var, const char *value,
419 const struct config_context *ctx,
420 void *data)
422 struct config_include_data *inc = data;
423 const char *cond, *key;
424 size_t cond_len;
425 int ret;
428 * Pass along all values, including "include" directives; this makes it
429 * possible to query information on the includes themselves.
431 ret = inc->fn(var, value, ctx, inc->data);
432 if (ret < 0)
433 return ret;
435 if (!strcmp(var, "include.path"))
436 ret = handle_path_include(ctx->kvi, value, inc);
438 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
439 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
440 !strcmp(key, "path")) {
441 config_fn_t old_fn = inc->fn;
443 if (inc->opts->unconditional_remote_url)
444 inc->fn = forbid_remote_url;
445 ret = handle_path_include(ctx->kvi, value, inc);
446 inc->fn = old_fn;
449 return ret;
452 static void git_config_push_split_parameter(const char *key, const char *value)
454 struct strbuf env = STRBUF_INIT;
455 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
456 if (old && *old) {
457 strbuf_addstr(&env, old);
458 strbuf_addch(&env, ' ');
460 sq_quote_buf(&env, key);
461 strbuf_addch(&env, '=');
462 if (value)
463 sq_quote_buf(&env, value);
464 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
465 strbuf_release(&env);
468 void git_config_push_parameter(const char *text)
470 const char *value;
473 * When we see:
475 * section.subsection=with=equals.key=value
477 * we cannot tell if it means:
479 * [section "subsection=with=equals"]
480 * key = value
482 * or:
484 * [section]
485 * subsection = with=equals.key=value
487 * We parse left-to-right for the first "=", meaning we'll prefer to
488 * keep the value intact over the subsection. This is historical, but
489 * also sensible since values are more likely to contain odd or
490 * untrusted input than a section name.
492 * A missing equals is explicitly allowed (as a bool-only entry).
494 value = strchr(text, '=');
495 if (value) {
496 char *key = xmemdupz(text, value - text);
497 git_config_push_split_parameter(key, value + 1);
498 free(key);
499 } else {
500 git_config_push_split_parameter(text, NULL);
504 void git_config_push_env(const char *spec)
506 char *key;
507 const char *env_name;
508 const char *env_value;
510 env_name = strrchr(spec, '=');
511 if (!env_name)
512 die(_("invalid config format: %s"), spec);
513 key = xmemdupz(spec, env_name - spec);
514 env_name++;
515 if (!*env_name)
516 die(_("missing environment variable name for configuration '%.*s'"),
517 (int)(env_name - spec - 1), spec);
519 env_value = getenv(env_name);
520 if (!env_value)
521 die(_("missing environment variable '%s' for configuration '%.*s'"),
522 env_name, (int)(env_name - spec - 1), spec);
524 git_config_push_split_parameter(key, env_value);
525 free(key);
528 static inline int iskeychar(int c)
530 return isalnum(c) || c == '-';
534 * Auxiliary function to sanity-check and split the key into the section
535 * identifier and variable name.
537 * Returns 0 on success, -1 when there is an invalid character in the key and
538 * -2 if there is no section name in the key.
540 * store_key - pointer to char* which will hold a copy of the key with
541 * lowercase section and variable name
542 * baselen - pointer to size_t which will hold the length of the
543 * section + subsection part, can be NULL
545 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
547 size_t i, baselen;
548 int dot;
549 const char *last_dot = strrchr(key, '.');
552 * Since "key" actually contains the section name and the real
553 * key name separated by a dot, we have to know where the dot is.
556 if (last_dot == NULL || last_dot == key) {
557 error(_("key does not contain a section: %s"), key);
558 return -CONFIG_NO_SECTION_OR_NAME;
561 if (!last_dot[1]) {
562 error(_("key does not contain variable name: %s"), key);
563 return -CONFIG_NO_SECTION_OR_NAME;
566 baselen = last_dot - key;
567 if (baselen_)
568 *baselen_ = baselen;
571 * Validate the key and while at it, lower case it for matching.
573 *store_key = xmallocz(strlen(key));
575 dot = 0;
576 for (i = 0; key[i]; i++) {
577 unsigned char c = key[i];
578 if (c == '.')
579 dot = 1;
580 /* Leave the extended basename untouched.. */
581 if (!dot || i > baselen) {
582 if (!iskeychar(c) ||
583 (i == baselen + 1 && !isalpha(c))) {
584 error(_("invalid key: %s"), key);
585 goto out_free_ret_1;
587 c = tolower(c);
588 } else if (c == '\n') {
589 error(_("invalid key (newline): %s"), key);
590 goto out_free_ret_1;
592 (*store_key)[i] = c;
595 return 0;
597 out_free_ret_1:
598 FREE_AND_NULL(*store_key);
599 return -CONFIG_INVALID_KEY;
602 static int config_parse_pair(const char *key, const char *value,
603 struct key_value_info *kvi,
604 config_fn_t fn, void *data)
606 char *canonical_name;
607 int ret;
608 struct config_context ctx = {
609 .kvi = kvi,
612 if (!strlen(key))
613 return error(_("empty config key"));
614 if (git_config_parse_key(key, &canonical_name, NULL))
615 return -1;
617 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
618 free(canonical_name);
619 return ret;
623 /* for values read from `git_config_from_parameters()` */
624 void kvi_from_param(struct key_value_info *out)
626 out->filename = NULL;
627 out->linenr = -1;
628 out->origin_type = CONFIG_ORIGIN_CMDLINE;
629 out->scope = CONFIG_SCOPE_COMMAND;
630 out->path = NULL;
633 int git_config_parse_parameter(const char *text,
634 config_fn_t fn, void *data)
636 const char *value;
637 struct strbuf **pair;
638 int ret;
639 struct key_value_info kvi = KVI_INIT;
641 kvi_from_param(&kvi);
643 pair = strbuf_split_str(text, '=', 2);
644 if (!pair[0])
645 return error(_("bogus config parameter: %s"), text);
647 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
648 strbuf_setlen(pair[0], pair[0]->len - 1);
649 value = pair[1] ? pair[1]->buf : "";
650 } else {
651 value = NULL;
654 strbuf_trim(pair[0]);
655 if (!pair[0]->len) {
656 strbuf_list_free(pair);
657 return error(_("bogus config parameter: %s"), text);
660 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
661 strbuf_list_free(pair);
662 return ret;
665 static int parse_config_env_list(char *env, struct key_value_info *kvi,
666 config_fn_t fn, void *data)
668 char *cur = env;
669 while (cur && *cur) {
670 const char *key = sq_dequote_step(cur, &cur);
671 if (!key)
672 return error(_("bogus format in %s"),
673 CONFIG_DATA_ENVIRONMENT);
675 if (!cur || isspace(*cur)) {
676 /* old-style 'key=value' */
677 if (git_config_parse_parameter(key, fn, data) < 0)
678 return -1;
680 else if (*cur == '=') {
681 /* new-style 'key'='value' */
682 const char *value;
684 cur++;
685 if (*cur == '\'') {
686 /* quoted value */
687 value = sq_dequote_step(cur, &cur);
688 if (!value || (cur && !isspace(*cur))) {
689 return error(_("bogus format in %s"),
690 CONFIG_DATA_ENVIRONMENT);
692 } else if (!*cur || isspace(*cur)) {
693 /* implicit bool: 'key'= */
694 value = NULL;
695 } else {
696 return error(_("bogus format in %s"),
697 CONFIG_DATA_ENVIRONMENT);
700 if (config_parse_pair(key, value, kvi, fn, data) < 0)
701 return -1;
703 else {
704 /* unknown format */
705 return error(_("bogus format in %s"),
706 CONFIG_DATA_ENVIRONMENT);
709 if (cur) {
710 while (isspace(*cur))
711 cur++;
714 return 0;
717 int git_config_from_parameters(config_fn_t fn, void *data)
719 const char *env;
720 struct strbuf envvar = STRBUF_INIT;
721 struct strvec to_free = STRVEC_INIT;
722 int ret = 0;
723 char *envw = NULL;
724 struct key_value_info kvi = KVI_INIT;
726 kvi_from_param(&kvi);
727 env = getenv(CONFIG_COUNT_ENVIRONMENT);
728 if (env) {
729 unsigned long count;
730 char *endp;
731 int i;
733 count = strtoul(env, &endp, 10);
734 if (*endp) {
735 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
736 goto out;
738 if (count > INT_MAX) {
739 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
740 goto out;
743 for (i = 0; i < count; i++) {
744 const char *key, *value;
746 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
747 key = getenv_safe(&to_free, envvar.buf);
748 if (!key) {
749 ret = error(_("missing config key %s"), envvar.buf);
750 goto out;
752 strbuf_reset(&envvar);
754 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
755 value = getenv_safe(&to_free, envvar.buf);
756 if (!value) {
757 ret = error(_("missing config value %s"), envvar.buf);
758 goto out;
760 strbuf_reset(&envvar);
762 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
763 ret = -1;
764 goto out;
769 env = getenv(CONFIG_DATA_ENVIRONMENT);
770 if (env) {
771 /* sq_dequote will write over it */
772 envw = xstrdup(env);
773 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
774 ret = -1;
775 goto out;
779 out:
780 strbuf_release(&envvar);
781 strvec_clear(&to_free);
782 free(envw);
783 return ret;
786 static int get_next_char(struct config_source *cs)
788 int c = cs->do_fgetc(cs);
790 if (c == '\r') {
791 /* DOS like systems */
792 c = cs->do_fgetc(cs);
793 if (c != '\n') {
794 if (c != EOF)
795 cs->do_ungetc(c, cs);
796 c = '\r';
800 if (c != EOF && ++cs->total_len > INT_MAX) {
802 * This is an absurdly long config file; refuse to parse
803 * further in order to protect downstream code from integer
804 * overflows. Note that we can't return an error specifically,
805 * but we can mark EOF and put trash in the return value,
806 * which will trigger a parse error.
808 cs->eof = 1;
809 return 0;
812 if (c == '\n')
813 cs->linenr++;
814 if (c == EOF) {
815 cs->eof = 1;
816 cs->linenr++;
817 c = '\n';
819 return c;
822 static char *parse_value(struct config_source *cs)
824 int quote = 0, comment = 0, space = 0;
826 strbuf_reset(&cs->value);
827 for (;;) {
828 int c = get_next_char(cs);
829 if (c == '\n') {
830 if (quote) {
831 cs->linenr--;
832 return NULL;
834 return cs->value.buf;
836 if (comment)
837 continue;
838 if (isspace(c) && !quote) {
839 if (cs->value.len)
840 space++;
841 continue;
843 if (!quote) {
844 if (c == ';' || c == '#') {
845 comment = 1;
846 continue;
849 for (; space; space--)
850 strbuf_addch(&cs->value, ' ');
851 if (c == '\\') {
852 c = get_next_char(cs);
853 switch (c) {
854 case '\n':
855 continue;
856 case 't':
857 c = '\t';
858 break;
859 case 'b':
860 c = '\b';
861 break;
862 case 'n':
863 c = '\n';
864 break;
865 /* Some characters escape as themselves */
866 case '\\': case '"':
867 break;
868 /* Reject unknown escape sequences */
869 default:
870 return NULL;
872 strbuf_addch(&cs->value, c);
873 continue;
875 if (c == '"') {
876 quote = 1-quote;
877 continue;
879 strbuf_addch(&cs->value, c);
883 static int get_value(struct config_source *cs, struct key_value_info *kvi,
884 config_fn_t fn, void *data, struct strbuf *name)
886 int c;
887 char *value;
888 int ret;
889 struct config_context ctx = {
890 .kvi = kvi,
893 /* Get the full name */
894 for (;;) {
895 c = get_next_char(cs);
896 if (cs->eof)
897 break;
898 if (!iskeychar(c))
899 break;
900 strbuf_addch(name, tolower(c));
903 while (c == ' ' || c == '\t')
904 c = get_next_char(cs);
906 value = NULL;
907 if (c != '\n') {
908 if (c != '=')
909 return -1;
910 value = parse_value(cs);
911 if (!value)
912 return -1;
915 * We already consumed the \n, but we need linenr to point to
916 * the line we just parsed during the call to fn to get
917 * accurate line number in error messages.
919 cs->linenr--;
920 kvi->linenr = cs->linenr;
921 ret = fn(name->buf, value, &ctx, data);
922 if (ret >= 0)
923 cs->linenr++;
924 return ret;
927 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
928 int c)
930 cs->subsection_case_sensitive = 0;
931 do {
932 if (c == '\n')
933 goto error_incomplete_line;
934 c = get_next_char(cs);
935 } while (isspace(c));
937 /* We require the format to be '[base "extension"]' */
938 if (c != '"')
939 return -1;
940 strbuf_addch(name, '.');
942 for (;;) {
943 int c = get_next_char(cs);
944 if (c == '\n')
945 goto error_incomplete_line;
946 if (c == '"')
947 break;
948 if (c == '\\') {
949 c = get_next_char(cs);
950 if (c == '\n')
951 goto error_incomplete_line;
953 strbuf_addch(name, c);
956 /* Final ']' */
957 if (get_next_char(cs) != ']')
958 return -1;
959 return 0;
960 error_incomplete_line:
961 cs->linenr--;
962 return -1;
965 static int get_base_var(struct config_source *cs, struct strbuf *name)
967 cs->subsection_case_sensitive = 1;
968 for (;;) {
969 int c = get_next_char(cs);
970 if (cs->eof)
971 return -1;
972 if (c == ']')
973 return 0;
974 if (isspace(c))
975 return get_extended_base_var(cs, name, c);
976 if (!iskeychar(c) && c != '.')
977 return -1;
978 strbuf_addch(name, tolower(c));
982 struct parse_event_data {
983 enum config_event_t previous_type;
984 size_t previous_offset;
985 const struct config_options *opts;
988 static int do_event(struct config_source *cs, enum config_event_t type,
989 struct parse_event_data *data)
991 size_t offset;
993 if (!data->opts || !data->opts->event_fn)
994 return 0;
996 if (type == CONFIG_EVENT_WHITESPACE &&
997 data->previous_type == type)
998 return 0;
1000 offset = cs->do_ftell(cs);
1002 * At EOF, the parser always "inserts" an extra '\n', therefore
1003 * the end offset of the event is the current file position, otherwise
1004 * we will already have advanced to the next event.
1006 if (type != CONFIG_EVENT_EOF)
1007 offset--;
1009 if (data->previous_type != CONFIG_EVENT_EOF &&
1010 data->opts->event_fn(data->previous_type, data->previous_offset,
1011 offset, cs, data->opts->event_fn_data) < 0)
1012 return -1;
1014 data->previous_type = type;
1015 data->previous_offset = offset;
1017 return 0;
1020 static void kvi_from_source(struct config_source *cs,
1021 enum config_scope scope,
1022 struct key_value_info *out)
1024 out->filename = strintern(cs->name);
1025 out->origin_type = cs->origin_type;
1026 out->linenr = cs->linenr;
1027 out->scope = scope;
1028 out->path = cs->path;
1031 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1032 struct key_value_info *kvi, void *data,
1033 const struct config_options *opts)
1035 int comment = 0;
1036 size_t baselen = 0;
1037 struct strbuf *var = &cs->var;
1038 int error_return = 0;
1039 char *error_msg = NULL;
1041 /* U+FEFF Byte Order Mark in UTF8 */
1042 const char *bomptr = utf8_bom;
1044 /* For the parser event callback */
1045 struct parse_event_data event_data = {
1046 CONFIG_EVENT_EOF, 0, opts
1049 for (;;) {
1050 int c;
1052 c = get_next_char(cs);
1053 if (bomptr && *bomptr) {
1054 /* We are at the file beginning; skip UTF8-encoded BOM
1055 * if present. Sane editors won't put this in on their
1056 * own, but e.g. Windows Notepad will do it happily. */
1057 if (c == (*bomptr & 0377)) {
1058 bomptr++;
1059 continue;
1060 } else {
1061 /* Do not tolerate partial BOM. */
1062 if (bomptr != utf8_bom)
1063 break;
1064 /* No BOM at file beginning. Cool. */
1065 bomptr = NULL;
1068 if (c == '\n') {
1069 if (cs->eof) {
1070 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1071 return -1;
1072 return 0;
1074 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1075 return -1;
1076 comment = 0;
1077 continue;
1079 if (comment)
1080 continue;
1081 if (isspace(c)) {
1082 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1083 return -1;
1084 continue;
1086 if (c == '#' || c == ';') {
1087 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1088 return -1;
1089 comment = 1;
1090 continue;
1092 if (c == '[') {
1093 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1094 return -1;
1096 /* Reset prior to determining a new stem */
1097 strbuf_reset(var);
1098 if (get_base_var(cs, var) < 0 || var->len < 1)
1099 break;
1100 strbuf_addch(var, '.');
1101 baselen = var->len;
1102 continue;
1104 if (!isalpha(c))
1105 break;
1107 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1108 return -1;
1111 * Truncate the var name back to the section header
1112 * stem prior to grabbing the suffix part of the name
1113 * and the value.
1115 strbuf_setlen(var, baselen);
1116 strbuf_addch(var, tolower(c));
1117 if (get_value(cs, kvi, fn, data, var) < 0)
1118 break;
1121 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1122 return -1;
1124 switch (cs->origin_type) {
1125 case CONFIG_ORIGIN_BLOB:
1126 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1127 cs->linenr, cs->name);
1128 break;
1129 case CONFIG_ORIGIN_FILE:
1130 error_msg = xstrfmt(_("bad config line %d in file %s"),
1131 cs->linenr, cs->name);
1132 break;
1133 case CONFIG_ORIGIN_STDIN:
1134 error_msg = xstrfmt(_("bad config line %d in standard input"),
1135 cs->linenr);
1136 break;
1137 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1138 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1139 cs->linenr, cs->name);
1140 break;
1141 case CONFIG_ORIGIN_CMDLINE:
1142 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1143 cs->linenr, cs->name);
1144 break;
1145 default:
1146 error_msg = xstrfmt(_("bad config line %d in %s"),
1147 cs->linenr, cs->name);
1150 switch (opts && opts->error_action ?
1151 opts->error_action :
1152 cs->default_error_action) {
1153 case CONFIG_ERROR_DIE:
1154 die("%s", error_msg);
1155 break;
1156 case CONFIG_ERROR_ERROR:
1157 error_return = error("%s", error_msg);
1158 break;
1159 case CONFIG_ERROR_SILENT:
1160 error_return = -1;
1161 break;
1162 case CONFIG_ERROR_UNSET:
1163 BUG("config error action unset");
1166 free(error_msg);
1167 return error_return;
1170 NORETURN
1171 static void die_bad_number(const char *name, const char *value,
1172 const struct key_value_info *kvi)
1174 const char *error_type = (errno == ERANGE) ?
1175 N_("out of range") : N_("invalid unit");
1176 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1178 if (!kvi)
1179 BUG("kvi should not be NULL");
1181 if (!value)
1182 value = "";
1184 if (!kvi->filename)
1185 die(_(bad_numeric), value, name, _(error_type));
1187 switch (kvi->origin_type) {
1188 case CONFIG_ORIGIN_BLOB:
1189 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1190 value, name, kvi->filename, _(error_type));
1191 case CONFIG_ORIGIN_FILE:
1192 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1193 value, name, kvi->filename, _(error_type));
1194 case CONFIG_ORIGIN_STDIN:
1195 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1196 value, name, _(error_type));
1197 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1198 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1199 value, name, kvi->filename, _(error_type));
1200 case CONFIG_ORIGIN_CMDLINE:
1201 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1202 value, name, kvi->filename, _(error_type));
1203 default:
1204 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1205 value, name, kvi->filename, _(error_type));
1209 int git_config_int(const char *name, const char *value,
1210 const struct key_value_info *kvi)
1212 int ret;
1213 if (!git_parse_int(value, &ret))
1214 die_bad_number(name, value, kvi);
1215 return ret;
1218 int64_t git_config_int64(const char *name, const char *value,
1219 const struct key_value_info *kvi)
1221 int64_t ret;
1222 if (!git_parse_int64(value, &ret))
1223 die_bad_number(name, value, kvi);
1224 return ret;
1227 unsigned long git_config_ulong(const char *name, const char *value,
1228 const struct key_value_info *kvi)
1230 unsigned long ret;
1231 if (!git_parse_ulong(value, &ret))
1232 die_bad_number(name, value, kvi);
1233 return ret;
1236 ssize_t git_config_ssize_t(const char *name, const char *value,
1237 const struct key_value_info *kvi)
1239 ssize_t ret;
1240 if (!git_parse_ssize_t(value, &ret))
1241 die_bad_number(name, value, kvi);
1242 return ret;
1245 static const struct fsync_component_name {
1246 const char *name;
1247 enum fsync_component component_bits;
1248 } fsync_component_names[] = {
1249 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1250 { "pack", FSYNC_COMPONENT_PACK },
1251 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1252 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1253 { "index", FSYNC_COMPONENT_INDEX },
1254 { "objects", FSYNC_COMPONENTS_OBJECTS },
1255 { "reference", FSYNC_COMPONENT_REFERENCE },
1256 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1257 { "committed", FSYNC_COMPONENTS_COMMITTED },
1258 { "added", FSYNC_COMPONENTS_ADDED },
1259 { "all", FSYNC_COMPONENTS_ALL },
1262 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1264 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1265 enum fsync_component positive = 0, negative = 0;
1267 while (string) {
1268 int i;
1269 size_t len;
1270 const char *ep;
1271 int negated = 0;
1272 int found = 0;
1274 string = string + strspn(string, ", \t\n\r");
1275 ep = strchrnul(string, ',');
1276 len = ep - string;
1277 if (!strcmp(string, "none")) {
1278 current = FSYNC_COMPONENT_NONE;
1279 goto next_name;
1282 if (*string == '-') {
1283 negated = 1;
1284 string++;
1285 len--;
1286 if (!len)
1287 warning(_("invalid value for variable %s"), var);
1290 if (!len)
1291 break;
1293 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1294 const struct fsync_component_name *n = &fsync_component_names[i];
1296 if (strncmp(n->name, string, len))
1297 continue;
1299 found = 1;
1300 if (negated)
1301 negative |= n->component_bits;
1302 else
1303 positive |= n->component_bits;
1306 if (!found) {
1307 char *component = xstrndup(string, len);
1308 warning(_("ignoring unknown core.fsync component '%s'"), component);
1309 free(component);
1312 next_name:
1313 string = ep;
1316 return (current & ~negative) | positive;
1319 int git_config_bool_or_int(const char *name, const char *value,
1320 const struct key_value_info *kvi, int *is_bool)
1322 int v = git_parse_maybe_bool_text(value);
1323 if (0 <= v) {
1324 *is_bool = 1;
1325 return v;
1327 *is_bool = 0;
1328 return git_config_int(name, value, kvi);
1331 int git_config_bool(const char *name, const char *value)
1333 int v = git_parse_maybe_bool(value);
1334 if (v < 0)
1335 die(_("bad boolean config value '%s' for '%s'"), value, name);
1336 return v;
1339 int git_config_string(const char **dest, const char *var, const char *value)
1341 if (!value)
1342 return config_error_nonbool(var);
1343 *dest = xstrdup(value);
1344 return 0;
1347 int git_config_pathname(const char **dest, const char *var, const char *value)
1349 if (!value)
1350 return config_error_nonbool(var);
1351 *dest = interpolate_path(value, 0);
1352 if (!*dest)
1353 die(_("failed to expand user dir in: '%s'"), value);
1354 return 0;
1357 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1359 if (!value)
1360 return config_error_nonbool(var);
1361 if (parse_expiry_date(value, timestamp))
1362 return error(_("'%s' for '%s' is not a valid timestamp"),
1363 value, var);
1364 return 0;
1367 int git_config_color(char *dest, const char *var, const char *value)
1369 if (!value)
1370 return config_error_nonbool(var);
1371 if (color_parse(value, dest) < 0)
1372 return -1;
1373 return 0;
1376 static int git_default_core_config(const char *var, const char *value,
1377 const struct config_context *ctx, void *cb)
1379 /* This needs a better name */
1380 if (!strcmp(var, "core.filemode")) {
1381 trust_executable_bit = git_config_bool(var, value);
1382 return 0;
1384 if (!strcmp(var, "core.trustctime")) {
1385 trust_ctime = git_config_bool(var, value);
1386 return 0;
1388 if (!strcmp(var, "core.checkstat")) {
1389 if (!strcasecmp(value, "default"))
1390 check_stat = 1;
1391 else if (!strcasecmp(value, "minimal"))
1392 check_stat = 0;
1395 if (!strcmp(var, "core.quotepath")) {
1396 quote_path_fully = git_config_bool(var, value);
1397 return 0;
1400 if (!strcmp(var, "core.symlinks")) {
1401 has_symlinks = git_config_bool(var, value);
1402 return 0;
1405 if (!strcmp(var, "core.ignorecase")) {
1406 ignore_case = git_config_bool(var, value);
1407 return 0;
1410 if (!strcmp(var, "core.attributesfile"))
1411 return git_config_pathname(&git_attributes_file, var, value);
1413 if (!strcmp(var, "core.hookspath"))
1414 return git_config_pathname(&git_hooks_path, var, value);
1416 if (!strcmp(var, "core.bare")) {
1417 is_bare_repository_cfg = git_config_bool(var, value);
1418 return 0;
1421 if (!strcmp(var, "core.ignorestat")) {
1422 assume_unchanged = git_config_bool(var, value);
1423 return 0;
1426 if (!strcmp(var, "core.prefersymlinkrefs")) {
1427 prefer_symlink_refs = git_config_bool(var, value);
1428 return 0;
1431 if (!strcmp(var, "core.logallrefupdates")) {
1432 if (value && !strcasecmp(value, "always"))
1433 log_all_ref_updates = LOG_REFS_ALWAYS;
1434 else if (git_config_bool(var, value))
1435 log_all_ref_updates = LOG_REFS_NORMAL;
1436 else
1437 log_all_ref_updates = LOG_REFS_NONE;
1438 return 0;
1441 if (!strcmp(var, "core.warnambiguousrefs")) {
1442 warn_ambiguous_refs = git_config_bool(var, value);
1443 return 0;
1446 if (!strcmp(var, "core.abbrev")) {
1447 if (!value)
1448 return config_error_nonbool(var);
1449 if (!strcasecmp(value, "auto"))
1450 default_abbrev = -1;
1451 else if (!git_parse_maybe_bool_text(value))
1452 default_abbrev = the_hash_algo->hexsz;
1453 else {
1454 int abbrev = git_config_int(var, value, ctx->kvi);
1455 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1456 return error(_("abbrev length out of range: %d"), abbrev);
1457 default_abbrev = abbrev;
1459 return 0;
1462 if (!strcmp(var, "core.disambiguate"))
1463 return set_disambiguate_hint_config(var, value);
1465 if (!strcmp(var, "core.loosecompression")) {
1466 int level = git_config_int(var, value, ctx->kvi);
1467 if (level == -1)
1468 level = Z_DEFAULT_COMPRESSION;
1469 else if (level < 0 || level > Z_BEST_COMPRESSION)
1470 die(_("bad zlib compression level %d"), level);
1471 zlib_compression_level = level;
1472 zlib_compression_seen = 1;
1473 return 0;
1476 if (!strcmp(var, "core.compression")) {
1477 int level = git_config_int(var, value, ctx->kvi);
1478 if (level == -1)
1479 level = Z_DEFAULT_COMPRESSION;
1480 else if (level < 0 || level > Z_BEST_COMPRESSION)
1481 die(_("bad zlib compression level %d"), level);
1482 if (!zlib_compression_seen)
1483 zlib_compression_level = level;
1484 if (!pack_compression_seen)
1485 pack_compression_level = level;
1486 return 0;
1489 if (!strcmp(var, "core.packedgitwindowsize")) {
1490 int pgsz_x2 = getpagesize() * 2;
1491 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1493 /* This value must be multiple of (pagesize * 2) */
1494 packed_git_window_size /= pgsz_x2;
1495 if (packed_git_window_size < 1)
1496 packed_git_window_size = 1;
1497 packed_git_window_size *= pgsz_x2;
1498 return 0;
1501 if (!strcmp(var, "core.bigfilethreshold")) {
1502 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1503 return 0;
1506 if (!strcmp(var, "core.packedgitlimit")) {
1507 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1508 return 0;
1511 if (!strcmp(var, "core.deltabasecachelimit")) {
1512 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1513 return 0;
1516 if (!strcmp(var, "core.autocrlf")) {
1517 if (value && !strcasecmp(value, "input")) {
1518 auto_crlf = AUTO_CRLF_INPUT;
1519 return 0;
1521 auto_crlf = git_config_bool(var, value);
1522 return 0;
1525 if (!strcmp(var, "core.safecrlf")) {
1526 int eol_rndtrp_die;
1527 if (value && !strcasecmp(value, "warn")) {
1528 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1529 return 0;
1531 eol_rndtrp_die = git_config_bool(var, value);
1532 global_conv_flags_eol = eol_rndtrp_die ?
1533 CONV_EOL_RNDTRP_DIE : 0;
1534 return 0;
1537 if (!strcmp(var, "core.eol")) {
1538 if (value && !strcasecmp(value, "lf"))
1539 core_eol = EOL_LF;
1540 else if (value && !strcasecmp(value, "crlf"))
1541 core_eol = EOL_CRLF;
1542 else if (value && !strcasecmp(value, "native"))
1543 core_eol = EOL_NATIVE;
1544 else
1545 core_eol = EOL_UNSET;
1546 return 0;
1549 if (!strcmp(var, "core.checkroundtripencoding")) {
1550 check_roundtrip_encoding = xstrdup(value);
1551 return 0;
1554 if (!strcmp(var, "core.notesref")) {
1555 notes_ref_name = xstrdup(value);
1556 return 0;
1559 if (!strcmp(var, "core.editor"))
1560 return git_config_string(&editor_program, var, value);
1562 if (!strcmp(var, "core.commentchar")) {
1563 if (!value)
1564 return config_error_nonbool(var);
1565 else if (!strcasecmp(value, "auto"))
1566 auto_comment_line_char = 1;
1567 else if (value[0] && !value[1]) {
1568 comment_line_char = value[0];
1569 auto_comment_line_char = 0;
1570 } else
1571 return error(_("core.commentChar should only be one ASCII character"));
1572 return 0;
1575 if (!strcmp(var, "core.askpass"))
1576 return git_config_string(&askpass_program, var, value);
1578 if (!strcmp(var, "core.excludesfile"))
1579 return git_config_pathname(&excludes_file, var, value);
1581 if (!strcmp(var, "core.whitespace")) {
1582 if (!value)
1583 return config_error_nonbool(var);
1584 whitespace_rule_cfg = parse_whitespace_rule(value);
1585 return 0;
1588 if (!strcmp(var, "core.fsync")) {
1589 if (!value)
1590 return config_error_nonbool(var);
1591 fsync_components = parse_fsync_components(var, value);
1592 return 0;
1595 if (!strcmp(var, "core.fsyncmethod")) {
1596 if (!value)
1597 return config_error_nonbool(var);
1598 if (!strcmp(value, "fsync"))
1599 fsync_method = FSYNC_METHOD_FSYNC;
1600 else if (!strcmp(value, "writeout-only"))
1601 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1602 else if (!strcmp(value, "batch"))
1603 fsync_method = FSYNC_METHOD_BATCH;
1604 else
1605 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1609 if (!strcmp(var, "core.fsyncobjectfiles")) {
1610 if (fsync_object_files < 0)
1611 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1612 fsync_object_files = git_config_bool(var, value);
1613 return 0;
1616 if (!strcmp(var, "core.preloadindex")) {
1617 core_preload_index = git_config_bool(var, value);
1618 return 0;
1621 if (!strcmp(var, "core.createobject")) {
1622 if (!strcmp(value, "rename"))
1623 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1624 else if (!strcmp(value, "link"))
1625 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1626 else
1627 die(_("invalid mode for object creation: %s"), value);
1628 return 0;
1631 if (!strcmp(var, "core.sparsecheckout")) {
1632 core_apply_sparse_checkout = git_config_bool(var, value);
1633 return 0;
1636 if (!strcmp(var, "core.sparsecheckoutcone")) {
1637 core_sparse_checkout_cone = git_config_bool(var, value);
1638 return 0;
1641 if (!strcmp(var, "core.precomposeunicode")) {
1642 precomposed_unicode = git_config_bool(var, value);
1643 return 0;
1646 if (!strcmp(var, "core.protecthfs")) {
1647 protect_hfs = git_config_bool(var, value);
1648 return 0;
1651 if (!strcmp(var, "core.protectntfs")) {
1652 protect_ntfs = git_config_bool(var, value);
1653 return 0;
1656 if (!strcmp(var, "core.maxtreedepth")) {
1657 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1658 return 0;
1661 /* Add other config variables here and to Documentation/config.txt. */
1662 return platform_core_config(var, value, ctx, cb);
1665 static int git_default_sparse_config(const char *var, const char *value)
1667 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1668 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1669 return 0;
1672 /* Add other config variables here and to Documentation/config/sparse.txt. */
1673 return 0;
1676 static int git_default_i18n_config(const char *var, const char *value)
1678 if (!strcmp(var, "i18n.commitencoding"))
1679 return git_config_string(&git_commit_encoding, var, value);
1681 if (!strcmp(var, "i18n.logoutputencoding"))
1682 return git_config_string(&git_log_output_encoding, var, value);
1684 /* Add other config variables here and to Documentation/config.txt. */
1685 return 0;
1688 static int git_default_branch_config(const char *var, const char *value)
1690 if (!strcmp(var, "branch.autosetupmerge")) {
1691 if (value && !strcmp(value, "always")) {
1692 git_branch_track = BRANCH_TRACK_ALWAYS;
1693 return 0;
1694 } else if (value && !strcmp(value, "inherit")) {
1695 git_branch_track = BRANCH_TRACK_INHERIT;
1696 return 0;
1697 } else if (value && !strcmp(value, "simple")) {
1698 git_branch_track = BRANCH_TRACK_SIMPLE;
1699 return 0;
1701 git_branch_track = git_config_bool(var, value);
1702 return 0;
1704 if (!strcmp(var, "branch.autosetuprebase")) {
1705 if (!value)
1706 return config_error_nonbool(var);
1707 else if (!strcmp(value, "never"))
1708 autorebase = AUTOREBASE_NEVER;
1709 else if (!strcmp(value, "local"))
1710 autorebase = AUTOREBASE_LOCAL;
1711 else if (!strcmp(value, "remote"))
1712 autorebase = AUTOREBASE_REMOTE;
1713 else if (!strcmp(value, "always"))
1714 autorebase = AUTOREBASE_ALWAYS;
1715 else
1716 return error(_("malformed value for %s"), var);
1717 return 0;
1720 /* Add other config variables here and to Documentation/config.txt. */
1721 return 0;
1724 static int git_default_push_config(const char *var, const char *value)
1726 if (!strcmp(var, "push.default")) {
1727 if (!value)
1728 return config_error_nonbool(var);
1729 else if (!strcmp(value, "nothing"))
1730 push_default = PUSH_DEFAULT_NOTHING;
1731 else if (!strcmp(value, "matching"))
1732 push_default = PUSH_DEFAULT_MATCHING;
1733 else if (!strcmp(value, "simple"))
1734 push_default = PUSH_DEFAULT_SIMPLE;
1735 else if (!strcmp(value, "upstream"))
1736 push_default = PUSH_DEFAULT_UPSTREAM;
1737 else if (!strcmp(value, "tracking")) /* deprecated */
1738 push_default = PUSH_DEFAULT_UPSTREAM;
1739 else if (!strcmp(value, "current"))
1740 push_default = PUSH_DEFAULT_CURRENT;
1741 else {
1742 error(_("malformed value for %s: %s"), var, value);
1743 return error(_("must be one of nothing, matching, simple, "
1744 "upstream or current"));
1746 return 0;
1749 /* Add other config variables here and to Documentation/config.txt. */
1750 return 0;
1753 static int git_default_mailmap_config(const char *var, const char *value)
1755 if (!strcmp(var, "mailmap.file"))
1756 return git_config_pathname(&git_mailmap_file, var, value);
1757 if (!strcmp(var, "mailmap.blob"))
1758 return git_config_string(&git_mailmap_blob, var, value);
1760 /* Add other config variables here and to Documentation/config.txt. */
1761 return 0;
1764 static int git_default_attr_config(const char *var, const char *value)
1766 if (!strcmp(var, "attr.tree"))
1767 return git_config_string(&git_attr_tree, var, value);
1770 * Add other attribute related config variables here and to
1771 * Documentation/config/attr.txt.
1773 return 0;
1776 int git_default_config(const char *var, const char *value,
1777 const struct config_context *ctx, void *cb)
1779 if (starts_with(var, "core."))
1780 return git_default_core_config(var, value, ctx, cb);
1782 if (starts_with(var, "user.") ||
1783 starts_with(var, "author.") ||
1784 starts_with(var, "committer."))
1785 return git_ident_config(var, value, ctx, cb);
1787 if (starts_with(var, "i18n."))
1788 return git_default_i18n_config(var, value);
1790 if (starts_with(var, "branch."))
1791 return git_default_branch_config(var, value);
1793 if (starts_with(var, "push."))
1794 return git_default_push_config(var, value);
1796 if (starts_with(var, "mailmap."))
1797 return git_default_mailmap_config(var, value);
1799 if (starts_with(var, "attr."))
1800 return git_default_attr_config(var, value);
1802 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1803 return git_default_advice_config(var, value);
1805 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1806 pager_use_color = git_config_bool(var,value);
1807 return 0;
1810 if (!strcmp(var, "pack.packsizelimit")) {
1811 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1812 return 0;
1815 if (!strcmp(var, "pack.compression")) {
1816 int level = git_config_int(var, value, ctx->kvi);
1817 if (level == -1)
1818 level = Z_DEFAULT_COMPRESSION;
1819 else if (level < 0 || level > Z_BEST_COMPRESSION)
1820 die(_("bad pack compression level %d"), level);
1821 pack_compression_level = level;
1822 pack_compression_seen = 1;
1823 return 0;
1826 if (starts_with(var, "sparse."))
1827 return git_default_sparse_config(var, value);
1829 /* Add other config variables here and to Documentation/config.txt. */
1830 return 0;
1834 * All source specific fields in the union, die_on_error, name and the callbacks
1835 * fgetc, ungetc, ftell of top need to be initialized before calling
1836 * this function.
1838 static int do_config_from(struct config_source *top, config_fn_t fn,
1839 void *data, enum config_scope scope,
1840 const struct config_options *opts)
1842 struct key_value_info kvi = KVI_INIT;
1843 int ret;
1845 /* push config-file parsing state stack */
1846 top->linenr = 1;
1847 top->eof = 0;
1848 top->total_len = 0;
1849 strbuf_init(&top->value, 1024);
1850 strbuf_init(&top->var, 1024);
1851 kvi_from_source(top, scope, &kvi);
1853 ret = git_parse_source(top, fn, &kvi, data, opts);
1855 strbuf_release(&top->value);
1856 strbuf_release(&top->var);
1858 return ret;
1861 static int do_config_from_file(config_fn_t fn,
1862 const enum config_origin_type origin_type,
1863 const char *name, const char *path, FILE *f,
1864 void *data, enum config_scope scope,
1865 const struct config_options *opts)
1867 struct config_source top = CONFIG_SOURCE_INIT;
1868 int ret;
1870 top.u.file = f;
1871 top.origin_type = origin_type;
1872 top.name = name;
1873 top.path = path;
1874 top.default_error_action = CONFIG_ERROR_DIE;
1875 top.do_fgetc = config_file_fgetc;
1876 top.do_ungetc = config_file_ungetc;
1877 top.do_ftell = config_file_ftell;
1879 flockfile(f);
1880 ret = do_config_from(&top, fn, data, scope, opts);
1881 funlockfile(f);
1882 return ret;
1885 static int git_config_from_stdin(config_fn_t fn, void *data,
1886 enum config_scope scope)
1888 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1889 data, scope, NULL);
1892 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1893 void *data, enum config_scope scope,
1894 const struct config_options *opts)
1896 int ret = -1;
1897 FILE *f;
1899 if (!filename)
1900 BUG("filename cannot be NULL");
1901 f = fopen_or_warn(filename, "r");
1902 if (f) {
1903 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1904 filename, f, data, scope, opts);
1905 fclose(f);
1907 return ret;
1910 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1912 return git_config_from_file_with_options(fn, filename, data,
1913 CONFIG_SCOPE_UNKNOWN, NULL);
1916 int git_config_from_mem(config_fn_t fn,
1917 const enum config_origin_type origin_type,
1918 const char *name, const char *buf, size_t len,
1919 void *data, enum config_scope scope,
1920 const struct config_options *opts)
1922 struct config_source top = CONFIG_SOURCE_INIT;
1924 top.u.buf.buf = buf;
1925 top.u.buf.len = len;
1926 top.u.buf.pos = 0;
1927 top.origin_type = origin_type;
1928 top.name = name;
1929 top.path = NULL;
1930 top.default_error_action = CONFIG_ERROR_ERROR;
1931 top.do_fgetc = config_buf_fgetc;
1932 top.do_ungetc = config_buf_ungetc;
1933 top.do_ftell = config_buf_ftell;
1935 return do_config_from(&top, fn, data, scope, opts);
1938 int git_config_from_blob_oid(config_fn_t fn,
1939 const char *name,
1940 struct repository *repo,
1941 const struct object_id *oid,
1942 void *data,
1943 enum config_scope scope)
1945 enum object_type type;
1946 char *buf;
1947 unsigned long size;
1948 int ret;
1950 buf = repo_read_object_file(repo, oid, &type, &size);
1951 if (!buf)
1952 return error(_("unable to load config blob object '%s'"), name);
1953 if (type != OBJ_BLOB) {
1954 free(buf);
1955 return error(_("reference '%s' does not point to a blob"), name);
1958 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1959 data, scope, NULL);
1960 free(buf);
1962 return ret;
1965 static int git_config_from_blob_ref(config_fn_t fn,
1966 struct repository *repo,
1967 const char *name,
1968 void *data,
1969 enum config_scope scope)
1971 struct object_id oid;
1973 if (repo_get_oid(repo, name, &oid) < 0)
1974 return error(_("unable to resolve config blob '%s'"), name);
1975 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
1978 char *git_system_config(void)
1980 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1981 if (!system_config)
1982 system_config = system_path(ETC_GITCONFIG);
1983 normalize_path_copy(system_config, system_config);
1984 return system_config;
1987 void git_global_config(char **user_out, char **xdg_out)
1989 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1990 char *xdg_config = NULL;
1992 if (!user_config) {
1993 user_config = interpolate_path("~/.gitconfig", 0);
1994 xdg_config = xdg_config_home("config");
1997 *user_out = user_config;
1998 *xdg_out = xdg_config;
2001 int git_config_system(void)
2003 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2006 static int do_git_config_sequence(const struct config_options *opts,
2007 const struct repository *repo,
2008 config_fn_t fn, void *data)
2010 int ret = 0;
2011 char *system_config = git_system_config();
2012 char *xdg_config = NULL;
2013 char *user_config = NULL;
2014 char *repo_config;
2015 char *worktree_config;
2018 * Ensure that either:
2019 * - the git_dir and commondir are both set, or
2020 * - the git_dir and commondir are both NULL
2022 if (!opts->git_dir != !opts->commondir)
2023 BUG("only one of commondir and git_dir is non-NULL");
2025 if (opts->commondir) {
2026 repo_config = mkpathdup("%s/config", opts->commondir);
2027 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2028 } else {
2029 repo_config = NULL;
2030 worktree_config = NULL;
2033 if (git_config_system() && system_config &&
2034 !access_or_die(system_config, R_OK,
2035 opts->system_gently ? ACCESS_EACCES_OK : 0))
2036 ret += git_config_from_file_with_options(fn, system_config,
2037 data, CONFIG_SCOPE_SYSTEM,
2038 NULL);
2040 git_global_config(&user_config, &xdg_config);
2042 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2043 ret += git_config_from_file_with_options(fn, xdg_config, data,
2044 CONFIG_SCOPE_GLOBAL, NULL);
2046 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2047 ret += git_config_from_file_with_options(fn, user_config, data,
2048 CONFIG_SCOPE_GLOBAL, NULL);
2050 if (!opts->ignore_repo && repo_config &&
2051 !access_or_die(repo_config, R_OK, 0))
2052 ret += git_config_from_file_with_options(fn, repo_config, data,
2053 CONFIG_SCOPE_LOCAL, NULL);
2055 if (!opts->ignore_worktree && worktree_config &&
2056 repo && repo->repository_format_worktree_config &&
2057 !access_or_die(worktree_config, R_OK, 0)) {
2058 ret += git_config_from_file_with_options(fn, worktree_config, data,
2059 CONFIG_SCOPE_WORKTREE,
2060 NULL);
2063 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2064 die(_("unable to parse command-line config"));
2066 free(system_config);
2067 free(xdg_config);
2068 free(user_config);
2069 free(repo_config);
2070 free(worktree_config);
2071 return ret;
2074 int config_with_options(config_fn_t fn, void *data,
2075 struct git_config_source *config_source,
2076 struct repository *repo,
2077 const struct config_options *opts)
2079 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2080 int ret;
2082 if (opts->respect_includes) {
2083 inc.fn = fn;
2084 inc.data = data;
2085 inc.opts = opts;
2086 inc.repo = repo;
2087 inc.config_source = config_source;
2088 fn = git_config_include;
2089 data = &inc;
2093 * If we have a specific filename, use it. Otherwise, follow the
2094 * regular lookup sequence.
2096 if (config_source && config_source->use_stdin) {
2097 ret = git_config_from_stdin(fn, data, config_source->scope);
2098 } else if (config_source && config_source->file) {
2099 ret = git_config_from_file_with_options(fn, config_source->file,
2100 data, config_source->scope,
2101 NULL);
2102 } else if (config_source && config_source->blob) {
2103 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2104 data, config_source->scope);
2105 } else {
2106 ret = do_git_config_sequence(opts, repo, fn, data);
2109 if (inc.remote_urls) {
2110 string_list_clear(inc.remote_urls, 0);
2111 FREE_AND_NULL(inc.remote_urls);
2113 return ret;
2116 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2118 int i, value_index;
2119 struct string_list *values;
2120 struct config_set_element *entry;
2121 struct configset_list *list = &set->list;
2122 struct config_context ctx = CONFIG_CONTEXT_INIT;
2124 for (i = 0; i < list->nr; i++) {
2125 entry = list->items[i].e;
2126 value_index = list->items[i].value_index;
2127 values = &entry->value_list;
2129 ctx.kvi = values->items[value_index].util;
2130 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2131 git_die_config_linenr(entry->key,
2132 ctx.kvi->filename,
2133 ctx.kvi->linenr);
2137 void read_early_config(config_fn_t cb, void *data)
2139 struct config_options opts = {0};
2140 struct strbuf commondir = STRBUF_INIT;
2141 struct strbuf gitdir = STRBUF_INIT;
2143 opts.respect_includes = 1;
2145 if (have_git_dir()) {
2146 opts.commondir = get_git_common_dir();
2147 opts.git_dir = get_git_dir();
2149 * When setup_git_directory() was not yet asked to discover the
2150 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2151 * is any repository config we should use (but unlike
2152 * setup_git_directory_gently(), no global state is changed, most
2153 * notably, the current working directory is still the same after the
2154 * call).
2156 } else if (!discover_git_directory(&commondir, &gitdir)) {
2157 opts.commondir = commondir.buf;
2158 opts.git_dir = gitdir.buf;
2161 config_with_options(cb, data, NULL, NULL, &opts);
2163 strbuf_release(&commondir);
2164 strbuf_release(&gitdir);
2168 * Read config but only enumerate system and global settings.
2169 * Omit any repo-local, worktree-local, or command-line settings.
2171 void read_very_early_config(config_fn_t cb, void *data)
2173 struct config_options opts = { 0 };
2175 opts.respect_includes = 1;
2176 opts.ignore_repo = 1;
2177 opts.ignore_worktree = 1;
2178 opts.ignore_cmdline = 1;
2179 opts.system_gently = 1;
2181 config_with_options(cb, data, NULL, NULL, &opts);
2184 RESULT_MUST_BE_USED
2185 static int configset_find_element(struct config_set *set, const char *key,
2186 struct config_set_element **dest)
2188 struct config_set_element k;
2189 struct config_set_element *found_entry;
2190 char *normalized_key;
2191 int ret;
2194 * `key` may come from the user, so normalize it before using it
2195 * for querying entries from the hashmap.
2197 ret = git_config_parse_key(key, &normalized_key, NULL);
2198 if (ret)
2199 return ret;
2201 hashmap_entry_init(&k.ent, strhash(normalized_key));
2202 k.key = normalized_key;
2203 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2204 free(normalized_key);
2205 *dest = found_entry;
2206 return 0;
2209 static int configset_add_value(const struct key_value_info *kvi_p,
2210 struct config_set *set, const char *key,
2211 const char *value)
2213 struct config_set_element *e;
2214 struct string_list_item *si;
2215 struct configset_list_item *l_item;
2216 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2217 int ret;
2219 ret = configset_find_element(set, key, &e);
2220 if (ret)
2221 return ret;
2223 * Since the keys are being fed by git_config*() callback mechanism, they
2224 * are already normalized. So simply add them without any further munging.
2226 if (!e) {
2227 e = xmalloc(sizeof(*e));
2228 hashmap_entry_init(&e->ent, strhash(key));
2229 e->key = xstrdup(key);
2230 string_list_init_dup(&e->value_list);
2231 hashmap_add(&set->config_hash, &e->ent);
2233 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2235 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2236 l_item = &set->list.items[set->list.nr++];
2237 l_item->e = e;
2238 l_item->value_index = e->value_list.nr - 1;
2240 *kv_info = *kvi_p;
2241 si->util = kv_info;
2243 return 0;
2246 static int config_set_element_cmp(const void *cmp_data UNUSED,
2247 const struct hashmap_entry *eptr,
2248 const struct hashmap_entry *entry_or_key,
2249 const void *keydata UNUSED)
2251 const struct config_set_element *e1, *e2;
2253 e1 = container_of(eptr, const struct config_set_element, ent);
2254 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2256 return strcmp(e1->key, e2->key);
2259 void git_configset_init(struct config_set *set)
2261 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2262 set->hash_initialized = 1;
2263 set->list.nr = 0;
2264 set->list.alloc = 0;
2265 set->list.items = NULL;
2268 void git_configset_clear(struct config_set *set)
2270 struct config_set_element *entry;
2271 struct hashmap_iter iter;
2272 if (!set->hash_initialized)
2273 return;
2275 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2276 ent /* member name */) {
2277 free(entry->key);
2278 string_list_clear(&entry->value_list, 1);
2280 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2281 set->hash_initialized = 0;
2282 free(set->list.items);
2283 set->list.nr = 0;
2284 set->list.alloc = 0;
2285 set->list.items = NULL;
2288 static int config_set_callback(const char *key, const char *value,
2289 const struct config_context *ctx,
2290 void *cb)
2292 struct config_set *set = cb;
2293 configset_add_value(ctx->kvi, set, key, value);
2294 return 0;
2297 int git_configset_add_file(struct config_set *set, const char *filename)
2299 return git_config_from_file(config_set_callback, filename, set);
2302 int git_configset_get_value(struct config_set *set, const char *key,
2303 const char **value, struct key_value_info *kvi)
2305 const struct string_list *values = NULL;
2306 int ret;
2307 struct string_list_item item;
2309 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2310 * queried key in the files of the configset, the value returned will be the last
2311 * value in the value list for that key.
2313 if ((ret = git_configset_get_value_multi(set, key, &values)))
2314 return ret;
2316 assert(values->nr > 0);
2317 item = values->items[values->nr - 1];
2318 *value = item.string;
2319 if (kvi)
2320 *kvi = *((struct key_value_info *)item.util);
2321 return 0;
2324 int git_configset_get_value_multi(struct config_set *set, const char *key,
2325 const struct string_list **dest)
2327 struct config_set_element *e;
2328 int ret;
2330 if ((ret = configset_find_element(set, key, &e)))
2331 return ret;
2332 else if (!e)
2333 return 1;
2334 *dest = &e->value_list;
2336 return 0;
2339 static int check_multi_string(struct string_list_item *item, void *util)
2341 return item->string ? 0 : config_error_nonbool(util);
2344 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2345 const struct string_list **dest)
2347 int ret;
2349 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2350 return ret;
2351 if ((ret = for_each_string_list((struct string_list *)*dest,
2352 check_multi_string, (void *)key)))
2353 return ret;
2355 return 0;
2358 int git_configset_get(struct config_set *set, const char *key)
2360 struct config_set_element *e;
2361 int ret;
2363 if ((ret = configset_find_element(set, key, &e)))
2364 return ret;
2365 else if (!e)
2366 return 1;
2367 return 0;
2370 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2372 const char *value;
2373 if (!git_configset_get_value(set, key, &value, NULL))
2374 return git_config_string((const char **)dest, key, value);
2375 else
2376 return 1;
2379 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2380 const char **dest)
2382 const char *value;
2383 if (!git_configset_get_value(set, key, &value, NULL)) {
2384 if (!value)
2385 return config_error_nonbool(key);
2386 *dest = value;
2387 return 0;
2388 } else {
2389 return 1;
2393 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2395 const char *value;
2396 struct key_value_info kvi;
2398 if (!git_configset_get_value(set, key, &value, &kvi)) {
2399 *dest = git_config_int(key, value, &kvi);
2400 return 0;
2401 } else
2402 return 1;
2405 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2407 const char *value;
2408 struct key_value_info kvi;
2410 if (!git_configset_get_value(set, key, &value, &kvi)) {
2411 *dest = git_config_ulong(key, value, &kvi);
2412 return 0;
2413 } else
2414 return 1;
2417 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2419 const char *value;
2420 if (!git_configset_get_value(set, key, &value, NULL)) {
2421 *dest = git_config_bool(key, value);
2422 return 0;
2423 } else
2424 return 1;
2427 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2428 int *is_bool, int *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_bool_or_int(key, value, &kvi, is_bool);
2435 return 0;
2436 } else
2437 return 1;
2440 int git_configset_get_maybe_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_parse_maybe_bool(value);
2445 if (*dest == -1)
2446 return -1;
2447 return 0;
2448 } else
2449 return 1;
2452 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2454 const char *value;
2455 if (!git_configset_get_value(set, key, &value, NULL))
2456 return git_config_pathname(dest, key, value);
2457 else
2458 return 1;
2461 /* Functions use to read configuration from a repository */
2462 static void repo_read_config(struct repository *repo)
2464 struct config_options opts = { 0 };
2466 opts.respect_includes = 1;
2467 opts.commondir = repo->commondir;
2468 opts.git_dir = repo->gitdir;
2470 if (!repo->config)
2471 CALLOC_ARRAY(repo->config, 1);
2472 else
2473 git_configset_clear(repo->config);
2475 git_configset_init(repo->config);
2476 if (config_with_options(config_set_callback, repo->config, NULL,
2477 repo, &opts) < 0)
2479 * config_with_options() normally returns only
2480 * zero, as most errors are fatal, and
2481 * non-fatal potential errors are guarded by "if"
2482 * statements that are entered only when no error is
2483 * possible.
2485 * If we ever encounter a non-fatal error, it means
2486 * something went really wrong and we should stop
2487 * immediately.
2489 die(_("unknown error occurred while reading the configuration files"));
2492 static void git_config_check_init(struct repository *repo)
2494 if (repo->config && repo->config->hash_initialized)
2495 return;
2496 repo_read_config(repo);
2499 static void repo_config_clear(struct repository *repo)
2501 if (!repo->config || !repo->config->hash_initialized)
2502 return;
2503 git_configset_clear(repo->config);
2506 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2508 git_config_check_init(repo);
2509 configset_iter(repo->config, fn, data);
2512 int repo_config_get(struct repository *repo, const char *key)
2514 git_config_check_init(repo);
2515 return git_configset_get(repo->config, key);
2518 int repo_config_get_value(struct repository *repo,
2519 const char *key, const char **value)
2521 git_config_check_init(repo);
2522 return git_configset_get_value(repo->config, key, value, NULL);
2525 int repo_config_get_value_multi(struct repository *repo, const char *key,
2526 const struct string_list **dest)
2528 git_config_check_init(repo);
2529 return git_configset_get_value_multi(repo->config, key, dest);
2532 int repo_config_get_string_multi(struct repository *repo, const char *key,
2533 const struct string_list **dest)
2535 git_config_check_init(repo);
2536 return git_configset_get_string_multi(repo->config, key, dest);
2539 int repo_config_get_string(struct repository *repo,
2540 const char *key, char **dest)
2542 int ret;
2543 git_config_check_init(repo);
2544 ret = git_configset_get_string(repo->config, key, dest);
2545 if (ret < 0)
2546 git_die_config(key, NULL);
2547 return ret;
2550 int repo_config_get_string_tmp(struct repository *repo,
2551 const char *key, const char **dest)
2553 int ret;
2554 git_config_check_init(repo);
2555 ret = git_configset_get_string_tmp(repo->config, key, dest);
2556 if (ret < 0)
2557 git_die_config(key, NULL);
2558 return ret;
2561 int repo_config_get_int(struct repository *repo,
2562 const char *key, int *dest)
2564 git_config_check_init(repo);
2565 return git_configset_get_int(repo->config, key, dest);
2568 int repo_config_get_ulong(struct repository *repo,
2569 const char *key, unsigned long *dest)
2571 git_config_check_init(repo);
2572 return git_configset_get_ulong(repo->config, key, dest);
2575 int repo_config_get_bool(struct repository *repo,
2576 const char *key, int *dest)
2578 git_config_check_init(repo);
2579 return git_configset_get_bool(repo->config, key, dest);
2582 int repo_config_get_bool_or_int(struct repository *repo,
2583 const char *key, int *is_bool, int *dest)
2585 git_config_check_init(repo);
2586 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2589 int repo_config_get_maybe_bool(struct repository *repo,
2590 const char *key, int *dest)
2592 git_config_check_init(repo);
2593 return git_configset_get_maybe_bool(repo->config, key, dest);
2596 int repo_config_get_pathname(struct repository *repo,
2597 const char *key, const char **dest)
2599 int ret;
2600 git_config_check_init(repo);
2601 ret = git_configset_get_pathname(repo->config, key, dest);
2602 if (ret < 0)
2603 git_die_config(key, NULL);
2604 return ret;
2607 /* Read values into protected_config. */
2608 static void read_protected_config(void)
2610 struct config_options opts = {
2611 .respect_includes = 1,
2612 .ignore_repo = 1,
2613 .ignore_worktree = 1,
2614 .system_gently = 1,
2617 git_configset_init(&protected_config);
2618 config_with_options(config_set_callback, &protected_config, NULL,
2619 NULL, &opts);
2622 void git_protected_config(config_fn_t fn, void *data)
2624 if (!protected_config.hash_initialized)
2625 read_protected_config();
2626 configset_iter(&protected_config, fn, data);
2629 /* Functions used historically to read configuration from 'the_repository' */
2630 void git_config(config_fn_t fn, void *data)
2632 repo_config(the_repository, fn, data);
2635 void git_config_clear(void)
2637 repo_config_clear(the_repository);
2640 int git_config_get(const char *key)
2642 return repo_config_get(the_repository, key);
2645 int git_config_get_value(const char *key, const char **value)
2647 return repo_config_get_value(the_repository, key, value);
2650 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2652 return repo_config_get_value_multi(the_repository, key, dest);
2655 int git_config_get_string_multi(const char *key,
2656 const struct string_list **dest)
2658 return repo_config_get_string_multi(the_repository, key, dest);
2661 int git_config_get_string(const char *key, char **dest)
2663 return repo_config_get_string(the_repository, key, dest);
2666 int git_config_get_string_tmp(const char *key, const char **dest)
2668 return repo_config_get_string_tmp(the_repository, key, dest);
2671 int git_config_get_int(const char *key, int *dest)
2673 return repo_config_get_int(the_repository, key, dest);
2676 int git_config_get_ulong(const char *key, unsigned long *dest)
2678 return repo_config_get_ulong(the_repository, key, dest);
2681 int git_config_get_bool(const char *key, int *dest)
2683 return repo_config_get_bool(the_repository, key, dest);
2686 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2688 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2691 int git_config_get_maybe_bool(const char *key, int *dest)
2693 return repo_config_get_maybe_bool(the_repository, key, dest);
2696 int git_config_get_pathname(const char *key, const char **dest)
2698 return repo_config_get_pathname(the_repository, key, dest);
2701 int git_config_get_expiry(const char *key, const char **output)
2703 int ret = git_config_get_string(key, (char **)output);
2704 if (ret)
2705 return ret;
2706 if (strcmp(*output, "now")) {
2707 timestamp_t now = approxidate("now");
2708 if (approxidate(*output) >= now)
2709 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2711 return ret;
2714 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2716 const char *expiry_string;
2717 intmax_t days;
2718 timestamp_t when;
2720 if (git_config_get_string_tmp(key, &expiry_string))
2721 return 1; /* no such thing */
2723 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2724 const int scale = 86400;
2725 *expiry = now - days * scale;
2726 return 0;
2729 if (!parse_expiry_date(expiry_string, &when)) {
2730 *expiry = when;
2731 return 0;
2733 return -1; /* thing exists but cannot be parsed */
2736 int git_config_get_split_index(void)
2738 int val;
2740 if (!git_config_get_maybe_bool("core.splitindex", &val))
2741 return val;
2743 return -1; /* default value */
2746 int git_config_get_max_percent_split_change(void)
2748 int val = -1;
2750 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2751 if (0 <= val && val <= 100)
2752 return val;
2754 return error(_("splitIndex.maxPercentChange value '%d' "
2755 "should be between 0 and 100"), val);
2758 return -1; /* default value */
2761 int git_config_get_index_threads(int *dest)
2763 int is_bool, val;
2765 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2766 if (val) {
2767 *dest = val;
2768 return 0;
2771 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2772 if (is_bool)
2773 *dest = val ? 0 : 1;
2774 else
2775 *dest = val;
2776 return 0;
2779 return 1;
2782 NORETURN
2783 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2785 if (!filename)
2786 die(_("unable to parse '%s' from command-line config"), key);
2787 else
2788 die(_("bad config variable '%s' in file '%s' at line %d"),
2789 key, filename, linenr);
2792 NORETURN __attribute__((format(printf, 2, 3)))
2793 void git_die_config(const char *key, const char *err, ...)
2795 const struct string_list *values;
2796 struct key_value_info *kv_info;
2797 report_fn error_fn = get_error_routine();
2799 if (err) {
2800 va_list params;
2801 va_start(params, err);
2802 error_fn(err, params);
2803 va_end(params);
2805 if (git_config_get_value_multi(key, &values))
2806 BUG("for key '%s' we must have a value to report on", key);
2807 kv_info = values->items[values->nr - 1].util;
2808 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2812 * Find all the stuff for git_config_set() below.
2815 struct config_store_data {
2816 size_t baselen;
2817 char *key;
2818 int do_not_match;
2819 const char *fixed_value;
2820 regex_t *value_pattern;
2821 int multi_replace;
2822 struct {
2823 size_t begin, end;
2824 enum config_event_t type;
2825 int is_keys_section;
2826 } *parsed;
2827 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2828 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2830 #define CONFIG_STORE_INIT { 0 }
2832 static void config_store_data_clear(struct config_store_data *store)
2834 free(store->key);
2835 if (store->value_pattern != NULL &&
2836 store->value_pattern != CONFIG_REGEX_NONE) {
2837 regfree(store->value_pattern);
2838 free(store->value_pattern);
2840 free(store->parsed);
2841 free(store->seen);
2842 memset(store, 0, sizeof(*store));
2845 static int matches(const char *key, const char *value,
2846 const struct config_store_data *store)
2848 if (strcmp(key, store->key))
2849 return 0; /* not ours */
2850 if (store->fixed_value)
2851 return !strcmp(store->fixed_value, value);
2852 if (!store->value_pattern)
2853 return 1; /* always matches */
2854 if (store->value_pattern == CONFIG_REGEX_NONE)
2855 return 0; /* never matches */
2857 return store->do_not_match ^
2858 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2861 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2862 struct config_source *cs, void *data)
2864 struct config_store_data *store = data;
2866 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2867 store->parsed[store->parsed_nr].begin = begin;
2868 store->parsed[store->parsed_nr].end = end;
2869 store->parsed[store->parsed_nr].type = type;
2871 if (type == CONFIG_EVENT_SECTION) {
2872 int (*cmpfn)(const char *, const char *, size_t);
2874 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2875 return error(_("invalid section name '%s'"), cs->var.buf);
2877 if (cs->subsection_case_sensitive)
2878 cmpfn = strncasecmp;
2879 else
2880 cmpfn = strncmp;
2882 /* Is this the section we were looking for? */
2883 store->is_keys_section =
2884 store->parsed[store->parsed_nr].is_keys_section =
2885 cs->var.len - 1 == store->baselen &&
2886 !cmpfn(cs->var.buf, store->key, store->baselen);
2887 if (store->is_keys_section) {
2888 store->section_seen = 1;
2889 ALLOC_GROW(store->seen, store->seen_nr + 1,
2890 store->seen_alloc);
2891 store->seen[store->seen_nr] = store->parsed_nr;
2895 store->parsed_nr++;
2897 return 0;
2900 static int store_aux(const char *key, const char *value,
2901 const struct config_context *ctx UNUSED, void *cb)
2903 struct config_store_data *store = cb;
2905 if (store->key_seen) {
2906 if (matches(key, value, store)) {
2907 if (store->seen_nr == 1 && store->multi_replace == 0) {
2908 warning(_("%s has multiple values"), key);
2911 ALLOC_GROW(store->seen, store->seen_nr + 1,
2912 store->seen_alloc);
2914 store->seen[store->seen_nr] = store->parsed_nr;
2915 store->seen_nr++;
2917 } else if (store->is_keys_section) {
2919 * Do not increment matches yet: this may not be a match, but we
2920 * are in the desired section.
2922 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2923 store->seen[store->seen_nr] = store->parsed_nr;
2924 store->section_seen = 1;
2926 if (matches(key, value, store)) {
2927 store->seen_nr++;
2928 store->key_seen = 1;
2932 return 0;
2935 static int write_error(const char *filename)
2937 error(_("failed to write new configuration file %s"), filename);
2939 /* Same error code as "failed to rename". */
2940 return 4;
2943 static struct strbuf store_create_section(const char *key,
2944 const struct config_store_data *store)
2946 const char *dot;
2947 size_t i;
2948 struct strbuf sb = STRBUF_INIT;
2950 dot = memchr(key, '.', store->baselen);
2951 if (dot) {
2952 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2953 for (i = dot - key + 1; i < store->baselen; i++) {
2954 if (key[i] == '"' || key[i] == '\\')
2955 strbuf_addch(&sb, '\\');
2956 strbuf_addch(&sb, key[i]);
2958 strbuf_addstr(&sb, "\"]\n");
2959 } else {
2960 strbuf_addch(&sb, '[');
2961 strbuf_add(&sb, key, store->baselen);
2962 strbuf_addstr(&sb, "]\n");
2965 return sb;
2968 static ssize_t write_section(int fd, const char *key,
2969 const struct config_store_data *store)
2971 struct strbuf sb = store_create_section(key, store);
2972 ssize_t ret;
2974 ret = write_in_full(fd, sb.buf, sb.len);
2975 strbuf_release(&sb);
2977 return ret;
2980 static ssize_t write_pair(int fd, const char *key, const char *value,
2981 const struct config_store_data *store)
2983 int i;
2984 ssize_t ret;
2985 const char *quote = "";
2986 struct strbuf sb = STRBUF_INIT;
2989 * Check to see if the value needs to be surrounded with a dq pair.
2990 * Note that problematic characters are always backslash-quoted; this
2991 * check is about not losing leading or trailing SP and strings that
2992 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2993 * configuration parser.
2995 if (value[0] == ' ')
2996 quote = "\"";
2997 for (i = 0; value[i]; i++)
2998 if (value[i] == ';' || value[i] == '#')
2999 quote = "\"";
3000 if (i && value[i - 1] == ' ')
3001 quote = "\"";
3003 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3005 for (i = 0; value[i]; i++)
3006 switch (value[i]) {
3007 case '\n':
3008 strbuf_addstr(&sb, "\\n");
3009 break;
3010 case '\t':
3011 strbuf_addstr(&sb, "\\t");
3012 break;
3013 case '"':
3014 case '\\':
3015 strbuf_addch(&sb, '\\');
3016 /* fallthrough */
3017 default:
3018 strbuf_addch(&sb, value[i]);
3019 break;
3021 strbuf_addf(&sb, "%s\n", quote);
3023 ret = write_in_full(fd, sb.buf, sb.len);
3024 strbuf_release(&sb);
3026 return ret;
3030 * If we are about to unset the last key(s) in a section, and if there are
3031 * no comments surrounding (or included in) the section, we will want to
3032 * extend begin/end to remove the entire section.
3034 * Note: the parameter `seen_ptr` points to the index into the store.seen
3035 * array. * This index may be incremented if a section has more than one
3036 * entry (which all are to be removed).
3038 static void maybe_remove_section(struct config_store_data *store,
3039 size_t *begin_offset, size_t *end_offset,
3040 int *seen_ptr)
3042 size_t begin;
3043 int i, seen, section_seen = 0;
3046 * First, ensure that this is the first key, and that there are no
3047 * comments before the entry nor before the section header.
3049 seen = *seen_ptr;
3050 for (i = store->seen[seen]; i > 0; i--) {
3051 enum config_event_t type = store->parsed[i - 1].type;
3053 if (type == CONFIG_EVENT_COMMENT)
3054 /* There is a comment before this entry or section */
3055 return;
3056 if (type == CONFIG_EVENT_ENTRY) {
3057 if (!section_seen)
3058 /* This is not the section's first entry. */
3059 return;
3060 /* We encountered no comment before the section. */
3061 break;
3063 if (type == CONFIG_EVENT_SECTION) {
3064 if (!store->parsed[i - 1].is_keys_section)
3065 break;
3066 section_seen = 1;
3069 begin = store->parsed[i].begin;
3072 * Next, make sure that we are removing the last key(s) in the section,
3073 * and that there are no comments that are possibly about the current
3074 * section.
3076 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3077 enum config_event_t type = store->parsed[i].type;
3079 if (type == CONFIG_EVENT_COMMENT)
3080 return;
3081 if (type == CONFIG_EVENT_SECTION) {
3082 if (store->parsed[i].is_keys_section)
3083 continue;
3084 break;
3086 if (type == CONFIG_EVENT_ENTRY) {
3087 if (++seen < store->seen_nr &&
3088 i == store->seen[seen])
3089 /* We want to remove this entry, too */
3090 continue;
3091 /* There is another entry in this section. */
3092 return;
3097 * We are really removing the last entry/entries from this section, and
3098 * there are no enclosed or surrounding comments. Remove the entire,
3099 * now-empty section.
3101 *seen_ptr = seen;
3102 *begin_offset = begin;
3103 if (i < store->parsed_nr)
3104 *end_offset = store->parsed[i].begin;
3105 else
3106 *end_offset = store->parsed[store->parsed_nr - 1].end;
3109 int git_config_set_in_file_gently(const char *config_filename,
3110 const char *key, const char *value)
3112 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3115 void git_config_set_in_file(const char *config_filename,
3116 const char *key, const char *value)
3118 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3121 int git_config_set_gently(const char *key, const char *value)
3123 return git_config_set_multivar_gently(key, value, NULL, 0);
3126 int repo_config_set_worktree_gently(struct repository *r,
3127 const char *key, const char *value)
3129 /* Only use worktree-specific config if it is already enabled. */
3130 if (r->repository_format_worktree_config) {
3131 char *file = repo_git_path(r, "config.worktree");
3132 int ret = git_config_set_multivar_in_file_gently(
3133 file, key, value, NULL, 0);
3134 free(file);
3135 return ret;
3137 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3140 void git_config_set(const char *key, const char *value)
3142 git_config_set_multivar(key, value, NULL, 0);
3144 trace2_cmd_set_config(key, value);
3148 * If value==NULL, unset in (remove from) config,
3149 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3150 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3151 * (only add a new one)
3152 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3153 * key/values are removed before a single new pair is written. If the
3154 * flag is not present, then replace only the first match.
3156 * Returns 0 on success.
3158 * This function does this:
3160 * - it locks the config file by creating ".git/config.lock"
3162 * - it then parses the config using store_aux() as validator to find
3163 * the position on the key/value pair to replace. If it is to be unset,
3164 * it must be found exactly once.
3166 * - the config file is mmap()ed and the part before the match (if any) is
3167 * written to the lock file, then the changed part and the rest.
3169 * - the config file is removed and the lock file rename()d to it.
3172 int git_config_set_multivar_in_file_gently(const char *config_filename,
3173 const char *key, const char *value,
3174 const char *value_pattern,
3175 unsigned flags)
3177 int fd = -1, in_fd = -1;
3178 int ret;
3179 struct lock_file lock = LOCK_INIT;
3180 char *filename_buf = NULL;
3181 char *contents = NULL;
3182 size_t contents_sz;
3183 struct config_store_data store = CONFIG_STORE_INIT;
3185 /* parse-key returns negative; flip the sign to feed exit(3) */
3186 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3187 if (ret)
3188 goto out_free;
3190 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3192 if (!config_filename)
3193 config_filename = filename_buf = git_pathdup("config");
3196 * The lock serves a purpose in addition to locking: the new
3197 * contents of .git/config will be written into it.
3199 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3200 if (fd < 0) {
3201 error_errno(_("could not lock config file %s"), config_filename);
3202 ret = CONFIG_NO_LOCK;
3203 goto out_free;
3207 * If .git/config does not exist yet, write a minimal version.
3209 in_fd = open(config_filename, O_RDONLY);
3210 if ( in_fd < 0 ) {
3211 if ( ENOENT != errno ) {
3212 error_errno(_("opening %s"), config_filename);
3213 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3214 goto out_free;
3216 /* if nothing to unset, error out */
3217 if (!value) {
3218 ret = CONFIG_NOTHING_SET;
3219 goto out_free;
3222 free(store.key);
3223 store.key = xstrdup(key);
3224 if (write_section(fd, key, &store) < 0 ||
3225 write_pair(fd, key, value, &store) < 0)
3226 goto write_err_out;
3227 } else {
3228 struct stat st;
3229 size_t copy_begin, copy_end;
3230 int i, new_line = 0;
3231 struct config_options opts;
3233 if (!value_pattern)
3234 store.value_pattern = NULL;
3235 else if (value_pattern == CONFIG_REGEX_NONE)
3236 store.value_pattern = CONFIG_REGEX_NONE;
3237 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3238 store.fixed_value = value_pattern;
3239 else {
3240 if (value_pattern[0] == '!') {
3241 store.do_not_match = 1;
3242 value_pattern++;
3243 } else
3244 store.do_not_match = 0;
3246 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3247 if (regcomp(store.value_pattern, value_pattern,
3248 REG_EXTENDED)) {
3249 error(_("invalid pattern: %s"), value_pattern);
3250 FREE_AND_NULL(store.value_pattern);
3251 ret = CONFIG_INVALID_PATTERN;
3252 goto out_free;
3256 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3257 store.parsed[0].end = 0;
3259 memset(&opts, 0, sizeof(opts));
3260 opts.event_fn = store_aux_event;
3261 opts.event_fn_data = &store;
3264 * After this, store.parsed will contain offsets of all the
3265 * parsed elements, and store.seen will contain a list of
3266 * matches, as indices into store.parsed.
3268 * As a side effect, we make sure to transform only a valid
3269 * existing config file.
3271 if (git_config_from_file_with_options(store_aux,
3272 config_filename,
3273 &store, CONFIG_SCOPE_UNKNOWN,
3274 &opts)) {
3275 error(_("invalid config file %s"), config_filename);
3276 ret = CONFIG_INVALID_FILE;
3277 goto out_free;
3280 /* if nothing to unset, or too many matches, error out */
3281 if ((store.seen_nr == 0 && value == NULL) ||
3282 (store.seen_nr > 1 && !store.multi_replace)) {
3283 ret = CONFIG_NOTHING_SET;
3284 goto out_free;
3287 if (fstat(in_fd, &st) == -1) {
3288 error_errno(_("fstat on %s failed"), config_filename);
3289 ret = CONFIG_INVALID_FILE;
3290 goto out_free;
3293 contents_sz = xsize_t(st.st_size);
3294 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3295 MAP_PRIVATE, in_fd, 0);
3296 if (contents == MAP_FAILED) {
3297 if (errno == ENODEV && S_ISDIR(st.st_mode))
3298 errno = EISDIR;
3299 error_errno(_("unable to mmap '%s'%s"),
3300 config_filename, mmap_os_err());
3301 ret = CONFIG_INVALID_FILE;
3302 contents = NULL;
3303 goto out_free;
3305 close(in_fd);
3306 in_fd = -1;
3308 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3309 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3310 ret = CONFIG_NO_WRITE;
3311 goto out_free;
3314 if (store.seen_nr == 0) {
3315 if (!store.seen_alloc) {
3316 /* Did not see key nor section */
3317 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3318 store.seen[0] = store.parsed_nr
3319 - !!store.parsed_nr;
3321 store.seen_nr = 1;
3324 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3325 size_t replace_end;
3326 int j = store.seen[i];
3328 new_line = 0;
3329 if (!store.key_seen) {
3330 copy_end = store.parsed[j].end;
3331 /* include '\n' when copying section header */
3332 if (copy_end > 0 && copy_end < contents_sz &&
3333 contents[copy_end - 1] != '\n' &&
3334 contents[copy_end] == '\n')
3335 copy_end++;
3336 replace_end = copy_end;
3337 } else {
3338 replace_end = store.parsed[j].end;
3339 copy_end = store.parsed[j].begin;
3340 if (!value)
3341 maybe_remove_section(&store,
3342 &copy_end,
3343 &replace_end, &i);
3345 * Swallow preceding white-space on the same
3346 * line.
3348 while (copy_end > 0 ) {
3349 char c = contents[copy_end - 1];
3351 if (isspace(c) && c != '\n')
3352 copy_end--;
3353 else
3354 break;
3358 if (copy_end > 0 && contents[copy_end-1] != '\n')
3359 new_line = 1;
3361 /* write the first part of the config */
3362 if (copy_end > copy_begin) {
3363 if (write_in_full(fd, contents + copy_begin,
3364 copy_end - copy_begin) < 0)
3365 goto write_err_out;
3366 if (new_line &&
3367 write_str_in_full(fd, "\n") < 0)
3368 goto write_err_out;
3370 copy_begin = replace_end;
3373 /* write the pair (value == NULL means unset) */
3374 if (value) {
3375 if (!store.section_seen) {
3376 if (write_section(fd, key, &store) < 0)
3377 goto write_err_out;
3379 if (write_pair(fd, key, value, &store) < 0)
3380 goto write_err_out;
3383 /* write the rest of the config */
3384 if (copy_begin < contents_sz)
3385 if (write_in_full(fd, contents + copy_begin,
3386 contents_sz - copy_begin) < 0)
3387 goto write_err_out;
3389 munmap(contents, contents_sz);
3390 contents = NULL;
3393 if (commit_lock_file(&lock) < 0) {
3394 error_errno(_("could not write config file %s"), config_filename);
3395 ret = CONFIG_NO_WRITE;
3396 goto out_free;
3399 ret = 0;
3401 /* Invalidate the config cache */
3402 git_config_clear();
3404 out_free:
3405 rollback_lock_file(&lock);
3406 free(filename_buf);
3407 if (contents)
3408 munmap(contents, contents_sz);
3409 if (in_fd >= 0)
3410 close(in_fd);
3411 config_store_data_clear(&store);
3412 return ret;
3414 write_err_out:
3415 ret = write_error(get_lock_file_path(&lock));
3416 goto out_free;
3420 void git_config_set_multivar_in_file(const char *config_filename,
3421 const char *key, const char *value,
3422 const char *value_pattern, unsigned flags)
3424 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3425 value_pattern, flags))
3426 return;
3427 if (value)
3428 die(_("could not set '%s' to '%s'"), key, value);
3429 else
3430 die(_("could not unset '%s'"), key);
3433 int git_config_set_multivar_gently(const char *key, const char *value,
3434 const char *value_pattern, unsigned flags)
3436 return repo_config_set_multivar_gently(the_repository, key, value,
3437 value_pattern, flags);
3440 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3441 const char *value,
3442 const char *value_pattern, unsigned flags)
3444 char *file = repo_git_path(r, "config");
3445 int res = git_config_set_multivar_in_file_gently(file,
3446 key, value,
3447 value_pattern,
3448 flags);
3449 free(file);
3450 return res;
3453 void git_config_set_multivar(const char *key, const char *value,
3454 const char *value_pattern, unsigned flags)
3456 git_config_set_multivar_in_file(git_path("config"),
3457 key, value, value_pattern,
3458 flags);
3461 static size_t section_name_match (const char *buf, const char *name)
3463 size_t i = 0, j = 0;
3464 int dot = 0;
3465 if (buf[i] != '[')
3466 return 0;
3467 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3468 if (!dot && isspace(buf[i])) {
3469 dot = 1;
3470 if (name[j++] != '.')
3471 break;
3472 for (i++; isspace(buf[i]); i++)
3473 ; /* do nothing */
3474 if (buf[i] != '"')
3475 break;
3476 continue;
3478 if (buf[i] == '\\' && dot)
3479 i++;
3480 else if (buf[i] == '"' && dot) {
3481 for (i++; isspace(buf[i]); i++)
3482 ; /* do_nothing */
3483 break;
3485 if (buf[i] != name[j++])
3486 break;
3488 if (buf[i] == ']' && name[j] == 0) {
3490 * We match, now just find the right length offset by
3491 * gobbling up any whitespace after it, as well
3493 i++;
3494 for (; buf[i] && isspace(buf[i]); i++)
3495 ; /* do nothing */
3496 return i;
3498 return 0;
3501 static int section_name_is_ok(const char *name)
3503 /* Empty section names are bogus. */
3504 if (!*name)
3505 return 0;
3508 * Before a dot, we must be alphanumeric or dash. After the first dot,
3509 * anything goes, so we can stop checking.
3511 for (; *name && *name != '.'; name++)
3512 if (*name != '-' && !isalnum(*name))
3513 return 0;
3514 return 1;
3517 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3519 /* if new_name == NULL, the section is removed instead */
3520 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3521 const char *old_name,
3522 const char *new_name, int copy)
3524 int ret = 0, remove = 0;
3525 char *filename_buf = NULL;
3526 struct lock_file lock = LOCK_INIT;
3527 int out_fd;
3528 struct strbuf buf = STRBUF_INIT;
3529 FILE *config_file = NULL;
3530 struct stat st;
3531 struct strbuf copystr = STRBUF_INIT;
3532 struct config_store_data store;
3533 uint32_t line_nr = 0;
3535 memset(&store, 0, sizeof(store));
3537 if (new_name && !section_name_is_ok(new_name)) {
3538 ret = error(_("invalid section name: %s"), new_name);
3539 goto out_no_rollback;
3542 if (!config_filename)
3543 config_filename = filename_buf = git_pathdup("config");
3545 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3546 if (out_fd < 0) {
3547 ret = error(_("could not lock config file %s"), config_filename);
3548 goto out;
3551 if (!(config_file = fopen(config_filename, "rb"))) {
3552 ret = warn_on_fopen_errors(config_filename);
3553 if (ret)
3554 goto out;
3555 /* no config file means nothing to rename, no error */
3556 goto commit_and_out;
3559 if (fstat(fileno(config_file), &st) == -1) {
3560 ret = error_errno(_("fstat on %s failed"), config_filename);
3561 goto out;
3564 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3565 ret = error_errno(_("chmod on %s failed"),
3566 get_lock_file_path(&lock));
3567 goto out;
3570 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3571 size_t i, length;
3572 int is_section = 0;
3573 char *output = buf.buf;
3575 line_nr++;
3577 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3578 ret = error(_("refusing to work with overly long line "
3579 "in '%s' on line %"PRIuMAX),
3580 config_filename, (uintmax_t)line_nr);
3581 goto out;
3584 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3585 ; /* do nothing */
3586 if (buf.buf[i] == '[') {
3587 /* it's a section */
3588 size_t offset;
3589 is_section = 1;
3592 * When encountering a new section under -c we
3593 * need to flush out any section we're already
3594 * coping and begin anew. There might be
3595 * multiple [branch "$name"] sections.
3597 if (copystr.len > 0) {
3598 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3599 ret = write_error(get_lock_file_path(&lock));
3600 goto out;
3602 strbuf_reset(&copystr);
3605 offset = section_name_match(&buf.buf[i], old_name);
3606 if (offset > 0) {
3607 ret++;
3608 if (!new_name) {
3609 remove = 1;
3610 continue;
3612 store.baselen = strlen(new_name);
3613 if (!copy) {
3614 if (write_section(out_fd, new_name, &store) < 0) {
3615 ret = write_error(get_lock_file_path(&lock));
3616 goto out;
3619 * We wrote out the new section, with
3620 * a newline, now skip the old
3621 * section's length
3623 output += offset + i;
3624 if (strlen(output) > 0) {
3626 * More content means there's
3627 * a declaration to put on the
3628 * next line; indent with a
3629 * tab
3631 output -= 1;
3632 output[0] = '\t';
3634 } else {
3635 strbuf_release(&copystr);
3636 copystr = store_create_section(new_name, &store);
3639 remove = 0;
3641 if (remove)
3642 continue;
3643 length = strlen(output);
3645 if (!is_section && copystr.len > 0) {
3646 strbuf_add(&copystr, output, length);
3649 if (write_in_full(out_fd, output, length) < 0) {
3650 ret = write_error(get_lock_file_path(&lock));
3651 goto out;
3656 * Copy a trailing section at the end of the config, won't be
3657 * flushed by the usual "flush because we have a new section
3658 * logic in the loop above.
3660 if (copystr.len > 0) {
3661 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3662 ret = write_error(get_lock_file_path(&lock));
3663 goto out;
3665 strbuf_reset(&copystr);
3668 fclose(config_file);
3669 config_file = NULL;
3670 commit_and_out:
3671 if (commit_lock_file(&lock) < 0)
3672 ret = error_errno(_("could not write config file %s"),
3673 config_filename);
3674 out:
3675 if (config_file)
3676 fclose(config_file);
3677 rollback_lock_file(&lock);
3678 out_no_rollback:
3679 free(filename_buf);
3680 config_store_data_clear(&store);
3681 strbuf_release(&buf);
3682 strbuf_release(&copystr);
3683 return ret;
3686 int git_config_rename_section_in_file(const char *config_filename,
3687 const char *old_name, const char *new_name)
3689 return git_config_copy_or_rename_section_in_file(config_filename,
3690 old_name, new_name, 0);
3693 int git_config_rename_section(const char *old_name, const char *new_name)
3695 return git_config_rename_section_in_file(NULL, old_name, new_name);
3698 int git_config_copy_section_in_file(const char *config_filename,
3699 const char *old_name, const char *new_name)
3701 return git_config_copy_or_rename_section_in_file(config_filename,
3702 old_name, new_name, 1);
3705 int git_config_copy_section(const char *old_name, const char *new_name)
3707 return git_config_copy_section_in_file(NULL, old_name, new_name);
3711 * Call this to report error for your variable that should not
3712 * get a boolean value (i.e. "[my] var" means "true").
3714 #undef config_error_nonbool
3715 int config_error_nonbool(const char *var)
3717 return error(_("missing value for '%s'"), var);
3720 int parse_config_key(const char *var,
3721 const char *section,
3722 const char **subsection, size_t *subsection_len,
3723 const char **key)
3725 const char *dot;
3727 /* Does it start with "section." ? */
3728 if (!skip_prefix(var, section, &var) || *var != '.')
3729 return -1;
3732 * Find the key; we don't know yet if we have a subsection, but we must
3733 * parse backwards from the end, since the subsection may have dots in
3734 * it, too.
3736 dot = strrchr(var, '.');
3737 *key = dot + 1;
3739 /* Did we have a subsection at all? */
3740 if (dot == var) {
3741 if (subsection) {
3742 *subsection = NULL;
3743 *subsection_len = 0;
3746 else {
3747 if (!subsection)
3748 return -1;
3749 *subsection = var + 1;
3750 *subsection_len = dot - *subsection;
3753 return 0;
3756 const char *config_origin_type_name(enum config_origin_type type)
3758 switch (type) {
3759 case CONFIG_ORIGIN_BLOB:
3760 return "blob";
3761 case CONFIG_ORIGIN_FILE:
3762 return "file";
3763 case CONFIG_ORIGIN_STDIN:
3764 return "standard input";
3765 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3766 return "submodule-blob";
3767 case CONFIG_ORIGIN_CMDLINE:
3768 return "command line";
3769 default:
3770 BUG("unknown config origin type");
3774 const char *config_scope_name(enum config_scope scope)
3776 switch (scope) {
3777 case CONFIG_SCOPE_SYSTEM:
3778 return "system";
3779 case CONFIG_SCOPE_GLOBAL:
3780 return "global";
3781 case CONFIG_SCOPE_LOCAL:
3782 return "local";
3783 case CONFIG_SCOPE_WORKTREE:
3784 return "worktree";
3785 case CONFIG_SCOPE_COMMAND:
3786 return "command";
3787 case CONFIG_SCOPE_SUBMODULE:
3788 return "submodule";
3789 default:
3790 return "unknown";
3794 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3796 int i;
3798 for (i = 0; i < nr_mapping; i++) {
3799 const char *name = mapping[i];
3801 if (name && !strcasecmp(var, name))
3802 return i;
3804 return -1;