add-patch: handle splitting hunks with diff.suppressBlankEmpty
[git.git] / config.c
blob9ff6ae1cb903a0690295a7d5bb452ef5f35c12e1
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "git-compat-util.h"
9 #include "abspath.h"
10 #include "advice.h"
11 #include "date.h"
12 #include "branch.h"
13 #include "config.h"
14 #include "parse.h"
15 #include "convert.h"
16 #include "environment.h"
17 #include "gettext.h"
18 #include "ident.h"
19 #include "repository.h"
20 #include "lockfile.h"
21 #include "mailmap.h"
22 #include "attr.h"
23 #include "exec-cmd.h"
24 #include "strbuf.h"
25 #include "quote.h"
26 #include "hashmap.h"
27 #include "string-list.h"
28 #include "object-name.h"
29 #include "object-store-ll.h"
30 #include "pager.h"
31 #include "path.h"
32 #include "utf8.h"
33 #include "color.h"
34 #include "refs.h"
35 #include "setup.h"
36 #include "strvec.h"
37 #include "trace2.h"
38 #include "wildmatch.h"
39 #include "ws.h"
40 #include "write-or-die.h"
42 struct config_source {
43 struct config_source *prev;
44 union {
45 FILE *file;
46 struct config_buf {
47 const char *buf;
48 size_t len;
49 size_t pos;
50 } buf;
51 } u;
52 enum config_origin_type origin_type;
53 const char *name;
54 const char *path;
55 enum config_error_action default_error_action;
56 int linenr;
57 int eof;
58 size_t total_len;
59 struct strbuf value;
60 struct strbuf var;
61 unsigned subsection_case_sensitive : 1;
63 int (*do_fgetc)(struct config_source *c);
64 int (*do_ungetc)(int c, struct config_source *conf);
65 long (*do_ftell)(struct config_source *c);
67 #define CONFIG_SOURCE_INIT { 0 }
69 static int pack_compression_seen;
70 static int zlib_compression_seen;
73 * Config that comes from trusted scopes, namely:
74 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
75 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
76 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
78 * This is declared here for code cleanliness, but unlike the other
79 * static variables, this does not hold config parser state.
81 static struct config_set protected_config;
83 static int config_file_fgetc(struct config_source *conf)
85 return getc_unlocked(conf->u.file);
88 static int config_file_ungetc(int c, struct config_source *conf)
90 return ungetc(c, conf->u.file);
93 static long config_file_ftell(struct config_source *conf)
95 return ftell(conf->u.file);
99 static int config_buf_fgetc(struct config_source *conf)
101 if (conf->u.buf.pos < conf->u.buf.len)
102 return conf->u.buf.buf[conf->u.buf.pos++];
104 return EOF;
107 static int config_buf_ungetc(int c, struct config_source *conf)
109 if (conf->u.buf.pos > 0) {
110 conf->u.buf.pos--;
111 if (conf->u.buf.buf[conf->u.buf.pos] != c)
112 BUG("config_buf can only ungetc the same character");
113 return c;
116 return EOF;
119 static long config_buf_ftell(struct config_source *conf)
121 return conf->u.buf.pos;
124 struct config_include_data {
125 int depth;
126 config_fn_t fn;
127 void *data;
128 const struct config_options *opts;
129 struct git_config_source *config_source;
130 struct repository *repo;
133 * All remote URLs discovered when reading all config files.
135 struct string_list *remote_urls;
137 #define CONFIG_INCLUDE_INIT { 0 }
139 static int git_config_include(const char *var, const char *value,
140 const struct config_context *ctx, void *data);
142 #define MAX_INCLUDE_DEPTH 10
143 static const char include_depth_advice[] = N_(
144 "exceeded maximum include depth (%d) while including\n"
145 " %s\n"
146 "from\n"
147 " %s\n"
148 "This might be due to circular includes.");
149 static int handle_path_include(const struct key_value_info *kvi,
150 const char *path,
151 struct config_include_data *inc)
153 int ret = 0;
154 struct strbuf buf = STRBUF_INIT;
155 char *expanded;
157 if (!path)
158 return config_error_nonbool("include.path");
160 expanded = interpolate_path(path, 0);
161 if (!expanded)
162 return error(_("could not expand include path '%s'"), path);
163 path = expanded;
166 * Use an absolute path as-is, but interpret relative paths
167 * based on the including config file.
169 if (!is_absolute_path(path)) {
170 char *slash;
172 if (!kvi || !kvi->path) {
173 ret = error(_("relative config includes must come from files"));
174 goto cleanup;
177 slash = find_last_dir_sep(kvi->path);
178 if (slash)
179 strbuf_add(&buf, kvi->path, slash - kvi->path + 1);
180 strbuf_addstr(&buf, path);
181 path = buf.buf;
184 if (!access_or_die(path, R_OK, 0)) {
185 if (++inc->depth > MAX_INCLUDE_DEPTH)
186 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
187 !kvi ? "<unknown>" :
188 kvi->filename ? kvi->filename :
189 "the command line");
190 ret = git_config_from_file_with_options(git_config_include, path, inc,
191 kvi->scope, NULL);
192 inc->depth--;
194 cleanup:
195 strbuf_release(&buf);
196 free(expanded);
197 return ret;
200 static void add_trailing_starstar_for_dir(struct strbuf *pat)
202 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
203 strbuf_addstr(pat, "**");
206 static int prepare_include_condition_pattern(const struct key_value_info *kvi,
207 struct strbuf *pat)
209 struct strbuf path = STRBUF_INIT;
210 char *expanded;
211 int prefix = 0;
213 expanded = interpolate_path(pat->buf, 1);
214 if (expanded) {
215 strbuf_reset(pat);
216 strbuf_addstr(pat, expanded);
217 free(expanded);
220 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
221 const char *slash;
223 if (!kvi || !kvi->path)
224 return error(_("relative config include "
225 "conditionals must come from files"));
227 strbuf_realpath(&path, kvi->path, 1);
228 slash = find_last_dir_sep(path.buf);
229 if (!slash)
230 BUG("how is this possible?");
231 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
232 prefix = slash - path.buf + 1 /* slash */;
233 } else if (!is_absolute_path(pat->buf))
234 strbuf_insertstr(pat, 0, "**/");
236 add_trailing_starstar_for_dir(pat);
238 strbuf_release(&path);
239 return prefix;
242 static int include_by_gitdir(const struct key_value_info *kvi,
243 const struct config_options *opts,
244 const char *cond, size_t cond_len, int icase)
246 struct strbuf text = STRBUF_INIT;
247 struct strbuf pattern = STRBUF_INIT;
248 int ret = 0, prefix;
249 const char *git_dir;
250 int already_tried_absolute = 0;
252 if (opts->git_dir)
253 git_dir = opts->git_dir;
254 else
255 goto done;
257 strbuf_realpath(&text, git_dir, 1);
258 strbuf_add(&pattern, cond, cond_len);
259 prefix = prepare_include_condition_pattern(kvi, &pattern);
261 again:
262 if (prefix < 0)
263 goto done;
265 if (prefix > 0) {
267 * perform literal matching on the prefix part so that
268 * any wildcard character in it can't create side effects.
270 if (text.len < prefix)
271 goto done;
272 if (!icase && strncmp(pattern.buf, text.buf, prefix))
273 goto done;
274 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
275 goto done;
278 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
279 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
281 if (!ret && !already_tried_absolute) {
283 * We've tried e.g. matching gitdir:~/work, but if
284 * ~/work is a symlink to /mnt/storage/work
285 * strbuf_realpath() will expand it, so the rule won't
286 * match. Let's match against a
287 * strbuf_add_absolute_path() version of the path,
288 * which'll do the right thing
290 strbuf_reset(&text);
291 strbuf_add_absolute_path(&text, git_dir);
292 already_tried_absolute = 1;
293 goto again;
295 done:
296 strbuf_release(&pattern);
297 strbuf_release(&text);
298 return ret;
301 static int include_by_branch(const char *cond, size_t cond_len)
303 int flags;
304 int ret;
305 struct strbuf pattern = STRBUF_INIT;
306 const char *refname = !the_repository->gitdir ?
307 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
308 const char *shortname;
310 if (!refname || !(flags & REF_ISSYMREF) ||
311 !skip_prefix(refname, "refs/heads/", &shortname))
312 return 0;
314 strbuf_add(&pattern, cond, cond_len);
315 add_trailing_starstar_for_dir(&pattern);
316 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
317 strbuf_release(&pattern);
318 return ret;
321 static int add_remote_url(const char *var, const char *value,
322 const struct config_context *ctx UNUSED, void *data)
324 struct string_list *remote_urls = data;
325 const char *remote_name;
326 size_t remote_name_len;
327 const char *key;
329 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
330 &key) &&
331 remote_name &&
332 !strcmp(key, "url"))
333 string_list_append(remote_urls, value);
334 return 0;
337 static void populate_remote_urls(struct config_include_data *inc)
339 struct config_options opts;
341 opts = *inc->opts;
342 opts.unconditional_remote_url = 1;
344 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
345 string_list_init_dup(inc->remote_urls);
346 config_with_options(add_remote_url, inc->remote_urls,
347 inc->config_source, inc->repo, &opts);
350 static int forbid_remote_url(const char *var, const char *value UNUSED,
351 const struct config_context *ctx UNUSED,
352 void *data UNUSED)
354 const char *remote_name;
355 size_t remote_name_len;
356 const char *key;
358 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
359 &key) &&
360 remote_name &&
361 !strcmp(key, "url"))
362 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
363 return 0;
366 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
367 struct string_list *remote_urls)
369 struct strbuf pattern = STRBUF_INIT;
370 struct string_list_item *url_item;
371 int found = 0;
373 strbuf_add(&pattern, glob, glob_len);
374 for_each_string_list_item(url_item, remote_urls) {
375 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
376 found = 1;
377 break;
380 strbuf_release(&pattern);
381 return found;
384 static int include_by_remote_url(struct config_include_data *inc,
385 const char *cond, size_t cond_len)
387 if (inc->opts->unconditional_remote_url)
388 return 1;
389 if (!inc->remote_urls)
390 populate_remote_urls(inc);
391 return at_least_one_url_matches_glob(cond, cond_len,
392 inc->remote_urls);
395 static int include_condition_is_true(const struct key_value_info *kvi,
396 struct config_include_data *inc,
397 const char *cond, size_t cond_len)
399 const struct config_options *opts = inc->opts;
401 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
402 return include_by_gitdir(kvi, opts, cond, cond_len, 0);
403 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
404 return include_by_gitdir(kvi, opts, cond, cond_len, 1);
405 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
406 return include_by_branch(cond, cond_len);
407 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
408 &cond_len))
409 return include_by_remote_url(inc, cond, cond_len);
411 /* unknown conditionals are always false */
412 return 0;
415 static int git_config_include(const char *var, const char *value,
416 const struct config_context *ctx,
417 void *data)
419 struct config_include_data *inc = data;
420 const char *cond, *key;
421 size_t cond_len;
422 int ret;
425 * Pass along all values, including "include" directives; this makes it
426 * possible to query information on the includes themselves.
428 ret = inc->fn(var, value, ctx, inc->data);
429 if (ret < 0)
430 return ret;
432 if (!strcmp(var, "include.path"))
433 ret = handle_path_include(ctx->kvi, value, inc);
435 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
436 cond && include_condition_is_true(ctx->kvi, inc, cond, cond_len) &&
437 !strcmp(key, "path")) {
438 config_fn_t old_fn = inc->fn;
440 if (inc->opts->unconditional_remote_url)
441 inc->fn = forbid_remote_url;
442 ret = handle_path_include(ctx->kvi, value, inc);
443 inc->fn = old_fn;
446 return ret;
449 static void git_config_push_split_parameter(const char *key, const char *value)
451 struct strbuf env = STRBUF_INIT;
452 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
453 if (old && *old) {
454 strbuf_addstr(&env, old);
455 strbuf_addch(&env, ' ');
457 sq_quote_buf(&env, key);
458 strbuf_addch(&env, '=');
459 if (value)
460 sq_quote_buf(&env, value);
461 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
462 strbuf_release(&env);
465 void git_config_push_parameter(const char *text)
467 const char *value;
470 * When we see:
472 * section.subsection=with=equals.key=value
474 * we cannot tell if it means:
476 * [section "subsection=with=equals"]
477 * key = value
479 * or:
481 * [section]
482 * subsection = with=equals.key=value
484 * We parse left-to-right for the first "=", meaning we'll prefer to
485 * keep the value intact over the subsection. This is historical, but
486 * also sensible since values are more likely to contain odd or
487 * untrusted input than a section name.
489 * A missing equals is explicitly allowed (as a bool-only entry).
491 value = strchr(text, '=');
492 if (value) {
493 char *key = xmemdupz(text, value - text);
494 git_config_push_split_parameter(key, value + 1);
495 free(key);
496 } else {
497 git_config_push_split_parameter(text, NULL);
501 void git_config_push_env(const char *spec)
503 char *key;
504 const char *env_name;
505 const char *env_value;
507 env_name = strrchr(spec, '=');
508 if (!env_name)
509 die(_("invalid config format: %s"), spec);
510 key = xmemdupz(spec, env_name - spec);
511 env_name++;
512 if (!*env_name)
513 die(_("missing environment variable name for configuration '%.*s'"),
514 (int)(env_name - spec - 1), spec);
516 env_value = getenv(env_name);
517 if (!env_value)
518 die(_("missing environment variable '%s' for configuration '%.*s'"),
519 env_name, (int)(env_name - spec - 1), spec);
521 git_config_push_split_parameter(key, env_value);
522 free(key);
525 static inline int iskeychar(int c)
527 return isalnum(c) || c == '-';
531 * Auxiliary function to sanity-check and split the key into the section
532 * identifier and variable name.
534 * Returns 0 on success, -1 when there is an invalid character in the key and
535 * -2 if there is no section name in the key.
537 * store_key - pointer to char* which will hold a copy of the key with
538 * lowercase section and variable name
539 * baselen - pointer to size_t which will hold the length of the
540 * section + subsection part, can be NULL
542 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
544 size_t i, baselen;
545 int dot;
546 const char *last_dot = strrchr(key, '.');
549 * Since "key" actually contains the section name and the real
550 * key name separated by a dot, we have to know where the dot is.
553 if (last_dot == NULL || last_dot == key) {
554 error(_("key does not contain a section: %s"), key);
555 return -CONFIG_NO_SECTION_OR_NAME;
558 if (!last_dot[1]) {
559 error(_("key does not contain variable name: %s"), key);
560 return -CONFIG_NO_SECTION_OR_NAME;
563 baselen = last_dot - key;
564 if (baselen_)
565 *baselen_ = baselen;
568 * Validate the key and while at it, lower case it for matching.
570 *store_key = xmallocz(strlen(key));
572 dot = 0;
573 for (i = 0; key[i]; i++) {
574 unsigned char c = key[i];
575 if (c == '.')
576 dot = 1;
577 /* Leave the extended basename untouched.. */
578 if (!dot || i > baselen) {
579 if (!iskeychar(c) ||
580 (i == baselen + 1 && !isalpha(c))) {
581 error(_("invalid key: %s"), key);
582 goto out_free_ret_1;
584 c = tolower(c);
585 } else if (c == '\n') {
586 error(_("invalid key (newline): %s"), key);
587 goto out_free_ret_1;
589 (*store_key)[i] = c;
592 return 0;
594 out_free_ret_1:
595 FREE_AND_NULL(*store_key);
596 return -CONFIG_INVALID_KEY;
599 static int config_parse_pair(const char *key, const char *value,
600 struct key_value_info *kvi,
601 config_fn_t fn, void *data)
603 char *canonical_name;
604 int ret;
605 struct config_context ctx = {
606 .kvi = kvi,
609 if (!strlen(key))
610 return error(_("empty config key"));
611 if (git_config_parse_key(key, &canonical_name, NULL))
612 return -1;
614 ret = (fn(canonical_name, value, &ctx, data) < 0) ? -1 : 0;
615 free(canonical_name);
616 return ret;
620 /* for values read from `git_config_from_parameters()` */
621 void kvi_from_param(struct key_value_info *out)
623 out->filename = NULL;
624 out->linenr = -1;
625 out->origin_type = CONFIG_ORIGIN_CMDLINE;
626 out->scope = CONFIG_SCOPE_COMMAND;
627 out->path = NULL;
630 int git_config_parse_parameter(const char *text,
631 config_fn_t fn, void *data)
633 const char *value;
634 struct strbuf **pair;
635 int ret;
636 struct key_value_info kvi = KVI_INIT;
638 kvi_from_param(&kvi);
640 pair = strbuf_split_str(text, '=', 2);
641 if (!pair[0])
642 return error(_("bogus config parameter: %s"), text);
644 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
645 strbuf_setlen(pair[0], pair[0]->len - 1);
646 value = pair[1] ? pair[1]->buf : "";
647 } else {
648 value = NULL;
651 strbuf_trim(pair[0]);
652 if (!pair[0]->len) {
653 strbuf_list_free(pair);
654 return error(_("bogus config parameter: %s"), text);
657 ret = config_parse_pair(pair[0]->buf, value, &kvi, fn, data);
658 strbuf_list_free(pair);
659 return ret;
662 static int parse_config_env_list(char *env, struct key_value_info *kvi,
663 config_fn_t fn, void *data)
665 char *cur = env;
666 while (cur && *cur) {
667 const char *key = sq_dequote_step(cur, &cur);
668 if (!key)
669 return error(_("bogus format in %s"),
670 CONFIG_DATA_ENVIRONMENT);
672 if (!cur || isspace(*cur)) {
673 /* old-style 'key=value' */
674 if (git_config_parse_parameter(key, fn, data) < 0)
675 return -1;
677 else if (*cur == '=') {
678 /* new-style 'key'='value' */
679 const char *value;
681 cur++;
682 if (*cur == '\'') {
683 /* quoted value */
684 value = sq_dequote_step(cur, &cur);
685 if (!value || (cur && !isspace(*cur))) {
686 return error(_("bogus format in %s"),
687 CONFIG_DATA_ENVIRONMENT);
689 } else if (!*cur || isspace(*cur)) {
690 /* implicit bool: 'key'= */
691 value = NULL;
692 } else {
693 return error(_("bogus format in %s"),
694 CONFIG_DATA_ENVIRONMENT);
697 if (config_parse_pair(key, value, kvi, fn, data) < 0)
698 return -1;
700 else {
701 /* unknown format */
702 return error(_("bogus format in %s"),
703 CONFIG_DATA_ENVIRONMENT);
706 if (cur) {
707 while (isspace(*cur))
708 cur++;
711 return 0;
714 int git_config_from_parameters(config_fn_t fn, void *data)
716 const char *env;
717 struct strbuf envvar = STRBUF_INIT;
718 struct strvec to_free = STRVEC_INIT;
719 int ret = 0;
720 char *envw = NULL;
721 struct key_value_info kvi = KVI_INIT;
723 kvi_from_param(&kvi);
724 env = getenv(CONFIG_COUNT_ENVIRONMENT);
725 if (env) {
726 unsigned long count;
727 char *endp;
728 int i;
730 count = strtoul(env, &endp, 10);
731 if (*endp) {
732 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
733 goto out;
735 if (count > INT_MAX) {
736 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
737 goto out;
740 for (i = 0; i < count; i++) {
741 const char *key, *value;
743 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
744 key = getenv_safe(&to_free, envvar.buf);
745 if (!key) {
746 ret = error(_("missing config key %s"), envvar.buf);
747 goto out;
749 strbuf_reset(&envvar);
751 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
752 value = getenv_safe(&to_free, envvar.buf);
753 if (!value) {
754 ret = error(_("missing config value %s"), envvar.buf);
755 goto out;
757 strbuf_reset(&envvar);
759 if (config_parse_pair(key, value, &kvi, fn, data) < 0) {
760 ret = -1;
761 goto out;
766 env = getenv(CONFIG_DATA_ENVIRONMENT);
767 if (env) {
768 /* sq_dequote will write over it */
769 envw = xstrdup(env);
770 if (parse_config_env_list(envw, &kvi, fn, data) < 0) {
771 ret = -1;
772 goto out;
776 out:
777 strbuf_release(&envvar);
778 strvec_clear(&to_free);
779 free(envw);
780 return ret;
783 static int get_next_char(struct config_source *cs)
785 int c = cs->do_fgetc(cs);
787 if (c == '\r') {
788 /* DOS like systems */
789 c = cs->do_fgetc(cs);
790 if (c != '\n') {
791 if (c != EOF)
792 cs->do_ungetc(c, cs);
793 c = '\r';
797 if (c != EOF && ++cs->total_len > INT_MAX) {
799 * This is an absurdly long config file; refuse to parse
800 * further in order to protect downstream code from integer
801 * overflows. Note that we can't return an error specifically,
802 * but we can mark EOF and put trash in the return value,
803 * which will trigger a parse error.
805 cs->eof = 1;
806 return 0;
809 if (c == '\n')
810 cs->linenr++;
811 if (c == EOF) {
812 cs->eof = 1;
813 cs->linenr++;
814 c = '\n';
816 return c;
819 static char *parse_value(struct config_source *cs)
821 int quote = 0, comment = 0, space = 0;
823 strbuf_reset(&cs->value);
824 for (;;) {
825 int c = get_next_char(cs);
826 if (c == '\n') {
827 if (quote) {
828 cs->linenr--;
829 return NULL;
831 return cs->value.buf;
833 if (comment)
834 continue;
835 if (isspace(c) && !quote) {
836 if (cs->value.len)
837 space++;
838 continue;
840 if (!quote) {
841 if (c == ';' || c == '#') {
842 comment = 1;
843 continue;
846 for (; space; space--)
847 strbuf_addch(&cs->value, ' ');
848 if (c == '\\') {
849 c = get_next_char(cs);
850 switch (c) {
851 case '\n':
852 continue;
853 case 't':
854 c = '\t';
855 break;
856 case 'b':
857 c = '\b';
858 break;
859 case 'n':
860 c = '\n';
861 break;
862 /* Some characters escape as themselves */
863 case '\\': case '"':
864 break;
865 /* Reject unknown escape sequences */
866 default:
867 return NULL;
869 strbuf_addch(&cs->value, c);
870 continue;
872 if (c == '"') {
873 quote = 1-quote;
874 continue;
876 strbuf_addch(&cs->value, c);
880 static int get_value(struct config_source *cs, struct key_value_info *kvi,
881 config_fn_t fn, void *data, struct strbuf *name)
883 int c;
884 char *value;
885 int ret;
886 struct config_context ctx = {
887 .kvi = kvi,
890 /* Get the full name */
891 for (;;) {
892 c = get_next_char(cs);
893 if (cs->eof)
894 break;
895 if (!iskeychar(c))
896 break;
897 strbuf_addch(name, tolower(c));
900 while (c == ' ' || c == '\t')
901 c = get_next_char(cs);
903 value = NULL;
904 if (c != '\n') {
905 if (c != '=')
906 return -1;
907 value = parse_value(cs);
908 if (!value)
909 return -1;
912 * We already consumed the \n, but we need linenr to point to
913 * the line we just parsed during the call to fn to get
914 * accurate line number in error messages.
916 cs->linenr--;
917 kvi->linenr = cs->linenr;
918 ret = fn(name->buf, value, &ctx, data);
919 if (ret >= 0)
920 cs->linenr++;
921 return ret;
924 static int get_extended_base_var(struct config_source *cs, struct strbuf *name,
925 int c)
927 cs->subsection_case_sensitive = 0;
928 do {
929 if (c == '\n')
930 goto error_incomplete_line;
931 c = get_next_char(cs);
932 } while (isspace(c));
934 /* We require the format to be '[base "extension"]' */
935 if (c != '"')
936 return -1;
937 strbuf_addch(name, '.');
939 for (;;) {
940 int c = get_next_char(cs);
941 if (c == '\n')
942 goto error_incomplete_line;
943 if (c == '"')
944 break;
945 if (c == '\\') {
946 c = get_next_char(cs);
947 if (c == '\n')
948 goto error_incomplete_line;
950 strbuf_addch(name, c);
953 /* Final ']' */
954 if (get_next_char(cs) != ']')
955 return -1;
956 return 0;
957 error_incomplete_line:
958 cs->linenr--;
959 return -1;
962 static int get_base_var(struct config_source *cs, struct strbuf *name)
964 cs->subsection_case_sensitive = 1;
965 for (;;) {
966 int c = get_next_char(cs);
967 if (cs->eof)
968 return -1;
969 if (c == ']')
970 return 0;
971 if (isspace(c))
972 return get_extended_base_var(cs, name, c);
973 if (!iskeychar(c) && c != '.')
974 return -1;
975 strbuf_addch(name, tolower(c));
979 struct parse_event_data {
980 enum config_event_t previous_type;
981 size_t previous_offset;
982 const struct config_options *opts;
985 static int do_event(struct config_source *cs, enum config_event_t type,
986 struct parse_event_data *data)
988 size_t offset;
990 if (!data->opts || !data->opts->event_fn)
991 return 0;
993 if (type == CONFIG_EVENT_WHITESPACE &&
994 data->previous_type == type)
995 return 0;
997 offset = cs->do_ftell(cs);
999 * At EOF, the parser always "inserts" an extra '\n', therefore
1000 * the end offset of the event is the current file position, otherwise
1001 * we will already have advanced to the next event.
1003 if (type != CONFIG_EVENT_EOF)
1004 offset--;
1006 if (data->previous_type != CONFIG_EVENT_EOF &&
1007 data->opts->event_fn(data->previous_type, data->previous_offset,
1008 offset, cs, data->opts->event_fn_data) < 0)
1009 return -1;
1011 data->previous_type = type;
1012 data->previous_offset = offset;
1014 return 0;
1017 static void kvi_from_source(struct config_source *cs,
1018 enum config_scope scope,
1019 struct key_value_info *out)
1021 out->filename = strintern(cs->name);
1022 out->origin_type = cs->origin_type;
1023 out->linenr = cs->linenr;
1024 out->scope = scope;
1025 out->path = cs->path;
1028 static int git_parse_source(struct config_source *cs, config_fn_t fn,
1029 struct key_value_info *kvi, void *data,
1030 const struct config_options *opts)
1032 int comment = 0;
1033 size_t baselen = 0;
1034 struct strbuf *var = &cs->var;
1035 int error_return = 0;
1036 char *error_msg = NULL;
1038 /* U+FEFF Byte Order Mark in UTF8 */
1039 const char *bomptr = utf8_bom;
1041 /* For the parser event callback */
1042 struct parse_event_data event_data = {
1043 CONFIG_EVENT_EOF, 0, opts
1046 for (;;) {
1047 int c;
1049 c = get_next_char(cs);
1050 if (bomptr && *bomptr) {
1051 /* We are at the file beginning; skip UTF8-encoded BOM
1052 * if present. Sane editors won't put this in on their
1053 * own, but e.g. Windows Notepad will do it happily. */
1054 if (c == (*bomptr & 0377)) {
1055 bomptr++;
1056 continue;
1057 } else {
1058 /* Do not tolerate partial BOM. */
1059 if (bomptr != utf8_bom)
1060 break;
1061 /* No BOM at file beginning. Cool. */
1062 bomptr = NULL;
1065 if (c == '\n') {
1066 if (cs->eof) {
1067 if (do_event(cs, CONFIG_EVENT_EOF, &event_data) < 0)
1068 return -1;
1069 return 0;
1071 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1072 return -1;
1073 comment = 0;
1074 continue;
1076 if (comment)
1077 continue;
1078 if (isspace(c)) {
1079 if (do_event(cs, CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1080 return -1;
1081 continue;
1083 if (c == '#' || c == ';') {
1084 if (do_event(cs, CONFIG_EVENT_COMMENT, &event_data) < 0)
1085 return -1;
1086 comment = 1;
1087 continue;
1089 if (c == '[') {
1090 if (do_event(cs, CONFIG_EVENT_SECTION, &event_data) < 0)
1091 return -1;
1093 /* Reset prior to determining a new stem */
1094 strbuf_reset(var);
1095 if (get_base_var(cs, var) < 0 || var->len < 1)
1096 break;
1097 strbuf_addch(var, '.');
1098 baselen = var->len;
1099 continue;
1101 if (!isalpha(c))
1102 break;
1104 if (do_event(cs, CONFIG_EVENT_ENTRY, &event_data) < 0)
1105 return -1;
1108 * Truncate the var name back to the section header
1109 * stem prior to grabbing the suffix part of the name
1110 * and the value.
1112 strbuf_setlen(var, baselen);
1113 strbuf_addch(var, tolower(c));
1114 if (get_value(cs, kvi, fn, data, var) < 0)
1115 break;
1118 if (do_event(cs, CONFIG_EVENT_ERROR, &event_data) < 0)
1119 return -1;
1121 switch (cs->origin_type) {
1122 case CONFIG_ORIGIN_BLOB:
1123 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1124 cs->linenr, cs->name);
1125 break;
1126 case CONFIG_ORIGIN_FILE:
1127 error_msg = xstrfmt(_("bad config line %d in file %s"),
1128 cs->linenr, cs->name);
1129 break;
1130 case CONFIG_ORIGIN_STDIN:
1131 error_msg = xstrfmt(_("bad config line %d in standard input"),
1132 cs->linenr);
1133 break;
1134 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1135 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1136 cs->linenr, cs->name);
1137 break;
1138 case CONFIG_ORIGIN_CMDLINE:
1139 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1140 cs->linenr, cs->name);
1141 break;
1142 default:
1143 error_msg = xstrfmt(_("bad config line %d in %s"),
1144 cs->linenr, cs->name);
1147 switch (opts && opts->error_action ?
1148 opts->error_action :
1149 cs->default_error_action) {
1150 case CONFIG_ERROR_DIE:
1151 die("%s", error_msg);
1152 break;
1153 case CONFIG_ERROR_ERROR:
1154 error_return = error("%s", error_msg);
1155 break;
1156 case CONFIG_ERROR_SILENT:
1157 error_return = -1;
1158 break;
1159 case CONFIG_ERROR_UNSET:
1160 BUG("config error action unset");
1163 free(error_msg);
1164 return error_return;
1167 NORETURN
1168 static void die_bad_number(const char *name, const char *value,
1169 const struct key_value_info *kvi)
1171 const char *error_type = (errno == ERANGE) ?
1172 N_("out of range") : N_("invalid unit");
1173 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1175 if (!kvi)
1176 BUG("kvi should not be NULL");
1178 if (!value)
1179 value = "";
1181 if (!kvi->filename)
1182 die(_(bad_numeric), value, name, _(error_type));
1184 switch (kvi->origin_type) {
1185 case CONFIG_ORIGIN_BLOB:
1186 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1187 value, name, kvi->filename, _(error_type));
1188 case CONFIG_ORIGIN_FILE:
1189 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1190 value, name, kvi->filename, _(error_type));
1191 case CONFIG_ORIGIN_STDIN:
1192 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1193 value, name, _(error_type));
1194 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1195 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1196 value, name, kvi->filename, _(error_type));
1197 case CONFIG_ORIGIN_CMDLINE:
1198 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1199 value, name, kvi->filename, _(error_type));
1200 default:
1201 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1202 value, name, kvi->filename, _(error_type));
1206 int git_config_int(const char *name, const char *value,
1207 const struct key_value_info *kvi)
1209 int ret;
1210 if (!git_parse_int(value, &ret))
1211 die_bad_number(name, value, kvi);
1212 return ret;
1215 int64_t git_config_int64(const char *name, const char *value,
1216 const struct key_value_info *kvi)
1218 int64_t ret;
1219 if (!git_parse_int64(value, &ret))
1220 die_bad_number(name, value, kvi);
1221 return ret;
1224 unsigned long git_config_ulong(const char *name, const char *value,
1225 const struct key_value_info *kvi)
1227 unsigned long ret;
1228 if (!git_parse_ulong(value, &ret))
1229 die_bad_number(name, value, kvi);
1230 return ret;
1233 ssize_t git_config_ssize_t(const char *name, const char *value,
1234 const struct key_value_info *kvi)
1236 ssize_t ret;
1237 if (!git_parse_ssize_t(value, &ret))
1238 die_bad_number(name, value, kvi);
1239 return ret;
1242 static const struct fsync_component_name {
1243 const char *name;
1244 enum fsync_component component_bits;
1245 } fsync_component_names[] = {
1246 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1247 { "pack", FSYNC_COMPONENT_PACK },
1248 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1249 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1250 { "index", FSYNC_COMPONENT_INDEX },
1251 { "objects", FSYNC_COMPONENTS_OBJECTS },
1252 { "reference", FSYNC_COMPONENT_REFERENCE },
1253 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1254 { "committed", FSYNC_COMPONENTS_COMMITTED },
1255 { "added", FSYNC_COMPONENTS_ADDED },
1256 { "all", FSYNC_COMPONENTS_ALL },
1259 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1261 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1262 enum fsync_component positive = 0, negative = 0;
1264 while (string) {
1265 int i;
1266 size_t len;
1267 const char *ep;
1268 int negated = 0;
1269 int found = 0;
1271 string = string + strspn(string, ", \t\n\r");
1272 ep = strchrnul(string, ',');
1273 len = ep - string;
1274 if (!strcmp(string, "none")) {
1275 current = FSYNC_COMPONENT_NONE;
1276 goto next_name;
1279 if (*string == '-') {
1280 negated = 1;
1281 string++;
1282 len--;
1283 if (!len)
1284 warning(_("invalid value for variable %s"), var);
1287 if (!len)
1288 break;
1290 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1291 const struct fsync_component_name *n = &fsync_component_names[i];
1293 if (strncmp(n->name, string, len))
1294 continue;
1296 found = 1;
1297 if (negated)
1298 negative |= n->component_bits;
1299 else
1300 positive |= n->component_bits;
1303 if (!found) {
1304 char *component = xstrndup(string, len);
1305 warning(_("ignoring unknown core.fsync component '%s'"), component);
1306 free(component);
1309 next_name:
1310 string = ep;
1313 return (current & ~negative) | positive;
1316 int git_config_bool_or_int(const char *name, const char *value,
1317 const struct key_value_info *kvi, int *is_bool)
1319 int v = git_parse_maybe_bool_text(value);
1320 if (0 <= v) {
1321 *is_bool = 1;
1322 return v;
1324 *is_bool = 0;
1325 return git_config_int(name, value, kvi);
1328 int git_config_bool(const char *name, const char *value)
1330 int v = git_parse_maybe_bool(value);
1331 if (v < 0)
1332 die(_("bad boolean config value '%s' for '%s'"), value, name);
1333 return v;
1336 int git_config_string(const char **dest, const char *var, const char *value)
1338 if (!value)
1339 return config_error_nonbool(var);
1340 *dest = xstrdup(value);
1341 return 0;
1344 int git_config_pathname(const char **dest, const char *var, const char *value)
1346 if (!value)
1347 return config_error_nonbool(var);
1348 *dest = interpolate_path(value, 0);
1349 if (!*dest)
1350 die(_("failed to expand user dir in: '%s'"), value);
1351 return 0;
1354 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1356 if (!value)
1357 return config_error_nonbool(var);
1358 if (parse_expiry_date(value, timestamp))
1359 return error(_("'%s' for '%s' is not a valid timestamp"),
1360 value, var);
1361 return 0;
1364 int git_config_color(char *dest, const char *var, const char *value)
1366 if (!value)
1367 return config_error_nonbool(var);
1368 if (color_parse(value, dest) < 0)
1369 return -1;
1370 return 0;
1373 static int git_default_core_config(const char *var, const char *value,
1374 const struct config_context *ctx, void *cb)
1376 /* This needs a better name */
1377 if (!strcmp(var, "core.filemode")) {
1378 trust_executable_bit = git_config_bool(var, value);
1379 return 0;
1381 if (!strcmp(var, "core.trustctime")) {
1382 trust_ctime = git_config_bool(var, value);
1383 return 0;
1385 if (!strcmp(var, "core.checkstat")) {
1386 if (!value)
1387 return config_error_nonbool(var);
1388 if (!strcasecmp(value, "default"))
1389 check_stat = 1;
1390 else if (!strcasecmp(value, "minimal"))
1391 check_stat = 0;
1392 else
1393 return error(_("invalid value for '%s': '%s'"),
1394 var, value);
1397 if (!strcmp(var, "core.quotepath")) {
1398 quote_path_fully = git_config_bool(var, value);
1399 return 0;
1402 if (!strcmp(var, "core.symlinks")) {
1403 has_symlinks = git_config_bool(var, value);
1404 return 0;
1407 if (!strcmp(var, "core.ignorecase")) {
1408 ignore_case = git_config_bool(var, value);
1409 return 0;
1412 if (!strcmp(var, "core.attributesfile"))
1413 return git_config_pathname(&git_attributes_file, var, value);
1415 if (!strcmp(var, "core.hookspath"))
1416 return git_config_pathname(&git_hooks_path, var, value);
1418 if (!strcmp(var, "core.bare")) {
1419 is_bare_repository_cfg = git_config_bool(var, value);
1420 return 0;
1423 if (!strcmp(var, "core.ignorestat")) {
1424 assume_unchanged = git_config_bool(var, value);
1425 return 0;
1428 if (!strcmp(var, "core.prefersymlinkrefs")) {
1429 prefer_symlink_refs = git_config_bool(var, value);
1430 return 0;
1433 if (!strcmp(var, "core.logallrefupdates")) {
1434 if (value && !strcasecmp(value, "always"))
1435 log_all_ref_updates = LOG_REFS_ALWAYS;
1436 else if (git_config_bool(var, value))
1437 log_all_ref_updates = LOG_REFS_NORMAL;
1438 else
1439 log_all_ref_updates = LOG_REFS_NONE;
1440 return 0;
1443 if (!strcmp(var, "core.warnambiguousrefs")) {
1444 warn_ambiguous_refs = git_config_bool(var, value);
1445 return 0;
1448 if (!strcmp(var, "core.abbrev")) {
1449 if (!value)
1450 return config_error_nonbool(var);
1451 if (!strcasecmp(value, "auto"))
1452 default_abbrev = -1;
1453 else if (!git_parse_maybe_bool_text(value))
1454 default_abbrev = the_hash_algo->hexsz;
1455 else {
1456 int abbrev = git_config_int(var, value, ctx->kvi);
1457 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1458 return error(_("abbrev length out of range: %d"), abbrev);
1459 default_abbrev = abbrev;
1461 return 0;
1464 if (!strcmp(var, "core.disambiguate"))
1465 return set_disambiguate_hint_config(var, value);
1467 if (!strcmp(var, "core.loosecompression")) {
1468 int level = git_config_int(var, value, ctx->kvi);
1469 if (level == -1)
1470 level = Z_DEFAULT_COMPRESSION;
1471 else if (level < 0 || level > Z_BEST_COMPRESSION)
1472 die(_("bad zlib compression level %d"), level);
1473 zlib_compression_level = level;
1474 zlib_compression_seen = 1;
1475 return 0;
1478 if (!strcmp(var, "core.compression")) {
1479 int level = git_config_int(var, value, ctx->kvi);
1480 if (level == -1)
1481 level = Z_DEFAULT_COMPRESSION;
1482 else if (level < 0 || level > Z_BEST_COMPRESSION)
1483 die(_("bad zlib compression level %d"), level);
1484 if (!zlib_compression_seen)
1485 zlib_compression_level = level;
1486 if (!pack_compression_seen)
1487 pack_compression_level = level;
1488 return 0;
1491 if (!strcmp(var, "core.packedgitwindowsize")) {
1492 int pgsz_x2 = getpagesize() * 2;
1493 packed_git_window_size = git_config_ulong(var, value, ctx->kvi);
1495 /* This value must be multiple of (pagesize * 2) */
1496 packed_git_window_size /= pgsz_x2;
1497 if (packed_git_window_size < 1)
1498 packed_git_window_size = 1;
1499 packed_git_window_size *= pgsz_x2;
1500 return 0;
1503 if (!strcmp(var, "core.bigfilethreshold")) {
1504 big_file_threshold = git_config_ulong(var, value, ctx->kvi);
1505 return 0;
1508 if (!strcmp(var, "core.packedgitlimit")) {
1509 packed_git_limit = git_config_ulong(var, value, ctx->kvi);
1510 return 0;
1513 if (!strcmp(var, "core.deltabasecachelimit")) {
1514 delta_base_cache_limit = git_config_ulong(var, value, ctx->kvi);
1515 return 0;
1518 if (!strcmp(var, "core.autocrlf")) {
1519 if (value && !strcasecmp(value, "input")) {
1520 auto_crlf = AUTO_CRLF_INPUT;
1521 return 0;
1523 auto_crlf = git_config_bool(var, value);
1524 return 0;
1527 if (!strcmp(var, "core.safecrlf")) {
1528 int eol_rndtrp_die;
1529 if (value && !strcasecmp(value, "warn")) {
1530 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1531 return 0;
1533 eol_rndtrp_die = git_config_bool(var, value);
1534 global_conv_flags_eol = eol_rndtrp_die ?
1535 CONV_EOL_RNDTRP_DIE : 0;
1536 return 0;
1539 if (!strcmp(var, "core.eol")) {
1540 if (value && !strcasecmp(value, "lf"))
1541 core_eol = EOL_LF;
1542 else if (value && !strcasecmp(value, "crlf"))
1543 core_eol = EOL_CRLF;
1544 else if (value && !strcasecmp(value, "native"))
1545 core_eol = EOL_NATIVE;
1546 else
1547 core_eol = EOL_UNSET;
1548 return 0;
1551 if (!strcmp(var, "core.checkroundtripencoding"))
1552 return git_config_string(&check_roundtrip_encoding, var, value);
1554 if (!strcmp(var, "core.notesref")) {
1555 if (!value)
1556 return config_error_nonbool(var);
1557 notes_ref_name = xstrdup(value);
1558 return 0;
1561 if (!strcmp(var, "core.editor"))
1562 return git_config_string(&editor_program, var, value);
1564 if (!strcmp(var, "core.commentchar")) {
1565 if (!value)
1566 return config_error_nonbool(var);
1567 else if (!strcasecmp(value, "auto"))
1568 auto_comment_line_char = 1;
1569 else if (value[0] && !value[1]) {
1570 comment_line_char = value[0];
1571 auto_comment_line_char = 0;
1572 } else
1573 return error(_("core.commentChar should only be one ASCII character"));
1574 return 0;
1577 if (!strcmp(var, "core.askpass"))
1578 return git_config_string(&askpass_program, var, value);
1580 if (!strcmp(var, "core.excludesfile"))
1581 return git_config_pathname(&excludes_file, var, value);
1583 if (!strcmp(var, "core.whitespace")) {
1584 if (!value)
1585 return config_error_nonbool(var);
1586 whitespace_rule_cfg = parse_whitespace_rule(value);
1587 return 0;
1590 if (!strcmp(var, "core.fsync")) {
1591 if (!value)
1592 return config_error_nonbool(var);
1593 fsync_components = parse_fsync_components(var, value);
1594 return 0;
1597 if (!strcmp(var, "core.fsyncmethod")) {
1598 if (!value)
1599 return config_error_nonbool(var);
1600 if (!strcmp(value, "fsync"))
1601 fsync_method = FSYNC_METHOD_FSYNC;
1602 else if (!strcmp(value, "writeout-only"))
1603 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1604 else if (!strcmp(value, "batch"))
1605 fsync_method = FSYNC_METHOD_BATCH;
1606 else
1607 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1611 if (!strcmp(var, "core.fsyncobjectfiles")) {
1612 if (fsync_object_files < 0)
1613 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1614 fsync_object_files = git_config_bool(var, value);
1615 return 0;
1618 if (!strcmp(var, "core.preloadindex")) {
1619 core_preload_index = git_config_bool(var, value);
1620 return 0;
1623 if (!strcmp(var, "core.createobject")) {
1624 if (!value)
1625 return config_error_nonbool(var);
1626 if (!strcmp(value, "rename"))
1627 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1628 else if (!strcmp(value, "link"))
1629 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1630 else
1631 die(_("invalid mode for object creation: %s"), value);
1632 return 0;
1635 if (!strcmp(var, "core.sparsecheckout")) {
1636 core_apply_sparse_checkout = git_config_bool(var, value);
1637 return 0;
1640 if (!strcmp(var, "core.sparsecheckoutcone")) {
1641 core_sparse_checkout_cone = git_config_bool(var, value);
1642 return 0;
1645 if (!strcmp(var, "core.precomposeunicode")) {
1646 precomposed_unicode = git_config_bool(var, value);
1647 return 0;
1650 if (!strcmp(var, "core.protecthfs")) {
1651 protect_hfs = git_config_bool(var, value);
1652 return 0;
1655 if (!strcmp(var, "core.protectntfs")) {
1656 protect_ntfs = git_config_bool(var, value);
1657 return 0;
1660 if (!strcmp(var, "core.maxtreedepth")) {
1661 max_allowed_tree_depth = git_config_int(var, value, ctx->kvi);
1662 return 0;
1665 /* Add other config variables here and to Documentation/config.txt. */
1666 return platform_core_config(var, value, ctx, cb);
1669 static int git_default_sparse_config(const char *var, const char *value)
1671 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1672 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1673 return 0;
1676 /* Add other config variables here and to Documentation/config/sparse.txt. */
1677 return 0;
1680 static int git_default_i18n_config(const char *var, const char *value)
1682 if (!strcmp(var, "i18n.commitencoding"))
1683 return git_config_string(&git_commit_encoding, var, value);
1685 if (!strcmp(var, "i18n.logoutputencoding"))
1686 return git_config_string(&git_log_output_encoding, var, value);
1688 /* Add other config variables here and to Documentation/config.txt. */
1689 return 0;
1692 static int git_default_branch_config(const char *var, const char *value)
1694 if (!strcmp(var, "branch.autosetupmerge")) {
1695 if (value && !strcmp(value, "always")) {
1696 git_branch_track = BRANCH_TRACK_ALWAYS;
1697 return 0;
1698 } else if (value && !strcmp(value, "inherit")) {
1699 git_branch_track = BRANCH_TRACK_INHERIT;
1700 return 0;
1701 } else if (value && !strcmp(value, "simple")) {
1702 git_branch_track = BRANCH_TRACK_SIMPLE;
1703 return 0;
1705 git_branch_track = git_config_bool(var, value);
1706 return 0;
1708 if (!strcmp(var, "branch.autosetuprebase")) {
1709 if (!value)
1710 return config_error_nonbool(var);
1711 else if (!strcmp(value, "never"))
1712 autorebase = AUTOREBASE_NEVER;
1713 else if (!strcmp(value, "local"))
1714 autorebase = AUTOREBASE_LOCAL;
1715 else if (!strcmp(value, "remote"))
1716 autorebase = AUTOREBASE_REMOTE;
1717 else if (!strcmp(value, "always"))
1718 autorebase = AUTOREBASE_ALWAYS;
1719 else
1720 return error(_("malformed value for %s"), var);
1721 return 0;
1724 /* Add other config variables here and to Documentation/config.txt. */
1725 return 0;
1728 static int git_default_push_config(const char *var, const char *value)
1730 if (!strcmp(var, "push.default")) {
1731 if (!value)
1732 return config_error_nonbool(var);
1733 else if (!strcmp(value, "nothing"))
1734 push_default = PUSH_DEFAULT_NOTHING;
1735 else if (!strcmp(value, "matching"))
1736 push_default = PUSH_DEFAULT_MATCHING;
1737 else if (!strcmp(value, "simple"))
1738 push_default = PUSH_DEFAULT_SIMPLE;
1739 else if (!strcmp(value, "upstream"))
1740 push_default = PUSH_DEFAULT_UPSTREAM;
1741 else if (!strcmp(value, "tracking")) /* deprecated */
1742 push_default = PUSH_DEFAULT_UPSTREAM;
1743 else if (!strcmp(value, "current"))
1744 push_default = PUSH_DEFAULT_CURRENT;
1745 else {
1746 error(_("malformed value for %s: %s"), var, value);
1747 return error(_("must be one of nothing, matching, simple, "
1748 "upstream or current"));
1750 return 0;
1753 /* Add other config variables here and to Documentation/config.txt. */
1754 return 0;
1757 static int git_default_mailmap_config(const char *var, const char *value)
1759 if (!strcmp(var, "mailmap.file"))
1760 return git_config_pathname(&git_mailmap_file, var, value);
1761 if (!strcmp(var, "mailmap.blob"))
1762 return git_config_string(&git_mailmap_blob, var, value);
1764 /* Add other config variables here and to Documentation/config.txt. */
1765 return 0;
1768 static int git_default_attr_config(const char *var, const char *value)
1770 if (!strcmp(var, "attr.tree"))
1771 return git_config_string(&git_attr_tree, var, value);
1774 * Add other attribute related config variables here and to
1775 * Documentation/config/attr.txt.
1777 return 0;
1780 int git_default_config(const char *var, const char *value,
1781 const struct config_context *ctx, void *cb)
1783 if (starts_with(var, "core."))
1784 return git_default_core_config(var, value, ctx, cb);
1786 if (starts_with(var, "user.") ||
1787 starts_with(var, "author.") ||
1788 starts_with(var, "committer."))
1789 return git_ident_config(var, value, ctx, cb);
1791 if (starts_with(var, "i18n."))
1792 return git_default_i18n_config(var, value);
1794 if (starts_with(var, "branch."))
1795 return git_default_branch_config(var, value);
1797 if (starts_with(var, "push."))
1798 return git_default_push_config(var, value);
1800 if (starts_with(var, "mailmap."))
1801 return git_default_mailmap_config(var, value);
1803 if (starts_with(var, "attr."))
1804 return git_default_attr_config(var, value);
1806 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1807 return git_default_advice_config(var, value);
1809 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1810 pager_use_color = git_config_bool(var,value);
1811 return 0;
1814 if (!strcmp(var, "pack.packsizelimit")) {
1815 pack_size_limit_cfg = git_config_ulong(var, value, ctx->kvi);
1816 return 0;
1819 if (!strcmp(var, "pack.compression")) {
1820 int level = git_config_int(var, value, ctx->kvi);
1821 if (level == -1)
1822 level = Z_DEFAULT_COMPRESSION;
1823 else if (level < 0 || level > Z_BEST_COMPRESSION)
1824 die(_("bad pack compression level %d"), level);
1825 pack_compression_level = level;
1826 pack_compression_seen = 1;
1827 return 0;
1830 if (starts_with(var, "sparse."))
1831 return git_default_sparse_config(var, value);
1833 /* Add other config variables here and to Documentation/config.txt. */
1834 return 0;
1838 * All source specific fields in the union, die_on_error, name and the callbacks
1839 * fgetc, ungetc, ftell of top need to be initialized before calling
1840 * this function.
1842 static int do_config_from(struct config_source *top, config_fn_t fn,
1843 void *data, enum config_scope scope,
1844 const struct config_options *opts)
1846 struct key_value_info kvi = KVI_INIT;
1847 int ret;
1849 /* push config-file parsing state stack */
1850 top->linenr = 1;
1851 top->eof = 0;
1852 top->total_len = 0;
1853 strbuf_init(&top->value, 1024);
1854 strbuf_init(&top->var, 1024);
1855 kvi_from_source(top, scope, &kvi);
1857 ret = git_parse_source(top, fn, &kvi, data, opts);
1859 strbuf_release(&top->value);
1860 strbuf_release(&top->var);
1862 return ret;
1865 static int do_config_from_file(config_fn_t fn,
1866 const enum config_origin_type origin_type,
1867 const char *name, const char *path, FILE *f,
1868 void *data, enum config_scope scope,
1869 const struct config_options *opts)
1871 struct config_source top = CONFIG_SOURCE_INIT;
1872 int ret;
1874 top.u.file = f;
1875 top.origin_type = origin_type;
1876 top.name = name;
1877 top.path = path;
1878 top.default_error_action = CONFIG_ERROR_DIE;
1879 top.do_fgetc = config_file_fgetc;
1880 top.do_ungetc = config_file_ungetc;
1881 top.do_ftell = config_file_ftell;
1883 flockfile(f);
1884 ret = do_config_from(&top, fn, data, scope, opts);
1885 funlockfile(f);
1886 return ret;
1889 static int git_config_from_stdin(config_fn_t fn, void *data,
1890 enum config_scope scope)
1892 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1893 data, scope, NULL);
1896 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1897 void *data, enum config_scope scope,
1898 const struct config_options *opts)
1900 int ret = -1;
1901 FILE *f;
1903 if (!filename)
1904 BUG("filename cannot be NULL");
1905 f = fopen_or_warn(filename, "r");
1906 if (f) {
1907 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1908 filename, f, data, scope, opts);
1909 fclose(f);
1911 return ret;
1914 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1916 return git_config_from_file_with_options(fn, filename, data,
1917 CONFIG_SCOPE_UNKNOWN, NULL);
1920 int git_config_from_mem(config_fn_t fn,
1921 const enum config_origin_type origin_type,
1922 const char *name, const char *buf, size_t len,
1923 void *data, enum config_scope scope,
1924 const struct config_options *opts)
1926 struct config_source top = CONFIG_SOURCE_INIT;
1928 top.u.buf.buf = buf;
1929 top.u.buf.len = len;
1930 top.u.buf.pos = 0;
1931 top.origin_type = origin_type;
1932 top.name = name;
1933 top.path = NULL;
1934 top.default_error_action = CONFIG_ERROR_ERROR;
1935 top.do_fgetc = config_buf_fgetc;
1936 top.do_ungetc = config_buf_ungetc;
1937 top.do_ftell = config_buf_ftell;
1939 return do_config_from(&top, fn, data, scope, opts);
1942 int git_config_from_blob_oid(config_fn_t fn,
1943 const char *name,
1944 struct repository *repo,
1945 const struct object_id *oid,
1946 void *data,
1947 enum config_scope scope)
1949 enum object_type type;
1950 char *buf;
1951 unsigned long size;
1952 int ret;
1954 buf = repo_read_object_file(repo, oid, &type, &size);
1955 if (!buf)
1956 return error(_("unable to load config blob object '%s'"), name);
1957 if (type != OBJ_BLOB) {
1958 free(buf);
1959 return error(_("reference '%s' does not point to a blob"), name);
1962 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1963 data, scope, NULL);
1964 free(buf);
1966 return ret;
1969 static int git_config_from_blob_ref(config_fn_t fn,
1970 struct repository *repo,
1971 const char *name,
1972 void *data,
1973 enum config_scope scope)
1975 struct object_id oid;
1977 if (repo_get_oid(repo, name, &oid) < 0)
1978 return error(_("unable to resolve config blob '%s'"), name);
1979 return git_config_from_blob_oid(fn, name, repo, &oid, data, scope);
1982 char *git_system_config(void)
1984 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1985 if (!system_config)
1986 system_config = system_path(ETC_GITCONFIG);
1987 normalize_path_copy(system_config, system_config);
1988 return system_config;
1991 void git_global_config(char **user_out, char **xdg_out)
1993 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1994 char *xdg_config = NULL;
1996 if (!user_config) {
1997 user_config = interpolate_path("~/.gitconfig", 0);
1998 xdg_config = xdg_config_home("config");
2001 *user_out = user_config;
2002 *xdg_out = xdg_config;
2005 int git_config_system(void)
2007 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2010 static int do_git_config_sequence(const struct config_options *opts,
2011 const struct repository *repo,
2012 config_fn_t fn, void *data)
2014 int ret = 0;
2015 char *system_config = git_system_config();
2016 char *xdg_config = NULL;
2017 char *user_config = NULL;
2018 char *repo_config;
2019 char *worktree_config;
2022 * Ensure that either:
2023 * - the git_dir and commondir are both set, or
2024 * - the git_dir and commondir are both NULL
2026 if (!opts->git_dir != !opts->commondir)
2027 BUG("only one of commondir and git_dir is non-NULL");
2029 if (opts->commondir) {
2030 repo_config = mkpathdup("%s/config", opts->commondir);
2031 worktree_config = mkpathdup("%s/config.worktree", opts->git_dir);
2032 } else {
2033 repo_config = NULL;
2034 worktree_config = NULL;
2037 if (git_config_system() && system_config &&
2038 !access_or_die(system_config, R_OK,
2039 opts->system_gently ? ACCESS_EACCES_OK : 0))
2040 ret += git_config_from_file_with_options(fn, system_config,
2041 data, CONFIG_SCOPE_SYSTEM,
2042 NULL);
2044 git_global_config(&user_config, &xdg_config);
2046 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2047 ret += git_config_from_file_with_options(fn, xdg_config, data,
2048 CONFIG_SCOPE_GLOBAL, NULL);
2050 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2051 ret += git_config_from_file_with_options(fn, user_config, data,
2052 CONFIG_SCOPE_GLOBAL, NULL);
2054 if (!opts->ignore_repo && repo_config &&
2055 !access_or_die(repo_config, R_OK, 0))
2056 ret += git_config_from_file_with_options(fn, repo_config, data,
2057 CONFIG_SCOPE_LOCAL, NULL);
2059 if (!opts->ignore_worktree && worktree_config &&
2060 repo && repo->repository_format_worktree_config &&
2061 !access_or_die(worktree_config, R_OK, 0)) {
2062 ret += git_config_from_file_with_options(fn, worktree_config, data,
2063 CONFIG_SCOPE_WORKTREE,
2064 NULL);
2067 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2068 die(_("unable to parse command-line config"));
2070 free(system_config);
2071 free(xdg_config);
2072 free(user_config);
2073 free(repo_config);
2074 free(worktree_config);
2075 return ret;
2078 int config_with_options(config_fn_t fn, void *data,
2079 struct git_config_source *config_source,
2080 struct repository *repo,
2081 const struct config_options *opts)
2083 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2084 int ret;
2086 if (opts->respect_includes) {
2087 inc.fn = fn;
2088 inc.data = data;
2089 inc.opts = opts;
2090 inc.repo = repo;
2091 inc.config_source = config_source;
2092 fn = git_config_include;
2093 data = &inc;
2097 * If we have a specific filename, use it. Otherwise, follow the
2098 * regular lookup sequence.
2100 if (config_source && config_source->use_stdin) {
2101 ret = git_config_from_stdin(fn, data, config_source->scope);
2102 } else if (config_source && config_source->file) {
2103 ret = git_config_from_file_with_options(fn, config_source->file,
2104 data, config_source->scope,
2105 NULL);
2106 } else if (config_source && config_source->blob) {
2107 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2108 data, config_source->scope);
2109 } else {
2110 ret = do_git_config_sequence(opts, repo, fn, data);
2113 if (inc.remote_urls) {
2114 string_list_clear(inc.remote_urls, 0);
2115 FREE_AND_NULL(inc.remote_urls);
2117 return ret;
2120 static void configset_iter(struct config_set *set, config_fn_t fn, void *data)
2122 int i, value_index;
2123 struct string_list *values;
2124 struct config_set_element *entry;
2125 struct configset_list *list = &set->list;
2126 struct config_context ctx = CONFIG_CONTEXT_INIT;
2128 for (i = 0; i < list->nr; i++) {
2129 entry = list->items[i].e;
2130 value_index = list->items[i].value_index;
2131 values = &entry->value_list;
2133 ctx.kvi = values->items[value_index].util;
2134 if (fn(entry->key, values->items[value_index].string, &ctx, data) < 0)
2135 git_die_config_linenr(entry->key,
2136 ctx.kvi->filename,
2137 ctx.kvi->linenr);
2141 void read_early_config(config_fn_t cb, void *data)
2143 struct config_options opts = {0};
2144 struct strbuf commondir = STRBUF_INIT;
2145 struct strbuf gitdir = STRBUF_INIT;
2147 opts.respect_includes = 1;
2149 if (have_git_dir()) {
2150 opts.commondir = get_git_common_dir();
2151 opts.git_dir = get_git_dir();
2153 * When setup_git_directory() was not yet asked to discover the
2154 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2155 * is any repository config we should use (but unlike
2156 * setup_git_directory_gently(), no global state is changed, most
2157 * notably, the current working directory is still the same after the
2158 * call).
2160 } else if (!discover_git_directory(&commondir, &gitdir)) {
2161 opts.commondir = commondir.buf;
2162 opts.git_dir = gitdir.buf;
2165 config_with_options(cb, data, NULL, NULL, &opts);
2167 strbuf_release(&commondir);
2168 strbuf_release(&gitdir);
2172 * Read config but only enumerate system and global settings.
2173 * Omit any repo-local, worktree-local, or command-line settings.
2175 void read_very_early_config(config_fn_t cb, void *data)
2177 struct config_options opts = { 0 };
2179 opts.respect_includes = 1;
2180 opts.ignore_repo = 1;
2181 opts.ignore_worktree = 1;
2182 opts.ignore_cmdline = 1;
2183 opts.system_gently = 1;
2185 config_with_options(cb, data, NULL, NULL, &opts);
2188 RESULT_MUST_BE_USED
2189 static int configset_find_element(struct config_set *set, const char *key,
2190 struct config_set_element **dest)
2192 struct config_set_element k;
2193 struct config_set_element *found_entry;
2194 char *normalized_key;
2195 int ret;
2198 * `key` may come from the user, so normalize it before using it
2199 * for querying entries from the hashmap.
2201 ret = git_config_parse_key(key, &normalized_key, NULL);
2202 if (ret)
2203 return ret;
2205 hashmap_entry_init(&k.ent, strhash(normalized_key));
2206 k.key = normalized_key;
2207 found_entry = hashmap_get_entry(&set->config_hash, &k, ent, NULL);
2208 free(normalized_key);
2209 *dest = found_entry;
2210 return 0;
2213 static int configset_add_value(const struct key_value_info *kvi_p,
2214 struct config_set *set, const char *key,
2215 const char *value)
2217 struct config_set_element *e;
2218 struct string_list_item *si;
2219 struct configset_list_item *l_item;
2220 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2221 int ret;
2223 ret = configset_find_element(set, key, &e);
2224 if (ret)
2225 return ret;
2227 * Since the keys are being fed by git_config*() callback mechanism, they
2228 * are already normalized. So simply add them without any further munging.
2230 if (!e) {
2231 e = xmalloc(sizeof(*e));
2232 hashmap_entry_init(&e->ent, strhash(key));
2233 e->key = xstrdup(key);
2234 string_list_init_dup(&e->value_list);
2235 hashmap_add(&set->config_hash, &e->ent);
2237 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2239 ALLOC_GROW(set->list.items, set->list.nr + 1, set->list.alloc);
2240 l_item = &set->list.items[set->list.nr++];
2241 l_item->e = e;
2242 l_item->value_index = e->value_list.nr - 1;
2244 *kv_info = *kvi_p;
2245 si->util = kv_info;
2247 return 0;
2250 static int config_set_element_cmp(const void *cmp_data UNUSED,
2251 const struct hashmap_entry *eptr,
2252 const struct hashmap_entry *entry_or_key,
2253 const void *keydata UNUSED)
2255 const struct config_set_element *e1, *e2;
2257 e1 = container_of(eptr, const struct config_set_element, ent);
2258 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2260 return strcmp(e1->key, e2->key);
2263 void git_configset_init(struct config_set *set)
2265 hashmap_init(&set->config_hash, config_set_element_cmp, NULL, 0);
2266 set->hash_initialized = 1;
2267 set->list.nr = 0;
2268 set->list.alloc = 0;
2269 set->list.items = NULL;
2272 void git_configset_clear(struct config_set *set)
2274 struct config_set_element *entry;
2275 struct hashmap_iter iter;
2276 if (!set->hash_initialized)
2277 return;
2279 hashmap_for_each_entry(&set->config_hash, &iter, entry,
2280 ent /* member name */) {
2281 free(entry->key);
2282 string_list_clear(&entry->value_list, 1);
2284 hashmap_clear_and_free(&set->config_hash, struct config_set_element, ent);
2285 set->hash_initialized = 0;
2286 free(set->list.items);
2287 set->list.nr = 0;
2288 set->list.alloc = 0;
2289 set->list.items = NULL;
2292 static int config_set_callback(const char *key, const char *value,
2293 const struct config_context *ctx,
2294 void *cb)
2296 struct config_set *set = cb;
2297 configset_add_value(ctx->kvi, set, key, value);
2298 return 0;
2301 int git_configset_add_file(struct config_set *set, const char *filename)
2303 return git_config_from_file(config_set_callback, filename, set);
2306 int git_configset_get_value(struct config_set *set, const char *key,
2307 const char **value, struct key_value_info *kvi)
2309 const struct string_list *values = NULL;
2310 int ret;
2311 struct string_list_item item;
2313 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2314 * queried key in the files of the configset, the value returned will be the last
2315 * value in the value list for that key.
2317 if ((ret = git_configset_get_value_multi(set, key, &values)))
2318 return ret;
2320 assert(values->nr > 0);
2321 item = values->items[values->nr - 1];
2322 *value = item.string;
2323 if (kvi)
2324 *kvi = *((struct key_value_info *)item.util);
2325 return 0;
2328 int git_configset_get_value_multi(struct config_set *set, const char *key,
2329 const struct string_list **dest)
2331 struct config_set_element *e;
2332 int ret;
2334 if ((ret = configset_find_element(set, key, &e)))
2335 return ret;
2336 else if (!e)
2337 return 1;
2338 *dest = &e->value_list;
2340 return 0;
2343 static int check_multi_string(struct string_list_item *item, void *util)
2345 return item->string ? 0 : config_error_nonbool(util);
2348 int git_configset_get_string_multi(struct config_set *cs, const char *key,
2349 const struct string_list **dest)
2351 int ret;
2353 if ((ret = git_configset_get_value_multi(cs, key, dest)))
2354 return ret;
2355 if ((ret = for_each_string_list((struct string_list *)*dest,
2356 check_multi_string, (void *)key)))
2357 return ret;
2359 return 0;
2362 int git_configset_get(struct config_set *set, const char *key)
2364 struct config_set_element *e;
2365 int ret;
2367 if ((ret = configset_find_element(set, key, &e)))
2368 return ret;
2369 else if (!e)
2370 return 1;
2371 return 0;
2374 int git_configset_get_string(struct config_set *set, const char *key, char **dest)
2376 const char *value;
2377 if (!git_configset_get_value(set, key, &value, NULL))
2378 return git_config_string((const char **)dest, key, value);
2379 else
2380 return 1;
2383 static int git_configset_get_string_tmp(struct config_set *set, const char *key,
2384 const char **dest)
2386 const char *value;
2387 if (!git_configset_get_value(set, key, &value, NULL)) {
2388 if (!value)
2389 return config_error_nonbool(key);
2390 *dest = value;
2391 return 0;
2392 } else {
2393 return 1;
2397 int git_configset_get_int(struct config_set *set, const char *key, int *dest)
2399 const char *value;
2400 struct key_value_info kvi;
2402 if (!git_configset_get_value(set, key, &value, &kvi)) {
2403 *dest = git_config_int(key, value, &kvi);
2404 return 0;
2405 } else
2406 return 1;
2409 int git_configset_get_ulong(struct config_set *set, const char *key, unsigned long *dest)
2411 const char *value;
2412 struct key_value_info kvi;
2414 if (!git_configset_get_value(set, key, &value, &kvi)) {
2415 *dest = git_config_ulong(key, value, &kvi);
2416 return 0;
2417 } else
2418 return 1;
2421 int git_configset_get_bool(struct config_set *set, const char *key, int *dest)
2423 const char *value;
2424 if (!git_configset_get_value(set, key, &value, NULL)) {
2425 *dest = git_config_bool(key, value);
2426 return 0;
2427 } else
2428 return 1;
2431 int git_configset_get_bool_or_int(struct config_set *set, const char *key,
2432 int *is_bool, int *dest)
2434 const char *value;
2435 struct key_value_info kvi;
2437 if (!git_configset_get_value(set, key, &value, &kvi)) {
2438 *dest = git_config_bool_or_int(key, value, &kvi, is_bool);
2439 return 0;
2440 } else
2441 return 1;
2444 int git_configset_get_maybe_bool(struct config_set *set, const char *key, int *dest)
2446 const char *value;
2447 if (!git_configset_get_value(set, key, &value, NULL)) {
2448 *dest = git_parse_maybe_bool(value);
2449 if (*dest == -1)
2450 return -1;
2451 return 0;
2452 } else
2453 return 1;
2456 int git_configset_get_pathname(struct config_set *set, const char *key, const char **dest)
2458 const char *value;
2459 if (!git_configset_get_value(set, key, &value, NULL))
2460 return git_config_pathname(dest, key, value);
2461 else
2462 return 1;
2465 /* Functions use to read configuration from a repository */
2466 static void repo_read_config(struct repository *repo)
2468 struct config_options opts = { 0 };
2470 opts.respect_includes = 1;
2471 opts.commondir = repo->commondir;
2472 opts.git_dir = repo->gitdir;
2474 if (!repo->config)
2475 CALLOC_ARRAY(repo->config, 1);
2476 else
2477 git_configset_clear(repo->config);
2479 git_configset_init(repo->config);
2480 if (config_with_options(config_set_callback, repo->config, NULL,
2481 repo, &opts) < 0)
2483 * config_with_options() normally returns only
2484 * zero, as most errors are fatal, and
2485 * non-fatal potential errors are guarded by "if"
2486 * statements that are entered only when no error is
2487 * possible.
2489 * If we ever encounter a non-fatal error, it means
2490 * something went really wrong and we should stop
2491 * immediately.
2493 die(_("unknown error occurred while reading the configuration files"));
2496 static void git_config_check_init(struct repository *repo)
2498 if (repo->config && repo->config->hash_initialized)
2499 return;
2500 repo_read_config(repo);
2503 static void repo_config_clear(struct repository *repo)
2505 if (!repo->config || !repo->config->hash_initialized)
2506 return;
2507 git_configset_clear(repo->config);
2510 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2512 git_config_check_init(repo);
2513 configset_iter(repo->config, fn, data);
2516 int repo_config_get(struct repository *repo, const char *key)
2518 git_config_check_init(repo);
2519 return git_configset_get(repo->config, key);
2522 int repo_config_get_value(struct repository *repo,
2523 const char *key, const char **value)
2525 git_config_check_init(repo);
2526 return git_configset_get_value(repo->config, key, value, NULL);
2529 int repo_config_get_value_multi(struct repository *repo, const char *key,
2530 const struct string_list **dest)
2532 git_config_check_init(repo);
2533 return git_configset_get_value_multi(repo->config, key, dest);
2536 int repo_config_get_string_multi(struct repository *repo, const char *key,
2537 const struct string_list **dest)
2539 git_config_check_init(repo);
2540 return git_configset_get_string_multi(repo->config, key, dest);
2543 int repo_config_get_string(struct repository *repo,
2544 const char *key, char **dest)
2546 int ret;
2547 git_config_check_init(repo);
2548 ret = git_configset_get_string(repo->config, key, dest);
2549 if (ret < 0)
2550 git_die_config(key, NULL);
2551 return ret;
2554 int repo_config_get_string_tmp(struct repository *repo,
2555 const char *key, const char **dest)
2557 int ret;
2558 git_config_check_init(repo);
2559 ret = git_configset_get_string_tmp(repo->config, key, dest);
2560 if (ret < 0)
2561 git_die_config(key, NULL);
2562 return ret;
2565 int repo_config_get_int(struct repository *repo,
2566 const char *key, int *dest)
2568 git_config_check_init(repo);
2569 return git_configset_get_int(repo->config, key, dest);
2572 int repo_config_get_ulong(struct repository *repo,
2573 const char *key, unsigned long *dest)
2575 git_config_check_init(repo);
2576 return git_configset_get_ulong(repo->config, key, dest);
2579 int repo_config_get_bool(struct repository *repo,
2580 const char *key, int *dest)
2582 git_config_check_init(repo);
2583 return git_configset_get_bool(repo->config, key, dest);
2586 int repo_config_get_bool_or_int(struct repository *repo,
2587 const char *key, int *is_bool, int *dest)
2589 git_config_check_init(repo);
2590 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2593 int repo_config_get_maybe_bool(struct repository *repo,
2594 const char *key, int *dest)
2596 git_config_check_init(repo);
2597 return git_configset_get_maybe_bool(repo->config, key, dest);
2600 int repo_config_get_pathname(struct repository *repo,
2601 const char *key, const char **dest)
2603 int ret;
2604 git_config_check_init(repo);
2605 ret = git_configset_get_pathname(repo->config, key, dest);
2606 if (ret < 0)
2607 git_die_config(key, NULL);
2608 return ret;
2611 /* Read values into protected_config. */
2612 static void read_protected_config(void)
2614 struct config_options opts = {
2615 .respect_includes = 1,
2616 .ignore_repo = 1,
2617 .ignore_worktree = 1,
2618 .system_gently = 1,
2621 git_configset_init(&protected_config);
2622 config_with_options(config_set_callback, &protected_config, NULL,
2623 NULL, &opts);
2626 void git_protected_config(config_fn_t fn, void *data)
2628 if (!protected_config.hash_initialized)
2629 read_protected_config();
2630 configset_iter(&protected_config, fn, data);
2633 /* Functions used historically to read configuration from 'the_repository' */
2634 void git_config(config_fn_t fn, void *data)
2636 repo_config(the_repository, fn, data);
2639 void git_config_clear(void)
2641 repo_config_clear(the_repository);
2644 int git_config_get(const char *key)
2646 return repo_config_get(the_repository, key);
2649 int git_config_get_value(const char *key, const char **value)
2651 return repo_config_get_value(the_repository, key, value);
2654 int git_config_get_value_multi(const char *key, const struct string_list **dest)
2656 return repo_config_get_value_multi(the_repository, key, dest);
2659 int git_config_get_string_multi(const char *key,
2660 const struct string_list **dest)
2662 return repo_config_get_string_multi(the_repository, key, dest);
2665 int git_config_get_string(const char *key, char **dest)
2667 return repo_config_get_string(the_repository, key, dest);
2670 int git_config_get_string_tmp(const char *key, const char **dest)
2672 return repo_config_get_string_tmp(the_repository, key, dest);
2675 int git_config_get_int(const char *key, int *dest)
2677 return repo_config_get_int(the_repository, key, dest);
2680 int git_config_get_ulong(const char *key, unsigned long *dest)
2682 return repo_config_get_ulong(the_repository, key, dest);
2685 int git_config_get_bool(const char *key, int *dest)
2687 return repo_config_get_bool(the_repository, key, dest);
2690 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2692 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2695 int git_config_get_maybe_bool(const char *key, int *dest)
2697 return repo_config_get_maybe_bool(the_repository, key, dest);
2700 int git_config_get_pathname(const char *key, const char **dest)
2702 return repo_config_get_pathname(the_repository, key, dest);
2705 int git_config_get_expiry(const char *key, const char **output)
2707 int ret = git_config_get_string(key, (char **)output);
2708 if (ret)
2709 return ret;
2710 if (strcmp(*output, "now")) {
2711 timestamp_t now = approxidate("now");
2712 if (approxidate(*output) >= now)
2713 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2715 return ret;
2718 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2720 const char *expiry_string;
2721 intmax_t days;
2722 timestamp_t when;
2724 if (git_config_get_string_tmp(key, &expiry_string))
2725 return 1; /* no such thing */
2727 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2728 const int scale = 86400;
2729 *expiry = now - days * scale;
2730 return 0;
2733 if (!parse_expiry_date(expiry_string, &when)) {
2734 *expiry = when;
2735 return 0;
2737 return -1; /* thing exists but cannot be parsed */
2740 int git_config_get_split_index(void)
2742 int val;
2744 if (!git_config_get_maybe_bool("core.splitindex", &val))
2745 return val;
2747 return -1; /* default value */
2750 int git_config_get_max_percent_split_change(void)
2752 int val = -1;
2754 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2755 if (0 <= val && val <= 100)
2756 return val;
2758 return error(_("splitIndex.maxPercentChange value '%d' "
2759 "should be between 0 and 100"), val);
2762 return -1; /* default value */
2765 int git_config_get_index_threads(int *dest)
2767 int is_bool, val;
2769 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2770 if (val) {
2771 *dest = val;
2772 return 0;
2775 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2776 if (is_bool)
2777 *dest = val ? 0 : 1;
2778 else
2779 *dest = val;
2780 return 0;
2783 return 1;
2786 NORETURN
2787 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2789 if (!filename)
2790 die(_("unable to parse '%s' from command-line config"), key);
2791 else
2792 die(_("bad config variable '%s' in file '%s' at line %d"),
2793 key, filename, linenr);
2796 NORETURN __attribute__((format(printf, 2, 3)))
2797 void git_die_config(const char *key, const char *err, ...)
2799 const struct string_list *values;
2800 struct key_value_info *kv_info;
2801 report_fn error_fn = get_error_routine();
2803 if (err) {
2804 va_list params;
2805 va_start(params, err);
2806 error_fn(err, params);
2807 va_end(params);
2809 if (git_config_get_value_multi(key, &values))
2810 BUG("for key '%s' we must have a value to report on", key);
2811 kv_info = values->items[values->nr - 1].util;
2812 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2816 * Find all the stuff for git_config_set() below.
2819 struct config_store_data {
2820 size_t baselen;
2821 char *key;
2822 int do_not_match;
2823 const char *fixed_value;
2824 regex_t *value_pattern;
2825 int multi_replace;
2826 struct {
2827 size_t begin, end;
2828 enum config_event_t type;
2829 int is_keys_section;
2830 } *parsed;
2831 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2832 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2834 #define CONFIG_STORE_INIT { 0 }
2836 static void config_store_data_clear(struct config_store_data *store)
2838 free(store->key);
2839 if (store->value_pattern != NULL &&
2840 store->value_pattern != CONFIG_REGEX_NONE) {
2841 regfree(store->value_pattern);
2842 free(store->value_pattern);
2844 free(store->parsed);
2845 free(store->seen);
2846 memset(store, 0, sizeof(*store));
2849 static int matches(const char *key, const char *value,
2850 const struct config_store_data *store)
2852 if (strcmp(key, store->key))
2853 return 0; /* not ours */
2854 if (store->fixed_value)
2855 return !strcmp(store->fixed_value, value);
2856 if (!store->value_pattern)
2857 return 1; /* always matches */
2858 if (store->value_pattern == CONFIG_REGEX_NONE)
2859 return 0; /* never matches */
2861 return store->do_not_match ^
2862 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2865 static int store_aux_event(enum config_event_t type, size_t begin, size_t end,
2866 struct config_source *cs, void *data)
2868 struct config_store_data *store = data;
2870 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2871 store->parsed[store->parsed_nr].begin = begin;
2872 store->parsed[store->parsed_nr].end = end;
2873 store->parsed[store->parsed_nr].type = type;
2875 if (type == CONFIG_EVENT_SECTION) {
2876 int (*cmpfn)(const char *, const char *, size_t);
2878 if (cs->var.len < 2 || cs->var.buf[cs->var.len - 1] != '.')
2879 return error(_("invalid section name '%s'"), cs->var.buf);
2881 if (cs->subsection_case_sensitive)
2882 cmpfn = strncasecmp;
2883 else
2884 cmpfn = strncmp;
2886 /* Is this the section we were looking for? */
2887 store->is_keys_section =
2888 store->parsed[store->parsed_nr].is_keys_section =
2889 cs->var.len - 1 == store->baselen &&
2890 !cmpfn(cs->var.buf, store->key, store->baselen);
2891 if (store->is_keys_section) {
2892 store->section_seen = 1;
2893 ALLOC_GROW(store->seen, store->seen_nr + 1,
2894 store->seen_alloc);
2895 store->seen[store->seen_nr] = store->parsed_nr;
2899 store->parsed_nr++;
2901 return 0;
2904 static int store_aux(const char *key, const char *value,
2905 const struct config_context *ctx UNUSED, void *cb)
2907 struct config_store_data *store = cb;
2909 if (store->key_seen) {
2910 if (matches(key, value, store)) {
2911 if (store->seen_nr == 1 && store->multi_replace == 0) {
2912 warning(_("%s has multiple values"), key);
2915 ALLOC_GROW(store->seen, store->seen_nr + 1,
2916 store->seen_alloc);
2918 store->seen[store->seen_nr] = store->parsed_nr;
2919 store->seen_nr++;
2921 } else if (store->is_keys_section) {
2923 * Do not increment matches yet: this may not be a match, but we
2924 * are in the desired section.
2926 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2927 store->seen[store->seen_nr] = store->parsed_nr;
2928 store->section_seen = 1;
2930 if (matches(key, value, store)) {
2931 store->seen_nr++;
2932 store->key_seen = 1;
2936 return 0;
2939 static int write_error(const char *filename)
2941 error(_("failed to write new configuration file %s"), filename);
2943 /* Same error code as "failed to rename". */
2944 return 4;
2947 static struct strbuf store_create_section(const char *key,
2948 const struct config_store_data *store)
2950 const char *dot;
2951 size_t i;
2952 struct strbuf sb = STRBUF_INIT;
2954 dot = memchr(key, '.', store->baselen);
2955 if (dot) {
2956 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2957 for (i = dot - key + 1; i < store->baselen; i++) {
2958 if (key[i] == '"' || key[i] == '\\')
2959 strbuf_addch(&sb, '\\');
2960 strbuf_addch(&sb, key[i]);
2962 strbuf_addstr(&sb, "\"]\n");
2963 } else {
2964 strbuf_addch(&sb, '[');
2965 strbuf_add(&sb, key, store->baselen);
2966 strbuf_addstr(&sb, "]\n");
2969 return sb;
2972 static ssize_t write_section(int fd, const char *key,
2973 const struct config_store_data *store)
2975 struct strbuf sb = store_create_section(key, store);
2976 ssize_t ret;
2978 ret = write_in_full(fd, sb.buf, sb.len);
2979 strbuf_release(&sb);
2981 return ret;
2984 static ssize_t write_pair(int fd, const char *key, const char *value,
2985 const struct config_store_data *store)
2987 int i;
2988 ssize_t ret;
2989 const char *quote = "";
2990 struct strbuf sb = STRBUF_INIT;
2993 * Check to see if the value needs to be surrounded with a dq pair.
2994 * Note that problematic characters are always backslash-quoted; this
2995 * check is about not losing leading or trailing SP and strings that
2996 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2997 * configuration parser.
2999 if (value[0] == ' ')
3000 quote = "\"";
3001 for (i = 0; value[i]; i++)
3002 if (value[i] == ';' || value[i] == '#')
3003 quote = "\"";
3004 if (i && value[i - 1] == ' ')
3005 quote = "\"";
3007 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3009 for (i = 0; value[i]; i++)
3010 switch (value[i]) {
3011 case '\n':
3012 strbuf_addstr(&sb, "\\n");
3013 break;
3014 case '\t':
3015 strbuf_addstr(&sb, "\\t");
3016 break;
3017 case '"':
3018 case '\\':
3019 strbuf_addch(&sb, '\\');
3020 /* fallthrough */
3021 default:
3022 strbuf_addch(&sb, value[i]);
3023 break;
3025 strbuf_addf(&sb, "%s\n", quote);
3027 ret = write_in_full(fd, sb.buf, sb.len);
3028 strbuf_release(&sb);
3030 return ret;
3034 * If we are about to unset the last key(s) in a section, and if there are
3035 * no comments surrounding (or included in) the section, we will want to
3036 * extend begin/end to remove the entire section.
3038 * Note: the parameter `seen_ptr` points to the index into the store.seen
3039 * array. * This index may be incremented if a section has more than one
3040 * entry (which all are to be removed).
3042 static void maybe_remove_section(struct config_store_data *store,
3043 size_t *begin_offset, size_t *end_offset,
3044 int *seen_ptr)
3046 size_t begin;
3047 int i, seen, section_seen = 0;
3050 * First, ensure that this is the first key, and that there are no
3051 * comments before the entry nor before the section header.
3053 seen = *seen_ptr;
3054 for (i = store->seen[seen]; i > 0; i--) {
3055 enum config_event_t type = store->parsed[i - 1].type;
3057 if (type == CONFIG_EVENT_COMMENT)
3058 /* There is a comment before this entry or section */
3059 return;
3060 if (type == CONFIG_EVENT_ENTRY) {
3061 if (!section_seen)
3062 /* This is not the section's first entry. */
3063 return;
3064 /* We encountered no comment before the section. */
3065 break;
3067 if (type == CONFIG_EVENT_SECTION) {
3068 if (!store->parsed[i - 1].is_keys_section)
3069 break;
3070 section_seen = 1;
3073 begin = store->parsed[i].begin;
3076 * Next, make sure that we are removing the last key(s) in the section,
3077 * and that there are no comments that are possibly about the current
3078 * section.
3080 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3081 enum config_event_t type = store->parsed[i].type;
3083 if (type == CONFIG_EVENT_COMMENT)
3084 return;
3085 if (type == CONFIG_EVENT_SECTION) {
3086 if (store->parsed[i].is_keys_section)
3087 continue;
3088 break;
3090 if (type == CONFIG_EVENT_ENTRY) {
3091 if (++seen < store->seen_nr &&
3092 i == store->seen[seen])
3093 /* We want to remove this entry, too */
3094 continue;
3095 /* There is another entry in this section. */
3096 return;
3101 * We are really removing the last entry/entries from this section, and
3102 * there are no enclosed or surrounding comments. Remove the entire,
3103 * now-empty section.
3105 *seen_ptr = seen;
3106 *begin_offset = begin;
3107 if (i < store->parsed_nr)
3108 *end_offset = store->parsed[i].begin;
3109 else
3110 *end_offset = store->parsed[store->parsed_nr - 1].end;
3113 int git_config_set_in_file_gently(const char *config_filename,
3114 const char *key, const char *value)
3116 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3119 void git_config_set_in_file(const char *config_filename,
3120 const char *key, const char *value)
3122 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3125 int git_config_set_gently(const char *key, const char *value)
3127 return git_config_set_multivar_gently(key, value, NULL, 0);
3130 int repo_config_set_worktree_gently(struct repository *r,
3131 const char *key, const char *value)
3133 /* Only use worktree-specific config if it is already enabled. */
3134 if (r->repository_format_worktree_config) {
3135 char *file = repo_git_path(r, "config.worktree");
3136 int ret = git_config_set_multivar_in_file_gently(
3137 file, key, value, NULL, 0);
3138 free(file);
3139 return ret;
3141 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3144 void git_config_set(const char *key, const char *value)
3146 git_config_set_multivar(key, value, NULL, 0);
3148 trace2_cmd_set_config(key, value);
3152 * If value==NULL, unset in (remove from) config,
3153 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3154 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3155 * (only add a new one)
3156 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3157 * key/values are removed before a single new pair is written. If the
3158 * flag is not present, then replace only the first match.
3160 * Returns 0 on success.
3162 * This function does this:
3164 * - it locks the config file by creating ".git/config.lock"
3166 * - it then parses the config using store_aux() as validator to find
3167 * the position on the key/value pair to replace. If it is to be unset,
3168 * it must be found exactly once.
3170 * - the config file is mmap()ed and the part before the match (if any) is
3171 * written to the lock file, then the changed part and the rest.
3173 * - the config file is removed and the lock file rename()d to it.
3176 int git_config_set_multivar_in_file_gently(const char *config_filename,
3177 const char *key, const char *value,
3178 const char *value_pattern,
3179 unsigned flags)
3181 int fd = -1, in_fd = -1;
3182 int ret;
3183 struct lock_file lock = LOCK_INIT;
3184 char *filename_buf = NULL;
3185 char *contents = NULL;
3186 size_t contents_sz;
3187 struct config_store_data store = CONFIG_STORE_INIT;
3189 /* parse-key returns negative; flip the sign to feed exit(3) */
3190 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3191 if (ret)
3192 goto out_free;
3194 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3196 if (!config_filename)
3197 config_filename = filename_buf = git_pathdup("config");
3200 * The lock serves a purpose in addition to locking: the new
3201 * contents of .git/config will be written into it.
3203 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3204 if (fd < 0) {
3205 error_errno(_("could not lock config file %s"), config_filename);
3206 ret = CONFIG_NO_LOCK;
3207 goto out_free;
3211 * If .git/config does not exist yet, write a minimal version.
3213 in_fd = open(config_filename, O_RDONLY);
3214 if ( in_fd < 0 ) {
3215 if ( ENOENT != errno ) {
3216 error_errno(_("opening %s"), config_filename);
3217 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3218 goto out_free;
3220 /* if nothing to unset, error out */
3221 if (!value) {
3222 ret = CONFIG_NOTHING_SET;
3223 goto out_free;
3226 free(store.key);
3227 store.key = xstrdup(key);
3228 if (write_section(fd, key, &store) < 0 ||
3229 write_pair(fd, key, value, &store) < 0)
3230 goto write_err_out;
3231 } else {
3232 struct stat st;
3233 size_t copy_begin, copy_end;
3234 int i, new_line = 0;
3235 struct config_options opts;
3237 if (!value_pattern)
3238 store.value_pattern = NULL;
3239 else if (value_pattern == CONFIG_REGEX_NONE)
3240 store.value_pattern = CONFIG_REGEX_NONE;
3241 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3242 store.fixed_value = value_pattern;
3243 else {
3244 if (value_pattern[0] == '!') {
3245 store.do_not_match = 1;
3246 value_pattern++;
3247 } else
3248 store.do_not_match = 0;
3250 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3251 if (regcomp(store.value_pattern, value_pattern,
3252 REG_EXTENDED)) {
3253 error(_("invalid pattern: %s"), value_pattern);
3254 FREE_AND_NULL(store.value_pattern);
3255 ret = CONFIG_INVALID_PATTERN;
3256 goto out_free;
3260 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3261 store.parsed[0].end = 0;
3263 memset(&opts, 0, sizeof(opts));
3264 opts.event_fn = store_aux_event;
3265 opts.event_fn_data = &store;
3268 * After this, store.parsed will contain offsets of all the
3269 * parsed elements, and store.seen will contain a list of
3270 * matches, as indices into store.parsed.
3272 * As a side effect, we make sure to transform only a valid
3273 * existing config file.
3275 if (git_config_from_file_with_options(store_aux,
3276 config_filename,
3277 &store, CONFIG_SCOPE_UNKNOWN,
3278 &opts)) {
3279 error(_("invalid config file %s"), config_filename);
3280 ret = CONFIG_INVALID_FILE;
3281 goto out_free;
3284 /* if nothing to unset, or too many matches, error out */
3285 if ((store.seen_nr == 0 && value == NULL) ||
3286 (store.seen_nr > 1 && !store.multi_replace)) {
3287 ret = CONFIG_NOTHING_SET;
3288 goto out_free;
3291 if (fstat(in_fd, &st) == -1) {
3292 error_errno(_("fstat on %s failed"), config_filename);
3293 ret = CONFIG_INVALID_FILE;
3294 goto out_free;
3297 contents_sz = xsize_t(st.st_size);
3298 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3299 MAP_PRIVATE, in_fd, 0);
3300 if (contents == MAP_FAILED) {
3301 if (errno == ENODEV && S_ISDIR(st.st_mode))
3302 errno = EISDIR;
3303 error_errno(_("unable to mmap '%s'%s"),
3304 config_filename, mmap_os_err());
3305 ret = CONFIG_INVALID_FILE;
3306 contents = NULL;
3307 goto out_free;
3309 close(in_fd);
3310 in_fd = -1;
3312 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3313 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3314 ret = CONFIG_NO_WRITE;
3315 goto out_free;
3318 if (store.seen_nr == 0) {
3319 if (!store.seen_alloc) {
3320 /* Did not see key nor section */
3321 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3322 store.seen[0] = store.parsed_nr
3323 - !!store.parsed_nr;
3325 store.seen_nr = 1;
3328 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3329 size_t replace_end;
3330 int j = store.seen[i];
3332 new_line = 0;
3333 if (!store.key_seen) {
3334 copy_end = store.parsed[j].end;
3335 /* include '\n' when copying section header */
3336 if (copy_end > 0 && copy_end < contents_sz &&
3337 contents[copy_end - 1] != '\n' &&
3338 contents[copy_end] == '\n')
3339 copy_end++;
3340 replace_end = copy_end;
3341 } else {
3342 replace_end = store.parsed[j].end;
3343 copy_end = store.parsed[j].begin;
3344 if (!value)
3345 maybe_remove_section(&store,
3346 &copy_end,
3347 &replace_end, &i);
3349 * Swallow preceding white-space on the same
3350 * line.
3352 while (copy_end > 0 ) {
3353 char c = contents[copy_end - 1];
3355 if (isspace(c) && c != '\n')
3356 copy_end--;
3357 else
3358 break;
3362 if (copy_end > 0 && contents[copy_end-1] != '\n')
3363 new_line = 1;
3365 /* write the first part of the config */
3366 if (copy_end > copy_begin) {
3367 if (write_in_full(fd, contents + copy_begin,
3368 copy_end - copy_begin) < 0)
3369 goto write_err_out;
3370 if (new_line &&
3371 write_str_in_full(fd, "\n") < 0)
3372 goto write_err_out;
3374 copy_begin = replace_end;
3377 /* write the pair (value == NULL means unset) */
3378 if (value) {
3379 if (!store.section_seen) {
3380 if (write_section(fd, key, &store) < 0)
3381 goto write_err_out;
3383 if (write_pair(fd, key, value, &store) < 0)
3384 goto write_err_out;
3387 /* write the rest of the config */
3388 if (copy_begin < contents_sz)
3389 if (write_in_full(fd, contents + copy_begin,
3390 contents_sz - copy_begin) < 0)
3391 goto write_err_out;
3393 munmap(contents, contents_sz);
3394 contents = NULL;
3397 if (commit_lock_file(&lock) < 0) {
3398 error_errno(_("could not write config file %s"), config_filename);
3399 ret = CONFIG_NO_WRITE;
3400 goto out_free;
3403 ret = 0;
3405 /* Invalidate the config cache */
3406 git_config_clear();
3408 out_free:
3409 rollback_lock_file(&lock);
3410 free(filename_buf);
3411 if (contents)
3412 munmap(contents, contents_sz);
3413 if (in_fd >= 0)
3414 close(in_fd);
3415 config_store_data_clear(&store);
3416 return ret;
3418 write_err_out:
3419 ret = write_error(get_lock_file_path(&lock));
3420 goto out_free;
3424 void git_config_set_multivar_in_file(const char *config_filename,
3425 const char *key, const char *value,
3426 const char *value_pattern, unsigned flags)
3428 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3429 value_pattern, flags))
3430 return;
3431 if (value)
3432 die(_("could not set '%s' to '%s'"), key, value);
3433 else
3434 die(_("could not unset '%s'"), key);
3437 int git_config_set_multivar_gently(const char *key, const char *value,
3438 const char *value_pattern, unsigned flags)
3440 return repo_config_set_multivar_gently(the_repository, key, value,
3441 value_pattern, flags);
3444 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3445 const char *value,
3446 const char *value_pattern, unsigned flags)
3448 char *file = repo_git_path(r, "config");
3449 int res = git_config_set_multivar_in_file_gently(file,
3450 key, value,
3451 value_pattern,
3452 flags);
3453 free(file);
3454 return res;
3457 void git_config_set_multivar(const char *key, const char *value,
3458 const char *value_pattern, unsigned flags)
3460 git_config_set_multivar_in_file(git_path("config"),
3461 key, value, value_pattern,
3462 flags);
3465 static size_t section_name_match (const char *buf, const char *name)
3467 size_t i = 0, j = 0;
3468 int dot = 0;
3469 if (buf[i] != '[')
3470 return 0;
3471 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3472 if (!dot && isspace(buf[i])) {
3473 dot = 1;
3474 if (name[j++] != '.')
3475 break;
3476 for (i++; isspace(buf[i]); i++)
3477 ; /* do nothing */
3478 if (buf[i] != '"')
3479 break;
3480 continue;
3482 if (buf[i] == '\\' && dot)
3483 i++;
3484 else if (buf[i] == '"' && dot) {
3485 for (i++; isspace(buf[i]); i++)
3486 ; /* do_nothing */
3487 break;
3489 if (buf[i] != name[j++])
3490 break;
3492 if (buf[i] == ']' && name[j] == 0) {
3494 * We match, now just find the right length offset by
3495 * gobbling up any whitespace after it, as well
3497 i++;
3498 for (; buf[i] && isspace(buf[i]); i++)
3499 ; /* do nothing */
3500 return i;
3502 return 0;
3505 static int section_name_is_ok(const char *name)
3507 /* Empty section names are bogus. */
3508 if (!*name)
3509 return 0;
3512 * Before a dot, we must be alphanumeric or dash. After the first dot,
3513 * anything goes, so we can stop checking.
3515 for (; *name && *name != '.'; name++)
3516 if (*name != '-' && !isalnum(*name))
3517 return 0;
3518 return 1;
3521 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3523 /* if new_name == NULL, the section is removed instead */
3524 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3525 const char *old_name,
3526 const char *new_name, int copy)
3528 int ret = 0, remove = 0;
3529 char *filename_buf = NULL;
3530 struct lock_file lock = LOCK_INIT;
3531 int out_fd;
3532 struct strbuf buf = STRBUF_INIT;
3533 FILE *config_file = NULL;
3534 struct stat st;
3535 struct strbuf copystr = STRBUF_INIT;
3536 struct config_store_data store;
3537 uint32_t line_nr = 0;
3539 memset(&store, 0, sizeof(store));
3541 if (new_name && !section_name_is_ok(new_name)) {
3542 ret = error(_("invalid section name: %s"), new_name);
3543 goto out_no_rollback;
3546 if (!config_filename)
3547 config_filename = filename_buf = git_pathdup("config");
3549 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3550 if (out_fd < 0) {
3551 ret = error(_("could not lock config file %s"), config_filename);
3552 goto out;
3555 if (!(config_file = fopen(config_filename, "rb"))) {
3556 ret = warn_on_fopen_errors(config_filename);
3557 if (ret)
3558 goto out;
3559 /* no config file means nothing to rename, no error */
3560 goto commit_and_out;
3563 if (fstat(fileno(config_file), &st) == -1) {
3564 ret = error_errno(_("fstat on %s failed"), config_filename);
3565 goto out;
3568 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3569 ret = error_errno(_("chmod on %s failed"),
3570 get_lock_file_path(&lock));
3571 goto out;
3574 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3575 size_t i, length;
3576 int is_section = 0;
3577 char *output = buf.buf;
3579 line_nr++;
3581 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3582 ret = error(_("refusing to work with overly long line "
3583 "in '%s' on line %"PRIuMAX),
3584 config_filename, (uintmax_t)line_nr);
3585 goto out;
3588 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3589 ; /* do nothing */
3590 if (buf.buf[i] == '[') {
3591 /* it's a section */
3592 size_t offset;
3593 is_section = 1;
3596 * When encountering a new section under -c we
3597 * need to flush out any section we're already
3598 * coping and begin anew. There might be
3599 * multiple [branch "$name"] sections.
3601 if (copystr.len > 0) {
3602 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3603 ret = write_error(get_lock_file_path(&lock));
3604 goto out;
3606 strbuf_reset(&copystr);
3609 offset = section_name_match(&buf.buf[i], old_name);
3610 if (offset > 0) {
3611 ret++;
3612 if (!new_name) {
3613 remove = 1;
3614 continue;
3616 store.baselen = strlen(new_name);
3617 if (!copy) {
3618 if (write_section(out_fd, new_name, &store) < 0) {
3619 ret = write_error(get_lock_file_path(&lock));
3620 goto out;
3623 * We wrote out the new section, with
3624 * a newline, now skip the old
3625 * section's length
3627 output += offset + i;
3628 if (strlen(output) > 0) {
3630 * More content means there's
3631 * a declaration to put on the
3632 * next line; indent with a
3633 * tab
3635 output -= 1;
3636 output[0] = '\t';
3638 } else {
3639 strbuf_release(&copystr);
3640 copystr = store_create_section(new_name, &store);
3643 remove = 0;
3645 if (remove)
3646 continue;
3647 length = strlen(output);
3649 if (!is_section && copystr.len > 0) {
3650 strbuf_add(&copystr, output, length);
3653 if (write_in_full(out_fd, output, length) < 0) {
3654 ret = write_error(get_lock_file_path(&lock));
3655 goto out;
3660 * Copy a trailing section at the end of the config, won't be
3661 * flushed by the usual "flush because we have a new section
3662 * logic in the loop above.
3664 if (copystr.len > 0) {
3665 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3666 ret = write_error(get_lock_file_path(&lock));
3667 goto out;
3669 strbuf_reset(&copystr);
3672 fclose(config_file);
3673 config_file = NULL;
3674 commit_and_out:
3675 if (commit_lock_file(&lock) < 0)
3676 ret = error_errno(_("could not write config file %s"),
3677 config_filename);
3678 out:
3679 if (config_file)
3680 fclose(config_file);
3681 rollback_lock_file(&lock);
3682 out_no_rollback:
3683 free(filename_buf);
3684 config_store_data_clear(&store);
3685 strbuf_release(&buf);
3686 strbuf_release(&copystr);
3687 return ret;
3690 int git_config_rename_section_in_file(const char *config_filename,
3691 const char *old_name, const char *new_name)
3693 return git_config_copy_or_rename_section_in_file(config_filename,
3694 old_name, new_name, 0);
3697 int git_config_rename_section(const char *old_name, const char *new_name)
3699 return git_config_rename_section_in_file(NULL, old_name, new_name);
3702 int git_config_copy_section_in_file(const char *config_filename,
3703 const char *old_name, const char *new_name)
3705 return git_config_copy_or_rename_section_in_file(config_filename,
3706 old_name, new_name, 1);
3709 int git_config_copy_section(const char *old_name, const char *new_name)
3711 return git_config_copy_section_in_file(NULL, old_name, new_name);
3715 * Call this to report error for your variable that should not
3716 * get a boolean value (i.e. "[my] var" means "true").
3718 #undef config_error_nonbool
3719 int config_error_nonbool(const char *var)
3721 return error(_("missing value for '%s'"), var);
3724 int parse_config_key(const char *var,
3725 const char *section,
3726 const char **subsection, size_t *subsection_len,
3727 const char **key)
3729 const char *dot;
3731 /* Does it start with "section." ? */
3732 if (!skip_prefix(var, section, &var) || *var != '.')
3733 return -1;
3736 * Find the key; we don't know yet if we have a subsection, but we must
3737 * parse backwards from the end, since the subsection may have dots in
3738 * it, too.
3740 dot = strrchr(var, '.');
3741 *key = dot + 1;
3743 /* Did we have a subsection at all? */
3744 if (dot == var) {
3745 if (subsection) {
3746 *subsection = NULL;
3747 *subsection_len = 0;
3750 else {
3751 if (!subsection)
3752 return -1;
3753 *subsection = var + 1;
3754 *subsection_len = dot - *subsection;
3757 return 0;
3760 const char *config_origin_type_name(enum config_origin_type type)
3762 switch (type) {
3763 case CONFIG_ORIGIN_BLOB:
3764 return "blob";
3765 case CONFIG_ORIGIN_FILE:
3766 return "file";
3767 case CONFIG_ORIGIN_STDIN:
3768 return "standard input";
3769 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3770 return "submodule-blob";
3771 case CONFIG_ORIGIN_CMDLINE:
3772 return "command line";
3773 default:
3774 BUG("unknown config origin type");
3778 const char *config_scope_name(enum config_scope scope)
3780 switch (scope) {
3781 case CONFIG_SCOPE_SYSTEM:
3782 return "system";
3783 case CONFIG_SCOPE_GLOBAL:
3784 return "global";
3785 case CONFIG_SCOPE_LOCAL:
3786 return "local";
3787 case CONFIG_SCOPE_WORKTREE:
3788 return "worktree";
3789 case CONFIG_SCOPE_COMMAND:
3790 return "command";
3791 case CONFIG_SCOPE_SUBMODULE:
3792 return "submodule";
3793 default:
3794 return "unknown";
3798 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3800 int i;
3802 for (i = 0; i < nr_mapping; i++) {
3803 const char *name = mapping[i];
3805 if (name && !strcasecmp(var, name))
3806 return i;
3808 return -1;