Sync with 2.33.8
[git/debian.git] / config.c
blob2317a76696149e36718b04f3a99a3cc553d9246b
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "branch.h"
10 #include "config.h"
11 #include "environment.h"
12 #include "repository.h"
13 #include "lockfile.h"
14 #include "exec-cmd.h"
15 #include "strbuf.h"
16 #include "quote.h"
17 #include "hashmap.h"
18 #include "string-list.h"
19 #include "object-store.h"
20 #include "utf8.h"
21 #include "dir.h"
22 #include "color.h"
23 #include "refs.h"
25 struct config_source {
26 struct config_source *prev;
27 union {
28 FILE *file;
29 struct config_buf {
30 const char *buf;
31 size_t len;
32 size_t pos;
33 } buf;
34 } u;
35 enum config_origin_type origin_type;
36 const char *name;
37 const char *path;
38 enum config_error_action default_error_action;
39 int linenr;
40 int eof;
41 size_t total_len;
42 struct strbuf value;
43 struct strbuf var;
44 unsigned subsection_case_sensitive : 1;
46 int (*do_fgetc)(struct config_source *c);
47 int (*do_ungetc)(int c, struct config_source *conf);
48 long (*do_ftell)(struct config_source *c);
52 * These variables record the "current" config source, which
53 * can be accessed by parsing callbacks.
55 * The "cf" variable will be non-NULL only when we are actually parsing a real
56 * config source (file, blob, cmdline, etc).
58 * The "current_config_kvi" variable will be non-NULL only when we are feeding
59 * cached config from a configset into a callback.
61 * They should generally never be non-NULL at the same time. If they are both
62 * NULL, then we aren't parsing anything (and depending on the function looking
63 * at the variables, it's either a bug for it to be called in the first place,
64 * or it's a function which can be reused for non-config purposes, and should
65 * fall back to some sane behavior).
67 static struct config_source *cf;
68 static struct key_value_info *current_config_kvi;
71 * Similar to the variables above, this gives access to the "scope" of the
72 * current value (repo, global, etc). For cached values, it can be found via
73 * the current_config_kvi as above. During parsing, the current value can be
74 * found in this variable. It's not part of "cf" because it transcends a single
75 * file (i.e., a file included from .git/config is still in "repo" scope).
77 static enum config_scope current_parsing_scope;
79 static int pack_compression_seen;
80 static int zlib_compression_seen;
82 static int config_file_fgetc(struct config_source *conf)
84 return getc_unlocked(conf->u.file);
87 static int config_file_ungetc(int c, struct config_source *conf)
89 return ungetc(c, conf->u.file);
92 static long config_file_ftell(struct config_source *conf)
94 return ftell(conf->u.file);
98 static int config_buf_fgetc(struct config_source *conf)
100 if (conf->u.buf.pos < conf->u.buf.len)
101 return conf->u.buf.buf[conf->u.buf.pos++];
103 return EOF;
106 static int config_buf_ungetc(int c, struct config_source *conf)
108 if (conf->u.buf.pos > 0) {
109 conf->u.buf.pos--;
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
111 BUG("config_buf can only ungetc the same character");
112 return c;
115 return EOF;
118 static long config_buf_ftell(struct config_source *conf)
120 return conf->u.buf.pos;
123 #define MAX_INCLUDE_DEPTH 10
124 static const char include_depth_advice[] = N_(
125 "exceeded maximum include depth (%d) while including\n"
126 " %s\n"
127 "from\n"
128 " %s\n"
129 "This might be due to circular includes.");
130 static int handle_path_include(const char *path, struct config_include_data *inc)
132 int ret = 0;
133 struct strbuf buf = STRBUF_INIT;
134 char *expanded;
136 if (!path)
137 return config_error_nonbool("include.path");
139 expanded = interpolate_path(path, 0);
140 if (!expanded)
141 return error(_("could not expand include path '%s'"), path);
142 path = expanded;
145 * Use an absolute path as-is, but interpret relative paths
146 * based on the including config file.
148 if (!is_absolute_path(path)) {
149 char *slash;
151 if (!cf || !cf->path) {
152 ret = error(_("relative config includes must come from files"));
153 goto cleanup;
156 slash = find_last_dir_sep(cf->path);
157 if (slash)
158 strbuf_add(&buf, cf->path, slash - cf->path + 1);
159 strbuf_addstr(&buf, path);
160 path = buf.buf;
163 if (!access_or_die(path, R_OK, 0)) {
164 if (++inc->depth > MAX_INCLUDE_DEPTH)
165 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
166 !cf ? "<unknown>" :
167 cf->name ? cf->name :
168 "the command line");
169 ret = git_config_from_file(git_config_include, path, inc);
170 inc->depth--;
172 cleanup:
173 strbuf_release(&buf);
174 free(expanded);
175 return ret;
178 static void add_trailing_starstar_for_dir(struct strbuf *pat)
180 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
181 strbuf_addstr(pat, "**");
184 static int prepare_include_condition_pattern(struct strbuf *pat)
186 struct strbuf path = STRBUF_INIT;
187 char *expanded;
188 int prefix = 0;
190 expanded = interpolate_path(pat->buf, 1);
191 if (expanded) {
192 strbuf_reset(pat);
193 strbuf_addstr(pat, expanded);
194 free(expanded);
197 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
198 const char *slash;
200 if (!cf || !cf->path)
201 return error(_("relative config include "
202 "conditionals must come from files"));
204 strbuf_realpath(&path, cf->path, 1);
205 slash = find_last_dir_sep(path.buf);
206 if (!slash)
207 BUG("how is this possible?");
208 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
209 prefix = slash - path.buf + 1 /* slash */;
210 } else if (!is_absolute_path(pat->buf))
211 strbuf_insertstr(pat, 0, "**/");
213 add_trailing_starstar_for_dir(pat);
215 strbuf_release(&path);
216 return prefix;
219 static int include_by_gitdir(const struct config_options *opts,
220 const char *cond, size_t cond_len, int icase)
222 struct strbuf text = STRBUF_INIT;
223 struct strbuf pattern = STRBUF_INIT;
224 int ret = 0, prefix;
225 const char *git_dir;
226 int already_tried_absolute = 0;
228 if (opts->git_dir)
229 git_dir = opts->git_dir;
230 else
231 goto done;
233 strbuf_realpath(&text, git_dir, 1);
234 strbuf_add(&pattern, cond, cond_len);
235 prefix = prepare_include_condition_pattern(&pattern);
237 again:
238 if (prefix < 0)
239 goto done;
241 if (prefix > 0) {
243 * perform literal matching on the prefix part so that
244 * any wildcard character in it can't create side effects.
246 if (text.len < prefix)
247 goto done;
248 if (!icase && strncmp(pattern.buf, text.buf, prefix))
249 goto done;
250 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
251 goto done;
254 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
255 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
257 if (!ret && !already_tried_absolute) {
259 * We've tried e.g. matching gitdir:~/work, but if
260 * ~/work is a symlink to /mnt/storage/work
261 * strbuf_realpath() will expand it, so the rule won't
262 * match. Let's match against a
263 * strbuf_add_absolute_path() version of the path,
264 * which'll do the right thing
266 strbuf_reset(&text);
267 strbuf_add_absolute_path(&text, git_dir);
268 already_tried_absolute = 1;
269 goto again;
271 done:
272 strbuf_release(&pattern);
273 strbuf_release(&text);
274 return ret;
277 static int include_by_branch(const char *cond, size_t cond_len)
279 int flags;
280 int ret;
281 struct strbuf pattern = STRBUF_INIT;
282 const char *refname = !the_repository->gitdir ?
283 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
284 const char *shortname;
286 if (!refname || !(flags & REF_ISSYMREF) ||
287 !skip_prefix(refname, "refs/heads/", &shortname))
288 return 0;
290 strbuf_add(&pattern, cond, cond_len);
291 add_trailing_starstar_for_dir(&pattern);
292 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
293 strbuf_release(&pattern);
294 return ret;
297 static int include_condition_is_true(const struct config_options *opts,
298 const char *cond, size_t cond_len)
301 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
302 return include_by_gitdir(opts, cond, cond_len, 0);
303 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
304 return include_by_gitdir(opts, cond, cond_len, 1);
305 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
306 return include_by_branch(cond, cond_len);
308 /* unknown conditionals are always false */
309 return 0;
312 int git_config_include(const char *var, const char *value, void *data)
314 struct config_include_data *inc = data;
315 const char *cond, *key;
316 size_t cond_len;
317 int ret;
320 * Pass along all values, including "include" directives; this makes it
321 * possible to query information on the includes themselves.
323 ret = inc->fn(var, value, inc->data);
324 if (ret < 0)
325 return ret;
327 if (!strcmp(var, "include.path"))
328 ret = handle_path_include(value, inc);
330 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
331 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
332 !strcmp(key, "path"))
333 ret = handle_path_include(value, inc);
335 return ret;
338 static void git_config_push_split_parameter(const char *key, const char *value)
340 struct strbuf env = STRBUF_INIT;
341 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
342 if (old && *old) {
343 strbuf_addstr(&env, old);
344 strbuf_addch(&env, ' ');
346 sq_quote_buf(&env, key);
347 strbuf_addch(&env, '=');
348 if (value)
349 sq_quote_buf(&env, value);
350 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
351 strbuf_release(&env);
354 void git_config_push_parameter(const char *text)
356 const char *value;
359 * When we see:
361 * section.subsection=with=equals.key=value
363 * we cannot tell if it means:
365 * [section "subsection=with=equals"]
366 * key = value
368 * or:
370 * [section]
371 * subsection = with=equals.key=value
373 * We parse left-to-right for the first "=", meaning we'll prefer to
374 * keep the value intact over the subsection. This is historical, but
375 * also sensible since values are more likely to contain odd or
376 * untrusted input than a section name.
378 * A missing equals is explicitly allowed (as a bool-only entry).
380 value = strchr(text, '=');
381 if (value) {
382 char *key = xmemdupz(text, value - text);
383 git_config_push_split_parameter(key, value + 1);
384 free(key);
385 } else {
386 git_config_push_split_parameter(text, NULL);
390 void git_config_push_env(const char *spec)
392 char *key;
393 const char *env_name;
394 const char *env_value;
396 env_name = strrchr(spec, '=');
397 if (!env_name)
398 die(_("invalid config format: %s"), spec);
399 key = xmemdupz(spec, env_name - spec);
400 env_name++;
401 if (!*env_name)
402 die(_("missing environment variable name for configuration '%.*s'"),
403 (int)(env_name - spec - 1), spec);
405 env_value = getenv(env_name);
406 if (!env_value)
407 die(_("missing environment variable '%s' for configuration '%.*s'"),
408 env_name, (int)(env_name - spec - 1), spec);
410 git_config_push_split_parameter(key, env_value);
411 free(key);
414 static inline int iskeychar(int c)
416 return isalnum(c) || c == '-';
420 * Auxiliary function to sanity-check and split the key into the section
421 * identifier and variable name.
423 * Returns 0 on success, -1 when there is an invalid character in the key and
424 * -2 if there is no section name in the key.
426 * store_key - pointer to char* which will hold a copy of the key with
427 * lowercase section and variable name
428 * baselen - pointer to size_t which will hold the length of the
429 * section + subsection part, can be NULL
431 int git_config_parse_key(const char *key, char **store_key, size_t *baselen_)
433 size_t i, baselen;
434 int dot;
435 const char *last_dot = strrchr(key, '.');
438 * Since "key" actually contains the section name and the real
439 * key name separated by a dot, we have to know where the dot is.
442 if (last_dot == NULL || last_dot == key) {
443 error(_("key does not contain a section: %s"), key);
444 return -CONFIG_NO_SECTION_OR_NAME;
447 if (!last_dot[1]) {
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 *store_key = xmallocz(strlen(key));
461 dot = 0;
462 for (i = 0; key[i]; i++) {
463 unsigned char c = key[i];
464 if (c == '.')
465 dot = 1;
466 /* Leave the extended basename untouched.. */
467 if (!dot || i > baselen) {
468 if (!iskeychar(c) ||
469 (i == baselen + 1 && !isalpha(c))) {
470 error(_("invalid key: %s"), key);
471 goto out_free_ret_1;
473 c = tolower(c);
474 } else if (c == '\n') {
475 error(_("invalid key (newline): %s"), key);
476 goto out_free_ret_1;
478 (*store_key)[i] = c;
481 return 0;
483 out_free_ret_1:
484 FREE_AND_NULL(*store_key);
485 return -CONFIG_INVALID_KEY;
488 static int config_parse_pair(const char *key, const char *value,
489 config_fn_t fn, void *data)
491 char *canonical_name;
492 int ret;
494 if (!strlen(key))
495 return error(_("empty config key"));
496 if (git_config_parse_key(key, &canonical_name, NULL))
497 return -1;
499 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
500 free(canonical_name);
501 return ret;
504 int git_config_parse_parameter(const char *text,
505 config_fn_t fn, void *data)
507 const char *value;
508 struct strbuf **pair;
509 int ret;
511 pair = strbuf_split_str(text, '=', 2);
512 if (!pair[0])
513 return error(_("bogus config parameter: %s"), text);
515 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
516 strbuf_setlen(pair[0], pair[0]->len - 1);
517 value = pair[1] ? pair[1]->buf : "";
518 } else {
519 value = NULL;
522 strbuf_trim(pair[0]);
523 if (!pair[0]->len) {
524 strbuf_list_free(pair);
525 return error(_("bogus config parameter: %s"), text);
528 ret = config_parse_pair(pair[0]->buf, value, fn, data);
529 strbuf_list_free(pair);
530 return ret;
533 static int parse_config_env_list(char *env, config_fn_t fn, void *data)
535 char *cur = env;
536 while (cur && *cur) {
537 const char *key = sq_dequote_step(cur, &cur);
538 if (!key)
539 return error(_("bogus format in %s"),
540 CONFIG_DATA_ENVIRONMENT);
542 if (!cur || isspace(*cur)) {
543 /* old-style 'key=value' */
544 if (git_config_parse_parameter(key, fn, data) < 0)
545 return -1;
547 else if (*cur == '=') {
548 /* new-style 'key'='value' */
549 const char *value;
551 cur++;
552 if (*cur == '\'') {
553 /* quoted value */
554 value = sq_dequote_step(cur, &cur);
555 if (!value || (cur && !isspace(*cur))) {
556 return error(_("bogus format in %s"),
557 CONFIG_DATA_ENVIRONMENT);
559 } else if (!*cur || isspace(*cur)) {
560 /* implicit bool: 'key'= */
561 value = NULL;
562 } else {
563 return error(_("bogus format in %s"),
564 CONFIG_DATA_ENVIRONMENT);
567 if (config_parse_pair(key, value, fn, data) < 0)
568 return -1;
570 else {
571 /* unknown format */
572 return error(_("bogus format in %s"),
573 CONFIG_DATA_ENVIRONMENT);
576 if (cur) {
577 while (isspace(*cur))
578 cur++;
581 return 0;
584 int git_config_from_parameters(config_fn_t fn, void *data)
586 const char *env;
587 struct strbuf envvar = STRBUF_INIT;
588 struct strvec to_free = STRVEC_INIT;
589 int ret = 0;
590 char *envw = NULL;
591 struct config_source source;
593 memset(&source, 0, sizeof(source));
594 source.prev = cf;
595 source.origin_type = CONFIG_ORIGIN_CMDLINE;
596 cf = &source;
598 env = getenv(CONFIG_COUNT_ENVIRONMENT);
599 if (env) {
600 unsigned long count;
601 char *endp;
602 int i;
604 count = strtoul(env, &endp, 10);
605 if (*endp) {
606 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
607 goto out;
609 if (count > INT_MAX) {
610 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
611 goto out;
614 for (i = 0; i < count; i++) {
615 const char *key, *value;
617 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
618 key = getenv_safe(&to_free, envvar.buf);
619 if (!key) {
620 ret = error(_("missing config key %s"), envvar.buf);
621 goto out;
623 strbuf_reset(&envvar);
625 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
626 value = getenv_safe(&to_free, envvar.buf);
627 if (!value) {
628 ret = error(_("missing config value %s"), envvar.buf);
629 goto out;
631 strbuf_reset(&envvar);
633 if (config_parse_pair(key, value, fn, data) < 0) {
634 ret = -1;
635 goto out;
640 env = getenv(CONFIG_DATA_ENVIRONMENT);
641 if (env) {
642 /* sq_dequote will write over it */
643 envw = xstrdup(env);
644 if (parse_config_env_list(envw, fn, data) < 0) {
645 ret = -1;
646 goto out;
650 out:
651 strbuf_release(&envvar);
652 strvec_clear(&to_free);
653 free(envw);
654 cf = source.prev;
655 return ret;
658 static int get_next_char(void)
660 int c = cf->do_fgetc(cf);
662 if (c == '\r') {
663 /* DOS like systems */
664 c = cf->do_fgetc(cf);
665 if (c != '\n') {
666 if (c != EOF)
667 cf->do_ungetc(c, cf);
668 c = '\r';
672 if (c != EOF && ++cf->total_len > INT_MAX) {
674 * This is an absurdly long config file; refuse to parse
675 * further in order to protect downstream code from integer
676 * overflows. Note that we can't return an error specifically,
677 * but we can mark EOF and put trash in the return value,
678 * which will trigger a parse error.
680 cf->eof = 1;
681 return 0;
684 if (c == '\n')
685 cf->linenr++;
686 if (c == EOF) {
687 cf->eof = 1;
688 cf->linenr++;
689 c = '\n';
691 return c;
694 static char *parse_value(void)
696 int quote = 0, comment = 0, space = 0;
698 strbuf_reset(&cf->value);
699 for (;;) {
700 int c = get_next_char();
701 if (c == '\n') {
702 if (quote) {
703 cf->linenr--;
704 return NULL;
706 return cf->value.buf;
708 if (comment)
709 continue;
710 if (isspace(c) && !quote) {
711 if (cf->value.len)
712 space++;
713 continue;
715 if (!quote) {
716 if (c == ';' || c == '#') {
717 comment = 1;
718 continue;
721 for (; space; space--)
722 strbuf_addch(&cf->value, ' ');
723 if (c == '\\') {
724 c = get_next_char();
725 switch (c) {
726 case '\n':
727 continue;
728 case 't':
729 c = '\t';
730 break;
731 case 'b':
732 c = '\b';
733 break;
734 case 'n':
735 c = '\n';
736 break;
737 /* Some characters escape as themselves */
738 case '\\': case '"':
739 break;
740 /* Reject unknown escape sequences */
741 default:
742 return NULL;
744 strbuf_addch(&cf->value, c);
745 continue;
747 if (c == '"') {
748 quote = 1-quote;
749 continue;
751 strbuf_addch(&cf->value, c);
755 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
757 int c;
758 char *value;
759 int ret;
761 /* Get the full name */
762 for (;;) {
763 c = get_next_char();
764 if (cf->eof)
765 break;
766 if (!iskeychar(c))
767 break;
768 strbuf_addch(name, tolower(c));
771 while (c == ' ' || c == '\t')
772 c = get_next_char();
774 value = NULL;
775 if (c != '\n') {
776 if (c != '=')
777 return -1;
778 value = parse_value();
779 if (!value)
780 return -1;
783 * We already consumed the \n, but we need linenr to point to
784 * the line we just parsed during the call to fn to get
785 * accurate line number in error messages.
787 cf->linenr--;
788 ret = fn(name->buf, value, data);
789 if (ret >= 0)
790 cf->linenr++;
791 return ret;
794 static int get_extended_base_var(struct strbuf *name, int c)
796 cf->subsection_case_sensitive = 0;
797 do {
798 if (c == '\n')
799 goto error_incomplete_line;
800 c = get_next_char();
801 } while (isspace(c));
803 /* We require the format to be '[base "extension"]' */
804 if (c != '"')
805 return -1;
806 strbuf_addch(name, '.');
808 for (;;) {
809 int c = get_next_char();
810 if (c == '\n')
811 goto error_incomplete_line;
812 if (c == '"')
813 break;
814 if (c == '\\') {
815 c = get_next_char();
816 if (c == '\n')
817 goto error_incomplete_line;
819 strbuf_addch(name, c);
822 /* Final ']' */
823 if (get_next_char() != ']')
824 return -1;
825 return 0;
826 error_incomplete_line:
827 cf->linenr--;
828 return -1;
831 static int get_base_var(struct strbuf *name)
833 cf->subsection_case_sensitive = 1;
834 for (;;) {
835 int c = get_next_char();
836 if (cf->eof)
837 return -1;
838 if (c == ']')
839 return 0;
840 if (isspace(c))
841 return get_extended_base_var(name, c);
842 if (!iskeychar(c) && c != '.')
843 return -1;
844 strbuf_addch(name, tolower(c));
848 struct parse_event_data {
849 enum config_event_t previous_type;
850 size_t previous_offset;
851 const struct config_options *opts;
854 static int do_event(enum config_event_t type, struct parse_event_data *data)
856 size_t offset;
858 if (!data->opts || !data->opts->event_fn)
859 return 0;
861 if (type == CONFIG_EVENT_WHITESPACE &&
862 data->previous_type == type)
863 return 0;
865 offset = cf->do_ftell(cf);
867 * At EOF, the parser always "inserts" an extra '\n', therefore
868 * the end offset of the event is the current file position, otherwise
869 * we will already have advanced to the next event.
871 if (type != CONFIG_EVENT_EOF)
872 offset--;
874 if (data->previous_type != CONFIG_EVENT_EOF &&
875 data->opts->event_fn(data->previous_type, data->previous_offset,
876 offset, data->opts->event_fn_data) < 0)
877 return -1;
879 data->previous_type = type;
880 data->previous_offset = offset;
882 return 0;
885 static int git_parse_source(config_fn_t fn, void *data,
886 const struct config_options *opts)
888 int comment = 0;
889 size_t baselen = 0;
890 struct strbuf *var = &cf->var;
891 int error_return = 0;
892 char *error_msg = NULL;
894 /* U+FEFF Byte Order Mark in UTF8 */
895 const char *bomptr = utf8_bom;
897 /* For the parser event callback */
898 struct parse_event_data event_data = {
899 CONFIG_EVENT_EOF, 0, opts
902 for (;;) {
903 int c;
905 c = get_next_char();
906 if (bomptr && *bomptr) {
907 /* We are at the file beginning; skip UTF8-encoded BOM
908 * if present. Sane editors won't put this in on their
909 * own, but e.g. Windows Notepad will do it happily. */
910 if (c == (*bomptr & 0377)) {
911 bomptr++;
912 continue;
913 } else {
914 /* Do not tolerate partial BOM. */
915 if (bomptr != utf8_bom)
916 break;
917 /* No BOM at file beginning. Cool. */
918 bomptr = NULL;
921 if (c == '\n') {
922 if (cf->eof) {
923 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
924 return -1;
925 return 0;
927 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
928 return -1;
929 comment = 0;
930 continue;
932 if (comment)
933 continue;
934 if (isspace(c)) {
935 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
936 return -1;
937 continue;
939 if (c == '#' || c == ';') {
940 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
941 return -1;
942 comment = 1;
943 continue;
945 if (c == '[') {
946 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
947 return -1;
949 /* Reset prior to determining a new stem */
950 strbuf_reset(var);
951 if (get_base_var(var) < 0 || var->len < 1)
952 break;
953 strbuf_addch(var, '.');
954 baselen = var->len;
955 continue;
957 if (!isalpha(c))
958 break;
960 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
961 return -1;
964 * Truncate the var name back to the section header
965 * stem prior to grabbing the suffix part of the name
966 * and the value.
968 strbuf_setlen(var, baselen);
969 strbuf_addch(var, tolower(c));
970 if (get_value(fn, data, var) < 0)
971 break;
974 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
975 return -1;
977 switch (cf->origin_type) {
978 case CONFIG_ORIGIN_BLOB:
979 error_msg = xstrfmt(_("bad config line %d in blob %s"),
980 cf->linenr, cf->name);
981 break;
982 case CONFIG_ORIGIN_FILE:
983 error_msg = xstrfmt(_("bad config line %d in file %s"),
984 cf->linenr, cf->name);
985 break;
986 case CONFIG_ORIGIN_STDIN:
987 error_msg = xstrfmt(_("bad config line %d in standard input"),
988 cf->linenr);
989 break;
990 case CONFIG_ORIGIN_SUBMODULE_BLOB:
991 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
992 cf->linenr, cf->name);
993 break;
994 case CONFIG_ORIGIN_CMDLINE:
995 error_msg = xstrfmt(_("bad config line %d in command line %s"),
996 cf->linenr, cf->name);
997 break;
998 default:
999 error_msg = xstrfmt(_("bad config line %d in %s"),
1000 cf->linenr, cf->name);
1003 switch (opts && opts->error_action ?
1004 opts->error_action :
1005 cf->default_error_action) {
1006 case CONFIG_ERROR_DIE:
1007 die("%s", error_msg);
1008 break;
1009 case CONFIG_ERROR_ERROR:
1010 error_return = error("%s", error_msg);
1011 break;
1012 case CONFIG_ERROR_SILENT:
1013 error_return = -1;
1014 break;
1015 case CONFIG_ERROR_UNSET:
1016 BUG("config error action unset");
1019 free(error_msg);
1020 return error_return;
1023 static uintmax_t get_unit_factor(const char *end)
1025 if (!*end)
1026 return 1;
1027 else if (!strcasecmp(end, "k"))
1028 return 1024;
1029 else if (!strcasecmp(end, "m"))
1030 return 1024 * 1024;
1031 else if (!strcasecmp(end, "g"))
1032 return 1024 * 1024 * 1024;
1033 return 0;
1036 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1038 if (value && *value) {
1039 char *end;
1040 intmax_t val;
1041 uintmax_t uval;
1042 uintmax_t factor;
1044 errno = 0;
1045 val = strtoimax(value, &end, 0);
1046 if (errno == ERANGE)
1047 return 0;
1048 factor = get_unit_factor(end);
1049 if (!factor) {
1050 errno = EINVAL;
1051 return 0;
1053 uval = val < 0 ? -val : val;
1054 if (unsigned_mult_overflows(factor, uval) ||
1055 factor * uval > max) {
1056 errno = ERANGE;
1057 return 0;
1059 val *= factor;
1060 *ret = val;
1061 return 1;
1063 errno = EINVAL;
1064 return 0;
1067 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1069 if (value && *value) {
1070 char *end;
1071 uintmax_t val;
1072 uintmax_t factor;
1074 errno = 0;
1075 val = strtoumax(value, &end, 0);
1076 if (errno == ERANGE)
1077 return 0;
1078 factor = get_unit_factor(end);
1079 if (!factor) {
1080 errno = EINVAL;
1081 return 0;
1083 if (unsigned_mult_overflows(factor, val) ||
1084 factor * val > max) {
1085 errno = ERANGE;
1086 return 0;
1088 val *= factor;
1089 *ret = val;
1090 return 1;
1092 errno = EINVAL;
1093 return 0;
1096 static int git_parse_int(const char *value, int *ret)
1098 intmax_t tmp;
1099 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1100 return 0;
1101 *ret = tmp;
1102 return 1;
1105 static int git_parse_int64(const char *value, int64_t *ret)
1107 intmax_t tmp;
1108 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1109 return 0;
1110 *ret = tmp;
1111 return 1;
1114 int git_parse_ulong(const char *value, unsigned long *ret)
1116 uintmax_t tmp;
1117 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1118 return 0;
1119 *ret = tmp;
1120 return 1;
1123 int git_parse_ssize_t(const char *value, ssize_t *ret)
1125 intmax_t tmp;
1126 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1127 return 0;
1128 *ret = tmp;
1129 return 1;
1132 NORETURN
1133 static void die_bad_number(const char *name, const char *value)
1135 const char *error_type = (errno == ERANGE) ?
1136 N_("out of range") : N_("invalid unit");
1137 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1139 if (!value)
1140 value = "";
1142 if (!(cf && cf->name))
1143 die(_(bad_numeric), value, name, _(error_type));
1145 switch (cf->origin_type) {
1146 case CONFIG_ORIGIN_BLOB:
1147 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1148 value, name, cf->name, _(error_type));
1149 case CONFIG_ORIGIN_FILE:
1150 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1151 value, name, cf->name, _(error_type));
1152 case CONFIG_ORIGIN_STDIN:
1153 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1154 value, name, _(error_type));
1155 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1156 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1157 value, name, cf->name, _(error_type));
1158 case CONFIG_ORIGIN_CMDLINE:
1159 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1160 value, name, cf->name, _(error_type));
1161 default:
1162 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1163 value, name, cf->name, _(error_type));
1167 int git_config_int(const char *name, const char *value)
1169 int ret;
1170 if (!git_parse_int(value, &ret))
1171 die_bad_number(name, value);
1172 return ret;
1175 int64_t git_config_int64(const char *name, const char *value)
1177 int64_t ret;
1178 if (!git_parse_int64(value, &ret))
1179 die_bad_number(name, value);
1180 return ret;
1183 unsigned long git_config_ulong(const char *name, const char *value)
1185 unsigned long ret;
1186 if (!git_parse_ulong(value, &ret))
1187 die_bad_number(name, value);
1188 return ret;
1191 ssize_t git_config_ssize_t(const char *name, const char *value)
1193 ssize_t ret;
1194 if (!git_parse_ssize_t(value, &ret))
1195 die_bad_number(name, value);
1196 return ret;
1199 static int git_parse_maybe_bool_text(const char *value)
1201 if (!value)
1202 return 1;
1203 if (!*value)
1204 return 0;
1205 if (!strcasecmp(value, "true")
1206 || !strcasecmp(value, "yes")
1207 || !strcasecmp(value, "on"))
1208 return 1;
1209 if (!strcasecmp(value, "false")
1210 || !strcasecmp(value, "no")
1211 || !strcasecmp(value, "off"))
1212 return 0;
1213 return -1;
1216 int git_parse_maybe_bool(const char *value)
1218 int v = git_parse_maybe_bool_text(value);
1219 if (0 <= v)
1220 return v;
1221 if (git_parse_int(value, &v))
1222 return !!v;
1223 return -1;
1226 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1228 int v = git_parse_maybe_bool_text(value);
1229 if (0 <= v) {
1230 *is_bool = 1;
1231 return v;
1233 *is_bool = 0;
1234 return git_config_int(name, value);
1237 int git_config_bool(const char *name, const char *value)
1239 int v = git_parse_maybe_bool(value);
1240 if (v < 0)
1241 die(_("bad boolean config value '%s' for '%s'"), value, name);
1242 return v;
1245 int git_config_string(const char **dest, const char *var, const char *value)
1247 if (!value)
1248 return config_error_nonbool(var);
1249 *dest = xstrdup(value);
1250 return 0;
1253 int git_config_pathname(const char **dest, const char *var, const char *value)
1255 if (!value)
1256 return config_error_nonbool(var);
1257 *dest = interpolate_path(value, 0);
1258 if (!*dest)
1259 die(_("failed to expand user dir in: '%s'"), value);
1260 return 0;
1263 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1265 if (!value)
1266 return config_error_nonbool(var);
1267 if (parse_expiry_date(value, timestamp))
1268 return error(_("'%s' for '%s' is not a valid timestamp"),
1269 value, var);
1270 return 0;
1273 int git_config_color(char *dest, const char *var, const char *value)
1275 if (!value)
1276 return config_error_nonbool(var);
1277 if (color_parse(value, dest) < 0)
1278 return -1;
1279 return 0;
1282 static int git_default_core_config(const char *var, const char *value, void *cb)
1284 /* This needs a better name */
1285 if (!strcmp(var, "core.filemode")) {
1286 trust_executable_bit = git_config_bool(var, value);
1287 return 0;
1289 if (!strcmp(var, "core.trustctime")) {
1290 trust_ctime = git_config_bool(var, value);
1291 return 0;
1293 if (!strcmp(var, "core.checkstat")) {
1294 if (!strcasecmp(value, "default"))
1295 check_stat = 1;
1296 else if (!strcasecmp(value, "minimal"))
1297 check_stat = 0;
1300 if (!strcmp(var, "core.quotepath")) {
1301 quote_path_fully = git_config_bool(var, value);
1302 return 0;
1305 if (!strcmp(var, "core.symlinks")) {
1306 has_symlinks = git_config_bool(var, value);
1307 return 0;
1310 if (!strcmp(var, "core.ignorecase")) {
1311 ignore_case = git_config_bool(var, value);
1312 return 0;
1315 if (!strcmp(var, "core.attributesfile"))
1316 return git_config_pathname(&git_attributes_file, var, value);
1318 if (!strcmp(var, "core.hookspath"))
1319 return git_config_pathname(&git_hooks_path, var, value);
1321 if (!strcmp(var, "core.bare")) {
1322 is_bare_repository_cfg = git_config_bool(var, value);
1323 return 0;
1326 if (!strcmp(var, "core.ignorestat")) {
1327 assume_unchanged = git_config_bool(var, value);
1328 return 0;
1331 if (!strcmp(var, "core.prefersymlinkrefs")) {
1332 prefer_symlink_refs = git_config_bool(var, value);
1333 return 0;
1336 if (!strcmp(var, "core.logallrefupdates")) {
1337 if (value && !strcasecmp(value, "always"))
1338 log_all_ref_updates = LOG_REFS_ALWAYS;
1339 else if (git_config_bool(var, value))
1340 log_all_ref_updates = LOG_REFS_NORMAL;
1341 else
1342 log_all_ref_updates = LOG_REFS_NONE;
1343 return 0;
1346 if (!strcmp(var, "core.warnambiguousrefs")) {
1347 warn_ambiguous_refs = git_config_bool(var, value);
1348 return 0;
1351 if (!strcmp(var, "core.abbrev")) {
1352 if (!value)
1353 return config_error_nonbool(var);
1354 if (!strcasecmp(value, "auto"))
1355 default_abbrev = -1;
1356 else if (!git_parse_maybe_bool_text(value))
1357 default_abbrev = the_hash_algo->hexsz;
1358 else {
1359 int abbrev = git_config_int(var, value);
1360 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1361 return error(_("abbrev length out of range: %d"), abbrev);
1362 default_abbrev = abbrev;
1364 return 0;
1367 if (!strcmp(var, "core.disambiguate"))
1368 return set_disambiguate_hint_config(var, value);
1370 if (!strcmp(var, "core.loosecompression")) {
1371 int level = git_config_int(var, value);
1372 if (level == -1)
1373 level = Z_DEFAULT_COMPRESSION;
1374 else if (level < 0 || level > Z_BEST_COMPRESSION)
1375 die(_("bad zlib compression level %d"), level);
1376 zlib_compression_level = level;
1377 zlib_compression_seen = 1;
1378 return 0;
1381 if (!strcmp(var, "core.compression")) {
1382 int level = git_config_int(var, value);
1383 if (level == -1)
1384 level = Z_DEFAULT_COMPRESSION;
1385 else if (level < 0 || level > Z_BEST_COMPRESSION)
1386 die(_("bad zlib compression level %d"), level);
1387 if (!zlib_compression_seen)
1388 zlib_compression_level = level;
1389 if (!pack_compression_seen)
1390 pack_compression_level = level;
1391 return 0;
1394 if (!strcmp(var, "core.packedgitwindowsize")) {
1395 int pgsz_x2 = getpagesize() * 2;
1396 packed_git_window_size = git_config_ulong(var, value);
1398 /* This value must be multiple of (pagesize * 2) */
1399 packed_git_window_size /= pgsz_x2;
1400 if (packed_git_window_size < 1)
1401 packed_git_window_size = 1;
1402 packed_git_window_size *= pgsz_x2;
1403 return 0;
1406 if (!strcmp(var, "core.bigfilethreshold")) {
1407 big_file_threshold = git_config_ulong(var, value);
1408 return 0;
1411 if (!strcmp(var, "core.packedgitlimit")) {
1412 packed_git_limit = git_config_ulong(var, value);
1413 return 0;
1416 if (!strcmp(var, "core.deltabasecachelimit")) {
1417 delta_base_cache_limit = git_config_ulong(var, value);
1418 return 0;
1421 if (!strcmp(var, "core.autocrlf")) {
1422 if (value && !strcasecmp(value, "input")) {
1423 auto_crlf = AUTO_CRLF_INPUT;
1424 return 0;
1426 auto_crlf = git_config_bool(var, value);
1427 return 0;
1430 if (!strcmp(var, "core.safecrlf")) {
1431 int eol_rndtrp_die;
1432 if (value && !strcasecmp(value, "warn")) {
1433 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1434 return 0;
1436 eol_rndtrp_die = git_config_bool(var, value);
1437 global_conv_flags_eol = eol_rndtrp_die ?
1438 CONV_EOL_RNDTRP_DIE : 0;
1439 return 0;
1442 if (!strcmp(var, "core.eol")) {
1443 if (value && !strcasecmp(value, "lf"))
1444 core_eol = EOL_LF;
1445 else if (value && !strcasecmp(value, "crlf"))
1446 core_eol = EOL_CRLF;
1447 else if (value && !strcasecmp(value, "native"))
1448 core_eol = EOL_NATIVE;
1449 else
1450 core_eol = EOL_UNSET;
1451 return 0;
1454 if (!strcmp(var, "core.checkroundtripencoding")) {
1455 check_roundtrip_encoding = xstrdup(value);
1456 return 0;
1459 if (!strcmp(var, "core.notesref")) {
1460 notes_ref_name = xstrdup(value);
1461 return 0;
1464 if (!strcmp(var, "core.editor"))
1465 return git_config_string(&editor_program, var, value);
1467 if (!strcmp(var, "core.commentchar")) {
1468 if (!value)
1469 return config_error_nonbool(var);
1470 else if (!strcasecmp(value, "auto"))
1471 auto_comment_line_char = 1;
1472 else if (value[0] && !value[1]) {
1473 comment_line_char = value[0];
1474 auto_comment_line_char = 0;
1475 } else
1476 return error(_("core.commentChar should only be one character"));
1477 return 0;
1480 if (!strcmp(var, "core.askpass"))
1481 return git_config_string(&askpass_program, var, value);
1483 if (!strcmp(var, "core.excludesfile"))
1484 return git_config_pathname(&excludes_file, var, value);
1486 if (!strcmp(var, "core.whitespace")) {
1487 if (!value)
1488 return config_error_nonbool(var);
1489 whitespace_rule_cfg = parse_whitespace_rule(value);
1490 return 0;
1493 if (!strcmp(var, "core.fsyncobjectfiles")) {
1494 fsync_object_files = git_config_bool(var, value);
1495 return 0;
1498 if (!strcmp(var, "core.preloadindex")) {
1499 core_preload_index = git_config_bool(var, value);
1500 return 0;
1503 if (!strcmp(var, "core.createobject")) {
1504 if (!strcmp(value, "rename"))
1505 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1506 else if (!strcmp(value, "link"))
1507 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1508 else
1509 die(_("invalid mode for object creation: %s"), value);
1510 return 0;
1513 if (!strcmp(var, "core.sparsecheckout")) {
1514 core_apply_sparse_checkout = git_config_bool(var, value);
1515 return 0;
1518 if (!strcmp(var, "core.sparsecheckoutcone")) {
1519 core_sparse_checkout_cone = git_config_bool(var, value);
1520 return 0;
1523 if (!strcmp(var, "core.precomposeunicode")) {
1524 precomposed_unicode = git_config_bool(var, value);
1525 return 0;
1528 if (!strcmp(var, "core.protecthfs")) {
1529 protect_hfs = git_config_bool(var, value);
1530 return 0;
1533 if (!strcmp(var, "core.protectntfs")) {
1534 protect_ntfs = git_config_bool(var, value);
1535 return 0;
1538 if (!strcmp(var, "core.usereplacerefs")) {
1539 read_replace_refs = git_config_bool(var, value);
1540 return 0;
1543 /* Add other config variables here and to Documentation/config.txt. */
1544 return platform_core_config(var, value, cb);
1547 static int git_default_i18n_config(const char *var, const char *value)
1549 if (!strcmp(var, "i18n.commitencoding"))
1550 return git_config_string(&git_commit_encoding, var, value);
1552 if (!strcmp(var, "i18n.logoutputencoding"))
1553 return git_config_string(&git_log_output_encoding, var, value);
1555 /* Add other config variables here and to Documentation/config.txt. */
1556 return 0;
1559 static int git_default_branch_config(const char *var, const char *value)
1561 if (!strcmp(var, "branch.autosetupmerge")) {
1562 if (value && !strcasecmp(value, "always")) {
1563 git_branch_track = BRANCH_TRACK_ALWAYS;
1564 return 0;
1566 git_branch_track = git_config_bool(var, value);
1567 return 0;
1569 if (!strcmp(var, "branch.autosetuprebase")) {
1570 if (!value)
1571 return config_error_nonbool(var);
1572 else if (!strcmp(value, "never"))
1573 autorebase = AUTOREBASE_NEVER;
1574 else if (!strcmp(value, "local"))
1575 autorebase = AUTOREBASE_LOCAL;
1576 else if (!strcmp(value, "remote"))
1577 autorebase = AUTOREBASE_REMOTE;
1578 else if (!strcmp(value, "always"))
1579 autorebase = AUTOREBASE_ALWAYS;
1580 else
1581 return error(_("malformed value for %s"), var);
1582 return 0;
1585 /* Add other config variables here and to Documentation/config.txt. */
1586 return 0;
1589 static int git_default_push_config(const char *var, const char *value)
1591 if (!strcmp(var, "push.default")) {
1592 if (!value)
1593 return config_error_nonbool(var);
1594 else if (!strcmp(value, "nothing"))
1595 push_default = PUSH_DEFAULT_NOTHING;
1596 else if (!strcmp(value, "matching"))
1597 push_default = PUSH_DEFAULT_MATCHING;
1598 else if (!strcmp(value, "simple"))
1599 push_default = PUSH_DEFAULT_SIMPLE;
1600 else if (!strcmp(value, "upstream"))
1601 push_default = PUSH_DEFAULT_UPSTREAM;
1602 else if (!strcmp(value, "tracking")) /* deprecated */
1603 push_default = PUSH_DEFAULT_UPSTREAM;
1604 else if (!strcmp(value, "current"))
1605 push_default = PUSH_DEFAULT_CURRENT;
1606 else {
1607 error(_("malformed value for %s: %s"), var, value);
1608 return error(_("must be one of nothing, matching, simple, "
1609 "upstream or current"));
1611 return 0;
1614 /* Add other config variables here and to Documentation/config.txt. */
1615 return 0;
1618 static int git_default_mailmap_config(const char *var, const char *value)
1620 if (!strcmp(var, "mailmap.file"))
1621 return git_config_pathname(&git_mailmap_file, var, value);
1622 if (!strcmp(var, "mailmap.blob"))
1623 return git_config_string(&git_mailmap_blob, var, value);
1625 /* Add other config variables here and to Documentation/config.txt. */
1626 return 0;
1629 int git_default_config(const char *var, const char *value, void *cb)
1631 if (starts_with(var, "core."))
1632 return git_default_core_config(var, value, cb);
1634 if (starts_with(var, "user.") ||
1635 starts_with(var, "author.") ||
1636 starts_with(var, "committer."))
1637 return git_ident_config(var, value, cb);
1639 if (starts_with(var, "i18n."))
1640 return git_default_i18n_config(var, value);
1642 if (starts_with(var, "branch."))
1643 return git_default_branch_config(var, value);
1645 if (starts_with(var, "push."))
1646 return git_default_push_config(var, value);
1648 if (starts_with(var, "mailmap."))
1649 return git_default_mailmap_config(var, value);
1651 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1652 return git_default_advice_config(var, value);
1654 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1655 pager_use_color = git_config_bool(var,value);
1656 return 0;
1659 if (!strcmp(var, "pack.packsizelimit")) {
1660 pack_size_limit_cfg = git_config_ulong(var, value);
1661 return 0;
1664 if (!strcmp(var, "pack.compression")) {
1665 int level = git_config_int(var, value);
1666 if (level == -1)
1667 level = Z_DEFAULT_COMPRESSION;
1668 else if (level < 0 || level > Z_BEST_COMPRESSION)
1669 die(_("bad pack compression level %d"), level);
1670 pack_compression_level = level;
1671 pack_compression_seen = 1;
1672 return 0;
1675 /* Add other config variables here and to Documentation/config.txt. */
1676 return 0;
1680 * All source specific fields in the union, die_on_error, name and the callbacks
1681 * fgetc, ungetc, ftell of top need to be initialized before calling
1682 * this function.
1684 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1685 const struct config_options *opts)
1687 int ret;
1689 /* push config-file parsing state stack */
1690 top->prev = cf;
1691 top->linenr = 1;
1692 top->eof = 0;
1693 top->total_len = 0;
1694 strbuf_init(&top->value, 1024);
1695 strbuf_init(&top->var, 1024);
1696 cf = top;
1698 ret = git_parse_source(fn, data, opts);
1700 /* pop config-file parsing state stack */
1701 strbuf_release(&top->value);
1702 strbuf_release(&top->var);
1703 cf = top->prev;
1705 return ret;
1708 static int do_config_from_file(config_fn_t fn,
1709 const enum config_origin_type origin_type,
1710 const char *name, const char *path, FILE *f,
1711 void *data, const struct config_options *opts)
1713 struct config_source top;
1714 int ret;
1716 top.u.file = f;
1717 top.origin_type = origin_type;
1718 top.name = name;
1719 top.path = path;
1720 top.default_error_action = CONFIG_ERROR_DIE;
1721 top.do_fgetc = config_file_fgetc;
1722 top.do_ungetc = config_file_ungetc;
1723 top.do_ftell = config_file_ftell;
1725 flockfile(f);
1726 ret = do_config_from(&top, fn, data, opts);
1727 funlockfile(f);
1728 return ret;
1731 static int git_config_from_stdin(config_fn_t fn, void *data)
1733 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1734 data, NULL);
1737 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1738 void *data,
1739 const struct config_options *opts)
1741 int ret = -1;
1742 FILE *f;
1744 f = fopen_or_warn(filename, "r");
1745 if (f) {
1746 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1747 filename, f, data, opts);
1748 fclose(f);
1750 return ret;
1753 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1755 return git_config_from_file_with_options(fn, filename, data, NULL);
1758 int git_config_from_mem(config_fn_t fn,
1759 const enum config_origin_type origin_type,
1760 const char *name, const char *buf, size_t len,
1761 void *data, const struct config_options *opts)
1763 struct config_source top;
1765 top.u.buf.buf = buf;
1766 top.u.buf.len = len;
1767 top.u.buf.pos = 0;
1768 top.origin_type = origin_type;
1769 top.name = name;
1770 top.path = NULL;
1771 top.default_error_action = CONFIG_ERROR_ERROR;
1772 top.do_fgetc = config_buf_fgetc;
1773 top.do_ungetc = config_buf_ungetc;
1774 top.do_ftell = config_buf_ftell;
1776 return do_config_from(&top, fn, data, opts);
1779 int git_config_from_blob_oid(config_fn_t fn,
1780 const char *name,
1781 struct repository *repo,
1782 const struct object_id *oid,
1783 void *data)
1785 enum object_type type;
1786 char *buf;
1787 unsigned long size;
1788 int ret;
1790 buf = repo_read_object_file(repo, oid, &type, &size);
1791 if (!buf)
1792 return error(_("unable to load config blob object '%s'"), name);
1793 if (type != OBJ_BLOB) {
1794 free(buf);
1795 return error(_("reference '%s' does not point to a blob"), name);
1798 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1799 data, NULL);
1800 free(buf);
1802 return ret;
1805 static int git_config_from_blob_ref(config_fn_t fn,
1806 struct repository *repo,
1807 const char *name,
1808 void *data)
1810 struct object_id oid;
1812 if (repo_get_oid(repo, name, &oid) < 0)
1813 return error(_("unable to resolve config blob '%s'"), name);
1814 return git_config_from_blob_oid(fn, name, repo, &oid, data);
1817 char *git_system_config(void)
1819 char *system_config = xstrdup_or_null(getenv("GIT_CONFIG_SYSTEM"));
1820 if (!system_config)
1821 system_config = system_path(ETC_GITCONFIG);
1822 normalize_path_copy(system_config, system_config);
1823 return system_config;
1826 void git_global_config(char **user_out, char **xdg_out)
1828 char *user_config = xstrdup_or_null(getenv("GIT_CONFIG_GLOBAL"));
1829 char *xdg_config = NULL;
1831 if (!user_config) {
1832 user_config = interpolate_path("~/.gitconfig", 0);
1833 xdg_config = xdg_config_home("config");
1836 *user_out = user_config;
1837 *xdg_out = xdg_config;
1841 * Parse environment variable 'k' as a boolean (in various
1842 * possible spellings); if missing, use the default value 'def'.
1844 int git_env_bool(const char *k, int def)
1846 const char *v = getenv(k);
1847 return v ? git_config_bool(k, v) : def;
1851 * Parse environment variable 'k' as ulong with possibly a unit
1852 * suffix; if missing, use the default value 'val'.
1854 unsigned long git_env_ulong(const char *k, unsigned long val)
1856 const char *v = getenv(k);
1857 if (v && !git_parse_ulong(v, &val))
1858 die(_("failed to parse %s"), k);
1859 return val;
1862 int git_config_system(void)
1864 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1867 static int do_git_config_sequence(const struct config_options *opts,
1868 config_fn_t fn, void *data)
1870 int ret = 0;
1871 char *system_config = git_system_config();
1872 char *xdg_config = NULL;
1873 char *user_config = NULL;
1874 char *repo_config;
1875 enum config_scope prev_parsing_scope = current_parsing_scope;
1877 if (opts->commondir)
1878 repo_config = mkpathdup("%s/config", opts->commondir);
1879 else if (opts->git_dir)
1880 BUG("git_dir without commondir");
1881 else
1882 repo_config = NULL;
1884 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1885 if (git_config_system() && system_config &&
1886 !access_or_die(system_config, R_OK,
1887 opts->system_gently ? ACCESS_EACCES_OK : 0))
1888 ret += git_config_from_file(fn, system_config, data);
1890 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1891 git_global_config(&user_config, &xdg_config);
1893 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1894 ret += git_config_from_file(fn, xdg_config, data);
1896 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1897 ret += git_config_from_file(fn, user_config, data);
1899 current_parsing_scope = CONFIG_SCOPE_LOCAL;
1900 if (!opts->ignore_repo && repo_config &&
1901 !access_or_die(repo_config, R_OK, 0))
1902 ret += git_config_from_file(fn, repo_config, data);
1904 current_parsing_scope = CONFIG_SCOPE_WORKTREE;
1905 if (!opts->ignore_worktree && repository_format_worktree_config) {
1906 char *path = git_pathdup("config.worktree");
1907 if (!access_or_die(path, R_OK, 0))
1908 ret += git_config_from_file(fn, path, data);
1909 free(path);
1912 current_parsing_scope = CONFIG_SCOPE_COMMAND;
1913 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
1914 die(_("unable to parse command-line config"));
1916 current_parsing_scope = prev_parsing_scope;
1917 free(system_config);
1918 free(xdg_config);
1919 free(user_config);
1920 free(repo_config);
1921 return ret;
1924 int config_with_options(config_fn_t fn, void *data,
1925 struct git_config_source *config_source,
1926 const struct config_options *opts)
1928 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1930 if (opts->respect_includes) {
1931 inc.fn = fn;
1932 inc.data = data;
1933 inc.opts = opts;
1934 fn = git_config_include;
1935 data = &inc;
1938 if (config_source)
1939 current_parsing_scope = config_source->scope;
1942 * If we have a specific filename, use it. Otherwise, follow the
1943 * regular lookup sequence.
1945 if (config_source && config_source->use_stdin) {
1946 return git_config_from_stdin(fn, data);
1947 } else if (config_source && config_source->file) {
1948 return git_config_from_file(fn, config_source->file, data);
1949 } else if (config_source && config_source->blob) {
1950 struct repository *repo = config_source->repo ?
1951 config_source->repo : the_repository;
1952 return git_config_from_blob_ref(fn, repo, config_source->blob,
1953 data);
1956 return do_git_config_sequence(opts, fn, data);
1959 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1961 int i, value_index;
1962 struct string_list *values;
1963 struct config_set_element *entry;
1964 struct configset_list *list = &cs->list;
1966 for (i = 0; i < list->nr; i++) {
1967 entry = list->items[i].e;
1968 value_index = list->items[i].value_index;
1969 values = &entry->value_list;
1971 current_config_kvi = values->items[value_index].util;
1973 if (fn(entry->key, values->items[value_index].string, data) < 0)
1974 git_die_config_linenr(entry->key,
1975 current_config_kvi->filename,
1976 current_config_kvi->linenr);
1978 current_config_kvi = NULL;
1982 void read_early_config(config_fn_t cb, void *data)
1984 struct config_options opts = {0};
1985 struct strbuf commondir = STRBUF_INIT;
1986 struct strbuf gitdir = STRBUF_INIT;
1988 opts.respect_includes = 1;
1990 if (have_git_dir()) {
1991 opts.commondir = get_git_common_dir();
1992 opts.git_dir = get_git_dir();
1994 * When setup_git_directory() was not yet asked to discover the
1995 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1996 * is any repository config we should use (but unlike
1997 * setup_git_directory_gently(), no global state is changed, most
1998 * notably, the current working directory is still the same after the
1999 * call).
2001 } else if (!discover_git_directory(&commondir, &gitdir)) {
2002 opts.commondir = commondir.buf;
2003 opts.git_dir = gitdir.buf;
2006 config_with_options(cb, data, NULL, &opts);
2008 strbuf_release(&commondir);
2009 strbuf_release(&gitdir);
2013 * Read config but only enumerate system and global settings.
2014 * Omit any repo-local, worktree-local, or command-line settings.
2016 void read_very_early_config(config_fn_t cb, void *data)
2018 struct config_options opts = { 0 };
2020 opts.respect_includes = 1;
2021 opts.ignore_repo = 1;
2022 opts.ignore_worktree = 1;
2023 opts.ignore_cmdline = 1;
2024 opts.system_gently = 1;
2026 config_with_options(cb, data, NULL, &opts);
2029 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
2031 struct config_set_element k;
2032 struct config_set_element *found_entry;
2033 char *normalized_key;
2035 * `key` may come from the user, so normalize it before using it
2036 * for querying entries from the hashmap.
2038 if (git_config_parse_key(key, &normalized_key, NULL))
2039 return NULL;
2041 hashmap_entry_init(&k.ent, strhash(normalized_key));
2042 k.key = normalized_key;
2043 found_entry = hashmap_get_entry(&cs->config_hash, &k, ent, NULL);
2044 free(normalized_key);
2045 return found_entry;
2048 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
2050 struct config_set_element *e;
2051 struct string_list_item *si;
2052 struct configset_list_item *l_item;
2053 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2055 e = configset_find_element(cs, key);
2057 * Since the keys are being fed by git_config*() callback mechanism, they
2058 * are already normalized. So simply add them without any further munging.
2060 if (!e) {
2061 e = xmalloc(sizeof(*e));
2062 hashmap_entry_init(&e->ent, strhash(key));
2063 e->key = xstrdup(key);
2064 string_list_init_dup(&e->value_list);
2065 hashmap_add(&cs->config_hash, &e->ent);
2067 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2069 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
2070 l_item = &cs->list.items[cs->list.nr++];
2071 l_item->e = e;
2072 l_item->value_index = e->value_list.nr - 1;
2074 if (!cf)
2075 BUG("configset_add_value has no source");
2076 if (cf->name) {
2077 kv_info->filename = strintern(cf->name);
2078 kv_info->linenr = cf->linenr;
2079 kv_info->origin_type = cf->origin_type;
2080 } else {
2081 /* for values read from `git_config_from_parameters()` */
2082 kv_info->filename = NULL;
2083 kv_info->linenr = -1;
2084 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
2086 kv_info->scope = current_parsing_scope;
2087 si->util = kv_info;
2089 return 0;
2092 static int config_set_element_cmp(const void *unused_cmp_data,
2093 const struct hashmap_entry *eptr,
2094 const struct hashmap_entry *entry_or_key,
2095 const void *unused_keydata)
2097 const struct config_set_element *e1, *e2;
2099 e1 = container_of(eptr, const struct config_set_element, ent);
2100 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2102 return strcmp(e1->key, e2->key);
2105 void git_configset_init(struct config_set *cs)
2107 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
2108 cs->hash_initialized = 1;
2109 cs->list.nr = 0;
2110 cs->list.alloc = 0;
2111 cs->list.items = NULL;
2114 void git_configset_clear(struct config_set *cs)
2116 struct config_set_element *entry;
2117 struct hashmap_iter iter;
2118 if (!cs->hash_initialized)
2119 return;
2121 hashmap_for_each_entry(&cs->config_hash, &iter, entry,
2122 ent /* member name */) {
2123 free(entry->key);
2124 string_list_clear(&entry->value_list, 1);
2126 hashmap_clear_and_free(&cs->config_hash, struct config_set_element, ent);
2127 cs->hash_initialized = 0;
2128 free(cs->list.items);
2129 cs->list.nr = 0;
2130 cs->list.alloc = 0;
2131 cs->list.items = NULL;
2134 static int config_set_callback(const char *key, const char *value, void *cb)
2136 struct config_set *cs = cb;
2137 configset_add_value(cs, key, value);
2138 return 0;
2141 int git_configset_add_file(struct config_set *cs, const char *filename)
2143 return git_config_from_file(config_set_callback, filename, cs);
2146 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
2148 const struct string_list *values = NULL;
2150 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2151 * queried key in the files of the configset, the value returned will be the last
2152 * value in the value list for that key.
2154 values = git_configset_get_value_multi(cs, key);
2156 if (!values)
2157 return 1;
2158 assert(values->nr > 0);
2159 *value = values->items[values->nr - 1].string;
2160 return 0;
2163 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
2165 struct config_set_element *e = configset_find_element(cs, key);
2166 return e ? &e->value_list : NULL;
2169 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
2171 const char *value;
2172 if (!git_configset_get_value(cs, key, &value))
2173 return git_config_string((const char **)dest, key, value);
2174 else
2175 return 1;
2178 int git_configset_get_string_tmp(struct config_set *cs, const char *key,
2179 const char **dest)
2181 const char *value;
2182 if (!git_configset_get_value(cs, key, &value)) {
2183 if (!value)
2184 return config_error_nonbool(key);
2185 *dest = value;
2186 return 0;
2187 } else {
2188 return 1;
2192 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
2194 const char *value;
2195 if (!git_configset_get_value(cs, key, &value)) {
2196 *dest = git_config_int(key, value);
2197 return 0;
2198 } else
2199 return 1;
2202 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
2204 const char *value;
2205 if (!git_configset_get_value(cs, key, &value)) {
2206 *dest = git_config_ulong(key, value);
2207 return 0;
2208 } else
2209 return 1;
2212 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
2214 const char *value;
2215 if (!git_configset_get_value(cs, key, &value)) {
2216 *dest = git_config_bool(key, value);
2217 return 0;
2218 } else
2219 return 1;
2222 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
2223 int *is_bool, int *dest)
2225 const char *value;
2226 if (!git_configset_get_value(cs, key, &value)) {
2227 *dest = git_config_bool_or_int(key, value, is_bool);
2228 return 0;
2229 } else
2230 return 1;
2233 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2235 const char *value;
2236 if (!git_configset_get_value(cs, key, &value)) {
2237 *dest = git_parse_maybe_bool(value);
2238 if (*dest == -1)
2239 return -1;
2240 return 0;
2241 } else
2242 return 1;
2245 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2247 const char *value;
2248 if (!git_configset_get_value(cs, key, &value))
2249 return git_config_pathname(dest, key, value);
2250 else
2251 return 1;
2254 /* Functions use to read configuration from a repository */
2255 static void repo_read_config(struct repository *repo)
2257 struct config_options opts = { 0 };
2259 opts.respect_includes = 1;
2260 opts.commondir = repo->commondir;
2261 opts.git_dir = repo->gitdir;
2263 if (!repo->config)
2264 CALLOC_ARRAY(repo->config, 1);
2265 else
2266 git_configset_clear(repo->config);
2268 git_configset_init(repo->config);
2270 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2272 * config_with_options() normally returns only
2273 * zero, as most errors are fatal, and
2274 * non-fatal potential errors are guarded by "if"
2275 * statements that are entered only when no error is
2276 * possible.
2278 * If we ever encounter a non-fatal error, it means
2279 * something went really wrong and we should stop
2280 * immediately.
2282 die(_("unknown error occurred while reading the configuration files"));
2285 static void git_config_check_init(struct repository *repo)
2287 if (repo->config && repo->config->hash_initialized)
2288 return;
2289 repo_read_config(repo);
2292 static void repo_config_clear(struct repository *repo)
2294 if (!repo->config || !repo->config->hash_initialized)
2295 return;
2296 git_configset_clear(repo->config);
2299 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2301 git_config_check_init(repo);
2302 configset_iter(repo->config, fn, data);
2305 int repo_config_get_value(struct repository *repo,
2306 const char *key, const char **value)
2308 git_config_check_init(repo);
2309 return git_configset_get_value(repo->config, key, value);
2312 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2313 const char *key)
2315 git_config_check_init(repo);
2316 return git_configset_get_value_multi(repo->config, key);
2319 int repo_config_get_string(struct repository *repo,
2320 const char *key, char **dest)
2322 int ret;
2323 git_config_check_init(repo);
2324 ret = git_configset_get_string(repo->config, key, dest);
2325 if (ret < 0)
2326 git_die_config(key, NULL);
2327 return ret;
2330 int repo_config_get_string_tmp(struct repository *repo,
2331 const char *key, const char **dest)
2333 int ret;
2334 git_config_check_init(repo);
2335 ret = git_configset_get_string_tmp(repo->config, key, dest);
2336 if (ret < 0)
2337 git_die_config(key, NULL);
2338 return ret;
2341 int repo_config_get_int(struct repository *repo,
2342 const char *key, int *dest)
2344 git_config_check_init(repo);
2345 return git_configset_get_int(repo->config, key, dest);
2348 int repo_config_get_ulong(struct repository *repo,
2349 const char *key, unsigned long *dest)
2351 git_config_check_init(repo);
2352 return git_configset_get_ulong(repo->config, key, dest);
2355 int repo_config_get_bool(struct repository *repo,
2356 const char *key, int *dest)
2358 git_config_check_init(repo);
2359 return git_configset_get_bool(repo->config, key, dest);
2362 int repo_config_get_bool_or_int(struct repository *repo,
2363 const char *key, int *is_bool, int *dest)
2365 git_config_check_init(repo);
2366 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2369 int repo_config_get_maybe_bool(struct repository *repo,
2370 const char *key, int *dest)
2372 git_config_check_init(repo);
2373 return git_configset_get_maybe_bool(repo->config, key, dest);
2376 int repo_config_get_pathname(struct repository *repo,
2377 const char *key, const char **dest)
2379 int ret;
2380 git_config_check_init(repo);
2381 ret = git_configset_get_pathname(repo->config, key, dest);
2382 if (ret < 0)
2383 git_die_config(key, NULL);
2384 return ret;
2387 /* Functions used historically to read configuration from 'the_repository' */
2388 void git_config(config_fn_t fn, void *data)
2390 repo_config(the_repository, fn, data);
2393 void git_config_clear(void)
2395 repo_config_clear(the_repository);
2398 int git_config_get_value(const char *key, const char **value)
2400 return repo_config_get_value(the_repository, key, value);
2403 const struct string_list *git_config_get_value_multi(const char *key)
2405 return repo_config_get_value_multi(the_repository, key);
2408 int git_config_get_string(const char *key, char **dest)
2410 return repo_config_get_string(the_repository, key, dest);
2413 int git_config_get_string_tmp(const char *key, const char **dest)
2415 return repo_config_get_string_tmp(the_repository, key, dest);
2418 int git_config_get_int(const char *key, int *dest)
2420 return repo_config_get_int(the_repository, key, dest);
2423 int git_config_get_ulong(const char *key, unsigned long *dest)
2425 return repo_config_get_ulong(the_repository, key, dest);
2428 int git_config_get_bool(const char *key, int *dest)
2430 return repo_config_get_bool(the_repository, key, dest);
2433 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2435 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2438 int git_config_get_maybe_bool(const char *key, int *dest)
2440 return repo_config_get_maybe_bool(the_repository, key, dest);
2443 int git_config_get_pathname(const char *key, const char **dest)
2445 return repo_config_get_pathname(the_repository, key, dest);
2448 int git_config_get_expiry(const char *key, const char **output)
2450 int ret = git_config_get_string(key, (char **)output);
2451 if (ret)
2452 return ret;
2453 if (strcmp(*output, "now")) {
2454 timestamp_t now = approxidate("now");
2455 if (approxidate(*output) >= now)
2456 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2458 return ret;
2461 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2463 const char *expiry_string;
2464 intmax_t days;
2465 timestamp_t when;
2467 if (git_config_get_string_tmp(key, &expiry_string))
2468 return 1; /* no such thing */
2470 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2471 const int scale = 86400;
2472 *expiry = now - days * scale;
2473 return 0;
2476 if (!parse_expiry_date(expiry_string, &when)) {
2477 *expiry = when;
2478 return 0;
2480 return -1; /* thing exists but cannot be parsed */
2483 int git_config_get_split_index(void)
2485 int val;
2487 if (!git_config_get_maybe_bool("core.splitindex", &val))
2488 return val;
2490 return -1; /* default value */
2493 int git_config_get_max_percent_split_change(void)
2495 int val = -1;
2497 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2498 if (0 <= val && val <= 100)
2499 return val;
2501 return error(_("splitIndex.maxPercentChange value '%d' "
2502 "should be between 0 and 100"), val);
2505 return -1; /* default value */
2508 int git_config_get_fsmonitor(void)
2510 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2511 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2513 if (core_fsmonitor && !*core_fsmonitor)
2514 core_fsmonitor = NULL;
2516 if (core_fsmonitor)
2517 return 1;
2519 return 0;
2522 int git_config_get_index_threads(int *dest)
2524 int is_bool, val;
2526 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2527 if (val) {
2528 *dest = val;
2529 return 0;
2532 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2533 if (is_bool)
2534 *dest = val ? 0 : 1;
2535 else
2536 *dest = val;
2537 return 0;
2540 return 1;
2543 NORETURN
2544 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2546 if (!filename)
2547 die(_("unable to parse '%s' from command-line config"), key);
2548 else
2549 die(_("bad config variable '%s' in file '%s' at line %d"),
2550 key, filename, linenr);
2553 NORETURN __attribute__((format(printf, 2, 3)))
2554 void git_die_config(const char *key, const char *err, ...)
2556 const struct string_list *values;
2557 struct key_value_info *kv_info;
2559 if (err) {
2560 va_list params;
2561 va_start(params, err);
2562 vreportf("error: ", err, params);
2563 va_end(params);
2565 values = git_config_get_value_multi(key);
2566 kv_info = values->items[values->nr - 1].util;
2567 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2571 * Find all the stuff for git_config_set() below.
2574 struct config_store_data {
2575 size_t baselen;
2576 char *key;
2577 int do_not_match;
2578 const char *fixed_value;
2579 regex_t *value_pattern;
2580 int multi_replace;
2581 struct {
2582 size_t begin, end;
2583 enum config_event_t type;
2584 int is_keys_section;
2585 } *parsed;
2586 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2587 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2590 static void config_store_data_clear(struct config_store_data *store)
2592 free(store->key);
2593 if (store->value_pattern != NULL &&
2594 store->value_pattern != CONFIG_REGEX_NONE) {
2595 regfree(store->value_pattern);
2596 free(store->value_pattern);
2598 free(store->parsed);
2599 free(store->seen);
2600 memset(store, 0, sizeof(*store));
2603 static int matches(const char *key, const char *value,
2604 const struct config_store_data *store)
2606 if (strcmp(key, store->key))
2607 return 0; /* not ours */
2608 if (store->fixed_value)
2609 return !strcmp(store->fixed_value, value);
2610 if (!store->value_pattern)
2611 return 1; /* always matches */
2612 if (store->value_pattern == CONFIG_REGEX_NONE)
2613 return 0; /* never matches */
2615 return store->do_not_match ^
2616 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2619 static int store_aux_event(enum config_event_t type,
2620 size_t begin, size_t end, void *data)
2622 struct config_store_data *store = data;
2624 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2625 store->parsed[store->parsed_nr].begin = begin;
2626 store->parsed[store->parsed_nr].end = end;
2627 store->parsed[store->parsed_nr].type = type;
2629 if (type == CONFIG_EVENT_SECTION) {
2630 int (*cmpfn)(const char *, const char *, size_t);
2632 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2633 return error(_("invalid section name '%s'"), cf->var.buf);
2635 if (cf->subsection_case_sensitive)
2636 cmpfn = strncasecmp;
2637 else
2638 cmpfn = strncmp;
2640 /* Is this the section we were looking for? */
2641 store->is_keys_section =
2642 store->parsed[store->parsed_nr].is_keys_section =
2643 cf->var.len - 1 == store->baselen &&
2644 !cmpfn(cf->var.buf, store->key, store->baselen);
2645 if (store->is_keys_section) {
2646 store->section_seen = 1;
2647 ALLOC_GROW(store->seen, store->seen_nr + 1,
2648 store->seen_alloc);
2649 store->seen[store->seen_nr] = store->parsed_nr;
2653 store->parsed_nr++;
2655 return 0;
2658 static int store_aux(const char *key, const char *value, void *cb)
2660 struct config_store_data *store = cb;
2662 if (store->key_seen) {
2663 if (matches(key, value, store)) {
2664 if (store->seen_nr == 1 && store->multi_replace == 0) {
2665 warning(_("%s has multiple values"), key);
2668 ALLOC_GROW(store->seen, store->seen_nr + 1,
2669 store->seen_alloc);
2671 store->seen[store->seen_nr] = store->parsed_nr;
2672 store->seen_nr++;
2674 } else if (store->is_keys_section) {
2676 * Do not increment matches yet: this may not be a match, but we
2677 * are in the desired section.
2679 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2680 store->seen[store->seen_nr] = store->parsed_nr;
2681 store->section_seen = 1;
2683 if (matches(key, value, store)) {
2684 store->seen_nr++;
2685 store->key_seen = 1;
2689 return 0;
2692 static int write_error(const char *filename)
2694 error(_("failed to write new configuration file %s"), filename);
2696 /* Same error code as "failed to rename". */
2697 return 4;
2700 static struct strbuf store_create_section(const char *key,
2701 const struct config_store_data *store)
2703 const char *dot;
2704 size_t i;
2705 struct strbuf sb = STRBUF_INIT;
2707 dot = memchr(key, '.', store->baselen);
2708 if (dot) {
2709 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2710 for (i = dot - key + 1; i < store->baselen; i++) {
2711 if (key[i] == '"' || key[i] == '\\')
2712 strbuf_addch(&sb, '\\');
2713 strbuf_addch(&sb, key[i]);
2715 strbuf_addstr(&sb, "\"]\n");
2716 } else {
2717 strbuf_addch(&sb, '[');
2718 strbuf_add(&sb, key, store->baselen);
2719 strbuf_addstr(&sb, "]\n");
2722 return sb;
2725 static ssize_t write_section(int fd, const char *key,
2726 const struct config_store_data *store)
2728 struct strbuf sb = store_create_section(key, store);
2729 ssize_t ret;
2731 ret = write_in_full(fd, sb.buf, sb.len);
2732 strbuf_release(&sb);
2734 return ret;
2737 static ssize_t write_pair(int fd, const char *key, const char *value,
2738 const struct config_store_data *store)
2740 int i;
2741 ssize_t ret;
2742 const char *quote = "";
2743 struct strbuf sb = STRBUF_INIT;
2746 * Check to see if the value needs to be surrounded with a dq pair.
2747 * Note that problematic characters are always backslash-quoted; this
2748 * check is about not losing leading or trailing SP and strings that
2749 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2750 * configuration parser.
2752 if (value[0] == ' ')
2753 quote = "\"";
2754 for (i = 0; value[i]; i++)
2755 if (value[i] == ';' || value[i] == '#')
2756 quote = "\"";
2757 if (i && value[i - 1] == ' ')
2758 quote = "\"";
2760 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
2762 for (i = 0; value[i]; i++)
2763 switch (value[i]) {
2764 case '\n':
2765 strbuf_addstr(&sb, "\\n");
2766 break;
2767 case '\t':
2768 strbuf_addstr(&sb, "\\t");
2769 break;
2770 case '"':
2771 case '\\':
2772 strbuf_addch(&sb, '\\');
2773 /* fallthrough */
2774 default:
2775 strbuf_addch(&sb, value[i]);
2776 break;
2778 strbuf_addf(&sb, "%s\n", quote);
2780 ret = write_in_full(fd, sb.buf, sb.len);
2781 strbuf_release(&sb);
2783 return ret;
2787 * If we are about to unset the last key(s) in a section, and if there are
2788 * no comments surrounding (or included in) the section, we will want to
2789 * extend begin/end to remove the entire section.
2791 * Note: the parameter `seen_ptr` points to the index into the store.seen
2792 * array. * This index may be incremented if a section has more than one
2793 * entry (which all are to be removed).
2795 static void maybe_remove_section(struct config_store_data *store,
2796 size_t *begin_offset, size_t *end_offset,
2797 int *seen_ptr)
2799 size_t begin;
2800 int i, seen, section_seen = 0;
2803 * First, ensure that this is the first key, and that there are no
2804 * comments before the entry nor before the section header.
2806 seen = *seen_ptr;
2807 for (i = store->seen[seen]; i > 0; i--) {
2808 enum config_event_t type = store->parsed[i - 1].type;
2810 if (type == CONFIG_EVENT_COMMENT)
2811 /* There is a comment before this entry or section */
2812 return;
2813 if (type == CONFIG_EVENT_ENTRY) {
2814 if (!section_seen)
2815 /* This is not the section's first entry. */
2816 return;
2817 /* We encountered no comment before the section. */
2818 break;
2820 if (type == CONFIG_EVENT_SECTION) {
2821 if (!store->parsed[i - 1].is_keys_section)
2822 break;
2823 section_seen = 1;
2826 begin = store->parsed[i].begin;
2829 * Next, make sure that we are removing the last key(s) in the section,
2830 * and that there are no comments that are possibly about the current
2831 * section.
2833 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2834 enum config_event_t type = store->parsed[i].type;
2836 if (type == CONFIG_EVENT_COMMENT)
2837 return;
2838 if (type == CONFIG_EVENT_SECTION) {
2839 if (store->parsed[i].is_keys_section)
2840 continue;
2841 break;
2843 if (type == CONFIG_EVENT_ENTRY) {
2844 if (++seen < store->seen_nr &&
2845 i == store->seen[seen])
2846 /* We want to remove this entry, too */
2847 continue;
2848 /* There is another entry in this section. */
2849 return;
2854 * We are really removing the last entry/entries from this section, and
2855 * there are no enclosed or surrounding comments. Remove the entire,
2856 * now-empty section.
2858 *seen_ptr = seen;
2859 *begin_offset = begin;
2860 if (i < store->parsed_nr)
2861 *end_offset = store->parsed[i].begin;
2862 else
2863 *end_offset = store->parsed[store->parsed_nr - 1].end;
2866 int git_config_set_in_file_gently(const char *config_filename,
2867 const char *key, const char *value)
2869 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2872 void git_config_set_in_file(const char *config_filename,
2873 const char *key, const char *value)
2875 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2878 int git_config_set_gently(const char *key, const char *value)
2880 return git_config_set_multivar_gently(key, value, NULL, 0);
2883 void git_config_set(const char *key, const char *value)
2885 git_config_set_multivar(key, value, NULL, 0);
2887 trace2_cmd_set_config(key, value);
2891 * If value==NULL, unset in (remove from) config,
2892 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
2893 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
2894 * (only add a new one)
2895 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
2896 * key/values are removed before a single new pair is written. If the
2897 * flag is not present, then replace only the first match.
2899 * Returns 0 on success.
2901 * This function does this:
2903 * - it locks the config file by creating ".git/config.lock"
2905 * - it then parses the config using store_aux() as validator to find
2906 * the position on the key/value pair to replace. If it is to be unset,
2907 * it must be found exactly once.
2909 * - the config file is mmap()ed and the part before the match (if any) is
2910 * written to the lock file, then the changed part and the rest.
2912 * - the config file is removed and the lock file rename()d to it.
2915 int git_config_set_multivar_in_file_gently(const char *config_filename,
2916 const char *key, const char *value,
2917 const char *value_pattern,
2918 unsigned flags)
2920 int fd = -1, in_fd = -1;
2921 int ret;
2922 struct lock_file lock = LOCK_INIT;
2923 char *filename_buf = NULL;
2924 char *contents = NULL;
2925 size_t contents_sz;
2926 struct config_store_data store;
2928 memset(&store, 0, sizeof(store));
2930 /* parse-key returns negative; flip the sign to feed exit(3) */
2931 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2932 if (ret)
2933 goto out_free;
2935 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
2937 if (!config_filename)
2938 config_filename = filename_buf = git_pathdup("config");
2941 * The lock serves a purpose in addition to locking: the new
2942 * contents of .git/config will be written into it.
2944 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2945 if (fd < 0) {
2946 error_errno(_("could not lock config file %s"), config_filename);
2947 ret = CONFIG_NO_LOCK;
2948 goto out_free;
2952 * If .git/config does not exist yet, write a minimal version.
2954 in_fd = open(config_filename, O_RDONLY);
2955 if ( in_fd < 0 ) {
2956 if ( ENOENT != errno ) {
2957 error_errno(_("opening %s"), config_filename);
2958 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2959 goto out_free;
2961 /* if nothing to unset, error out */
2962 if (value == NULL) {
2963 ret = CONFIG_NOTHING_SET;
2964 goto out_free;
2967 free(store.key);
2968 store.key = xstrdup(key);
2969 if (write_section(fd, key, &store) < 0 ||
2970 write_pair(fd, key, value, &store) < 0)
2971 goto write_err_out;
2972 } else {
2973 struct stat st;
2974 size_t copy_begin, copy_end;
2975 int i, new_line = 0;
2976 struct config_options opts;
2978 if (value_pattern == NULL)
2979 store.value_pattern = NULL;
2980 else if (value_pattern == CONFIG_REGEX_NONE)
2981 store.value_pattern = CONFIG_REGEX_NONE;
2982 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
2983 store.fixed_value = value_pattern;
2984 else {
2985 if (value_pattern[0] == '!') {
2986 store.do_not_match = 1;
2987 value_pattern++;
2988 } else
2989 store.do_not_match = 0;
2991 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
2992 if (regcomp(store.value_pattern, value_pattern,
2993 REG_EXTENDED)) {
2994 error(_("invalid pattern: %s"), value_pattern);
2995 FREE_AND_NULL(store.value_pattern);
2996 ret = CONFIG_INVALID_PATTERN;
2997 goto out_free;
3001 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3002 store.parsed[0].end = 0;
3004 memset(&opts, 0, sizeof(opts));
3005 opts.event_fn = store_aux_event;
3006 opts.event_fn_data = &store;
3009 * After this, store.parsed will contain offsets of all the
3010 * parsed elements, and store.seen will contain a list of
3011 * matches, as indices into store.parsed.
3013 * As a side effect, we make sure to transform only a valid
3014 * existing config file.
3016 if (git_config_from_file_with_options(store_aux,
3017 config_filename,
3018 &store, &opts)) {
3019 error(_("invalid config file %s"), config_filename);
3020 ret = CONFIG_INVALID_FILE;
3021 goto out_free;
3024 /* if nothing to unset, or too many matches, error out */
3025 if ((store.seen_nr == 0 && value == NULL) ||
3026 (store.seen_nr > 1 && !store.multi_replace)) {
3027 ret = CONFIG_NOTHING_SET;
3028 goto out_free;
3031 if (fstat(in_fd, &st) == -1) {
3032 error_errno(_("fstat on %s failed"), config_filename);
3033 ret = CONFIG_INVALID_FILE;
3034 goto out_free;
3037 contents_sz = xsize_t(st.st_size);
3038 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3039 MAP_PRIVATE, in_fd, 0);
3040 if (contents == MAP_FAILED) {
3041 if (errno == ENODEV && S_ISDIR(st.st_mode))
3042 errno = EISDIR;
3043 error_errno(_("unable to mmap '%s'%s"),
3044 config_filename, mmap_os_err());
3045 ret = CONFIG_INVALID_FILE;
3046 contents = NULL;
3047 goto out_free;
3049 close(in_fd);
3050 in_fd = -1;
3052 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3053 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3054 ret = CONFIG_NO_WRITE;
3055 goto out_free;
3058 if (store.seen_nr == 0) {
3059 if (!store.seen_alloc) {
3060 /* Did not see key nor section */
3061 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3062 store.seen[0] = store.parsed_nr
3063 - !!store.parsed_nr;
3065 store.seen_nr = 1;
3068 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3069 size_t replace_end;
3070 int j = store.seen[i];
3072 new_line = 0;
3073 if (!store.key_seen) {
3074 copy_end = store.parsed[j].end;
3075 /* include '\n' when copying section header */
3076 if (copy_end > 0 && copy_end < contents_sz &&
3077 contents[copy_end - 1] != '\n' &&
3078 contents[copy_end] == '\n')
3079 copy_end++;
3080 replace_end = copy_end;
3081 } else {
3082 replace_end = store.parsed[j].end;
3083 copy_end = store.parsed[j].begin;
3084 if (!value)
3085 maybe_remove_section(&store,
3086 &copy_end,
3087 &replace_end, &i);
3089 * Swallow preceding white-space on the same
3090 * line.
3092 while (copy_end > 0 ) {
3093 char c = contents[copy_end - 1];
3095 if (isspace(c) && c != '\n')
3096 copy_end--;
3097 else
3098 break;
3102 if (copy_end > 0 && contents[copy_end-1] != '\n')
3103 new_line = 1;
3105 /* write the first part of the config */
3106 if (copy_end > copy_begin) {
3107 if (write_in_full(fd, contents + copy_begin,
3108 copy_end - copy_begin) < 0)
3109 goto write_err_out;
3110 if (new_line &&
3111 write_str_in_full(fd, "\n") < 0)
3112 goto write_err_out;
3114 copy_begin = replace_end;
3117 /* write the pair (value == NULL means unset) */
3118 if (value != NULL) {
3119 if (!store.section_seen) {
3120 if (write_section(fd, key, &store) < 0)
3121 goto write_err_out;
3123 if (write_pair(fd, key, value, &store) < 0)
3124 goto write_err_out;
3127 /* write the rest of the config */
3128 if (copy_begin < contents_sz)
3129 if (write_in_full(fd, contents + copy_begin,
3130 contents_sz - copy_begin) < 0)
3131 goto write_err_out;
3133 munmap(contents, contents_sz);
3134 contents = NULL;
3137 if (commit_lock_file(&lock) < 0) {
3138 error_errno(_("could not write config file %s"), config_filename);
3139 ret = CONFIG_NO_WRITE;
3140 goto out_free;
3143 ret = 0;
3145 /* Invalidate the config cache */
3146 git_config_clear();
3148 out_free:
3149 rollback_lock_file(&lock);
3150 free(filename_buf);
3151 if (contents)
3152 munmap(contents, contents_sz);
3153 if (in_fd >= 0)
3154 close(in_fd);
3155 config_store_data_clear(&store);
3156 return ret;
3158 write_err_out:
3159 ret = write_error(get_lock_file_path(&lock));
3160 goto out_free;
3164 void git_config_set_multivar_in_file(const char *config_filename,
3165 const char *key, const char *value,
3166 const char *value_pattern, unsigned flags)
3168 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3169 value_pattern, flags))
3170 return;
3171 if (value)
3172 die(_("could not set '%s' to '%s'"), key, value);
3173 else
3174 die(_("could not unset '%s'"), key);
3177 int git_config_set_multivar_gently(const char *key, const char *value,
3178 const char *value_pattern, unsigned flags)
3180 return git_config_set_multivar_in_file_gently(NULL, key, value, value_pattern,
3181 flags);
3184 void git_config_set_multivar(const char *key, const char *value,
3185 const char *value_pattern, unsigned flags)
3187 git_config_set_multivar_in_file(NULL, key, value, value_pattern,
3188 flags);
3191 static size_t section_name_match (const char *buf, const char *name)
3193 size_t i = 0, j = 0;
3194 int dot = 0;
3195 if (buf[i] != '[')
3196 return 0;
3197 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3198 if (!dot && isspace(buf[i])) {
3199 dot = 1;
3200 if (name[j++] != '.')
3201 break;
3202 for (i++; isspace(buf[i]); i++)
3203 ; /* do nothing */
3204 if (buf[i] != '"')
3205 break;
3206 continue;
3208 if (buf[i] == '\\' && dot)
3209 i++;
3210 else if (buf[i] == '"' && dot) {
3211 for (i++; isspace(buf[i]); i++)
3212 ; /* do_nothing */
3213 break;
3215 if (buf[i] != name[j++])
3216 break;
3218 if (buf[i] == ']' && name[j] == 0) {
3220 * We match, now just find the right length offset by
3221 * gobbling up any whitespace after it, as well
3223 i++;
3224 for (; buf[i] && isspace(buf[i]); i++)
3225 ; /* do nothing */
3226 return i;
3228 return 0;
3231 static int section_name_is_ok(const char *name)
3233 /* Empty section names are bogus. */
3234 if (!*name)
3235 return 0;
3238 * Before a dot, we must be alphanumeric or dash. After the first dot,
3239 * anything goes, so we can stop checking.
3241 for (; *name && *name != '.'; name++)
3242 if (*name != '-' && !isalnum(*name))
3243 return 0;
3244 return 1;
3247 #define GIT_CONFIG_MAX_LINE_LEN (512 * 1024)
3249 /* if new_name == NULL, the section is removed instead */
3250 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3251 const char *old_name,
3252 const char *new_name, int copy)
3254 int ret = 0, remove = 0;
3255 char *filename_buf = NULL;
3256 struct lock_file lock = LOCK_INIT;
3257 int out_fd;
3258 struct strbuf buf = STRBUF_INIT;
3259 FILE *config_file = NULL;
3260 struct stat st;
3261 struct strbuf copystr = STRBUF_INIT;
3262 struct config_store_data store;
3263 uint32_t line_nr = 0;
3265 memset(&store, 0, sizeof(store));
3267 if (new_name && !section_name_is_ok(new_name)) {
3268 ret = error(_("invalid section name: %s"), new_name);
3269 goto out_no_rollback;
3272 if (!config_filename)
3273 config_filename = filename_buf = git_pathdup("config");
3275 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3276 if (out_fd < 0) {
3277 ret = error(_("could not lock config file %s"), config_filename);
3278 goto out;
3281 if (!(config_file = fopen(config_filename, "rb"))) {
3282 ret = warn_on_fopen_errors(config_filename);
3283 if (ret)
3284 goto out;
3285 /* no config file means nothing to rename, no error */
3286 goto commit_and_out;
3289 if (fstat(fileno(config_file), &st) == -1) {
3290 ret = error_errno(_("fstat on %s failed"), config_filename);
3291 goto out;
3294 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3295 ret = error_errno(_("chmod on %s failed"),
3296 get_lock_file_path(&lock));
3297 goto out;
3300 while (!strbuf_getwholeline(&buf, config_file, '\n')) {
3301 size_t i, length;
3302 int is_section = 0;
3303 char *output = buf.buf;
3305 line_nr++;
3307 if (buf.len >= GIT_CONFIG_MAX_LINE_LEN) {
3308 ret = error(_("refusing to work with overly long line "
3309 "in '%s' on line %"PRIuMAX),
3310 config_filename, (uintmax_t)line_nr);
3311 goto out;
3314 for (i = 0; buf.buf[i] && isspace(buf.buf[i]); i++)
3315 ; /* do nothing */
3316 if (buf.buf[i] == '[') {
3317 /* it's a section */
3318 size_t offset;
3319 is_section = 1;
3322 * When encountering a new section under -c we
3323 * need to flush out any section we're already
3324 * coping and begin anew. There might be
3325 * multiple [branch "$name"] sections.
3327 if (copystr.len > 0) {
3328 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3329 ret = write_error(get_lock_file_path(&lock));
3330 goto out;
3332 strbuf_reset(&copystr);
3335 offset = section_name_match(&buf.buf[i], old_name);
3336 if (offset > 0) {
3337 ret++;
3338 if (new_name == NULL) {
3339 remove = 1;
3340 continue;
3342 store.baselen = strlen(new_name);
3343 if (!copy) {
3344 if (write_section(out_fd, new_name, &store) < 0) {
3345 ret = write_error(get_lock_file_path(&lock));
3346 goto out;
3349 * We wrote out the new section, with
3350 * a newline, now skip the old
3351 * section's length
3353 output += offset + i;
3354 if (strlen(output) > 0) {
3356 * More content means there's
3357 * a declaration to put on the
3358 * next line; indent with a
3359 * tab
3361 output -= 1;
3362 output[0] = '\t';
3364 } else {
3365 copystr = store_create_section(new_name, &store);
3368 remove = 0;
3370 if (remove)
3371 continue;
3372 length = strlen(output);
3374 if (!is_section && copystr.len > 0) {
3375 strbuf_add(&copystr, output, length);
3378 if (write_in_full(out_fd, output, length) < 0) {
3379 ret = write_error(get_lock_file_path(&lock));
3380 goto out;
3385 * Copy a trailing section at the end of the config, won't be
3386 * flushed by the usual "flush because we have a new section
3387 * logic in the loop above.
3389 if (copystr.len > 0) {
3390 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3391 ret = write_error(get_lock_file_path(&lock));
3392 goto out;
3394 strbuf_reset(&copystr);
3397 fclose(config_file);
3398 config_file = NULL;
3399 commit_and_out:
3400 if (commit_lock_file(&lock) < 0)
3401 ret = error_errno(_("could not write config file %s"),
3402 config_filename);
3403 out:
3404 if (config_file)
3405 fclose(config_file);
3406 rollback_lock_file(&lock);
3407 out_no_rollback:
3408 free(filename_buf);
3409 config_store_data_clear(&store);
3410 strbuf_release(&buf);
3411 return ret;
3414 int git_config_rename_section_in_file(const char *config_filename,
3415 const char *old_name, const char *new_name)
3417 return git_config_copy_or_rename_section_in_file(config_filename,
3418 old_name, new_name, 0);
3421 int git_config_rename_section(const char *old_name, const char *new_name)
3423 return git_config_rename_section_in_file(NULL, old_name, new_name);
3426 int git_config_copy_section_in_file(const char *config_filename,
3427 const char *old_name, const char *new_name)
3429 return git_config_copy_or_rename_section_in_file(config_filename,
3430 old_name, new_name, 1);
3433 int git_config_copy_section(const char *old_name, const char *new_name)
3435 return git_config_copy_section_in_file(NULL, old_name, new_name);
3439 * Call this to report error for your variable that should not
3440 * get a boolean value (i.e. "[my] var" means "true").
3442 #undef config_error_nonbool
3443 int config_error_nonbool(const char *var)
3445 return error(_("missing value for '%s'"), var);
3448 int parse_config_key(const char *var,
3449 const char *section,
3450 const char **subsection, size_t *subsection_len,
3451 const char **key)
3453 const char *dot;
3455 /* Does it start with "section." ? */
3456 if (!skip_prefix(var, section, &var) || *var != '.')
3457 return -1;
3460 * Find the key; we don't know yet if we have a subsection, but we must
3461 * parse backwards from the end, since the subsection may have dots in
3462 * it, too.
3464 dot = strrchr(var, '.');
3465 *key = dot + 1;
3467 /* Did we have a subsection at all? */
3468 if (dot == var) {
3469 if (subsection) {
3470 *subsection = NULL;
3471 *subsection_len = 0;
3474 else {
3475 if (!subsection)
3476 return -1;
3477 *subsection = var + 1;
3478 *subsection_len = dot - *subsection;
3481 return 0;
3484 const char *current_config_origin_type(void)
3486 int type;
3487 if (current_config_kvi)
3488 type = current_config_kvi->origin_type;
3489 else if(cf)
3490 type = cf->origin_type;
3491 else
3492 BUG("current_config_origin_type called outside config callback");
3494 switch (type) {
3495 case CONFIG_ORIGIN_BLOB:
3496 return "blob";
3497 case CONFIG_ORIGIN_FILE:
3498 return "file";
3499 case CONFIG_ORIGIN_STDIN:
3500 return "standard input";
3501 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3502 return "submodule-blob";
3503 case CONFIG_ORIGIN_CMDLINE:
3504 return "command line";
3505 default:
3506 BUG("unknown config origin type");
3510 const char *config_scope_name(enum config_scope scope)
3512 switch (scope) {
3513 case CONFIG_SCOPE_SYSTEM:
3514 return "system";
3515 case CONFIG_SCOPE_GLOBAL:
3516 return "global";
3517 case CONFIG_SCOPE_LOCAL:
3518 return "local";
3519 case CONFIG_SCOPE_WORKTREE:
3520 return "worktree";
3521 case CONFIG_SCOPE_COMMAND:
3522 return "command";
3523 case CONFIG_SCOPE_SUBMODULE:
3524 return "submodule";
3525 default:
3526 return "unknown";
3530 const char *current_config_name(void)
3532 const char *name;
3533 if (current_config_kvi)
3534 name = current_config_kvi->filename;
3535 else if (cf)
3536 name = cf->name;
3537 else
3538 BUG("current_config_name called outside config callback");
3539 return name ? name : "";
3542 enum config_scope current_config_scope(void)
3544 if (current_config_kvi)
3545 return current_config_kvi->scope;
3546 else
3547 return current_parsing_scope;
3550 int current_config_line(void)
3552 if (current_config_kvi)
3553 return current_config_kvi->linenr;
3554 else
3555 return cf->linenr;
3558 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3560 int i;
3562 for (i = 0; i < nr_mapping; i++) {
3563 const char *name = mapping[i];
3565 if (name && !strcasecmp(var, name))
3566 return i;
3568 return -1;