Sync with 2.32.3
[git.git] / config.c
blob7a6ff18ffa6c4697c6b4513b1a31b8f47e97a7b2
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 "branch.h"
10 #include "config.h"
11 #include "environment.h"
12 #include "repository.h"
13 #include "lockfile.h"
14 #include "exec-cmd.h"
15 #include "strbuf.h"
16 #include "quote.h"
17 #include "hashmap.h"
18 #include "string-list.h"
19 #include "object-store.h"
20 #include "utf8.h"
21 #include "dir.h"
22 #include "color.h"
23 #include "refs.h"
25 struct config_source {
26 struct config_source *prev;
27 union {
28 FILE *file;
29 struct config_buf {
30 const char *buf;
31 size_t len;
32 size_t pos;
33 } buf;
34 } u;
35 enum config_origin_type origin_type;
36 const char *name;
37 const char *path;
38 enum config_error_action default_error_action;
39 int linenr;
40 int eof;
41 size_t total_len;
42 struct strbuf value;
43 struct strbuf var;
44 unsigned subsection_case_sensitive : 1;
46 int (*do_fgetc)(struct config_source *c);
47 int (*do_ungetc)(int c, struct config_source *conf);
48 long (*do_ftell)(struct config_source *c);
52 * These variables record the "current" config source, which
53 * can be accessed by parsing callbacks.
55 * The "cf" variable will be non-NULL only when we are actually parsing a real
56 * config source (file, blob, cmdline, etc).
58 * The "current_config_kvi" variable will be non-NULL only when we are feeding
59 * cached config from a configset into a callback.
61 * They should generally never be non-NULL at the same time. If they are both
62 * NULL, then we aren't parsing anything (and depending on the function looking
63 * at the variables, it's either a bug for it to be called in the first place,
64 * or it's a function which can be reused for non-config purposes, and should
65 * fall back to some sane behavior).
67 static struct config_source *cf;
68 static struct key_value_info *current_config_kvi;
71 * Similar to the variables above, this gives access to the "scope" of the
72 * current value (repo, global, etc). For cached values, it can be found via
73 * the current_config_kvi as above. During parsing, the current value can be
74 * found in this variable. It's not part of "cf" because it transcends a single
75 * file (i.e., a file included from .git/config is still in "repo" scope).
77 static enum config_scope current_parsing_scope;
79 static int pack_compression_seen;
80 static int zlib_compression_seen;
82 static int config_file_fgetc(struct config_source *conf)
84 return getc_unlocked(conf->u.file);
87 static int config_file_ungetc(int c, struct config_source *conf)
89 return ungetc(c, conf->u.file);
92 static long config_file_ftell(struct config_source *conf)
94 return ftell(conf->u.file);
98 static int config_buf_fgetc(struct config_source *conf)
100 if (conf->u.buf.pos < conf->u.buf.len)
101 return conf->u.buf.buf[conf->u.buf.pos++];
103 return EOF;
106 static int config_buf_ungetc(int c, struct config_source *conf)
108 if (conf->u.buf.pos > 0) {
109 conf->u.buf.pos--;
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
111 BUG("config_buf can only ungetc the same character");
112 return c;
115 return EOF;
118 static long config_buf_ftell(struct config_source *conf)
120 return conf->u.buf.pos;
123 #define MAX_INCLUDE_DEPTH 10
124 static const char include_depth_advice[] = N_(
125 "exceeded maximum include depth (%d) while including\n"
126 " %s\n"
127 "from\n"
128 " %s\n"
129 "This might be due to circular includes.");
130 static int handle_path_include(const char *path, struct config_include_data *inc)
132 int ret = 0;
133 struct strbuf buf = STRBUF_INIT;
134 char *expanded;
136 if (!path)
137 return config_error_nonbool("include.path");
139 expanded = expand_user_path(path, 0);
140 if (!expanded)
141 return error(_("could not expand include path '%s'"), path);
142 path = expanded;
145 * Use an absolute path as-is, but interpret relative paths
146 * based on the including config file.
148 if (!is_absolute_path(path)) {
149 char *slash;
151 if (!cf || !cf->path)
152 return error(_("relative config includes must come from files"));
154 slash = find_last_dir_sep(cf->path);
155 if (slash)
156 strbuf_add(&buf, cf->path, slash - cf->path + 1);
157 strbuf_addstr(&buf, path);
158 path = buf.buf;
161 if (!access_or_die(path, R_OK, 0)) {
162 if (++inc->depth > MAX_INCLUDE_DEPTH)
163 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
164 !cf ? "<unknown>" :
165 cf->name ? cf->name :
166 "the command line");
167 ret = git_config_from_file(git_config_include, path, inc);
168 inc->depth--;
170 strbuf_release(&buf);
171 free(expanded);
172 return ret;
175 static void add_trailing_starstar_for_dir(struct strbuf *pat)
177 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
178 strbuf_addstr(pat, "**");
181 static int prepare_include_condition_pattern(struct strbuf *pat)
183 struct strbuf path = STRBUF_INIT;
184 char *expanded;
185 int prefix = 0;
187 expanded = expand_user_path(pat->buf, 1);
188 if (expanded) {
189 strbuf_reset(pat);
190 strbuf_addstr(pat, expanded);
191 free(expanded);
194 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
195 const char *slash;
197 if (!cf || !cf->path)
198 return error(_("relative config include "
199 "conditionals must come from files"));
201 strbuf_realpath(&path, cf->path, 1);
202 slash = find_last_dir_sep(path.buf);
203 if (!slash)
204 BUG("how is this possible?");
205 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
206 prefix = slash - path.buf + 1 /* slash */;
207 } else if (!is_absolute_path(pat->buf))
208 strbuf_insertstr(pat, 0, "**/");
210 add_trailing_starstar_for_dir(pat);
212 strbuf_release(&path);
213 return prefix;
216 static int include_by_gitdir(const struct config_options *opts,
217 const char *cond, size_t cond_len, int icase)
219 struct strbuf text = STRBUF_INIT;
220 struct strbuf pattern = STRBUF_INIT;
221 int ret = 0, prefix;
222 const char *git_dir;
223 int already_tried_absolute = 0;
225 if (opts->git_dir)
226 git_dir = opts->git_dir;
227 else
228 goto done;
230 strbuf_realpath(&text, git_dir, 1);
231 strbuf_add(&pattern, cond, cond_len);
232 prefix = prepare_include_condition_pattern(&pattern);
234 again:
235 if (prefix < 0)
236 goto done;
238 if (prefix > 0) {
240 * perform literal matching on the prefix part so that
241 * any wildcard character in it can't create side effects.
243 if (text.len < prefix)
244 goto done;
245 if (!icase && strncmp(pattern.buf, text.buf, prefix))
246 goto done;
247 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
248 goto done;
251 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
252 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
254 if (!ret && !already_tried_absolute) {
256 * We've tried e.g. matching gitdir:~/work, but if
257 * ~/work is a symlink to /mnt/storage/work
258 * strbuf_realpath() will expand it, so the rule won't
259 * match. Let's match against a
260 * strbuf_add_absolute_path() version of the path,
261 * which'll do the right thing
263 strbuf_reset(&text);
264 strbuf_add_absolute_path(&text, git_dir);
265 already_tried_absolute = 1;
266 goto again;
268 done:
269 strbuf_release(&pattern);
270 strbuf_release(&text);
271 return ret;
274 static int include_by_branch(const char *cond, size_t cond_len)
276 int flags;
277 int ret;
278 struct strbuf pattern = STRBUF_INIT;
279 const char *refname = !the_repository->gitdir ?
280 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
281 const char *shortname;
283 if (!refname || !(flags & REF_ISSYMREF) ||
284 !skip_prefix(refname, "refs/heads/", &shortname))
285 return 0;
287 strbuf_add(&pattern, cond, cond_len);
288 add_trailing_starstar_for_dir(&pattern);
289 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
290 strbuf_release(&pattern);
291 return ret;
294 static int include_condition_is_true(const struct config_options *opts,
295 const char *cond, size_t cond_len)
298 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
299 return include_by_gitdir(opts, cond, cond_len, 0);
300 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
301 return include_by_gitdir(opts, cond, cond_len, 1);
302 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
303 return include_by_branch(cond, cond_len);
305 /* unknown conditionals are always false */
306 return 0;
309 int git_config_include(const char *var, const char *value, void *data)
311 struct config_include_data *inc = data;
312 const char *cond, *key;
313 size_t cond_len;
314 int ret;
317 * Pass along all values, including "include" directives; this makes it
318 * possible to query information on the includes themselves.
320 ret = inc->fn(var, value, inc->data);
321 if (ret < 0)
322 return ret;
324 if (!strcmp(var, "include.path"))
325 ret = handle_path_include(value, inc);
327 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
328 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
329 !strcmp(key, "path"))
330 ret = handle_path_include(value, inc);
332 return ret;
335 static void git_config_push_split_parameter(const char *key, const char *value)
337 struct strbuf env = STRBUF_INIT;
338 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
339 if (old && *old) {
340 strbuf_addstr(&env, old);
341 strbuf_addch(&env, ' ');
343 sq_quote_buf(&env, key);
344 strbuf_addch(&env, '=');
345 if (value)
346 sq_quote_buf(&env, value);
347 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
348 strbuf_release(&env);
351 void git_config_push_parameter(const char *text)
353 const char *value;
356 * When we see:
358 * section.subsection=with=equals.key=value
360 * we cannot tell if it means:
362 * [section "subsection=with=equals"]
363 * key = value
365 * or:
367 * [section]
368 * subsection = with=equals.key=value
370 * We parse left-to-right for the first "=", meaning we'll prefer to
371 * keep the value intact over the subsection. This is historical, but
372 * also sensible since values are more likely to contain odd or
373 * untrusted input than a section name.
375 * A missing equals is explicitly allowed (as a bool-only entry).
377 value = strchr(text, '=');
378 if (value) {
379 char *key = xmemdupz(text, value - text);
380 git_config_push_split_parameter(key, value + 1);
381 free(key);
382 } else {
383 git_config_push_split_parameter(text, NULL);
387 void git_config_push_env(const char *spec)
389 char *key;
390 const char *env_name;
391 const char *env_value;
393 env_name = strrchr(spec, '=');
394 if (!env_name)
395 die(_("invalid config format: %s"), spec);
396 key = xmemdupz(spec, env_name - spec);
397 env_name++;
398 if (!*env_name)
399 die(_("missing environment variable name for configuration '%.*s'"),
400 (int)(env_name - spec - 1), spec);
402 env_value = getenv(env_name);
403 if (!env_value)
404 die(_("missing environment variable '%s' for configuration '%.*s'"),
405 env_name, (int)(env_name - spec - 1), spec);
407 git_config_push_split_parameter(key, env_value);
408 free(key);
411 static inline int iskeychar(int c)
413 return isalnum(c) || c == '-';
417 * Auxiliary function to sanity-check and split the key into the section
418 * identifier and variable name.
420 * Returns 0 on success, -1 when there is an invalid character in the key and
421 * -2 if there is no section name in the key.
423 * store_key - pointer to char* which will hold a copy of the key with
424 * lowercase section and variable name
425 * baselen - pointer to size_t which will hold the length of the
426 * section + subsection part, can be NULL
428 static int git_config_parse_key_1(const char *key, char **store_key, size_t *baselen_, int quiet)
430 size_t i, baselen;
431 int dot;
432 const char *last_dot = strrchr(key, '.');
435 * Since "key" actually contains the section name and the real
436 * key name separated by a dot, we have to know where the dot is.
439 if (last_dot == NULL || last_dot == key) {
440 if (!quiet)
441 error(_("key does not contain a section: %s"), key);
442 return -CONFIG_NO_SECTION_OR_NAME;
445 if (!last_dot[1]) {
446 if (!quiet)
447 error(_("key does not contain variable name: %s"), key);
448 return -CONFIG_NO_SECTION_OR_NAME;
451 baselen = last_dot - key;
452 if (baselen_)
453 *baselen_ = baselen;
456 * Validate the key and while at it, lower case it for matching.
458 if (store_key)
459 *store_key = xmallocz(strlen(key));
461 dot = 0;
462 for (i = 0; key[i]; i++) {
463 unsigned char c = key[i];
464 if (c == '.')
465 dot = 1;
466 /* Leave the extended basename untouched.. */
467 if (!dot || i > baselen) {
468 if (!iskeychar(c) ||
469 (i == baselen + 1 && !isalpha(c))) {
470 if (!quiet)
471 error(_("invalid key: %s"), key);
472 goto out_free_ret_1;
474 c = tolower(c);
475 } else if (c == '\n') {
476 if (!quiet)
477 error(_("invalid key (newline): %s"), key);
478 goto out_free_ret_1;
480 if (store_key)
481 (*store_key)[i] = c;
484 return 0;
486 out_free_ret_1:
487 if (store_key) {
488 FREE_AND_NULL(*store_key);
490 return -CONFIG_INVALID_KEY;
493 int git_config_parse_key(const char *key, char **store_key, size_t *baselen)
495 return git_config_parse_key_1(key, store_key, baselen, 0);
498 int git_config_key_is_valid(const char *key)
500 return !git_config_parse_key_1(key, NULL, NULL, 1);
503 static int config_parse_pair(const char *key, const char *value,
504 config_fn_t fn, void *data)
506 char *canonical_name;
507 int ret;
509 if (!strlen(key))
510 return error(_("empty config key"));
511 if (git_config_parse_key(key, &canonical_name, NULL))
512 return -1;
514 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
515 free(canonical_name);
516 return ret;
519 int git_config_parse_parameter(const char *text,
520 config_fn_t fn, void *data)
522 const char *value;
523 struct strbuf **pair;
524 int ret;
526 pair = strbuf_split_str(text, '=', 2);
527 if (!pair[0])
528 return error(_("bogus config parameter: %s"), text);
530 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
531 strbuf_setlen(pair[0], pair[0]->len - 1);
532 value = pair[1] ? pair[1]->buf : "";
533 } else {
534 value = NULL;
537 strbuf_trim(pair[0]);
538 if (!pair[0]->len) {
539 strbuf_list_free(pair);
540 return error(_("bogus config parameter: %s"), text);
543 ret = config_parse_pair(pair[0]->buf, value, fn, data);
544 strbuf_list_free(pair);
545 return ret;
548 static int parse_config_env_list(char *env, config_fn_t fn, void *data)
550 char *cur = env;
551 while (cur && *cur) {
552 const char *key = sq_dequote_step(cur, &cur);
553 if (!key)
554 return error(_("bogus format in %s"),
555 CONFIG_DATA_ENVIRONMENT);
557 if (!cur || isspace(*cur)) {
558 /* old-style 'key=value' */
559 if (git_config_parse_parameter(key, fn, data) < 0)
560 return -1;
562 else if (*cur == '=') {
563 /* new-style 'key'='value' */
564 const char *value;
566 cur++;
567 if (*cur == '\'') {
568 /* quoted value */
569 value = sq_dequote_step(cur, &cur);
570 if (!value || (cur && !isspace(*cur))) {
571 return error(_("bogus format in %s"),
572 CONFIG_DATA_ENVIRONMENT);
574 } else if (!*cur || isspace(*cur)) {
575 /* implicit bool: 'key'= */
576 value = NULL;
577 } else {
578 return error(_("bogus format in %s"),
579 CONFIG_DATA_ENVIRONMENT);
582 if (config_parse_pair(key, value, fn, data) < 0)
583 return -1;
585 else {
586 /* unknown format */
587 return error(_("bogus format in %s"),
588 CONFIG_DATA_ENVIRONMENT);
591 if (cur) {
592 while (isspace(*cur))
593 cur++;
596 return 0;
599 int git_config_from_parameters(config_fn_t fn, void *data)
601 const char *env;
602 struct strbuf envvar = STRBUF_INIT;
603 struct strvec to_free = STRVEC_INIT;
604 int ret = 0;
605 char *envw = NULL;
606 struct config_source source;
608 memset(&source, 0, sizeof(source));
609 source.prev = cf;
610 source.origin_type = CONFIG_ORIGIN_CMDLINE;
611 cf = &source;
613 env = getenv(CONFIG_COUNT_ENVIRONMENT);
614 if (env) {
615 unsigned long count;
616 char *endp;
617 int i;
619 count = strtoul(env, &endp, 10);
620 if (*endp) {
621 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
622 goto out;
624 if (count > INT_MAX) {
625 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
626 goto out;
629 for (i = 0; i < count; i++) {
630 const char *key, *value;
632 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
633 key = getenv_safe(&to_free, envvar.buf);
634 if (!key) {
635 ret = error(_("missing config key %s"), envvar.buf);
636 goto out;
638 strbuf_reset(&envvar);
640 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
641 value = getenv_safe(&to_free, envvar.buf);
642 if (!value) {
643 ret = error(_("missing config value %s"), envvar.buf);
644 goto out;
646 strbuf_reset(&envvar);
648 if (config_parse_pair(key, value, fn, data) < 0) {
649 ret = -1;
650 goto out;
655 env = getenv(CONFIG_DATA_ENVIRONMENT);
656 if (env) {
657 /* sq_dequote will write over it */
658 envw = xstrdup(env);
659 if (parse_config_env_list(envw, fn, data) < 0) {
660 ret = -1;
661 goto out;
665 out:
666 strbuf_release(&envvar);
667 strvec_clear(&to_free);
668 free(envw);
669 cf = source.prev;
670 return ret;
673 static int get_next_char(void)
675 int c = cf->do_fgetc(cf);
677 if (c == '\r') {
678 /* DOS like systems */
679 c = cf->do_fgetc(cf);
680 if (c != '\n') {
681 if (c != EOF)
682 cf->do_ungetc(c, cf);
683 c = '\r';
687 if (c != EOF && ++cf->total_len > INT_MAX) {
689 * This is an absurdly long config file; refuse to parse
690 * further in order to protect downstream code from integer
691 * overflows. Note that we can't return an error specifically,
692 * but we can mark EOF and put trash in the return value,
693 * which will trigger a parse error.
695 cf->eof = 1;
696 return 0;
699 if (c == '\n')
700 cf->linenr++;
701 if (c == EOF) {
702 cf->eof = 1;
703 cf->linenr++;
704 c = '\n';
706 return c;
709 static char *parse_value(void)
711 int quote = 0, comment = 0, space = 0;
713 strbuf_reset(&cf->value);
714 for (;;) {
715 int c = get_next_char();
716 if (c == '\n') {
717 if (quote) {
718 cf->linenr--;
719 return NULL;
721 return cf->value.buf;
723 if (comment)
724 continue;
725 if (isspace(c) && !quote) {
726 if (cf->value.len)
727 space++;
728 continue;
730 if (!quote) {
731 if (c == ';' || c == '#') {
732 comment = 1;
733 continue;
736 for (; space; space--)
737 strbuf_addch(&cf->value, ' ');
738 if (c == '\\') {
739 c = get_next_char();
740 switch (c) {
741 case '\n':
742 continue;
743 case 't':
744 c = '\t';
745 break;
746 case 'b':
747 c = '\b';
748 break;
749 case 'n':
750 c = '\n';
751 break;
752 /* Some characters escape as themselves */
753 case '\\': case '"':
754 break;
755 /* Reject unknown escape sequences */
756 default:
757 return NULL;
759 strbuf_addch(&cf->value, c);
760 continue;
762 if (c == '"') {
763 quote = 1-quote;
764 continue;
766 strbuf_addch(&cf->value, c);
770 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
772 int c;
773 char *value;
774 int ret;
776 /* Get the full name */
777 for (;;) {
778 c = get_next_char();
779 if (cf->eof)
780 break;
781 if (!iskeychar(c))
782 break;
783 strbuf_addch(name, tolower(c));
786 while (c == ' ' || c == '\t')
787 c = get_next_char();
789 value = NULL;
790 if (c != '\n') {
791 if (c != '=')
792 return -1;
793 value = parse_value();
794 if (!value)
795 return -1;
798 * We already consumed the \n, but we need linenr to point to
799 * the line we just parsed during the call to fn to get
800 * accurate line number in error messages.
802 cf->linenr--;
803 ret = fn(name->buf, value, data);
804 if (ret >= 0)
805 cf->linenr++;
806 return ret;
809 static int get_extended_base_var(struct strbuf *name, int c)
811 cf->subsection_case_sensitive = 0;
812 do {
813 if (c == '\n')
814 goto error_incomplete_line;
815 c = get_next_char();
816 } while (isspace(c));
818 /* We require the format to be '[base "extension"]' */
819 if (c != '"')
820 return -1;
821 strbuf_addch(name, '.');
823 for (;;) {
824 int c = get_next_char();
825 if (c == '\n')
826 goto error_incomplete_line;
827 if (c == '"')
828 break;
829 if (c == '\\') {
830 c = get_next_char();
831 if (c == '\n')
832 goto error_incomplete_line;
834 strbuf_addch(name, c);
837 /* Final ']' */
838 if (get_next_char() != ']')
839 return -1;
840 return 0;
841 error_incomplete_line:
842 cf->linenr--;
843 return -1;
846 static int get_base_var(struct strbuf *name)
848 cf->subsection_case_sensitive = 1;
849 for (;;) {
850 int c = get_next_char();
851 if (cf->eof)
852 return -1;
853 if (c == ']')
854 return 0;
855 if (isspace(c))
856 return get_extended_base_var(name, c);
857 if (!iskeychar(c) && c != '.')
858 return -1;
859 strbuf_addch(name, tolower(c));
863 struct parse_event_data {
864 enum config_event_t previous_type;
865 size_t previous_offset;
866 const struct config_options *opts;
869 static int do_event(enum config_event_t type, struct parse_event_data *data)
871 size_t offset;
873 if (!data->opts || !data->opts->event_fn)
874 return 0;
876 if (type == CONFIG_EVENT_WHITESPACE &&
877 data->previous_type == type)
878 return 0;
880 offset = cf->do_ftell(cf);
882 * At EOF, the parser always "inserts" an extra '\n', therefore
883 * the end offset of the event is the current file position, otherwise
884 * we will already have advanced to the next event.
886 if (type != CONFIG_EVENT_EOF)
887 offset--;
889 if (data->previous_type != CONFIG_EVENT_EOF &&
890 data->opts->event_fn(data->previous_type, data->previous_offset,
891 offset, data->opts->event_fn_data) < 0)
892 return -1;
894 data->previous_type = type;
895 data->previous_offset = offset;
897 return 0;
900 static int git_parse_source(config_fn_t fn, void *data,
901 const struct config_options *opts)
903 int comment = 0;
904 size_t baselen = 0;
905 struct strbuf *var = &cf->var;
906 int error_return = 0;
907 char *error_msg = NULL;
909 /* U+FEFF Byte Order Mark in UTF8 */
910 const char *bomptr = utf8_bom;
912 /* For the parser event callback */
913 struct parse_event_data event_data = {
914 CONFIG_EVENT_EOF, 0, opts
917 for (;;) {
918 int c;
920 c = get_next_char();
921 if (bomptr && *bomptr) {
922 /* We are at the file beginning; skip UTF8-encoded BOM
923 * if present. Sane editors won't put this in on their
924 * own, but e.g. Windows Notepad will do it happily. */
925 if (c == (*bomptr & 0377)) {
926 bomptr++;
927 continue;
928 } else {
929 /* Do not tolerate partial BOM. */
930 if (bomptr != utf8_bom)
931 break;
932 /* No BOM at file beginning. Cool. */
933 bomptr = NULL;
936 if (c == '\n') {
937 if (cf->eof) {
938 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
939 return -1;
940 return 0;
942 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
943 return -1;
944 comment = 0;
945 continue;
947 if (comment)
948 continue;
949 if (isspace(c)) {
950 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
951 return -1;
952 continue;
954 if (c == '#' || c == ';') {
955 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
956 return -1;
957 comment = 1;
958 continue;
960 if (c == '[') {
961 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
962 return -1;
964 /* Reset prior to determining a new stem */
965 strbuf_reset(var);
966 if (get_base_var(var) < 0 || var->len < 1)
967 break;
968 strbuf_addch(var, '.');
969 baselen = var->len;
970 continue;
972 if (!isalpha(c))
973 break;
975 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
976 return -1;
979 * Truncate the var name back to the section header
980 * stem prior to grabbing the suffix part of the name
981 * and the value.
983 strbuf_setlen(var, baselen);
984 strbuf_addch(var, tolower(c));
985 if (get_value(fn, data, var) < 0)
986 break;
989 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
990 return -1;
992 switch (cf->origin_type) {
993 case CONFIG_ORIGIN_BLOB:
994 error_msg = xstrfmt(_("bad config line %d in blob %s"),
995 cf->linenr, cf->name);
996 break;
997 case CONFIG_ORIGIN_FILE:
998 error_msg = xstrfmt(_("bad config line %d in file %s"),
999 cf->linenr, cf->name);
1000 break;
1001 case CONFIG_ORIGIN_STDIN:
1002 error_msg = xstrfmt(_("bad config line %d in standard input"),
1003 cf->linenr);
1004 break;
1005 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1006 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1007 cf->linenr, cf->name);
1008 break;
1009 case CONFIG_ORIGIN_CMDLINE:
1010 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1011 cf->linenr, cf->name);
1012 break;
1013 default:
1014 error_msg = xstrfmt(_("bad config line %d in %s"),
1015 cf->linenr, cf->name);
1018 switch (opts && opts->error_action ?
1019 opts->error_action :
1020 cf->default_error_action) {
1021 case CONFIG_ERROR_DIE:
1022 die("%s", error_msg);
1023 break;
1024 case CONFIG_ERROR_ERROR:
1025 error_return = error("%s", error_msg);
1026 break;
1027 case CONFIG_ERROR_SILENT:
1028 error_return = -1;
1029 break;
1030 case CONFIG_ERROR_UNSET:
1031 BUG("config error action unset");
1034 free(error_msg);
1035 return error_return;
1038 static uintmax_t get_unit_factor(const char *end)
1040 if (!*end)
1041 return 1;
1042 else if (!strcasecmp(end, "k"))
1043 return 1024;
1044 else if (!strcasecmp(end, "m"))
1045 return 1024 * 1024;
1046 else if (!strcasecmp(end, "g"))
1047 return 1024 * 1024 * 1024;
1048 return 0;
1051 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1053 if (value && *value) {
1054 char *end;
1055 intmax_t val;
1056 uintmax_t uval;
1057 uintmax_t factor;
1059 errno = 0;
1060 val = strtoimax(value, &end, 0);
1061 if (errno == ERANGE)
1062 return 0;
1063 factor = get_unit_factor(end);
1064 if (!factor) {
1065 errno = EINVAL;
1066 return 0;
1068 uval = val < 0 ? -val : val;
1069 if (unsigned_mult_overflows(factor, uval) ||
1070 factor * uval > max) {
1071 errno = ERANGE;
1072 return 0;
1074 val *= factor;
1075 *ret = val;
1076 return 1;
1078 errno = EINVAL;
1079 return 0;
1082 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1084 if (value && *value) {
1085 char *end;
1086 uintmax_t val;
1087 uintmax_t factor;
1089 errno = 0;
1090 val = strtoumax(value, &end, 0);
1091 if (errno == ERANGE)
1092 return 0;
1093 factor = get_unit_factor(end);
1094 if (!factor) {
1095 errno = EINVAL;
1096 return 0;
1098 if (unsigned_mult_overflows(factor, val) ||
1099 factor * val > max) {
1100 errno = ERANGE;
1101 return 0;
1103 val *= factor;
1104 *ret = val;
1105 return 1;
1107 errno = EINVAL;
1108 return 0;
1111 static int git_parse_int(const char *value, int *ret)
1113 intmax_t tmp;
1114 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1115 return 0;
1116 *ret = tmp;
1117 return 1;
1120 static int git_parse_int64(const char *value, int64_t *ret)
1122 intmax_t tmp;
1123 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1124 return 0;
1125 *ret = tmp;
1126 return 1;
1129 int git_parse_ulong(const char *value, unsigned long *ret)
1131 uintmax_t tmp;
1132 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1133 return 0;
1134 *ret = tmp;
1135 return 1;
1138 int git_parse_ssize_t(const char *value, ssize_t *ret)
1140 intmax_t tmp;
1141 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1142 return 0;
1143 *ret = tmp;
1144 return 1;
1147 NORETURN
1148 static void die_bad_number(const char *name, const char *value)
1150 const char *error_type = (errno == ERANGE) ?
1151 N_("out of range") : N_("invalid unit");
1152 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1154 if (!value)
1155 value = "";
1157 if (!(cf && cf->name))
1158 die(_(bad_numeric), value, name, _(error_type));
1160 switch (cf->origin_type) {
1161 case CONFIG_ORIGIN_BLOB:
1162 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1163 value, name, cf->name, _(error_type));
1164 case CONFIG_ORIGIN_FILE:
1165 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1166 value, name, cf->name, _(error_type));
1167 case CONFIG_ORIGIN_STDIN:
1168 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1169 value, name, _(error_type));
1170 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1171 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1172 value, name, cf->name, _(error_type));
1173 case CONFIG_ORIGIN_CMDLINE:
1174 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1175 value, name, cf->name, _(error_type));
1176 default:
1177 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1178 value, name, cf->name, _(error_type));
1182 int git_config_int(const char *name, const char *value)
1184 int ret;
1185 if (!git_parse_int(value, &ret))
1186 die_bad_number(name, value);
1187 return ret;
1190 int64_t git_config_int64(const char *name, const char *value)
1192 int64_t ret;
1193 if (!git_parse_int64(value, &ret))
1194 die_bad_number(name, value);
1195 return ret;
1198 unsigned long git_config_ulong(const char *name, const char *value)
1200 unsigned long ret;
1201 if (!git_parse_ulong(value, &ret))
1202 die_bad_number(name, value);
1203 return ret;
1206 ssize_t git_config_ssize_t(const char *name, const char *value)
1208 ssize_t ret;
1209 if (!git_parse_ssize_t(value, &ret))
1210 die_bad_number(name, value);
1211 return ret;
1214 static int git_parse_maybe_bool_text(const char *value)
1216 if (!value)
1217 return 1;
1218 if (!*value)
1219 return 0;
1220 if (!strcasecmp(value, "true")
1221 || !strcasecmp(value, "yes")
1222 || !strcasecmp(value, "on"))
1223 return 1;
1224 if (!strcasecmp(value, "false")
1225 || !strcasecmp(value, "no")
1226 || !strcasecmp(value, "off"))
1227 return 0;
1228 return -1;
1231 int git_parse_maybe_bool(const char *value)
1233 int v = git_parse_maybe_bool_text(value);
1234 if (0 <= v)
1235 return v;
1236 if (git_parse_int(value, &v))
1237 return !!v;
1238 return -1;
1241 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1243 int v = git_parse_maybe_bool_text(value);
1244 if (0 <= v) {
1245 *is_bool = 1;
1246 return v;
1248 *is_bool = 0;
1249 return git_config_int(name, value);
1252 int git_config_bool(const char *name, const char *value)
1254 int v = git_parse_maybe_bool(value);
1255 if (v < 0)
1256 die(_("bad boolean config value '%s' for '%s'"), value, name);
1257 return v;
1260 int git_config_string(const char **dest, const char *var, const char *value)
1262 if (!value)
1263 return config_error_nonbool(var);
1264 *dest = xstrdup(value);
1265 return 0;
1268 int git_config_pathname(const char **dest, const char *var, const char *value)
1270 if (!value)
1271 return config_error_nonbool(var);
1272 *dest = expand_user_path(value, 0);
1273 if (!*dest)
1274 die(_("failed to expand user dir in: '%s'"), value);
1275 return 0;
1278 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1280 if (!value)
1281 return config_error_nonbool(var);
1282 if (parse_expiry_date(value, timestamp))
1283 return error(_("'%s' for '%s' is not a valid timestamp"),
1284 value, var);
1285 return 0;
1288 int git_config_color(char *dest, const char *var, const char *value)
1290 if (!value)
1291 return config_error_nonbool(var);
1292 if (color_parse(value, dest) < 0)
1293 return -1;
1294 return 0;
1297 static int git_default_core_config(const char *var, const char *value, void *cb)
1299 /* This needs a better name */
1300 if (!strcmp(var, "core.filemode")) {
1301 trust_executable_bit = git_config_bool(var, value);
1302 return 0;
1304 if (!strcmp(var, "core.trustctime")) {
1305 trust_ctime = git_config_bool(var, value);
1306 return 0;
1308 if (!strcmp(var, "core.checkstat")) {
1309 if (!strcasecmp(value, "default"))
1310 check_stat = 1;
1311 else if (!strcasecmp(value, "minimal"))
1312 check_stat = 0;
1315 if (!strcmp(var, "core.quotepath")) {
1316 quote_path_fully = git_config_bool(var, value);
1317 return 0;
1320 if (!strcmp(var, "core.symlinks")) {
1321 has_symlinks = git_config_bool(var, value);
1322 return 0;
1325 if (!strcmp(var, "core.ignorecase")) {
1326 ignore_case = git_config_bool(var, value);
1327 return 0;
1330 if (!strcmp(var, "core.attributesfile"))
1331 return git_config_pathname(&git_attributes_file, var, value);
1333 if (!strcmp(var, "core.hookspath"))
1334 return git_config_pathname(&git_hooks_path, var, value);
1336 if (!strcmp(var, "core.bare")) {
1337 is_bare_repository_cfg = git_config_bool(var, value);
1338 return 0;
1341 if (!strcmp(var, "core.ignorestat")) {
1342 assume_unchanged = git_config_bool(var, value);
1343 return 0;
1346 if (!strcmp(var, "core.prefersymlinkrefs")) {
1347 prefer_symlink_refs = git_config_bool(var, value);
1348 return 0;
1351 if (!strcmp(var, "core.logallrefupdates")) {
1352 if (value && !strcasecmp(value, "always"))
1353 log_all_ref_updates = LOG_REFS_ALWAYS;
1354 else if (git_config_bool(var, value))
1355 log_all_ref_updates = LOG_REFS_NORMAL;
1356 else
1357 log_all_ref_updates = LOG_REFS_NONE;
1358 return 0;
1361 if (!strcmp(var, "core.warnambiguousrefs")) {
1362 warn_ambiguous_refs = git_config_bool(var, value);
1363 return 0;
1366 if (!strcmp(var, "core.abbrev")) {
1367 if (!value)
1368 return config_error_nonbool(var);
1369 if (!strcasecmp(value, "auto"))
1370 default_abbrev = -1;
1371 else if (!git_parse_maybe_bool_text(value))
1372 default_abbrev = the_hash_algo->hexsz;
1373 else {
1374 int abbrev = git_config_int(var, value);
1375 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1376 return error(_("abbrev length out of range: %d"), abbrev);
1377 default_abbrev = abbrev;
1379 return 0;
1382 if (!strcmp(var, "core.disambiguate"))
1383 return set_disambiguate_hint_config(var, value);
1385 if (!strcmp(var, "core.loosecompression")) {
1386 int level = git_config_int(var, value);
1387 if (level == -1)
1388 level = Z_DEFAULT_COMPRESSION;
1389 else if (level < 0 || level > Z_BEST_COMPRESSION)
1390 die(_("bad zlib compression level %d"), level);
1391 zlib_compression_level = level;
1392 zlib_compression_seen = 1;
1393 return 0;
1396 if (!strcmp(var, "core.compression")) {
1397 int level = git_config_int(var, value);
1398 if (level == -1)
1399 level = Z_DEFAULT_COMPRESSION;
1400 else if (level < 0 || level > Z_BEST_COMPRESSION)
1401 die(_("bad zlib compression level %d"), level);
1402 if (!zlib_compression_seen)
1403 zlib_compression_level = level;
1404 if (!pack_compression_seen)
1405 pack_compression_level = level;
1406 return 0;
1409 if (!strcmp(var, "core.packedgitwindowsize")) {
1410 int pgsz_x2 = getpagesize() * 2;
1411 packed_git_window_size = git_config_ulong(var, value);
1413 /* This value must be multiple of (pagesize * 2) */
1414 packed_git_window_size /= pgsz_x2;
1415 if (packed_git_window_size < 1)
1416 packed_git_window_size = 1;
1417 packed_git_window_size *= pgsz_x2;
1418 return 0;
1421 if (!strcmp(var, "core.bigfilethreshold")) {
1422 big_file_threshold = git_config_ulong(var, value);
1423 return 0;
1426 if (!strcmp(var, "core.packedgitlimit")) {
1427 packed_git_limit = git_config_ulong(var, value);
1428 return 0;
1431 if (!strcmp(var, "core.deltabasecachelimit")) {
1432 delta_base_cache_limit = git_config_ulong(var, value);
1433 return 0;
1436 if (!strcmp(var, "core.autocrlf")) {
1437 if (value && !strcasecmp(value, "input")) {
1438 auto_crlf = AUTO_CRLF_INPUT;
1439 return 0;
1441 auto_crlf = git_config_bool(var, value);
1442 return 0;
1445 if (!strcmp(var, "core.safecrlf")) {
1446 int eol_rndtrp_die;
1447 if (value && !strcasecmp(value, "warn")) {
1448 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1449 return 0;
1451 eol_rndtrp_die = git_config_bool(var, value);
1452 global_conv_flags_eol = eol_rndtrp_die ?
1453 CONV_EOL_RNDTRP_DIE : 0;
1454 return 0;
1457 if (!strcmp(var, "core.eol")) {
1458 if (value && !strcasecmp(value, "lf"))
1459 core_eol = EOL_LF;
1460 else if (value && !strcasecmp(value, "crlf"))
1461 core_eol = EOL_CRLF;
1462 else if (value && !strcasecmp(value, "native"))
1463 core_eol = EOL_NATIVE;
1464 else
1465 core_eol = EOL_UNSET;
1466 return 0;
1469 if (!strcmp(var, "core.checkroundtripencoding")) {
1470 check_roundtrip_encoding = xstrdup(value);
1471 return 0;
1474 if (!strcmp(var, "core.notesref")) {
1475 notes_ref_name = xstrdup(value);
1476 return 0;
1479 if (!strcmp(var, "core.editor"))
1480 return git_config_string(&editor_program, var, value);
1482 if (!strcmp(var, "core.commentchar")) {
1483 if (!value)
1484 return config_error_nonbool(var);
1485 else if (!strcasecmp(value, "auto"))
1486 auto_comment_line_char = 1;
1487 else if (value[0] && !value[1]) {
1488 comment_line_char = value[0];
1489 auto_comment_line_char = 0;
1490 } else
1491 return error(_("core.commentChar should only be one character"));
1492 return 0;
1495 if (!strcmp(var, "core.askpass"))
1496 return git_config_string(&askpass_program, var, value);
1498 if (!strcmp(var, "core.excludesfile"))
1499 return git_config_pathname(&excludes_file, var, value);
1501 if (!strcmp(var, "core.whitespace")) {
1502 if (!value)
1503 return config_error_nonbool(var);
1504 whitespace_rule_cfg = parse_whitespace_rule(value);
1505 return 0;
1508 if (!strcmp(var, "core.fsyncobjectfiles")) {
1509 fsync_object_files = git_config_bool(var, value);
1510 return 0;
1513 if (!strcmp(var, "core.preloadindex")) {
1514 core_preload_index = git_config_bool(var, value);
1515 return 0;
1518 if (!strcmp(var, "core.createobject")) {
1519 if (!strcmp(value, "rename"))
1520 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1521 else if (!strcmp(value, "link"))
1522 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1523 else
1524 die(_("invalid mode for object creation: %s"), value);
1525 return 0;
1528 if (!strcmp(var, "core.sparsecheckout")) {
1529 core_apply_sparse_checkout = git_config_bool(var, value);
1530 return 0;
1533 if (!strcmp(var, "core.sparsecheckoutcone")) {
1534 core_sparse_checkout_cone = git_config_bool(var, value);
1535 return 0;
1538 if (!strcmp(var, "core.precomposeunicode")) {
1539 precomposed_unicode = git_config_bool(var, value);
1540 return 0;
1543 if (!strcmp(var, "core.protecthfs")) {
1544 protect_hfs = git_config_bool(var, value);
1545 return 0;
1548 if (!strcmp(var, "core.protectntfs")) {
1549 protect_ntfs = git_config_bool(var, value);
1550 return 0;
1553 if (!strcmp(var, "core.usereplacerefs")) {
1554 read_replace_refs = git_config_bool(var, value);
1555 return 0;
1558 /* Add other config variables here and to Documentation/config.txt. */
1559 return platform_core_config(var, value, cb);
1562 static int git_default_i18n_config(const char *var, const char *value)
1564 if (!strcmp(var, "i18n.commitencoding"))
1565 return git_config_string(&git_commit_encoding, var, value);
1567 if (!strcmp(var, "i18n.logoutputencoding"))
1568 return git_config_string(&git_log_output_encoding, var, value);
1570 /* Add other config variables here and to Documentation/config.txt. */
1571 return 0;
1574 static int git_default_branch_config(const char *var, const char *value)
1576 if (!strcmp(var, "branch.autosetupmerge")) {
1577 if (value && !strcasecmp(value, "always")) {
1578 git_branch_track = BRANCH_TRACK_ALWAYS;
1579 return 0;
1581 git_branch_track = git_config_bool(var, value);
1582 return 0;
1584 if (!strcmp(var, "branch.autosetuprebase")) {
1585 if (!value)
1586 return config_error_nonbool(var);
1587 else if (!strcmp(value, "never"))
1588 autorebase = AUTOREBASE_NEVER;
1589 else if (!strcmp(value, "local"))
1590 autorebase = AUTOREBASE_LOCAL;
1591 else if (!strcmp(value, "remote"))
1592 autorebase = AUTOREBASE_REMOTE;
1593 else if (!strcmp(value, "always"))
1594 autorebase = AUTOREBASE_ALWAYS;
1595 else
1596 return error(_("malformed value for %s"), var);
1597 return 0;
1600 /* Add other config variables here and to Documentation/config.txt. */
1601 return 0;
1604 static int git_default_push_config(const char *var, const char *value)
1606 if (!strcmp(var, "push.default")) {
1607 if (!value)
1608 return config_error_nonbool(var);
1609 else if (!strcmp(value, "nothing"))
1610 push_default = PUSH_DEFAULT_NOTHING;
1611 else if (!strcmp(value, "matching"))
1612 push_default = PUSH_DEFAULT_MATCHING;
1613 else if (!strcmp(value, "simple"))
1614 push_default = PUSH_DEFAULT_SIMPLE;
1615 else if (!strcmp(value, "upstream"))
1616 push_default = PUSH_DEFAULT_UPSTREAM;
1617 else if (!strcmp(value, "tracking")) /* deprecated */
1618 push_default = PUSH_DEFAULT_UPSTREAM;
1619 else if (!strcmp(value, "current"))
1620 push_default = PUSH_DEFAULT_CURRENT;
1621 else {
1622 error(_("malformed value for %s: %s"), var, value);
1623 return error(_("must be one of nothing, matching, simple, "
1624 "upstream or current"));
1626 return 0;
1629 /* Add other config variables here and to Documentation/config.txt. */
1630 return 0;
1633 static int git_default_mailmap_config(const char *var, const char *value)
1635 if (!strcmp(var, "mailmap.file"))
1636 return git_config_pathname(&git_mailmap_file, var, value);
1637 if (!strcmp(var, "mailmap.blob"))
1638 return git_config_string(&git_mailmap_blob, var, value);
1640 /* Add other config variables here and to Documentation/config.txt. */
1641 return 0;
1644 int git_default_config(const char *var, const char *value, void *cb)
1646 if (starts_with(var, "core."))
1647 return git_default_core_config(var, value, cb);
1649 if (starts_with(var, "user.") ||
1650 starts_with(var, "author.") ||
1651 starts_with(var, "committer."))
1652 return git_ident_config(var, value, cb);
1654 if (starts_with(var, "i18n."))
1655 return git_default_i18n_config(var, value);
1657 if (starts_with(var, "branch."))
1658 return git_default_branch_config(var, value);
1660 if (starts_with(var, "push."))
1661 return git_default_push_config(var, value);
1663 if (starts_with(var, "mailmap."))
1664 return git_default_mailmap_config(var, value);
1666 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1667 return git_default_advice_config(var, value);
1669 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1670 pager_use_color = git_config_bool(var,value);
1671 return 0;
1674 if (!strcmp(var, "pack.packsizelimit")) {
1675 pack_size_limit_cfg = git_config_ulong(var, value);
1676 return 0;
1679 if (!strcmp(var, "pack.compression")) {
1680 int level = git_config_int(var, value);
1681 if (level == -1)
1682 level = Z_DEFAULT_COMPRESSION;
1683 else if (level < 0 || level > Z_BEST_COMPRESSION)
1684 die(_("bad pack compression level %d"), level);
1685 pack_compression_level = level;
1686 pack_compression_seen = 1;
1687 return 0;
1690 /* Add other config variables here and to Documentation/config.txt. */
1691 return 0;
1695 * All source specific fields in the union, die_on_error, name and the callbacks
1696 * fgetc, ungetc, ftell of top need to be initialized before calling
1697 * this function.
1699 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1700 const struct config_options *opts)
1702 int ret;
1704 /* push config-file parsing state stack */
1705 top->prev = cf;
1706 top->linenr = 1;
1707 top->eof = 0;
1708 top->total_len = 0;
1709 strbuf_init(&top->value, 1024);
1710 strbuf_init(&top->var, 1024);
1711 cf = top;
1713 ret = git_parse_source(fn, data, opts);
1715 /* pop config-file parsing state stack */
1716 strbuf_release(&top->value);
1717 strbuf_release(&top->var);
1718 cf = top->prev;
1720 return ret;
1723 static int do_config_from_file(config_fn_t fn,
1724 const enum config_origin_type origin_type,
1725 const char *name, const char *path, FILE *f,
1726 void *data, const struct config_options *opts)
1728 struct config_source top;
1729 int ret;
1731 top.u.file = f;
1732 top.origin_type = origin_type;
1733 top.name = name;
1734 top.path = path;
1735 top.default_error_action = CONFIG_ERROR_DIE;
1736 top.do_fgetc = config_file_fgetc;
1737 top.do_ungetc = config_file_ungetc;
1738 top.do_ftell = config_file_ftell;
1740 flockfile(f);
1741 ret = do_config_from(&top, fn, data, opts);
1742 funlockfile(f);
1743 return ret;
1746 static int git_config_from_stdin(config_fn_t fn, void *data)
1748 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1749 data, NULL);
1752 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1753 void *data,
1754 const struct config_options *opts)
1756 int ret = -1;
1757 FILE *f;
1759 f = fopen_or_warn(filename, "r");
1760 if (f) {
1761 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1762 filename, f, data, opts);
1763 fclose(f);
1765 return ret;
1768 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1770 return git_config_from_file_with_options(fn, filename, data, NULL);
1773 int git_config_from_mem(config_fn_t fn,
1774 const enum config_origin_type origin_type,
1775 const char *name, const char *buf, size_t len,
1776 void *data, const struct config_options *opts)
1778 struct config_source top;
1780 top.u.buf.buf = buf;
1781 top.u.buf.len = len;
1782 top.u.buf.pos = 0;
1783 top.origin_type = origin_type;
1784 top.name = name;
1785 top.path = NULL;
1786 top.default_error_action = CONFIG_ERROR_ERROR;
1787 top.do_fgetc = config_buf_fgetc;
1788 top.do_ungetc = config_buf_ungetc;
1789 top.do_ftell = config_buf_ftell;
1791 return do_config_from(&top, fn, data, opts);
1794 int git_config_from_blob_oid(config_fn_t fn,
1795 const char *name,
1796 const struct object_id *oid,
1797 void *data)
1799 enum object_type type;
1800 char *buf;
1801 unsigned long size;
1802 int ret;
1804 buf = read_object_file(oid, &type, &size);
1805 if (!buf)
1806 return error(_("unable to load config blob object '%s'"), name);
1807 if (type != OBJ_BLOB) {
1808 free(buf);
1809 return error(_("reference '%s' does not point to a blob"), name);
1812 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1813 data, NULL);
1814 free(buf);
1816 return ret;
1819 static int git_config_from_blob_ref(config_fn_t fn,
1820 const char *name,
1821 void *data)
1823 struct object_id oid;
1825 if (get_oid(name, &oid) < 0)
1826 return error(_("unable to resolve config blob '%s'"), name);
1827 return git_config_from_blob_oid(fn, name, &oid, data);
1830 char *git_system_config(void)
1832 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1833 if (!system_config)
1834 system_config = system_path(ETC_GITCONFIG);
1835 normalize_path_copy(system_config, system_config);
1836 return system_config;
1839 void git_global_config(char **user_out, char **xdg_out)
1841 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1842 char *xdg_config = NULL;
1844 if (!user_config) {
1845 user_config = expand_user_path("~/.gitconfig", 0);
1846 xdg_config = xdg_config_home("config");
1849 *user_out = user_config;
1850 *xdg_out = xdg_config;
1854 * Parse environment variable 'k' as a boolean (in various
1855 * possible spellings); if missing, use the default value 'def'.
1857 int git_env_bool(const char *k, int def)
1859 const char *v = getenv(k);
1860 return v ? git_config_bool(k, v) : def;
1864 * Parse environment variable 'k' as ulong with possibly a unit
1865 * suffix; if missing, use the default value 'val'.
1867 unsigned long git_env_ulong(const char *k, unsigned long val)
1869 const char *v = getenv(k);
1870 if (v && !git_parse_ulong(v, &val))
1871 die(_("failed to parse %s"), k);
1872 return val;
1875 int git_config_system(void)
1877 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1880 static int do_git_config_sequence(const struct config_options *opts,
1881 config_fn_t fn, void *data)
1883 int ret = 0;
1884 char *system_config = git_system_config();
1885 char *xdg_config = NULL;
1886 char *user_config = NULL;
1887 char *repo_config;
1888 enum config_scope prev_parsing_scope = current_parsing_scope;
1890 if (opts->commondir)
1891 repo_config = mkpathdup("%s/config", opts->commondir);
1892 else if (opts->git_dir)
1893 BUG("git_dir without commondir");
1894 else
1895 repo_config = NULL;
1897 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1898 if (git_config_system() && system_config &&
1899 !access_or_die(system_config, R_OK,
1900 opts->system_gently ? ACCESS_EACCES_OK : 0))
1901 ret += git_config_from_file(fn, system_config, data);
1903 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1904 git_global_config(&user_config, &xdg_config);
1906 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1907 ret += git_config_from_file(fn, xdg_config, data);
1909 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1910 ret += git_config_from_file(fn, user_config, data);
1912 current_parsing_scope = CONFIG_SCOPE_LOCAL;
1913 if (!opts->ignore_repo && repo_config &&
1914 !access_or_die(repo_config, R_OK, 0))
1915 ret += git_config_from_file(fn, repo_config, data);
1917 current_parsing_scope = CONFIG_SCOPE_WORKTREE;
1918 if (!opts->ignore_worktree && repository_format_worktree_config) {
1919 char *path = git_pathdup("config.worktree");
1920 if (!access_or_die(path, R_OK, 0))
1921 ret += git_config_from_file(fn, path, data);
1922 free(path);
1925 current_parsing_scope = CONFIG_SCOPE_COMMAND;
1926 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
1927 die(_("unable to parse command-line config"));
1929 current_parsing_scope = prev_parsing_scope;
1930 free(system_config);
1931 free(xdg_config);
1932 free(user_config);
1933 free(repo_config);
1934 return ret;
1937 int config_with_options(config_fn_t fn, void *data,
1938 struct git_config_source *config_source,
1939 const struct config_options *opts)
1941 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1943 if (opts->respect_includes) {
1944 inc.fn = fn;
1945 inc.data = data;
1946 inc.opts = opts;
1947 fn = git_config_include;
1948 data = &inc;
1951 if (config_source)
1952 current_parsing_scope = config_source->scope;
1955 * If we have a specific filename, use it. Otherwise, follow the
1956 * regular lookup sequence.
1958 if (config_source && config_source->use_stdin)
1959 return git_config_from_stdin(fn, data);
1960 else if (config_source && config_source->file)
1961 return git_config_from_file(fn, config_source->file, data);
1962 else if (config_source && config_source->blob)
1963 return git_config_from_blob_ref(fn, config_source->blob, data);
1965 return do_git_config_sequence(opts, fn, data);
1968 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1970 int i, value_index;
1971 struct string_list *values;
1972 struct config_set_element *entry;
1973 struct configset_list *list = &cs->list;
1975 for (i = 0; i < list->nr; i++) {
1976 entry = list->items[i].e;
1977 value_index = list->items[i].value_index;
1978 values = &entry->value_list;
1980 current_config_kvi = values->items[value_index].util;
1982 if (fn(entry->key, values->items[value_index].string, data) < 0)
1983 git_die_config_linenr(entry->key,
1984 current_config_kvi->filename,
1985 current_config_kvi->linenr);
1987 current_config_kvi = NULL;
1991 void read_early_config(config_fn_t cb, void *data)
1993 struct config_options opts = {0};
1994 struct strbuf commondir = STRBUF_INIT;
1995 struct strbuf gitdir = STRBUF_INIT;
1997 opts.respect_includes = 1;
1999 if (have_git_dir()) {
2000 opts.commondir = get_git_common_dir();
2001 opts.git_dir = get_git_dir();
2003 * When setup_git_directory() was not yet asked to discover the
2004 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2005 * is any repository config we should use (but unlike
2006 * setup_git_directory_gently(), no global state is changed, most
2007 * notably, the current working directory is still the same after the
2008 * call).
2010 } else if (!discover_git_directory(&commondir, &gitdir)) {
2011 opts.commondir = commondir.buf;
2012 opts.git_dir = gitdir.buf;
2015 config_with_options(cb, data, NULL, &opts);
2017 strbuf_release(&commondir);
2018 strbuf_release(&gitdir);
2022 * Read config but only enumerate system and global settings.
2023 * Omit any repo-local, worktree-local, or command-line settings.
2025 void read_very_early_config(config_fn_t cb, void *data)
2027 struct config_options opts = { 0 };
2029 opts.respect_includes = 1;
2030 opts.ignore_repo = 1;
2031 opts.ignore_worktree = 1;
2032 opts.ignore_cmdline = 1;
2033 opts.system_gently = 1;
2035 config_with_options(cb, data, NULL, &opts);
2038 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
2040 struct config_set_element k;
2041 struct config_set_element *found_entry;
2042 char *normalized_key;
2044 * `key` may come from the user, so normalize it before using it
2045 * for querying entries from the hashmap.
2047 if (git_config_parse_key(key, &normalized_key, NULL))
2048 return NULL;
2050 hashmap_entry_init(&k.ent, strhash(normalized_key));
2051 k.key = normalized_key;
2052 found_entry = hashmap_get_entry(&cs->config_hash, &k, ent, NULL);
2053 free(normalized_key);
2054 return found_entry;
2057 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
2059 struct config_set_element *e;
2060 struct string_list_item *si;
2061 struct configset_list_item *l_item;
2062 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2064 e = configset_find_element(cs, key);
2066 * Since the keys are being fed by git_config*() callback mechanism, they
2067 * are already normalized. So simply add them without any further munging.
2069 if (!e) {
2070 e = xmalloc(sizeof(*e));
2071 hashmap_entry_init(&e->ent, strhash(key));
2072 e->key = xstrdup(key);
2073 string_list_init_dup(&e->value_list);
2074 hashmap_add(&cs->config_hash, &e->ent);
2076 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2078 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
2079 l_item = &cs->list.items[cs->list.nr++];
2080 l_item->e = e;
2081 l_item->value_index = e->value_list.nr - 1;
2083 if (!cf)
2084 BUG("configset_add_value has no source");
2085 if (cf->name) {
2086 kv_info->filename = strintern(cf->name);
2087 kv_info->linenr = cf->linenr;
2088 kv_info->origin_type = cf->origin_type;
2089 } else {
2090 /* for values read from `git_config_from_parameters()` */
2091 kv_info->filename = NULL;
2092 kv_info->linenr = -1;
2093 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
2095 kv_info->scope = current_parsing_scope;
2096 si->util = kv_info;
2098 return 0;
2101 static int config_set_element_cmp(const void *unused_cmp_data,
2102 const struct hashmap_entry *eptr,
2103 const struct hashmap_entry *entry_or_key,
2104 const void *unused_keydata)
2106 const struct config_set_element *e1, *e2;
2108 e1 = container_of(eptr, const struct config_set_element, ent);
2109 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2111 return strcmp(e1->key, e2->key);
2114 void git_configset_init(struct config_set *cs)
2116 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
2117 cs->hash_initialized = 1;
2118 cs->list.nr = 0;
2119 cs->list.alloc = 0;
2120 cs->list.items = NULL;
2123 void git_configset_clear(struct config_set *cs)
2125 struct config_set_element *entry;
2126 struct hashmap_iter iter;
2127 if (!cs->hash_initialized)
2128 return;
2130 hashmap_for_each_entry(&cs->config_hash, &iter, entry,
2131 ent /* member name */) {
2132 free(entry->key);
2133 string_list_clear(&entry->value_list, 1);
2135 hashmap_clear_and_free(&cs->config_hash, struct config_set_element, ent);
2136 cs->hash_initialized = 0;
2137 free(cs->list.items);
2138 cs->list.nr = 0;
2139 cs->list.alloc = 0;
2140 cs->list.items = NULL;
2143 static int config_set_callback(const char *key, const char *value, void *cb)
2145 struct config_set *cs = cb;
2146 configset_add_value(cs, key, value);
2147 return 0;
2150 int git_configset_add_file(struct config_set *cs, const char *filename)
2152 return git_config_from_file(config_set_callback, filename, cs);
2155 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
2157 const struct string_list *values = NULL;
2159 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2160 * queried key in the files of the configset, the value returned will be the last
2161 * value in the value list for that key.
2163 values = git_configset_get_value_multi(cs, key);
2165 if (!values)
2166 return 1;
2167 assert(values->nr > 0);
2168 *value = values->items[values->nr - 1].string;
2169 return 0;
2172 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
2174 struct config_set_element *e = configset_find_element(cs, key);
2175 return e ? &e->value_list : NULL;
2178 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
2180 const char *value;
2181 if (!git_configset_get_value(cs, key, &value))
2182 return git_config_string((const char **)dest, key, value);
2183 else
2184 return 1;
2187 int git_configset_get_string_tmp(struct config_set *cs, const char *key,
2188 const char **dest)
2190 const char *value;
2191 if (!git_configset_get_value(cs, key, &value)) {
2192 if (!value)
2193 return config_error_nonbool(key);
2194 *dest = value;
2195 return 0;
2196 } else {
2197 return 1;
2201 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
2203 const char *value;
2204 if (!git_configset_get_value(cs, key, &value)) {
2205 *dest = git_config_int(key, value);
2206 return 0;
2207 } else
2208 return 1;
2211 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
2213 const char *value;
2214 if (!git_configset_get_value(cs, key, &value)) {
2215 *dest = git_config_ulong(key, value);
2216 return 0;
2217 } else
2218 return 1;
2221 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
2223 const char *value;
2224 if (!git_configset_get_value(cs, key, &value)) {
2225 *dest = git_config_bool(key, value);
2226 return 0;
2227 } else
2228 return 1;
2231 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
2232 int *is_bool, int *dest)
2234 const char *value;
2235 if (!git_configset_get_value(cs, key, &value)) {
2236 *dest = git_config_bool_or_int(key, value, is_bool);
2237 return 0;
2238 } else
2239 return 1;
2242 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2244 const char *value;
2245 if (!git_configset_get_value(cs, key, &value)) {
2246 *dest = git_parse_maybe_bool(value);
2247 if (*dest == -1)
2248 return -1;
2249 return 0;
2250 } else
2251 return 1;
2254 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2256 const char *value;
2257 if (!git_configset_get_value(cs, key, &value))
2258 return git_config_pathname(dest, key, value);
2259 else
2260 return 1;
2263 /* Functions use to read configuration from a repository */
2264 static void repo_read_config(struct repository *repo)
2266 struct config_options opts = { 0 };
2268 opts.respect_includes = 1;
2269 opts.commondir = repo->commondir;
2270 opts.git_dir = repo->gitdir;
2272 if (!repo->config)
2273 CALLOC_ARRAY(repo->config, 1);
2274 else
2275 git_configset_clear(repo->config);
2277 git_configset_init(repo->config);
2279 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2281 * config_with_options() normally returns only
2282 * zero, as most errors are fatal, and
2283 * non-fatal potential errors are guarded by "if"
2284 * statements that are entered only when no error is
2285 * possible.
2287 * If we ever encounter a non-fatal error, it means
2288 * something went really wrong and we should stop
2289 * immediately.
2291 die(_("unknown error occurred while reading the configuration files"));
2294 static void git_config_check_init(struct repository *repo)
2296 if (repo->config && repo->config->hash_initialized)
2297 return;
2298 repo_read_config(repo);
2301 static void repo_config_clear(struct repository *repo)
2303 if (!repo->config || !repo->config->hash_initialized)
2304 return;
2305 git_configset_clear(repo->config);
2308 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2310 git_config_check_init(repo);
2311 configset_iter(repo->config, fn, data);
2314 int repo_config_get_value(struct repository *repo,
2315 const char *key, const char **value)
2317 git_config_check_init(repo);
2318 return git_configset_get_value(repo->config, key, value);
2321 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2322 const char *key)
2324 git_config_check_init(repo);
2325 return git_configset_get_value_multi(repo->config, key);
2328 int repo_config_get_string(struct repository *repo,
2329 const char *key, char **dest)
2331 int ret;
2332 git_config_check_init(repo);
2333 ret = git_configset_get_string(repo->config, key, dest);
2334 if (ret < 0)
2335 git_die_config(key, NULL);
2336 return ret;
2339 int repo_config_get_string_tmp(struct repository *repo,
2340 const char *key, const char **dest)
2342 int ret;
2343 git_config_check_init(repo);
2344 ret = git_configset_get_string_tmp(repo->config, key, dest);
2345 if (ret < 0)
2346 git_die_config(key, NULL);
2347 return ret;
2350 int repo_config_get_int(struct repository *repo,
2351 const char *key, int *dest)
2353 git_config_check_init(repo);
2354 return git_configset_get_int(repo->config, key, dest);
2357 int repo_config_get_ulong(struct repository *repo,
2358 const char *key, unsigned long *dest)
2360 git_config_check_init(repo);
2361 return git_configset_get_ulong(repo->config, key, dest);
2364 int repo_config_get_bool(struct repository *repo,
2365 const char *key, int *dest)
2367 git_config_check_init(repo);
2368 return git_configset_get_bool(repo->config, key, dest);
2371 int repo_config_get_bool_or_int(struct repository *repo,
2372 const char *key, int *is_bool, int *dest)
2374 git_config_check_init(repo);
2375 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2378 int repo_config_get_maybe_bool(struct repository *repo,
2379 const char *key, int *dest)
2381 git_config_check_init(repo);
2382 return git_configset_get_maybe_bool(repo->config, key, dest);
2385 int repo_config_get_pathname(struct repository *repo,
2386 const char *key, const char **dest)
2388 int ret;
2389 git_config_check_init(repo);
2390 ret = git_configset_get_pathname(repo->config, key, dest);
2391 if (ret < 0)
2392 git_die_config(key, NULL);
2393 return ret;
2396 /* Functions used historically to read configuration from 'the_repository' */
2397 void git_config(config_fn_t fn, void *data)
2399 repo_config(the_repository, fn, data);
2402 void git_config_clear(void)
2404 repo_config_clear(the_repository);
2407 int git_config_get_value(const char *key, const char **value)
2409 return repo_config_get_value(the_repository, key, value);
2412 const struct string_list *git_config_get_value_multi(const char *key)
2414 return repo_config_get_value_multi(the_repository, key);
2417 int git_config_get_string(const char *key, char **dest)
2419 return repo_config_get_string(the_repository, key, dest);
2422 int git_config_get_string_tmp(const char *key, const char **dest)
2424 return repo_config_get_string_tmp(the_repository, key, dest);
2427 int git_config_get_int(const char *key, int *dest)
2429 return repo_config_get_int(the_repository, key, dest);
2432 int git_config_get_ulong(const char *key, unsigned long *dest)
2434 return repo_config_get_ulong(the_repository, key, dest);
2437 int git_config_get_bool(const char *key, int *dest)
2439 return repo_config_get_bool(the_repository, key, dest);
2442 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2444 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2447 int git_config_get_maybe_bool(const char *key, int *dest)
2449 return repo_config_get_maybe_bool(the_repository, key, dest);
2452 int git_config_get_pathname(const char *key, const char **dest)
2454 return repo_config_get_pathname(the_repository, key, dest);
2457 int git_config_get_expiry(const char *key, const char **output)
2459 int ret = git_config_get_string(key, (char **)output);
2460 if (ret)
2461 return ret;
2462 if (strcmp(*output, "now")) {
2463 timestamp_t now = approxidate("now");
2464 if (approxidate(*output) >= now)
2465 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2467 return ret;
2470 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2472 const char *expiry_string;
2473 intmax_t days;
2474 timestamp_t when;
2476 if (git_config_get_string_tmp(key, &expiry_string))
2477 return 1; /* no such thing */
2479 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2480 const int scale = 86400;
2481 *expiry = now - days * scale;
2482 return 0;
2485 if (!parse_expiry_date(expiry_string, &when)) {
2486 *expiry = when;
2487 return 0;
2489 return -1; /* thing exists but cannot be parsed */
2492 int git_config_get_split_index(void)
2494 int val;
2496 if (!git_config_get_maybe_bool("core.splitindex", &val))
2497 return val;
2499 return -1; /* default value */
2502 int git_config_get_max_percent_split_change(void)
2504 int val = -1;
2506 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2507 if (0 <= val && val <= 100)
2508 return val;
2510 return error(_("splitIndex.maxPercentChange value '%d' "
2511 "should be between 0 and 100"), val);
2514 return -1; /* default value */
2517 int git_config_get_fsmonitor(void)
2519 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2520 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2522 if (core_fsmonitor && !*core_fsmonitor)
2523 core_fsmonitor = NULL;
2525 if (core_fsmonitor)
2526 return 1;
2528 return 0;
2531 int git_config_get_index_threads(int *dest)
2533 int is_bool, val;
2535 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2536 if (val) {
2537 *dest = val;
2538 return 0;
2541 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2542 if (is_bool)
2543 *dest = val ? 0 : 1;
2544 else
2545 *dest = val;
2546 return 0;
2549 return 1;
2552 NORETURN
2553 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2555 if (!filename)
2556 die(_("unable to parse '%s' from command-line config"), key);
2557 else
2558 die(_("bad config variable '%s' in file '%s' at line %d"),
2559 key, filename, linenr);
2562 NORETURN __attribute__((format(printf, 2, 3)))
2563 void git_die_config(const char *key, const char *err, ...)
2565 const struct string_list *values;
2566 struct key_value_info *kv_info;
2568 if (err) {
2569 va_list params;
2570 va_start(params, err);
2571 vreportf("error: ", err, params);
2572 va_end(params);
2574 values = git_config_get_value_multi(key);
2575 kv_info = values->items[values->nr - 1].util;
2576 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2580 * Find all the stuff for git_config_set() below.
2583 struct config_store_data {
2584 size_t baselen;
2585 char *key;
2586 int do_not_match;
2587 const char *fixed_value;
2588 regex_t *value_pattern;
2589 int multi_replace;
2590 struct {
2591 size_t begin, end;
2592 enum config_event_t type;
2593 int is_keys_section;
2594 } *parsed;
2595 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2596 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2599 static void config_store_data_clear(struct config_store_data *store)
2601 free(store->key);
2602 if (store->value_pattern != NULL &&
2603 store->value_pattern != CONFIG_REGEX_NONE) {
2604 regfree(store->value_pattern);
2605 free(store->value_pattern);
2607 free(store->parsed);
2608 free(store->seen);
2609 memset(store, 0, sizeof(*store));
2612 static int matches(const char *key, const char *value,
2613 const struct config_store_data *store)
2615 if (strcmp(key, store->key))
2616 return 0; /* not ours */
2617 if (store->fixed_value)
2618 return !strcmp(store->fixed_value, value);
2619 if (!store->value_pattern)
2620 return 1; /* always matches */
2621 if (store->value_pattern == CONFIG_REGEX_NONE)
2622 return 0; /* never matches */
2624 return store->do_not_match ^
2625 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2628 static int store_aux_event(enum config_event_t type,
2629 size_t begin, size_t end, void *data)
2631 struct config_store_data *store = data;
2633 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2634 store->parsed[store->parsed_nr].begin = begin;
2635 store->parsed[store->parsed_nr].end = end;
2636 store->parsed[store->parsed_nr].type = type;
2638 if (type == CONFIG_EVENT_SECTION) {
2639 int (*cmpfn)(const char *, const char *, size_t);
2641 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2642 return error(_("invalid section name '%s'"), cf->var.buf);
2644 if (cf->subsection_case_sensitive)
2645 cmpfn = strncasecmp;
2646 else
2647 cmpfn = strncmp;
2649 /* Is this the section we were looking for? */
2650 store->is_keys_section =
2651 store->parsed[store->parsed_nr].is_keys_section =
2652 cf->var.len - 1 == store->baselen &&
2653 !cmpfn(cf->var.buf, store->key, store->baselen);
2654 if (store->is_keys_section) {
2655 store->section_seen = 1;
2656 ALLOC_GROW(store->seen, store->seen_nr + 1,
2657 store->seen_alloc);
2658 store->seen[store->seen_nr] = store->parsed_nr;
2662 store->parsed_nr++;
2664 return 0;
2667 static int store_aux(const char *key, const char *value, void *cb)
2669 struct config_store_data *store = cb;
2671 if (store->key_seen) {
2672 if (matches(key, value, store)) {
2673 if (store->seen_nr == 1 && store->multi_replace == 0) {
2674 warning(_("%s has multiple values"), key);
2677 ALLOC_GROW(store->seen, store->seen_nr + 1,
2678 store->seen_alloc);
2680 store->seen[store->seen_nr] = store->parsed_nr;
2681 store->seen_nr++;
2683 } else if (store->is_keys_section) {
2685 * Do not increment matches yet: this may not be a match, but we
2686 * are in the desired section.
2688 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2689 store->seen[store->seen_nr] = store->parsed_nr;
2690 store->section_seen = 1;
2692 if (matches(key, value, store)) {
2693 store->seen_nr++;
2694 store->key_seen = 1;
2698 return 0;
2701 static int write_error(const char *filename)
2703 error(_("failed to write new configuration file %s"), filename);
2705 /* Same error code as "failed to rename". */
2706 return 4;
2709 static struct strbuf store_create_section(const char *key,
2710 const struct config_store_data *store)
2712 const char *dot;
2713 size_t i;
2714 struct strbuf sb = STRBUF_INIT;
2716 dot = memchr(key, '.', store->baselen);
2717 if (dot) {
2718 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2719 for (i = dot - key + 1; i < store->baselen; i++) {
2720 if (key[i] == '"' || key[i] == '\\')
2721 strbuf_addch(&sb, '\\');
2722 strbuf_addch(&sb, key[i]);
2724 strbuf_addstr(&sb, "\"]\n");
2725 } else {
2726 strbuf_addch(&sb, '[');
2727 strbuf_add(&sb, key, store->baselen);
2728 strbuf_addstr(&sb, "]\n");
2731 return sb;
2734 static ssize_t write_section(int fd, const char *key,
2735 const struct config_store_data *store)
2737 struct strbuf sb = store_create_section(key, store);
2738 ssize_t ret;
2740 ret = write_in_full(fd, sb.buf, sb.len);
2741 strbuf_release(&sb);
2743 return ret;
2746 static ssize_t write_pair(int fd, const char *key, const char *value,
2747 const struct config_store_data *store)
2749 int i;
2750 ssize_t ret;
2751 const char *quote = "";
2752 struct strbuf sb = STRBUF_INIT;
2755 * Check to see if the value needs to be surrounded with a dq pair.
2756 * Note that problematic characters are always backslash-quoted; this
2757 * check is about not losing leading or trailing SP and strings that
2758 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2759 * configuration parser.
2761 if (value[0] == ' ')
2762 quote = "\"";
2763 for (i = 0; value[i]; i++)
2764 if (value[i] == ';' || value[i] == '#')
2765 quote = "\"";
2766 if (i && value[i - 1] == ' ')
2767 quote = "\"";
2769 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
2771 for (i = 0; value[i]; i++)
2772 switch (value[i]) {
2773 case '\n':
2774 strbuf_addstr(&sb, "\\n");
2775 break;
2776 case '\t':
2777 strbuf_addstr(&sb, "\\t");
2778 break;
2779 case '"':
2780 case '\\':
2781 strbuf_addch(&sb, '\\');
2782 /* fallthrough */
2783 default:
2784 strbuf_addch(&sb, value[i]);
2785 break;
2787 strbuf_addf(&sb, "%s\n", quote);
2789 ret = write_in_full(fd, sb.buf, sb.len);
2790 strbuf_release(&sb);
2792 return ret;
2796 * If we are about to unset the last key(s) in a section, and if there are
2797 * no comments surrounding (or included in) the section, we will want to
2798 * extend begin/end to remove the entire section.
2800 * Note: the parameter `seen_ptr` points to the index into the store.seen
2801 * array. * This index may be incremented if a section has more than one
2802 * entry (which all are to be removed).
2804 static void maybe_remove_section(struct config_store_data *store,
2805 size_t *begin_offset, size_t *end_offset,
2806 int *seen_ptr)
2808 size_t begin;
2809 int i, seen, section_seen = 0;
2812 * First, ensure that this is the first key, and that there are no
2813 * comments before the entry nor before the section header.
2815 seen = *seen_ptr;
2816 for (i = store->seen[seen]; i > 0; i--) {
2817 enum config_event_t type = store->parsed[i - 1].type;
2819 if (type == CONFIG_EVENT_COMMENT)
2820 /* There is a comment before this entry or section */
2821 return;
2822 if (type == CONFIG_EVENT_ENTRY) {
2823 if (!section_seen)
2824 /* This is not the section's first entry. */
2825 return;
2826 /* We encountered no comment before the section. */
2827 break;
2829 if (type == CONFIG_EVENT_SECTION) {
2830 if (!store->parsed[i - 1].is_keys_section)
2831 break;
2832 section_seen = 1;
2835 begin = store->parsed[i].begin;
2838 * Next, make sure that we are removing the last key(s) in the section,
2839 * and that there are no comments that are possibly about the current
2840 * section.
2842 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2843 enum config_event_t type = store->parsed[i].type;
2845 if (type == CONFIG_EVENT_COMMENT)
2846 return;
2847 if (type == CONFIG_EVENT_SECTION) {
2848 if (store->parsed[i].is_keys_section)
2849 continue;
2850 break;
2852 if (type == CONFIG_EVENT_ENTRY) {
2853 if (++seen < store->seen_nr &&
2854 i == store->seen[seen])
2855 /* We want to remove this entry, too */
2856 continue;
2857 /* There is another entry in this section. */
2858 return;
2863 * We are really removing the last entry/entries from this section, and
2864 * there are no enclosed or surrounding comments. Remove the entire,
2865 * now-empty section.
2867 *seen_ptr = seen;
2868 *begin_offset = begin;
2869 if (i < store->parsed_nr)
2870 *end_offset = store->parsed[i].begin;
2871 else
2872 *end_offset = store->parsed[store->parsed_nr - 1].end;
2875 int git_config_set_in_file_gently(const char *config_filename,
2876 const char *key, const char *value)
2878 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2881 void git_config_set_in_file(const char *config_filename,
2882 const char *key, const char *value)
2884 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2887 int git_config_set_gently(const char *key, const char *value)
2889 return git_config_set_multivar_gently(key, value, NULL, 0);
2892 void git_config_set(const char *key, const char *value)
2894 git_config_set_multivar(key, value, NULL, 0);
2896 trace2_cmd_set_config(key, value);
2900 * If value==NULL, unset in (remove from) config,
2901 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
2902 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
2903 * (only add a new one)
2904 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
2905 * key/values are removed before a single new pair is written. If the
2906 * flag is not present, then replace only the first match.
2908 * Returns 0 on success.
2910 * This function does this:
2912 * - it locks the config file by creating ".git/config.lock"
2914 * - it then parses the config using store_aux() as validator to find
2915 * the position on the key/value pair to replace. If it is to be unset,
2916 * it must be found exactly once.
2918 * - the config file is mmap()ed and the part before the match (if any) is
2919 * written to the lock file, then the changed part and the rest.
2921 * - the config file is removed and the lock file rename()d to it.
2924 int git_config_set_multivar_in_file_gently(const char *config_filename,
2925 const char *key, const char *value,
2926 const char *value_pattern,
2927 unsigned flags)
2929 int fd = -1, in_fd = -1;
2930 int ret;
2931 struct lock_file lock = LOCK_INIT;
2932 char *filename_buf = NULL;
2933 char *contents = NULL;
2934 size_t contents_sz;
2935 struct config_store_data store;
2937 memset(&store, 0, sizeof(store));
2939 /* parse-key returns negative; flip the sign to feed exit(3) */
2940 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2941 if (ret)
2942 goto out_free;
2944 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
2946 if (!config_filename)
2947 config_filename = filename_buf = git_pathdup("config");
2950 * The lock serves a purpose in addition to locking: the new
2951 * contents of .git/config will be written into it.
2953 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2954 if (fd < 0) {
2955 error_errno(_("could not lock config file %s"), config_filename);
2956 ret = CONFIG_NO_LOCK;
2957 goto out_free;
2961 * If .git/config does not exist yet, write a minimal version.
2963 in_fd = open(config_filename, O_RDONLY);
2964 if ( in_fd < 0 ) {
2965 if ( ENOENT != errno ) {
2966 error_errno(_("opening %s"), config_filename);
2967 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2968 goto out_free;
2970 /* if nothing to unset, error out */
2971 if (value == NULL) {
2972 ret = CONFIG_NOTHING_SET;
2973 goto out_free;
2976 free(store.key);
2977 store.key = xstrdup(key);
2978 if (write_section(fd, key, &store) < 0 ||
2979 write_pair(fd, key, value, &store) < 0)
2980 goto write_err_out;
2981 } else {
2982 struct stat st;
2983 size_t copy_begin, copy_end;
2984 int i, new_line = 0;
2985 struct config_options opts;
2987 if (value_pattern == NULL)
2988 store.value_pattern = NULL;
2989 else if (value_pattern == CONFIG_REGEX_NONE)
2990 store.value_pattern = CONFIG_REGEX_NONE;
2991 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
2992 store.fixed_value = value_pattern;
2993 else {
2994 if (value_pattern[0] == '!') {
2995 store.do_not_match = 1;
2996 value_pattern++;
2997 } else
2998 store.do_not_match = 0;
3000 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3001 if (regcomp(store.value_pattern, value_pattern,
3002 REG_EXTENDED)) {
3003 error(_("invalid pattern: %s"), value_pattern);
3004 FREE_AND_NULL(store.value_pattern);
3005 ret = CONFIG_INVALID_PATTERN;
3006 goto out_free;
3010 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3011 store.parsed[0].end = 0;
3013 memset(&opts, 0, sizeof(opts));
3014 opts.event_fn = store_aux_event;
3015 opts.event_fn_data = &store;
3018 * After this, store.parsed will contain offsets of all the
3019 * parsed elements, and store.seen will contain a list of
3020 * matches, as indices into store.parsed.
3022 * As a side effect, we make sure to transform only a valid
3023 * existing config file.
3025 if (git_config_from_file_with_options(store_aux,
3026 config_filename,
3027 &store, &opts)) {
3028 error(_("invalid config file %s"), config_filename);
3029 ret = CONFIG_INVALID_FILE;
3030 goto out_free;
3033 /* if nothing to unset, or too many matches, error out */
3034 if ((store.seen_nr == 0 && value == NULL) ||
3035 (store.seen_nr > 1 && !store.multi_replace)) {
3036 ret = CONFIG_NOTHING_SET;
3037 goto out_free;
3040 if (fstat(in_fd, &st) == -1) {
3041 error_errno(_("fstat on %s failed"), config_filename);
3042 ret = CONFIG_INVALID_FILE;
3043 goto out_free;
3046 contents_sz = xsize_t(st.st_size);
3047 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3048 MAP_PRIVATE, in_fd, 0);
3049 if (contents == MAP_FAILED) {
3050 if (errno == ENODEV && S_ISDIR(st.st_mode))
3051 errno = EISDIR;
3052 error_errno(_("unable to mmap '%s'%s"),
3053 config_filename, mmap_os_err());
3054 ret = CONFIG_INVALID_FILE;
3055 contents = NULL;
3056 goto out_free;
3058 close(in_fd);
3059 in_fd = -1;
3061 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3062 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3063 ret = CONFIG_NO_WRITE;
3064 goto out_free;
3067 if (store.seen_nr == 0) {
3068 if (!store.seen_alloc) {
3069 /* Did not see key nor section */
3070 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3071 store.seen[0] = store.parsed_nr
3072 - !!store.parsed_nr;
3074 store.seen_nr = 1;
3077 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3078 size_t replace_end;
3079 int j = store.seen[i];
3081 new_line = 0;
3082 if (!store.key_seen) {
3083 copy_end = store.parsed[j].end;
3084 /* include '\n' when copying section header */
3085 if (copy_end > 0 && copy_end < contents_sz &&
3086 contents[copy_end - 1] != '\n' &&
3087 contents[copy_end] == '\n')
3088 copy_end++;
3089 replace_end = copy_end;
3090 } else {
3091 replace_end = store.parsed[j].end;
3092 copy_end = store.parsed[j].begin;
3093 if (!value)
3094 maybe_remove_section(&store,
3095 &copy_end,
3096 &replace_end, &i);
3098 * Swallow preceding white-space on the same
3099 * line.
3101 while (copy_end > 0 ) {
3102 char c = contents[copy_end - 1];
3104 if (isspace(c) && c != '\n')
3105 copy_end--;
3106 else
3107 break;
3111 if (copy_end > 0 && contents[copy_end-1] != '\n')
3112 new_line = 1;
3114 /* write the first part of the config */
3115 if (copy_end > copy_begin) {
3116 if (write_in_full(fd, contents + copy_begin,
3117 copy_end - copy_begin) < 0)
3118 goto write_err_out;
3119 if (new_line &&
3120 write_str_in_full(fd, "\n") < 0)
3121 goto write_err_out;
3123 copy_begin = replace_end;
3126 /* write the pair (value == NULL means unset) */
3127 if (value != NULL) {
3128 if (!store.section_seen) {
3129 if (write_section(fd, key, &store) < 0)
3130 goto write_err_out;
3132 if (write_pair(fd, key, value, &store) < 0)
3133 goto write_err_out;
3136 /* write the rest of the config */
3137 if (copy_begin < contents_sz)
3138 if (write_in_full(fd, contents + copy_begin,
3139 contents_sz - copy_begin) < 0)
3140 goto write_err_out;
3142 munmap(contents, contents_sz);
3143 contents = NULL;
3146 if (commit_lock_file(&lock) < 0) {
3147 error_errno(_("could not write config file %s"), config_filename);
3148 ret = CONFIG_NO_WRITE;
3149 goto out_free;
3152 ret = 0;
3154 /* Invalidate the config cache */
3155 git_config_clear();
3157 out_free:
3158 rollback_lock_file(&lock);
3159 free(filename_buf);
3160 if (contents)
3161 munmap(contents, contents_sz);
3162 if (in_fd >= 0)
3163 close(in_fd);
3164 config_store_data_clear(&store);
3165 return ret;
3167 write_err_out:
3168 ret = write_error(get_lock_file_path(&lock));
3169 goto out_free;
3173 void git_config_set_multivar_in_file(const char *config_filename,
3174 const char *key, const char *value,
3175 const char *value_pattern, unsigned flags)
3177 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3178 value_pattern, flags))
3179 return;
3180 if (value)
3181 die(_("could not set '%s' to '%s'"), key, value);
3182 else
3183 die(_("could not unset '%s'"), key);
3186 int git_config_set_multivar_gently(const char *key, const char *value,
3187 const char *value_pattern, unsigned flags)
3189 return git_config_set_multivar_in_file_gently(NULL, key, value, value_pattern,
3190 flags);
3193 void git_config_set_multivar(const char *key, const char *value,
3194 const char *value_pattern, unsigned flags)
3196 git_config_set_multivar_in_file(NULL, key, value, value_pattern,
3197 flags);
3200 static int section_name_match (const char *buf, const char *name)
3202 int i = 0, j = 0, dot = 0;
3203 if (buf[i] != '[')
3204 return 0;
3205 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3206 if (!dot && isspace(buf[i])) {
3207 dot = 1;
3208 if (name[j++] != '.')
3209 break;
3210 for (i++; isspace(buf[i]); i++)
3211 ; /* do nothing */
3212 if (buf[i] != '"')
3213 break;
3214 continue;
3216 if (buf[i] == '\\' && dot)
3217 i++;
3218 else if (buf[i] == '"' && dot) {
3219 for (i++; isspace(buf[i]); i++)
3220 ; /* do_nothing */
3221 break;
3223 if (buf[i] != name[j++])
3224 break;
3226 if (buf[i] == ']' && name[j] == 0) {
3228 * We match, now just find the right length offset by
3229 * gobbling up any whitespace after it, as well
3231 i++;
3232 for (; buf[i] && isspace(buf[i]); i++)
3233 ; /* do nothing */
3234 return i;
3236 return 0;
3239 static int section_name_is_ok(const char *name)
3241 /* Empty section names are bogus. */
3242 if (!*name)
3243 return 0;
3246 * Before a dot, we must be alphanumeric or dash. After the first dot,
3247 * anything goes, so we can stop checking.
3249 for (; *name && *name != '.'; name++)
3250 if (*name != '-' && !isalnum(*name))
3251 return 0;
3252 return 1;
3255 /* if new_name == NULL, the section is removed instead */
3256 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3257 const char *old_name,
3258 const char *new_name, int copy)
3260 int ret = 0, remove = 0;
3261 char *filename_buf = NULL;
3262 struct lock_file lock = LOCK_INIT;
3263 int out_fd;
3264 char buf[1024];
3265 FILE *config_file = NULL;
3266 struct stat st;
3267 struct strbuf copystr = STRBUF_INIT;
3268 struct config_store_data store;
3270 memset(&store, 0, sizeof(store));
3272 if (new_name && !section_name_is_ok(new_name)) {
3273 ret = error(_("invalid section name: %s"), new_name);
3274 goto out_no_rollback;
3277 if (!config_filename)
3278 config_filename = filename_buf = git_pathdup("config");
3280 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3281 if (out_fd < 0) {
3282 ret = error(_("could not lock config file %s"), config_filename);
3283 goto out;
3286 if (!(config_file = fopen(config_filename, "rb"))) {
3287 ret = warn_on_fopen_errors(config_filename);
3288 if (ret)
3289 goto out;
3290 /* no config file means nothing to rename, no error */
3291 goto commit_and_out;
3294 if (fstat(fileno(config_file), &st) == -1) {
3295 ret = error_errno(_("fstat on %s failed"), config_filename);
3296 goto out;
3299 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3300 ret = error_errno(_("chmod on %s failed"),
3301 get_lock_file_path(&lock));
3302 goto out;
3305 while (fgets(buf, sizeof(buf), config_file)) {
3306 unsigned i;
3307 int length;
3308 int is_section = 0;
3309 char *output = buf;
3310 for (i = 0; buf[i] && isspace(buf[i]); i++)
3311 ; /* do nothing */
3312 if (buf[i] == '[') {
3313 /* it's a section */
3314 int offset;
3315 is_section = 1;
3318 * When encountering a new section under -c we
3319 * need to flush out any section we're already
3320 * coping and begin anew. There might be
3321 * multiple [branch "$name"] sections.
3323 if (copystr.len > 0) {
3324 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3325 ret = write_error(get_lock_file_path(&lock));
3326 goto out;
3328 strbuf_reset(&copystr);
3331 offset = section_name_match(&buf[i], old_name);
3332 if (offset > 0) {
3333 ret++;
3334 if (new_name == NULL) {
3335 remove = 1;
3336 continue;
3338 store.baselen = strlen(new_name);
3339 if (!copy) {
3340 if (write_section(out_fd, new_name, &store) < 0) {
3341 ret = write_error(get_lock_file_path(&lock));
3342 goto out;
3345 * We wrote out the new section, with
3346 * a newline, now skip the old
3347 * section's length
3349 output += offset + i;
3350 if (strlen(output) > 0) {
3352 * More content means there's
3353 * a declaration to put on the
3354 * next line; indent with a
3355 * tab
3357 output -= 1;
3358 output[0] = '\t';
3360 } else {
3361 copystr = store_create_section(new_name, &store);
3364 remove = 0;
3366 if (remove)
3367 continue;
3368 length = strlen(output);
3370 if (!is_section && copystr.len > 0) {
3371 strbuf_add(&copystr, output, length);
3374 if (write_in_full(out_fd, output, length) < 0) {
3375 ret = write_error(get_lock_file_path(&lock));
3376 goto out;
3381 * Copy a trailing section at the end of the config, won't be
3382 * flushed by the usual "flush because we have a new section
3383 * logic in the loop above.
3385 if (copystr.len > 0) {
3386 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3387 ret = write_error(get_lock_file_path(&lock));
3388 goto out;
3390 strbuf_reset(&copystr);
3393 fclose(config_file);
3394 config_file = NULL;
3395 commit_and_out:
3396 if (commit_lock_file(&lock) < 0)
3397 ret = error_errno(_("could not write config file %s"),
3398 config_filename);
3399 out:
3400 if (config_file)
3401 fclose(config_file);
3402 rollback_lock_file(&lock);
3403 out_no_rollback:
3404 free(filename_buf);
3405 config_store_data_clear(&store);
3406 return ret;
3409 int git_config_rename_section_in_file(const char *config_filename,
3410 const char *old_name, const char *new_name)
3412 return git_config_copy_or_rename_section_in_file(config_filename,
3413 old_name, new_name, 0);
3416 int git_config_rename_section(const char *old_name, const char *new_name)
3418 return git_config_rename_section_in_file(NULL, old_name, new_name);
3421 int git_config_copy_section_in_file(const char *config_filename,
3422 const char *old_name, const char *new_name)
3424 return git_config_copy_or_rename_section_in_file(config_filename,
3425 old_name, new_name, 1);
3428 int git_config_copy_section(const char *old_name, const char *new_name)
3430 return git_config_copy_section_in_file(NULL, old_name, new_name);
3434 * Call this to report error for your variable that should not
3435 * get a boolean value (i.e. "[my] var" means "true").
3437 #undef config_error_nonbool
3438 int config_error_nonbool(const char *var)
3440 return error(_("missing value for '%s'"), var);
3443 int parse_config_key(const char *var,
3444 const char *section,
3445 const char **subsection, size_t *subsection_len,
3446 const char **key)
3448 const char *dot;
3450 /* Does it start with "section." ? */
3451 if (!skip_prefix(var, section, &var) || *var != '.')
3452 return -1;
3455 * Find the key; we don't know yet if we have a subsection, but we must
3456 * parse backwards from the end, since the subsection may have dots in
3457 * it, too.
3459 dot = strrchr(var, '.');
3460 *key = dot + 1;
3462 /* Did we have a subsection at all? */
3463 if (dot == var) {
3464 if (subsection) {
3465 *subsection = NULL;
3466 *subsection_len = 0;
3469 else {
3470 if (!subsection)
3471 return -1;
3472 *subsection = var + 1;
3473 *subsection_len = dot - *subsection;
3476 return 0;
3479 const char *current_config_origin_type(void)
3481 int type;
3482 if (current_config_kvi)
3483 type = current_config_kvi->origin_type;
3484 else if(cf)
3485 type = cf->origin_type;
3486 else
3487 BUG("current_config_origin_type called outside config callback");
3489 switch (type) {
3490 case CONFIG_ORIGIN_BLOB:
3491 return "blob";
3492 case CONFIG_ORIGIN_FILE:
3493 return "file";
3494 case CONFIG_ORIGIN_STDIN:
3495 return "standard input";
3496 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3497 return "submodule-blob";
3498 case CONFIG_ORIGIN_CMDLINE:
3499 return "command line";
3500 default:
3501 BUG("unknown config origin type");
3505 const char *config_scope_name(enum config_scope scope)
3507 switch (scope) {
3508 case CONFIG_SCOPE_SYSTEM:
3509 return "system";
3510 case CONFIG_SCOPE_GLOBAL:
3511 return "global";
3512 case CONFIG_SCOPE_LOCAL:
3513 return "local";
3514 case CONFIG_SCOPE_WORKTREE:
3515 return "worktree";
3516 case CONFIG_SCOPE_COMMAND:
3517 return "command";
3518 case CONFIG_SCOPE_SUBMODULE:
3519 return "submodule";
3520 default:
3521 return "unknown";
3525 const char *current_config_name(void)
3527 const char *name;
3528 if (current_config_kvi)
3529 name = current_config_kvi->filename;
3530 else if (cf)
3531 name = cf->name;
3532 else
3533 BUG("current_config_name called outside config callback");
3534 return name ? name : "";
3537 enum config_scope current_config_scope(void)
3539 if (current_config_kvi)
3540 return current_config_kvi->scope;
3541 else
3542 return current_parsing_scope;
3545 int current_config_line(void)
3547 if (current_config_kvi)
3548 return current_config_kvi->linenr;
3549 else
3550 return cf->linenr;
3553 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3555 int i;
3557 for (i = 0; i < nr_mapping; i++) {
3558 const char *name = mapping[i];
3560 if (name && !strcasecmp(var, name))
3561 return i;
3563 return -1;