Merge branch 'vd/sparse-reset-checkout-fixes' into sy/sparse-rm
[git/debian.git] / config.c
blobe8ebef77d5c92423f7af85d9176059e2a772a320
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "date.h"
10 #include "branch.h"
11 #include "config.h"
12 #include "environment.h"
13 #include "repository.h"
14 #include "lockfile.h"
15 #include "exec-cmd.h"
16 #include "strbuf.h"
17 #include "quote.h"
18 #include "hashmap.h"
19 #include "string-list.h"
20 #include "object-store.h"
21 #include "utf8.h"
22 #include "dir.h"
23 #include "color.h"
24 #include "refs.h"
25 #include "worktree.h"
27 struct config_source {
28 struct config_source *prev;
29 union {
30 FILE *file;
31 struct config_buf {
32 const char *buf;
33 size_t len;
34 size_t pos;
35 } buf;
36 } u;
37 enum config_origin_type origin_type;
38 const char *name;
39 const char *path;
40 enum config_error_action default_error_action;
41 int linenr;
42 int eof;
43 size_t total_len;
44 struct strbuf value;
45 struct strbuf var;
46 unsigned subsection_case_sensitive : 1;
48 int (*do_fgetc)(struct config_source *c);
49 int (*do_ungetc)(int c, struct config_source *conf);
50 long (*do_ftell)(struct config_source *c);
54 * These variables record the "current" config source, which
55 * can be accessed by parsing callbacks.
57 * The "cf" variable will be non-NULL only when we are actually parsing a real
58 * config source (file, blob, cmdline, etc).
60 * The "current_config_kvi" variable will be non-NULL only when we are feeding
61 * cached config from a configset into a callback.
63 * They should generally never be non-NULL at the same time. If they are both
64 * NULL, then we aren't parsing anything (and depending on the function looking
65 * at the variables, it's either a bug for it to be called in the first place,
66 * or it's a function which can be reused for non-config purposes, and should
67 * fall back to some sane behavior).
69 static struct config_source *cf;
70 static struct key_value_info *current_config_kvi;
73 * Similar to the variables above, this gives access to the "scope" of the
74 * current value (repo, global, etc). For cached values, it can be found via
75 * the current_config_kvi as above. During parsing, the current value can be
76 * found in this variable. It's not part of "cf" because it transcends a single
77 * file (i.e., a file included from .git/config is still in "repo" scope).
79 static enum config_scope current_parsing_scope;
81 static int pack_compression_seen;
82 static int zlib_compression_seen;
85 * Config that comes from trusted scopes, namely:
86 * - CONFIG_SCOPE_SYSTEM (e.g. /etc/gitconfig)
87 * - CONFIG_SCOPE_GLOBAL (e.g. $HOME/.gitconfig, $XDG_CONFIG_HOME/git)
88 * - CONFIG_SCOPE_COMMAND (e.g. "-c" option, environment variables)
90 * This is declared here for code cleanliness, but unlike the other
91 * static variables, this does not hold config parser state.
93 static struct config_set protected_config;
95 static int config_file_fgetc(struct config_source *conf)
97 return getc_unlocked(conf->u.file);
100 static int config_file_ungetc(int c, struct config_source *conf)
102 return ungetc(c, conf->u.file);
105 static long config_file_ftell(struct config_source *conf)
107 return ftell(conf->u.file);
111 static int config_buf_fgetc(struct config_source *conf)
113 if (conf->u.buf.pos < conf->u.buf.len)
114 return conf->u.buf.buf[conf->u.buf.pos++];
116 return EOF;
119 static int config_buf_ungetc(int c, struct config_source *conf)
121 if (conf->u.buf.pos > 0) {
122 conf->u.buf.pos--;
123 if (conf->u.buf.buf[conf->u.buf.pos] != c)
124 BUG("config_buf can only ungetc the same character");
125 return c;
128 return EOF;
131 static long config_buf_ftell(struct config_source *conf)
133 return conf->u.buf.pos;
136 struct config_include_data {
137 int depth;
138 config_fn_t fn;
139 void *data;
140 const struct config_options *opts;
141 struct git_config_source *config_source;
144 * All remote URLs discovered when reading all config files.
146 struct string_list *remote_urls;
148 #define CONFIG_INCLUDE_INIT { 0 }
150 static int git_config_include(const char *var, const char *value, void *data);
152 #define MAX_INCLUDE_DEPTH 10
153 static const char include_depth_advice[] = N_(
154 "exceeded maximum include depth (%d) while including\n"
155 " %s\n"
156 "from\n"
157 " %s\n"
158 "This might be due to circular includes.");
159 static int handle_path_include(const char *path, struct config_include_data *inc)
161 int ret = 0;
162 struct strbuf buf = STRBUF_INIT;
163 char *expanded;
165 if (!path)
166 return config_error_nonbool("include.path");
168 expanded = interpolate_path(path, 0);
169 if (!expanded)
170 return error(_("could not expand include path '%s'"), path);
171 path = expanded;
174 * Use an absolute path as-is, but interpret relative paths
175 * based on the including config file.
177 if (!is_absolute_path(path)) {
178 char *slash;
180 if (!cf || !cf->path) {
181 ret = error(_("relative config includes must come from files"));
182 goto cleanup;
185 slash = find_last_dir_sep(cf->path);
186 if (slash)
187 strbuf_add(&buf, cf->path, slash - cf->path + 1);
188 strbuf_addstr(&buf, path);
189 path = buf.buf;
192 if (!access_or_die(path, R_OK, 0)) {
193 if (++inc->depth > MAX_INCLUDE_DEPTH)
194 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
195 !cf ? "<unknown>" :
196 cf->name ? cf->name :
197 "the command line");
198 ret = git_config_from_file(git_config_include, path, inc);
199 inc->depth--;
201 cleanup:
202 strbuf_release(&buf);
203 free(expanded);
204 return ret;
207 static void add_trailing_starstar_for_dir(struct strbuf *pat)
209 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
210 strbuf_addstr(pat, "**");
213 static int prepare_include_condition_pattern(struct strbuf *pat)
215 struct strbuf path = STRBUF_INIT;
216 char *expanded;
217 int prefix = 0;
219 expanded = interpolate_path(pat->buf, 1);
220 if (expanded) {
221 strbuf_reset(pat);
222 strbuf_addstr(pat, expanded);
223 free(expanded);
226 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
227 const char *slash;
229 if (!cf || !cf->path)
230 return error(_("relative config include "
231 "conditionals must come from files"));
233 strbuf_realpath(&path, cf->path, 1);
234 slash = find_last_dir_sep(path.buf);
235 if (!slash)
236 BUG("how is this possible?");
237 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
238 prefix = slash - path.buf + 1 /* slash */;
239 } else if (!is_absolute_path(pat->buf))
240 strbuf_insertstr(pat, 0, "**/");
242 add_trailing_starstar_for_dir(pat);
244 strbuf_release(&path);
245 return prefix;
248 static int include_by_gitdir(const struct config_options *opts,
249 const char *cond, size_t cond_len, int icase)
251 struct strbuf text = STRBUF_INIT;
252 struct strbuf pattern = STRBUF_INIT;
253 int ret = 0, prefix;
254 const char *git_dir;
255 int already_tried_absolute = 0;
257 if (opts->git_dir)
258 git_dir = opts->git_dir;
259 else
260 goto done;
262 strbuf_realpath(&text, git_dir, 1);
263 strbuf_add(&pattern, cond, cond_len);
264 prefix = prepare_include_condition_pattern(&pattern);
266 again:
267 if (prefix < 0)
268 goto done;
270 if (prefix > 0) {
272 * perform literal matching on the prefix part so that
273 * any wildcard character in it can't create side effects.
275 if (text.len < prefix)
276 goto done;
277 if (!icase && strncmp(pattern.buf, text.buf, prefix))
278 goto done;
279 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
280 goto done;
283 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
284 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
286 if (!ret && !already_tried_absolute) {
288 * We've tried e.g. matching gitdir:~/work, but if
289 * ~/work is a symlink to /mnt/storage/work
290 * strbuf_realpath() will expand it, so the rule won't
291 * match. Let's match against a
292 * strbuf_add_absolute_path() version of the path,
293 * which'll do the right thing
295 strbuf_reset(&text);
296 strbuf_add_absolute_path(&text, git_dir);
297 already_tried_absolute = 1;
298 goto again;
300 done:
301 strbuf_release(&pattern);
302 strbuf_release(&text);
303 return ret;
306 static int include_by_branch(const char *cond, size_t cond_len)
308 int flags;
309 int ret;
310 struct strbuf pattern = STRBUF_INIT;
311 const char *refname = !the_repository->gitdir ?
312 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
313 const char *shortname;
315 if (!refname || !(flags & REF_ISSYMREF) ||
316 !skip_prefix(refname, "refs/heads/", &shortname))
317 return 0;
319 strbuf_add(&pattern, cond, cond_len);
320 add_trailing_starstar_for_dir(&pattern);
321 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
322 strbuf_release(&pattern);
323 return ret;
326 static int add_remote_url(const char *var, const char *value, void *data)
328 struct string_list *remote_urls = data;
329 const char *remote_name;
330 size_t remote_name_len;
331 const char *key;
333 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
334 &key) &&
335 remote_name &&
336 !strcmp(key, "url"))
337 string_list_append(remote_urls, value);
338 return 0;
341 static void populate_remote_urls(struct config_include_data *inc)
343 struct config_options opts;
345 struct config_source *store_cf = cf;
346 struct key_value_info *store_kvi = current_config_kvi;
347 enum config_scope store_scope = current_parsing_scope;
349 opts = *inc->opts;
350 opts.unconditional_remote_url = 1;
352 cf = NULL;
353 current_config_kvi = NULL;
354 current_parsing_scope = 0;
356 inc->remote_urls = xmalloc(sizeof(*inc->remote_urls));
357 string_list_init_dup(inc->remote_urls);
358 config_with_options(add_remote_url, inc->remote_urls, inc->config_source, &opts);
360 cf = store_cf;
361 current_config_kvi = store_kvi;
362 current_parsing_scope = store_scope;
365 static int forbid_remote_url(const char *var, const char *value, void *data)
367 const char *remote_name;
368 size_t remote_name_len;
369 const char *key;
371 if (!parse_config_key(var, "remote", &remote_name, &remote_name_len,
372 &key) &&
373 remote_name &&
374 !strcmp(key, "url"))
375 die(_("remote URLs cannot be configured in file directly or indirectly included by includeIf.hasconfig:remote.*.url"));
376 return 0;
379 static int at_least_one_url_matches_glob(const char *glob, int glob_len,
380 struct string_list *remote_urls)
382 struct strbuf pattern = STRBUF_INIT;
383 struct string_list_item *url_item;
384 int found = 0;
386 strbuf_add(&pattern, glob, glob_len);
387 for_each_string_list_item(url_item, remote_urls) {
388 if (!wildmatch(pattern.buf, url_item->string, WM_PATHNAME)) {
389 found = 1;
390 break;
393 strbuf_release(&pattern);
394 return found;
397 static int include_by_remote_url(struct config_include_data *inc,
398 const char *cond, size_t cond_len)
400 if (inc->opts->unconditional_remote_url)
401 return 1;
402 if (!inc->remote_urls)
403 populate_remote_urls(inc);
404 return at_least_one_url_matches_glob(cond, cond_len,
405 inc->remote_urls);
408 static int include_condition_is_true(struct config_include_data *inc,
409 const char *cond, size_t cond_len)
411 const struct config_options *opts = inc->opts;
413 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
414 return include_by_gitdir(opts, cond, cond_len, 0);
415 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
416 return include_by_gitdir(opts, cond, cond_len, 1);
417 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
418 return include_by_branch(cond, cond_len);
419 else if (skip_prefix_mem(cond, cond_len, "hasconfig:remote.*.url:", &cond,
420 &cond_len))
421 return include_by_remote_url(inc, cond, cond_len);
423 /* unknown conditionals are always false */
424 return 0;
427 static int git_config_include(const char *var, const char *value, void *data)
429 struct config_include_data *inc = data;
430 const char *cond, *key;
431 size_t cond_len;
432 int ret;
435 * Pass along all values, including "include" directives; this makes it
436 * possible to query information on the includes themselves.
438 ret = inc->fn(var, value, inc->data);
439 if (ret < 0)
440 return ret;
442 if (!strcmp(var, "include.path"))
443 ret = handle_path_include(value, inc);
445 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
446 cond && include_condition_is_true(inc, cond, cond_len) &&
447 !strcmp(key, "path")) {
448 config_fn_t old_fn = inc->fn;
450 if (inc->opts->unconditional_remote_url)
451 inc->fn = forbid_remote_url;
452 ret = handle_path_include(value, inc);
453 inc->fn = old_fn;
456 return ret;
459 static void git_config_push_split_parameter(const char *key, const char *value)
461 struct strbuf env = STRBUF_INIT;
462 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
463 if (old && *old) {
464 strbuf_addstr(&env, old);
465 strbuf_addch(&env, ' ');
467 sq_quote_buf(&env, key);
468 strbuf_addch(&env, '=');
469 if (value)
470 sq_quote_buf(&env, value);
471 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
472 strbuf_release(&env);
475 void git_config_push_parameter(const char *text)
477 const char *value;
480 * When we see:
482 * section.subsection=with=equals.key=value
484 * we cannot tell if it means:
486 * [section "subsection=with=equals"]
487 * key = value
489 * or:
491 * [section]
492 * subsection = with=equals.key=value
494 * We parse left-to-right for the first "=", meaning we'll prefer to
495 * keep the value intact over the subsection. This is historical, but
496 * also sensible since values are more likely to contain odd or
497 * untrusted input than a section name.
499 * A missing equals is explicitly allowed (as a bool-only entry).
501 value = strchr(text, '=');
502 if (value) {
503 char *key = xmemdupz(text, value - text);
504 git_config_push_split_parameter(key, value + 1);
505 free(key);
506 } else {
507 git_config_push_split_parameter(text, NULL);
511 void git_config_push_env(const char *spec)
513 char *key;
514 const char *env_name;
515 const char *env_value;
517 env_name = strrchr(spec, '=');
518 if (!env_name)
519 die(_("invalid config format: %s"), spec);
520 key = xmemdupz(spec, env_name - spec);
521 env_name++;
522 if (!*env_name)
523 die(_("missing environment variable name for configuration '%.*s'"),
524 (int)(env_name - spec - 1), spec);
526 env_value = getenv(env_name);
527 if (!env_value)
528 die(_("missing environment variable '%s' for configuration '%.*s'"),
529 env_name, (int)(env_name - spec - 1), spec);
531 git_config_push_split_parameter(key, env_value);
532 free(key);
535 static inline int iskeychar(int c)
537 return isalnum(c) || c == '-';
541 * Auxiliary function to sanity-check and split the key into the section
542 * identifier and variable name.
544 * Returns 0 on success, -1 when there is an invalid character in the key and
545 * -2 if there is no section name in the key.
547 * store_key - pointer to char* which will hold a copy of the key with
548 * lowercase section and variable name
549 * baselen - pointer to size_t which will hold the length of the
550 * section + subsection part, can be NULL
552 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
554 size_t i, baselen;
555 int dot;
556 const char *last_dot = strrchr(key, '.');
559 * Since "key" actually contains the section name and the real
560 * key name separated by a dot, we have to know where the dot is.
563 if (last_dot == NULL || last_dot == key) {
564 error(_("key does not contain a section: %s"), key);
565 return -CONFIG_NO_SECTION_OR_NAME;
568 if (!last_dot[1]) {
569 error(_("key does not contain variable name: %s"), key);
570 return -CONFIG_NO_SECTION_OR_NAME;
573 baselen = last_dot - key;
574 if (baselen_)
575 *baselen_ = baselen;
578 * Validate the key and while at it, lower case it for matching.
580 *store_key = xmallocz(strlen(key));
582 dot = 0;
583 for (i = 0; key[i]; i++) {
584 unsigned char c = key[i];
585 if (c == '.')
586 dot = 1;
587 /* Leave the extended basename untouched.. */
588 if (!dot || i > baselen) {
589 if (!iskeychar(c) ||
590 (i == baselen + 1 && !isalpha(c))) {
591 error(_("invalid key: %s"), key);
592 goto out_free_ret_1;
594 c = tolower(c);
595 } else if (c == '\n') {
596 error(_("invalid key (newline): %s"), key);
597 goto out_free_ret_1;
599 (*store_key)[i] = c;
602 return 0;
604 out_free_ret_1:
605 FREE_AND_NULL(*store_key);
606 return -CONFIG_INVALID_KEY;
609 static int config_parse_pair(const char *key, const char *value,
610 config_fn_t fn, void *data)
612 char *canonical_name;
613 int ret;
615 if (!strlen(key))
616 return error(_("empty config key"));
617 if (git_config_parse_key(key, &canonical_name, NULL))
618 return -1;
620 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
621 free(canonical_name);
622 return ret;
625 int git_config_parse_parameter(const char *text,
626 config_fn_t fn, void *data)
628 const char *value;
629 struct strbuf **pair;
630 int ret;
632 pair = strbuf_split_str(text, '=', 2);
633 if (!pair[0])
634 return error(_("bogus config parameter: %s"), text);
636 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
637 strbuf_setlen(pair[0], pair[0]->len - 1);
638 value = pair[1] ? pair[1]->buf : "";
639 } else {
640 value = NULL;
643 strbuf_trim(pair[0]);
644 if (!pair[0]->len) {
645 strbuf_list_free(pair);
646 return error(_("bogus config parameter: %s"), text);
649 ret = config_parse_pair(pair[0]->buf, value, fn, data);
650 strbuf_list_free(pair);
651 return ret;
654 static int parse_config_env_list(char *env, config_fn_t fn, void *data)
656 char *cur = env;
657 while (cur && *cur) {
658 const char *key = sq_dequote_step(cur, &cur);
659 if (!key)
660 return error(_("bogus format in %s"),
661 CONFIG_DATA_ENVIRONMENT);
663 if (!cur || isspace(*cur)) {
664 /* old-style 'key=value' */
665 if (git_config_parse_parameter(key, fn, data) < 0)
666 return -1;
668 else if (*cur == '=') {
669 /* new-style 'key'='value' */
670 const char *value;
672 cur++;
673 if (*cur == '\'') {
674 /* quoted value */
675 value = sq_dequote_step(cur, &cur);
676 if (!value || (cur && !isspace(*cur))) {
677 return error(_("bogus format in %s"),
678 CONFIG_DATA_ENVIRONMENT);
680 } else if (!*cur || isspace(*cur)) {
681 /* implicit bool: 'key'= */
682 value = NULL;
683 } else {
684 return error(_("bogus format in %s"),
685 CONFIG_DATA_ENVIRONMENT);
688 if (config_parse_pair(key, value, fn, data) < 0)
689 return -1;
691 else {
692 /* unknown format */
693 return error(_("bogus format in %s"),
694 CONFIG_DATA_ENVIRONMENT);
697 if (cur) {
698 while (isspace(*cur))
699 cur++;
702 return 0;
705 int git_config_from_parameters(config_fn_t fn, void *data)
707 const char *env;
708 struct strbuf envvar = STRBUF_INIT;
709 struct strvec to_free = STRVEC_INIT;
710 int ret = 0;
711 char *envw = NULL;
712 struct config_source source;
714 memset(&source, 0, sizeof(source));
715 source.prev = cf;
716 source.origin_type = CONFIG_ORIGIN_CMDLINE;
717 cf = &source;
719 env = getenv(CONFIG_COUNT_ENVIRONMENT);
720 if (env) {
721 unsigned long count;
722 char *endp;
723 int i;
725 count = strtoul(env, &endp, 10);
726 if (*endp) {
727 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
728 goto out;
730 if (count > INT_MAX) {
731 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
732 goto out;
735 for (i = 0; i < count; i++) {
736 const char *key, *value;
738 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
739 key = getenv_safe(&to_free, envvar.buf);
740 if (!key) {
741 ret = error(_("missing config key %s"), envvar.buf);
742 goto out;
744 strbuf_reset(&envvar);
746 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
747 value = getenv_safe(&to_free, envvar.buf);
748 if (!value) {
749 ret = error(_("missing config value %s"), envvar.buf);
750 goto out;
752 strbuf_reset(&envvar);
754 if (config_parse_pair(key, value, fn, data) < 0) {
755 ret = -1;
756 goto out;
761 env = getenv(CONFIG_DATA_ENVIRONMENT);
762 if (env) {
763 /* sq_dequote will write over it */
764 envw = xstrdup(env);
765 if (parse_config_env_list(envw, fn, data) < 0) {
766 ret = -1;
767 goto out;
771 out:
772 strbuf_release(&envvar);
773 strvec_clear(&to_free);
774 free(envw);
775 cf = source.prev;
776 return ret;
779 static int get_next_char(void)
781 int c = cf->do_fgetc(cf);
783 if (c == '\r') {
784 /* DOS like systems */
785 c = cf->do_fgetc(cf);
786 if (c != '\n') {
787 if (c != EOF)
788 cf->do_ungetc(c, cf);
789 c = '\r';
793 if (c != EOF && ++cf->total_len > INT_MAX) {
795 * This is an absurdly long config file; refuse to parse
796 * further in order to protect downstream code from integer
797 * overflows. Note that we can't return an error specifically,
798 * but we can mark EOF and put trash in the return value,
799 * which will trigger a parse error.
801 cf->eof = 1;
802 return 0;
805 if (c == '\n')
806 cf->linenr++;
807 if (c == EOF) {
808 cf->eof = 1;
809 cf->linenr++;
810 c = '\n';
812 return c;
815 static char *parse_value(void)
817 int quote = 0, comment = 0, space = 0;
819 strbuf_reset(&cf->value);
820 for (;;) {
821 int c = get_next_char();
822 if (c == '\n') {
823 if (quote) {
824 cf->linenr--;
825 return NULL;
827 return cf->value.buf;
829 if (comment)
830 continue;
831 if (isspace(c) && !quote) {
832 if (cf->value.len)
833 space++;
834 continue;
836 if (!quote) {
837 if (c == ';' || c == '#') {
838 comment = 1;
839 continue;
842 for (; space; space--)
843 strbuf_addch(&cf->value, ' ');
844 if (c == '\\') {
845 c = get_next_char();
846 switch (c) {
847 case '\n':
848 continue;
849 case 't':
850 c = '\t';
851 break;
852 case 'b':
853 c = '\b';
854 break;
855 case 'n':
856 c = '\n';
857 break;
858 /* Some characters escape as themselves */
859 case '\\': case '"':
860 break;
861 /* Reject unknown escape sequences */
862 default:
863 return NULL;
865 strbuf_addch(&cf->value, c);
866 continue;
868 if (c == '"') {
869 quote = 1-quote;
870 continue;
872 strbuf_addch(&cf->value, c);
876 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
878 int c;
879 char *value;
880 int ret;
882 /* Get the full name */
883 for (;;) {
884 c = get_next_char();
885 if (cf->eof)
886 break;
887 if (!iskeychar(c))
888 break;
889 strbuf_addch(name, tolower(c));
892 while (c == ' ' || c == '\t')
893 c = get_next_char();
895 value = NULL;
896 if (c != '\n') {
897 if (c != '=')
898 return -1;
899 value = parse_value();
900 if (!value)
901 return -1;
904 * We already consumed the \n, but we need linenr to point to
905 * the line we just parsed during the call to fn to get
906 * accurate line number in error messages.
908 cf->linenr--;
909 ret = fn(name->buf, value, data);
910 if (ret >= 0)
911 cf->linenr++;
912 return ret;
915 static int get_extended_base_var(struct strbuf *name, int c)
917 cf->subsection_case_sensitive = 0;
918 do {
919 if (c == '\n')
920 goto error_incomplete_line;
921 c = get_next_char();
922 } while (isspace(c));
924 /* We require the format to be '[base "extension"]' */
925 if (c != '"')
926 return -1;
927 strbuf_addch(name, '.');
929 for (;;) {
930 int c = get_next_char();
931 if (c == '\n')
932 goto error_incomplete_line;
933 if (c == '"')
934 break;
935 if (c == '\\') {
936 c = get_next_char();
937 if (c == '\n')
938 goto error_incomplete_line;
940 strbuf_addch(name, c);
943 /* Final ']' */
944 if (get_next_char() != ']')
945 return -1;
946 return 0;
947 error_incomplete_line:
948 cf->linenr--;
949 return -1;
952 static int get_base_var(struct strbuf *name)
954 cf->subsection_case_sensitive = 1;
955 for (;;) {
956 int c = get_next_char();
957 if (cf->eof)
958 return -1;
959 if (c == ']')
960 return 0;
961 if (isspace(c))
962 return get_extended_base_var(name, c);
963 if (!iskeychar(c) && c != '.')
964 return -1;
965 strbuf_addch(name, tolower(c));
969 struct parse_event_data {
970 enum config_event_t previous_type;
971 size_t previous_offset;
972 const struct config_options *opts;
975 static int do_event(enum config_event_t type, struct parse_event_data *data)
977 size_t offset;
979 if (!data->opts || !data->opts->event_fn)
980 return 0;
982 if (type == CONFIG_EVENT_WHITESPACE &&
983 data->previous_type == type)
984 return 0;
986 offset = cf->do_ftell(cf);
988 * At EOF, the parser always "inserts" an extra '\n', therefore
989 * the end offset of the event is the current file position, otherwise
990 * we will already have advanced to the next event.
992 if (type != CONFIG_EVENT_EOF)
993 offset--;
995 if (data->previous_type != CONFIG_EVENT_EOF &&
996 data->opts->event_fn(data->previous_type, data->previous_offset,
997 offset, data->opts->event_fn_data) < 0)
998 return -1;
1000 data->previous_type = type;
1001 data->previous_offset = offset;
1003 return 0;
1006 static int git_parse_source(config_fn_t fn, void *data,
1007 const struct config_options *opts)
1009 int comment = 0;
1010 size_t baselen = 0;
1011 struct strbuf *var = &cf->var;
1012 int error_return = 0;
1013 char *error_msg = NULL;
1015 /* U+FEFF Byte Order Mark in UTF8 */
1016 const char *bomptr = utf8_bom;
1018 /* For the parser event callback */
1019 struct parse_event_data event_data = {
1020 CONFIG_EVENT_EOF, 0, opts
1023 for (;;) {
1024 int c;
1026 c = get_next_char();
1027 if (bomptr && *bomptr) {
1028 /* We are at the file beginning; skip UTF8-encoded BOM
1029 * if present. Sane editors won't put this in on their
1030 * own, but e.g. Windows Notepad will do it happily. */
1031 if (c == (*bomptr & 0377)) {
1032 bomptr++;
1033 continue;
1034 } else {
1035 /* Do not tolerate partial BOM. */
1036 if (bomptr != utf8_bom)
1037 break;
1038 /* No BOM at file beginning. Cool. */
1039 bomptr = NULL;
1042 if (c == '\n') {
1043 if (cf->eof) {
1044 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
1045 return -1;
1046 return 0;
1048 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1049 return -1;
1050 comment = 0;
1051 continue;
1053 if (comment)
1054 continue;
1055 if (isspace(c)) {
1056 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
1057 return -1;
1058 continue;
1060 if (c == '#' || c == ';') {
1061 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
1062 return -1;
1063 comment = 1;
1064 continue;
1066 if (c == '[') {
1067 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
1068 return -1;
1070 /* Reset prior to determining a new stem */
1071 strbuf_reset(var);
1072 if (get_base_var(var) < 0 || var->len < 1)
1073 break;
1074 strbuf_addch(var, '.');
1075 baselen = var->len;
1076 continue;
1078 if (!isalpha(c))
1079 break;
1081 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
1082 return -1;
1085 * Truncate the var name back to the section header
1086 * stem prior to grabbing the suffix part of the name
1087 * and the value.
1089 strbuf_setlen(var, baselen);
1090 strbuf_addch(var, tolower(c));
1091 if (get_value(fn, data, var) < 0)
1092 break;
1095 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
1096 return -1;
1098 switch (cf->origin_type) {
1099 case CONFIG_ORIGIN_BLOB:
1100 error_msg = xstrfmt(_("bad config line %d in blob %s"),
1101 cf->linenr, cf->name);
1102 break;
1103 case CONFIG_ORIGIN_FILE:
1104 error_msg = xstrfmt(_("bad config line %d in file %s"),
1105 cf->linenr, cf->name);
1106 break;
1107 case CONFIG_ORIGIN_STDIN:
1108 error_msg = xstrfmt(_("bad config line %d in standard input"),
1109 cf->linenr);
1110 break;
1111 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1112 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1113 cf->linenr, cf->name);
1114 break;
1115 case CONFIG_ORIGIN_CMDLINE:
1116 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1117 cf->linenr, cf->name);
1118 break;
1119 default:
1120 error_msg = xstrfmt(_("bad config line %d in %s"),
1121 cf->linenr, cf->name);
1124 switch (opts && opts->error_action ?
1125 opts->error_action :
1126 cf->default_error_action) {
1127 case CONFIG_ERROR_DIE:
1128 die("%s", error_msg);
1129 break;
1130 case CONFIG_ERROR_ERROR:
1131 error_return = error("%s", error_msg);
1132 break;
1133 case CONFIG_ERROR_SILENT:
1134 error_return = -1;
1135 break;
1136 case CONFIG_ERROR_UNSET:
1137 BUG("config error action unset");
1140 free(error_msg);
1141 return error_return;
1144 static uintmax_t get_unit_factor(const char *end)
1146 if (!*end)
1147 return 1;
1148 else if (!strcasecmp(end, "k"))
1149 return 1024;
1150 else if (!strcasecmp(end, "m"))
1151 return 1024 * 1024;
1152 else if (!strcasecmp(end, "g"))
1153 return 1024 * 1024 * 1024;
1154 return 0;
1157 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1159 if (value && *value) {
1160 char *end;
1161 intmax_t val;
1162 uintmax_t uval;
1163 uintmax_t factor;
1165 errno = 0;
1166 val = strtoimax(value, &end, 0);
1167 if (errno == ERANGE)
1168 return 0;
1169 factor = get_unit_factor(end);
1170 if (!factor) {
1171 errno = EINVAL;
1172 return 0;
1174 uval = val < 0 ? -val : val;
1175 if (unsigned_mult_overflows(factor, uval) ||
1176 factor * uval > max) {
1177 errno = ERANGE;
1178 return 0;
1180 val *= factor;
1181 *ret = val;
1182 return 1;
1184 errno = EINVAL;
1185 return 0;
1188 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1190 if (value && *value) {
1191 char *end;
1192 uintmax_t val;
1193 uintmax_t factor;
1195 errno = 0;
1196 val = strtoumax(value, &end, 0);
1197 if (errno == ERANGE)
1198 return 0;
1199 factor = get_unit_factor(end);
1200 if (!factor) {
1201 errno = EINVAL;
1202 return 0;
1204 if (unsigned_mult_overflows(factor, val) ||
1205 factor * val > max) {
1206 errno = ERANGE;
1207 return 0;
1209 val *= factor;
1210 *ret = val;
1211 return 1;
1213 errno = EINVAL;
1214 return 0;
1217 static int git_parse_int(const char *value, int *ret)
1219 intmax_t tmp;
1220 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1221 return 0;
1222 *ret = tmp;
1223 return 1;
1226 static int git_parse_int64(const char *value, int64_t *ret)
1228 intmax_t tmp;
1229 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1230 return 0;
1231 *ret = tmp;
1232 return 1;
1235 int git_parse_ulong(const char *value, unsigned long *ret)
1237 uintmax_t tmp;
1238 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1239 return 0;
1240 *ret = tmp;
1241 return 1;
1244 int git_parse_ssize_t(const char *value, ssize_t *ret)
1246 intmax_t tmp;
1247 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1248 return 0;
1249 *ret = tmp;
1250 return 1;
1253 NORETURN
1254 static void die_bad_number(const char *name, const char *value)
1256 const char *error_type = (errno == ERANGE) ?
1257 N_("out of range") : N_("invalid unit");
1258 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1260 if (!value)
1261 value = "";
1263 if (!(cf && cf->name))
1264 die(_(bad_numeric), value, name, _(error_type));
1266 switch (cf->origin_type) {
1267 case CONFIG_ORIGIN_BLOB:
1268 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1269 value, name, cf->name, _(error_type));
1270 case CONFIG_ORIGIN_FILE:
1271 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1272 value, name, cf->name, _(error_type));
1273 case CONFIG_ORIGIN_STDIN:
1274 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1275 value, name, _(error_type));
1276 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1277 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1278 value, name, cf->name, _(error_type));
1279 case CONFIG_ORIGIN_CMDLINE:
1280 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1281 value, name, cf->name, _(error_type));
1282 default:
1283 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1284 value, name, cf->name, _(error_type));
1288 int git_config_int(const char *name, const char *value)
1290 int ret;
1291 if (!git_parse_int(value, &ret))
1292 die_bad_number(name, value);
1293 return ret;
1296 int64_t git_config_int64(const char *name, const char *value)
1298 int64_t ret;
1299 if (!git_parse_int64(value, &ret))
1300 die_bad_number(name, value);
1301 return ret;
1304 unsigned long git_config_ulong(const char *name, const char *value)
1306 unsigned long ret;
1307 if (!git_parse_ulong(value, &ret))
1308 die_bad_number(name, value);
1309 return ret;
1312 ssize_t git_config_ssize_t(const char *name, const char *value)
1314 ssize_t ret;
1315 if (!git_parse_ssize_t(value, &ret))
1316 die_bad_number(name, value);
1317 return ret;
1320 static int git_parse_maybe_bool_text(const char *value)
1322 if (!value)
1323 return 1;
1324 if (!*value)
1325 return 0;
1326 if (!strcasecmp(value, "true")
1327 || !strcasecmp(value, "yes")
1328 || !strcasecmp(value, "on"))
1329 return 1;
1330 if (!strcasecmp(value, "false")
1331 || !strcasecmp(value, "no")
1332 || !strcasecmp(value, "off"))
1333 return 0;
1334 return -1;
1337 static const struct fsync_component_name {
1338 const char *name;
1339 enum fsync_component component_bits;
1340 } fsync_component_names[] = {
1341 { "loose-object", FSYNC_COMPONENT_LOOSE_OBJECT },
1342 { "pack", FSYNC_COMPONENT_PACK },
1343 { "pack-metadata", FSYNC_COMPONENT_PACK_METADATA },
1344 { "commit-graph", FSYNC_COMPONENT_COMMIT_GRAPH },
1345 { "index", FSYNC_COMPONENT_INDEX },
1346 { "objects", FSYNC_COMPONENTS_OBJECTS },
1347 { "reference", FSYNC_COMPONENT_REFERENCE },
1348 { "derived-metadata", FSYNC_COMPONENTS_DERIVED_METADATA },
1349 { "committed", FSYNC_COMPONENTS_COMMITTED },
1350 { "added", FSYNC_COMPONENTS_ADDED },
1351 { "all", FSYNC_COMPONENTS_ALL },
1354 static enum fsync_component parse_fsync_components(const char *var, const char *string)
1356 enum fsync_component current = FSYNC_COMPONENTS_PLATFORM_DEFAULT;
1357 enum fsync_component positive = 0, negative = 0;
1359 while (string) {
1360 int i;
1361 size_t len;
1362 const char *ep;
1363 int negated = 0;
1364 int found = 0;
1366 string = string + strspn(string, ", \t\n\r");
1367 ep = strchrnul(string, ',');
1368 len = ep - string;
1369 if (!strcmp(string, "none")) {
1370 current = FSYNC_COMPONENT_NONE;
1371 goto next_name;
1374 if (*string == '-') {
1375 negated = 1;
1376 string++;
1377 len--;
1378 if (!len)
1379 warning(_("invalid value for variable %s"), var);
1382 if (!len)
1383 break;
1385 for (i = 0; i < ARRAY_SIZE(fsync_component_names); ++i) {
1386 const struct fsync_component_name *n = &fsync_component_names[i];
1388 if (strncmp(n->name, string, len))
1389 continue;
1391 found = 1;
1392 if (negated)
1393 negative |= n->component_bits;
1394 else
1395 positive |= n->component_bits;
1398 if (!found) {
1399 char *component = xstrndup(string, len);
1400 warning(_("ignoring unknown core.fsync component '%s'"), component);
1401 free(component);
1404 next_name:
1405 string = ep;
1408 return (current & ~negative) | positive;
1411 int git_parse_maybe_bool(const char *value)
1413 int v = git_parse_maybe_bool_text(value);
1414 if (0 <= v)
1415 return v;
1416 if (git_parse_int(value, &v))
1417 return !!v;
1418 return -1;
1421 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1423 int v = git_parse_maybe_bool_text(value);
1424 if (0 <= v) {
1425 *is_bool = 1;
1426 return v;
1428 *is_bool = 0;
1429 return git_config_int(name, value);
1432 int git_config_bool(const char *name, const char *value)
1434 int v = git_parse_maybe_bool(value);
1435 if (v < 0)
1436 die(_("bad boolean config value '%s' for '%s'"), value, name);
1437 return v;
1440 int git_config_string(const char **dest, const char *var, const char *value)
1442 if (!value)
1443 return config_error_nonbool(var);
1444 *dest = xstrdup(value);
1445 return 0;
1448 int git_config_pathname(const char **dest, const char *var, const char *value)
1450 if (!value)
1451 return config_error_nonbool(var);
1452 *dest = interpolate_path(value, 0);
1453 if (!*dest)
1454 die(_("failed to expand user dir in: '%s'"), value);
1455 return 0;
1458 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1460 if (!value)
1461 return config_error_nonbool(var);
1462 if (parse_expiry_date(value, timestamp))
1463 return error(_("'%s' for '%s' is not a valid timestamp"),
1464 value, var);
1465 return 0;
1468 int git_config_color(char *dest, const char *var, const char *value)
1470 if (!value)
1471 return config_error_nonbool(var);
1472 if (color_parse(value, dest) < 0)
1473 return -1;
1474 return 0;
1477 static int git_default_core_config(const char *var, const char *value, void *cb)
1479 /* This needs a better name */
1480 if (!strcmp(var, "core.filemode")) {
1481 trust_executable_bit = git_config_bool(var, value);
1482 return 0;
1484 if (!strcmp(var, "core.trustctime")) {
1485 trust_ctime = git_config_bool(var, value);
1486 return 0;
1488 if (!strcmp(var, "core.checkstat")) {
1489 if (!strcasecmp(value, "default"))
1490 check_stat = 1;
1491 else if (!strcasecmp(value, "minimal"))
1492 check_stat = 0;
1495 if (!strcmp(var, "core.quotepath")) {
1496 quote_path_fully = git_config_bool(var, value);
1497 return 0;
1500 if (!strcmp(var, "core.symlinks")) {
1501 has_symlinks = git_config_bool(var, value);
1502 return 0;
1505 if (!strcmp(var, "core.ignorecase")) {
1506 ignore_case = git_config_bool(var, value);
1507 return 0;
1510 if (!strcmp(var, "core.attributesfile"))
1511 return git_config_pathname(&git_attributes_file, var, value);
1513 if (!strcmp(var, "core.hookspath"))
1514 return git_config_pathname(&git_hooks_path, var, value);
1516 if (!strcmp(var, "core.bare")) {
1517 is_bare_repository_cfg = git_config_bool(var, value);
1518 return 0;
1521 if (!strcmp(var, "core.ignorestat")) {
1522 assume_unchanged = git_config_bool(var, value);
1523 return 0;
1526 if (!strcmp(var, "core.prefersymlinkrefs")) {
1527 prefer_symlink_refs = git_config_bool(var, value);
1528 return 0;
1531 if (!strcmp(var, "core.logallrefupdates")) {
1532 if (value && !strcasecmp(value, "always"))
1533 log_all_ref_updates = LOG_REFS_ALWAYS;
1534 else if (git_config_bool(var, value))
1535 log_all_ref_updates = LOG_REFS_NORMAL;
1536 else
1537 log_all_ref_updates = LOG_REFS_NONE;
1538 return 0;
1541 if (!strcmp(var, "core.warnambiguousrefs")) {
1542 warn_ambiguous_refs = git_config_bool(var, value);
1543 return 0;
1546 if (!strcmp(var, "core.abbrev")) {
1547 if (!value)
1548 return config_error_nonbool(var);
1549 if (!strcasecmp(value, "auto"))
1550 default_abbrev = -1;
1551 else if (!git_parse_maybe_bool_text(value))
1552 default_abbrev = the_hash_algo->hexsz;
1553 else {
1554 int abbrev = git_config_int(var, value);
1555 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1556 return error(_("abbrev length out of range: %d"), abbrev);
1557 default_abbrev = abbrev;
1559 return 0;
1562 if (!strcmp(var, "core.disambiguate"))
1563 return set_disambiguate_hint_config(var, value);
1565 if (!strcmp(var, "core.loosecompression")) {
1566 int level = git_config_int(var, value);
1567 if (level == -1)
1568 level = Z_DEFAULT_COMPRESSION;
1569 else if (level < 0 || level > Z_BEST_COMPRESSION)
1570 die(_("bad zlib compression level %d"), level);
1571 zlib_compression_level = level;
1572 zlib_compression_seen = 1;
1573 return 0;
1576 if (!strcmp(var, "core.compression")) {
1577 int level = git_config_int(var, value);
1578 if (level == -1)
1579 level = Z_DEFAULT_COMPRESSION;
1580 else if (level < 0 || level > Z_BEST_COMPRESSION)
1581 die(_("bad zlib compression level %d"), level);
1582 if (!zlib_compression_seen)
1583 zlib_compression_level = level;
1584 if (!pack_compression_seen)
1585 pack_compression_level = level;
1586 return 0;
1589 if (!strcmp(var, "core.packedgitwindowsize")) {
1590 int pgsz_x2 = getpagesize() * 2;
1591 packed_git_window_size = git_config_ulong(var, value);
1593 /* This value must be multiple of (pagesize * 2) */
1594 packed_git_window_size /= pgsz_x2;
1595 if (packed_git_window_size < 1)
1596 packed_git_window_size = 1;
1597 packed_git_window_size *= pgsz_x2;
1598 return 0;
1601 if (!strcmp(var, "core.bigfilethreshold")) {
1602 big_file_threshold = git_config_ulong(var, value);
1603 return 0;
1606 if (!strcmp(var, "core.packedgitlimit")) {
1607 packed_git_limit = git_config_ulong(var, value);
1608 return 0;
1611 if (!strcmp(var, "core.deltabasecachelimit")) {
1612 delta_base_cache_limit = git_config_ulong(var, value);
1613 return 0;
1616 if (!strcmp(var, "core.autocrlf")) {
1617 if (value && !strcasecmp(value, "input")) {
1618 auto_crlf = AUTO_CRLF_INPUT;
1619 return 0;
1621 auto_crlf = git_config_bool(var, value);
1622 return 0;
1625 if (!strcmp(var, "core.safecrlf")) {
1626 int eol_rndtrp_die;
1627 if (value && !strcasecmp(value, "warn")) {
1628 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1629 return 0;
1631 eol_rndtrp_die = git_config_bool(var, value);
1632 global_conv_flags_eol = eol_rndtrp_die ?
1633 CONV_EOL_RNDTRP_DIE : 0;
1634 return 0;
1637 if (!strcmp(var, "core.eol")) {
1638 if (value && !strcasecmp(value, "lf"))
1639 core_eol = EOL_LF;
1640 else if (value && !strcasecmp(value, "crlf"))
1641 core_eol = EOL_CRLF;
1642 else if (value && !strcasecmp(value, "native"))
1643 core_eol = EOL_NATIVE;
1644 else
1645 core_eol = EOL_UNSET;
1646 return 0;
1649 if (!strcmp(var, "core.checkroundtripencoding")) {
1650 check_roundtrip_encoding = xstrdup(value);
1651 return 0;
1654 if (!strcmp(var, "core.notesref")) {
1655 notes_ref_name = xstrdup(value);
1656 return 0;
1659 if (!strcmp(var, "core.editor"))
1660 return git_config_string(&editor_program, var, value);
1662 if (!strcmp(var, "core.commentchar")) {
1663 if (!value)
1664 return config_error_nonbool(var);
1665 else if (!strcasecmp(value, "auto"))
1666 auto_comment_line_char = 1;
1667 else if (value[0] && !value[1]) {
1668 comment_line_char = value[0];
1669 auto_comment_line_char = 0;
1670 } else
1671 return error(_("core.commentChar should only be one character"));
1672 return 0;
1675 if (!strcmp(var, "core.askpass"))
1676 return git_config_string(&askpass_program, var, value);
1678 if (!strcmp(var, "core.excludesfile"))
1679 return git_config_pathname(&excludes_file, var, value);
1681 if (!strcmp(var, "core.whitespace")) {
1682 if (!value)
1683 return config_error_nonbool(var);
1684 whitespace_rule_cfg = parse_whitespace_rule(value);
1685 return 0;
1688 if (!strcmp(var, "core.fsync")) {
1689 if (!value)
1690 return config_error_nonbool(var);
1691 fsync_components = parse_fsync_components(var, value);
1692 return 0;
1695 if (!strcmp(var, "core.fsyncmethod")) {
1696 if (!value)
1697 return config_error_nonbool(var);
1698 if (!strcmp(value, "fsync"))
1699 fsync_method = FSYNC_METHOD_FSYNC;
1700 else if (!strcmp(value, "writeout-only"))
1701 fsync_method = FSYNC_METHOD_WRITEOUT_ONLY;
1702 else if (!strcmp(value, "batch"))
1703 fsync_method = FSYNC_METHOD_BATCH;
1704 else
1705 warning(_("ignoring unknown core.fsyncMethod value '%s'"), value);
1709 if (!strcmp(var, "core.fsyncobjectfiles")) {
1710 if (fsync_object_files < 0)
1711 warning(_("core.fsyncObjectFiles is deprecated; use core.fsync instead"));
1712 fsync_object_files = git_config_bool(var, value);
1713 return 0;
1716 if (!strcmp(var, "core.preloadindex")) {
1717 core_preload_index = git_config_bool(var, value);
1718 return 0;
1721 if (!strcmp(var, "core.createobject")) {
1722 if (!strcmp(value, "rename"))
1723 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1724 else if (!strcmp(value, "link"))
1725 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1726 else
1727 die(_("invalid mode for object creation: %s"), value);
1728 return 0;
1731 if (!strcmp(var, "core.sparsecheckout")) {
1732 core_apply_sparse_checkout = git_config_bool(var, value);
1733 return 0;
1736 if (!strcmp(var, "core.sparsecheckoutcone")) {
1737 core_sparse_checkout_cone = git_config_bool(var, value);
1738 return 0;
1741 if (!strcmp(var, "core.precomposeunicode")) {
1742 precomposed_unicode = git_config_bool(var, value);
1743 return 0;
1746 if (!strcmp(var, "core.protecthfs")) {
1747 protect_hfs = git_config_bool(var, value);
1748 return 0;
1751 if (!strcmp(var, "core.protectntfs")) {
1752 protect_ntfs = git_config_bool(var, value);
1753 return 0;
1756 if (!strcmp(var, "core.usereplacerefs")) {
1757 read_replace_refs = git_config_bool(var, value);
1758 return 0;
1761 /* Add other config variables here and to Documentation/config.txt. */
1762 return platform_core_config(var, value, cb);
1765 static int git_default_sparse_config(const char *var, const char *value)
1767 if (!strcmp(var, "sparse.expectfilesoutsideofpatterns")) {
1768 sparse_expect_files_outside_of_patterns = git_config_bool(var, value);
1769 return 0;
1772 /* Add other config variables here and to Documentation/config/sparse.txt. */
1773 return 0;
1776 static int git_default_i18n_config(const char *var, const char *value)
1778 if (!strcmp(var, "i18n.commitencoding"))
1779 return git_config_string(&git_commit_encoding, var, value);
1781 if (!strcmp(var, "i18n.logoutputencoding"))
1782 return git_config_string(&git_log_output_encoding, var, value);
1784 /* Add other config variables here and to Documentation/config.txt. */
1785 return 0;
1788 static int git_default_branch_config(const char *var, const char *value)
1790 if (!strcmp(var, "branch.autosetupmerge")) {
1791 if (value && !strcmp(value, "always")) {
1792 git_branch_track = BRANCH_TRACK_ALWAYS;
1793 return 0;
1794 } else if (value && !strcmp(value, "inherit")) {
1795 git_branch_track = BRANCH_TRACK_INHERIT;
1796 return 0;
1797 } else if (value && !strcmp(value, "simple")) {
1798 git_branch_track = BRANCH_TRACK_SIMPLE;
1799 return 0;
1801 git_branch_track = git_config_bool(var, value);
1802 return 0;
1804 if (!strcmp(var, "branch.autosetuprebase")) {
1805 if (!value)
1806 return config_error_nonbool(var);
1807 else if (!strcmp(value, "never"))
1808 autorebase = AUTOREBASE_NEVER;
1809 else if (!strcmp(value, "local"))
1810 autorebase = AUTOREBASE_LOCAL;
1811 else if (!strcmp(value, "remote"))
1812 autorebase = AUTOREBASE_REMOTE;
1813 else if (!strcmp(value, "always"))
1814 autorebase = AUTOREBASE_ALWAYS;
1815 else
1816 return error(_("malformed value for %s"), var);
1817 return 0;
1820 /* Add other config variables here and to Documentation/config.txt. */
1821 return 0;
1824 static int git_default_push_config(const char *var, const char *value)
1826 if (!strcmp(var, "push.default")) {
1827 if (!value)
1828 return config_error_nonbool(var);
1829 else if (!strcmp(value, "nothing"))
1830 push_default = PUSH_DEFAULT_NOTHING;
1831 else if (!strcmp(value, "matching"))
1832 push_default = PUSH_DEFAULT_MATCHING;
1833 else if (!strcmp(value, "simple"))
1834 push_default = PUSH_DEFAULT_SIMPLE;
1835 else if (!strcmp(value, "upstream"))
1836 push_default = PUSH_DEFAULT_UPSTREAM;
1837 else if (!strcmp(value, "tracking")) /* deprecated */
1838 push_default = PUSH_DEFAULT_UPSTREAM;
1839 else if (!strcmp(value, "current"))
1840 push_default = PUSH_DEFAULT_CURRENT;
1841 else {
1842 error(_("malformed value for %s: %s"), var, value);
1843 return error(_("must be one of nothing, matching, simple, "
1844 "upstream or current"));
1846 return 0;
1849 /* Add other config variables here and to Documentation/config.txt. */
1850 return 0;
1853 static int git_default_mailmap_config(const char *var, const char *value)
1855 if (!strcmp(var, "mailmap.file"))
1856 return git_config_pathname(&git_mailmap_file, var, value);
1857 if (!strcmp(var, "mailmap.blob"))
1858 return git_config_string(&git_mailmap_blob, var, value);
1860 /* Add other config variables here and to Documentation/config.txt. */
1861 return 0;
1864 int git_default_config(const char *var, const char *value, void *cb)
1866 if (starts_with(var, "core."))
1867 return git_default_core_config(var, value, cb);
1869 if (starts_with(var, "user.") ||
1870 starts_with(var, "author.") ||
1871 starts_with(var, "committer."))
1872 return git_ident_config(var, value, cb);
1874 if (starts_with(var, "i18n."))
1875 return git_default_i18n_config(var, value);
1877 if (starts_with(var, "branch."))
1878 return git_default_branch_config(var, value);
1880 if (starts_with(var, "push."))
1881 return git_default_push_config(var, value);
1883 if (starts_with(var, "mailmap."))
1884 return git_default_mailmap_config(var, value);
1886 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1887 return git_default_advice_config(var, value);
1889 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1890 pager_use_color = git_config_bool(var,value);
1891 return 0;
1894 if (!strcmp(var, "pack.packsizelimit")) {
1895 pack_size_limit_cfg = git_config_ulong(var, value);
1896 return 0;
1899 if (!strcmp(var, "pack.compression")) {
1900 int level = git_config_int(var, value);
1901 if (level == -1)
1902 level = Z_DEFAULT_COMPRESSION;
1903 else if (level < 0 || level > Z_BEST_COMPRESSION)
1904 die(_("bad pack compression level %d"), level);
1905 pack_compression_level = level;
1906 pack_compression_seen = 1;
1907 return 0;
1910 if (starts_with(var, "sparse."))
1911 return git_default_sparse_config(var, value);
1913 /* Add other config variables here and to Documentation/config.txt. */
1914 return 0;
1918 * All source specific fields in the union, die_on_error, name and the callbacks
1919 * fgetc, ungetc, ftell of top need to be initialized before calling
1920 * this function.
1922 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1923 const struct config_options *opts)
1925 int ret;
1927 /* push config-file parsing state stack */
1928 top->prev = cf;
1929 top->linenr = 1;
1930 top->eof = 0;
1931 top->total_len = 0;
1932 strbuf_init(&top->value, 1024);
1933 strbuf_init(&top->var, 1024);
1934 cf = top;
1936 ret = git_parse_source(fn, data, opts);
1938 /* pop config-file parsing state stack */
1939 strbuf_release(&top->value);
1940 strbuf_release(&top->var);
1941 cf = top->prev;
1943 return ret;
1946 static int do_config_from_file(config_fn_t fn,
1947 const enum config_origin_type origin_type,
1948 const char *name, const char *path, FILE *f,
1949 void *data, const struct config_options *opts)
1951 struct config_source top;
1952 int ret;
1954 top.u.file = f;
1955 top.origin_type = origin_type;
1956 top.name = name;
1957 top.path = path;
1958 top.default_error_action = CONFIG_ERROR_DIE;
1959 top.do_fgetc = config_file_fgetc;
1960 top.do_ungetc = config_file_ungetc;
1961 top.do_ftell = config_file_ftell;
1963 flockfile(f);
1964 ret = do_config_from(&top, fn, data, opts);
1965 funlockfile(f);
1966 return ret;
1969 static int git_config_from_stdin(config_fn_t fn, void *data)
1971 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1972 data, NULL);
1975 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1976 void *data,
1977 const struct config_options *opts)
1979 int ret = -1;
1980 FILE *f;
1982 if (!filename)
1983 BUG("filename cannot be NULL");
1984 f = fopen_or_warn(filename, "r");
1985 if (f) {
1986 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1987 filename, f, data, opts);
1988 fclose(f);
1990 return ret;
1993 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1995 return git_config_from_file_with_options(fn, filename, data, NULL);
1998 int git_config_from_mem(config_fn_t fn,
1999 const enum config_origin_type origin_type,
2000 const char *name, const char *buf, size_t len,
2001 void *data, const struct config_options *opts)
2003 struct config_source top;
2005 top.u.buf.buf = buf;
2006 top.u.buf.len = len;
2007 top.u.buf.pos = 0;
2008 top.origin_type = origin_type;
2009 top.name = name;
2010 top.path = NULL;
2011 top.default_error_action = CONFIG_ERROR_ERROR;
2012 top.do_fgetc = config_buf_fgetc;
2013 top.do_ungetc = config_buf_ungetc;
2014 top.do_ftell = config_buf_ftell;
2016 return do_config_from(&top, fn, data, opts);
2019 int git_config_from_blob_oid(config_fn_t fn,
2020 const char *name,
2021 struct repository *repo,
2022 const struct object_id *oid,
2023 void *data)
2025 enum object_type type;
2026 char *buf;
2027 unsigned long size;
2028 int ret;
2030 buf = repo_read_object_file(repo, oid, &type, &size);
2031 if (!buf)
2032 return error(_("unable to load config blob object '%s'"), name);
2033 if (type != OBJ_BLOB) {
2034 free(buf);
2035 return error(_("reference '%s' does not point to a blob"), name);
2038 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
2039 data, NULL);
2040 free(buf);
2042 return ret;
2045 static int git_config_from_blob_ref(config_fn_t fn,
2046 struct repository *repo,
2047 const char *name,
2048 void *data)
2050 struct object_id oid;
2052 if (repo_get_oid(repo, name, &oid) < 0)
2053 return error(_("unable to resolve config blob '%s'"), name);
2054 return git_config_from_blob_oid(fn, name, repo, &oid, data);
2057 char *git_system_config(void)
2059 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
2060 if (!system_config)
2061 system_config = system_path(ETC_GITCONFIG);
2062 normalize_path_copy(system_config, system_config);
2063 return system_config;
2066 void git_global_config(char **user_out, char **xdg_out)
2068 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
2069 char *xdg_config = NULL;
2071 if (!user_config) {
2072 user_config = interpolate_path("~/.gitconfig", 0);
2073 xdg_config = xdg_config_home("config");
2076 *user_out = user_config;
2077 *xdg_out = xdg_config;
2081 * Parse environment variable 'k' as a boolean (in various
2082 * possible spellings); if missing, use the default value 'def'.
2084 int git_env_bool(const char *k, int def)
2086 const char *v = getenv(k);
2087 return v ? git_config_bool(k, v) : def;
2091 * Parse environment variable 'k' as ulong with possibly a unit
2092 * suffix; if missing, use the default value 'val'.
2094 unsigned long git_env_ulong(const char *k, unsigned long val)
2096 const char *v = getenv(k);
2097 if (v && !git_parse_ulong(v, &val))
2098 die(_("failed to parse %s"), k);
2099 return val;
2102 int git_config_system(void)
2104 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
2107 static int do_git_config_sequence(const struct config_options *opts,
2108 config_fn_t fn, void *data)
2110 int ret = 0;
2111 char *system_config = git_system_config();
2112 char *xdg_config = NULL;
2113 char *user_config = NULL;
2114 char *repo_config;
2115 enum config_scope prev_parsing_scope = current_parsing_scope;
2117 if (opts->commondir)
2118 repo_config = mkpathdup("%s/config", opts->commondir);
2119 else if (opts->git_dir)
2120 BUG("git_dir without commondir");
2121 else
2122 repo_config = NULL;
2124 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
2125 if (git_config_system() && system_config &&
2126 !access_or_die(system_config, R_OK,
2127 opts->system_gently ? ACCESS_EACCES_OK : 0))
2128 ret += git_config_from_file(fn, system_config, data);
2130 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
2131 git_global_config(&user_config, &xdg_config);
2133 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
2134 ret += git_config_from_file(fn, xdg_config, data);
2136 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
2137 ret += git_config_from_file(fn, user_config, data);
2139 current_parsing_scope = CONFIG_SCOPE_LOCAL;
2140 if (!opts->ignore_repo && repo_config &&
2141 !access_or_die(repo_config, R_OK, 0))
2142 ret += git_config_from_file(fn, repo_config, data);
2144 current_parsing_scope = CONFIG_SCOPE_WORKTREE;
2145 if (!opts->ignore_worktree && repository_format_worktree_config) {
2146 char *path = git_pathdup("config.worktree");
2147 if (!access_or_die(path, R_OK, 0))
2148 ret += git_config_from_file(fn, path, data);
2149 free(path);
2152 current_parsing_scope = CONFIG_SCOPE_COMMAND;
2153 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
2154 die(_("unable to parse command-line config"));
2156 current_parsing_scope = prev_parsing_scope;
2157 free(system_config);
2158 free(xdg_config);
2159 free(user_config);
2160 free(repo_config);
2161 return ret;
2164 int config_with_options(config_fn_t fn, void *data,
2165 struct git_config_source *config_source,
2166 const struct config_options *opts)
2168 struct config_include_data inc = CONFIG_INCLUDE_INIT;
2169 int ret;
2171 if (opts->respect_includes) {
2172 inc.fn = fn;
2173 inc.data = data;
2174 inc.opts = opts;
2175 inc.config_source = config_source;
2176 fn = git_config_include;
2177 data = &inc;
2180 if (config_source)
2181 current_parsing_scope = config_source->scope;
2184 * If we have a specific filename, use it. Otherwise, follow the
2185 * regular lookup sequence.
2187 if (config_source && config_source->use_stdin) {
2188 ret = git_config_from_stdin(fn, data);
2189 } else if (config_source && config_source->file) {
2190 ret = git_config_from_file(fn, config_source->file, data);
2191 } else if (config_source && config_source->blob) {
2192 struct repository *repo = config_source->repo ?
2193 config_source->repo : the_repository;
2194 ret = git_config_from_blob_ref(fn, repo, config_source->blob,
2195 data);
2196 } else {
2197 ret = do_git_config_sequence(opts, fn, data);
2200 if (inc.remote_urls) {
2201 string_list_clear(inc.remote_urls, 0);
2202 FREE_AND_NULL(inc.remote_urls);
2204 return ret;
2207 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
2209 int i, value_index;
2210 struct string_list *values;
2211 struct config_set_element *entry;
2212 struct configset_list *list = &cs->list;
2214 for (i = 0; i < list->nr; i++) {
2215 entry = list->items[i].e;
2216 value_index = list->items[i].value_index;
2217 values = &entry->value_list;
2219 current_config_kvi = values->items[value_index].util;
2221 if (fn(entry->key, values->items[value_index].string, data) < 0)
2222 git_die_config_linenr(entry->key,
2223 current_config_kvi->filename,
2224 current_config_kvi->linenr);
2226 current_config_kvi = NULL;
2230 void read_early_config(config_fn_t cb, void *data)
2232 struct config_options opts = {0};
2233 struct strbuf commondir = STRBUF_INIT;
2234 struct strbuf gitdir = STRBUF_INIT;
2236 opts.respect_includes = 1;
2238 if (have_git_dir()) {
2239 opts.commondir = get_git_common_dir();
2240 opts.git_dir = get_git_dir();
2242 * When setup_git_directory() was not yet asked to discover the
2243 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2244 * is any repository config we should use (but unlike
2245 * setup_git_directory_gently(), no global state is changed, most
2246 * notably, the current working directory is still the same after the
2247 * call).
2249 } else if (!discover_git_directory(&commondir, &gitdir)) {
2250 opts.commondir = commondir.buf;
2251 opts.git_dir = gitdir.buf;
2254 config_with_options(cb, data, NULL, &opts);
2256 strbuf_release(&commondir);
2257 strbuf_release(&gitdir);
2261 * Read config but only enumerate system and global settings.
2262 * Omit any repo-local, worktree-local, or command-line settings.
2264 void read_very_early_config(config_fn_t cb, void *data)
2266 struct config_options opts = { 0 };
2268 opts.respect_includes = 1;
2269 opts.ignore_repo = 1;
2270 opts.ignore_worktree = 1;
2271 opts.ignore_cmdline = 1;
2272 opts.system_gently = 1;
2274 config_with_options(cb, data, NULL, &opts);
2277 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
2279 struct config_set_element k;
2280 struct config_set_element *found_entry;
2281 char *normalized_key;
2283 * `key` may come from the user, so normalize it before using it
2284 * for querying entries from the hashmap.
2286 if (git_config_parse_key(key, &normalized_key, NULL))
2287 return NULL;
2289 hashmap_entry_init(&k.ent, strhash(normalized_key));
2290 k.key = normalized_key;
2291 found_entry = hashmap_get_entry(&cs->config_hash, &k, ent, NULL);
2292 free(normalized_key);
2293 return found_entry;
2296 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
2298 struct config_set_element *e;
2299 struct string_list_item *si;
2300 struct configset_list_item *l_item;
2301 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2303 e = configset_find_element(cs, key);
2305 * Since the keys are being fed by git_config*() callback mechanism, they
2306 * are already normalized. So simply add them without any further munging.
2308 if (!e) {
2309 e = xmalloc(sizeof(*e));
2310 hashmap_entry_init(&e->ent, strhash(key));
2311 e->key = xstrdup(key);
2312 string_list_init_dup(&e->value_list);
2313 hashmap_add(&cs->config_hash, &e->ent);
2315 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2317 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
2318 l_item = &cs->list.items[cs->list.nr++];
2319 l_item->e = e;
2320 l_item->value_index = e->value_list.nr - 1;
2322 if (!cf)
2323 BUG("configset_add_value has no source");
2324 if (cf->name) {
2325 kv_info->filename = strintern(cf->name);
2326 kv_info->linenr = cf->linenr;
2327 kv_info->origin_type = cf->origin_type;
2328 } else {
2329 /* for values read from `git_config_from_parameters()` */
2330 kv_info->filename = NULL;
2331 kv_info->linenr = -1;
2332 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
2334 kv_info->scope = current_parsing_scope;
2335 si->util = kv_info;
2337 return 0;
2340 static int config_set_element_cmp(const void *unused_cmp_data,
2341 const struct hashmap_entry *eptr,
2342 const struct hashmap_entry *entry_or_key,
2343 const void *unused_keydata)
2345 const struct config_set_element *e1, *e2;
2347 e1 = container_of(eptr, const struct config_set_element, ent);
2348 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2350 return strcmp(e1->key, e2->key);
2353 void git_configset_init(struct config_set *cs)
2355 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
2356 cs->hash_initialized = 1;
2357 cs->list.nr = 0;
2358 cs->list.alloc = 0;
2359 cs->list.items = NULL;
2362 void git_configset_clear(struct config_set *cs)
2364 struct config_set_element *entry;
2365 struct hashmap_iter iter;
2366 if (!cs->hash_initialized)
2367 return;
2369 hashmap_for_each_entry(&cs->config_hash, &iter, entry,
2370 ent /* member name */) {
2371 free(entry->key);
2372 string_list_clear(&entry->value_list, 1);
2374 hashmap_clear_and_free(&cs->config_hash, struct config_set_element, ent);
2375 cs->hash_initialized = 0;
2376 free(cs->list.items);
2377 cs->list.nr = 0;
2378 cs->list.alloc = 0;
2379 cs->list.items = NULL;
2382 static int config_set_callback(const char *key, const char *value, void *cb)
2384 struct config_set *cs = cb;
2385 configset_add_value(cs, key, value);
2386 return 0;
2389 int git_configset_add_file(struct config_set *cs, const char *filename)
2391 return git_config_from_file(config_set_callback, filename, cs);
2394 int git_configset_add_parameters(struct config_set *cs)
2396 return git_config_from_parameters(config_set_callback, cs);
2399 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
2401 const struct string_list *values = NULL;
2403 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2404 * queried key in the files of the configset, the value returned will be the last
2405 * value in the value list for that key.
2407 values = git_configset_get_value_multi(cs, key);
2409 if (!values)
2410 return 1;
2411 assert(values->nr > 0);
2412 *value = values->items[values->nr - 1].string;
2413 return 0;
2416 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
2418 struct config_set_element *e = configset_find_element(cs, key);
2419 return e ? &e->value_list : NULL;
2422 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
2424 const char *value;
2425 if (!git_configset_get_value(cs, key, &value))
2426 return git_config_string((const char **)dest, key, value);
2427 else
2428 return 1;
2431 static int git_configset_get_string_tmp(struct config_set *cs, const char *key,
2432 const char **dest)
2434 const char *value;
2435 if (!git_configset_get_value(cs, key, &value)) {
2436 if (!value)
2437 return config_error_nonbool(key);
2438 *dest = value;
2439 return 0;
2440 } else {
2441 return 1;
2445 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
2447 const char *value;
2448 if (!git_configset_get_value(cs, key, &value)) {
2449 *dest = git_config_int(key, value);
2450 return 0;
2451 } else
2452 return 1;
2455 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
2457 const char *value;
2458 if (!git_configset_get_value(cs, key, &value)) {
2459 *dest = git_config_ulong(key, value);
2460 return 0;
2461 } else
2462 return 1;
2465 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
2467 const char *value;
2468 if (!git_configset_get_value(cs, key, &value)) {
2469 *dest = git_config_bool(key, value);
2470 return 0;
2471 } else
2472 return 1;
2475 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
2476 int *is_bool, int *dest)
2478 const char *value;
2479 if (!git_configset_get_value(cs, key, &value)) {
2480 *dest = git_config_bool_or_int(key, value, is_bool);
2481 return 0;
2482 } else
2483 return 1;
2486 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2488 const char *value;
2489 if (!git_configset_get_value(cs, key, &value)) {
2490 *dest = git_parse_maybe_bool(value);
2491 if (*dest == -1)
2492 return -1;
2493 return 0;
2494 } else
2495 return 1;
2498 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2500 const char *value;
2501 if (!git_configset_get_value(cs, key, &value))
2502 return git_config_pathname(dest, key, value);
2503 else
2504 return 1;
2507 /* Functions use to read configuration from a repository */
2508 static void repo_read_config(struct repository *repo)
2510 struct config_options opts = { 0 };
2512 opts.respect_includes = 1;
2513 opts.commondir = repo->commondir;
2514 opts.git_dir = repo->gitdir;
2516 if (!repo->config)
2517 CALLOC_ARRAY(repo->config, 1);
2518 else
2519 git_configset_clear(repo->config);
2521 git_configset_init(repo->config);
2523 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2525 * config_with_options() normally returns only
2526 * zero, as most errors are fatal, and
2527 * non-fatal potential errors are guarded by "if"
2528 * statements that are entered only when no error is
2529 * possible.
2531 * If we ever encounter a non-fatal error, it means
2532 * something went really wrong and we should stop
2533 * immediately.
2535 die(_("unknown error occurred while reading the configuration files"));
2538 static void git_config_check_init(struct repository *repo)
2540 if (repo->config && repo->config->hash_initialized)
2541 return;
2542 repo_read_config(repo);
2545 static void repo_config_clear(struct repository *repo)
2547 if (!repo->config || !repo->config->hash_initialized)
2548 return;
2549 git_configset_clear(repo->config);
2552 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2554 git_config_check_init(repo);
2555 configset_iter(repo->config, fn, data);
2558 int repo_config_get_value(struct repository *repo,
2559 const char *key, const char **value)
2561 git_config_check_init(repo);
2562 return git_configset_get_value(repo->config, key, value);
2565 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2566 const char *key)
2568 git_config_check_init(repo);
2569 return git_configset_get_value_multi(repo->config, key);
2572 int repo_config_get_string(struct repository *repo,
2573 const char *key, char **dest)
2575 int ret;
2576 git_config_check_init(repo);
2577 ret = git_configset_get_string(repo->config, key, dest);
2578 if (ret < 0)
2579 git_die_config(key, NULL);
2580 return ret;
2583 int repo_config_get_string_tmp(struct repository *repo,
2584 const char *key, const char **dest)
2586 int ret;
2587 git_config_check_init(repo);
2588 ret = git_configset_get_string_tmp(repo->config, key, dest);
2589 if (ret < 0)
2590 git_die_config(key, NULL);
2591 return ret;
2594 int repo_config_get_int(struct repository *repo,
2595 const char *key, int *dest)
2597 git_config_check_init(repo);
2598 return git_configset_get_int(repo->config, key, dest);
2601 int repo_config_get_ulong(struct repository *repo,
2602 const char *key, unsigned long *dest)
2604 git_config_check_init(repo);
2605 return git_configset_get_ulong(repo->config, key, dest);
2608 int repo_config_get_bool(struct repository *repo,
2609 const char *key, int *dest)
2611 git_config_check_init(repo);
2612 return git_configset_get_bool(repo->config, key, dest);
2615 int repo_config_get_bool_or_int(struct repository *repo,
2616 const char *key, int *is_bool, int *dest)
2618 git_config_check_init(repo);
2619 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2622 int repo_config_get_maybe_bool(struct repository *repo,
2623 const char *key, int *dest)
2625 git_config_check_init(repo);
2626 return git_configset_get_maybe_bool(repo->config, key, dest);
2629 int repo_config_get_pathname(struct repository *repo,
2630 const char *key, const char **dest)
2632 int ret;
2633 git_config_check_init(repo);
2634 ret = git_configset_get_pathname(repo->config, key, dest);
2635 if (ret < 0)
2636 git_die_config(key, NULL);
2637 return ret;
2640 /* Read values into protected_config. */
2641 static void read_protected_config(void)
2643 char *xdg_config = NULL, *user_config = NULL, *system_config = NULL;
2645 git_configset_init(&protected_config);
2647 system_config = git_system_config();
2648 git_global_config(&user_config, &xdg_config);
2650 if (system_config)
2651 git_configset_add_file(&protected_config, system_config);
2652 if (xdg_config)
2653 git_configset_add_file(&protected_config, xdg_config);
2654 if (user_config)
2655 git_configset_add_file(&protected_config, user_config);
2656 git_configset_add_parameters(&protected_config);
2658 free(system_config);
2659 free(xdg_config);
2660 free(user_config);
2663 void git_protected_config(config_fn_t fn, void *data)
2665 if (!protected_config.hash_initialized)
2666 read_protected_config();
2667 configset_iter(&protected_config, fn, data);
2670 /* Functions used historically to read configuration from 'the_repository' */
2671 void git_config(config_fn_t fn, void *data)
2673 repo_config(the_repository, fn, data);
2676 void git_config_clear(void)
2678 repo_config_clear(the_repository);
2681 int git_config_get_value(const char *key, const char **value)
2683 return repo_config_get_value(the_repository, key, value);
2686 const struct string_list *git_config_get_value_multi(const char *key)
2688 return repo_config_get_value_multi(the_repository, key);
2691 int git_config_get_string(const char *key, char **dest)
2693 return repo_config_get_string(the_repository, key, dest);
2696 int git_config_get_string_tmp(const char *key, const char **dest)
2698 return repo_config_get_string_tmp(the_repository, key, dest);
2701 int git_config_get_int(const char *key, int *dest)
2703 return repo_config_get_int(the_repository, key, dest);
2706 int git_config_get_ulong(const char *key, unsigned long *dest)
2708 return repo_config_get_ulong(the_repository, key, dest);
2711 int git_config_get_bool(const char *key, int *dest)
2713 return repo_config_get_bool(the_repository, key, dest);
2716 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2718 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2721 int git_config_get_maybe_bool(const char *key, int *dest)
2723 return repo_config_get_maybe_bool(the_repository, key, dest);
2726 int git_config_get_pathname(const char *key, const char **dest)
2728 return repo_config_get_pathname(the_repository, key, dest);
2731 int git_config_get_expiry(const char *key, const char **output)
2733 int ret = git_config_get_string(key, (char **)output);
2734 if (ret)
2735 return ret;
2736 if (strcmp(*output, "now")) {
2737 timestamp_t now = approxidate("now");
2738 if (approxidate(*output) >= now)
2739 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2741 return ret;
2744 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2746 const char *expiry_string;
2747 intmax_t days;
2748 timestamp_t when;
2750 if (git_config_get_string_tmp(key, &expiry_string))
2751 return 1; /* no such thing */
2753 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2754 const int scale = 86400;
2755 *expiry = now - days * scale;
2756 return 0;
2759 if (!parse_expiry_date(expiry_string, &when)) {
2760 *expiry = when;
2761 return 0;
2763 return -1; /* thing exists but cannot be parsed */
2766 int git_config_get_split_index(void)
2768 int val;
2770 if (!git_config_get_maybe_bool("core.splitindex", &val))
2771 return val;
2773 return -1; /* default value */
2776 int git_config_get_max_percent_split_change(void)
2778 int val = -1;
2780 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2781 if (0 <= val && val <= 100)
2782 return val;
2784 return error(_("splitIndex.maxPercentChange value '%d' "
2785 "should be between 0 and 100"), val);
2788 return -1; /* default value */
2791 int git_config_get_index_threads(int *dest)
2793 int is_bool, val;
2795 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2796 if (val) {
2797 *dest = val;
2798 return 0;
2801 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2802 if (is_bool)
2803 *dest = val ? 0 : 1;
2804 else
2805 *dest = val;
2806 return 0;
2809 return 1;
2812 NORETURN
2813 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2815 if (!filename)
2816 die(_("unable to parse '%s' from command-line config"), key);
2817 else
2818 die(_("bad config variable '%s' in file '%s' at line %d"),
2819 key, filename, linenr);
2822 NORETURN __attribute__((format(printf, 2, 3)))
2823 void git_die_config(const char *key, const char *err, ...)
2825 const struct string_list *values;
2826 struct key_value_info *kv_info;
2827 report_fn error_fn = get_error_routine();
2829 if (err) {
2830 va_list params;
2831 va_start(params, err);
2832 error_fn(err, params);
2833 va_end(params);
2835 values = git_config_get_value_multi(key);
2836 kv_info = values->items[values->nr - 1].util;
2837 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2841 * Find all the stuff for git_config_set() below.
2844 struct config_store_data {
2845 size_t baselen;
2846 char *key;
2847 int do_not_match;
2848 const char *fixed_value;
2849 regex_t *value_pattern;
2850 int multi_replace;
2851 struct {
2852 size_t begin, end;
2853 enum config_event_t type;
2854 int is_keys_section;
2855 } *parsed;
2856 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2857 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2860 static void config_store_data_clear(struct config_store_data *store)
2862 free(store->key);
2863 if (store->value_pattern != NULL &&
2864 store->value_pattern != CONFIG_REGEX_NONE) {
2865 regfree(store->value_pattern);
2866 free(store->value_pattern);
2868 free(store->parsed);
2869 free(store->seen);
2870 memset(store, 0, sizeof(*store));
2873 static int matches(const char *key, const char *value,
2874 const struct config_store_data *store)
2876 if (strcmp(key, store->key))
2877 return 0; /* not ours */
2878 if (store->fixed_value)
2879 return !strcmp(store->fixed_value, value);
2880 if (!store->value_pattern)
2881 return 1; /* always matches */
2882 if (store->value_pattern == CONFIG_REGEX_NONE)
2883 return 0; /* never matches */
2885 return store->do_not_match ^
2886 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2889 static int store_aux_event(enum config_event_t type,
2890 size_t begin, size_t end, void *data)
2892 struct config_store_data *store = data;
2894 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2895 store->parsed[store->parsed_nr].begin = begin;
2896 store->parsed[store->parsed_nr].end = end;
2897 store->parsed[store->parsed_nr].type = type;
2899 if (type == CONFIG_EVENT_SECTION) {
2900 int (*cmpfn)(const char *, const char *, size_t);
2902 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2903 return error(_("invalid section name '%s'"), cf->var.buf);
2905 if (cf->subsection_case_sensitive)
2906 cmpfn = strncasecmp;
2907 else
2908 cmpfn = strncmp;
2910 /* Is this the section we were looking for? */
2911 store->is_keys_section =
2912 store->parsed[store->parsed_nr].is_keys_section =
2913 cf->var.len - 1 == store->baselen &&
2914 !cmpfn(cf->var.buf, store->key, store->baselen);
2915 if (store->is_keys_section) {
2916 store->section_seen = 1;
2917 ALLOC_GROW(store->seen, store->seen_nr + 1,
2918 store->seen_alloc);
2919 store->seen[store->seen_nr] = store->parsed_nr;
2923 store->parsed_nr++;
2925 return 0;
2928 static int store_aux(const char *key, const char *value, void *cb)
2930 struct config_store_data *store = cb;
2932 if (store->key_seen) {
2933 if (matches(key, value, store)) {
2934 if (store->seen_nr == 1 && store->multi_replace == 0) {
2935 warning(_("%s has multiple values"), key);
2938 ALLOC_GROW(store->seen, store->seen_nr + 1,
2939 store->seen_alloc);
2941 store->seen[store->seen_nr] = store->parsed_nr;
2942 store->seen_nr++;
2944 } else if (store->is_keys_section) {
2946 * Do not increment matches yet: this may not be a match, but we
2947 * are in the desired section.
2949 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2950 store->seen[store->seen_nr] = store->parsed_nr;
2951 store->section_seen = 1;
2953 if (matches(key, value, store)) {
2954 store->seen_nr++;
2955 store->key_seen = 1;
2959 return 0;
2962 static int write_error(const char *filename)
2964 error(_("failed to write new configuration file %s"), filename);
2966 /* Same error code as "failed to rename". */
2967 return 4;
2970 static struct strbuf store_create_section(const char *key,
2971 const struct config_store_data *store)
2973 const char *dot;
2974 size_t i;
2975 struct strbuf sb = STRBUF_INIT;
2977 dot = memchr(key, '.', store->baselen);
2978 if (dot) {
2979 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2980 for (i = dot - key + 1; i < store->baselen; i++) {
2981 if (key[i] == '"' || key[i] == '\\')
2982 strbuf_addch(&sb, '\\');
2983 strbuf_addch(&sb, key[i]);
2985 strbuf_addstr(&sb, "\"]\n");
2986 } else {
2987 strbuf_addch(&sb, '[');
2988 strbuf_add(&sb, key, store->baselen);
2989 strbuf_addstr(&sb, "]\n");
2992 return sb;
2995 static ssize_t write_section(int fd, const char *key,
2996 const struct config_store_data *store)
2998 struct strbuf sb = store_create_section(key, store);
2999 ssize_t ret;
3001 ret = write_in_full(fd, sb.buf, sb.len);
3002 strbuf_release(&sb);
3004 return ret;
3007 static ssize_t write_pair(int fd, const char *key, const char *value,
3008 const struct config_store_data *store)
3010 int i;
3011 ssize_t ret;
3012 const char *quote = "";
3013 struct strbuf sb = STRBUF_INIT;
3016 * Check to see if the value needs to be surrounded with a dq pair.
3017 * Note that problematic characters are always backslash-quoted; this
3018 * check is about not losing leading or trailing SP and strings that
3019 * follow beginning-of-comment characters (i.e. ';' and '#') by the
3020 * configuration parser.
3022 if (value[0] == ' ')
3023 quote = "\"";
3024 for (i = 0; value[i]; i++)
3025 if (value[i] == ';' || value[i] == '#')
3026 quote = "\"";
3027 if (i && value[i - 1] == ' ')
3028 quote = "\"";
3030 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
3032 for (i = 0; value[i]; i++)
3033 switch (value[i]) {
3034 case '\n':
3035 strbuf_addstr(&sb, "\\n");
3036 break;
3037 case '\t':
3038 strbuf_addstr(&sb, "\\t");
3039 break;
3040 case '"':
3041 case '\\':
3042 strbuf_addch(&sb, '\\');
3043 /* fallthrough */
3044 default:
3045 strbuf_addch(&sb, value[i]);
3046 break;
3048 strbuf_addf(&sb, "%s\n", quote);
3050 ret = write_in_full(fd, sb.buf, sb.len);
3051 strbuf_release(&sb);
3053 return ret;
3057 * If we are about to unset the last key(s) in a section, and if there are
3058 * no comments surrounding (or included in) the section, we will want to
3059 * extend begin/end to remove the entire section.
3061 * Note: the parameter `seen_ptr` points to the index into the store.seen
3062 * array. * This index may be incremented if a section has more than one
3063 * entry (which all are to be removed).
3065 static void maybe_remove_section(struct config_store_data *store,
3066 size_t *begin_offset, size_t *end_offset,
3067 int *seen_ptr)
3069 size_t begin;
3070 int i, seen, section_seen = 0;
3073 * First, ensure that this is the first key, and that there are no
3074 * comments before the entry nor before the section header.
3076 seen = *seen_ptr;
3077 for (i = store->seen[seen]; i > 0; i--) {
3078 enum config_event_t type = store->parsed[i - 1].type;
3080 if (type == CONFIG_EVENT_COMMENT)
3081 /* There is a comment before this entry or section */
3082 return;
3083 if (type == CONFIG_EVENT_ENTRY) {
3084 if (!section_seen)
3085 /* This is not the section's first entry. */
3086 return;
3087 /* We encountered no comment before the section. */
3088 break;
3090 if (type == CONFIG_EVENT_SECTION) {
3091 if (!store->parsed[i - 1].is_keys_section)
3092 break;
3093 section_seen = 1;
3096 begin = store->parsed[i].begin;
3099 * Next, make sure that we are removing the last key(s) in the section,
3100 * and that there are no comments that are possibly about the current
3101 * section.
3103 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
3104 enum config_event_t type = store->parsed[i].type;
3106 if (type == CONFIG_EVENT_COMMENT)
3107 return;
3108 if (type == CONFIG_EVENT_SECTION) {
3109 if (store->parsed[i].is_keys_section)
3110 continue;
3111 break;
3113 if (type == CONFIG_EVENT_ENTRY) {
3114 if (++seen < store->seen_nr &&
3115 i == store->seen[seen])
3116 /* We want to remove this entry, too */
3117 continue;
3118 /* There is another entry in this section. */
3119 return;
3124 * We are really removing the last entry/entries from this section, and
3125 * there are no enclosed or surrounding comments. Remove the entire,
3126 * now-empty section.
3128 *seen_ptr = seen;
3129 *begin_offset = begin;
3130 if (i < store->parsed_nr)
3131 *end_offset = store->parsed[i].begin;
3132 else
3133 *end_offset = store->parsed[store->parsed_nr - 1].end;
3136 int git_config_set_in_file_gently(const char *config_filename,
3137 const char *key, const char *value)
3139 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
3142 void git_config_set_in_file(const char *config_filename,
3143 const char *key, const char *value)
3145 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
3148 int git_config_set_gently(const char *key, const char *value)
3150 return git_config_set_multivar_gently(key, value, NULL, 0);
3153 int repo_config_set_worktree_gently(struct repository *r,
3154 const char *key, const char *value)
3156 /* Only use worktree-specific config if it is is already enabled. */
3157 if (repository_format_worktree_config) {
3158 char *file = repo_git_path(r, "config.worktree");
3159 int ret = git_config_set_multivar_in_file_gently(
3160 file, key, value, NULL, 0);
3161 free(file);
3162 return ret;
3164 return repo_config_set_multivar_gently(r, key, value, NULL, 0);
3167 void git_config_set(const char *key, const char *value)
3169 git_config_set_multivar(key, value, NULL, 0);
3171 trace2_cmd_set_config(key, value);
3175 * If value==NULL, unset in (remove from) config,
3176 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
3177 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
3178 * (only add a new one)
3179 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
3180 * key/values are removed before a single new pair is written. If the
3181 * flag is not present, then replace only the first match.
3183 * Returns 0 on success.
3185 * This function does this:
3187 * - it locks the config file by creating ".git/config.lock"
3189 * - it then parses the config using store_aux() as validator to find
3190 * the position on the key/value pair to replace. If it is to be unset,
3191 * it must be found exactly once.
3193 * - the config file is mmap()ed and the part before the match (if any) is
3194 * written to the lock file, then the changed part and the rest.
3196 * - the config file is removed and the lock file rename()d to it.
3199 int git_config_set_multivar_in_file_gently(const char *config_filename,
3200 const char *key, const char *value,
3201 const char *value_pattern,
3202 unsigned flags)
3204 int fd = -1, in_fd = -1;
3205 int ret;
3206 struct lock_file lock = LOCK_INIT;
3207 char *filename_buf = NULL;
3208 char *contents = NULL;
3209 size_t contents_sz;
3210 struct config_store_data store;
3212 memset(&store, 0, sizeof(store));
3214 /* parse-key returns negative; flip the sign to feed exit(3) */
3215 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
3216 if (ret)
3217 goto out_free;
3219 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
3221 if (!config_filename)
3222 config_filename = filename_buf = git_pathdup("config");
3225 * The lock serves a purpose in addition to locking: the new
3226 * contents of .git/config will be written into it.
3228 fd = hold_lock_file_for_update(&lock, config_filename, 0);
3229 if (fd < 0) {
3230 error_errno(_("could not lock config file %s"), config_filename);
3231 ret = CONFIG_NO_LOCK;
3232 goto out_free;
3236 * If .git/config does not exist yet, write a minimal version.
3238 in_fd = open(config_filename, O_RDONLY);
3239 if ( in_fd < 0 ) {
3240 if ( ENOENT != errno ) {
3241 error_errno(_("opening %s"), config_filename);
3242 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
3243 goto out_free;
3245 /* if nothing to unset, error out */
3246 if (!value) {
3247 ret = CONFIG_NOTHING_SET;
3248 goto out_free;
3251 free(store.key);
3252 store.key = xstrdup(key);
3253 if (write_section(fd, key, &store) < 0 ||
3254 write_pair(fd, key, value, &store) < 0)
3255 goto write_err_out;
3256 } else {
3257 struct stat st;
3258 size_t copy_begin, copy_end;
3259 int i, new_line = 0;
3260 struct config_options opts;
3262 if (!value_pattern)
3263 store.value_pattern = NULL;
3264 else if (value_pattern == CONFIG_REGEX_NONE)
3265 store.value_pattern = CONFIG_REGEX_NONE;
3266 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
3267 store.fixed_value = value_pattern;
3268 else {
3269 if (value_pattern[0] == '!') {
3270 store.do_not_match = 1;
3271 value_pattern++;
3272 } else
3273 store.do_not_match = 0;
3275 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3276 if (regcomp(store.value_pattern, value_pattern,
3277 REG_EXTENDED)) {
3278 error(_("invalid pattern: %s"), value_pattern);
3279 FREE_AND_NULL(store.value_pattern);
3280 ret = CONFIG_INVALID_PATTERN;
3281 goto out_free;
3285 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3286 store.parsed[0].end = 0;
3288 memset(&opts, 0, sizeof(opts));
3289 opts.event_fn = store_aux_event;
3290 opts.event_fn_data = &store;
3293 * After this, store.parsed will contain offsets of all the
3294 * parsed elements, and store.seen will contain a list of
3295 * matches, as indices into store.parsed.
3297 * As a side effect, we make sure to transform only a valid
3298 * existing config file.
3300 if (git_config_from_file_with_options(store_aux,
3301 config_filename,
3302 &store, &opts)) {
3303 error(_("invalid config file %s"), config_filename);
3304 ret = CONFIG_INVALID_FILE;
3305 goto out_free;
3308 /* if nothing to unset, or too many matches, error out */
3309 if ((store.seen_nr == 0 && value == NULL) ||
3310 (store.seen_nr > 1 && !store.multi_replace)) {
3311 ret = CONFIG_NOTHING_SET;
3312 goto out_free;
3315 if (fstat(in_fd, &st) == -1) {
3316 error_errno(_("fstat on %s failed"), config_filename);
3317 ret = CONFIG_INVALID_FILE;
3318 goto out_free;
3321 contents_sz = xsize_t(st.st_size);
3322 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3323 MAP_PRIVATE, in_fd, 0);
3324 if (contents == MAP_FAILED) {
3325 if (errno == ENODEV && S_ISDIR(st.st_mode))
3326 errno = EISDIR;
3327 error_errno(_("unable to mmap '%s'%s"),
3328 config_filename, mmap_os_err());
3329 ret = CONFIG_INVALID_FILE;
3330 contents = NULL;
3331 goto out_free;
3333 close(in_fd);
3334 in_fd = -1;
3336 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3337 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3338 ret = CONFIG_NO_WRITE;
3339 goto out_free;
3342 if (store.seen_nr == 0) {
3343 if (!store.seen_alloc) {
3344 /* Did not see key nor section */
3345 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3346 store.seen[0] = store.parsed_nr
3347 - !!store.parsed_nr;
3349 store.seen_nr = 1;
3352 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3353 size_t replace_end;
3354 int j = store.seen[i];
3356 new_line = 0;
3357 if (!store.key_seen) {
3358 copy_end = store.parsed[j].end;
3359 /* include '\n' when copying section header */
3360 if (copy_end > 0 && copy_end < contents_sz &&
3361 contents[copy_end - 1] != '\n' &&
3362 contents[copy_end] == '\n')
3363 copy_end++;
3364 replace_end = copy_end;
3365 } else {
3366 replace_end = store.parsed[j].end;
3367 copy_end = store.parsed[j].begin;
3368 if (!value)
3369 maybe_remove_section(&store,
3370 &copy_end,
3371 &replace_end, &i);
3373 * Swallow preceding white-space on the same
3374 * line.
3376 while (copy_end > 0 ) {
3377 char c = contents[copy_end - 1];
3379 if (isspace(c) && c != '\n')
3380 copy_end--;
3381 else
3382 break;
3386 if (copy_end > 0 && contents[copy_end-1] != '\n')
3387 new_line = 1;
3389 /* write the first part of the config */
3390 if (copy_end > copy_begin) {
3391 if (write_in_full(fd, contents + copy_begin,
3392 copy_end - copy_begin) < 0)
3393 goto write_err_out;
3394 if (new_line &&
3395 write_str_in_full(fd, "\n") < 0)
3396 goto write_err_out;
3398 copy_begin = replace_end;
3401 /* write the pair (value == NULL means unset) */
3402 if (value) {
3403 if (!store.section_seen) {
3404 if (write_section(fd, key, &store) < 0)
3405 goto write_err_out;
3407 if (write_pair(fd, key, value, &store) < 0)
3408 goto write_err_out;
3411 /* write the rest of the config */
3412 if (copy_begin < contents_sz)
3413 if (write_in_full(fd, contents + copy_begin,
3414 contents_sz - copy_begin) < 0)
3415 goto write_err_out;
3417 munmap(contents, contents_sz);
3418 contents = NULL;
3421 if (commit_lock_file(&lock) < 0) {
3422 error_errno(_("could not write config file %s"), config_filename);
3423 ret = CONFIG_NO_WRITE;
3424 goto out_free;
3427 ret = 0;
3429 /* Invalidate the config cache */
3430 git_config_clear();
3432 out_free:
3433 rollback_lock_file(&lock);
3434 free(filename_buf);
3435 if (contents)
3436 munmap(contents, contents_sz);
3437 if (in_fd >= 0)
3438 close(in_fd);
3439 config_store_data_clear(&store);
3440 return ret;
3442 write_err_out:
3443 ret = write_error(get_lock_file_path(&lock));
3444 goto out_free;
3448 void git_config_set_multivar_in_file(const char *config_filename,
3449 const char *key, const char *value,
3450 const char *value_pattern, unsigned flags)
3452 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3453 value_pattern, flags))
3454 return;
3455 if (value)
3456 die(_("could not set '%s' to '%s'"), key, value);
3457 else
3458 die(_("could not unset '%s'"), key);
3461 int git_config_set_multivar_gently(const char *key, const char *value,
3462 const char *value_pattern, unsigned flags)
3464 return repo_config_set_multivar_gently(the_repository, key, value,
3465 value_pattern, flags);
3468 int repo_config_set_multivar_gently(struct repository *r, const char *key,
3469 const char *value,
3470 const char *value_pattern, unsigned flags)
3472 char *file = repo_git_path(r, "config");
3473 int res = git_config_set_multivar_in_file_gently(file,
3474 key, value,
3475 value_pattern,
3476 flags);
3477 free(file);
3478 return res;
3481 void git_config_set_multivar(const char *key, const char *value,
3482 const char *value_pattern, unsigned flags)
3484 git_config_set_multivar_in_file(git_path("config"),
3485 key, value, value_pattern,
3486 flags);
3489 static int section_name_match (const char *buf, const char *name)
3491 int i = 0, j = 0, dot = 0;
3492 if (buf[i] != '[')
3493 return 0;
3494 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3495 if (!dot && isspace(buf[i])) {
3496 dot = 1;
3497 if (name[j++] != '.')
3498 break;
3499 for (i++; isspace(buf[i]); i++)
3500 ; /* do nothing */
3501 if (buf[i] != '"')
3502 break;
3503 continue;
3505 if (buf[i] == '\\' && dot)
3506 i++;
3507 else if (buf[i] == '"' && dot) {
3508 for (i++; isspace(buf[i]); i++)
3509 ; /* do_nothing */
3510 break;
3512 if (buf[i] != name[j++])
3513 break;
3515 if (buf[i] == ']' && name[j] == 0) {
3517 * We match, now just find the right length offset by
3518 * gobbling up any whitespace after it, as well
3520 i++;
3521 for (; buf[i] && isspace(buf[i]); i++)
3522 ; /* do nothing */
3523 return i;
3525 return 0;
3528 static int section_name_is_ok(const char *name)
3530 /* Empty section names are bogus. */
3531 if (!*name)
3532 return 0;
3535 * Before a dot, we must be alphanumeric or dash. After the first dot,
3536 * anything goes, so we can stop checking.
3538 for (; *name && *name != '.'; name++)
3539 if (*name != '-' && !isalnum(*name))
3540 return 0;
3541 return 1;
3544 /* if new_name == NULL, the section is removed instead */
3545 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3546 const char *old_name,
3547 const char *new_name, int copy)
3549 int ret = 0, remove = 0;
3550 char *filename_buf = NULL;
3551 struct lock_file lock = LOCK_INIT;
3552 int out_fd;
3553 char buf[1024];
3554 FILE *config_file = NULL;
3555 struct stat st;
3556 struct strbuf copystr = STRBUF_INIT;
3557 struct config_store_data store;
3559 memset(&store, 0, sizeof(store));
3561 if (new_name && !section_name_is_ok(new_name)) {
3562 ret = error(_("invalid section name: %s"), new_name);
3563 goto out_no_rollback;
3566 if (!config_filename)
3567 config_filename = filename_buf = git_pathdup("config");
3569 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3570 if (out_fd < 0) {
3571 ret = error(_("could not lock config file %s"), config_filename);
3572 goto out;
3575 if (!(config_file = fopen(config_filename, "rb"))) {
3576 ret = warn_on_fopen_errors(config_filename);
3577 if (ret)
3578 goto out;
3579 /* no config file means nothing to rename, no error */
3580 goto commit_and_out;
3583 if (fstat(fileno(config_file), &st) == -1) {
3584 ret = error_errno(_("fstat on %s failed"), config_filename);
3585 goto out;
3588 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3589 ret = error_errno(_("chmod on %s failed"),
3590 get_lock_file_path(&lock));
3591 goto out;
3594 while (fgets(buf, sizeof(buf), config_file)) {
3595 unsigned i;
3596 int length;
3597 int is_section = 0;
3598 char *output = buf;
3599 for (i = 0; buf[i] && isspace(buf[i]); i++)
3600 ; /* do nothing */
3601 if (buf[i] == '[') {
3602 /* it's a section */
3603 int offset;
3604 is_section = 1;
3607 * When encountering a new section under -c we
3608 * need to flush out any section we're already
3609 * coping and begin anew. There might be
3610 * multiple [branch "$name"] sections.
3612 if (copystr.len > 0) {
3613 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3614 ret = write_error(get_lock_file_path(&lock));
3615 goto out;
3617 strbuf_reset(&copystr);
3620 offset = section_name_match(&buf[i], old_name);
3621 if (offset > 0) {
3622 ret++;
3623 if (!new_name) {
3624 remove = 1;
3625 continue;
3627 store.baselen = strlen(new_name);
3628 if (!copy) {
3629 if (write_section(out_fd, new_name, &store) < 0) {
3630 ret = write_error(get_lock_file_path(&lock));
3631 goto out;
3634 * We wrote out the new section, with
3635 * a newline, now skip the old
3636 * section's length
3638 output += offset + i;
3639 if (strlen(output) > 0) {
3641 * More content means there's
3642 * a declaration to put on the
3643 * next line; indent with a
3644 * tab
3646 output -= 1;
3647 output[0] = '\t';
3649 } else {
3650 copystr = store_create_section(new_name, &store);
3653 remove = 0;
3655 if (remove)
3656 continue;
3657 length = strlen(output);
3659 if (!is_section && copystr.len > 0) {
3660 strbuf_add(&copystr, output, length);
3663 if (write_in_full(out_fd, output, length) < 0) {
3664 ret = write_error(get_lock_file_path(&lock));
3665 goto out;
3670 * Copy a trailing section at the end of the config, won't be
3671 * flushed by the usual "flush because we have a new section
3672 * logic in the loop above.
3674 if (copystr.len > 0) {
3675 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3676 ret = write_error(get_lock_file_path(&lock));
3677 goto out;
3679 strbuf_reset(&copystr);
3682 fclose(config_file);
3683 config_file = NULL;
3684 commit_and_out:
3685 if (commit_lock_file(&lock) < 0)
3686 ret = error_errno(_("could not write config file %s"),
3687 config_filename);
3688 out:
3689 if (config_file)
3690 fclose(config_file);
3691 rollback_lock_file(&lock);
3692 out_no_rollback:
3693 free(filename_buf);
3694 config_store_data_clear(&store);
3695 return ret;
3698 int git_config_rename_section_in_file(const char *config_filename,
3699 const char *old_name, const char *new_name)
3701 return git_config_copy_or_rename_section_in_file(config_filename,
3702 old_name, new_name, 0);
3705 int git_config_rename_section(const char *old_name, const char *new_name)
3707 return git_config_rename_section_in_file(NULL, old_name, new_name);
3710 int git_config_copy_section_in_file(const char *config_filename,
3711 const char *old_name, const char *new_name)
3713 return git_config_copy_or_rename_section_in_file(config_filename,
3714 old_name, new_name, 1);
3717 int git_config_copy_section(const char *old_name, const char *new_name)
3719 return git_config_copy_section_in_file(NULL, old_name, new_name);
3723 * Call this to report error for your variable that should not
3724 * get a boolean value (i.e. "[my] var" means "true").
3726 #undef config_error_nonbool
3727 int config_error_nonbool(const char *var)
3729 return error(_("missing value for '%s'"), var);
3732 int parse_config_key(const char *var,
3733 const char *section,
3734 const char **subsection, size_t *subsection_len,
3735 const char **key)
3737 const char *dot;
3739 /* Does it start with "section." ? */
3740 if (!skip_prefix(var, section, &var) || *var != '.')
3741 return -1;
3744 * Find the key; we don't know yet if we have a subsection, but we must
3745 * parse backwards from the end, since the subsection may have dots in
3746 * it, too.
3748 dot = strrchr(var, '.');
3749 *key = dot + 1;
3751 /* Did we have a subsection at all? */
3752 if (dot == var) {
3753 if (subsection) {
3754 *subsection = NULL;
3755 *subsection_len = 0;
3758 else {
3759 if (!subsection)
3760 return -1;
3761 *subsection = var + 1;
3762 *subsection_len = dot - *subsection;
3765 return 0;
3768 const char *current_config_origin_type(void)
3770 int type;
3771 if (current_config_kvi)
3772 type = current_config_kvi->origin_type;
3773 else if(cf)
3774 type = cf->origin_type;
3775 else
3776 BUG("current_config_origin_type called outside config callback");
3778 switch (type) {
3779 case CONFIG_ORIGIN_BLOB:
3780 return "blob";
3781 case CONFIG_ORIGIN_FILE:
3782 return "file";
3783 case CONFIG_ORIGIN_STDIN:
3784 return "standard input";
3785 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3786 return "submodule-blob";
3787 case CONFIG_ORIGIN_CMDLINE:
3788 return "command line";
3789 default:
3790 BUG("unknown config origin type");
3794 const char *config_scope_name(enum config_scope scope)
3796 switch (scope) {
3797 case CONFIG_SCOPE_SYSTEM:
3798 return "system";
3799 case CONFIG_SCOPE_GLOBAL:
3800 return "global";
3801 case CONFIG_SCOPE_LOCAL:
3802 return "local";
3803 case CONFIG_SCOPE_WORKTREE:
3804 return "worktree";
3805 case CONFIG_SCOPE_COMMAND:
3806 return "command";
3807 case CONFIG_SCOPE_SUBMODULE:
3808 return "submodule";
3809 default:
3810 return "unknown";
3814 const char *current_config_name(void)
3816 const char *name;
3817 if (current_config_kvi)
3818 name = current_config_kvi->filename;
3819 else if (cf)
3820 name = cf->name;
3821 else
3822 BUG("current_config_name called outside config callback");
3823 return name ? name : "";
3826 enum config_scope current_config_scope(void)
3828 if (current_config_kvi)
3829 return current_config_kvi->scope;
3830 else
3831 return current_parsing_scope;
3834 int current_config_line(void)
3836 if (current_config_kvi)
3837 return current_config_kvi->linenr;
3838 else
3839 return cf->linenr;
3842 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3844 int i;
3846 for (i = 0; i < nr_mapping; i++) {
3847 const char *name = mapping[i];
3849 if (name && !strcasecmp(var, name))
3850 return i;
3852 return -1;