Merge tag 'v2.32.0-rc2' into debian-sid
[git/debian.git] / config.c
blobf9c400ad3062d9953142d6a2f9c4b357962c48c7
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 core_compression_seen;
80 static int pack_compression_seen;
81 static int zlib_compression_seen;
83 static int config_file_fgetc(struct config_source *conf)
85 return getc_unlocked(conf->u.file);
88 static int config_file_ungetc(int c, struct config_source *conf)
90 return ungetc(c, conf->u.file);
93 static long config_file_ftell(struct config_source *conf)
95 return ftell(conf->u.file);
99 static int config_buf_fgetc(struct config_source *conf)
101 if (conf->u.buf.pos < conf->u.buf.len)
102 return conf->u.buf.buf[conf->u.buf.pos++];
104 return EOF;
107 static int config_buf_ungetc(int c, struct config_source *conf)
109 if (conf->u.buf.pos > 0) {
110 conf->u.buf.pos--;
111 if (conf->u.buf.buf[conf->u.buf.pos] != c)
112 BUG("config_buf can only ungetc the same character");
113 return c;
116 return EOF;
119 static long config_buf_ftell(struct config_source *conf)
121 return conf->u.buf.pos;
124 #define MAX_INCLUDE_DEPTH 10
125 static const char include_depth_advice[] = N_(
126 "exceeded maximum include depth (%d) while including\n"
127 " %s\n"
128 "from\n"
129 " %s\n"
130 "This might be due to circular includes.");
131 static int handle_path_include(const char *path, struct config_include_data *inc)
133 int ret = 0;
134 struct strbuf buf = STRBUF_INIT;
135 char *expanded;
137 if (!path)
138 return config_error_nonbool("include.path");
140 expanded = expand_user_path(path, 0);
141 if (!expanded)
142 return error(_("could not expand include path '%s'"), path);
143 path = expanded;
146 * Use an absolute path as-is, but interpret relative paths
147 * based on the including config file.
149 if (!is_absolute_path(path)) {
150 char *slash;
152 if (!cf || !cf->path)
153 return error(_("relative config includes must come from files"));
155 slash = find_last_dir_sep(cf->path);
156 if (slash)
157 strbuf_add(&buf, cf->path, slash - cf->path + 1);
158 strbuf_addstr(&buf, path);
159 path = buf.buf;
162 if (!access_or_die(path, R_OK, 0)) {
163 if (++inc->depth > MAX_INCLUDE_DEPTH)
164 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
165 !cf ? "<unknown>" :
166 cf->name ? cf->name :
167 "the command line");
168 ret = git_config_from_file(git_config_include, path, inc);
169 inc->depth--;
171 strbuf_release(&buf);
172 free(expanded);
173 return ret;
176 static void add_trailing_starstar_for_dir(struct strbuf *pat)
178 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
179 strbuf_addstr(pat, "**");
182 static int prepare_include_condition_pattern(struct strbuf *pat)
184 struct strbuf path = STRBUF_INIT;
185 char *expanded;
186 int prefix = 0;
188 expanded = expand_user_path(pat->buf, 1);
189 if (expanded) {
190 strbuf_reset(pat);
191 strbuf_addstr(pat, expanded);
192 free(expanded);
195 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
196 const char *slash;
198 if (!cf || !cf->path)
199 return error(_("relative config include "
200 "conditionals must come from files"));
202 strbuf_realpath(&path, cf->path, 1);
203 slash = find_last_dir_sep(path.buf);
204 if (!slash)
205 BUG("how is this possible?");
206 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
207 prefix = slash - path.buf + 1 /* slash */;
208 } else if (!is_absolute_path(pat->buf))
209 strbuf_insertstr(pat, 0, "**/");
211 add_trailing_starstar_for_dir(pat);
213 strbuf_release(&path);
214 return prefix;
217 static int include_by_gitdir(const struct config_options *opts,
218 const char *cond, size_t cond_len, int icase)
220 struct strbuf text = STRBUF_INIT;
221 struct strbuf pattern = STRBUF_INIT;
222 int ret = 0, prefix;
223 const char *git_dir;
224 int already_tried_absolute = 0;
226 if (opts->git_dir)
227 git_dir = opts->git_dir;
228 else
229 goto done;
231 strbuf_realpath(&text, git_dir, 1);
232 strbuf_add(&pattern, cond, cond_len);
233 prefix = prepare_include_condition_pattern(&pattern);
235 again:
236 if (prefix < 0)
237 goto done;
239 if (prefix > 0) {
241 * perform literal matching on the prefix part so that
242 * any wildcard character in it can't create side effects.
244 if (text.len < prefix)
245 goto done;
246 if (!icase && strncmp(pattern.buf, text.buf, prefix))
247 goto done;
248 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
249 goto done;
252 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
253 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
255 if (!ret && !already_tried_absolute) {
257 * We've tried e.g. matching gitdir:~/work, but if
258 * ~/work is a symlink to /mnt/storage/work
259 * strbuf_realpath() will expand it, so the rule won't
260 * match. Let's match against a
261 * strbuf_add_absolute_path() version of the path,
262 * which'll do the right thing
264 strbuf_reset(&text);
265 strbuf_add_absolute_path(&text, git_dir);
266 already_tried_absolute = 1;
267 goto again;
269 done:
270 strbuf_release(&pattern);
271 strbuf_release(&text);
272 return ret;
275 static int include_by_branch(const char *cond, size_t cond_len)
277 int flags;
278 int ret;
279 struct strbuf pattern = STRBUF_INIT;
280 const char *refname = !the_repository->gitdir ?
281 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
282 const char *shortname;
284 if (!refname || !(flags & REF_ISSYMREF) ||
285 !skip_prefix(refname, "refs/heads/", &shortname))
286 return 0;
288 strbuf_add(&pattern, cond, cond_len);
289 add_trailing_starstar_for_dir(&pattern);
290 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
291 strbuf_release(&pattern);
292 return ret;
295 static int include_condition_is_true(const struct config_options *opts,
296 const char *cond, size_t cond_len)
299 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
300 return include_by_gitdir(opts, cond, cond_len, 0);
301 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
302 return include_by_gitdir(opts, cond, cond_len, 1);
303 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
304 return include_by_branch(cond, cond_len);
306 /* unknown conditionals are always false */
307 return 0;
310 int git_config_include(const char *var, const char *value, void *data)
312 struct config_include_data *inc = data;
313 const char *cond, *key;
314 size_t cond_len;
315 int ret;
318 * Pass along all values, including "include" directives; this makes it
319 * possible to query information on the includes themselves.
321 ret = inc->fn(var, value, inc->data);
322 if (ret < 0)
323 return ret;
325 if (!strcmp(var, "include.path"))
326 ret = handle_path_include(value, inc);
328 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
329 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
330 !strcmp(key, "path"))
331 ret = handle_path_include(value, inc);
333 return ret;
336 static void git_config_push_split_parameter(const char *key, const char *value)
338 struct strbuf env = STRBUF_INIT;
339 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
340 if (old && *old) {
341 strbuf_addstr(&env, old);
342 strbuf_addch(&env, ' ');
344 sq_quote_buf(&env, key);
345 strbuf_addch(&env, '=');
346 if (value)
347 sq_quote_buf(&env, value);
348 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
349 strbuf_release(&env);
352 void git_config_push_parameter(const char *text)
354 const char *value;
357 * When we see:
359 * section.subsection=with=equals.key=value
361 * we cannot tell if it means:
363 * [section "subsection=with=equals"]
364 * key = value
366 * or:
368 * [section]
369 * subsection = with=equals.key=value
371 * We parse left-to-right for the first "=", meaning we'll prefer to
372 * keep the value intact over the subsection. This is historical, but
373 * also sensible since values are more likely to contain odd or
374 * untrusted input than a section name.
376 * A missing equals is explicitly allowed (as a bool-only entry).
378 value = strchr(text, '=');
379 if (value) {
380 char *key = xmemdupz(text, value - text);
381 git_config_push_split_parameter(key, value + 1);
382 free(key);
383 } else {
384 git_config_push_split_parameter(text, NULL);
388 void git_config_push_env(const char *spec)
390 char *key;
391 const char *env_name;
392 const char *env_value;
394 env_name = strrchr(spec, '=');
395 if (!env_name)
396 die(_("invalid config format: %s"), spec);
397 key = xmemdupz(spec, env_name - spec);
398 env_name++;
399 if (!*env_name)
400 die(_("missing environment variable name for configuration '%.*s'"),
401 (int)(env_name - spec - 1), spec);
403 env_value = getenv(env_name);
404 if (!env_value)
405 die(_("missing environment variable '%s' for configuration '%.*s'"),
406 env_name, (int)(env_name - spec - 1), spec);
408 git_config_push_split_parameter(key, env_value);
409 free(key);
412 static inline int iskeychar(int c)
414 return isalnum(c) || c == '-';
418 * Auxiliary function to sanity-check and split the key into the section
419 * identifier and variable name.
421 * Returns 0 on success, -1 when there is an invalid character in the key and
422 * -2 if there is no section name in the key.
424 * store_key - pointer to char* which will hold a copy of the key with
425 * lowercase section and variable name
426 * baselen - pointer to size_t which will hold the length of the
427 * section + subsection part, can be NULL
429 static int git_config_parse_key_1(const char *key, char **store_key, size_t *baselen_, int quiet)
431 size_t i, baselen;
432 int dot;
433 const char *last_dot = strrchr(key, '.');
436 * Since "key" actually contains the section name and the real
437 * key name separated by a dot, we have to know where the dot is.
440 if (last_dot == NULL || last_dot == key) {
441 if (!quiet)
442 error(_("key does not contain a section: %s"), key);
443 return -CONFIG_NO_SECTION_OR_NAME;
446 if (!last_dot[1]) {
447 if (!quiet)
448 error(_("key does not contain variable name: %s"), key);
449 return -CONFIG_NO_SECTION_OR_NAME;
452 baselen = last_dot - key;
453 if (baselen_)
454 *baselen_ = baselen;
457 * Validate the key and while at it, lower case it for matching.
459 if (store_key)
460 *store_key = xmallocz(strlen(key));
462 dot = 0;
463 for (i = 0; key[i]; i++) {
464 unsigned char c = key[i];
465 if (c == '.')
466 dot = 1;
467 /* Leave the extended basename untouched.. */
468 if (!dot || i > baselen) {
469 if (!iskeychar(c) ||
470 (i == baselen + 1 && !isalpha(c))) {
471 if (!quiet)
472 error(_("invalid key: %s"), key);
473 goto out_free_ret_1;
475 c = tolower(c);
476 } else if (c == '\n') {
477 if (!quiet)
478 error(_("invalid key (newline): %s"), key);
479 goto out_free_ret_1;
481 if (store_key)
482 (*store_key)[i] = c;
485 return 0;
487 out_free_ret_1:
488 if (store_key) {
489 FREE_AND_NULL(*store_key);
491 return -CONFIG_INVALID_KEY;
494 int git_config_parse_key(const char *key, char **store_key, size_t *baselen)
496 return git_config_parse_key_1(key, store_key, baselen, 0);
499 int git_config_key_is_valid(const char *key)
501 return !git_config_parse_key_1(key, NULL, NULL, 1);
504 static int config_parse_pair(const char *key, const char *value,
505 config_fn_t fn, void *data)
507 char *canonical_name;
508 int ret;
510 if (!strlen(key))
511 return error(_("empty config key"));
512 if (git_config_parse_key(key, &canonical_name, NULL))
513 return -1;
515 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
516 free(canonical_name);
517 return ret;
520 int git_config_parse_parameter(const char *text,
521 config_fn_t fn, void *data)
523 const char *value;
524 struct strbuf **pair;
525 int ret;
527 pair = strbuf_split_str(text, '=', 2);
528 if (!pair[0])
529 return error(_("bogus config parameter: %s"), text);
531 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
532 strbuf_setlen(pair[0], pair[0]->len - 1);
533 value = pair[1] ? pair[1]->buf : "";
534 } else {
535 value = NULL;
538 strbuf_trim(pair[0]);
539 if (!pair[0]->len) {
540 strbuf_list_free(pair);
541 return error(_("bogus config parameter: %s"), text);
544 ret = config_parse_pair(pair[0]->buf, value, fn, data);
545 strbuf_list_free(pair);
546 return ret;
549 static int parse_config_env_list(char *env, config_fn_t fn, void *data)
551 char *cur = env;
552 while (cur && *cur) {
553 const char *key = sq_dequote_step(cur, &cur);
554 if (!key)
555 return error(_("bogus format in %s"),
556 CONFIG_DATA_ENVIRONMENT);
558 if (!cur || isspace(*cur)) {
559 /* old-style 'key=value' */
560 if (git_config_parse_parameter(key, fn, data) < 0)
561 return -1;
563 else if (*cur == '=') {
564 /* new-style 'key'='value' */
565 const char *value;
567 cur++;
568 if (*cur == '\'') {
569 /* quoted value */
570 value = sq_dequote_step(cur, &cur);
571 if (!value || (cur && !isspace(*cur))) {
572 return error(_("bogus format in %s"),
573 CONFIG_DATA_ENVIRONMENT);
575 } else if (!*cur || isspace(*cur)) {
576 /* implicit bool: 'key'= */
577 value = NULL;
578 } else {
579 return error(_("bogus format in %s"),
580 CONFIG_DATA_ENVIRONMENT);
583 if (config_parse_pair(key, value, fn, data) < 0)
584 return -1;
586 else {
587 /* unknown format */
588 return error(_("bogus format in %s"),
589 CONFIG_DATA_ENVIRONMENT);
592 if (cur) {
593 while (isspace(*cur))
594 cur++;
597 return 0;
600 int git_config_from_parameters(config_fn_t fn, void *data)
602 const char *env;
603 struct strbuf envvar = STRBUF_INIT;
604 struct strvec to_free = STRVEC_INIT;
605 int ret = 0;
606 char *envw = NULL;
607 struct config_source source;
609 memset(&source, 0, sizeof(source));
610 source.prev = cf;
611 source.origin_type = CONFIG_ORIGIN_CMDLINE;
612 cf = &source;
614 env = getenv(CONFIG_COUNT_ENVIRONMENT);
615 if (env) {
616 unsigned long count;
617 char *endp;
618 int i;
620 count = strtoul(env, &endp, 10);
621 if (*endp) {
622 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
623 goto out;
625 if (count > INT_MAX) {
626 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
627 goto out;
630 for (i = 0; i < count; i++) {
631 const char *key, *value;
633 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
634 key = getenv_safe(&to_free, envvar.buf);
635 if (!key) {
636 ret = error(_("missing config key %s"), envvar.buf);
637 goto out;
639 strbuf_reset(&envvar);
641 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
642 value = getenv_safe(&to_free, envvar.buf);
643 if (!value) {
644 ret = error(_("missing config value %s"), envvar.buf);
645 goto out;
647 strbuf_reset(&envvar);
649 if (config_parse_pair(key, value, fn, data) < 0) {
650 ret = -1;
651 goto out;
656 env = getenv(CONFIG_DATA_ENVIRONMENT);
657 if (env) {
658 /* sq_dequote will write over it */
659 envw = xstrdup(env);
660 if (parse_config_env_list(envw, fn, data) < 0) {
661 ret = -1;
662 goto out;
666 out:
667 strbuf_release(&envvar);
668 strvec_clear(&to_free);
669 free(envw);
670 cf = source.prev;
671 return ret;
674 static int get_next_char(void)
676 int c = cf->do_fgetc(cf);
678 if (c == '\r') {
679 /* DOS like systems */
680 c = cf->do_fgetc(cf);
681 if (c != '\n') {
682 if (c != EOF)
683 cf->do_ungetc(c, cf);
684 c = '\r';
688 if (c != EOF && ++cf->total_len > INT_MAX) {
690 * This is an absurdly long config file; refuse to parse
691 * further in order to protect downstream code from integer
692 * overflows. Note that we can't return an error specifically,
693 * but we can mark EOF and put trash in the return value,
694 * which will trigger a parse error.
696 cf->eof = 1;
697 return 0;
700 if (c == '\n')
701 cf->linenr++;
702 if (c == EOF) {
703 cf->eof = 1;
704 cf->linenr++;
705 c = '\n';
707 return c;
710 static char *parse_value(void)
712 int quote = 0, comment = 0, space = 0;
714 strbuf_reset(&cf->value);
715 for (;;) {
716 int c = get_next_char();
717 if (c == '\n') {
718 if (quote) {
719 cf->linenr--;
720 return NULL;
722 return cf->value.buf;
724 if (comment)
725 continue;
726 if (isspace(c) && !quote) {
727 if (cf->value.len)
728 space++;
729 continue;
731 if (!quote) {
732 if (c == ';' || c == '#') {
733 comment = 1;
734 continue;
737 for (; space; space--)
738 strbuf_addch(&cf->value, ' ');
739 if (c == '\\') {
740 c = get_next_char();
741 switch (c) {
742 case '\n':
743 continue;
744 case 't':
745 c = '\t';
746 break;
747 case 'b':
748 c = '\b';
749 break;
750 case 'n':
751 c = '\n';
752 break;
753 /* Some characters escape as themselves */
754 case '\\': case '"':
755 break;
756 /* Reject unknown escape sequences */
757 default:
758 return NULL;
760 strbuf_addch(&cf->value, c);
761 continue;
763 if (c == '"') {
764 quote = 1-quote;
765 continue;
767 strbuf_addch(&cf->value, c);
771 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
773 int c;
774 char *value;
775 int ret;
777 /* Get the full name */
778 for (;;) {
779 c = get_next_char();
780 if (cf->eof)
781 break;
782 if (!iskeychar(c))
783 break;
784 strbuf_addch(name, tolower(c));
787 while (c == ' ' || c == '\t')
788 c = get_next_char();
790 value = NULL;
791 if (c != '\n') {
792 if (c != '=')
793 return -1;
794 value = parse_value();
795 if (!value)
796 return -1;
799 * We already consumed the \n, but we need linenr to point to
800 * the line we just parsed during the call to fn to get
801 * accurate line number in error messages.
803 cf->linenr--;
804 ret = fn(name->buf, value, data);
805 if (ret >= 0)
806 cf->linenr++;
807 return ret;
810 static int get_extended_base_var(struct strbuf *name, int c)
812 cf->subsection_case_sensitive = 0;
813 do {
814 if (c == '\n')
815 goto error_incomplete_line;
816 c = get_next_char();
817 } while (isspace(c));
819 /* We require the format to be '[base "extension"]' */
820 if (c != '"')
821 return -1;
822 strbuf_addch(name, '.');
824 for (;;) {
825 int c = get_next_char();
826 if (c == '\n')
827 goto error_incomplete_line;
828 if (c == '"')
829 break;
830 if (c == '\\') {
831 c = get_next_char();
832 if (c == '\n')
833 goto error_incomplete_line;
835 strbuf_addch(name, c);
838 /* Final ']' */
839 if (get_next_char() != ']')
840 return -1;
841 return 0;
842 error_incomplete_line:
843 cf->linenr--;
844 return -1;
847 static int get_base_var(struct strbuf *name)
849 cf->subsection_case_sensitive = 1;
850 for (;;) {
851 int c = get_next_char();
852 if (cf->eof)
853 return -1;
854 if (c == ']')
855 return 0;
856 if (isspace(c))
857 return get_extended_base_var(name, c);
858 if (!iskeychar(c) && c != '.')
859 return -1;
860 strbuf_addch(name, tolower(c));
864 struct parse_event_data {
865 enum config_event_t previous_type;
866 size_t previous_offset;
867 const struct config_options *opts;
870 static int do_event(enum config_event_t type, struct parse_event_data *data)
872 size_t offset;
874 if (!data->opts || !data->opts->event_fn)
875 return 0;
877 if (type == CONFIG_EVENT_WHITESPACE &&
878 data->previous_type == type)
879 return 0;
881 offset = cf->do_ftell(cf);
883 * At EOF, the parser always "inserts" an extra '\n', therefore
884 * the end offset of the event is the current file position, otherwise
885 * we will already have advanced to the next event.
887 if (type != CONFIG_EVENT_EOF)
888 offset--;
890 if (data->previous_type != CONFIG_EVENT_EOF &&
891 data->opts->event_fn(data->previous_type, data->previous_offset,
892 offset, data->opts->event_fn_data) < 0)
893 return -1;
895 data->previous_type = type;
896 data->previous_offset = offset;
898 return 0;
901 static int git_parse_source(config_fn_t fn, void *data,
902 const struct config_options *opts)
904 int comment = 0;
905 size_t baselen = 0;
906 struct strbuf *var = &cf->var;
907 int error_return = 0;
908 char *error_msg = NULL;
910 /* U+FEFF Byte Order Mark in UTF8 */
911 const char *bomptr = utf8_bom;
913 /* For the parser event callback */
914 struct parse_event_data event_data = {
915 CONFIG_EVENT_EOF, 0, opts
918 for (;;) {
919 int c;
921 c = get_next_char();
922 if (bomptr && *bomptr) {
923 /* We are at the file beginning; skip UTF8-encoded BOM
924 * if present. Sane editors won't put this in on their
925 * own, but e.g. Windows Notepad will do it happily. */
926 if (c == (*bomptr & 0377)) {
927 bomptr++;
928 continue;
929 } else {
930 /* Do not tolerate partial BOM. */
931 if (bomptr != utf8_bom)
932 break;
933 /* No BOM at file beginning. Cool. */
934 bomptr = NULL;
937 if (c == '\n') {
938 if (cf->eof) {
939 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
940 return -1;
941 return 0;
943 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
944 return -1;
945 comment = 0;
946 continue;
948 if (comment)
949 continue;
950 if (isspace(c)) {
951 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
952 return -1;
953 continue;
955 if (c == '#' || c == ';') {
956 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
957 return -1;
958 comment = 1;
959 continue;
961 if (c == '[') {
962 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
963 return -1;
965 /* Reset prior to determining a new stem */
966 strbuf_reset(var);
967 if (get_base_var(var) < 0 || var->len < 1)
968 break;
969 strbuf_addch(var, '.');
970 baselen = var->len;
971 continue;
973 if (!isalpha(c))
974 break;
976 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
977 return -1;
980 * Truncate the var name back to the section header
981 * stem prior to grabbing the suffix part of the name
982 * and the value.
984 strbuf_setlen(var, baselen);
985 strbuf_addch(var, tolower(c));
986 if (get_value(fn, data, var) < 0)
987 break;
990 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
991 return -1;
993 switch (cf->origin_type) {
994 case CONFIG_ORIGIN_BLOB:
995 error_msg = xstrfmt(_("bad config line %d in blob %s"),
996 cf->linenr, cf->name);
997 break;
998 case CONFIG_ORIGIN_FILE:
999 error_msg = xstrfmt(_("bad config line %d in file %s"),
1000 cf->linenr, cf->name);
1001 break;
1002 case CONFIG_ORIGIN_STDIN:
1003 error_msg = xstrfmt(_("bad config line %d in standard input"),
1004 cf->linenr);
1005 break;
1006 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1007 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1008 cf->linenr, cf->name);
1009 break;
1010 case CONFIG_ORIGIN_CMDLINE:
1011 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1012 cf->linenr, cf->name);
1013 break;
1014 default:
1015 error_msg = xstrfmt(_("bad config line %d in %s"),
1016 cf->linenr, cf->name);
1019 switch (opts && opts->error_action ?
1020 opts->error_action :
1021 cf->default_error_action) {
1022 case CONFIG_ERROR_DIE:
1023 die("%s", error_msg);
1024 break;
1025 case CONFIG_ERROR_ERROR:
1026 error_return = error("%s", error_msg);
1027 break;
1028 case CONFIG_ERROR_SILENT:
1029 error_return = -1;
1030 break;
1031 case CONFIG_ERROR_UNSET:
1032 BUG("config error action unset");
1035 free(error_msg);
1036 return error_return;
1039 static uintmax_t get_unit_factor(const char *end)
1041 if (!*end)
1042 return 1;
1043 else if (!strcasecmp(end, "k"))
1044 return 1024;
1045 else if (!strcasecmp(end, "m"))
1046 return 1024 * 1024;
1047 else if (!strcasecmp(end, "g"))
1048 return 1024 * 1024 * 1024;
1049 return 0;
1052 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1054 if (value && *value) {
1055 char *end;
1056 intmax_t val;
1057 uintmax_t uval;
1058 uintmax_t factor;
1060 errno = 0;
1061 val = strtoimax(value, &end, 0);
1062 if (errno == ERANGE)
1063 return 0;
1064 factor = get_unit_factor(end);
1065 if (!factor) {
1066 errno = EINVAL;
1067 return 0;
1069 uval = val < 0 ? -val : val;
1070 if (unsigned_mult_overflows(factor, uval) ||
1071 factor * uval > max) {
1072 errno = ERANGE;
1073 return 0;
1075 val *= factor;
1076 *ret = val;
1077 return 1;
1079 errno = EINVAL;
1080 return 0;
1083 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1085 if (value && *value) {
1086 char *end;
1087 uintmax_t val;
1088 uintmax_t factor;
1090 errno = 0;
1091 val = strtoumax(value, &end, 0);
1092 if (errno == ERANGE)
1093 return 0;
1094 factor = get_unit_factor(end);
1095 if (!factor) {
1096 errno = EINVAL;
1097 return 0;
1099 if (unsigned_mult_overflows(factor, val) ||
1100 factor * val > max) {
1101 errno = ERANGE;
1102 return 0;
1104 val *= factor;
1105 *ret = val;
1106 return 1;
1108 errno = EINVAL;
1109 return 0;
1112 static int git_parse_int(const char *value, int *ret)
1114 intmax_t tmp;
1115 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1116 return 0;
1117 *ret = tmp;
1118 return 1;
1121 static int git_parse_int64(const char *value, int64_t *ret)
1123 intmax_t tmp;
1124 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1125 return 0;
1126 *ret = tmp;
1127 return 1;
1130 int git_parse_ulong(const char *value, unsigned long *ret)
1132 uintmax_t tmp;
1133 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1134 return 0;
1135 *ret = tmp;
1136 return 1;
1139 int git_parse_ssize_t(const char *value, ssize_t *ret)
1141 intmax_t tmp;
1142 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1143 return 0;
1144 *ret = tmp;
1145 return 1;
1148 NORETURN
1149 static void die_bad_number(const char *name, const char *value)
1151 const char *error_type = (errno == ERANGE) ?
1152 N_("out of range") : N_("invalid unit");
1153 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1155 if (!value)
1156 value = "";
1158 if (!(cf && cf->name))
1159 die(_(bad_numeric), value, name, _(error_type));
1161 switch (cf->origin_type) {
1162 case CONFIG_ORIGIN_BLOB:
1163 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1164 value, name, cf->name, _(error_type));
1165 case CONFIG_ORIGIN_FILE:
1166 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1167 value, name, cf->name, _(error_type));
1168 case CONFIG_ORIGIN_STDIN:
1169 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1170 value, name, _(error_type));
1171 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1172 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1173 value, name, cf->name, _(error_type));
1174 case CONFIG_ORIGIN_CMDLINE:
1175 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1176 value, name, cf->name, _(error_type));
1177 default:
1178 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1179 value, name, cf->name, _(error_type));
1183 int git_config_int(const char *name, const char *value)
1185 int ret;
1186 if (!git_parse_int(value, &ret))
1187 die_bad_number(name, value);
1188 return ret;
1191 int64_t git_config_int64(const char *name, const char *value)
1193 int64_t ret;
1194 if (!git_parse_int64(value, &ret))
1195 die_bad_number(name, value);
1196 return ret;
1199 unsigned long git_config_ulong(const char *name, const char *value)
1201 unsigned long ret;
1202 if (!git_parse_ulong(value, &ret))
1203 die_bad_number(name, value);
1204 return ret;
1207 ssize_t git_config_ssize_t(const char *name, const char *value)
1209 ssize_t ret;
1210 if (!git_parse_ssize_t(value, &ret))
1211 die_bad_number(name, value);
1212 return ret;
1215 static int git_parse_maybe_bool_text(const char *value)
1217 if (!value)
1218 return 1;
1219 if (!*value)
1220 return 0;
1221 if (!strcasecmp(value, "true")
1222 || !strcasecmp(value, "yes")
1223 || !strcasecmp(value, "on"))
1224 return 1;
1225 if (!strcasecmp(value, "false")
1226 || !strcasecmp(value, "no")
1227 || !strcasecmp(value, "off"))
1228 return 0;
1229 return -1;
1232 int git_parse_maybe_bool(const char *value)
1234 int v = git_parse_maybe_bool_text(value);
1235 if (0 <= v)
1236 return v;
1237 if (git_parse_int(value, &v))
1238 return !!v;
1239 return -1;
1242 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1244 int v = git_parse_maybe_bool_text(value);
1245 if (0 <= v) {
1246 *is_bool = 1;
1247 return v;
1249 *is_bool = 0;
1250 return git_config_int(name, value);
1253 int git_config_bool(const char *name, const char *value)
1255 int v = git_parse_maybe_bool(value);
1256 if (v < 0)
1257 die(_("bad boolean config value '%s' for '%s'"), value, name);
1258 return v;
1261 int git_config_string(const char **dest, const char *var, const char *value)
1263 if (!value)
1264 return config_error_nonbool(var);
1265 *dest = xstrdup(value);
1266 return 0;
1269 int git_config_pathname(const char **dest, const char *var, const char *value)
1271 if (!value)
1272 return config_error_nonbool(var);
1273 *dest = expand_user_path(value, 0);
1274 if (!*dest)
1275 die(_("failed to expand user dir in: '%s'"), value);
1276 return 0;
1279 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1281 if (!value)
1282 return config_error_nonbool(var);
1283 if (parse_expiry_date(value, timestamp))
1284 return error(_("'%s' for '%s' is not a valid timestamp"),
1285 value, var);
1286 return 0;
1289 int git_config_color(char *dest, const char *var, const char *value)
1291 if (!value)
1292 return config_error_nonbool(var);
1293 if (color_parse(value, dest) < 0)
1294 return -1;
1295 return 0;
1298 static int git_default_core_config(const char *var, const char *value, void *cb)
1300 /* This needs a better name */
1301 if (!strcmp(var, "core.filemode")) {
1302 trust_executable_bit = git_config_bool(var, value);
1303 return 0;
1305 if (!strcmp(var, "core.trustctime")) {
1306 trust_ctime = git_config_bool(var, value);
1307 return 0;
1309 if (!strcmp(var, "core.checkstat")) {
1310 if (!strcasecmp(value, "default"))
1311 check_stat = 1;
1312 else if (!strcasecmp(value, "minimal"))
1313 check_stat = 0;
1316 if (!strcmp(var, "core.quotepath")) {
1317 quote_path_fully = git_config_bool(var, value);
1318 return 0;
1321 if (!strcmp(var, "core.symlinks")) {
1322 has_symlinks = git_config_bool(var, value);
1323 return 0;
1326 if (!strcmp(var, "core.ignorecase")) {
1327 ignore_case = git_config_bool(var, value);
1328 return 0;
1331 if (!strcmp(var, "core.attributesfile"))
1332 return git_config_pathname(&git_attributes_file, var, value);
1334 if (!strcmp(var, "core.hookspath"))
1335 return git_config_pathname(&git_hooks_path, var, value);
1337 if (!strcmp(var, "core.bare")) {
1338 is_bare_repository_cfg = git_config_bool(var, value);
1339 return 0;
1342 if (!strcmp(var, "core.ignorestat")) {
1343 assume_unchanged = git_config_bool(var, value);
1344 return 0;
1347 if (!strcmp(var, "core.prefersymlinkrefs")) {
1348 prefer_symlink_refs = git_config_bool(var, value);
1349 return 0;
1352 if (!strcmp(var, "core.logallrefupdates")) {
1353 if (value && !strcasecmp(value, "always"))
1354 log_all_ref_updates = LOG_REFS_ALWAYS;
1355 else if (git_config_bool(var, value))
1356 log_all_ref_updates = LOG_REFS_NORMAL;
1357 else
1358 log_all_ref_updates = LOG_REFS_NONE;
1359 return 0;
1362 if (!strcmp(var, "core.warnambiguousrefs")) {
1363 warn_ambiguous_refs = git_config_bool(var, value);
1364 return 0;
1367 if (!strcmp(var, "core.abbrev")) {
1368 if (!value)
1369 return config_error_nonbool(var);
1370 if (!strcasecmp(value, "auto"))
1371 default_abbrev = -1;
1372 else if (!git_parse_maybe_bool_text(value))
1373 default_abbrev = the_hash_algo->hexsz;
1374 else {
1375 int abbrev = git_config_int(var, value);
1376 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1377 return error(_("abbrev length out of range: %d"), abbrev);
1378 default_abbrev = abbrev;
1380 return 0;
1383 if (!strcmp(var, "core.disambiguate"))
1384 return set_disambiguate_hint_config(var, value);
1386 if (!strcmp(var, "core.loosecompression")) {
1387 int level = git_config_int(var, value);
1388 if (level == -1)
1389 level = Z_DEFAULT_COMPRESSION;
1390 else if (level < 0 || level > Z_BEST_COMPRESSION)
1391 die(_("bad zlib compression level %d"), level);
1392 zlib_compression_level = level;
1393 zlib_compression_seen = 1;
1394 return 0;
1397 if (!strcmp(var, "core.compression")) {
1398 int level = git_config_int(var, value);
1399 if (level == -1)
1400 level = Z_DEFAULT_COMPRESSION;
1401 else if (level < 0 || level > Z_BEST_COMPRESSION)
1402 die(_("bad zlib compression level %d"), level);
1403 core_compression_level = level;
1404 core_compression_seen = 1;
1405 if (!zlib_compression_seen)
1406 zlib_compression_level = level;
1407 if (!pack_compression_seen)
1408 pack_compression_level = level;
1409 return 0;
1412 if (!strcmp(var, "core.packedgitwindowsize")) {
1413 int pgsz_x2 = getpagesize() * 2;
1414 packed_git_window_size = git_config_ulong(var, value);
1416 /* This value must be multiple of (pagesize * 2) */
1417 packed_git_window_size /= pgsz_x2;
1418 if (packed_git_window_size < 1)
1419 packed_git_window_size = 1;
1420 packed_git_window_size *= pgsz_x2;
1421 return 0;
1424 if (!strcmp(var, "core.bigfilethreshold")) {
1425 big_file_threshold = git_config_ulong(var, value);
1426 return 0;
1429 if (!strcmp(var, "core.packedgitlimit")) {
1430 packed_git_limit = git_config_ulong(var, value);
1431 return 0;
1434 if (!strcmp(var, "core.deltabasecachelimit")) {
1435 delta_base_cache_limit = git_config_ulong(var, value);
1436 return 0;
1439 if (!strcmp(var, "core.autocrlf")) {
1440 if (value && !strcasecmp(value, "input")) {
1441 auto_crlf = AUTO_CRLF_INPUT;
1442 return 0;
1444 auto_crlf = git_config_bool(var, value);
1445 return 0;
1448 if (!strcmp(var, "core.safecrlf")) {
1449 int eol_rndtrp_die;
1450 if (value && !strcasecmp(value, "warn")) {
1451 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1452 return 0;
1454 eol_rndtrp_die = git_config_bool(var, value);
1455 global_conv_flags_eol = eol_rndtrp_die ?
1456 CONV_EOL_RNDTRP_DIE : 0;
1457 return 0;
1460 if (!strcmp(var, "core.eol")) {
1461 if (value && !strcasecmp(value, "lf"))
1462 core_eol = EOL_LF;
1463 else if (value && !strcasecmp(value, "crlf"))
1464 core_eol = EOL_CRLF;
1465 else if (value && !strcasecmp(value, "native"))
1466 core_eol = EOL_NATIVE;
1467 else
1468 core_eol = EOL_UNSET;
1469 return 0;
1472 if (!strcmp(var, "core.checkroundtripencoding")) {
1473 check_roundtrip_encoding = xstrdup(value);
1474 return 0;
1477 if (!strcmp(var, "core.notesref")) {
1478 notes_ref_name = xstrdup(value);
1479 return 0;
1482 if (!strcmp(var, "core.editor"))
1483 return git_config_string(&editor_program, var, value);
1485 if (!strcmp(var, "core.commentchar")) {
1486 if (!value)
1487 return config_error_nonbool(var);
1488 else if (!strcasecmp(value, "auto"))
1489 auto_comment_line_char = 1;
1490 else if (value[0] && !value[1]) {
1491 comment_line_char = value[0];
1492 auto_comment_line_char = 0;
1493 } else
1494 return error(_("core.commentChar should only be one character"));
1495 return 0;
1498 if (!strcmp(var, "core.askpass"))
1499 return git_config_string(&askpass_program, var, value);
1501 if (!strcmp(var, "core.excludesfile"))
1502 return git_config_pathname(&excludes_file, var, value);
1504 if (!strcmp(var, "core.whitespace")) {
1505 if (!value)
1506 return config_error_nonbool(var);
1507 whitespace_rule_cfg = parse_whitespace_rule(value);
1508 return 0;
1511 if (!strcmp(var, "core.fsyncobjectfiles")) {
1512 fsync_object_files = git_config_bool(var, value);
1513 return 0;
1516 if (!strcmp(var, "core.preloadindex")) {
1517 core_preload_index = git_config_bool(var, value);
1518 return 0;
1521 if (!strcmp(var, "core.createobject")) {
1522 if (!strcmp(value, "rename"))
1523 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1524 else if (!strcmp(value, "link"))
1525 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1526 else
1527 die(_("invalid mode for object creation: %s"), value);
1528 return 0;
1531 if (!strcmp(var, "core.sparsecheckout")) {
1532 core_apply_sparse_checkout = git_config_bool(var, value);
1533 return 0;
1536 if (!strcmp(var, "core.sparsecheckoutcone")) {
1537 core_sparse_checkout_cone = git_config_bool(var, value);
1538 return 0;
1541 if (!strcmp(var, "core.precomposeunicode")) {
1542 precomposed_unicode = git_config_bool(var, value);
1543 return 0;
1546 if (!strcmp(var, "core.protecthfs")) {
1547 protect_hfs = git_config_bool(var, value);
1548 return 0;
1551 if (!strcmp(var, "core.protectntfs")) {
1552 protect_ntfs = git_config_bool(var, value);
1553 return 0;
1556 if (!strcmp(var, "core.usereplacerefs")) {
1557 read_replace_refs = git_config_bool(var, value);
1558 return 0;
1561 /* Add other config variables here and to Documentation/config.txt. */
1562 return platform_core_config(var, value, cb);
1565 static int git_default_i18n_config(const char *var, const char *value)
1567 if (!strcmp(var, "i18n.commitencoding"))
1568 return git_config_string(&git_commit_encoding, var, value);
1570 if (!strcmp(var, "i18n.logoutputencoding"))
1571 return git_config_string(&git_log_output_encoding, var, value);
1573 /* Add other config variables here and to Documentation/config.txt. */
1574 return 0;
1577 static int git_default_branch_config(const char *var, const char *value)
1579 if (!strcmp(var, "branch.autosetupmerge")) {
1580 if (value && !strcasecmp(value, "always")) {
1581 git_branch_track = BRANCH_TRACK_ALWAYS;
1582 return 0;
1584 git_branch_track = git_config_bool(var, value);
1585 return 0;
1587 if (!strcmp(var, "branch.autosetuprebase")) {
1588 if (!value)
1589 return config_error_nonbool(var);
1590 else if (!strcmp(value, "never"))
1591 autorebase = AUTOREBASE_NEVER;
1592 else if (!strcmp(value, "local"))
1593 autorebase = AUTOREBASE_LOCAL;
1594 else if (!strcmp(value, "remote"))
1595 autorebase = AUTOREBASE_REMOTE;
1596 else if (!strcmp(value, "always"))
1597 autorebase = AUTOREBASE_ALWAYS;
1598 else
1599 return error(_("malformed value for %s"), var);
1600 return 0;
1603 /* Add other config variables here and to Documentation/config.txt. */
1604 return 0;
1607 static int git_default_push_config(const char *var, const char *value)
1609 if (!strcmp(var, "push.default")) {
1610 if (!value)
1611 return config_error_nonbool(var);
1612 else if (!strcmp(value, "nothing"))
1613 push_default = PUSH_DEFAULT_NOTHING;
1614 else if (!strcmp(value, "matching"))
1615 push_default = PUSH_DEFAULT_MATCHING;
1616 else if (!strcmp(value, "simple"))
1617 push_default = PUSH_DEFAULT_SIMPLE;
1618 else if (!strcmp(value, "upstream"))
1619 push_default = PUSH_DEFAULT_UPSTREAM;
1620 else if (!strcmp(value, "tracking")) /* deprecated */
1621 push_default = PUSH_DEFAULT_UPSTREAM;
1622 else if (!strcmp(value, "current"))
1623 push_default = PUSH_DEFAULT_CURRENT;
1624 else {
1625 error(_("malformed value for %s: %s"), var, value);
1626 return error(_("must be one of nothing, matching, simple, "
1627 "upstream or current"));
1629 return 0;
1632 /* Add other config variables here and to Documentation/config.txt. */
1633 return 0;
1636 static int git_default_mailmap_config(const char *var, const char *value)
1638 if (!strcmp(var, "mailmap.file"))
1639 return git_config_pathname(&git_mailmap_file, var, value);
1640 if (!strcmp(var, "mailmap.blob"))
1641 return git_config_string(&git_mailmap_blob, var, value);
1643 /* Add other config variables here and to Documentation/config.txt. */
1644 return 0;
1647 int git_default_config(const char *var, const char *value, void *cb)
1649 if (starts_with(var, "core."))
1650 return git_default_core_config(var, value, cb);
1652 if (starts_with(var, "user.") ||
1653 starts_with(var, "author.") ||
1654 starts_with(var, "committer."))
1655 return git_ident_config(var, value, cb);
1657 if (starts_with(var, "i18n."))
1658 return git_default_i18n_config(var, value);
1660 if (starts_with(var, "branch."))
1661 return git_default_branch_config(var, value);
1663 if (starts_with(var, "push."))
1664 return git_default_push_config(var, value);
1666 if (starts_with(var, "mailmap."))
1667 return git_default_mailmap_config(var, value);
1669 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1670 return git_default_advice_config(var, value);
1672 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1673 pager_use_color = git_config_bool(var,value);
1674 return 0;
1677 if (!strcmp(var, "pack.packsizelimit")) {
1678 pack_size_limit_cfg = git_config_ulong(var, value);
1679 return 0;
1682 if (!strcmp(var, "pack.compression")) {
1683 int level = git_config_int(var, value);
1684 if (level == -1)
1685 level = Z_DEFAULT_COMPRESSION;
1686 else if (level < 0 || level > Z_BEST_COMPRESSION)
1687 die(_("bad pack compression level %d"), level);
1688 pack_compression_level = level;
1689 pack_compression_seen = 1;
1690 return 0;
1693 /* Add other config variables here and to Documentation/config.txt. */
1694 return 0;
1698 * All source specific fields in the union, die_on_error, name and the callbacks
1699 * fgetc, ungetc, ftell of top need to be initialized before calling
1700 * this function.
1702 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1703 const struct config_options *opts)
1705 int ret;
1707 /* push config-file parsing state stack */
1708 top->prev = cf;
1709 top->linenr = 1;
1710 top->eof = 0;
1711 top->total_len = 0;
1712 strbuf_init(&top->value, 1024);
1713 strbuf_init(&top->var, 1024);
1714 cf = top;
1716 ret = git_parse_source(fn, data, opts);
1718 /* pop config-file parsing state stack */
1719 strbuf_release(&top->value);
1720 strbuf_release(&top->var);
1721 cf = top->prev;
1723 return ret;
1726 static int do_config_from_file(config_fn_t fn,
1727 const enum config_origin_type origin_type,
1728 const char *name, const char *path, FILE *f,
1729 void *data, const struct config_options *opts)
1731 struct config_source top;
1732 int ret;
1734 top.u.file = f;
1735 top.origin_type = origin_type;
1736 top.name = name;
1737 top.path = path;
1738 top.default_error_action = CONFIG_ERROR_DIE;
1739 top.do_fgetc = config_file_fgetc;
1740 top.do_ungetc = config_file_ungetc;
1741 top.do_ftell = config_file_ftell;
1743 flockfile(f);
1744 ret = do_config_from(&top, fn, data, opts);
1745 funlockfile(f);
1746 return ret;
1749 static int git_config_from_stdin(config_fn_t fn, void *data)
1751 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1752 data, NULL);
1755 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1756 void *data,
1757 const struct config_options *opts)
1759 int ret = -1;
1760 FILE *f;
1762 f = fopen_or_warn(filename, "r");
1763 if (f) {
1764 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1765 filename, f, data, opts);
1766 fclose(f);
1768 return ret;
1771 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1773 return git_config_from_file_with_options(fn, filename, data, NULL);
1776 int git_config_from_mem(config_fn_t fn,
1777 const enum config_origin_type origin_type,
1778 const char *name, const char *buf, size_t len,
1779 void *data, const struct config_options *opts)
1781 struct config_source top;
1783 top.u.buf.buf = buf;
1784 top.u.buf.len = len;
1785 top.u.buf.pos = 0;
1786 top.origin_type = origin_type;
1787 top.name = name;
1788 top.path = NULL;
1789 top.default_error_action = CONFIG_ERROR_ERROR;
1790 top.do_fgetc = config_buf_fgetc;
1791 top.do_ungetc = config_buf_ungetc;
1792 top.do_ftell = config_buf_ftell;
1794 return do_config_from(&top, fn, data, opts);
1797 int git_config_from_blob_oid(config_fn_t fn,
1798 const char *name,
1799 const struct object_id *oid,
1800 void *data)
1802 enum object_type type;
1803 char *buf;
1804 unsigned long size;
1805 int ret;
1807 buf = read_object_file(oid, &type, &size);
1808 if (!buf)
1809 return error(_("unable to load config blob object '%s'"), name);
1810 if (type != OBJ_BLOB) {
1811 free(buf);
1812 return error(_("reference '%s' does not point to a blob"), name);
1815 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1816 data, NULL);
1817 free(buf);
1819 return ret;
1822 static int git_config_from_blob_ref(config_fn_t fn,
1823 const char *name,
1824 void *data)
1826 struct object_id oid;
1828 if (get_oid(name, &oid) < 0)
1829 return error(_("unable to resolve config blob '%s'"), name);
1830 return git_config_from_blob_oid(fn, name, &oid, data);
1833 char *git_system_config(void)
1835 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1836 if (system_config)
1837 return system_config;
1838 return system_path(ETC_GITCONFIG);
1841 void git_global_config(char **user_out, char **xdg_out)
1843 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1844 char *xdg_config = NULL;
1846 if (!user_config) {
1847 user_config = expand_user_path("~/.gitconfig", 0);
1848 xdg_config = xdg_config_home("config");
1851 *user_out = user_config;
1852 *xdg_out = xdg_config;
1856 * Parse environment variable 'k' as a boolean (in various
1857 * possible spellings); if missing, use the default value 'def'.
1859 int git_env_bool(const char *k, int def)
1861 const char *v = getenv(k);
1862 return v ? git_config_bool(k, v) : def;
1866 * Parse environment variable 'k' as ulong with possibly a unit
1867 * suffix; if missing, use the default value 'val'.
1869 unsigned long git_env_ulong(const char *k, unsigned long val)
1871 const char *v = getenv(k);
1872 if (v && !git_parse_ulong(v, &val))
1873 die(_("failed to parse %s"), k);
1874 return val;
1877 int git_config_system(void)
1879 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1882 static int do_git_config_sequence(const struct config_options *opts,
1883 config_fn_t fn, void *data)
1885 int ret = 0;
1886 char *system_config = git_system_config();
1887 char *xdg_config = NULL;
1888 char *user_config = NULL;
1889 char *repo_config;
1890 enum config_scope prev_parsing_scope = current_parsing_scope;
1892 if (opts->commondir)
1893 repo_config = mkpathdup("%s/config", opts->commondir);
1894 else if (opts->git_dir)
1895 BUG("git_dir without commondir");
1896 else
1897 repo_config = NULL;
1899 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1900 if (git_config_system() && system_config &&
1901 !access_or_die(system_config, R_OK,
1902 opts->system_gently ? ACCESS_EACCES_OK : 0))
1903 ret += git_config_from_file(fn, system_config, data);
1905 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1906 git_global_config(&user_config, &xdg_config);
1908 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1909 ret += git_config_from_file(fn, xdg_config, data);
1911 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1912 ret += git_config_from_file(fn, user_config, data);
1914 current_parsing_scope = CONFIG_SCOPE_LOCAL;
1915 if (!opts->ignore_repo && repo_config &&
1916 !access_or_die(repo_config, R_OK, 0))
1917 ret += git_config_from_file(fn, repo_config, data);
1919 current_parsing_scope = CONFIG_SCOPE_WORKTREE;
1920 if (!opts->ignore_worktree && repository_format_worktree_config) {
1921 char *path = git_pathdup("config.worktree");
1922 if (!access_or_die(path, R_OK, 0))
1923 ret += git_config_from_file(fn, path, data);
1924 free(path);
1927 current_parsing_scope = CONFIG_SCOPE_COMMAND;
1928 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
1929 die(_("unable to parse command-line config"));
1931 current_parsing_scope = prev_parsing_scope;
1932 free(system_config);
1933 free(xdg_config);
1934 free(user_config);
1935 free(repo_config);
1936 return ret;
1939 int config_with_options(config_fn_t fn, void *data,
1940 struct git_config_source *config_source,
1941 const struct config_options *opts)
1943 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1945 if (opts->respect_includes) {
1946 inc.fn = fn;
1947 inc.data = data;
1948 inc.opts = opts;
1949 fn = git_config_include;
1950 data = &inc;
1953 if (config_source)
1954 current_parsing_scope = config_source->scope;
1957 * If we have a specific filename, use it. Otherwise, follow the
1958 * regular lookup sequence.
1960 if (config_source && config_source->use_stdin)
1961 return git_config_from_stdin(fn, data);
1962 else if (config_source && config_source->file)
1963 return git_config_from_file(fn, config_source->file, data);
1964 else if (config_source && config_source->blob)
1965 return git_config_from_blob_ref(fn, config_source->blob, data);
1967 return do_git_config_sequence(opts, fn, data);
1970 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1972 int i, value_index;
1973 struct string_list *values;
1974 struct config_set_element *entry;
1975 struct configset_list *list = &cs->list;
1977 for (i = 0; i < list->nr; i++) {
1978 entry = list->items[i].e;
1979 value_index = list->items[i].value_index;
1980 values = &entry->value_list;
1982 current_config_kvi = values->items[value_index].util;
1984 if (fn(entry->key, values->items[value_index].string, data) < 0)
1985 git_die_config_linenr(entry->key,
1986 current_config_kvi->filename,
1987 current_config_kvi->linenr);
1989 current_config_kvi = NULL;
1993 void read_early_config(config_fn_t cb, void *data)
1995 struct config_options opts = {0};
1996 struct strbuf commondir = STRBUF_INIT;
1997 struct strbuf gitdir = STRBUF_INIT;
1999 opts.respect_includes = 1;
2001 if (have_git_dir()) {
2002 opts.commondir = get_git_common_dir();
2003 opts.git_dir = get_git_dir();
2005 * When setup_git_directory() was not yet asked to discover the
2006 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2007 * is any repository config we should use (but unlike
2008 * setup_git_directory_gently(), no global state is changed, most
2009 * notably, the current working directory is still the same after the
2010 * call).
2012 } else if (!discover_git_directory(&commondir, &gitdir)) {
2013 opts.commondir = commondir.buf;
2014 opts.git_dir = gitdir.buf;
2017 config_with_options(cb, data, NULL, &opts);
2019 strbuf_release(&commondir);
2020 strbuf_release(&gitdir);
2024 * Read config but only enumerate system and global settings.
2025 * Omit any repo-local, worktree-local, or command-line settings.
2027 void read_very_early_config(config_fn_t cb, void *data)
2029 struct config_options opts = { 0 };
2031 opts.respect_includes = 1;
2032 opts.ignore_repo = 1;
2033 opts.ignore_worktree = 1;
2034 opts.ignore_cmdline = 1;
2035 opts.system_gently = 1;
2037 config_with_options(cb, data, NULL, &opts);
2040 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
2042 struct config_set_element k;
2043 struct config_set_element *found_entry;
2044 char *normalized_key;
2046 * `key` may come from the user, so normalize it before using it
2047 * for querying entries from the hashmap.
2049 if (git_config_parse_key(key, &normalized_key, NULL))
2050 return NULL;
2052 hashmap_entry_init(&k.ent, strhash(normalized_key));
2053 k.key = normalized_key;
2054 found_entry = hashmap_get_entry(&cs->config_hash, &k, ent, NULL);
2055 free(normalized_key);
2056 return found_entry;
2059 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
2061 struct config_set_element *e;
2062 struct string_list_item *si;
2063 struct configset_list_item *l_item;
2064 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2066 e = configset_find_element(cs, key);
2068 * Since the keys are being fed by git_config*() callback mechanism, they
2069 * are already normalized. So simply add them without any further munging.
2071 if (!e) {
2072 e = xmalloc(sizeof(*e));
2073 hashmap_entry_init(&e->ent, strhash(key));
2074 e->key = xstrdup(key);
2075 string_list_init(&e->value_list, 1);
2076 hashmap_add(&cs->config_hash, &e->ent);
2078 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2080 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
2081 l_item = &cs->list.items[cs->list.nr++];
2082 l_item->e = e;
2083 l_item->value_index = e->value_list.nr - 1;
2085 if (!cf)
2086 BUG("configset_add_value has no source");
2087 if (cf->name) {
2088 kv_info->filename = strintern(cf->name);
2089 kv_info->linenr = cf->linenr;
2090 kv_info->origin_type = cf->origin_type;
2091 } else {
2092 /* for values read from `git_config_from_parameters()` */
2093 kv_info->filename = NULL;
2094 kv_info->linenr = -1;
2095 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
2097 kv_info->scope = current_parsing_scope;
2098 si->util = kv_info;
2100 return 0;
2103 static int config_set_element_cmp(const void *unused_cmp_data,
2104 const struct hashmap_entry *eptr,
2105 const struct hashmap_entry *entry_or_key,
2106 const void *unused_keydata)
2108 const struct config_set_element *e1, *e2;
2110 e1 = container_of(eptr, const struct config_set_element, ent);
2111 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2113 return strcmp(e1->key, e2->key);
2116 void git_configset_init(struct config_set *cs)
2118 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
2119 cs->hash_initialized = 1;
2120 cs->list.nr = 0;
2121 cs->list.alloc = 0;
2122 cs->list.items = NULL;
2125 void git_configset_clear(struct config_set *cs)
2127 struct config_set_element *entry;
2128 struct hashmap_iter iter;
2129 if (!cs->hash_initialized)
2130 return;
2132 hashmap_for_each_entry(&cs->config_hash, &iter, entry,
2133 ent /* member name */) {
2134 free(entry->key);
2135 string_list_clear(&entry->value_list, 1);
2137 hashmap_clear_and_free(&cs->config_hash, struct config_set_element, ent);
2138 cs->hash_initialized = 0;
2139 free(cs->list.items);
2140 cs->list.nr = 0;
2141 cs->list.alloc = 0;
2142 cs->list.items = NULL;
2145 static int config_set_callback(const char *key, const char *value, void *cb)
2147 struct config_set *cs = cb;
2148 configset_add_value(cs, key, value);
2149 return 0;
2152 int git_configset_add_file(struct config_set *cs, const char *filename)
2154 return git_config_from_file(config_set_callback, filename, cs);
2157 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
2159 const struct string_list *values = NULL;
2161 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2162 * queried key in the files of the configset, the value returned will be the last
2163 * value in the value list for that key.
2165 values = git_configset_get_value_multi(cs, key);
2167 if (!values)
2168 return 1;
2169 assert(values->nr > 0);
2170 *value = values->items[values->nr - 1].string;
2171 return 0;
2174 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
2176 struct config_set_element *e = configset_find_element(cs, key);
2177 return e ? &e->value_list : NULL;
2180 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
2182 const char *value;
2183 if (!git_configset_get_value(cs, key, &value))
2184 return git_config_string((const char **)dest, key, value);
2185 else
2186 return 1;
2189 int git_configset_get_string_tmp(struct config_set *cs, const char *key,
2190 const char **dest)
2192 const char *value;
2193 if (!git_configset_get_value(cs, key, &value)) {
2194 if (!value)
2195 return config_error_nonbool(key);
2196 *dest = value;
2197 return 0;
2198 } else {
2199 return 1;
2203 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
2205 const char *value;
2206 if (!git_configset_get_value(cs, key, &value)) {
2207 *dest = git_config_int(key, value);
2208 return 0;
2209 } else
2210 return 1;
2213 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
2215 const char *value;
2216 if (!git_configset_get_value(cs, key, &value)) {
2217 *dest = git_config_ulong(key, value);
2218 return 0;
2219 } else
2220 return 1;
2223 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
2225 const char *value;
2226 if (!git_configset_get_value(cs, key, &value)) {
2227 *dest = git_config_bool(key, value);
2228 return 0;
2229 } else
2230 return 1;
2233 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
2234 int *is_bool, int *dest)
2236 const char *value;
2237 if (!git_configset_get_value(cs, key, &value)) {
2238 *dest = git_config_bool_or_int(key, value, is_bool);
2239 return 0;
2240 } else
2241 return 1;
2244 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2246 const char *value;
2247 if (!git_configset_get_value(cs, key, &value)) {
2248 *dest = git_parse_maybe_bool(value);
2249 if (*dest == -1)
2250 return -1;
2251 return 0;
2252 } else
2253 return 1;
2256 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2258 const char *value;
2259 if (!git_configset_get_value(cs, key, &value))
2260 return git_config_pathname(dest, key, value);
2261 else
2262 return 1;
2265 /* Functions use to read configuration from a repository */
2266 static void repo_read_config(struct repository *repo)
2268 struct config_options opts = { 0 };
2270 opts.respect_includes = 1;
2271 opts.commondir = repo->commondir;
2272 opts.git_dir = repo->gitdir;
2274 if (!repo->config)
2275 CALLOC_ARRAY(repo->config, 1);
2276 else
2277 git_configset_clear(repo->config);
2279 git_configset_init(repo->config);
2281 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2283 * config_with_options() normally returns only
2284 * zero, as most errors are fatal, and
2285 * non-fatal potential errors are guarded by "if"
2286 * statements that are entered only when no error is
2287 * possible.
2289 * If we ever encounter a non-fatal error, it means
2290 * something went really wrong and we should stop
2291 * immediately.
2293 die(_("unknown error occurred while reading the configuration files"));
2296 static void git_config_check_init(struct repository *repo)
2298 if (repo->config && repo->config->hash_initialized)
2299 return;
2300 repo_read_config(repo);
2303 static void repo_config_clear(struct repository *repo)
2305 if (!repo->config || !repo->config->hash_initialized)
2306 return;
2307 git_configset_clear(repo->config);
2310 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2312 git_config_check_init(repo);
2313 configset_iter(repo->config, fn, data);
2316 int repo_config_get_value(struct repository *repo,
2317 const char *key, const char **value)
2319 git_config_check_init(repo);
2320 return git_configset_get_value(repo->config, key, value);
2323 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2324 const char *key)
2326 git_config_check_init(repo);
2327 return git_configset_get_value_multi(repo->config, key);
2330 int repo_config_get_string(struct repository *repo,
2331 const char *key, char **dest)
2333 int ret;
2334 git_config_check_init(repo);
2335 ret = git_configset_get_string(repo->config, key, dest);
2336 if (ret < 0)
2337 git_die_config(key, NULL);
2338 return ret;
2341 int repo_config_get_string_tmp(struct repository *repo,
2342 const char *key, const char **dest)
2344 int ret;
2345 git_config_check_init(repo);
2346 ret = git_configset_get_string_tmp(repo->config, key, dest);
2347 if (ret < 0)
2348 git_die_config(key, NULL);
2349 return ret;
2352 int repo_config_get_int(struct repository *repo,
2353 const char *key, int *dest)
2355 git_config_check_init(repo);
2356 return git_configset_get_int(repo->config, key, dest);
2359 int repo_config_get_ulong(struct repository *repo,
2360 const char *key, unsigned long *dest)
2362 git_config_check_init(repo);
2363 return git_configset_get_ulong(repo->config, key, dest);
2366 int repo_config_get_bool(struct repository *repo,
2367 const char *key, int *dest)
2369 git_config_check_init(repo);
2370 return git_configset_get_bool(repo->config, key, dest);
2373 int repo_config_get_bool_or_int(struct repository *repo,
2374 const char *key, int *is_bool, int *dest)
2376 git_config_check_init(repo);
2377 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2380 int repo_config_get_maybe_bool(struct repository *repo,
2381 const char *key, int *dest)
2383 git_config_check_init(repo);
2384 return git_configset_get_maybe_bool(repo->config, key, dest);
2387 int repo_config_get_pathname(struct repository *repo,
2388 const char *key, const char **dest)
2390 int ret;
2391 git_config_check_init(repo);
2392 ret = git_configset_get_pathname(repo->config, key, dest);
2393 if (ret < 0)
2394 git_die_config(key, NULL);
2395 return ret;
2398 /* Functions used historically to read configuration from 'the_repository' */
2399 void git_config(config_fn_t fn, void *data)
2401 repo_config(the_repository, fn, data);
2404 void git_config_clear(void)
2406 repo_config_clear(the_repository);
2409 int git_config_get_value(const char *key, const char **value)
2411 return repo_config_get_value(the_repository, key, value);
2414 const struct string_list *git_config_get_value_multi(const char *key)
2416 return repo_config_get_value_multi(the_repository, key);
2419 int git_config_get_string(const char *key, char **dest)
2421 return repo_config_get_string(the_repository, key, dest);
2424 int git_config_get_string_tmp(const char *key, const char **dest)
2426 return repo_config_get_string_tmp(the_repository, key, dest);
2429 int git_config_get_int(const char *key, int *dest)
2431 return repo_config_get_int(the_repository, key, dest);
2434 int git_config_get_ulong(const char *key, unsigned long *dest)
2436 return repo_config_get_ulong(the_repository, key, dest);
2439 int git_config_get_bool(const char *key, int *dest)
2441 return repo_config_get_bool(the_repository, key, dest);
2444 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2446 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2449 int git_config_get_maybe_bool(const char *key, int *dest)
2451 return repo_config_get_maybe_bool(the_repository, key, dest);
2454 int git_config_get_pathname(const char *key, const char **dest)
2456 return repo_config_get_pathname(the_repository, key, dest);
2459 int git_config_get_expiry(const char *key, const char **output)
2461 int ret = git_config_get_string(key, (char **)output);
2462 if (ret)
2463 return ret;
2464 if (strcmp(*output, "now")) {
2465 timestamp_t now = approxidate("now");
2466 if (approxidate(*output) >= now)
2467 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2469 return ret;
2472 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2474 const char *expiry_string;
2475 intmax_t days;
2476 timestamp_t when;
2478 if (git_config_get_string_tmp(key, &expiry_string))
2479 return 1; /* no such thing */
2481 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2482 const int scale = 86400;
2483 *expiry = now - days * scale;
2484 return 0;
2487 if (!parse_expiry_date(expiry_string, &when)) {
2488 *expiry = when;
2489 return 0;
2491 return -1; /* thing exists but cannot be parsed */
2494 int git_config_get_split_index(void)
2496 int val;
2498 if (!git_config_get_maybe_bool("core.splitindex", &val))
2499 return val;
2501 return -1; /* default value */
2504 int git_config_get_max_percent_split_change(void)
2506 int val = -1;
2508 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2509 if (0 <= val && val <= 100)
2510 return val;
2512 return error(_("splitIndex.maxPercentChange value '%d' "
2513 "should be between 0 and 100"), val);
2516 return -1; /* default value */
2519 int git_config_get_fsmonitor(void)
2521 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2522 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2524 if (core_fsmonitor && !*core_fsmonitor)
2525 core_fsmonitor = NULL;
2527 if (core_fsmonitor)
2528 return 1;
2530 return 0;
2533 int git_config_get_index_threads(int *dest)
2535 int is_bool, val;
2537 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2538 if (val) {
2539 *dest = val;
2540 return 0;
2543 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2544 if (is_bool)
2545 *dest = val ? 0 : 1;
2546 else
2547 *dest = val;
2548 return 0;
2551 return 1;
2554 NORETURN
2555 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2557 if (!filename)
2558 die(_("unable to parse '%s' from command-line config"), key);
2559 else
2560 die(_("bad config variable '%s' in file '%s' at line %d"),
2561 key, filename, linenr);
2564 NORETURN __attribute__((format(printf, 2, 3)))
2565 void git_die_config(const char *key, const char *err, ...)
2567 const struct string_list *values;
2568 struct key_value_info *kv_info;
2570 if (err) {
2571 va_list params;
2572 va_start(params, err);
2573 vreportf("error: ", err, params);
2574 va_end(params);
2576 values = git_config_get_value_multi(key);
2577 kv_info = values->items[values->nr - 1].util;
2578 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2582 * Find all the stuff for git_config_set() below.
2585 struct config_store_data {
2586 size_t baselen;
2587 char *key;
2588 int do_not_match;
2589 const char *fixed_value;
2590 regex_t *value_pattern;
2591 int multi_replace;
2592 struct {
2593 size_t begin, end;
2594 enum config_event_t type;
2595 int is_keys_section;
2596 } *parsed;
2597 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2598 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2601 static void config_store_data_clear(struct config_store_data *store)
2603 free(store->key);
2604 if (store->value_pattern != NULL &&
2605 store->value_pattern != CONFIG_REGEX_NONE) {
2606 regfree(store->value_pattern);
2607 free(store->value_pattern);
2609 free(store->parsed);
2610 free(store->seen);
2611 memset(store, 0, sizeof(*store));
2614 static int matches(const char *key, const char *value,
2615 const struct config_store_data *store)
2617 if (strcmp(key, store->key))
2618 return 0; /* not ours */
2619 if (store->fixed_value)
2620 return !strcmp(store->fixed_value, value);
2621 if (!store->value_pattern)
2622 return 1; /* always matches */
2623 if (store->value_pattern == CONFIG_REGEX_NONE)
2624 return 0; /* never matches */
2626 return store->do_not_match ^
2627 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2630 static int store_aux_event(enum config_event_t type,
2631 size_t begin, size_t end, void *data)
2633 struct config_store_data *store = data;
2635 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2636 store->parsed[store->parsed_nr].begin = begin;
2637 store->parsed[store->parsed_nr].end = end;
2638 store->parsed[store->parsed_nr].type = type;
2640 if (type == CONFIG_EVENT_SECTION) {
2641 int (*cmpfn)(const char *, const char *, size_t);
2643 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2644 return error(_("invalid section name '%s'"), cf->var.buf);
2646 if (cf->subsection_case_sensitive)
2647 cmpfn = strncasecmp;
2648 else
2649 cmpfn = strncmp;
2651 /* Is this the section we were looking for? */
2652 store->is_keys_section =
2653 store->parsed[store->parsed_nr].is_keys_section =
2654 cf->var.len - 1 == store->baselen &&
2655 !cmpfn(cf->var.buf, store->key, store->baselen);
2656 if (store->is_keys_section) {
2657 store->section_seen = 1;
2658 ALLOC_GROW(store->seen, store->seen_nr + 1,
2659 store->seen_alloc);
2660 store->seen[store->seen_nr] = store->parsed_nr;
2664 store->parsed_nr++;
2666 return 0;
2669 static int store_aux(const char *key, const char *value, void *cb)
2671 struct config_store_data *store = cb;
2673 if (store->key_seen) {
2674 if (matches(key, value, store)) {
2675 if (store->seen_nr == 1 && store->multi_replace == 0) {
2676 warning(_("%s has multiple values"), key);
2679 ALLOC_GROW(store->seen, store->seen_nr + 1,
2680 store->seen_alloc);
2682 store->seen[store->seen_nr] = store->parsed_nr;
2683 store->seen_nr++;
2685 } else if (store->is_keys_section) {
2687 * Do not increment matches yet: this may not be a match, but we
2688 * are in the desired section.
2690 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2691 store->seen[store->seen_nr] = store->parsed_nr;
2692 store->section_seen = 1;
2694 if (matches(key, value, store)) {
2695 store->seen_nr++;
2696 store->key_seen = 1;
2700 return 0;
2703 static int write_error(const char *filename)
2705 error(_("failed to write new configuration file %s"), filename);
2707 /* Same error code as "failed to rename". */
2708 return 4;
2711 static struct strbuf store_create_section(const char *key,
2712 const struct config_store_data *store)
2714 const char *dot;
2715 size_t i;
2716 struct strbuf sb = STRBUF_INIT;
2718 dot = memchr(key, '.', store->baselen);
2719 if (dot) {
2720 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2721 for (i = dot - key + 1; i < store->baselen; i++) {
2722 if (key[i] == '"' || key[i] == '\\')
2723 strbuf_addch(&sb, '\\');
2724 strbuf_addch(&sb, key[i]);
2726 strbuf_addstr(&sb, "\"]\n");
2727 } else {
2728 strbuf_addch(&sb, '[');
2729 strbuf_add(&sb, key, store->baselen);
2730 strbuf_addstr(&sb, "]\n");
2733 return sb;
2736 static ssize_t write_section(int fd, const char *key,
2737 const struct config_store_data *store)
2739 struct strbuf sb = store_create_section(key, store);
2740 ssize_t ret;
2742 ret = write_in_full(fd, sb.buf, sb.len);
2743 strbuf_release(&sb);
2745 return ret;
2748 static ssize_t write_pair(int fd, const char *key, const char *value,
2749 const struct config_store_data *store)
2751 int i;
2752 ssize_t ret;
2753 const char *quote = "";
2754 struct strbuf sb = STRBUF_INIT;
2757 * Check to see if the value needs to be surrounded with a dq pair.
2758 * Note that problematic characters are always backslash-quoted; this
2759 * check is about not losing leading or trailing SP and strings that
2760 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2761 * configuration parser.
2763 if (value[0] == ' ')
2764 quote = "\"";
2765 for (i = 0; value[i]; i++)
2766 if (value[i] == ';' || value[i] == '#')
2767 quote = "\"";
2768 if (i && value[i - 1] == ' ')
2769 quote = "\"";
2771 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
2773 for (i = 0; value[i]; i++)
2774 switch (value[i]) {
2775 case '\n':
2776 strbuf_addstr(&sb, "\\n");
2777 break;
2778 case '\t':
2779 strbuf_addstr(&sb, "\\t");
2780 break;
2781 case '"':
2782 case '\\':
2783 strbuf_addch(&sb, '\\');
2784 /* fallthrough */
2785 default:
2786 strbuf_addch(&sb, value[i]);
2787 break;
2789 strbuf_addf(&sb, "%s\n", quote);
2791 ret = write_in_full(fd, sb.buf, sb.len);
2792 strbuf_release(&sb);
2794 return ret;
2798 * If we are about to unset the last key(s) in a section, and if there are
2799 * no comments surrounding (or included in) the section, we will want to
2800 * extend begin/end to remove the entire section.
2802 * Note: the parameter `seen_ptr` points to the index into the store.seen
2803 * array. * This index may be incremented if a section has more than one
2804 * entry (which all are to be removed).
2806 static void maybe_remove_section(struct config_store_data *store,
2807 size_t *begin_offset, size_t *end_offset,
2808 int *seen_ptr)
2810 size_t begin;
2811 int i, seen, section_seen = 0;
2814 * First, ensure that this is the first key, and that there are no
2815 * comments before the entry nor before the section header.
2817 seen = *seen_ptr;
2818 for (i = store->seen[seen]; i > 0; i--) {
2819 enum config_event_t type = store->parsed[i - 1].type;
2821 if (type == CONFIG_EVENT_COMMENT)
2822 /* There is a comment before this entry or section */
2823 return;
2824 if (type == CONFIG_EVENT_ENTRY) {
2825 if (!section_seen)
2826 /* This is not the section's first entry. */
2827 return;
2828 /* We encountered no comment before the section. */
2829 break;
2831 if (type == CONFIG_EVENT_SECTION) {
2832 if (!store->parsed[i - 1].is_keys_section)
2833 break;
2834 section_seen = 1;
2837 begin = store->parsed[i].begin;
2840 * Next, make sure that we are removing he last key(s) in the section,
2841 * and that there are no comments that are possibly about the current
2842 * section.
2844 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2845 enum config_event_t type = store->parsed[i].type;
2847 if (type == CONFIG_EVENT_COMMENT)
2848 return;
2849 if (type == CONFIG_EVENT_SECTION) {
2850 if (store->parsed[i].is_keys_section)
2851 continue;
2852 break;
2854 if (type == CONFIG_EVENT_ENTRY) {
2855 if (++seen < store->seen_nr &&
2856 i == store->seen[seen])
2857 /* We want to remove this entry, too */
2858 continue;
2859 /* There is another entry in this section. */
2860 return;
2865 * We are really removing the last entry/entries from this section, and
2866 * there are no enclosed or surrounding comments. Remove the entire,
2867 * now-empty section.
2869 *seen_ptr = seen;
2870 *begin_offset = begin;
2871 if (i < store->parsed_nr)
2872 *end_offset = store->parsed[i].begin;
2873 else
2874 *end_offset = store->parsed[store->parsed_nr - 1].end;
2877 int git_config_set_in_file_gently(const char *config_filename,
2878 const char *key, const char *value)
2880 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2883 void git_config_set_in_file(const char *config_filename,
2884 const char *key, const char *value)
2886 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2889 int git_config_set_gently(const char *key, const char *value)
2891 return git_config_set_multivar_gently(key, value, NULL, 0);
2894 void git_config_set(const char *key, const char *value)
2896 git_config_set_multivar(key, value, NULL, 0);
2898 trace2_cmd_set_config(key, value);
2902 * If value==NULL, unset in (remove from) config,
2903 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
2904 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
2905 * (only add a new one)
2906 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
2907 * key/values are removed before a single new pair is written. If the
2908 * flag is not present, then replace only the first match.
2910 * Returns 0 on success.
2912 * This function does this:
2914 * - it locks the config file by creating ".git/config.lock"
2916 * - it then parses the config using store_aux() as validator to find
2917 * the position on the key/value pair to replace. If it is to be unset,
2918 * it must be found exactly once.
2920 * - the config file is mmap()ed and the part before the match (if any) is
2921 * written to the lock file, then the changed part and the rest.
2923 * - the config file is removed and the lock file rename()d to it.
2926 int git_config_set_multivar_in_file_gently(const char *config_filename,
2927 const char *key, const char *value,
2928 const char *value_pattern,
2929 unsigned flags)
2931 int fd = -1, in_fd = -1;
2932 int ret;
2933 struct lock_file lock = LOCK_INIT;
2934 char *filename_buf = NULL;
2935 char *contents = NULL;
2936 size_t contents_sz;
2937 struct config_store_data store;
2939 memset(&store, 0, sizeof(store));
2941 /* parse-key returns negative; flip the sign to feed exit(3) */
2942 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2943 if (ret)
2944 goto out_free;
2946 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
2948 if (!config_filename)
2949 config_filename = filename_buf = git_pathdup("config");
2952 * The lock serves a purpose in addition to locking: the new
2953 * contents of .git/config will be written into it.
2955 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2956 if (fd < 0) {
2957 error_errno(_("could not lock config file %s"), config_filename);
2958 ret = CONFIG_NO_LOCK;
2959 goto out_free;
2963 * If .git/config does not exist yet, write a minimal version.
2965 in_fd = open(config_filename, O_RDONLY);
2966 if ( in_fd < 0 ) {
2967 if ( ENOENT != errno ) {
2968 error_errno(_("opening %s"), config_filename);
2969 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2970 goto out_free;
2972 /* if nothing to unset, error out */
2973 if (value == NULL) {
2974 ret = CONFIG_NOTHING_SET;
2975 goto out_free;
2978 free(store.key);
2979 store.key = xstrdup(key);
2980 if (write_section(fd, key, &store) < 0 ||
2981 write_pair(fd, key, value, &store) < 0)
2982 goto write_err_out;
2983 } else {
2984 struct stat st;
2985 size_t copy_begin, copy_end;
2986 int i, new_line = 0;
2987 struct config_options opts;
2989 if (value_pattern == NULL)
2990 store.value_pattern = NULL;
2991 else if (value_pattern == CONFIG_REGEX_NONE)
2992 store.value_pattern = CONFIG_REGEX_NONE;
2993 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
2994 store.fixed_value = value_pattern;
2995 else {
2996 if (value_pattern[0] == '!') {
2997 store.do_not_match = 1;
2998 value_pattern++;
2999 } else
3000 store.do_not_match = 0;
3002 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3003 if (regcomp(store.value_pattern, value_pattern,
3004 REG_EXTENDED)) {
3005 error(_("invalid pattern: %s"), value_pattern);
3006 FREE_AND_NULL(store.value_pattern);
3007 ret = CONFIG_INVALID_PATTERN;
3008 goto out_free;
3012 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3013 store.parsed[0].end = 0;
3015 memset(&opts, 0, sizeof(opts));
3016 opts.event_fn = store_aux_event;
3017 opts.event_fn_data = &store;
3020 * After this, store.parsed will contain offsets of all the
3021 * parsed elements, and store.seen will contain a list of
3022 * matches, as indices into store.parsed.
3024 * As a side effect, we make sure to transform only a valid
3025 * existing config file.
3027 if (git_config_from_file_with_options(store_aux,
3028 config_filename,
3029 &store, &opts)) {
3030 error(_("invalid config file %s"), config_filename);
3031 ret = CONFIG_INVALID_FILE;
3032 goto out_free;
3035 /* if nothing to unset, or too many matches, error out */
3036 if ((store.seen_nr == 0 && value == NULL) ||
3037 (store.seen_nr > 1 && !store.multi_replace)) {
3038 ret = CONFIG_NOTHING_SET;
3039 goto out_free;
3042 if (fstat(in_fd, &st) == -1) {
3043 error_errno(_("fstat on %s failed"), config_filename);
3044 ret = CONFIG_INVALID_FILE;
3045 goto out_free;
3048 contents_sz = xsize_t(st.st_size);
3049 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3050 MAP_PRIVATE, in_fd, 0);
3051 if (contents == MAP_FAILED) {
3052 if (errno == ENODEV && S_ISDIR(st.st_mode))
3053 errno = EISDIR;
3054 error_errno(_("unable to mmap '%s'"), config_filename);
3055 ret = CONFIG_INVALID_FILE;
3056 contents = NULL;
3057 goto out_free;
3059 close(in_fd);
3060 in_fd = -1;
3062 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3063 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3064 ret = CONFIG_NO_WRITE;
3065 goto out_free;
3068 if (store.seen_nr == 0) {
3069 if (!store.seen_alloc) {
3070 /* Did not see key nor section */
3071 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3072 store.seen[0] = store.parsed_nr
3073 - !!store.parsed_nr;
3075 store.seen_nr = 1;
3078 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3079 size_t replace_end;
3080 int j = store.seen[i];
3082 new_line = 0;
3083 if (!store.key_seen) {
3084 copy_end = store.parsed[j].end;
3085 /* include '\n' when copying section header */
3086 if (copy_end > 0 && copy_end < contents_sz &&
3087 contents[copy_end - 1] != '\n' &&
3088 contents[copy_end] == '\n')
3089 copy_end++;
3090 replace_end = copy_end;
3091 } else {
3092 replace_end = store.parsed[j].end;
3093 copy_end = store.parsed[j].begin;
3094 if (!value)
3095 maybe_remove_section(&store,
3096 &copy_end,
3097 &replace_end, &i);
3099 * Swallow preceding white-space on the same
3100 * line.
3102 while (copy_end > 0 ) {
3103 char c = contents[copy_end - 1];
3105 if (isspace(c) && c != '\n')
3106 copy_end--;
3107 else
3108 break;
3112 if (copy_end > 0 && contents[copy_end-1] != '\n')
3113 new_line = 1;
3115 /* write the first part of the config */
3116 if (copy_end > copy_begin) {
3117 if (write_in_full(fd, contents + copy_begin,
3118 copy_end - copy_begin) < 0)
3119 goto write_err_out;
3120 if (new_line &&
3121 write_str_in_full(fd, "\n") < 0)
3122 goto write_err_out;
3124 copy_begin = replace_end;
3127 /* write the pair (value == NULL means unset) */
3128 if (value != NULL) {
3129 if (!store.section_seen) {
3130 if (write_section(fd, key, &store) < 0)
3131 goto write_err_out;
3133 if (write_pair(fd, key, value, &store) < 0)
3134 goto write_err_out;
3137 /* write the rest of the config */
3138 if (copy_begin < contents_sz)
3139 if (write_in_full(fd, contents + copy_begin,
3140 contents_sz - copy_begin) < 0)
3141 goto write_err_out;
3143 munmap(contents, contents_sz);
3144 contents = NULL;
3147 if (commit_lock_file(&lock) < 0) {
3148 error_errno(_("could not write config file %s"), config_filename);
3149 ret = CONFIG_NO_WRITE;
3150 goto out_free;
3153 ret = 0;
3155 /* Invalidate the config cache */
3156 git_config_clear();
3158 out_free:
3159 rollback_lock_file(&lock);
3160 free(filename_buf);
3161 if (contents)
3162 munmap(contents, contents_sz);
3163 if (in_fd >= 0)
3164 close(in_fd);
3165 config_store_data_clear(&store);
3166 return ret;
3168 write_err_out:
3169 ret = write_error(get_lock_file_path(&lock));
3170 goto out_free;
3174 void git_config_set_multivar_in_file(const char *config_filename,
3175 const char *key, const char *value,
3176 const char *value_pattern, unsigned flags)
3178 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3179 value_pattern, flags))
3180 return;
3181 if (value)
3182 die(_("could not set '%s' to '%s'"), key, value);
3183 else
3184 die(_("could not unset '%s'"), key);
3187 int git_config_set_multivar_gently(const char *key, const char *value,
3188 const char *value_pattern, unsigned flags)
3190 return git_config_set_multivar_in_file_gently(NULL, key, value, value_pattern,
3191 flags);
3194 void git_config_set_multivar(const char *key, const char *value,
3195 const char *value_pattern, unsigned flags)
3197 git_config_set_multivar_in_file(NULL, key, value, value_pattern,
3198 flags);
3201 static int section_name_match (const char *buf, const char *name)
3203 int i = 0, j = 0, dot = 0;
3204 if (buf[i] != '[')
3205 return 0;
3206 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3207 if (!dot && isspace(buf[i])) {
3208 dot = 1;
3209 if (name[j++] != '.')
3210 break;
3211 for (i++; isspace(buf[i]); i++)
3212 ; /* do nothing */
3213 if (buf[i] != '"')
3214 break;
3215 continue;
3217 if (buf[i] == '\\' && dot)
3218 i++;
3219 else if (buf[i] == '"' && dot) {
3220 for (i++; isspace(buf[i]); i++)
3221 ; /* do_nothing */
3222 break;
3224 if (buf[i] != name[j++])
3225 break;
3227 if (buf[i] == ']' && name[j] == 0) {
3229 * We match, now just find the right length offset by
3230 * gobbling up any whitespace after it, as well
3232 i++;
3233 for (; buf[i] && isspace(buf[i]); i++)
3234 ; /* do nothing */
3235 return i;
3237 return 0;
3240 static int section_name_is_ok(const char *name)
3242 /* Empty section names are bogus. */
3243 if (!*name)
3244 return 0;
3247 * Before a dot, we must be alphanumeric or dash. After the first dot,
3248 * anything goes, so we can stop checking.
3250 for (; *name && *name != '.'; name++)
3251 if (*name != '-' && !isalnum(*name))
3252 return 0;
3253 return 1;
3256 /* if new_name == NULL, the section is removed instead */
3257 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3258 const char *old_name,
3259 const char *new_name, int copy)
3261 int ret = 0, remove = 0;
3262 char *filename_buf = NULL;
3263 struct lock_file lock = LOCK_INIT;
3264 int out_fd;
3265 char buf[1024];
3266 FILE *config_file = NULL;
3267 struct stat st;
3268 struct strbuf copystr = STRBUF_INIT;
3269 struct config_store_data store;
3271 memset(&store, 0, sizeof(store));
3273 if (new_name && !section_name_is_ok(new_name)) {
3274 ret = error(_("invalid section name: %s"), new_name);
3275 goto out_no_rollback;
3278 if (!config_filename)
3279 config_filename = filename_buf = git_pathdup("config");
3281 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3282 if (out_fd < 0) {
3283 ret = error(_("could not lock config file %s"), config_filename);
3284 goto out;
3287 if (!(config_file = fopen(config_filename, "rb"))) {
3288 ret = warn_on_fopen_errors(config_filename);
3289 if (ret)
3290 goto out;
3291 /* no config file means nothing to rename, no error */
3292 goto commit_and_out;
3295 if (fstat(fileno(config_file), &st) == -1) {
3296 ret = error_errno(_("fstat on %s failed"), config_filename);
3297 goto out;
3300 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3301 ret = error_errno(_("chmod on %s failed"),
3302 get_lock_file_path(&lock));
3303 goto out;
3306 while (fgets(buf, sizeof(buf), config_file)) {
3307 unsigned i;
3308 int length;
3309 int is_section = 0;
3310 char *output = buf;
3311 for (i = 0; buf[i] && isspace(buf[i]); i++)
3312 ; /* do nothing */
3313 if (buf[i] == '[') {
3314 /* it's a section */
3315 int offset;
3316 is_section = 1;
3319 * When encountering a new section under -c we
3320 * need to flush out any section we're already
3321 * coping and begin anew. There might be
3322 * multiple [branch "$name"] sections.
3324 if (copystr.len > 0) {
3325 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3326 ret = write_error(get_lock_file_path(&lock));
3327 goto out;
3329 strbuf_reset(&copystr);
3332 offset = section_name_match(&buf[i], old_name);
3333 if (offset > 0) {
3334 ret++;
3335 if (new_name == NULL) {
3336 remove = 1;
3337 continue;
3339 store.baselen = strlen(new_name);
3340 if (!copy) {
3341 if (write_section(out_fd, new_name, &store) < 0) {
3342 ret = write_error(get_lock_file_path(&lock));
3343 goto out;
3346 * We wrote out the new section, with
3347 * a newline, now skip the old
3348 * section's length
3350 output += offset + i;
3351 if (strlen(output) > 0) {
3353 * More content means there's
3354 * a declaration to put on the
3355 * next line; indent with a
3356 * tab
3358 output -= 1;
3359 output[0] = '\t';
3361 } else {
3362 copystr = store_create_section(new_name, &store);
3365 remove = 0;
3367 if (remove)
3368 continue;
3369 length = strlen(output);
3371 if (!is_section && copystr.len > 0) {
3372 strbuf_add(&copystr, output, length);
3375 if (write_in_full(out_fd, output, length) < 0) {
3376 ret = write_error(get_lock_file_path(&lock));
3377 goto out;
3382 * Copy a trailing section at the end of the config, won't be
3383 * flushed by the usual "flush because we have a new section
3384 * logic in the loop above.
3386 if (copystr.len > 0) {
3387 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3388 ret = write_error(get_lock_file_path(&lock));
3389 goto out;
3391 strbuf_reset(&copystr);
3394 fclose(config_file);
3395 config_file = NULL;
3396 commit_and_out:
3397 if (commit_lock_file(&lock) < 0)
3398 ret = error_errno(_("could not write config file %s"),
3399 config_filename);
3400 out:
3401 if (config_file)
3402 fclose(config_file);
3403 rollback_lock_file(&lock);
3404 out_no_rollback:
3405 free(filename_buf);
3406 config_store_data_clear(&store);
3407 return ret;
3410 int git_config_rename_section_in_file(const char *config_filename,
3411 const char *old_name, const char *new_name)
3413 return git_config_copy_or_rename_section_in_file(config_filename,
3414 old_name, new_name, 0);
3417 int git_config_rename_section(const char *old_name, const char *new_name)
3419 return git_config_rename_section_in_file(NULL, old_name, new_name);
3422 int git_config_copy_section_in_file(const char *config_filename,
3423 const char *old_name, const char *new_name)
3425 return git_config_copy_or_rename_section_in_file(config_filename,
3426 old_name, new_name, 1);
3429 int git_config_copy_section(const char *old_name, const char *new_name)
3431 return git_config_copy_section_in_file(NULL, old_name, new_name);
3435 * Call this to report error for your variable that should not
3436 * get a boolean value (i.e. "[my] var" means "true").
3438 #undef config_error_nonbool
3439 int config_error_nonbool(const char *var)
3441 return error(_("missing value for '%s'"), var);
3444 int parse_config_key(const char *var,
3445 const char *section,
3446 const char **subsection, size_t *subsection_len,
3447 const char **key)
3449 const char *dot;
3451 /* Does it start with "section." ? */
3452 if (!skip_prefix(var, section, &var) || *var != '.')
3453 return -1;
3456 * Find the key; we don't know yet if we have a subsection, but we must
3457 * parse backwards from the end, since the subsection may have dots in
3458 * it, too.
3460 dot = strrchr(var, '.');
3461 *key = dot + 1;
3463 /* Did we have a subsection at all? */
3464 if (dot == var) {
3465 if (subsection) {
3466 *subsection = NULL;
3467 *subsection_len = 0;
3470 else {
3471 if (!subsection)
3472 return -1;
3473 *subsection = var + 1;
3474 *subsection_len = dot - *subsection;
3477 return 0;
3480 const char *current_config_origin_type(void)
3482 int type;
3483 if (current_config_kvi)
3484 type = current_config_kvi->origin_type;
3485 else if(cf)
3486 type = cf->origin_type;
3487 else
3488 BUG("current_config_origin_type called outside config callback");
3490 switch (type) {
3491 case CONFIG_ORIGIN_BLOB:
3492 return "blob";
3493 case CONFIG_ORIGIN_FILE:
3494 return "file";
3495 case CONFIG_ORIGIN_STDIN:
3496 return "standard input";
3497 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3498 return "submodule-blob";
3499 case CONFIG_ORIGIN_CMDLINE:
3500 return "command line";
3501 default:
3502 BUG("unknown config origin type");
3506 const char *config_scope_name(enum config_scope scope)
3508 switch (scope) {
3509 case CONFIG_SCOPE_SYSTEM:
3510 return "system";
3511 case CONFIG_SCOPE_GLOBAL:
3512 return "global";
3513 case CONFIG_SCOPE_LOCAL:
3514 return "local";
3515 case CONFIG_SCOPE_WORKTREE:
3516 return "worktree";
3517 case CONFIG_SCOPE_COMMAND:
3518 return "command";
3519 case CONFIG_SCOPE_SUBMODULE:
3520 return "submodule";
3521 default:
3522 return "unknown";
3526 const char *current_config_name(void)
3528 const char *name;
3529 if (current_config_kvi)
3530 name = current_config_kvi->filename;
3531 else if (cf)
3532 name = cf->name;
3533 else
3534 BUG("current_config_name called outside config callback");
3535 return name ? name : "";
3538 enum config_scope current_config_scope(void)
3540 if (current_config_kvi)
3541 return current_config_kvi->scope;
3542 else
3543 return current_parsing_scope;
3546 int current_config_line(void)
3548 if (current_config_kvi)
3549 return current_config_kvi->linenr;
3550 else
3551 return cf->linenr;
3554 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3556 int i;
3558 for (i = 0; i < nr_mapping; i++) {
3559 const char *name = mapping[i];
3561 if (name && !strcasecmp(var, name))
3562 return i;
3564 return -1;