builtin/show-ref: explicitly spell out different modes in synopsis
[alt-git.git] / config.c
blobf9a1cca4e8af6b14e51b6993027f7cae3b8d31bb
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 "exec-cmd.h"
23 #include "strbuf.h"
24 #include "quote.h"
25 #include "hashmap.h"
26 #include "string-list.h"
27 #include "object-name.h"
28 #include "object-store-ll.h"
29 #include "pager.h"
30 #include "path.h"
31 #include "utf8.h"
32 #include "dir.h"
33 #include "color.h"
34 #include "replace-object.h"
35 #include "refs.h"
36 #include "setup.h"
37 #include "strvec.h"
38 #include "trace2.h"
39 #include "wildmatch.h"
40 #include "worktree.h"
41 #include "ws.h"
42 #include "write-or-die.h"
44 struct config_source {
45 struct config_source *prev;
46 union {
47 FILE *file;
48 struct config_buf {
49 const char *buf;
50 size_t len;
51 size_t pos;
52 } buf;
53 } u;
54 enum config_origin_type origin_type;
55 const char *name;
56 const char *path;
57 enum config_error_action default_error_action;
58 int linenr;
59 int eof;
60 size_t total_len;
61 struct strbuf value;
62 struct strbuf var;
63 unsigned subsection_case_sensitive : 1;
65 int (*do_fgetc)(struct config_source *c);
66 int (*do_ungetc)(int c, struct config_source *conf);
67 long (*do_ftell)(struct config_source *c);
69 #define CONFIG_SOURCE_INIT { 0 }
71 static int pack_compression_seen;
72 static int zlib_compression_seen;
75 * Config that comes from trusted scopes, namely:
76 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
77 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
78 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
80 * This is declared here for code cleanliness, but unlike the other
81 * static variables, this does not hold config parser state.
83 static struct config_set protected_config;
85 static int config_file_fgetc(struct config_source *conf)
87 return getc_unlocked(conf->u.file);
90 static int config_file_ungetc(int c, struct config_source *conf)
92 return ungetc(c, conf->u.file);
95 static long config_file_ftell(struct config_source *conf)
97 return ftell(conf->u.file);
101 static int config_buf_fgetc(struct config_source *conf)
103 if (conf->u.buf.pos < conf->u.buf.len)
104 return conf->u.buf.buf[conf->u.buf.pos++];
106 return EOF;
109 static int config_buf_ungetc(int c, struct config_source *conf)
111 if (conf->u.buf.pos > 0) {
112 conf->u.buf.pos--;
113 if (conf->u.buf.buf[conf->u.buf.pos] != c)
114 BUG("config_buf can only ungetc the same character");
115 return c;
118 return EOF;
121 static long config_buf_ftell(struct config_source *conf)
123 return conf->u.buf.pos;
126 struct config_include_data {
127 int depth;
128 config_fn_t fn;
129 void *data;
130 const struct config_options *opts;
131 struct git_config_source *config_source;
132 struct repository *repo;
135 * All remote URLs discovered when reading all config files.
137 struct string_list *remote_urls;
139 #define CONFIG_INCLUDE_INIT { 0 }
141 static int git_config_include(const char *var, const char *value,
142 const struct config_context *ctx, void *data);
144 #define MAX_INCLUDE_DEPTH 10
145 static const char include_depth_advice[] = N_(
146 "exceeded maximum include depth (%d) while including\n"
147 " %s\n"
148 "from\n"
149 " %s\n"
150 "This might be due to circular includes.");
151 static int handle_path_include(const struct key_value_info *kvi,
152 const char *path,
153 struct config_include_data *inc)
155 int ret = 0;
156 struct strbuf buf = STRBUF_INIT;
157 char *expanded;
159 if (!path)
160 return config_error_nonbool("include.path");
162 expanded = interpolate_path(path, 0);
163 if (!expanded)
164 return error(_("could not expand include path '%s'"), path);
165 path = expanded;
168 * Use an absolute path as-is, but interpret relative paths
169 * based on the including config file.
171 if (!is_absolute_path(path)) {
172 char *slash;
174 if (!kvi || !kvi->path) {
175 ret = error(_("relative config includes must come from files"));
176 goto cleanup;
179 slash = find_last_dir_sep(kvi->path);
180 if (slash)
181 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
182 strbuf_addstr(&buf, path);
183 path = buf.buf;
186 if (!access_or_die(path, R_OK, 0)) {
187 if (++inc->depth > MAX_INCLUDE_DEPTH)
188 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
189 !kvi ? "<unknown>" :
190 kvi->filename ? kvi->filename :
191 "the command line");
192 ret = git_config_from_file_with_options(git_config_include, path, inc,
193 kvi->scope, NULL);
194 inc->depth--;
196 cleanup:
197 strbuf_release(&buf);
198 free(expanded);
199 return ret;
202 static void add_trailing_starstar_for_dir(struct strbuf *pat)
204 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
205 strbuf_addstr(pat, "**");
208 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
209 struct strbuf *pat)
211 struct strbuf path = STRBUF_INIT;
212 char *expanded;
213 int prefix = 0;
215 expanded = interpolate_path(pat->buf, 1);
216 if (expanded) {
217 strbuf_reset(pat);
218 strbuf_addstr(pat, expanded);
219 free(expanded);
222 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
223 const char *slash;
225 if (!kvi || !kvi->path)
226 return error(_("relative config include "
227 "conditionals must come from files"));
229 strbuf_realpath(&path, kvi->path, 1);
230 slash = find_last_dir_sep(path.buf);
231 if (!slash)
232 BUG("how is this possible?");
233 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
234 prefix = slash - path.buf + 1 /* slash */;
235 } else if (!is_absolute_path(pat->buf))
236 strbuf_insertstr(pat, 0, "**/");
238 add_trailing_starstar_for_dir(pat);
240 strbuf_release(&path);
241 return prefix;
244 static int include_by_gitdir(const struct key_value_info *kvi,
245 const struct config_options *opts,
246 const char *cond, size_t cond_len, int icase)
248 struct strbuf text = STRBUF_INIT;
249 struct strbuf pattern = STRBUF_INIT;
250 int ret = 0, prefix;
251 const char *git_dir;
252 int already_tried_absolute = 0;
254 if (opts->git_dir)
255 git_dir = opts->git_dir;
256 else
257 goto done;
259 strbuf_realpath(&text, git_dir, 1);
260 strbuf_add(&pattern, cond, cond_len);
261 prefix = prepare_include_condition_pattern(kvi, &pattern);
263 again:
264 if (prefix < 0)
265 goto done;
267 if (prefix > 0) {
269 * perform literal matching on the prefix part so that
270 * any wildcard character in it can't create side effects.
272 if (text.len < prefix)
273 goto done;
274 if (!icase && strncmp(pattern.buf, text.buf, prefix))
275 goto done;
276 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
277 goto done;
280 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
281 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
283 if (!ret && !already_tried_absolute) {
285 * We've tried e.g. matching gitdir:~/work, but if
286 * ~/work is a symlink to /mnt/storage/work
287 * strbuf_realpath() will expand it, so the rule won't
288 * match. Let's match against a
289 * strbuf_add_absolute_path() version of the path,
290 * which'll do the right thing
292 strbuf_reset(&text);
293 strbuf_add_absolute_path(&text, git_dir);
294 already_tried_absolute = 1;
295 goto again;
297 done:
298 strbuf_release(&pattern);
299 strbuf_release(&text);
300 return ret;
303 static int include_by_branch(const char *cond, size_t cond_len)
305 int flags;
306 int ret;
307 struct strbuf pattern = STRBUF_INIT;
308 const char *refname = !the_repository->gitdir ?
309 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
310 const char *shortname;
312 if (!refname || !(flags & REF_ISSYMREF) ||
313 !skip_prefix(refname, "refs/heads/", &shortname))
314 return 0;
316 strbuf_add(&pattern, cond, cond_len);
317 add_trailing_starstar_for_dir(&pattern);
318 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
319 strbuf_release(&pattern);
320 return ret;
323 static int add_remote_url(const char *var, const char *value,
324 const struct config_context *ctx UNUSED, void *data)
326 struct string_list *remote_urls = data;
327 const char *remote_name;
328 size_t remote_name_len;
329 const char *key;
331 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
332 &key) &&
333 remote_name &&
334 !strcmp(key, "url"))
335 string_list_append(remote_urls, value);
336 return 0;
339 static void populate_remote_urls(struct config_include_data *inc)
341 struct config_options opts;
343 opts = *inc->opts;
344 opts.unconditional_remote_url = 1;
346 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
347 string_list_init_dup(inc->remote_urls);
348 config_with_options(add_remote_url, inc->remote_urls,
349 inc->config_source, inc->repo, &opts);
352 static int forbid_remote_url(const char *var, const char *value UNUSED,
353 const struct config_context *ctx UNUSED,
354 void *data UNUSED)
356 const char *remote_name;
357 size_t remote_name_len;
358 const char *key;
360 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
361 &key) &&
362 remote_name &&
363 !strcmp(key, "url"))
364 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
365 return 0;
368 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
369 struct string_list *remote_urls)
371 struct strbuf pattern = STRBUF_INIT;
372 struct string_list_item *url_item;
373 int found = 0;
375 strbuf_add(&pattern, glob, glob_len);
376 for_each_string_list_item(url_item, remote_urls) {
377 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
378 found = 1;
379 break;
382 strbuf_release(&pattern);
383 return found;
386 static int include_by_remote_url(struct config_include_data *inc,
387 const char *cond, size_t cond_len)
389 if (inc->opts->unconditional_remote_url)
390 return 1;
391 if (!inc->remote_urls)
392 populate_remote_urls(inc);
393 return at_least_one_url_matches_glob(cond, cond_len,
394 inc->remote_urls);
397 static int include_condition_is_true(const struct key_value_info *kvi,
398 struct config_include_data *inc,
399 const char *cond, size_t cond_len)
401 const struct config_options *opts = inc->opts;
403 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
404 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
405 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
406 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
407 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
408 return include_by_branch(cond, cond_len);
409 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
410 &cond_len))
411 return include_by_remote_url(inc, cond, cond_len);
413 /* unknown conditionals are always false */
414 return 0;
417 static int git_config_include(const char *var, const char *value,
418 const struct config_context *ctx,
419 void *data)
421 struct config_include_data *inc = data;
422 const char *cond, *key;
423 size_t cond_len;
424 int ret;
427 * Pass along all values, including "include" directives; this makes it
428 * possible to query information on the includes themselves.
430 ret = inc->fn(var, value, ctx, inc->data);
431 if (ret < 0)
432 return ret;
434 if (!strcmp(var, "include.path"))
435 ret = handle_path_include(ctx->kvi, value, inc);
437 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
438 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
439 !strcmp(key, "path")) {
440 config_fn_t old_fn = inc->fn;
442 if (inc->opts->unconditional_remote_url)
443 inc->fn = forbid_remote_url;
444 ret = handle_path_include(ctx->kvi, value, inc);
445 inc->fn = old_fn;
448 return ret;
451 static void git_config_push_split_parameter(const char *key, const char *value)
453 struct strbuf env = STRBUF_INIT;
454 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
455 if (old && *old) {
456 strbuf_addstr(&env, old);
457 strbuf_addch(&env, ' ');
459 sq_quote_buf(&env, key);
460 strbuf_addch(&env, '=');
461 if (value)
462 sq_quote_buf(&env, value);
463 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
464 strbuf_release(&env);
467 void git_config_push_parameter(const char *text)
469 const char *value;
472 * When we see:
474 * section.subsection=with=equals.key=value
476 * we cannot tell if it means:
478 * [section "subsection=with=equals"]
479 * key = value
481 * or:
483 * [section]
484 * subsection = with=equals.key=value
486 * We parse left-to-right for the first "=", meaning we'll prefer to
487 * keep the value intact over the subsection. This is historical, but
488 * also sensible since values are more likely to contain odd or
489 * untrusted input than a section name.
491 * A missing equals is explicitly allowed (as a bool-only entry).
493 value = strchr(text, '=');
494 if (value) {
495 char *key = xmemdupz(text, value - text);
496 git_config_push_split_parameter(key, value + 1);
497 free(key);
498 } else {
499 git_config_push_split_parameter(text, NULL);
503 void git_config_push_env(const char *spec)
505 char *key;
506 const char *env_name;
507 const char *env_value;
509 env_name = strrchr(spec, '=');
510 if (!env_name)
511 die(_("invalid config format: %s"), spec);
512 key = xmemdupz(spec, env_name - spec);
513 env_name++;
514 if (!*env_name)
515 die(_("missing environment variable name for configuration '%.*s'"),
516 (int)(env_name - spec - 1), spec);
518 env_value = getenv(env_name);
519 if (!env_value)
520 die(_("missing environment variable '%s' for configuration '%.*s'"),
521 env_name, (int)(env_name - spec - 1), spec);
523 git_config_push_split_parameter(key, env_value);
524 free(key);
527 static inline int iskeychar(int c)
529 return isalnum(c) || c == '-';
533 * Auxiliary function to sanity-check and split the key into the section
534 * identifier and variable name.
536 * Returns 0 on success, -1 when there is an invalid character in the key and
537 * -2 if there is no section name in the key.
539 * store_key - pointer to char* which will hold a copy of the key with
540 * lowercase section and variable name
541 * baselen - pointer to size_t which will hold the length of the
542 * section + subsection part, can be NULL
544 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
546 size_t i, baselen;
547 int dot;
548 const char *last_dot = strrchr(key, '.');
551 * Since "key" actually contains the section name and the real
552 * key name separated by a dot, we have to know where the dot is.
555 if (last_dot == NULL || last_dot == key) {
556 error(_("key does not contain a section: %s"), key);
557 return -CONFIG_NO_SECTION_OR_NAME;
560 if (!last_dot[1]) {
561 error(_("key does not contain variable name: %s"), key);
562 return -CONFIG_NO_SECTION_OR_NAME;
565 baselen = last_dot - key;
566 if (baselen_)
567 *baselen_ = baselen;
570 * Validate the key and while at it, lower case it for matching.
572 *store_key = xmallocz(strlen(key));
574 dot = 0;
575 for (i = 0; key[i]; i++) {
576 unsigned char c = key[i];
577 if (c == '.')
578 dot = 1;
579 /* Leave the extended basename untouched.. */
580 if (!dot || i > baselen) {
581 if (!iskeychar(c) ||
582 (i == baselen + 1 && !isalpha(c))) {
583 error(_("invalid key: %s"), key);
584 goto out_free_ret_1;
586 c = tolower(c);
587 } else if (c == '\n') {
588 error(_("invalid key (newline): %s"), key);
589 goto out_free_ret_1;
591 (*store_key)[i] = c;
594 return 0;
596 out_free_ret_1:
597 FREE_AND_NULL(*store_key);
598 return -CONFIG_INVALID_KEY;
601 static int config_parse_pair(const char *key, const char *value,
602 struct key_value_info *kvi,
603 config_fn_t fn, void *data)
605 char *canonical_name;
606 int ret;
607 struct config_context ctx = {
608 .kvi = kvi,
611 if (!strlen(key))
612 return error(_("empty config key"));
613 if (git_config_parse_key(key, &canonical_name, NULL))
614 return -1;
616 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
617 free(canonical_name);
618 return ret;
622 /* for values read from `git_config_from_parameters()` */
623 void kvi_from_param(struct key_value_info *out)
625 out->filename = NULL;
626 out->linenr = -1;
627 out->origin_type = CONFIG_ORIGIN_CMDLINE;
628 out->scope = CONFIG_SCOPE_COMMAND;
629 out->path = NULL;
632 int git_config_parse_parameter(const char *text,
633 config_fn_t fn, void *data)
635 const char *value;
636 struct strbuf **pair;
637 int ret;
638 struct key_value_info kvi = KVI_INIT;
640 kvi_from_param(&kvi);
642 pair = strbuf_split_str(text, '=', 2);
643 if (!pair[0])
644 return error(_("bogus config parameter: %s"), text);
646 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
647 strbuf_setlen(pair[0], pair[0]->len - 1);
648 value = pair[1] ? pair[1]->buf : "";
649 } else {
650 value = NULL;
653 strbuf_trim(pair[0]);
654 if (!pair[0]->len) {
655 strbuf_list_free(pair);
656 return error(_("bogus config parameter: %s"), text);
659 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
660 strbuf_list_free(pair);
661 return ret;
664 static int parse_config_env_list(char *env, struct key_value_info *kvi,
665 config_fn_t fn, void *data)
667 char *cur = env;
668 while (cur && *cur) {
669 const char *key = sq_dequote_step(cur, &cur);
670 if (!key)
671 return error(_("bogus format in %s"),
672 CONFIG_DATA_ENVIRONMENT);
674 if (!cur || isspace(*cur)) {
675 /* old-style 'key=value' */
676 if (git_config_parse_parameter(key, fn, data) < 0)
677 return -1;
679 else if (*cur == '=') {
680 /* new-style 'key'='value' */
681 const char *value;
683 cur++;
684 if (*cur == '\'') {
685 /* quoted value */
686 value = sq_dequote_step(cur, &cur);
687 if (!value || (cur && !isspace(*cur))) {
688 return error(_("bogus format in %s"),
689 CONFIG_DATA_ENVIRONMENT);
691 } else if (!*cur || isspace(*cur)) {
692 /* implicit bool: 'key'= */
693 value = NULL;
694 } else {
695 return error(_("bogus format in %s"),
696 CONFIG_DATA_ENVIRONMENT);
699 if (config_parse_pair(key, value, kvi, fn, data) < 0)
700 return -1;
702 else {
703 /* unknown format */
704 return error(_("bogus format in %s"),
705 CONFIG_DATA_ENVIRONMENT);
708 if (cur) {
709 while (isspace(*cur))
710 cur++;
713 return 0;
716 int git_config_from_parameters(config_fn_t fn, void *data)
718 const char *env;
719 struct strbuf envvar = STRBUF_INIT;
720 struct strvec to_free = STRVEC_INIT;
721 int ret = 0;
722 char *envw = NULL;
723 struct key_value_info kvi = KVI_INIT;
725 kvi_from_param(&kvi);
726 env = getenv(CONFIG_COUNT_ENVIRONMENT);
727 if (env) {
728 unsigned long count;
729 char *endp;
730 int i;
732 count = strtoul(env, &endp, 10);
733 if (*endp) {
734 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
735 goto out;
737 if (count > INT_MAX) {
738 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
739 goto out;
742 for (i = 0; i < count; i++) {
743 const char *key, *value;
745 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
746 key = getenv_safe(&to_free, envvar.buf);
747 if (!key) {
748 ret = error(_("missing config key %s"), envvar.buf);
749 goto out;
751 strbuf_reset(&envvar);
753 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
754 value = getenv_safe(&to_free, envvar.buf);
755 if (!value) {
756 ret = error(_("missing config value %s"), envvar.buf);
757 goto out;
759 strbuf_reset(&envvar);
761 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
762 ret = -1;
763 goto out;
768 env = getenv(CONFIG_DATA_ENVIRONMENT);
769 if (env) {
770 /* sq_dequote will write over it */
771 envw = xstrdup(env);
772 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
773 ret = -1;
774 goto out;
778 out:
779 strbuf_release(&envvar);
780 strvec_clear(&to_free);
781 free(envw);
782 return ret;
785 static int get_next_char(struct config_source *cs)
787 int c = cs->do_fgetc(cs);
789 if (c == '\r') {
790 /* DOS like systems */
791 c = cs->do_fgetc(cs);
792 if (c != '\n') {
793 if (c != EOF)
794 cs->do_ungetc(c, cs);
795 c = '\r';
799 if (c != EOF && ++cs->total_len > INT_MAX) {
801 * This is an absurdly long config file; refuse to parse
802 * further in order to protect downstream code from integer
803 * overflows. Note that we can't return an error specifically,
804 * but we can mark EOF and put trash in the return value,
805 * which will trigger a parse error.
807 cs->eof = 1;
808 return 0;
811 if (c == '\n')
812 cs->linenr++;
813 if (c == EOF) {
814 cs->eof = 1;
815 cs->linenr++;
816 c = '\n';
818 return c;
821 static char *parse_value(struct config_source *cs)
823 int quote = 0, comment = 0, space = 0;
825 strbuf_reset(&cs->value);
826 for (;;) {
827 int c = get_next_char(cs);
828 if (c == '\n') {
829 if (quote) {
830 cs->linenr--;
831 return NULL;
833 return cs->value.buf;
835 if (comment)
836 continue;
837 if (isspace(c) && !quote) {
838 if (cs->value.len)
839 space++;
840 continue;
842 if (!quote) {
843 if (c == ';' || c == '#') {
844 comment = 1;
845 continue;
848 for (; space; space--)
849 strbuf_addch(&cs->value, ' ');
850 if (c == '\\') {
851 c = get_next_char(cs);
852 switch (c) {
853 case '\n':
854 continue;
855 case 't':
856 c = '\t';
857 break;
858 case 'b':
859 c = '\b';
860 break;
861 case 'n':
862 c = '\n';
863 break;
864 /* Some characters escape as themselves */
865 case '\\': case '"':
866 break;
867 /* Reject unknown escape sequences */
868 default:
869 return NULL;
871 strbuf_addch(&cs->value, c);
872 continue;
874 if (c == '"') {
875 quote = 1-quote;
876 continue;
878 strbuf_addch(&cs->value, c);
882 static int get_value(struct config_source *cs, struct key_value_info *kvi,
883 config_fn_t fn, void *data, struct strbuf *name)
885 int c;
886 char *value;
887 int ret;
888 struct config_context ctx = {
889 .kvi = kvi,
892 /* Get the full name */
893 for (;;) {
894 c = get_next_char(cs);
895 if (cs->eof)
896 break;
897 if (!iskeychar(c))
898 break;
899 strbuf_addch(name, tolower(c));
902 while (c == ' ' || c == '\t')
903 c = get_next_char(cs);
905 value = NULL;
906 if (c != '\n') {
907 if (c != '=')
908 return -1;
909 value = parse_value(cs);
910 if (!value)
911 return -1;
914 * We already consumed the \n, but we need linenr to point to
915 * the line we just parsed during the call to fn to get
916 * accurate line number in error messages.
918 cs->linenr--;
919 kvi->linenr = cs->linenr;
920 ret = fn(name->buf, value, &ctx, data);
921 if (ret >= 0)
922 cs->linenr++;
923 return ret;
926 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
927 int c)
929 cs->subsection_case_sensitive = 0;
930 do {
931 if (c == '\n')
932 goto error_incomplete_line;
933 c = get_next_char(cs);
934 } while (isspace(c));
936 /* We require the format to be '[base "extension"]' */
937 if (c != '"')
938 return -1;
939 strbuf_addch(name, '.');
941 for (;;) {
942 int c = get_next_char(cs);
943 if (c == '\n')
944 goto error_incomplete_line;
945 if (c == '"')
946 break;
947 if (c == '\\') {
948 c = get_next_char(cs);
949 if (c == '\n')
950 goto error_incomplete_line;
952 strbuf_addch(name, c);
955 /* Final ']' */
956 if (get_next_char(cs) != ']')
957 return -1;
958 return 0;
959 error_incomplete_line:
960 cs->linenr--;
961 return -1;
964 static int get_base_var(struct config_source *cs, struct strbuf *name)
966 cs->subsection_case_sensitive = 1;
967 for (;;) {
968 int c = get_next_char(cs);
969 if (cs->eof)
970 return -1;
971 if (c == ']')
972 return 0;
973 if (isspace(c))
974 return get_extended_base_var(cs, name, c);
975 if (!iskeychar(c) && c != '.')
976 return -1;
977 strbuf_addch(name, tolower(c));
981 struct parse_event_data {
982 enum config_event_t previous_type;
983 size_t previous_offset;
984 const struct config_options *opts;
987 static int do_event(struct config_source *cs, enum config_event_t type,
988 struct parse_event_data *data)
990 size_t offset;
992 if (!data->opts || !data->opts->event_fn)
993 return 0;
995 if (type == CONFIG_EVENT_WHITESPACE &&
996 data->previous_type == type)
997 return 0;
999 offset = cs->do_ftell(cs);
1001 * At EOF, the parser always "inserts" an extra '\n', therefore
1002 * the end offset of the event is the current file position, otherwise
1003 * we will already have advanced to the next event.
1005 if (type != CONFIG_EVENT_EOF)
1006 offset--;
1008 if (data->previous_type != CONFIG_EVENT_EOF &&
1009 data->opts->event_fn(data->previous_type, data->previous_offset,
1010 offset, cs, data->opts->event_fn_data) < 0)
1011 return -1;
1013 data->previous_type = type;
1014 data->previous_offset = offset;
1016 return 0;
1019 static void kvi_from_source(struct config_source *cs,
1020 enum config_scope scope,
1021 struct key_value_info *out)
1023 out->filename = strintern(cs->name);
1024 out->origin_type = cs->origin_type;
1025 out->linenr = cs->linenr;
1026 out->scope = scope;
1027 out->path = cs->path;
1030 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1031 struct key_value_info *kvi, void *data,
1032 const struct config_options *opts)
1034 int comment = 0;
1035 size_t baselen = 0;
1036 struct strbuf *var = &cs->var;
1037 int error_return = 0;
1038 char *error_msg = NULL;
1040 /* U+FEFF Byte Order Mark in UTF8 */
1041 const char *bomptr = utf8_bom;
1043 /* For the parser event callback */
1044 struct parse_event_data event_data = {
1045 CONFIG_EVENT_EOF, 0, opts
1048 for (;;) {
1049 int c;
1051 c = get_next_char(cs);
1052 if (bomptr && *bomptr) {
1053 /* We are at the file beginning; skip UTF8-encoded BOM
1054 * if present. Sane editors won't put this in on their
1055 * own, but e.g. Windows Notepad will do it happily. */
1056 if (c == (*bomptr & 0377)) {
1057 bomptr++;
1058 continue;
1059 } else {
1060 /* Do not tolerate partial BOM. */
1061 if (bomptr != utf8_bom)
1062 break;
1063 /* No BOM at file beginning. Cool. */
1064 bomptr = NULL;
1067 if (c == '\n') {
1068 if (cs->eof) {
1069 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1070 return -1;
1071 return 0;
1073 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1074 return -1;
1075 comment = 0;
1076 continue;
1078 if (comment)
1079 continue;
1080 if (isspace(c)) {
1081 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1082 return -1;
1083 continue;
1085 if (c == '#' || c == ';') {
1086 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1087 return -1;
1088 comment = 1;
1089 continue;
1091 if (c == '[') {
1092 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1093 return -1;
1095 /* Reset prior to determining a new stem */
1096 strbuf_reset(var);
1097 if (get_base_var(cs, var) < 0 || var->len < 1)
1098 break;
1099 strbuf_addch(var, '.');
1100 baselen = var->len;
1101 continue;
1103 if (!isalpha(c))
1104 break;
1106 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1107 return -1;
1110 * Truncate the var name back to the section header
1111 * stem prior to grabbing the suffix part of the name
1112 * and the value.
1114 strbuf_setlen(var, baselen);
1115 strbuf_addch(var, tolower(c));
1116 if (get_value(cs, kvi, fn, data, var) < 0)
1117 break;
1120 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1121 return -1;
1123 switch (cs->origin_type) {
1124 case CONFIG_ORIGIN_BLOB:
1125 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1126 cs->linenr, cs->name);
1127 break;
1128 case CONFIG_ORIGIN_FILE:
1129 error_msg = xstrfmt(_("bad config line %d in file %s"),
1130 cs->linenr, cs->name);
1131 break;
1132 case CONFIG_ORIGIN_STDIN:
1133 error_msg = xstrfmt(_("bad config line %d in standard input"),
1134 cs->linenr);
1135 break;
1136 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1137 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1138 cs->linenr, cs->name);
1139 break;
1140 case CONFIG_ORIGIN_CMDLINE:
1141 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1142 cs->linenr, cs->name);
1143 break;
1144 default:
1145 error_msg = xstrfmt(_("bad config line %d in %s"),
1146 cs->linenr, cs->name);
1149 switch (opts && opts->error_action ?
1150 opts->error_action :
1151 cs->default_error_action) {
1152 case CONFIG_ERROR_DIE:
1153 die("%s", error_msg);
1154 break;
1155 case CONFIG_ERROR_ERROR:
1156 error_return = error("%s", error_msg);
1157 break;
1158 case CONFIG_ERROR_SILENT:
1159 error_return = -1;
1160 break;
1161 case CONFIG_ERROR_UNSET:
1162 BUG("config error action unset");
1165 free(error_msg);
1166 return error_return;
1169 NORETURN
1170 static void die_bad_number(const char *name, const char *value,
1171 const struct key_value_info *kvi)
1173 const char *error_type = (errno == ERANGE) ?
1174 N_("out of range") : N_("invalid unit");
1175 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1177 if (!kvi)
1178 BUG("kvi should not be NULL");
1180 if (!value)
1181 value = "";
1183 if (!kvi->filename)
1184 die(_(bad_numeric), value, name, _(error_type));
1186 switch (kvi->origin_type) {
1187 case CONFIG_ORIGIN_BLOB:
1188 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1189 value, name, kvi->filename, _(error_type));
1190 case CONFIG_ORIGIN_FILE:
1191 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1192 value, name, kvi->filename, _(error_type));
1193 case CONFIG_ORIGIN_STDIN:
1194 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1195 value, name, _(error_type));
1196 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1197 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1198 value, name, kvi->filename, _(error_type));
1199 case CONFIG_ORIGIN_CMDLINE:
1200 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1201 value, name, kvi->filename, _(error_type));
1202 default:
1203 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1204 value, name, kvi->filename, _(error_type));
1208 int git_config_int(const char *name, const char *value,
1209 const struct key_value_info *kvi)
1211 int ret;
1212 if (!git_parse_int(value, &ret))
1213 die_bad_number(name, value, kvi);
1214 return ret;
1217 int64_t git_config_int64(const char *name, const char *value,
1218 const struct key_value_info *kvi)
1220 int64_t ret;
1221 if (!git_parse_int64(value, &ret))
1222 die_bad_number(name, value, kvi);
1223 return ret;
1226 unsigned long git_config_ulong(const char *name, const char *value,
1227 const struct key_value_info *kvi)
1229 unsigned long ret;
1230 if (!git_parse_ulong(value, &ret))
1231 die_bad_number(name, value, kvi);
1232 return ret;
1235 ssize_t git_config_ssize_t(const char *name, const char *value,
1236 const struct key_value_info *kvi)
1238 ssize_t ret;
1239 if (!git_parse_ssize_t(value, &ret))
1240 die_bad_number(name, value, kvi);
1241 return ret;
1244 static const struct fsync_component_name {
1245 const char *name;
1246 enum fsync_component component_bits;
1247 } fsync_component_names[] = {
1248 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1249 { "pack", FSYNC_COMPONENT_PACK },
1250 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1251 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1252 { "index", FSYNC_COMPONENT_INDEX },
1253 { "objects", FSYNC_COMPONENTS_OBJECTS },
1254 { "reference", FSYNC_COMPONENT_REFERENCE },
1255 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1256 { "committed", FSYNC_COMPONENTS_COMMITTED },
1257 { "added", FSYNC_COMPONENTS_ADDED },
1258 { "all", FSYNC_COMPONENTS_ALL },
1261 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1263 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1264 enum fsync_component positive = 0, negative = 0;
1266 while (string) {
1267 int i;
1268 size_t len;
1269 const char *ep;
1270 int negated = 0;
1271 int found = 0;
1273 string = string + strspn(string, ", \t\n\r");
1274 ep = strchrnul(string, ',');
1275 len = ep - string;
1276 if (!strcmp(string, "none")) {
1277 current = FSYNC_COMPONENT_NONE;
1278 goto next_name;
1281 if (*string == '-') {
1282 negated = 1;
1283 string++;
1284 len--;
1285 if (!len)
1286 warning(_("invalid value for variable %s"), var);
1289 if (!len)
1290 break;
1292 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1293 const struct fsync_component_name *n = &fsync_component_names[i];
1295 if (strncmp(n->name, string, len))
1296 continue;
1298 found = 1;
1299 if (negated)
1300 negative |= n->component_bits;
1301 else
1302 positive |= n->component_bits;
1305 if (!found) {
1306 char *component = xstrndup(string, len);
1307 warning(_("ignoring unknown core.fsync component '%s'"), component);
1308 free(component);
1311 next_name:
1312 string = ep;
1315 return (current & ~negative) | positive;
1318 int git_config_bool_or_int(const char *name, const char *value,
1319 const struct key_value_info *kvi, int *is_bool)
1321 int v = git_parse_maybe_bool_text(value);
1322 if (0 <= v) {
1323 *is_bool = 1;
1324 return v;
1326 *is_bool = 0;
1327 return git_config_int(name, value, kvi);
1330 int git_config_bool(const char *name, const char *value)
1332 int v = git_parse_maybe_bool(value);
1333 if (v < 0)
1334 die(_("bad boolean config value '%s' for '%s'"), value, name);
1335 return v;
1338 int git_config_string(const char **dest, const char *var, const char *value)
1340 if (!value)
1341 return config_error_nonbool(var);
1342 *dest = xstrdup(value);
1343 return 0;
1346 int git_config_pathname(const char **dest, const char *var, const char *value)
1348 if (!value)
1349 return config_error_nonbool(var);
1350 *dest = interpolate_path(value, 0);
1351 if (!*dest)
1352 die(_("failed to expand user dir in: '%s'"), value);
1353 return 0;
1356 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1358 if (!value)
1359 return config_error_nonbool(var);
1360 if (parse_expiry_date(value, timestamp))
1361 return error(_("'%s' for '%s' is not a valid timestamp"),
1362 value, var);
1363 return 0;
1366 int git_config_color(char *dest, const char *var, const char *value)
1368 if (!value)
1369 return config_error_nonbool(var);
1370 if (color_parse(value, dest) < 0)
1371 return -1;
1372 return 0;
1375 static int git_default_core_config(const char *var, const char *value,
1376 const struct config_context *ctx, void *cb)
1378 /* This needs a better name */
1379 if (!strcmp(var, "core.filemode")) {
1380 trust_executable_bit = git_config_bool(var, value);
1381 return 0;
1383 if (!strcmp(var, "core.trustctime")) {
1384 trust_ctime = git_config_bool(var, value);
1385 return 0;
1387 if (!strcmp(var, "core.checkstat")) {
1388 if (!strcasecmp(value, "default"))
1389 check_stat = 1;
1390 else if (!strcasecmp(value, "minimal"))
1391 check_stat = 0;
1394 if (!strcmp(var, "core.quotepath")) {
1395 quote_path_fully = git_config_bool(var, value);
1396 return 0;
1399 if (!strcmp(var, "core.symlinks")) {
1400 has_symlinks = git_config_bool(var, value);
1401 return 0;
1404 if (!strcmp(var, "core.ignorecase")) {
1405 ignore_case = git_config_bool(var, value);
1406 return 0;
1409 if (!strcmp(var, "core.attributesfile"))
1410 return git_config_pathname(&git_attributes_file, var, value);
1412 if (!strcmp(var, "core.hookspath"))
1413 return git_config_pathname(&git_hooks_path, var, value);
1415 if (!strcmp(var, "core.bare")) {
1416 is_bare_repository_cfg = git_config_bool(var, value);
1417 return 0;
1420 if (!strcmp(var, "core.ignorestat")) {
1421 assume_unchanged = git_config_bool(var, value);
1422 return 0;
1425 if (!strcmp(var, "core.prefersymlinkrefs")) {
1426 prefer_symlink_refs = git_config_bool(var, value);
1427 return 0;
1430 if (!strcmp(var, "core.logallrefupdates")) {
1431 if (value && !strcasecmp(value, "always"))
1432 log_all_ref_updates = LOG_REFS_ALWAYS;
1433 else if (git_config_bool(var, value))
1434 log_all_ref_updates = LOG_REFS_NORMAL;
1435 else
1436 log_all_ref_updates = LOG_REFS_NONE;
1437 return 0;
1440 if (!strcmp(var, "core.warnambiguousrefs")) {
1441 warn_ambiguous_refs = git_config_bool(var, value);
1442 return 0;
1445 if (!strcmp(var, "core.abbrev")) {
1446 if (!value)
1447 return config_error_nonbool(var);
1448 if (!strcasecmp(value, "auto"))
1449 default_abbrev = -1;
1450 else if (!git_parse_maybe_bool_text(value))
1451 default_abbrev = the_hash_algo->hexsz;
1452 else {
1453 int abbrev = git_config_int(var, value, ctx->kvi);
1454 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1455 return error(_("abbrev length out of range: %d"), abbrev);
1456 default_abbrev = abbrev;
1458 return 0;
1461 if (!strcmp(var, "core.disambiguate"))
1462 return set_disambiguate_hint_config(var, value);
1464 if (!strcmp(var, "core.loosecompression")) {
1465 int level = git_config_int(var, value, ctx->kvi);
1466 if (level == -1)
1467 level = Z_DEFAULT_COMPRESSION;
1468 else if (level < 0 || level > Z_BEST_COMPRESSION)
1469 die(_("bad zlib compression level %d"), level);
1470 zlib_compression_level = level;
1471 zlib_compression_seen = 1;
1472 return 0;
1475 if (!strcmp(var, "core.compression")) {
1476 int level = git_config_int(var, value, ctx->kvi);
1477 if (level == -1)
1478 level = Z_DEFAULT_COMPRESSION;
1479 else if (level < 0 || level > Z_BEST_COMPRESSION)
1480 die(_("bad zlib compression level %d"), level);
1481 if (!zlib_compression_seen)
1482 zlib_compression_level = level;
1483 if (!pack_compression_seen)
1484 pack_compression_level = level;
1485 return 0;
1488 if (!strcmp(var, "core.packedgitwindowsize")) {
1489 int pgsz_x2 = getpagesize() * 2;
1490 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1492 /* This value must be multiple of (pagesize * 2) */
1493 packed_git_window_size /= pgsz_x2;
1494 if (packed_git_window_size < 1)
1495 packed_git_window_size = 1;
1496 packed_git_window_size *= pgsz_x2;
1497 return 0;
1500 if (!strcmp(var, "core.bigfilethreshold")) {
1501 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1502 return 0;
1505 if (!strcmp(var, "core.packedgitlimit")) {
1506 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1507 return 0;
1510 if (!strcmp(var, "core.deltabasecachelimit")) {
1511 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1512 return 0;
1515 if (!strcmp(var, "core.autocrlf")) {
1516 if (value && !strcasecmp(value, "input")) {
1517 auto_crlf = AUTO_CRLF_INPUT;
1518 return 0;
1520 auto_crlf = git_config_bool(var, value);
1521 return 0;
1524 if (!strcmp(var, "core.safecrlf")) {
1525 int eol_rndtrp_die;
1526 if (value && !strcasecmp(value, "warn")) {
1527 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1528 return 0;
1530 eol_rndtrp_die = git_config_bool(var, value);
1531 global_conv_flags_eol = eol_rndtrp_die ?
1532 CONV_EOL_RNDTRP_DIE : 0;
1533 return 0;
1536 if (!strcmp(var, "core.eol")) {
1537 if (value && !strcasecmp(value, "lf"))
1538 core_eol = EOL_LF;
1539 else if (value && !strcasecmp(value, "crlf"))
1540 core_eol = EOL_CRLF;
1541 else if (value && !strcasecmp(value, "native"))
1542 core_eol = EOL_NATIVE;
1543 else
1544 core_eol = EOL_UNSET;
1545 return 0;
1548 if (!strcmp(var, "core.checkroundtripencoding")) {
1549 check_roundtrip_encoding = xstrdup(value);
1550 return 0;
1553 if (!strcmp(var, "core.notesref")) {
1554 notes_ref_name = xstrdup(value);
1555 return 0;
1558 if (!strcmp(var, "core.editor"))
1559 return git_config_string(&editor_program, var, value);
1561 if (!strcmp(var, "core.commentchar")) {
1562 if (!value)
1563 return config_error_nonbool(var);
1564 else if (!strcasecmp(value, "auto"))
1565 auto_comment_line_char = 1;
1566 else if (value[0] && !value[1]) {
1567 comment_line_char = value[0];
1568 auto_comment_line_char = 0;
1569 } else
1570 return error(_("core.commentChar should only be one ASCII character"));
1571 return 0;
1574 if (!strcmp(var, "core.askpass"))
1575 return git_config_string(&askpass_program, var, value);
1577 if (!strcmp(var, "core.excludesfile"))
1578 return git_config_pathname(&excludes_file, var, value);
1580 if (!strcmp(var, "core.whitespace")) {
1581 if (!value)
1582 return config_error_nonbool(var);
1583 whitespace_rule_cfg = parse_whitespace_rule(value);
1584 return 0;
1587 if (!strcmp(var, "core.fsync")) {
1588 if (!value)
1589 return config_error_nonbool(var);
1590 fsync_components = parse_fsync_components(var, value);
1591 return 0;
1594 if (!strcmp(var, "core.fsyncmethod")) {
1595 if (!value)
1596 return config_error_nonbool(var);
1597 if (!strcmp(value, "fsync"))
1598 fsync_method = FSYNC_METHOD_FSYNC;
1599 else if (!strcmp(value, "writeout-only"))
1600 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1601 else if (!strcmp(value, "batch"))
1602 fsync_method = FSYNC_METHOD_BATCH;
1603 else
1604 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1608 if (!strcmp(var, "core.fsyncobjectfiles")) {
1609 if (fsync_object_files < 0)
1610 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1611 fsync_object_files = git_config_bool(var, value);
1612 return 0;
1615 if (!strcmp(var, "core.preloadindex")) {
1616 core_preload_index = git_config_bool(var, value);
1617 return 0;
1620 if (!strcmp(var, "core.createobject")) {
1621 if (!strcmp(value, "rename"))
1622 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1623 else if (!strcmp(value, "link"))
1624 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1625 else
1626 die(_("invalid mode for object creation: %s"), value);
1627 return 0;
1630 if (!strcmp(var, "core.sparsecheckout")) {
1631 core_apply_sparse_checkout = git_config_bool(var, value);
1632 return 0;
1635 if (!strcmp(var, "core.sparsecheckoutcone")) {
1636 core_sparse_checkout_cone = git_config_bool(var, value);
1637 return 0;
1640 if (!strcmp(var, "core.precomposeunicode")) {
1641 precomposed_unicode = git_config_bool(var, value);
1642 return 0;
1645 if (!strcmp(var, "core.protecthfs")) {
1646 protect_hfs = git_config_bool(var, value);
1647 return 0;
1650 if (!strcmp(var, "core.protectntfs")) {
1651 protect_ntfs = git_config_bool(var, value);
1652 return 0;
1655 if (!strcmp(var, "core.maxtreedepth")) {
1656 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1657 return 0;
1660 /* Add other config variables here and to Documentation/config.txt. */
1661 return platform_core_config(var, value, ctx, cb);
1664 static int git_default_sparse_config(const char *var, const char *value)
1666 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1667 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1668 return 0;
1671 /* Add other config variables here and to Documentation/config/sparse.txt. */
1672 return 0;
1675 static int git_default_i18n_config(const char *var, const char *value)
1677 if (!strcmp(var, "i18n.commitencoding"))
1678 return git_config_string(&git_commit_encoding, var, value);
1680 if (!strcmp(var, "i18n.logoutputencoding"))
1681 return git_config_string(&git_log_output_encoding, var, value);
1683 /* Add other config variables here and to Documentation/config.txt. */
1684 return 0;
1687 static int git_default_branch_config(const char *var, const char *value)
1689 if (!strcmp(var, "branch.autosetupmerge")) {
1690 if (value && !strcmp(value, "always")) {
1691 git_branch_track = BRANCH_TRACK_ALWAYS;
1692 return 0;
1693 } else if (value && !strcmp(value, "inherit")) {
1694 git_branch_track = BRANCH_TRACK_INHERIT;
1695 return 0;
1696 } else if (value && !strcmp(value, "simple")) {
1697 git_branch_track = BRANCH_TRACK_SIMPLE;
1698 return 0;
1700 git_branch_track = git_config_bool(var, value);
1701 return 0;
1703 if (!strcmp(var, "branch.autosetuprebase")) {
1704 if (!value)
1705 return config_error_nonbool(var);
1706 else if (!strcmp(value, "never"))
1707 autorebase = AUTOREBASE_NEVER;
1708 else if (!strcmp(value, "local"))
1709 autorebase = AUTOREBASE_LOCAL;
1710 else if (!strcmp(value, "remote"))
1711 autorebase = AUTOREBASE_REMOTE;
1712 else if (!strcmp(value, "always"))
1713 autorebase = AUTOREBASE_ALWAYS;
1714 else
1715 return error(_("malformed value for %s"), var);
1716 return 0;
1719 /* Add other config variables here and to Documentation/config.txt. */
1720 return 0;
1723 static int git_default_push_config(const char *var, const char *value)
1725 if (!strcmp(var, "push.default")) {
1726 if (!value)
1727 return config_error_nonbool(var);
1728 else if (!strcmp(value, "nothing"))
1729 push_default = PUSH_DEFAULT_NOTHING;
1730 else if (!strcmp(value, "matching"))
1731 push_default = PUSH_DEFAULT_MATCHING;
1732 else if (!strcmp(value, "simple"))
1733 push_default = PUSH_DEFAULT_SIMPLE;
1734 else if (!strcmp(value, "upstream"))
1735 push_default = PUSH_DEFAULT_UPSTREAM;
1736 else if (!strcmp(value, "tracking")) /* deprecated */
1737 push_default = PUSH_DEFAULT_UPSTREAM;
1738 else if (!strcmp(value, "current"))
1739 push_default = PUSH_DEFAULT_CURRENT;
1740 else {
1741 error(_("malformed value for %s: %s"), var, value);
1742 return error(_("must be one of nothing, matching, simple, "
1743 "upstream or current"));
1745 return 0;
1748 /* Add other config variables here and to Documentation/config.txt. */
1749 return 0;
1752 static int git_default_mailmap_config(const char *var, const char *value)
1754 if (!strcmp(var, "mailmap.file"))
1755 return git_config_pathname(&git_mailmap_file, var, value);
1756 if (!strcmp(var, "mailmap.blob"))
1757 return git_config_string(&git_mailmap_blob, var, value);
1759 /* Add other config variables here and to Documentation/config.txt. */
1760 return 0;
1763 int git_default_config(const char *var, const char *value,
1764 const struct config_context *ctx, void *cb)
1766 if (starts_with(var, "core."))
1767 return git_default_core_config(var, value, ctx, cb);
1769 if (starts_with(var, "user.") ||
1770 starts_with(var, "author.") ||
1771 starts_with(var, "committer."))
1772 return git_ident_config(var, value, ctx, cb);
1774 if (starts_with(var, "i18n."))
1775 return git_default_i18n_config(var, value);
1777 if (starts_with(var, "branch."))
1778 return git_default_branch_config(var, value);
1780 if (starts_with(var, "push."))
1781 return git_default_push_config(var, value);
1783 if (starts_with(var, "mailmap."))
1784 return git_default_mailmap_config(var, value);
1786 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1787 return git_default_advice_config(var, value);
1789 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1790 pager_use_color = git_config_bool(var,value);
1791 return 0;
1794 if (!strcmp(var, "pack.packsizelimit")) {
1795 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1796 return 0;
1799 if (!strcmp(var, "pack.compression")) {
1800 int level = git_config_int(var, value, ctx->kvi);
1801 if (level == -1)
1802 level = Z_DEFAULT_COMPRESSION;
1803 else if (level < 0 || level > Z_BEST_COMPRESSION)
1804 die(_("bad pack compression level %d"), level);
1805 pack_compression_level = level;
1806 pack_compression_seen = 1;
1807 return 0;
1810 if (starts_with(var, "sparse."))
1811 return git_default_sparse_config(var, value);
1813 /* Add other config variables here and to Documentation/config.txt. */
1814 return 0;
1818 * All source specific fields in the union, die_on_error, name and the callbacks
1819 * fgetc, ungetc, ftell of top need to be initialized before calling
1820 * this function.
1822 static int do_config_from(struct config_source *top, config_fn_t fn,
1823 void *data, enum config_scope scope,
1824 const struct config_options *opts)
1826 struct key_value_info kvi = KVI_INIT;
1827 int ret;
1829 /* push config-file parsing state stack */
1830 top->linenr = 1;
1831 top->eof = 0;
1832 top->total_len = 0;
1833 strbuf_init(&top->value, 1024);
1834 strbuf_init(&top->var, 1024);
1835 kvi_from_source(top, scope, &kvi);
1837 ret = git_parse_source(top, fn, &kvi, data, opts);
1839 strbuf_release(&top->value);
1840 strbuf_release(&top->var);
1842 return ret;
1845 static int do_config_from_file(config_fn_t fn,
1846 const enum config_origin_type origin_type,
1847 const char *name, const char *path, FILE *f,
1848 void *data, enum config_scope scope,
1849 const struct config_options *opts)
1851 struct config_source top = CONFIG_SOURCE_INIT;
1852 int ret;
1854 top.u.file = f;
1855 top.origin_type = origin_type;
1856 top.name = name;
1857 top.path = path;
1858 top.default_error_action = CONFIG_ERROR_DIE;
1859 top.do_fgetc = config_file_fgetc;
1860 top.do_ungetc = config_file_ungetc;
1861 top.do_ftell = config_file_ftell;
1863 flockfile(f);
1864 ret = do_config_from(&top, fn, data, scope, opts);
1865 funlockfile(f);
1866 return ret;
1869 static int git_config_from_stdin(config_fn_t fn, void *data,
1870 enum config_scope scope)
1872 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1873 data, scope, NULL);
1876 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1877 void *data, enum config_scope scope,
1878 const struct config_options *opts)
1880 int ret = -1;
1881 FILE *f;
1883 if (!filename)
1884 BUG("filename cannot be NULL");
1885 f = fopen_or_warn(filename, "r");
1886 if (f) {
1887 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1888 filename, f, data, scope, opts);
1889 fclose(f);
1891 return ret;
1894 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1896 return git_config_from_file_with_options(fn, filename, data,
1897 CONFIG_SCOPE_UNKNOWN, NULL);
1900 int git_config_from_mem(config_fn_t fn,
1901 const enum config_origin_type origin_type,
1902 const char *name, const char *buf, size_t len,
1903 void *data, enum config_scope scope,
1904 const struct config_options *opts)
1906 struct config_source top = CONFIG_SOURCE_INIT;
1908 top.u.buf.buf = buf;
1909 top.u.buf.len = len;
1910 top.u.buf.pos = 0;
1911 top.origin_type = origin_type;
1912 top.name = name;
1913 top.path = NULL;
1914 top.default_error_action = CONFIG_ERROR_ERROR;
1915 top.do_fgetc = config_buf_fgetc;
1916 top.do_ungetc = config_buf_ungetc;
1917 top.do_ftell = config_buf_ftell;
1919 return do_config_from(&top, fn, data, scope, opts);
1922 int git_config_from_blob_oid(config_fn_t fn,
1923 const char *name,
1924 struct repository *repo,
1925 const struct object_id *oid,
1926 void *data,
1927 enum config_scope scope)
1929 enum object_type type;
1930 char *buf;
1931 unsigned long size;
1932 int ret;
1934 buf = repo_read_object_file(repo, oid, &type, &size);
1935 if (!buf)
1936 return error(_("unable to load config blob object '%s'"), name);
1937 if (type != OBJ_BLOB) {
1938 free(buf);
1939 return error(_("reference '%s' does not point to a blob"), name);
1942 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1943 data, scope, NULL);
1944 free(buf);
1946 return ret;
1949 static int git_config_from_blob_ref(config_fn_t fn,
1950 struct repository *repo,
1951 const char *name,
1952 void *data,
1953 enum config_scope scope)
1955 struct object_id oid;
1957 if (repo_get_oid(repo, name, &oid) < 0)
1958 return error(_("unable to resolve config blob '%s'"), name);
1959 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
1962 char *git_system_config(void)
1964 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1965 if (!system_config)
1966 system_config = system_path(ETC_GITCONFIG);
1967 normalize_path_copy(system_config, system_config);
1968 return system_config;
1971 void git_global_config(char **user_out, char **xdg_out)
1973 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1974 char *xdg_config = NULL;
1976 if (!user_config) {
1977 user_config = interpolate_path("~/.gitconfig", 0);
1978 xdg_config = xdg_config_home("config");
1981 *user_out = user_config;
1982 *xdg_out = xdg_config;
1985 int git_config_system(void)
1987 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1990 static int do_git_config_sequence(const struct config_options *opts,
1991 const struct repository *repo,
1992 config_fn_t fn, void *data)
1994 int ret = 0;
1995 char *system_config = git_system_config();
1996 char *xdg_config = NULL;
1997 char *user_config = NULL;
1998 char *repo_config;
1999 char *worktree_config;
2002 * Ensure that either:
2003 * - the git_dir and commondir are both set, or
2004 * - the git_dir and commondir are both NULL
2006 if (!opts->git_dir != !opts->commondir)
2007 BUG("only one of commondir and git_dir is non-NULL");
2009 if (opts->commondir) {
2010 repo_config = mkpathdup("%s/config", opts->commondir);
2011 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2012 } else {
2013 repo_config = NULL;
2014 worktree_config = NULL;
2017 if (git_config_system() && system_config &&
2018 !access_or_die(system_config, R_OK,
2019 opts->system_gently ? ACCESS_EACCES_OK : 0))
2020 ret += git_config_from_file_with_options(fn, system_config,
2021 data, CONFIG_SCOPE_SYSTEM,
2022 NULL);
2024 git_global_config(&user_config, &xdg_config);
2026 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2027 ret += git_config_from_file_with_options(fn, xdg_config, data,
2028 CONFIG_SCOPE_GLOBAL, NULL);
2030 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2031 ret += git_config_from_file_with_options(fn, user_config, data,
2032 CONFIG_SCOPE_GLOBAL, NULL);
2034 if (!opts->ignore_repo && repo_config &&
2035 !access_or_die(repo_config, R_OK, 0))
2036 ret += git_config_from_file_with_options(fn, repo_config, data,
2037 CONFIG_SCOPE_LOCAL, NULL);
2039 if (!opts->ignore_worktree && worktree_config &&
2040 repo && repo->repository_format_worktree_config &&
2041 !access_or_die(worktree_config, R_OK, 0)) {
2042 ret += git_config_from_file_with_options(fn, worktree_config, data,
2043 CONFIG_SCOPE_WORKTREE,
2044 NULL);
2047 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2048 die(_("unable to parse command-line config"));
2050 free(system_config);
2051 free(xdg_config);
2052 free(user_config);
2053 free(repo_config);
2054 free(worktree_config);
2055 return ret;
2058 int config_with_options(config_fn_t fn, void *data,
2059 struct git_config_source *config_source,
2060 struct repository *repo,
2061 const struct config_options *opts)
2063 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2064 int ret;
2066 if (opts->respect_includes) {
2067 inc.fn = fn;
2068 inc.data = data;
2069 inc.opts = opts;
2070 inc.repo = repo;
2071 inc.config_source = config_source;
2072 fn = git_config_include;
2073 data = &inc;
2077 * If we have a specific filename, use it. Otherwise, follow the
2078 * regular lookup sequence.
2080 if (config_source && config_source->use_stdin) {
2081 ret = git_config_from_stdin(fn, data, config_source->scope);
2082 } else if (config_source && config_source->file) {
2083 ret = git_config_from_file_with_options(fn, config_source->file,
2084 data, config_source->scope,
2085 NULL);
2086 } else if (config_source && config_source->blob) {
2087 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2088 data, config_source->scope);
2089 } else {
2090 ret = do_git_config_sequence(opts, repo, fn, data);
2093 if (inc.remote_urls) {
2094 string_list_clear(inc.remote_urls, 0);
2095 FREE_AND_NULL(inc.remote_urls);
2097 return ret;
2100 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2102 int i, value_index;
2103 struct string_list *values;
2104 struct config_set_element *entry;
2105 struct configset_list *list = &set->list;
2106 struct config_context ctx = CONFIG_CONTEXT_INIT;
2108 for (i = 0; i < list->nr; i++) {
2109 entry = list->items[i].e;
2110 value_index = list->items[i].value_index;
2111 values = &entry->value_list;
2113 ctx.kvi = values->items[value_index].util;
2114 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2115 git_die_config_linenr(entry->key,
2116 ctx.kvi->filename,
2117 ctx.kvi->linenr);
2121 void read_early_config(config_fn_t cb, void *data)
2123 struct config_options opts = {0};
2124 struct strbuf commondir = STRBUF_INIT;
2125 struct strbuf gitdir = STRBUF_INIT;
2127 opts.respect_includes = 1;
2129 if (have_git_dir()) {
2130 opts.commondir = get_git_common_dir();
2131 opts.git_dir = get_git_dir();
2133 * When setup_git_directory() was not yet asked to discover the
2134 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2135 * is any repository config we should use (but unlike
2136 * setup_git_directory_gently(), no global state is changed, most
2137 * notably, the current working directory is still the same after the
2138 * call).
2140 } else if (!discover_git_directory(&commondir, &gitdir)) {
2141 opts.commondir = commondir.buf;
2142 opts.git_dir = gitdir.buf;
2145 config_with_options(cb, data, NULL, NULL, &opts);
2147 strbuf_release(&commondir);
2148 strbuf_release(&gitdir);
2152 * Read config but only enumerate system and global settings.
2153 * Omit any repo-local, worktree-local, or command-line settings.
2155 void read_very_early_config(config_fn_t cb, void *data)
2157 struct config_options opts = { 0 };
2159 opts.respect_includes = 1;
2160 opts.ignore_repo = 1;
2161 opts.ignore_worktree = 1;
2162 opts.ignore_cmdline = 1;
2163 opts.system_gently = 1;
2165 config_with_options(cb, data, NULL, NULL, &opts);
2168 RESULT_MUST_BE_USED
2169 static int configset_find_element(struct config_set *set, const char *key,
2170 struct config_set_element **dest)
2172 struct config_set_element k;
2173 struct config_set_element *found_entry;
2174 char *normalized_key;
2175 int ret;
2178 * `key` may come from the user, so normalize it before using it
2179 * for querying entries from the hashmap.
2181 ret = git_config_parse_key(key, &normalized_key, NULL);
2182 if (ret)
2183 return ret;
2185 hashmap_entry_init(&k.ent, strhash(normalized_key));
2186 k.key = normalized_key;
2187 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2188 free(normalized_key);
2189 *dest = found_entry;
2190 return 0;
2193 static int configset_add_value(const struct key_value_info *kvi_p,
2194 struct config_set *set, const char *key,
2195 const char *value)
2197 struct config_set_element *e;
2198 struct string_list_item *si;
2199 struct configset_list_item *l_item;
2200 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2201 int ret;
2203 ret = configset_find_element(set, key, &e);
2204 if (ret)
2205 return ret;
2207 * Since the keys are being fed by git_config*() callback mechanism, they
2208 * are already normalized. So simply add them without any further munging.
2210 if (!e) {
2211 e = xmalloc(sizeof(*e));
2212 hashmap_entry_init(&e->ent, strhash(key));
2213 e->key = xstrdup(key);
2214 string_list_init_dup(&e->value_list);
2215 hashmap_add(&set->config_hash, &e->ent);
2217 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2219 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2220 l_item = &set->list.items[set->list.nr++];
2221 l_item->e = e;
2222 l_item->value_index = e->value_list.nr - 1;
2224 *kv_info = *kvi_p;
2225 si->util = kv_info;
2227 return 0;
2230 static int config_set_element_cmp(const void *cmp_data UNUSED,
2231 const struct hashmap_entry *eptr,
2232 const struct hashmap_entry *entry_or_key,
2233 const void *keydata UNUSED)
2235 const struct config_set_element *e1, *e2;
2237 e1 = container_of(eptr, const struct config_set_element, ent);
2238 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2240 return strcmp(e1->key, e2->key);
2243 void git_configset_init(struct config_set *set)
2245 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2246 set->hash_initialized = 1;
2247 set->list.nr = 0;
2248 set->list.alloc = 0;
2249 set->list.items = NULL;
2252 void git_configset_clear(struct config_set *set)
2254 struct config_set_element *entry;
2255 struct hashmap_iter iter;
2256 if (!set->hash_initialized)
2257 return;
2259 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2260 ent /* member name */) {
2261 free(entry->key);
2262 string_list_clear(&entry->value_list, 1);
2264 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2265 set->hash_initialized = 0;
2266 free(set->list.items);
2267 set->list.nr = 0;
2268 set->list.alloc = 0;
2269 set->list.items = NULL;
2272 static int config_set_callback(const char *key, const char *value,
2273 const struct config_context *ctx,
2274 void *cb)
2276 struct config_set *set = cb;
2277 configset_add_value(ctx->kvi, set, key, value);
2278 return 0;
2281 int git_configset_add_file(struct config_set *set, const char *filename)
2283 return git_config_from_file(config_set_callback, filename, set);
2286 int git_configset_get_value(struct config_set *set, const char *key,
2287 const char **value, struct key_value_info *kvi)
2289 const struct string_list *values = NULL;
2290 int ret;
2291 struct string_list_item item;
2293 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2294 * queried key in the files of the configset, the value returned will be the last
2295 * value in the value list for that key.
2297 if ((ret = git_configset_get_value_multi(set, key, &values)))
2298 return ret;
2300 assert(values->nr > 0);
2301 item = values->items[values->nr - 1];
2302 *value = item.string;
2303 if (kvi)
2304 *kvi = *((struct key_value_info *)item.util);
2305 return 0;
2308 int git_configset_get_value_multi(struct config_set *set, const char *key,
2309 const struct string_list **dest)
2311 struct config_set_element *e;
2312 int ret;
2314 if ((ret = configset_find_element(set, key, &e)))
2315 return ret;
2316 else if (!e)
2317 return 1;
2318 *dest = &e->value_list;
2320 return 0;
2323 static int check_multi_string(struct string_list_item *item, void *util)
2325 return item->string ? 0 : config_error_nonbool(util);
2328 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2329 const struct string_list **dest)
2331 int ret;
2333 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2334 return ret;
2335 if ((ret = for_each_string_list((struct string_list *)*dest,
2336 check_multi_string, (void *)key)))
2337 return ret;
2339 return 0;
2342 int git_configset_get(struct config_set *set, const char *key)
2344 struct config_set_element *e;
2345 int ret;
2347 if ((ret = configset_find_element(set, key, &e)))
2348 return ret;
2349 else if (!e)
2350 return 1;
2351 return 0;
2354 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2356 const char *value;
2357 if (!git_configset_get_value(set, key, &value, NULL))
2358 return git_config_string((const char **)dest, key, value);
2359 else
2360 return 1;
2363 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2364 const char **dest)
2366 const char *value;
2367 if (!git_configset_get_value(set, key, &value, NULL)) {
2368 if (!value)
2369 return config_error_nonbool(key);
2370 *dest = value;
2371 return 0;
2372 } else {
2373 return 1;
2377 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2379 const char *value;
2380 struct key_value_info kvi;
2382 if (!git_configset_get_value(set, key, &value, &kvi)) {
2383 *dest = git_config_int(key, value, &kvi);
2384 return 0;
2385 } else
2386 return 1;
2389 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2391 const char *value;
2392 struct key_value_info kvi;
2394 if (!git_configset_get_value(set, key, &value, &kvi)) {
2395 *dest = git_config_ulong(key, value, &kvi);
2396 return 0;
2397 } else
2398 return 1;
2401 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2403 const char *value;
2404 if (!git_configset_get_value(set, key, &value, NULL)) {
2405 *dest = git_config_bool(key, value);
2406 return 0;
2407 } else
2408 return 1;
2411 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2412 int *is_bool, int *dest)
2414 const char *value;
2415 struct key_value_info kvi;
2417 if (!git_configset_get_value(set, key, &value, &kvi)) {
2418 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2419 return 0;
2420 } else
2421 return 1;
2424 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2426 const char *value;
2427 if (!git_configset_get_value(set, key, &value, NULL)) {
2428 *dest = git_parse_maybe_bool(value);
2429 if (*dest == -1)
2430 return -1;
2431 return 0;
2432 } else
2433 return 1;
2436 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2438 const char *value;
2439 if (!git_configset_get_value(set, key, &value, NULL))
2440 return git_config_pathname(dest, key, value);
2441 else
2442 return 1;
2445 /* Functions use to read configuration from a repository */
2446 static void repo_read_config(struct repository *repo)
2448 struct config_options opts = { 0 };
2450 opts.respect_includes = 1;
2451 opts.commondir = repo->commondir;
2452 opts.git_dir = repo->gitdir;
2454 if (!repo->config)
2455 CALLOC_ARRAY(repo->config, 1);
2456 else
2457 git_configset_clear(repo->config);
2459 git_configset_init(repo->config);
2460 if (config_with_options(config_set_callback, repo->config, NULL,
2461 repo, &opts) < 0)
2463 * config_with_options() normally returns only
2464 * zero, as most errors are fatal, and
2465 * non-fatal potential errors are guarded by "if"
2466 * statements that are entered only when no error is
2467 * possible.
2469 * If we ever encounter a non-fatal error, it means
2470 * something went really wrong and we should stop
2471 * immediately.
2473 die(_("unknown error occurred while reading the configuration files"));
2476 static void git_config_check_init(struct repository *repo)
2478 if (repo->config && repo->config->hash_initialized)
2479 return;
2480 repo_read_config(repo);
2483 static void repo_config_clear(struct repository *repo)
2485 if (!repo->config || !repo->config->hash_initialized)
2486 return;
2487 git_configset_clear(repo->config);
2490 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2492 git_config_check_init(repo);
2493 configset_iter(repo->config, fn, data);
2496 int repo_config_get(struct repository *repo, const char *key)
2498 git_config_check_init(repo);
2499 return git_configset_get(repo->config, key);
2502 int repo_config_get_value(struct repository *repo,
2503 const char *key, const char **value)
2505 git_config_check_init(repo);
2506 return git_configset_get_value(repo->config, key, value, NULL);
2509 int repo_config_get_value_multi(struct repository *repo, const char *key,
2510 const struct string_list **dest)
2512 git_config_check_init(repo);
2513 return git_configset_get_value_multi(repo->config, key, dest);
2516 int repo_config_get_string_multi(struct repository *repo, const char *key,
2517 const struct string_list **dest)
2519 git_config_check_init(repo);
2520 return git_configset_get_string_multi(repo->config, key, dest);
2523 int repo_config_get_string(struct repository *repo,
2524 const char *key, char **dest)
2526 int ret;
2527 git_config_check_init(repo);
2528 ret = git_configset_get_string(repo->config, key, dest);
2529 if (ret < 0)
2530 git_die_config(key, NULL);
2531 return ret;
2534 int repo_config_get_string_tmp(struct repository *repo,
2535 const char *key, const char **dest)
2537 int ret;
2538 git_config_check_init(repo);
2539 ret = git_configset_get_string_tmp(repo->config, key, dest);
2540 if (ret < 0)
2541 git_die_config(key, NULL);
2542 return ret;
2545 int repo_config_get_int(struct repository *repo,
2546 const char *key, int *dest)
2548 git_config_check_init(repo);
2549 return git_configset_get_int(repo->config, key, dest);
2552 int repo_config_get_ulong(struct repository *repo,
2553 const char *key, unsigned long *dest)
2555 git_config_check_init(repo);
2556 return git_configset_get_ulong(repo->config, key, dest);
2559 int repo_config_get_bool(struct repository *repo,
2560 const char *key, int *dest)
2562 git_config_check_init(repo);
2563 return git_configset_get_bool(repo->config, key, dest);
2566 int repo_config_get_bool_or_int(struct repository *repo,
2567 const char *key, int *is_bool, int *dest)
2569 git_config_check_init(repo);
2570 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2573 int repo_config_get_maybe_bool(struct repository *repo,
2574 const char *key, int *dest)
2576 git_config_check_init(repo);
2577 return git_configset_get_maybe_bool(repo->config, key, dest);
2580 int repo_config_get_pathname(struct repository *repo,
2581 const char *key, const char **dest)
2583 int ret;
2584 git_config_check_init(repo);
2585 ret = git_configset_get_pathname(repo->config, key, dest);
2586 if (ret < 0)
2587 git_die_config(key, NULL);
2588 return ret;
2591 /* Read values into protected_config. */
2592 static void read_protected_config(void)
2594 struct config_options opts = {
2595 .respect_includes = 1,
2596 .ignore_repo = 1,
2597 .ignore_worktree = 1,
2598 .system_gently = 1,
2601 git_configset_init(&protected_config);
2602 config_with_options(config_set_callback, &protected_config, NULL,
2603 NULL, &opts);
2606 void git_protected_config(config_fn_t fn, void *data)
2608 if (!protected_config.hash_initialized)
2609 read_protected_config();
2610 configset_iter(&protected_config, fn, data);
2613 /* Functions used historically to read configuration from 'the_repository' */
2614 void git_config(config_fn_t fn, void *data)
2616 repo_config(the_repository, fn, data);
2619 void git_config_clear(void)
2621 repo_config_clear(the_repository);
2624 int git_config_get(const char *key)
2626 return repo_config_get(the_repository, key);
2629 int git_config_get_value(const char *key, const char **value)
2631 return repo_config_get_value(the_repository, key, value);
2634 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2636 return repo_config_get_value_multi(the_repository, key, dest);
2639 int git_config_get_string_multi(const char *key,
2640 const struct string_list **dest)
2642 return repo_config_get_string_multi(the_repository, key, dest);
2645 int git_config_get_string(const char *key, char **dest)
2647 return repo_config_get_string(the_repository, key, dest);
2650 int git_config_get_string_tmp(const char *key, const char **dest)
2652 return repo_config_get_string_tmp(the_repository, key, dest);
2655 int git_config_get_int(const char *key, int *dest)
2657 return repo_config_get_int(the_repository, key, dest);
2660 int git_config_get_ulong(const char *key, unsigned long *dest)
2662 return repo_config_get_ulong(the_repository, key, dest);
2665 int git_config_get_bool(const char *key, int *dest)
2667 return repo_config_get_bool(the_repository, key, dest);
2670 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2672 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2675 int git_config_get_maybe_bool(const char *key, int *dest)
2677 return repo_config_get_maybe_bool(the_repository, key, dest);
2680 int git_config_get_pathname(const char *key, const char **dest)
2682 return repo_config_get_pathname(the_repository, key, dest);
2685 int git_config_get_expiry(const char *key, const char **output)
2687 int ret = git_config_get_string(key, (char **)output);
2688 if (ret)
2689 return ret;
2690 if (strcmp(*output, "now")) {
2691 timestamp_t now = approxidate("now");
2692 if (approxidate(*output) >= now)
2693 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2695 return ret;
2698 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2700 const char *expiry_string;
2701 intmax_t days;
2702 timestamp_t when;
2704 if (git_config_get_string_tmp(key, &expiry_string))
2705 return 1; /* no such thing */
2707 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2708 const int scale = 86400;
2709 *expiry = now - days * scale;
2710 return 0;
2713 if (!parse_expiry_date(expiry_string, &when)) {
2714 *expiry = when;
2715 return 0;
2717 return -1; /* thing exists but cannot be parsed */
2720 int git_config_get_split_index(void)
2722 int val;
2724 if (!git_config_get_maybe_bool("core.splitindex", &val))
2725 return val;
2727 return -1; /* default value */
2730 int git_config_get_max_percent_split_change(void)
2732 int val = -1;
2734 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2735 if (0 <= val && val <= 100)
2736 return val;
2738 return error(_("splitIndex.maxPercentChange value '%d' "
2739 "should be between 0 and 100"), val);
2742 return -1; /* default value */
2745 int git_config_get_index_threads(int *dest)
2747 int is_bool, val;
2749 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2750 if (val) {
2751 *dest = val;
2752 return 0;
2755 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2756 if (is_bool)
2757 *dest = val ? 0 : 1;
2758 else
2759 *dest = val;
2760 return 0;
2763 return 1;
2766 NORETURN
2767 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2769 if (!filename)
2770 die(_("unable to parse '%s' from command-line config"), key);
2771 else
2772 die(_("bad config variable '%s' in file '%s' at line %d"),
2773 key, filename, linenr);
2776 NORETURN __attribute__((format(printf, 2, 3)))
2777 void git_die_config(const char *key, const char *err, ...)
2779 const struct string_list *values;
2780 struct key_value_info *kv_info;
2781 report_fn error_fn = get_error_routine();
2783 if (err) {
2784 va_list params;
2785 va_start(params, err);
2786 error_fn(err, params);
2787 va_end(params);
2789 if (git_config_get_value_multi(key, &values))
2790 BUG("for key '%s' we must have a value to report on", key);
2791 kv_info = values->items[values->nr - 1].util;
2792 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2796 * Find all the stuff for git_config_set() below.
2799 struct config_store_data {
2800 size_t baselen;
2801 char *key;
2802 int do_not_match;
2803 const char *fixed_value;
2804 regex_t *value_pattern;
2805 int multi_replace;
2806 struct {
2807 size_t begin, end;
2808 enum config_event_t type;
2809 int is_keys_section;
2810 } *parsed;
2811 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2812 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2814 #define CONFIG_STORE_INIT { 0 }
2816 static void config_store_data_clear(struct config_store_data *store)
2818 free(store->key);
2819 if (store->value_pattern != NULL &&
2820 store->value_pattern != CONFIG_REGEX_NONE) {
2821 regfree(store->value_pattern);
2822 free(store->value_pattern);
2824 free(store->parsed);
2825 free(store->seen);
2826 memset(store, 0, sizeof(*store));
2829 static int matches(const char *key, const char *value,
2830 const struct config_store_data *store)
2832 if (strcmp(key, store->key))
2833 return 0; /* not ours */
2834 if (store->fixed_value)
2835 return !strcmp(store->fixed_value, value);
2836 if (!store->value_pattern)
2837 return 1; /* always matches */
2838 if (store->value_pattern == CONFIG_REGEX_NONE)
2839 return 0; /* never matches */
2841 return store->do_not_match ^
2842 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2845 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2846 struct config_source *cs, void *data)
2848 struct config_store_data *store = data;
2850 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2851 store->parsed[store->parsed_nr].begin = begin;
2852 store->parsed[store->parsed_nr].end = end;
2853 store->parsed[store->parsed_nr].type = type;
2855 if (type == CONFIG_EVENT_SECTION) {
2856 int (*cmpfn)(const char *, const char *, size_t);
2858 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2859 return error(_("invalid section name '%s'"), cs->var.buf);
2861 if (cs->subsection_case_sensitive)
2862 cmpfn = strncasecmp;
2863 else
2864 cmpfn = strncmp;
2866 /* Is this the section we were looking for? */
2867 store->is_keys_section =
2868 store->parsed[store->parsed_nr].is_keys_section =
2869 cs->var.len - 1 == store->baselen &&
2870 !cmpfn(cs->var.buf, store->key, store->baselen);
2871 if (store->is_keys_section) {
2872 store->section_seen = 1;
2873 ALLOC_GROW(store->seen, store->seen_nr + 1,
2874 store->seen_alloc);
2875 store->seen[store->seen_nr] = store->parsed_nr;
2879 store->parsed_nr++;
2881 return 0;
2884 static int store_aux(const char *key, const char *value,
2885 const struct config_context *ctx UNUSED, void *cb)
2887 struct config_store_data *store = cb;
2889 if (store->key_seen) {
2890 if (matches(key, value, store)) {
2891 if (store->seen_nr == 1 && store->multi_replace == 0) {
2892 warning(_("%s has multiple values"), key);
2895 ALLOC_GROW(store->seen, store->seen_nr + 1,
2896 store->seen_alloc);
2898 store->seen[store->seen_nr] = store->parsed_nr;
2899 store->seen_nr++;
2901 } else if (store->is_keys_section) {
2903 * Do not increment matches yet: this may not be a match, but we
2904 * are in the desired section.
2906 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2907 store->seen[store->seen_nr] = store->parsed_nr;
2908 store->section_seen = 1;
2910 if (matches(key, value, store)) {
2911 store->seen_nr++;
2912 store->key_seen = 1;
2916 return 0;
2919 static int write_error(const char *filename)
2921 error(_("failed to write new configuration file %s"), filename);
2923 /* Same error code as "failed to rename". */
2924 return 4;
2927 static struct strbuf store_create_section(const char *key,
2928 const struct config_store_data *store)
2930 const char *dot;
2931 size_t i;
2932 struct strbuf sb = STRBUF_INIT;
2934 dot = memchr(key, '.', store->baselen);
2935 if (dot) {
2936 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2937 for (i = dot - key + 1; i < store->baselen; i++) {
2938 if (key[i] == '"' || key[i] == '\\')
2939 strbuf_addch(&sb, '\\');
2940 strbuf_addch(&sb, key[i]);
2942 strbuf_addstr(&sb, "\"]\n");
2943 } else {
2944 strbuf_addch(&sb, '[');
2945 strbuf_add(&sb, key, store->baselen);
2946 strbuf_addstr(&sb, "]\n");
2949 return sb;
2952 static ssize_t write_section(int fd, const char *key,
2953 const struct config_store_data *store)
2955 struct strbuf sb = store_create_section(key, store);
2956 ssize_t ret;
2958 ret = write_in_full(fd, sb.buf, sb.len);
2959 strbuf_release(&sb);
2961 return ret;
2964 static ssize_t write_pair(int fd, const char *key, const char *value,
2965 const struct config_store_data *store)
2967 int i;
2968 ssize_t ret;
2969 const char *quote = "";
2970 struct strbuf sb = STRBUF_INIT;
2973 * Check to see if the value needs to be surrounded with a dq pair.
2974 * Note that problematic characters are always backslash-quoted; this
2975 * check is about not losing leading or trailing SP and strings that
2976 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2977 * configuration parser.
2979 if (value[0] == ' ')
2980 quote = "\"";
2981 for (i = 0; value[i]; i++)
2982 if (value[i] == ';' || value[i] == '#')
2983 quote = "\"";
2984 if (i && value[i - 1] == ' ')
2985 quote = "\"";
2987 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
2989 for (i = 0; value[i]; i++)
2990 switch (value[i]) {
2991 case '\n':
2992 strbuf_addstr(&sb, "\\n");
2993 break;
2994 case '\t':
2995 strbuf_addstr(&sb, "\\t");
2996 break;
2997 case '"':
2998 case '\\':
2999 strbuf_addch(&sb, '\\');
3000 /* fallthrough */
3001 default:
3002 strbuf_addch(&sb, value[i]);
3003 break;
3005 strbuf_addf(&sb, "%s\n", quote);
3007 ret = write_in_full(fd, sb.buf, sb.len);
3008 strbuf_release(&sb);
3010 return ret;
3014 * If we are about to unset the last key(s) in a section, and if there are
3015 * no comments surrounding (or included in) the section, we will want to
3016 * extend begin/end to remove the entire section.
3018 * Note: the parameter `seen_ptr` points to the index into the store.seen
3019 * array. * This index may be incremented if a section has more than one
3020 * entry (which all are to be removed).
3022 static void maybe_remove_section(struct config_store_data *store,
3023 size_t *begin_offset, size_t *end_offset,
3024 int *seen_ptr)
3026 size_t begin;
3027 int i, seen, section_seen = 0;
3030 * First, ensure that this is the first key, and that there are no
3031 * comments before the entry nor before the section header.
3033 seen = *seen_ptr;
3034 for (i = store->seen[seen]; i > 0; i--) {
3035 enum config_event_t type = store->parsed[i - 1].type;
3037 if (type == CONFIG_EVENT_COMMENT)
3038 /* There is a comment before this entry or section */
3039 return;
3040 if (type == CONFIG_EVENT_ENTRY) {
3041 if (!section_seen)
3042 /* This is not the section's first entry. */
3043 return;
3044 /* We encountered no comment before the section. */
3045 break;
3047 if (type == CONFIG_EVENT_SECTION) {
3048 if (!store->parsed[i - 1].is_keys_section)
3049 break;
3050 section_seen = 1;
3053 begin = store->parsed[i].begin;
3056 * Next, make sure that we are removing the last key(s) in the section,
3057 * and that there are no comments that are possibly about the current
3058 * section.
3060 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3061 enum config_event_t type = store->parsed[i].type;
3063 if (type == CONFIG_EVENT_COMMENT)
3064 return;
3065 if (type == CONFIG_EVENT_SECTION) {
3066 if (store->parsed[i].is_keys_section)
3067 continue;
3068 break;
3070 if (type == CONFIG_EVENT_ENTRY) {
3071 if (++seen < store->seen_nr &&
3072 i == store->seen[seen])
3073 /* We want to remove this entry, too */
3074 continue;
3075 /* There is another entry in this section. */
3076 return;
3081 * We are really removing the last entry/entries from this section, and
3082 * there are no enclosed or surrounding comments. Remove the entire,
3083 * now-empty section.
3085 *seen_ptr = seen;
3086 *begin_offset = begin;
3087 if (i < store->parsed_nr)
3088 *end_offset = store->parsed[i].begin;
3089 else
3090 *end_offset = store->parsed[store->parsed_nr - 1].end;
3093 int git_config_set_in_file_gently(const char *config_filename,
3094 const char *key, const char *value)
3096 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3099 void git_config_set_in_file(const char *config_filename,
3100 const char *key, const char *value)
3102 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3105 int git_config_set_gently(const char *key, const char *value)
3107 return git_config_set_multivar_gently(key, value, NULL, 0);
3110 int repo_config_set_worktree_gently(struct repository *r,
3111 const char *key, const char *value)
3113 /* Only use worktree-specific config if it is already enabled. */
3114 if (r->repository_format_worktree_config) {
3115 char *file = repo_git_path(r, "config.worktree");
3116 int ret = git_config_set_multivar_in_file_gently(
3117 file, key, value, NULL, 0);
3118 free(file);
3119 return ret;
3121 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3124 void git_config_set(const char *key, const char *value)
3126 git_config_set_multivar(key, value, NULL, 0);
3128 trace2_cmd_set_config(key, value);
3132 * If value==NULL, unset in (remove from) config,
3133 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3134 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3135 * (only add a new one)
3136 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3137 * key/values are removed before a single new pair is written. If the
3138 * flag is not present, then replace only the first match.
3140 * Returns 0 on success.
3142 * This function does this:
3144 * - it locks the config file by creating ".git/config.lock"
3146 * - it then parses the config using store_aux() as validator to find
3147 * the position on the key/value pair to replace. If it is to be unset,
3148 * it must be found exactly once.
3150 * - the config file is mmap()ed and the part before the match (if any) is
3151 * written to the lock file, then the changed part and the rest.
3153 * - the config file is removed and the lock file rename()d to it.
3156 int git_config_set_multivar_in_file_gently(const char *config_filename,
3157 const char *key, const char *value,
3158 const char *value_pattern,
3159 unsigned flags)
3161 int fd = -1, in_fd = -1;
3162 int ret;
3163 struct lock_file lock = LOCK_INIT;
3164 char *filename_buf = NULL;
3165 char *contents = NULL;
3166 size_t contents_sz;
3167 struct config_store_data store = CONFIG_STORE_INIT;
3169 /* parse-key returns negative; flip the sign to feed exit(3) */
3170 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3171 if (ret)
3172 goto out_free;
3174 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3176 if (!config_filename)
3177 config_filename = filename_buf = git_pathdup("config");
3180 * The lock serves a purpose in addition to locking: the new
3181 * contents of .git/config will be written into it.
3183 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3184 if (fd < 0) {
3185 error_errno(_("could not lock config file %s"), config_filename);
3186 ret = CONFIG_NO_LOCK;
3187 goto out_free;
3191 * If .git/config does not exist yet, write a minimal version.
3193 in_fd = open(config_filename, O_RDONLY);
3194 if ( in_fd < 0 ) {
3195 if ( ENOENT != errno ) {
3196 error_errno(_("opening %s"), config_filename);
3197 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3198 goto out_free;
3200 /* if nothing to unset, error out */
3201 if (!value) {
3202 ret = CONFIG_NOTHING_SET;
3203 goto out_free;
3206 free(store.key);
3207 store.key = xstrdup(key);
3208 if (write_section(fd, key, &store) < 0 ||
3209 write_pair(fd, key, value, &store) < 0)
3210 goto write_err_out;
3211 } else {
3212 struct stat st;
3213 size_t copy_begin, copy_end;
3214 int i, new_line = 0;
3215 struct config_options opts;
3217 if (!value_pattern)
3218 store.value_pattern = NULL;
3219 else if (value_pattern == CONFIG_REGEX_NONE)
3220 store.value_pattern = CONFIG_REGEX_NONE;
3221 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3222 store.fixed_value = value_pattern;
3223 else {
3224 if (value_pattern[0] == '!') {
3225 store.do_not_match = 1;
3226 value_pattern++;
3227 } else
3228 store.do_not_match = 0;
3230 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3231 if (regcomp(store.value_pattern, value_pattern,
3232 REG_EXTENDED)) {
3233 error(_("invalid pattern: %s"), value_pattern);
3234 FREE_AND_NULL(store.value_pattern);
3235 ret = CONFIG_INVALID_PATTERN;
3236 goto out_free;
3240 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3241 store.parsed[0].end = 0;
3243 memset(&opts, 0, sizeof(opts));
3244 opts.event_fn = store_aux_event;
3245 opts.event_fn_data = &store;
3248 * After this, store.parsed will contain offsets of all the
3249 * parsed elements, and store.seen will contain a list of
3250 * matches, as indices into store.parsed.
3252 * As a side effect, we make sure to transform only a valid
3253 * existing config file.
3255 if (git_config_from_file_with_options(store_aux,
3256 config_filename,
3257 &store, CONFIG_SCOPE_UNKNOWN,
3258 &opts)) {
3259 error(_("invalid config file %s"), config_filename);
3260 ret = CONFIG_INVALID_FILE;
3261 goto out_free;
3264 /* if nothing to unset, or too many matches, error out */
3265 if ((store.seen_nr == 0 && value == NULL) ||
3266 (store.seen_nr > 1 && !store.multi_replace)) {
3267 ret = CONFIG_NOTHING_SET;
3268 goto out_free;
3271 if (fstat(in_fd, &st) == -1) {
3272 error_errno(_("fstat on %s failed"), config_filename);
3273 ret = CONFIG_INVALID_FILE;
3274 goto out_free;
3277 contents_sz = xsize_t(st.st_size);
3278 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3279 MAP_PRIVATE, in_fd, 0);
3280 if (contents == MAP_FAILED) {
3281 if (errno == ENODEV && S_ISDIR(st.st_mode))
3282 errno = EISDIR;
3283 error_errno(_("unable to mmap '%s'%s"),
3284 config_filename, mmap_os_err());
3285 ret = CONFIG_INVALID_FILE;
3286 contents = NULL;
3287 goto out_free;
3289 close(in_fd);
3290 in_fd = -1;
3292 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3293 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3294 ret = CONFIG_NO_WRITE;
3295 goto out_free;
3298 if (store.seen_nr == 0) {
3299 if (!store.seen_alloc) {
3300 /* Did not see key nor section */
3301 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3302 store.seen[0] = store.parsed_nr
3303 - !!store.parsed_nr;
3305 store.seen_nr = 1;
3308 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3309 size_t replace_end;
3310 int j = store.seen[i];
3312 new_line = 0;
3313 if (!store.key_seen) {
3314 copy_end = store.parsed[j].end;
3315 /* include '\n' when copying section header */
3316 if (copy_end > 0 && copy_end < contents_sz &&
3317 contents[copy_end - 1] != '\n' &&
3318 contents[copy_end] == '\n')
3319 copy_end++;
3320 replace_end = copy_end;
3321 } else {
3322 replace_end = store.parsed[j].end;
3323 copy_end = store.parsed[j].begin;
3324 if (!value)
3325 maybe_remove_section(&store,
3326 &copy_end,
3327 &replace_end, &i);
3329 * Swallow preceding white-space on the same
3330 * line.
3332 while (copy_end > 0 ) {
3333 char c = contents[copy_end - 1];
3335 if (isspace(c) && c != '\n')
3336 copy_end--;
3337 else
3338 break;
3342 if (copy_end > 0 && contents[copy_end-1] != '\n')
3343 new_line = 1;
3345 /* write the first part of the config */
3346 if (copy_end > copy_begin) {
3347 if (write_in_full(fd, contents + copy_begin,
3348 copy_end - copy_begin) < 0)
3349 goto write_err_out;
3350 if (new_line &&
3351 write_str_in_full(fd, "\n") < 0)
3352 goto write_err_out;
3354 copy_begin = replace_end;
3357 /* write the pair (value == NULL means unset) */
3358 if (value) {
3359 if (!store.section_seen) {
3360 if (write_section(fd, key, &store) < 0)
3361 goto write_err_out;
3363 if (write_pair(fd, key, value, &store) < 0)
3364 goto write_err_out;
3367 /* write the rest of the config */
3368 if (copy_begin < contents_sz)
3369 if (write_in_full(fd, contents + copy_begin,
3370 contents_sz - copy_begin) < 0)
3371 goto write_err_out;
3373 munmap(contents, contents_sz);
3374 contents = NULL;
3377 if (commit_lock_file(&lock) < 0) {
3378 error_errno(_("could not write config file %s"), config_filename);
3379 ret = CONFIG_NO_WRITE;
3380 goto out_free;
3383 ret = 0;
3385 /* Invalidate the config cache */
3386 git_config_clear();
3388 out_free:
3389 rollback_lock_file(&lock);
3390 free(filename_buf);
3391 if (contents)
3392 munmap(contents, contents_sz);
3393 if (in_fd >= 0)
3394 close(in_fd);
3395 config_store_data_clear(&store);
3396 return ret;
3398 write_err_out:
3399 ret = write_error(get_lock_file_path(&lock));
3400 goto out_free;
3404 void git_config_set_multivar_in_file(const char *config_filename,
3405 const char *key, const char *value,
3406 const char *value_pattern, unsigned flags)
3408 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3409 value_pattern, flags))
3410 return;
3411 if (value)
3412 die(_("could not set '%s' to '%s'"), key, value);
3413 else
3414 die(_("could not unset '%s'"), key);
3417 int git_config_set_multivar_gently(const char *key, const char *value,
3418 const char *value_pattern, unsigned flags)
3420 return repo_config_set_multivar_gently(the_repository, key, value,
3421 value_pattern, flags);
3424 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3425 const char *value,
3426 const char *value_pattern, unsigned flags)
3428 char *file = repo_git_path(r, "config");
3429 int res = git_config_set_multivar_in_file_gently(file,
3430 key, value,
3431 value_pattern,
3432 flags);
3433 free(file);
3434 return res;
3437 void git_config_set_multivar(const char *key, const char *value,
3438 const char *value_pattern, unsigned flags)
3440 git_config_set_multivar_in_file(git_path("config"),
3441 key, value, value_pattern,
3442 flags);
3445 static size_t section_name_match (const char *buf, const char *name)
3447 size_t i = 0, j = 0;
3448 int dot = 0;
3449 if (buf[i] != '[')
3450 return 0;
3451 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3452 if (!dot && isspace(buf[i])) {
3453 dot = 1;
3454 if (name[j++] != '.')
3455 break;
3456 for (i++; isspace(buf[i]); i++)
3457 ; /* do nothing */
3458 if (buf[i] != '"')
3459 break;
3460 continue;
3462 if (buf[i] == '\\' && dot)
3463 i++;
3464 else if (buf[i] == '"' && dot) {
3465 for (i++; isspace(buf[i]); i++)
3466 ; /* do_nothing */
3467 break;
3469 if (buf[i] != name[j++])
3470 break;
3472 if (buf[i] == ']' && name[j] == 0) {
3474 * We match, now just find the right length offset by
3475 * gobbling up any whitespace after it, as well
3477 i++;
3478 for (; buf[i] && isspace(buf[i]); i++)
3479 ; /* do nothing */
3480 return i;
3482 return 0;
3485 static int section_name_is_ok(const char *name)
3487 /* Empty section names are bogus. */
3488 if (!*name)
3489 return 0;
3492 * Before a dot, we must be alphanumeric or dash. After the first dot,
3493 * anything goes, so we can stop checking.
3495 for (; *name && *name != '.'; name++)
3496 if (*name != '-' && !isalnum(*name))
3497 return 0;
3498 return 1;
3501 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3503 /* if new_name == NULL, the section is removed instead */
3504 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3505 const char *old_name,
3506 const char *new_name, int copy)
3508 int ret = 0, remove = 0;
3509 char *filename_buf = NULL;
3510 struct lock_file lock = LOCK_INIT;
3511 int out_fd;
3512 struct strbuf buf = STRBUF_INIT;
3513 FILE *config_file = NULL;
3514 struct stat st;
3515 struct strbuf copystr = STRBUF_INIT;
3516 struct config_store_data store;
3517 uint32_t line_nr = 0;
3519 memset(&store, 0, sizeof(store));
3521 if (new_name && !section_name_is_ok(new_name)) {
3522 ret = error(_("invalid section name: %s"), new_name);
3523 goto out_no_rollback;
3526 if (!config_filename)
3527 config_filename = filename_buf = git_pathdup("config");
3529 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3530 if (out_fd < 0) {
3531 ret = error(_("could not lock config file %s"), config_filename);
3532 goto out;
3535 if (!(config_file = fopen(config_filename, "rb"))) {
3536 ret = warn_on_fopen_errors(config_filename);
3537 if (ret)
3538 goto out;
3539 /* no config file means nothing to rename, no error */
3540 goto commit_and_out;
3543 if (fstat(fileno(config_file), &st) == -1) {
3544 ret = error_errno(_("fstat on %s failed"), config_filename);
3545 goto out;
3548 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3549 ret = error_errno(_("chmod on %s failed"),
3550 get_lock_file_path(&lock));
3551 goto out;
3554 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3555 size_t i, length;
3556 int is_section = 0;
3557 char *output = buf.buf;
3559 line_nr++;
3561 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3562 ret = error(_("refusing to work with overly long line "
3563 "in '%s' on line %"PRIuMAX),
3564 config_filename, (uintmax_t)line_nr);
3565 goto out;
3568 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3569 ; /* do nothing */
3570 if (buf.buf[i] == '[') {
3571 /* it's a section */
3572 size_t offset;
3573 is_section = 1;
3576 * When encountering a new section under -c we
3577 * need to flush out any section we're already
3578 * coping and begin anew. There might be
3579 * multiple [branch "$name"] sections.
3581 if (copystr.len > 0) {
3582 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3583 ret = write_error(get_lock_file_path(&lock));
3584 goto out;
3586 strbuf_reset(&copystr);
3589 offset = section_name_match(&buf.buf[i], old_name);
3590 if (offset > 0) {
3591 ret++;
3592 if (!new_name) {
3593 remove = 1;
3594 continue;
3596 store.baselen = strlen(new_name);
3597 if (!copy) {
3598 if (write_section(out_fd, new_name, &store) < 0) {
3599 ret = write_error(get_lock_file_path(&lock));
3600 goto out;
3603 * We wrote out the new section, with
3604 * a newline, now skip the old
3605 * section's length
3607 output += offset + i;
3608 if (strlen(output) > 0) {
3610 * More content means there's
3611 * a declaration to put on the
3612 * next line; indent with a
3613 * tab
3615 output -= 1;
3616 output[0] = '\t';
3618 } else {
3619 strbuf_release(&copystr);
3620 copystr = store_create_section(new_name, &store);
3623 remove = 0;
3625 if (remove)
3626 continue;
3627 length = strlen(output);
3629 if (!is_section && copystr.len > 0) {
3630 strbuf_add(&copystr, output, length);
3633 if (write_in_full(out_fd, output, length) < 0) {
3634 ret = write_error(get_lock_file_path(&lock));
3635 goto out;
3640 * Copy a trailing section at the end of the config, won't be
3641 * flushed by the usual "flush because we have a new section
3642 * logic in the loop above.
3644 if (copystr.len > 0) {
3645 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3646 ret = write_error(get_lock_file_path(&lock));
3647 goto out;
3649 strbuf_reset(&copystr);
3652 fclose(config_file);
3653 config_file = NULL;
3654 commit_and_out:
3655 if (commit_lock_file(&lock) < 0)
3656 ret = error_errno(_("could not write config file %s"),
3657 config_filename);
3658 out:
3659 if (config_file)
3660 fclose(config_file);
3661 rollback_lock_file(&lock);
3662 out_no_rollback:
3663 free(filename_buf);
3664 config_store_data_clear(&store);
3665 strbuf_release(&buf);
3666 strbuf_release(&copystr);
3667 return ret;
3670 int git_config_rename_section_in_file(const char *config_filename,
3671 const char *old_name, const char *new_name)
3673 return git_config_copy_or_rename_section_in_file(config_filename,
3674 old_name, new_name, 0);
3677 int git_config_rename_section(const char *old_name, const char *new_name)
3679 return git_config_rename_section_in_file(NULL, old_name, new_name);
3682 int git_config_copy_section_in_file(const char *config_filename,
3683 const char *old_name, const char *new_name)
3685 return git_config_copy_or_rename_section_in_file(config_filename,
3686 old_name, new_name, 1);
3689 int git_config_copy_section(const char *old_name, const char *new_name)
3691 return git_config_copy_section_in_file(NULL, old_name, new_name);
3695 * Call this to report error for your variable that should not
3696 * get a boolean value (i.e. "[my] var" means "true").
3698 #undef config_error_nonbool
3699 int config_error_nonbool(const char *var)
3701 return error(_("missing value for '%s'"), var);
3704 int parse_config_key(const char *var,
3705 const char *section,
3706 const char **subsection, size_t *subsection_len,
3707 const char **key)
3709 const char *dot;
3711 /* Does it start with "section." ? */
3712 if (!skip_prefix(var, section, &var) || *var != '.')
3713 return -1;
3716 * Find the key; we don't know yet if we have a subsection, but we must
3717 * parse backwards from the end, since the subsection may have dots in
3718 * it, too.
3720 dot = strrchr(var, '.');
3721 *key = dot + 1;
3723 /* Did we have a subsection at all? */
3724 if (dot == var) {
3725 if (subsection) {
3726 *subsection = NULL;
3727 *subsection_len = 0;
3730 else {
3731 if (!subsection)
3732 return -1;
3733 *subsection = var + 1;
3734 *subsection_len = dot - *subsection;
3737 return 0;
3740 const char *config_origin_type_name(enum config_origin_type type)
3742 switch (type) {
3743 case CONFIG_ORIGIN_BLOB:
3744 return "blob";
3745 case CONFIG_ORIGIN_FILE:
3746 return "file";
3747 case CONFIG_ORIGIN_STDIN:
3748 return "standard input";
3749 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3750 return "submodule-blob";
3751 case CONFIG_ORIGIN_CMDLINE:
3752 return "command line";
3753 default:
3754 BUG("unknown config origin type");
3758 const char *config_scope_name(enum config_scope scope)
3760 switch (scope) {
3761 case CONFIG_SCOPE_SYSTEM:
3762 return "system";
3763 case CONFIG_SCOPE_GLOBAL:
3764 return "global";
3765 case CONFIG_SCOPE_LOCAL:
3766 return "local";
3767 case CONFIG_SCOPE_WORKTREE:
3768 return "worktree";
3769 case CONFIG_SCOPE_COMMAND:
3770 return "command";
3771 case CONFIG_SCOPE_SUBMODULE:
3772 return "submodule";
3773 default:
3774 return "unknown";
3778 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3780 int i;
3782 for (i = 0; i < nr_mapping; i++) {
3783 const char *name = mapping[i];
3785 if (name && !strcasecmp(var, name))
3786 return i;
3788 return -1;