Merge branch 'rs/xcalloc-takes-nelem-first'
[git/debian.git] / config.c
blob6428393a4143b7cd9060e31dea039b639b5db22d
1 /*
2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
5 * Copyright (C) Johannes Schindelin, 2005
7 */
8 #include "cache.h"
9 #include "branch.h"
10 #include "config.h"
11 #include "environment.h"
12 #include "repository.h"
13 #include "lockfile.h"
14 #include "exec-cmd.h"
15 #include "strbuf.h"
16 #include "quote.h"
17 #include "hashmap.h"
18 #include "string-list.h"
19 #include "object-store.h"
20 #include "utf8.h"
21 #include "dir.h"
22 #include "color.h"
23 #include "refs.h"
25 struct config_source {
26 struct config_source *prev;
27 union {
28 FILE *file;
29 struct config_buf {
30 const char *buf;
31 size_t len;
32 size_t pos;
33 } buf;
34 } u;
35 enum config_origin_type origin_type;
36 const char *name;
37 const char *path;
38 enum config_error_action default_error_action;
39 int linenr;
40 int eof;
41 size_t total_len;
42 struct strbuf value;
43 struct strbuf var;
44 unsigned subsection_case_sensitive : 1;
46 int (*do_fgetc)(struct config_source *c);
47 int (*do_ungetc)(int c, struct config_source *conf);
48 long (*do_ftell)(struct config_source *c);
52 * These variables record the "current" config source, which
53 * can be accessed by parsing callbacks.
55 * The "cf" variable will be non-NULL only when we are actually parsing a real
56 * config source (file, blob, cmdline, etc).
58 * The "current_config_kvi" variable will be non-NULL only when we are feeding
59 * cached config from a configset into a callback.
61 * They should generally never be non-NULL at the same time. If they are both
62 * NULL, then we aren't parsing anything (and depending on the function looking
63 * at the variables, it's either a bug for it to be called in the first place,
64 * or it's a function which can be reused for non-config purposes, and should
65 * fall back to some sane behavior).
67 static struct config_source *cf;
68 static struct key_value_info *current_config_kvi;
71 * Similar to the variables above, this gives access to the "scope" of the
72 * current value (repo, global, etc). For cached values, it can be found via
73 * the current_config_kvi as above. During parsing, the current value can be
74 * found in this variable. It's not part of "cf" because it transcends a single
75 * file (i.e., a file included from .git/config is still in "repo" scope).
77 static enum config_scope current_parsing_scope;
79 static int core_compression_seen;
80 static int pack_compression_seen;
81 static int zlib_compression_seen;
83 static int config_file_fgetc(struct config_source *conf)
85 return getc_unlocked(conf->u.file);
88 static int config_file_ungetc(int c, struct config_source *conf)
90 return ungetc(c, conf->u.file);
93 static long config_file_ftell(struct config_source *conf)
95 return ftell(conf->u.file);
99 static int config_buf_fgetc(struct config_source *conf)
101 if (conf->u.buf.pos < conf->u.buf.len)
102 return conf->u.buf.buf[conf->u.buf.pos++];
104 return EOF;
107 static int config_buf_ungetc(int c, struct config_source *conf)
109 if (conf->u.buf.pos > 0) {
110 conf->u.buf.pos--;
111 if (conf->u.buf.buf[conf->u.buf.pos] != c)
112 BUG("config_buf can only ungetc the same character");
113 return c;
116 return EOF;
119 static long config_buf_ftell(struct config_source *conf)
121 return conf->u.buf.pos;
124 #define MAX_INCLUDE_DEPTH 10
125 static const char include_depth_advice[] = N_(
126 "exceeded maximum include depth (%d) while including\n"
127 " %s\n"
128 "from\n"
129 " %s\n"
130 "This might be due to circular includes.");
131 static int handle_path_include(const char *path, struct config_include_data *inc)
133 int ret = 0;
134 struct strbuf buf = STRBUF_INIT;
135 char *expanded;
137 if (!path)
138 return config_error_nonbool("include.path");
140 expanded = expand_user_path(path, 0);
141 if (!expanded)
142 return error(_("could not expand include path '%s'"), path);
143 path = expanded;
146 * Use an absolute path as-is, but interpret relative paths
147 * based on the including config file.
149 if (!is_absolute_path(path)) {
150 char *slash;
152 if (!cf || !cf->path)
153 return error(_("relative config includes must come from files"));
155 slash = find_last_dir_sep(cf->path);
156 if (slash)
157 strbuf_add(&buf, cf->path, slash - cf->path + 1);
158 strbuf_addstr(&buf, path);
159 path = buf.buf;
162 if (!access_or_die(path, R_OK, 0)) {
163 if (++inc->depth > MAX_INCLUDE_DEPTH)
164 die(_(include_depth_advice), MAX_INCLUDE_DEPTH, path,
165 !cf ? "<unknown>" :
166 cf->name ? cf->name :
167 "the command line");
168 ret = git_config_from_file(git_config_include, path, inc);
169 inc->depth--;
171 strbuf_release(&buf);
172 free(expanded);
173 return ret;
176 static void add_trailing_starstar_for_dir(struct strbuf *pat)
178 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
179 strbuf_addstr(pat, "**");
182 static int prepare_include_condition_pattern(struct strbuf *pat)
184 struct strbuf path = STRBUF_INIT;
185 char *expanded;
186 int prefix = 0;
188 expanded = expand_user_path(pat->buf, 1);
189 if (expanded) {
190 strbuf_reset(pat);
191 strbuf_addstr(pat, expanded);
192 free(expanded);
195 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
196 const char *slash;
198 if (!cf || !cf->path)
199 return error(_("relative config include "
200 "conditionals must come from files"));
202 strbuf_realpath(&path, cf->path, 1);
203 slash = find_last_dir_sep(path.buf);
204 if (!slash)
205 BUG("how is this possible?");
206 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
207 prefix = slash - path.buf + 1 /* slash */;
208 } else if (!is_absolute_path(pat->buf))
209 strbuf_insertstr(pat, 0, "**/");
211 add_trailing_starstar_for_dir(pat);
213 strbuf_release(&path);
214 return prefix;
217 static int include_by_gitdir(const struct config_options *opts,
218 const char *cond, size_t cond_len, int icase)
220 struct strbuf text = STRBUF_INIT;
221 struct strbuf pattern = STRBUF_INIT;
222 int ret = 0, prefix;
223 const char *git_dir;
224 int already_tried_absolute = 0;
226 if (opts->git_dir)
227 git_dir = opts->git_dir;
228 else
229 goto done;
231 strbuf_realpath(&text, git_dir, 1);
232 strbuf_add(&pattern, cond, cond_len);
233 prefix = prepare_include_condition_pattern(&pattern);
235 again:
236 if (prefix < 0)
237 goto done;
239 if (prefix > 0) {
241 * perform literal matching on the prefix part so that
242 * any wildcard character in it can't create side effects.
244 if (text.len < prefix)
245 goto done;
246 if (!icase && strncmp(pattern.buf, text.buf, prefix))
247 goto done;
248 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
249 goto done;
252 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
253 WM_PATHNAME | (icase ? WM_CASEFOLD : 0));
255 if (!ret && !already_tried_absolute) {
257 * We've tried e.g. matching gitdir:~/work, but if
258 * ~/work is a symlink to /mnt/storage/work
259 * strbuf_realpath() will expand it, so the rule won't
260 * match. Let's match against a
261 * strbuf_add_absolute_path() version of the path,
262 * which'll do the right thing
264 strbuf_reset(&text);
265 strbuf_add_absolute_path(&text, git_dir);
266 already_tried_absolute = 1;
267 goto again;
269 done:
270 strbuf_release(&pattern);
271 strbuf_release(&text);
272 return ret;
275 static int include_by_branch(const char *cond, size_t cond_len)
277 int flags;
278 int ret;
279 struct strbuf pattern = STRBUF_INIT;
280 const char *refname = !the_repository->gitdir ?
281 NULL : resolve_ref_unsafe("HEAD", 0, NULL, &flags);
282 const char *shortname;
284 if (!refname || !(flags & REF_ISSYMREF) ||
285 !skip_prefix(refname, "refs/heads/", &shortname))
286 return 0;
288 strbuf_add(&pattern, cond, cond_len);
289 add_trailing_starstar_for_dir(&pattern);
290 ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
291 strbuf_release(&pattern);
292 return ret;
295 static int include_condition_is_true(const struct config_options *opts,
296 const char *cond, size_t cond_len)
299 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
300 return include_by_gitdir(opts, cond, cond_len, 0);
301 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
302 return include_by_gitdir(opts, cond, cond_len, 1);
303 else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
304 return include_by_branch(cond, cond_len);
306 /* unknown conditionals are always false */
307 return 0;
310 int git_config_include(const char *var, const char *value, void *data)
312 struct config_include_data *inc = data;
313 const char *cond, *key;
314 size_t cond_len;
315 int ret;
318 * Pass along all values, including "include" directives; this makes it
319 * possible to query information on the includes themselves.
321 ret = inc->fn(var, value, inc->data);
322 if (ret < 0)
323 return ret;
325 if (!strcmp(var, "include.path"))
326 ret = handle_path_include(value, inc);
328 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
329 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
330 !strcmp(key, "path"))
331 ret = handle_path_include(value, inc);
333 return ret;
336 static void git_config_push_split_parameter(const char *key, const char *value)
338 struct strbuf env = STRBUF_INIT;
339 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
340 if (old && *old) {
341 strbuf_addstr(&env, old);
342 strbuf_addch(&env, ' ');
344 sq_quote_buf(&env, key);
345 strbuf_addch(&env, '=');
346 if (value)
347 sq_quote_buf(&env, value);
348 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
349 strbuf_release(&env);
352 void git_config_push_parameter(const char *text)
354 const char *value;
357 * When we see:
359 * section.subsection=with=equals.key=value
361 * we cannot tell if it means:
363 * [section "subsection=with=equals"]
364 * key = value
366 * or:
368 * [section]
369 * subsection = with=equals.key=value
371 * We parse left-to-right for the first "=", meaning we'll prefer to
372 * keep the value intact over the subsection. This is historical, but
373 * also sensible since values are more likely to contain odd or
374 * untrusted input than a section name.
376 * A missing equals is explicitly allowed (as a bool-only entry).
378 value = strchr(text, '=');
379 if (value) {
380 char *key = xmemdupz(text, value - text);
381 git_config_push_split_parameter(key, value + 1);
382 free(key);
383 } else {
384 git_config_push_split_parameter(text, NULL);
388 void git_config_push_env(const char *spec)
390 char *key;
391 const char *env_name;
392 const char *env_value;
394 env_name = strrchr(spec, '=');
395 if (!env_name)
396 die(_("invalid config format: %s"), spec);
397 key = xmemdupz(spec, env_name - spec);
398 env_name++;
399 if (!*env_name)
400 die(_("missing environment variable name for configuration '%.*s'"),
401 (int)(env_name - spec - 1), spec);
403 env_value = getenv(env_name);
404 if (!env_value)
405 die(_("missing environment variable '%s' for configuration '%.*s'"),
406 env_name, (int)(env_name - spec - 1), spec);
408 git_config_push_split_parameter(key, env_value);
409 free(key);
412 static inline int iskeychar(int c)
414 return isalnum(c) || c == '-';
418 * Auxiliary function to sanity-check and split the key into the section
419 * identifier and variable name.
421 * Returns 0 on success, -1 when there is an invalid character in the key and
422 * -2 if there is no section name in the key.
424 * store_key - pointer to char* which will hold a copy of the key with
425 * lowercase section and variable name
426 * baselen - pointer to size_t which will hold the length of the
427 * section + subsection part, can be NULL
429 static int git_config_parse_key_1(const char *key, char **store_key, size_t *baselen_, int quiet)
431 size_t i, baselen;
432 int dot;
433 const char *last_dot = strrchr(key, '.');
436 * Since "key" actually contains the section name and the real
437 * key name separated by a dot, we have to know where the dot is.
440 if (last_dot == NULL || last_dot == key) {
441 if (!quiet)
442 error(_("key does not contain a section: %s"), key);
443 return -CONFIG_NO_SECTION_OR_NAME;
446 if (!last_dot[1]) {
447 if (!quiet)
448 error(_("key does not contain variable name: %s"), key);
449 return -CONFIG_NO_SECTION_OR_NAME;
452 baselen = last_dot - key;
453 if (baselen_)
454 *baselen_ = baselen;
457 * Validate the key and while at it, lower case it for matching.
459 if (store_key)
460 *store_key = xmallocz(strlen(key));
462 dot = 0;
463 for (i = 0; key[i]; i++) {
464 unsigned char c = key[i];
465 if (c == '.')
466 dot = 1;
467 /* Leave the extended basename untouched.. */
468 if (!dot || i > baselen) {
469 if (!iskeychar(c) ||
470 (i == baselen + 1 && !isalpha(c))) {
471 if (!quiet)
472 error(_("invalid key: %s"), key);
473 goto out_free_ret_1;
475 c = tolower(c);
476 } else if (c == '\n') {
477 if (!quiet)
478 error(_("invalid key (newline): %s"), key);
479 goto out_free_ret_1;
481 if (store_key)
482 (*store_key)[i] = c;
485 return 0;
487 out_free_ret_1:
488 if (store_key) {
489 FREE_AND_NULL(*store_key);
491 return -CONFIG_INVALID_KEY;
494 int git_config_parse_key(const char *key, char **store_key, size_t *baselen)
496 return git_config_parse_key_1(key, store_key, baselen, 0);
499 int git_config_key_is_valid(const char *key)
501 return !git_config_parse_key_1(key, NULL, NULL, 1);
504 static int config_parse_pair(const char *key, const char *value,
505 config_fn_t fn, void *data)
507 char *canonical_name;
508 int ret;
510 if (!strlen(key))
511 return error(_("empty config key"));
512 if (git_config_parse_key(key, &canonical_name, NULL))
513 return -1;
515 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
516 free(canonical_name);
517 return ret;
520 int git_config_parse_parameter(const char *text,
521 config_fn_t fn, void *data)
523 const char *value;
524 struct strbuf **pair;
525 int ret;
527 pair = strbuf_split_str(text, '=', 2);
528 if (!pair[0])
529 return error(_("bogus config parameter: %s"), text);
531 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
532 strbuf_setlen(pair[0], pair[0]->len - 1);
533 value = pair[1] ? pair[1]->buf : "";
534 } else {
535 value = NULL;
538 strbuf_trim(pair[0]);
539 if (!pair[0]->len) {
540 strbuf_list_free(pair);
541 return error(_("bogus config parameter: %s"), text);
544 ret = config_parse_pair(pair[0]->buf, value, fn, data);
545 strbuf_list_free(pair);
546 return ret;
549 static int parse_config_env_list(char *env, config_fn_t fn, void *data)
551 char *cur = env;
552 while (cur && *cur) {
553 const char *key = sq_dequote_step(cur, &cur);
554 if (!key)
555 return error(_("bogus format in %s"),
556 CONFIG_DATA_ENVIRONMENT);
558 if (!cur || isspace(*cur)) {
559 /* old-style 'key=value' */
560 if (git_config_parse_parameter(key, fn, data) < 0)
561 return -1;
563 else if (*cur == '=') {
564 /* new-style 'key'='value' */
565 const char *value;
567 cur++;
568 if (*cur == '\'') {
569 /* quoted value */
570 value = sq_dequote_step(cur, &cur);
571 if (!value || (cur && !isspace(*cur))) {
572 return error(_("bogus format in %s"),
573 CONFIG_DATA_ENVIRONMENT);
575 } else if (!*cur || isspace(*cur)) {
576 /* implicit bool: 'key'= */
577 value = NULL;
578 } else {
579 return error(_("bogus format in %s"),
580 CONFIG_DATA_ENVIRONMENT);
583 if (config_parse_pair(key, value, fn, data) < 0)
584 return -1;
586 else {
587 /* unknown format */
588 return error(_("bogus format in %s"),
589 CONFIG_DATA_ENVIRONMENT);
592 if (cur) {
593 while (isspace(*cur))
594 cur++;
597 return 0;
600 int git_config_from_parameters(config_fn_t fn, void *data)
602 const char *env;
603 struct strbuf envvar = STRBUF_INIT;
604 struct strvec to_free = STRVEC_INIT;
605 int ret = 0;
606 char *envw = NULL;
607 struct config_source source;
609 memset(&source, 0, sizeof(source));
610 source.prev = cf;
611 source.origin_type = CONFIG_ORIGIN_CMDLINE;
612 cf = &source;
614 env = getenv(CONFIG_COUNT_ENVIRONMENT);
615 if (env) {
616 unsigned long count;
617 char *endp;
618 int i;
620 count = strtoul(env, &endp, 10);
621 if (*endp) {
622 ret = error(_("bogus count in %s"), CONFIG_COUNT_ENVIRONMENT);
623 goto out;
625 if (count > INT_MAX) {
626 ret = error(_("too many entries in %s"), CONFIG_COUNT_ENVIRONMENT);
627 goto out;
630 for (i = 0; i < count; i++) {
631 const char *key, *value;
633 strbuf_addf(&envvar, "GIT_CONFIG_KEY_%d", i);
634 key = getenv_safe(&to_free, envvar.buf);
635 if (!key) {
636 ret = error(_("missing config key %s"), envvar.buf);
637 goto out;
639 strbuf_reset(&envvar);
641 strbuf_addf(&envvar, "GIT_CONFIG_VALUE_%d", i);
642 value = getenv_safe(&to_free, envvar.buf);
643 if (!value) {
644 ret = error(_("missing config value %s"), envvar.buf);
645 goto out;
647 strbuf_reset(&envvar);
649 if (config_parse_pair(key, value, fn, data) < 0) {
650 ret = -1;
651 goto out;
656 env = getenv(CONFIG_DATA_ENVIRONMENT);
657 if (env) {
658 /* sq_dequote will write over it */
659 envw = xstrdup(env);
660 if (parse_config_env_list(envw, fn, data) < 0) {
661 ret = -1;
662 goto out;
666 out:
667 strbuf_release(&envvar);
668 strvec_clear(&to_free);
669 free(envw);
670 cf = source.prev;
671 return ret;
674 static int get_next_char(void)
676 int c = cf->do_fgetc(cf);
678 if (c == '\r') {
679 /* DOS like systems */
680 c = cf->do_fgetc(cf);
681 if (c != '\n') {
682 if (c != EOF)
683 cf->do_ungetc(c, cf);
684 c = '\r';
688 if (c != EOF && ++cf->total_len > INT_MAX) {
690 * This is an absurdly long config file; refuse to parse
691 * further in order to protect downstream code from integer
692 * overflows. Note that we can't return an error specifically,
693 * but we can mark EOF and put trash in the return value,
694 * which will trigger a parse error.
696 cf->eof = 1;
697 return 0;
700 if (c == '\n')
701 cf->linenr++;
702 if (c == EOF) {
703 cf->eof = 1;
704 cf->linenr++;
705 c = '\n';
707 return c;
710 static char *parse_value(void)
712 int quote = 0, comment = 0, space = 0;
714 strbuf_reset(&cf->value);
715 for (;;) {
716 int c = get_next_char();
717 if (c == '\n') {
718 if (quote) {
719 cf->linenr--;
720 return NULL;
722 return cf->value.buf;
724 if (comment)
725 continue;
726 if (isspace(c) && !quote) {
727 if (cf->value.len)
728 space++;
729 continue;
731 if (!quote) {
732 if (c == ';' || c == '#') {
733 comment = 1;
734 continue;
737 for (; space; space--)
738 strbuf_addch(&cf->value, ' ');
739 if (c == '\\') {
740 c = get_next_char();
741 switch (c) {
742 case '\n':
743 continue;
744 case 't':
745 c = '\t';
746 break;
747 case 'b':
748 c = '\b';
749 break;
750 case 'n':
751 c = '\n';
752 break;
753 /* Some characters escape as themselves */
754 case '\\': case '"':
755 break;
756 /* Reject unknown escape sequences */
757 default:
758 return NULL;
760 strbuf_addch(&cf->value, c);
761 continue;
763 if (c == '"') {
764 quote = 1-quote;
765 continue;
767 strbuf_addch(&cf->value, c);
771 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
773 int c;
774 char *value;
775 int ret;
777 /* Get the full name */
778 for (;;) {
779 c = get_next_char();
780 if (cf->eof)
781 break;
782 if (!iskeychar(c))
783 break;
784 strbuf_addch(name, tolower(c));
787 while (c == ' ' || c == '\t')
788 c = get_next_char();
790 value = NULL;
791 if (c != '\n') {
792 if (c != '=')
793 return -1;
794 value = parse_value();
795 if (!value)
796 return -1;
799 * We already consumed the \n, but we need linenr to point to
800 * the line we just parsed during the call to fn to get
801 * accurate line number in error messages.
803 cf->linenr--;
804 ret = fn(name->buf, value, data);
805 if (ret >= 0)
806 cf->linenr++;
807 return ret;
810 static int get_extended_base_var(struct strbuf *name, int c)
812 cf->subsection_case_sensitive = 0;
813 do {
814 if (c == '\n')
815 goto error_incomplete_line;
816 c = get_next_char();
817 } while (isspace(c));
819 /* We require the format to be '[base "extension"]' */
820 if (c != '"')
821 return -1;
822 strbuf_addch(name, '.');
824 for (;;) {
825 int c = get_next_char();
826 if (c == '\n')
827 goto error_incomplete_line;
828 if (c == '"')
829 break;
830 if (c == '\\') {
831 c = get_next_char();
832 if (c == '\n')
833 goto error_incomplete_line;
835 strbuf_addch(name, c);
838 /* Final ']' */
839 if (get_next_char() != ']')
840 return -1;
841 return 0;
842 error_incomplete_line:
843 cf->linenr--;
844 return -1;
847 static int get_base_var(struct strbuf *name)
849 cf->subsection_case_sensitive = 1;
850 for (;;) {
851 int c = get_next_char();
852 if (cf->eof)
853 return -1;
854 if (c == ']')
855 return 0;
856 if (isspace(c))
857 return get_extended_base_var(name, c);
858 if (!iskeychar(c) && c != '.')
859 return -1;
860 strbuf_addch(name, tolower(c));
864 struct parse_event_data {
865 enum config_event_t previous_type;
866 size_t previous_offset;
867 const struct config_options *opts;
870 static int do_event(enum config_event_t type, struct parse_event_data *data)
872 size_t offset;
874 if (!data->opts || !data->opts->event_fn)
875 return 0;
877 if (type == CONFIG_EVENT_WHITESPACE &&
878 data->previous_type == type)
879 return 0;
881 offset = cf->do_ftell(cf);
883 * At EOF, the parser always "inserts" an extra '\n', therefore
884 * the end offset of the event is the current file position, otherwise
885 * we will already have advanced to the next event.
887 if (type != CONFIG_EVENT_EOF)
888 offset--;
890 if (data->previous_type != CONFIG_EVENT_EOF &&
891 data->opts->event_fn(data->previous_type, data->previous_offset,
892 offset, data->opts->event_fn_data) < 0)
893 return -1;
895 data->previous_type = type;
896 data->previous_offset = offset;
898 return 0;
901 static int git_parse_source(config_fn_t fn, void *data,
902 const struct config_options *opts)
904 int comment = 0;
905 size_t baselen = 0;
906 struct strbuf *var = &cf->var;
907 int error_return = 0;
908 char *error_msg = NULL;
910 /* U+FEFF Byte Order Mark in UTF8 */
911 const char *bomptr = utf8_bom;
913 /* For the parser event callback */
914 struct parse_event_data event_data = {
915 CONFIG_EVENT_EOF, 0, opts
918 for (;;) {
919 int c;
921 c = get_next_char();
922 if (bomptr && *bomptr) {
923 /* We are at the file beginning; skip UTF8-encoded BOM
924 * if present. Sane editors won't put this in on their
925 * own, but e.g. Windows Notepad will do it happily. */
926 if (c == (*bomptr & 0377)) {
927 bomptr++;
928 continue;
929 } else {
930 /* Do not tolerate partial BOM. */
931 if (bomptr != utf8_bom)
932 break;
933 /* No BOM at file beginning. Cool. */
934 bomptr = NULL;
937 if (c == '\n') {
938 if (cf->eof) {
939 if (do_event(CONFIG_EVENT_EOF, &event_data) < 0)
940 return -1;
941 return 0;
943 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
944 return -1;
945 comment = 0;
946 continue;
948 if (comment)
949 continue;
950 if (isspace(c)) {
951 if (do_event(CONFIG_EVENT_WHITESPACE, &event_data) < 0)
952 return -1;
953 continue;
955 if (c == '#' || c == ';') {
956 if (do_event(CONFIG_EVENT_COMMENT, &event_data) < 0)
957 return -1;
958 comment = 1;
959 continue;
961 if (c == '[') {
962 if (do_event(CONFIG_EVENT_SECTION, &event_data) < 0)
963 return -1;
965 /* Reset prior to determining a new stem */
966 strbuf_reset(var);
967 if (get_base_var(var) < 0 || var->len < 1)
968 break;
969 strbuf_addch(var, '.');
970 baselen = var->len;
971 continue;
973 if (!isalpha(c))
974 break;
976 if (do_event(CONFIG_EVENT_ENTRY, &event_data) < 0)
977 return -1;
980 * Truncate the var name back to the section header
981 * stem prior to grabbing the suffix part of the name
982 * and the value.
984 strbuf_setlen(var, baselen);
985 strbuf_addch(var, tolower(c));
986 if (get_value(fn, data, var) < 0)
987 break;
990 if (do_event(CONFIG_EVENT_ERROR, &event_data) < 0)
991 return -1;
993 switch (cf->origin_type) {
994 case CONFIG_ORIGIN_BLOB:
995 error_msg = xstrfmt(_("bad config line %d in blob %s"),
996 cf->linenr, cf->name);
997 break;
998 case CONFIG_ORIGIN_FILE:
999 error_msg = xstrfmt(_("bad config line %d in file %s"),
1000 cf->linenr, cf->name);
1001 break;
1002 case CONFIG_ORIGIN_STDIN:
1003 error_msg = xstrfmt(_("bad config line %d in standard input"),
1004 cf->linenr);
1005 break;
1006 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1007 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
1008 cf->linenr, cf->name);
1009 break;
1010 case CONFIG_ORIGIN_CMDLINE:
1011 error_msg = xstrfmt(_("bad config line %d in command line %s"),
1012 cf->linenr, cf->name);
1013 break;
1014 default:
1015 error_msg = xstrfmt(_("bad config line %d in %s"),
1016 cf->linenr, cf->name);
1019 switch (opts && opts->error_action ?
1020 opts->error_action :
1021 cf->default_error_action) {
1022 case CONFIG_ERROR_DIE:
1023 die("%s", error_msg);
1024 break;
1025 case CONFIG_ERROR_ERROR:
1026 error_return = error("%s", error_msg);
1027 break;
1028 case CONFIG_ERROR_SILENT:
1029 error_return = -1;
1030 break;
1031 case CONFIG_ERROR_UNSET:
1032 BUG("config error action unset");
1035 free(error_msg);
1036 return error_return;
1039 static uintmax_t get_unit_factor(const char *end)
1041 if (!*end)
1042 return 1;
1043 else if (!strcasecmp(end, "k"))
1044 return 1024;
1045 else if (!strcasecmp(end, "m"))
1046 return 1024 * 1024;
1047 else if (!strcasecmp(end, "g"))
1048 return 1024 * 1024 * 1024;
1049 return 0;
1052 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
1054 if (value && *value) {
1055 char *end;
1056 intmax_t val;
1057 uintmax_t uval;
1058 uintmax_t factor;
1060 errno = 0;
1061 val = strtoimax(value, &end, 0);
1062 if (errno == ERANGE)
1063 return 0;
1064 factor = get_unit_factor(end);
1065 if (!factor) {
1066 errno = EINVAL;
1067 return 0;
1069 uval = val < 0 ? -val : val;
1070 if (unsigned_mult_overflows(factor, uval) ||
1071 factor * uval > max) {
1072 errno = ERANGE;
1073 return 0;
1075 val *= factor;
1076 *ret = val;
1077 return 1;
1079 errno = EINVAL;
1080 return 0;
1083 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
1085 if (value && *value) {
1086 char *end;
1087 uintmax_t val;
1088 uintmax_t factor;
1090 errno = 0;
1091 val = strtoumax(value, &end, 0);
1092 if (errno == ERANGE)
1093 return 0;
1094 factor = get_unit_factor(end);
1095 if (!factor) {
1096 errno = EINVAL;
1097 return 0;
1099 if (unsigned_mult_overflows(factor, val) ||
1100 factor * val > max) {
1101 errno = ERANGE;
1102 return 0;
1104 val *= factor;
1105 *ret = val;
1106 return 1;
1108 errno = EINVAL;
1109 return 0;
1112 static int git_parse_int(const char *value, int *ret)
1114 intmax_t tmp;
1115 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
1116 return 0;
1117 *ret = tmp;
1118 return 1;
1121 static int git_parse_int64(const char *value, int64_t *ret)
1123 intmax_t tmp;
1124 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
1125 return 0;
1126 *ret = tmp;
1127 return 1;
1130 int git_parse_ulong(const char *value, unsigned long *ret)
1132 uintmax_t tmp;
1133 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
1134 return 0;
1135 *ret = tmp;
1136 return 1;
1139 int git_parse_ssize_t(const char *value, ssize_t *ret)
1141 intmax_t tmp;
1142 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
1143 return 0;
1144 *ret = tmp;
1145 return 1;
1148 NORETURN
1149 static void die_bad_number(const char *name, const char *value)
1151 const char *error_type = (errno == ERANGE) ?
1152 N_("out of range") : N_("invalid unit");
1153 const char *bad_numeric = N_("bad numeric config value '%s' for '%s': %s");
1155 if (!value)
1156 value = "";
1158 if (!(cf && cf->name))
1159 die(_(bad_numeric), value, name, _(error_type));
1161 switch (cf->origin_type) {
1162 case CONFIG_ORIGIN_BLOB:
1163 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
1164 value, name, cf->name, _(error_type));
1165 case CONFIG_ORIGIN_FILE:
1166 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
1167 value, name, cf->name, _(error_type));
1168 case CONFIG_ORIGIN_STDIN:
1169 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
1170 value, name, _(error_type));
1171 case CONFIG_ORIGIN_SUBMODULE_BLOB:
1172 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
1173 value, name, cf->name, _(error_type));
1174 case CONFIG_ORIGIN_CMDLINE:
1175 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
1176 value, name, cf->name, _(error_type));
1177 default:
1178 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
1179 value, name, cf->name, _(error_type));
1183 NORETURN
1184 static void die_bad_bool(const char *name, const char *value)
1186 if (!strcmp(name, "GIT_TEST_GETTEXT_POISON"))
1188 * We explicitly *don't* use _() here since it would
1189 * cause an infinite loop with _() needing to call
1190 * use_gettext_poison().
1192 die("bad boolean config value '%s' for '%s'", value, name);
1193 else
1194 die(_("bad boolean config value '%s' for '%s'"), value, name);
1197 int git_config_int(const char *name, const char *value)
1199 int ret;
1200 if (!git_parse_int(value, &ret))
1201 die_bad_number(name, value);
1202 return ret;
1205 int64_t git_config_int64(const char *name, const char *value)
1207 int64_t ret;
1208 if (!git_parse_int64(value, &ret))
1209 die_bad_number(name, value);
1210 return ret;
1213 unsigned long git_config_ulong(const char *name, const char *value)
1215 unsigned long ret;
1216 if (!git_parse_ulong(value, &ret))
1217 die_bad_number(name, value);
1218 return ret;
1221 ssize_t git_config_ssize_t(const char *name, const char *value)
1223 ssize_t ret;
1224 if (!git_parse_ssize_t(value, &ret))
1225 die_bad_number(name, value);
1226 return ret;
1229 static int git_parse_maybe_bool_text(const char *value)
1231 if (!value)
1232 return 1;
1233 if (!*value)
1234 return 0;
1235 if (!strcasecmp(value, "true")
1236 || !strcasecmp(value, "yes")
1237 || !strcasecmp(value, "on"))
1238 return 1;
1239 if (!strcasecmp(value, "false")
1240 || !strcasecmp(value, "no")
1241 || !strcasecmp(value, "off"))
1242 return 0;
1243 return -1;
1246 int git_parse_maybe_bool(const char *value)
1248 int v = git_parse_maybe_bool_text(value);
1249 if (0 <= v)
1250 return v;
1251 if (git_parse_int(value, &v))
1252 return !!v;
1253 return -1;
1256 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
1258 int v = git_parse_maybe_bool_text(value);
1259 if (0 <= v) {
1260 *is_bool = 1;
1261 return v;
1263 *is_bool = 0;
1264 return git_config_int(name, value);
1267 int git_config_bool(const char *name, const char *value)
1269 int v = git_parse_maybe_bool(value);
1270 if (v < 0)
1271 die_bad_bool(name, value);
1272 return v;
1275 int git_config_string(const char **dest, const char *var, const char *value)
1277 if (!value)
1278 return config_error_nonbool(var);
1279 *dest = xstrdup(value);
1280 return 0;
1283 int git_config_pathname(const char **dest, const char *var, const char *value)
1285 if (!value)
1286 return config_error_nonbool(var);
1287 *dest = expand_user_path(value, 0);
1288 if (!*dest)
1289 die(_("failed to expand user dir in: '%s'"), value);
1290 return 0;
1293 int git_config_expiry_date(timestamp_t *timestamp, const char *var, const char *value)
1295 if (!value)
1296 return config_error_nonbool(var);
1297 if (parse_expiry_date(value, timestamp))
1298 return error(_("'%s' for '%s' is not a valid timestamp"),
1299 value, var);
1300 return 0;
1303 int git_config_color(char *dest, const char *var, const char *value)
1305 if (!value)
1306 return config_error_nonbool(var);
1307 if (color_parse(value, dest) < 0)
1308 return -1;
1309 return 0;
1312 static int git_default_core_config(const char *var, const char *value, void *cb)
1314 /* This needs a better name */
1315 if (!strcmp(var, "core.filemode")) {
1316 trust_executable_bit = git_config_bool(var, value);
1317 return 0;
1319 if (!strcmp(var, "core.trustctime")) {
1320 trust_ctime = git_config_bool(var, value);
1321 return 0;
1323 if (!strcmp(var, "core.checkstat")) {
1324 if (!strcasecmp(value, "default"))
1325 check_stat = 1;
1326 else if (!strcasecmp(value, "minimal"))
1327 check_stat = 0;
1330 if (!strcmp(var, "core.quotepath")) {
1331 quote_path_fully = git_config_bool(var, value);
1332 return 0;
1335 if (!strcmp(var, "core.symlinks")) {
1336 has_symlinks = git_config_bool(var, value);
1337 return 0;
1340 if (!strcmp(var, "core.ignorecase")) {
1341 ignore_case = git_config_bool(var, value);
1342 return 0;
1345 if (!strcmp(var, "core.attributesfile"))
1346 return git_config_pathname(&git_attributes_file, var, value);
1348 if (!strcmp(var, "core.hookspath"))
1349 return git_config_pathname(&git_hooks_path, var, value);
1351 if (!strcmp(var, "core.bare")) {
1352 is_bare_repository_cfg = git_config_bool(var, value);
1353 return 0;
1356 if (!strcmp(var, "core.ignorestat")) {
1357 assume_unchanged = git_config_bool(var, value);
1358 return 0;
1361 if (!strcmp(var, "core.prefersymlinkrefs")) {
1362 prefer_symlink_refs = git_config_bool(var, value);
1363 return 0;
1366 if (!strcmp(var, "core.logallrefupdates")) {
1367 if (value && !strcasecmp(value, "always"))
1368 log_all_ref_updates = LOG_REFS_ALWAYS;
1369 else if (git_config_bool(var, value))
1370 log_all_ref_updates = LOG_REFS_NORMAL;
1371 else
1372 log_all_ref_updates = LOG_REFS_NONE;
1373 return 0;
1376 if (!strcmp(var, "core.warnambiguousrefs")) {
1377 warn_ambiguous_refs = git_config_bool(var, value);
1378 return 0;
1381 if (!strcmp(var, "core.abbrev")) {
1382 if (!value)
1383 return config_error_nonbool(var);
1384 if (!strcasecmp(value, "auto"))
1385 default_abbrev = -1;
1386 else if (!git_parse_maybe_bool_text(value))
1387 default_abbrev = the_hash_algo->hexsz;
1388 else {
1389 int abbrev = git_config_int(var, value);
1390 if (abbrev < minimum_abbrev || abbrev > the_hash_algo->hexsz)
1391 return error(_("abbrev length out of range: %d"), abbrev);
1392 default_abbrev = abbrev;
1394 return 0;
1397 if (!strcmp(var, "core.disambiguate"))
1398 return set_disambiguate_hint_config(var, value);
1400 if (!strcmp(var, "core.loosecompression")) {
1401 int level = git_config_int(var, value);
1402 if (level == -1)
1403 level = Z_DEFAULT_COMPRESSION;
1404 else if (level < 0 || level > Z_BEST_COMPRESSION)
1405 die(_("bad zlib compression level %d"), level);
1406 zlib_compression_level = level;
1407 zlib_compression_seen = 1;
1408 return 0;
1411 if (!strcmp(var, "core.compression")) {
1412 int level = git_config_int(var, value);
1413 if (level == -1)
1414 level = Z_DEFAULT_COMPRESSION;
1415 else if (level < 0 || level > Z_BEST_COMPRESSION)
1416 die(_("bad zlib compression level %d"), level);
1417 core_compression_level = level;
1418 core_compression_seen = 1;
1419 if (!zlib_compression_seen)
1420 zlib_compression_level = level;
1421 if (!pack_compression_seen)
1422 pack_compression_level = level;
1423 return 0;
1426 if (!strcmp(var, "core.packedgitwindowsize")) {
1427 int pgsz_x2 = getpagesize() * 2;
1428 packed_git_window_size = git_config_ulong(var, value);
1430 /* This value must be multiple of (pagesize * 2) */
1431 packed_git_window_size /= pgsz_x2;
1432 if (packed_git_window_size < 1)
1433 packed_git_window_size = 1;
1434 packed_git_window_size *= pgsz_x2;
1435 return 0;
1438 if (!strcmp(var, "core.bigfilethreshold")) {
1439 big_file_threshold = git_config_ulong(var, value);
1440 return 0;
1443 if (!strcmp(var, "core.packedgitlimit")) {
1444 packed_git_limit = git_config_ulong(var, value);
1445 return 0;
1448 if (!strcmp(var, "core.deltabasecachelimit")) {
1449 delta_base_cache_limit = git_config_ulong(var, value);
1450 return 0;
1453 if (!strcmp(var, "core.autocrlf")) {
1454 if (value && !strcasecmp(value, "input")) {
1455 auto_crlf = AUTO_CRLF_INPUT;
1456 return 0;
1458 auto_crlf = git_config_bool(var, value);
1459 return 0;
1462 if (!strcmp(var, "core.safecrlf")) {
1463 int eol_rndtrp_die;
1464 if (value && !strcasecmp(value, "warn")) {
1465 global_conv_flags_eol = CONV_EOL_RNDTRP_WARN;
1466 return 0;
1468 eol_rndtrp_die = git_config_bool(var, value);
1469 global_conv_flags_eol = eol_rndtrp_die ?
1470 CONV_EOL_RNDTRP_DIE : 0;
1471 return 0;
1474 if (!strcmp(var, "core.eol")) {
1475 if (value && !strcasecmp(value, "lf"))
1476 core_eol = EOL_LF;
1477 else if (value && !strcasecmp(value, "crlf"))
1478 core_eol = EOL_CRLF;
1479 else if (value && !strcasecmp(value, "native"))
1480 core_eol = EOL_NATIVE;
1481 else
1482 core_eol = EOL_UNSET;
1483 return 0;
1486 if (!strcmp(var, "core.checkroundtripencoding")) {
1487 check_roundtrip_encoding = xstrdup(value);
1488 return 0;
1491 if (!strcmp(var, "core.notesref")) {
1492 notes_ref_name = xstrdup(value);
1493 return 0;
1496 if (!strcmp(var, "core.editor"))
1497 return git_config_string(&editor_program, var, value);
1499 if (!strcmp(var, "core.commentchar")) {
1500 if (!value)
1501 return config_error_nonbool(var);
1502 else if (!strcasecmp(value, "auto"))
1503 auto_comment_line_char = 1;
1504 else if (value[0] && !value[1]) {
1505 comment_line_char = value[0];
1506 auto_comment_line_char = 0;
1507 } else
1508 return error(_("core.commentChar should only be one character"));
1509 return 0;
1512 if (!strcmp(var, "core.askpass"))
1513 return git_config_string(&askpass_program, var, value);
1515 if (!strcmp(var, "core.excludesfile"))
1516 return git_config_pathname(&excludes_file, var, value);
1518 if (!strcmp(var, "core.whitespace")) {
1519 if (!value)
1520 return config_error_nonbool(var);
1521 whitespace_rule_cfg = parse_whitespace_rule(value);
1522 return 0;
1525 if (!strcmp(var, "core.fsyncobjectfiles")) {
1526 fsync_object_files = git_config_bool(var, value);
1527 return 0;
1530 if (!strcmp(var, "core.preloadindex")) {
1531 core_preload_index = git_config_bool(var, value);
1532 return 0;
1535 if (!strcmp(var, "core.createobject")) {
1536 if (!strcmp(value, "rename"))
1537 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1538 else if (!strcmp(value, "link"))
1539 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1540 else
1541 die(_("invalid mode for object creation: %s"), value);
1542 return 0;
1545 if (!strcmp(var, "core.sparsecheckout")) {
1546 core_apply_sparse_checkout = git_config_bool(var, value);
1547 return 0;
1550 if (!strcmp(var, "core.sparsecheckoutcone")) {
1551 core_sparse_checkout_cone = git_config_bool(var, value);
1552 return 0;
1555 if (!strcmp(var, "core.precomposeunicode")) {
1556 precomposed_unicode = git_config_bool(var, value);
1557 return 0;
1560 if (!strcmp(var, "core.protecthfs")) {
1561 protect_hfs = git_config_bool(var, value);
1562 return 0;
1565 if (!strcmp(var, "core.protectntfs")) {
1566 protect_ntfs = git_config_bool(var, value);
1567 return 0;
1570 if (!strcmp(var, "core.usereplacerefs")) {
1571 read_replace_refs = git_config_bool(var, value);
1572 return 0;
1575 /* Add other config variables here and to Documentation/config.txt. */
1576 return platform_core_config(var, value, cb);
1579 static int git_default_i18n_config(const char *var, const char *value)
1581 if (!strcmp(var, "i18n.commitencoding"))
1582 return git_config_string(&git_commit_encoding, var, value);
1584 if (!strcmp(var, "i18n.logoutputencoding"))
1585 return git_config_string(&git_log_output_encoding, var, value);
1587 /* Add other config variables here and to Documentation/config.txt. */
1588 return 0;
1591 static int git_default_branch_config(const char *var, const char *value)
1593 if (!strcmp(var, "branch.autosetupmerge")) {
1594 if (value && !strcasecmp(value, "always")) {
1595 git_branch_track = BRANCH_TRACK_ALWAYS;
1596 return 0;
1598 git_branch_track = git_config_bool(var, value);
1599 return 0;
1601 if (!strcmp(var, "branch.autosetuprebase")) {
1602 if (!value)
1603 return config_error_nonbool(var);
1604 else if (!strcmp(value, "never"))
1605 autorebase = AUTOREBASE_NEVER;
1606 else if (!strcmp(value, "local"))
1607 autorebase = AUTOREBASE_LOCAL;
1608 else if (!strcmp(value, "remote"))
1609 autorebase = AUTOREBASE_REMOTE;
1610 else if (!strcmp(value, "always"))
1611 autorebase = AUTOREBASE_ALWAYS;
1612 else
1613 return error(_("malformed value for %s"), var);
1614 return 0;
1617 /* Add other config variables here and to Documentation/config.txt. */
1618 return 0;
1621 static int git_default_push_config(const char *var, const char *value)
1623 if (!strcmp(var, "push.default")) {
1624 if (!value)
1625 return config_error_nonbool(var);
1626 else if (!strcmp(value, "nothing"))
1627 push_default = PUSH_DEFAULT_NOTHING;
1628 else if (!strcmp(value, "matching"))
1629 push_default = PUSH_DEFAULT_MATCHING;
1630 else if (!strcmp(value, "simple"))
1631 push_default = PUSH_DEFAULT_SIMPLE;
1632 else if (!strcmp(value, "upstream"))
1633 push_default = PUSH_DEFAULT_UPSTREAM;
1634 else if (!strcmp(value, "tracking")) /* deprecated */
1635 push_default = PUSH_DEFAULT_UPSTREAM;
1636 else if (!strcmp(value, "current"))
1637 push_default = PUSH_DEFAULT_CURRENT;
1638 else {
1639 error(_("malformed value for %s: %s"), var, value);
1640 return error(_("must be one of nothing, matching, simple, "
1641 "upstream or current"));
1643 return 0;
1646 /* Add other config variables here and to Documentation/config.txt. */
1647 return 0;
1650 static int git_default_mailmap_config(const char *var, const char *value)
1652 if (!strcmp(var, "mailmap.file"))
1653 return git_config_pathname(&git_mailmap_file, var, value);
1654 if (!strcmp(var, "mailmap.blob"))
1655 return git_config_string(&git_mailmap_blob, var, value);
1657 /* Add other config variables here and to Documentation/config.txt. */
1658 return 0;
1661 int git_default_config(const char *var, const char *value, void *cb)
1663 if (starts_with(var, "core."))
1664 return git_default_core_config(var, value, cb);
1666 if (starts_with(var, "user.") ||
1667 starts_with(var, "author.") ||
1668 starts_with(var, "committer."))
1669 return git_ident_config(var, value, cb);
1671 if (starts_with(var, "i18n."))
1672 return git_default_i18n_config(var, value);
1674 if (starts_with(var, "branch."))
1675 return git_default_branch_config(var, value);
1677 if (starts_with(var, "push."))
1678 return git_default_push_config(var, value);
1680 if (starts_with(var, "mailmap."))
1681 return git_default_mailmap_config(var, value);
1683 if (starts_with(var, "advice.") || starts_with(var, "color.advice"))
1684 return git_default_advice_config(var, value);
1686 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1687 pager_use_color = git_config_bool(var,value);
1688 return 0;
1691 if (!strcmp(var, "pack.packsizelimit")) {
1692 pack_size_limit_cfg = git_config_ulong(var, value);
1693 return 0;
1696 if (!strcmp(var, "pack.compression")) {
1697 int level = git_config_int(var, value);
1698 if (level == -1)
1699 level = Z_DEFAULT_COMPRESSION;
1700 else if (level < 0 || level > Z_BEST_COMPRESSION)
1701 die(_("bad pack compression level %d"), level);
1702 pack_compression_level = level;
1703 pack_compression_seen = 1;
1704 return 0;
1707 /* Add other config variables here and to Documentation/config.txt. */
1708 return 0;
1712 * All source specific fields in the union, die_on_error, name and the callbacks
1713 * fgetc, ungetc, ftell of top need to be initialized before calling
1714 * this function.
1716 static int do_config_from(struct config_source *top, config_fn_t fn, void *data,
1717 const struct config_options *opts)
1719 int ret;
1721 /* push config-file parsing state stack */
1722 top->prev = cf;
1723 top->linenr = 1;
1724 top->eof = 0;
1725 top->total_len = 0;
1726 strbuf_init(&top->value, 1024);
1727 strbuf_init(&top->var, 1024);
1728 cf = top;
1730 ret = git_parse_source(fn, data, opts);
1732 /* pop config-file parsing state stack */
1733 strbuf_release(&top->value);
1734 strbuf_release(&top->var);
1735 cf = top->prev;
1737 return ret;
1740 static int do_config_from_file(config_fn_t fn,
1741 const enum config_origin_type origin_type,
1742 const char *name, const char *path, FILE *f,
1743 void *data, const struct config_options *opts)
1745 struct config_source top;
1746 int ret;
1748 top.u.file = f;
1749 top.origin_type = origin_type;
1750 top.name = name;
1751 top.path = path;
1752 top.default_error_action = CONFIG_ERROR_DIE;
1753 top.do_fgetc = config_file_fgetc;
1754 top.do_ungetc = config_file_ungetc;
1755 top.do_ftell = config_file_ftell;
1757 flockfile(f);
1758 ret = do_config_from(&top, fn, data, opts);
1759 funlockfile(f);
1760 return ret;
1763 static int git_config_from_stdin(config_fn_t fn, void *data)
1765 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin,
1766 data, NULL);
1769 int git_config_from_file_with_options(config_fn_t fn, const char *filename,
1770 void *data,
1771 const struct config_options *opts)
1773 int ret = -1;
1774 FILE *f;
1776 f = fopen_or_warn(filename, "r");
1777 if (f) {
1778 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename,
1779 filename, f, data, opts);
1780 fclose(f);
1782 return ret;
1785 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1787 return git_config_from_file_with_options(fn, filename, data, NULL);
1790 int git_config_from_mem(config_fn_t fn,
1791 const enum config_origin_type origin_type,
1792 const char *name, const char *buf, size_t len,
1793 void *data, const struct config_options *opts)
1795 struct config_source top;
1797 top.u.buf.buf = buf;
1798 top.u.buf.len = len;
1799 top.u.buf.pos = 0;
1800 top.origin_type = origin_type;
1801 top.name = name;
1802 top.path = NULL;
1803 top.default_error_action = CONFIG_ERROR_ERROR;
1804 top.do_fgetc = config_buf_fgetc;
1805 top.do_ungetc = config_buf_ungetc;
1806 top.do_ftell = config_buf_ftell;
1808 return do_config_from(&top, fn, data, opts);
1811 int git_config_from_blob_oid(config_fn_t fn,
1812 const char *name,
1813 const struct object_id *oid,
1814 void *data)
1816 enum object_type type;
1817 char *buf;
1818 unsigned long size;
1819 int ret;
1821 buf = read_object_file(oid, &type, &size);
1822 if (!buf)
1823 return error(_("unable to load config blob object '%s'"), name);
1824 if (type != OBJ_BLOB) {
1825 free(buf);
1826 return error(_("reference '%s' does not point to a blob"), name);
1829 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size,
1830 data, NULL);
1831 free(buf);
1833 return ret;
1836 static int git_config_from_blob_ref(config_fn_t fn,
1837 const char *name,
1838 void *data)
1840 struct object_id oid;
1842 if (get_oid(name, &oid) < 0)
1843 return error(_("unable to resolve config blob '%s'"), name);
1844 return git_config_from_blob_oid(fn, name, &oid, data);
1847 const char *git_etc_gitconfig(void)
1849 static const char *system_wide;
1850 if (!system_wide)
1851 system_wide = system_path(ETC_GITCONFIG);
1852 return system_wide;
1856 * Parse environment variable 'k' as a boolean (in various
1857 * possible spellings); if missing, use the default value 'def'.
1859 int git_env_bool(const char *k, int def)
1861 const char *v = getenv(k);
1862 return v ? git_config_bool(k, v) : def;
1866 * Parse environment variable 'k' as ulong with possibly a unit
1867 * suffix; if missing, use the default value 'val'.
1869 unsigned long git_env_ulong(const char *k, unsigned long val)
1871 const char *v = getenv(k);
1872 if (v && !git_parse_ulong(v, &val))
1873 die(_("failed to parse %s"), k);
1874 return val;
1877 int git_config_system(void)
1879 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1882 static int do_git_config_sequence(const struct config_options *opts,
1883 config_fn_t fn, void *data)
1885 int ret = 0;
1886 char *xdg_config = xdg_config_home("config");
1887 char *user_config = expand_user_path("~/.gitconfig", 0);
1888 char *repo_config;
1889 enum config_scope prev_parsing_scope = current_parsing_scope;
1891 if (opts->commondir)
1892 repo_config = mkpathdup("%s/config", opts->commondir);
1893 else if (opts->git_dir)
1894 BUG("git_dir without commondir");
1895 else
1896 repo_config = NULL;
1898 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1899 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK,
1900 opts->system_gently ?
1901 ACCESS_EACCES_OK : 0))
1902 ret += git_config_from_file(fn, git_etc_gitconfig(),
1903 data);
1905 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1906 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1907 ret += git_config_from_file(fn, xdg_config, data);
1909 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1910 ret += git_config_from_file(fn, user_config, data);
1912 current_parsing_scope = CONFIG_SCOPE_LOCAL;
1913 if (!opts->ignore_repo && repo_config &&
1914 !access_or_die(repo_config, R_OK, 0))
1915 ret += git_config_from_file(fn, repo_config, data);
1917 current_parsing_scope = CONFIG_SCOPE_WORKTREE;
1918 if (!opts->ignore_worktree && repository_format_worktree_config) {
1919 char *path = git_pathdup("config.worktree");
1920 if (!access_or_die(path, R_OK, 0))
1921 ret += git_config_from_file(fn, path, data);
1922 free(path);
1925 current_parsing_scope = CONFIG_SCOPE_COMMAND;
1926 if (!opts->ignore_cmdline && git_config_from_parameters(fn, data) < 0)
1927 die(_("unable to parse command-line config"));
1929 current_parsing_scope = prev_parsing_scope;
1930 free(xdg_config);
1931 free(user_config);
1932 free(repo_config);
1933 return ret;
1936 int config_with_options(config_fn_t fn, void *data,
1937 struct git_config_source *config_source,
1938 const struct config_options *opts)
1940 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1942 if (opts->respect_includes) {
1943 inc.fn = fn;
1944 inc.data = data;
1945 inc.opts = opts;
1946 fn = git_config_include;
1947 data = &inc;
1950 if (config_source)
1951 current_parsing_scope = config_source->scope;
1954 * If we have a specific filename, use it. Otherwise, follow the
1955 * regular lookup sequence.
1957 if (config_source && config_source->use_stdin)
1958 return git_config_from_stdin(fn, data);
1959 else if (config_source && config_source->file)
1960 return git_config_from_file(fn, config_source->file, data);
1961 else if (config_source && config_source->blob)
1962 return git_config_from_blob_ref(fn, config_source->blob, data);
1964 return do_git_config_sequence(opts, fn, data);
1967 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1969 int i, value_index;
1970 struct string_list *values;
1971 struct config_set_element *entry;
1972 struct configset_list *list = &cs->list;
1974 for (i = 0; i < list->nr; i++) {
1975 entry = list->items[i].e;
1976 value_index = list->items[i].value_index;
1977 values = &entry->value_list;
1979 current_config_kvi = values->items[value_index].util;
1981 if (fn(entry->key, values->items[value_index].string, data) < 0)
1982 git_die_config_linenr(entry->key,
1983 current_config_kvi->filename,
1984 current_config_kvi->linenr);
1986 current_config_kvi = NULL;
1990 void read_early_config(config_fn_t cb, void *data)
1992 struct config_options opts = {0};
1993 struct strbuf commondir = STRBUF_INIT;
1994 struct strbuf gitdir = STRBUF_INIT;
1996 opts.respect_includes = 1;
1998 if (have_git_dir()) {
1999 opts.commondir = get_git_common_dir();
2000 opts.git_dir = get_git_dir();
2002 * When setup_git_directory() was not yet asked to discover the
2003 * GIT_DIR, we ask discover_git_directory() to figure out whether there
2004 * is any repository config we should use (but unlike
2005 * setup_git_directory_gently(), no global state is changed, most
2006 * notably, the current working directory is still the same after the
2007 * call).
2009 } else if (!discover_git_directory(&commondir, &gitdir)) {
2010 opts.commondir = commondir.buf;
2011 opts.git_dir = gitdir.buf;
2014 config_with_options(cb, data, NULL, &opts);
2016 strbuf_release(&commondir);
2017 strbuf_release(&gitdir);
2021 * Read config but only enumerate system and global settings.
2022 * Omit any repo-local, worktree-local, or command-line settings.
2024 void read_very_early_config(config_fn_t cb, void *data)
2026 struct config_options opts = { 0 };
2028 opts.respect_includes = 1;
2029 opts.ignore_repo = 1;
2030 opts.ignore_worktree = 1;
2031 opts.ignore_cmdline = 1;
2032 opts.system_gently = 1;
2034 config_with_options(cb, data, NULL, &opts);
2037 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
2039 struct config_set_element k;
2040 struct config_set_element *found_entry;
2041 char *normalized_key;
2043 * `key` may come from the user, so normalize it before using it
2044 * for querying entries from the hashmap.
2046 if (git_config_parse_key(key, &normalized_key, NULL))
2047 return NULL;
2049 hashmap_entry_init(&k.ent, strhash(normalized_key));
2050 k.key = normalized_key;
2051 found_entry = hashmap_get_entry(&cs->config_hash, &k, ent, NULL);
2052 free(normalized_key);
2053 return found_entry;
2056 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
2058 struct config_set_element *e;
2059 struct string_list_item *si;
2060 struct configset_list_item *l_item;
2061 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
2063 e = configset_find_element(cs, key);
2065 * Since the keys are being fed by git_config*() callback mechanism, they
2066 * are already normalized. So simply add them without any further munging.
2068 if (!e) {
2069 e = xmalloc(sizeof(*e));
2070 hashmap_entry_init(&e->ent, strhash(key));
2071 e->key = xstrdup(key);
2072 string_list_init(&e->value_list, 1);
2073 hashmap_add(&cs->config_hash, &e->ent);
2075 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
2077 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
2078 l_item = &cs->list.items[cs->list.nr++];
2079 l_item->e = e;
2080 l_item->value_index = e->value_list.nr - 1;
2082 if (!cf)
2083 BUG("configset_add_value has no source");
2084 if (cf->name) {
2085 kv_info->filename = strintern(cf->name);
2086 kv_info->linenr = cf->linenr;
2087 kv_info->origin_type = cf->origin_type;
2088 } else {
2089 /* for values read from `git_config_from_parameters()` */
2090 kv_info->filename = NULL;
2091 kv_info->linenr = -1;
2092 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
2094 kv_info->scope = current_parsing_scope;
2095 si->util = kv_info;
2097 return 0;
2100 static int config_set_element_cmp(const void *unused_cmp_data,
2101 const struct hashmap_entry *eptr,
2102 const struct hashmap_entry *entry_or_key,
2103 const void *unused_keydata)
2105 const struct config_set_element *e1, *e2;
2107 e1 = container_of(eptr, const struct config_set_element, ent);
2108 e2 = container_of(entry_or_key, const struct config_set_element, ent);
2110 return strcmp(e1->key, e2->key);
2113 void git_configset_init(struct config_set *cs)
2115 hashmap_init(&cs->config_hash, config_set_element_cmp, NULL, 0);
2116 cs->hash_initialized = 1;
2117 cs->list.nr = 0;
2118 cs->list.alloc = 0;
2119 cs->list.items = NULL;
2122 void git_configset_clear(struct config_set *cs)
2124 struct config_set_element *entry;
2125 struct hashmap_iter iter;
2126 if (!cs->hash_initialized)
2127 return;
2129 hashmap_for_each_entry(&cs->config_hash, &iter, entry,
2130 ent /* member name */) {
2131 free(entry->key);
2132 string_list_clear(&entry->value_list, 1);
2134 hashmap_clear_and_free(&cs->config_hash, struct config_set_element, ent);
2135 cs->hash_initialized = 0;
2136 free(cs->list.items);
2137 cs->list.nr = 0;
2138 cs->list.alloc = 0;
2139 cs->list.items = NULL;
2142 static int config_set_callback(const char *key, const char *value, void *cb)
2144 struct config_set *cs = cb;
2145 configset_add_value(cs, key, value);
2146 return 0;
2149 int git_configset_add_file(struct config_set *cs, const char *filename)
2151 return git_config_from_file(config_set_callback, filename, cs);
2154 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
2156 const struct string_list *values = NULL;
2158 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
2159 * queried key in the files of the configset, the value returned will be the last
2160 * value in the value list for that key.
2162 values = git_configset_get_value_multi(cs, key);
2164 if (!values)
2165 return 1;
2166 assert(values->nr > 0);
2167 *value = values->items[values->nr - 1].string;
2168 return 0;
2171 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
2173 struct config_set_element *e = configset_find_element(cs, key);
2174 return e ? &e->value_list : NULL;
2177 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
2179 const char *value;
2180 if (!git_configset_get_value(cs, key, &value))
2181 return git_config_string((const char **)dest, key, value);
2182 else
2183 return 1;
2186 int git_configset_get_string_tmp(struct config_set *cs, const char *key,
2187 const char **dest)
2189 const char *value;
2190 if (!git_configset_get_value(cs, key, &value)) {
2191 if (!value)
2192 return config_error_nonbool(key);
2193 *dest = value;
2194 return 0;
2195 } else {
2196 return 1;
2200 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
2202 const char *value;
2203 if (!git_configset_get_value(cs, key, &value)) {
2204 *dest = git_config_int(key, value);
2205 return 0;
2206 } else
2207 return 1;
2210 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
2212 const char *value;
2213 if (!git_configset_get_value(cs, key, &value)) {
2214 *dest = git_config_ulong(key, value);
2215 return 0;
2216 } else
2217 return 1;
2220 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
2222 const char *value;
2223 if (!git_configset_get_value(cs, key, &value)) {
2224 *dest = git_config_bool(key, value);
2225 return 0;
2226 } else
2227 return 1;
2230 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
2231 int *is_bool, int *dest)
2233 const char *value;
2234 if (!git_configset_get_value(cs, key, &value)) {
2235 *dest = git_config_bool_or_int(key, value, is_bool);
2236 return 0;
2237 } else
2238 return 1;
2241 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
2243 const char *value;
2244 if (!git_configset_get_value(cs, key, &value)) {
2245 *dest = git_parse_maybe_bool(value);
2246 if (*dest == -1)
2247 return -1;
2248 return 0;
2249 } else
2250 return 1;
2253 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
2255 const char *value;
2256 if (!git_configset_get_value(cs, key, &value))
2257 return git_config_pathname(dest, key, value);
2258 else
2259 return 1;
2262 /* Functions use to read configuration from a repository */
2263 static void repo_read_config(struct repository *repo)
2265 struct config_options opts = { 0 };
2267 opts.respect_includes = 1;
2268 opts.commondir = repo->commondir;
2269 opts.git_dir = repo->gitdir;
2271 if (!repo->config)
2272 CALLOC_ARRAY(repo->config, 1);
2273 else
2274 git_configset_clear(repo->config);
2276 git_configset_init(repo->config);
2278 if (config_with_options(config_set_callback, repo->config, NULL, &opts) < 0)
2280 * config_with_options() normally returns only
2281 * zero, as most errors are fatal, and
2282 * non-fatal potential errors are guarded by "if"
2283 * statements that are entered only when no error is
2284 * possible.
2286 * If we ever encounter a non-fatal error, it means
2287 * something went really wrong and we should stop
2288 * immediately.
2290 die(_("unknown error occurred while reading the configuration files"));
2293 static void git_config_check_init(struct repository *repo)
2295 if (repo->config && repo->config->hash_initialized)
2296 return;
2297 repo_read_config(repo);
2300 static void repo_config_clear(struct repository *repo)
2302 if (!repo->config || !repo->config->hash_initialized)
2303 return;
2304 git_configset_clear(repo->config);
2307 void repo_config(struct repository *repo, config_fn_t fn, void *data)
2309 git_config_check_init(repo);
2310 configset_iter(repo->config, fn, data);
2313 int repo_config_get_value(struct repository *repo,
2314 const char *key, const char **value)
2316 git_config_check_init(repo);
2317 return git_configset_get_value(repo->config, key, value);
2320 const struct string_list *repo_config_get_value_multi(struct repository *repo,
2321 const char *key)
2323 git_config_check_init(repo);
2324 return git_configset_get_value_multi(repo->config, key);
2327 int repo_config_get_string(struct repository *repo,
2328 const char *key, char **dest)
2330 int ret;
2331 git_config_check_init(repo);
2332 ret = git_configset_get_string(repo->config, key, dest);
2333 if (ret < 0)
2334 git_die_config(key, NULL);
2335 return ret;
2338 int repo_config_get_string_tmp(struct repository *repo,
2339 const char *key, const char **dest)
2341 int ret;
2342 git_config_check_init(repo);
2343 ret = git_configset_get_string_tmp(repo->config, key, dest);
2344 if (ret < 0)
2345 git_die_config(key, NULL);
2346 return ret;
2349 int repo_config_get_int(struct repository *repo,
2350 const char *key, int *dest)
2352 git_config_check_init(repo);
2353 return git_configset_get_int(repo->config, key, dest);
2356 int repo_config_get_ulong(struct repository *repo,
2357 const char *key, unsigned long *dest)
2359 git_config_check_init(repo);
2360 return git_configset_get_ulong(repo->config, key, dest);
2363 int repo_config_get_bool(struct repository *repo,
2364 const char *key, int *dest)
2366 git_config_check_init(repo);
2367 return git_configset_get_bool(repo->config, key, dest);
2370 int repo_config_get_bool_or_int(struct repository *repo,
2371 const char *key, int *is_bool, int *dest)
2373 git_config_check_init(repo);
2374 return git_configset_get_bool_or_int(repo->config, key, is_bool, dest);
2377 int repo_config_get_maybe_bool(struct repository *repo,
2378 const char *key, int *dest)
2380 git_config_check_init(repo);
2381 return git_configset_get_maybe_bool(repo->config, key, dest);
2384 int repo_config_get_pathname(struct repository *repo,
2385 const char *key, const char **dest)
2387 int ret;
2388 git_config_check_init(repo);
2389 ret = git_configset_get_pathname(repo->config, key, dest);
2390 if (ret < 0)
2391 git_die_config(key, NULL);
2392 return ret;
2395 /* Functions used historically to read configuration from 'the_repository' */
2396 void git_config(config_fn_t fn, void *data)
2398 repo_config(the_repository, fn, data);
2401 void git_config_clear(void)
2403 repo_config_clear(the_repository);
2406 int git_config_get_value(const char *key, const char **value)
2408 return repo_config_get_value(the_repository, key, value);
2411 const struct string_list *git_config_get_value_multi(const char *key)
2413 return repo_config_get_value_multi(the_repository, key);
2416 int git_config_get_string(const char *key, char **dest)
2418 return repo_config_get_string(the_repository, key, dest);
2421 int git_config_get_string_tmp(const char *key, const char **dest)
2423 return repo_config_get_string_tmp(the_repository, key, dest);
2426 int git_config_get_int(const char *key, int *dest)
2428 return repo_config_get_int(the_repository, key, dest);
2431 int git_config_get_ulong(const char *key, unsigned long *dest)
2433 return repo_config_get_ulong(the_repository, key, dest);
2436 int git_config_get_bool(const char *key, int *dest)
2438 return repo_config_get_bool(the_repository, key, dest);
2441 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
2443 return repo_config_get_bool_or_int(the_repository, key, is_bool, dest);
2446 int git_config_get_maybe_bool(const char *key, int *dest)
2448 return repo_config_get_maybe_bool(the_repository, key, dest);
2451 int git_config_get_pathname(const char *key, const char **dest)
2453 return repo_config_get_pathname(the_repository, key, dest);
2456 int git_config_get_expiry(const char *key, const char **output)
2458 int ret = git_config_get_string(key, (char **)output);
2459 if (ret)
2460 return ret;
2461 if (strcmp(*output, "now")) {
2462 timestamp_t now = approxidate("now");
2463 if (approxidate(*output) >= now)
2464 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
2466 return ret;
2469 int git_config_get_expiry_in_days(const char *key, timestamp_t *expiry, timestamp_t now)
2471 const char *expiry_string;
2472 intmax_t days;
2473 timestamp_t when;
2475 if (git_config_get_string_tmp(key, &expiry_string))
2476 return 1; /* no such thing */
2478 if (git_parse_signed(expiry_string, &days, maximum_signed_value_of_type(int))) {
2479 const int scale = 86400;
2480 *expiry = now - days * scale;
2481 return 0;
2484 if (!parse_expiry_date(expiry_string, &when)) {
2485 *expiry = when;
2486 return 0;
2488 return -1; /* thing exists but cannot be parsed */
2491 int git_config_get_split_index(void)
2493 int val;
2495 if (!git_config_get_maybe_bool("core.splitindex", &val))
2496 return val;
2498 return -1; /* default value */
2501 int git_config_get_max_percent_split_change(void)
2503 int val = -1;
2505 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2506 if (0 <= val && val <= 100)
2507 return val;
2509 return error(_("splitIndex.maxPercentChange value '%d' "
2510 "should be between 0 and 100"), val);
2513 return -1; /* default value */
2516 int git_config_get_fsmonitor(void)
2518 if (git_config_get_pathname("core.fsmonitor", &core_fsmonitor))
2519 core_fsmonitor = getenv("GIT_TEST_FSMONITOR");
2521 if (core_fsmonitor && !*core_fsmonitor)
2522 core_fsmonitor = NULL;
2524 if (core_fsmonitor)
2525 return 1;
2527 return 0;
2530 int git_config_get_index_threads(int *dest)
2532 int is_bool, val;
2534 val = git_env_ulong("GIT_TEST_INDEX_THREADS", 0);
2535 if (val) {
2536 *dest = val;
2537 return 0;
2540 if (!git_config_get_bool_or_int("index.threads", &is_bool, &val)) {
2541 if (is_bool)
2542 *dest = val ? 0 : 1;
2543 else
2544 *dest = val;
2545 return 0;
2548 return 1;
2551 NORETURN
2552 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2554 if (!filename)
2555 die(_("unable to parse '%s' from command-line config"), key);
2556 else
2557 die(_("bad config variable '%s' in file '%s' at line %d"),
2558 key, filename, linenr);
2561 NORETURN __attribute__((format(printf, 2, 3)))
2562 void git_die_config(const char *key, const char *err, ...)
2564 const struct string_list *values;
2565 struct key_value_info *kv_info;
2567 if (err) {
2568 va_list params;
2569 va_start(params, err);
2570 vreportf("error: ", err, params);
2571 va_end(params);
2573 values = git_config_get_value_multi(key);
2574 kv_info = values->items[values->nr - 1].util;
2575 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2579 * Find all the stuff for git_config_set() below.
2582 struct config_store_data {
2583 size_t baselen;
2584 char *key;
2585 int do_not_match;
2586 const char *fixed_value;
2587 regex_t *value_pattern;
2588 int multi_replace;
2589 struct {
2590 size_t begin, end;
2591 enum config_event_t type;
2592 int is_keys_section;
2593 } *parsed;
2594 unsigned int parsed_nr, parsed_alloc, *seen, seen_nr, seen_alloc;
2595 unsigned int key_seen:1, section_seen:1, is_keys_section:1;
2598 static void config_store_data_clear(struct config_store_data *store)
2600 free(store->key);
2601 if (store->value_pattern != NULL &&
2602 store->value_pattern != CONFIG_REGEX_NONE) {
2603 regfree(store->value_pattern);
2604 free(store->value_pattern);
2606 free(store->parsed);
2607 free(store->seen);
2608 memset(store, 0, sizeof(*store));
2611 static int matches(const char *key, const char *value,
2612 const struct config_store_data *store)
2614 if (strcmp(key, store->key))
2615 return 0; /* not ours */
2616 if (store->fixed_value)
2617 return !strcmp(store->fixed_value, value);
2618 if (!store->value_pattern)
2619 return 1; /* always matches */
2620 if (store->value_pattern == CONFIG_REGEX_NONE)
2621 return 0; /* never matches */
2623 return store->do_not_match ^
2624 (value && !regexec(store->value_pattern, value, 0, NULL, 0));
2627 static int store_aux_event(enum config_event_t type,
2628 size_t begin, size_t end, void *data)
2630 struct config_store_data *store = data;
2632 ALLOC_GROW(store->parsed, store->parsed_nr + 1, store->parsed_alloc);
2633 store->parsed[store->parsed_nr].begin = begin;
2634 store->parsed[store->parsed_nr].end = end;
2635 store->parsed[store->parsed_nr].type = type;
2637 if (type == CONFIG_EVENT_SECTION) {
2638 int (*cmpfn)(const char *, const char *, size_t);
2640 if (cf->var.len < 2 || cf->var.buf[cf->var.len - 1] != '.')
2641 return error(_("invalid section name '%s'"), cf->var.buf);
2643 if (cf->subsection_case_sensitive)
2644 cmpfn = strncasecmp;
2645 else
2646 cmpfn = strncmp;
2648 /* Is this the section we were looking for? */
2649 store->is_keys_section =
2650 store->parsed[store->parsed_nr].is_keys_section =
2651 cf->var.len - 1 == store->baselen &&
2652 !cmpfn(cf->var.buf, store->key, store->baselen);
2653 if (store->is_keys_section) {
2654 store->section_seen = 1;
2655 ALLOC_GROW(store->seen, store->seen_nr + 1,
2656 store->seen_alloc);
2657 store->seen[store->seen_nr] = store->parsed_nr;
2661 store->parsed_nr++;
2663 return 0;
2666 static int store_aux(const char *key, const char *value, void *cb)
2668 struct config_store_data *store = cb;
2670 if (store->key_seen) {
2671 if (matches(key, value, store)) {
2672 if (store->seen_nr == 1 && store->multi_replace == 0) {
2673 warning(_("%s has multiple values"), key);
2676 ALLOC_GROW(store->seen, store->seen_nr + 1,
2677 store->seen_alloc);
2679 store->seen[store->seen_nr] = store->parsed_nr;
2680 store->seen_nr++;
2682 } else if (store->is_keys_section) {
2684 * Do not increment matches yet: this may not be a match, but we
2685 * are in the desired section.
2687 ALLOC_GROW(store->seen, store->seen_nr + 1, store->seen_alloc);
2688 store->seen[store->seen_nr] = store->parsed_nr;
2689 store->section_seen = 1;
2691 if (matches(key, value, store)) {
2692 store->seen_nr++;
2693 store->key_seen = 1;
2697 return 0;
2700 static int write_error(const char *filename)
2702 error(_("failed to write new configuration file %s"), filename);
2704 /* Same error code as "failed to rename". */
2705 return 4;
2708 static struct strbuf store_create_section(const char *key,
2709 const struct config_store_data *store)
2711 const char *dot;
2712 size_t i;
2713 struct strbuf sb = STRBUF_INIT;
2715 dot = memchr(key, '.', store->baselen);
2716 if (dot) {
2717 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2718 for (i = dot - key + 1; i < store->baselen; i++) {
2719 if (key[i] == '"' || key[i] == '\\')
2720 strbuf_addch(&sb, '\\');
2721 strbuf_addch(&sb, key[i]);
2723 strbuf_addstr(&sb, "\"]\n");
2724 } else {
2725 strbuf_addch(&sb, '[');
2726 strbuf_add(&sb, key, store->baselen);
2727 strbuf_addstr(&sb, "]\n");
2730 return sb;
2733 static ssize_t write_section(int fd, const char *key,
2734 const struct config_store_data *store)
2736 struct strbuf sb = store_create_section(key, store);
2737 ssize_t ret;
2739 ret = write_in_full(fd, sb.buf, sb.len);
2740 strbuf_release(&sb);
2742 return ret;
2745 static ssize_t write_pair(int fd, const char *key, const char *value,
2746 const struct config_store_data *store)
2748 int i;
2749 ssize_t ret;
2750 const char *quote = "";
2751 struct strbuf sb = STRBUF_INIT;
2754 * Check to see if the value needs to be surrounded with a dq pair.
2755 * Note that problematic characters are always backslash-quoted; this
2756 * check is about not losing leading or trailing SP and strings that
2757 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2758 * configuration parser.
2760 if (value[0] == ' ')
2761 quote = "\"";
2762 for (i = 0; value[i]; i++)
2763 if (value[i] == ';' || value[i] == '#')
2764 quote = "\"";
2765 if (i && value[i - 1] == ' ')
2766 quote = "\"";
2768 strbuf_addf(&sb, "\t%s = %s", key + store->baselen + 1, quote);
2770 for (i = 0; value[i]; i++)
2771 switch (value[i]) {
2772 case '\n':
2773 strbuf_addstr(&sb, "\\n");
2774 break;
2775 case '\t':
2776 strbuf_addstr(&sb, "\\t");
2777 break;
2778 case '"':
2779 case '\\':
2780 strbuf_addch(&sb, '\\');
2781 /* fallthrough */
2782 default:
2783 strbuf_addch(&sb, value[i]);
2784 break;
2786 strbuf_addf(&sb, "%s\n", quote);
2788 ret = write_in_full(fd, sb.buf, sb.len);
2789 strbuf_release(&sb);
2791 return ret;
2795 * If we are about to unset the last key(s) in a section, and if there are
2796 * no comments surrounding (or included in) the section, we will want to
2797 * extend begin/end to remove the entire section.
2799 * Note: the parameter `seen_ptr` points to the index into the store.seen
2800 * array. * This index may be incremented if a section has more than one
2801 * entry (which all are to be removed).
2803 static void maybe_remove_section(struct config_store_data *store,
2804 size_t *begin_offset, size_t *end_offset,
2805 int *seen_ptr)
2807 size_t begin;
2808 int i, seen, section_seen = 0;
2811 * First, ensure that this is the first key, and that there are no
2812 * comments before the entry nor before the section header.
2814 seen = *seen_ptr;
2815 for (i = store->seen[seen]; i > 0; i--) {
2816 enum config_event_t type = store->parsed[i - 1].type;
2818 if (type == CONFIG_EVENT_COMMENT)
2819 /* There is a comment before this entry or section */
2820 return;
2821 if (type == CONFIG_EVENT_ENTRY) {
2822 if (!section_seen)
2823 /* This is not the section's first entry. */
2824 return;
2825 /* We encountered no comment before the section. */
2826 break;
2828 if (type == CONFIG_EVENT_SECTION) {
2829 if (!store->parsed[i - 1].is_keys_section)
2830 break;
2831 section_seen = 1;
2834 begin = store->parsed[i].begin;
2837 * Next, make sure that we are removing he last key(s) in the section,
2838 * and that there are no comments that are possibly about the current
2839 * section.
2841 for (i = store->seen[seen] + 1; i < store->parsed_nr; i++) {
2842 enum config_event_t type = store->parsed[i].type;
2844 if (type == CONFIG_EVENT_COMMENT)
2845 return;
2846 if (type == CONFIG_EVENT_SECTION) {
2847 if (store->parsed[i].is_keys_section)
2848 continue;
2849 break;
2851 if (type == CONFIG_EVENT_ENTRY) {
2852 if (++seen < store->seen_nr &&
2853 i == store->seen[seen])
2854 /* We want to remove this entry, too */
2855 continue;
2856 /* There is another entry in this section. */
2857 return;
2862 * We are really removing the last entry/entries from this section, and
2863 * there are no enclosed or surrounding comments. Remove the entire,
2864 * now-empty section.
2866 *seen_ptr = seen;
2867 *begin_offset = begin;
2868 if (i < store->parsed_nr)
2869 *end_offset = store->parsed[i].begin;
2870 else
2871 *end_offset = store->parsed[store->parsed_nr - 1].end;
2874 int git_config_set_in_file_gently(const char *config_filename,
2875 const char *key, const char *value)
2877 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2880 void git_config_set_in_file(const char *config_filename,
2881 const char *key, const char *value)
2883 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2886 int git_config_set_gently(const char *key, const char *value)
2888 return git_config_set_multivar_gently(key, value, NULL, 0);
2891 void git_config_set(const char *key, const char *value)
2893 git_config_set_multivar(key, value, NULL, 0);
2895 trace2_cmd_set_config(key, value);
2899 * If value==NULL, unset in (remove from) config,
2900 * if value_pattern!=NULL, disregard key/value pairs where value does not match.
2901 * if value_pattern==CONFIG_REGEX_NONE, do not match any existing values
2902 * (only add a new one)
2903 * if flags contains the CONFIG_FLAGS_MULTI_REPLACE flag, all matching
2904 * key/values are removed before a single new pair is written. If the
2905 * flag is not present, then replace only the first match.
2907 * Returns 0 on success.
2909 * This function does this:
2911 * - it locks the config file by creating ".git/config.lock"
2913 * - it then parses the config using store_aux() as validator to find
2914 * the position on the key/value pair to replace. If it is to be unset,
2915 * it must be found exactly once.
2917 * - the config file is mmap()ed and the part before the match (if any) is
2918 * written to the lock file, then the changed part and the rest.
2920 * - the config file is removed and the lock file rename()d to it.
2923 int git_config_set_multivar_in_file_gently(const char *config_filename,
2924 const char *key, const char *value,
2925 const char *value_pattern,
2926 unsigned flags)
2928 int fd = -1, in_fd = -1;
2929 int ret;
2930 struct lock_file lock = LOCK_INIT;
2931 char *filename_buf = NULL;
2932 char *contents = NULL;
2933 size_t contents_sz;
2934 struct config_store_data store;
2936 memset(&store, 0, sizeof(store));
2938 /* parse-key returns negative; flip the sign to feed exit(3) */
2939 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2940 if (ret)
2941 goto out_free;
2943 store.multi_replace = (flags & CONFIG_FLAGS_MULTI_REPLACE) != 0;
2945 if (!config_filename)
2946 config_filename = filename_buf = git_pathdup("config");
2949 * The lock serves a purpose in addition to locking: the new
2950 * contents of .git/config will be written into it.
2952 fd = hold_lock_file_for_update(&lock, config_filename, 0);
2953 if (fd < 0) {
2954 error_errno(_("could not lock config file %s"), config_filename);
2955 ret = CONFIG_NO_LOCK;
2956 goto out_free;
2960 * If .git/config does not exist yet, write a minimal version.
2962 in_fd = open(config_filename, O_RDONLY);
2963 if ( in_fd < 0 ) {
2964 if ( ENOENT != errno ) {
2965 error_errno(_("opening %s"), config_filename);
2966 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2967 goto out_free;
2969 /* if nothing to unset, error out */
2970 if (value == NULL) {
2971 ret = CONFIG_NOTHING_SET;
2972 goto out_free;
2975 free(store.key);
2976 store.key = xstrdup(key);
2977 if (write_section(fd, key, &store) < 0 ||
2978 write_pair(fd, key, value, &store) < 0)
2979 goto write_err_out;
2980 } else {
2981 struct stat st;
2982 size_t copy_begin, copy_end;
2983 int i, new_line = 0;
2984 struct config_options opts;
2986 if (value_pattern == NULL)
2987 store.value_pattern = NULL;
2988 else if (value_pattern == CONFIG_REGEX_NONE)
2989 store.value_pattern = CONFIG_REGEX_NONE;
2990 else if (flags & CONFIG_FLAGS_FIXED_VALUE)
2991 store.fixed_value = value_pattern;
2992 else {
2993 if (value_pattern[0] == '!') {
2994 store.do_not_match = 1;
2995 value_pattern++;
2996 } else
2997 store.do_not_match = 0;
2999 store.value_pattern = (regex_t*)xmalloc(sizeof(regex_t));
3000 if (regcomp(store.value_pattern, value_pattern,
3001 REG_EXTENDED)) {
3002 error(_("invalid pattern: %s"), value_pattern);
3003 FREE_AND_NULL(store.value_pattern);
3004 ret = CONFIG_INVALID_PATTERN;
3005 goto out_free;
3009 ALLOC_GROW(store.parsed, 1, store.parsed_alloc);
3010 store.parsed[0].end = 0;
3012 memset(&opts, 0, sizeof(opts));
3013 opts.event_fn = store_aux_event;
3014 opts.event_fn_data = &store;
3017 * After this, store.parsed will contain offsets of all the
3018 * parsed elements, and store.seen will contain a list of
3019 * matches, as indices into store.parsed.
3021 * As a side effect, we make sure to transform only a valid
3022 * existing config file.
3024 if (git_config_from_file_with_options(store_aux,
3025 config_filename,
3026 &store, &opts)) {
3027 error(_("invalid config file %s"), config_filename);
3028 ret = CONFIG_INVALID_FILE;
3029 goto out_free;
3032 /* if nothing to unset, or too many matches, error out */
3033 if ((store.seen_nr == 0 && value == NULL) ||
3034 (store.seen_nr > 1 && !store.multi_replace)) {
3035 ret = CONFIG_NOTHING_SET;
3036 goto out_free;
3039 if (fstat(in_fd, &st) == -1) {
3040 error_errno(_("fstat on %s failed"), config_filename);
3041 ret = CONFIG_INVALID_FILE;
3042 goto out_free;
3045 contents_sz = xsize_t(st.st_size);
3046 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
3047 MAP_PRIVATE, in_fd, 0);
3048 if (contents == MAP_FAILED) {
3049 if (errno == ENODEV && S_ISDIR(st.st_mode))
3050 errno = EISDIR;
3051 error_errno(_("unable to mmap '%s'"), config_filename);
3052 ret = CONFIG_INVALID_FILE;
3053 contents = NULL;
3054 goto out_free;
3056 close(in_fd);
3057 in_fd = -1;
3059 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3060 error_errno(_("chmod on %s failed"), get_lock_file_path(&lock));
3061 ret = CONFIG_NO_WRITE;
3062 goto out_free;
3065 if (store.seen_nr == 0) {
3066 if (!store.seen_alloc) {
3067 /* Did not see key nor section */
3068 ALLOC_GROW(store.seen, 1, store.seen_alloc);
3069 store.seen[0] = store.parsed_nr
3070 - !!store.parsed_nr;
3072 store.seen_nr = 1;
3075 for (i = 0, copy_begin = 0; i < store.seen_nr; i++) {
3076 size_t replace_end;
3077 int j = store.seen[i];
3079 new_line = 0;
3080 if (!store.key_seen) {
3081 copy_end = store.parsed[j].end;
3082 /* include '\n' when copying section header */
3083 if (copy_end > 0 && copy_end < contents_sz &&
3084 contents[copy_end - 1] != '\n' &&
3085 contents[copy_end] == '\n')
3086 copy_end++;
3087 replace_end = copy_end;
3088 } else {
3089 replace_end = store.parsed[j].end;
3090 copy_end = store.parsed[j].begin;
3091 if (!value)
3092 maybe_remove_section(&store,
3093 &copy_end,
3094 &replace_end, &i);
3096 * Swallow preceding white-space on the same
3097 * line.
3099 while (copy_end > 0 ) {
3100 char c = contents[copy_end - 1];
3102 if (isspace(c) && c != '\n')
3103 copy_end--;
3104 else
3105 break;
3109 if (copy_end > 0 && contents[copy_end-1] != '\n')
3110 new_line = 1;
3112 /* write the first part of the config */
3113 if (copy_end > copy_begin) {
3114 if (write_in_full(fd, contents + copy_begin,
3115 copy_end - copy_begin) < 0)
3116 goto write_err_out;
3117 if (new_line &&
3118 write_str_in_full(fd, "\n") < 0)
3119 goto write_err_out;
3121 copy_begin = replace_end;
3124 /* write the pair (value == NULL means unset) */
3125 if (value != NULL) {
3126 if (!store.section_seen) {
3127 if (write_section(fd, key, &store) < 0)
3128 goto write_err_out;
3130 if (write_pair(fd, key, value, &store) < 0)
3131 goto write_err_out;
3134 /* write the rest of the config */
3135 if (copy_begin < contents_sz)
3136 if (write_in_full(fd, contents + copy_begin,
3137 contents_sz - copy_begin) < 0)
3138 goto write_err_out;
3140 munmap(contents, contents_sz);
3141 contents = NULL;
3144 if (commit_lock_file(&lock) < 0) {
3145 error_errno(_("could not write config file %s"), config_filename);
3146 ret = CONFIG_NO_WRITE;
3147 goto out_free;
3150 ret = 0;
3152 /* Invalidate the config cache */
3153 git_config_clear();
3155 out_free:
3156 rollback_lock_file(&lock);
3157 free(filename_buf);
3158 if (contents)
3159 munmap(contents, contents_sz);
3160 if (in_fd >= 0)
3161 close(in_fd);
3162 config_store_data_clear(&store);
3163 return ret;
3165 write_err_out:
3166 ret = write_error(get_lock_file_path(&lock));
3167 goto out_free;
3171 void git_config_set_multivar_in_file(const char *config_filename,
3172 const char *key, const char *value,
3173 const char *value_pattern, unsigned flags)
3175 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
3176 value_pattern, flags))
3177 return;
3178 if (value)
3179 die(_("could not set '%s' to '%s'"), key, value);
3180 else
3181 die(_("could not unset '%s'"), key);
3184 int git_config_set_multivar_gently(const char *key, const char *value,
3185 const char *value_pattern, unsigned flags)
3187 return git_config_set_multivar_in_file_gently(NULL, key, value, value_pattern,
3188 flags);
3191 void git_config_set_multivar(const char *key, const char *value,
3192 const char *value_pattern, unsigned flags)
3194 git_config_set_multivar_in_file(NULL, key, value, value_pattern,
3195 flags);
3198 static int section_name_match (const char *buf, const char *name)
3200 int i = 0, j = 0, dot = 0;
3201 if (buf[i] != '[')
3202 return 0;
3203 for (i = 1; buf[i] && buf[i] != ']'; i++) {
3204 if (!dot && isspace(buf[i])) {
3205 dot = 1;
3206 if (name[j++] != '.')
3207 break;
3208 for (i++; isspace(buf[i]); i++)
3209 ; /* do nothing */
3210 if (buf[i] != '"')
3211 break;
3212 continue;
3214 if (buf[i] == '\\' && dot)
3215 i++;
3216 else if (buf[i] == '"' && dot) {
3217 for (i++; isspace(buf[i]); i++)
3218 ; /* do_nothing */
3219 break;
3221 if (buf[i] != name[j++])
3222 break;
3224 if (buf[i] == ']' && name[j] == 0) {
3226 * We match, now just find the right length offset by
3227 * gobbling up any whitespace after it, as well
3229 i++;
3230 for (; buf[i] && isspace(buf[i]); i++)
3231 ; /* do nothing */
3232 return i;
3234 return 0;
3237 static int section_name_is_ok(const char *name)
3239 /* Empty section names are bogus. */
3240 if (!*name)
3241 return 0;
3244 * Before a dot, we must be alphanumeric or dash. After the first dot,
3245 * anything goes, so we can stop checking.
3247 for (; *name && *name != '.'; name++)
3248 if (*name != '-' && !isalnum(*name))
3249 return 0;
3250 return 1;
3253 /* if new_name == NULL, the section is removed instead */
3254 static int git_config_copy_or_rename_section_in_file(const char *config_filename,
3255 const char *old_name,
3256 const char *new_name, int copy)
3258 int ret = 0, remove = 0;
3259 char *filename_buf = NULL;
3260 struct lock_file lock = LOCK_INIT;
3261 int out_fd;
3262 char buf[1024];
3263 FILE *config_file = NULL;
3264 struct stat st;
3265 struct strbuf copystr = STRBUF_INIT;
3266 struct config_store_data store;
3268 memset(&store, 0, sizeof(store));
3270 if (new_name && !section_name_is_ok(new_name)) {
3271 ret = error(_("invalid section name: %s"), new_name);
3272 goto out_no_rollback;
3275 if (!config_filename)
3276 config_filename = filename_buf = git_pathdup("config");
3278 out_fd = hold_lock_file_for_update(&lock, config_filename, 0);
3279 if (out_fd < 0) {
3280 ret = error(_("could not lock config file %s"), config_filename);
3281 goto out;
3284 if (!(config_file = fopen(config_filename, "rb"))) {
3285 ret = warn_on_fopen_errors(config_filename);
3286 if (ret)
3287 goto out;
3288 /* no config file means nothing to rename, no error */
3289 goto commit_and_out;
3292 if (fstat(fileno(config_file), &st) == -1) {
3293 ret = error_errno(_("fstat on %s failed"), config_filename);
3294 goto out;
3297 if (chmod(get_lock_file_path(&lock), st.st_mode & 07777) < 0) {
3298 ret = error_errno(_("chmod on %s failed"),
3299 get_lock_file_path(&lock));
3300 goto out;
3303 while (fgets(buf, sizeof(buf), config_file)) {
3304 unsigned i;
3305 int length;
3306 int is_section = 0;
3307 char *output = buf;
3308 for (i = 0; buf[i] && isspace(buf[i]); i++)
3309 ; /* do nothing */
3310 if (buf[i] == '[') {
3311 /* it's a section */
3312 int offset;
3313 is_section = 1;
3316 * When encountering a new section under -c we
3317 * need to flush out any section we're already
3318 * coping and begin anew. There might be
3319 * multiple [branch "$name"] sections.
3321 if (copystr.len > 0) {
3322 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3323 ret = write_error(get_lock_file_path(&lock));
3324 goto out;
3326 strbuf_reset(&copystr);
3329 offset = section_name_match(&buf[i], old_name);
3330 if (offset > 0) {
3331 ret++;
3332 if (new_name == NULL) {
3333 remove = 1;
3334 continue;
3336 store.baselen = strlen(new_name);
3337 if (!copy) {
3338 if (write_section(out_fd, new_name, &store) < 0) {
3339 ret = write_error(get_lock_file_path(&lock));
3340 goto out;
3343 * We wrote out the new section, with
3344 * a newline, now skip the old
3345 * section's length
3347 output += offset + i;
3348 if (strlen(output) > 0) {
3350 * More content means there's
3351 * a declaration to put on the
3352 * next line; indent with a
3353 * tab
3355 output -= 1;
3356 output[0] = '\t';
3358 } else {
3359 copystr = store_create_section(new_name, &store);
3362 remove = 0;
3364 if (remove)
3365 continue;
3366 length = strlen(output);
3368 if (!is_section && copystr.len > 0) {
3369 strbuf_add(&copystr, output, length);
3372 if (write_in_full(out_fd, output, length) < 0) {
3373 ret = write_error(get_lock_file_path(&lock));
3374 goto out;
3379 * Copy a trailing section at the end of the config, won't be
3380 * flushed by the usual "flush because we have a new section
3381 * logic in the loop above.
3383 if (copystr.len > 0) {
3384 if (write_in_full(out_fd, copystr.buf, copystr.len) < 0) {
3385 ret = write_error(get_lock_file_path(&lock));
3386 goto out;
3388 strbuf_reset(&copystr);
3391 fclose(config_file);
3392 config_file = NULL;
3393 commit_and_out:
3394 if (commit_lock_file(&lock) < 0)
3395 ret = error_errno(_("could not write config file %s"),
3396 config_filename);
3397 out:
3398 if (config_file)
3399 fclose(config_file);
3400 rollback_lock_file(&lock);
3401 out_no_rollback:
3402 free(filename_buf);
3403 config_store_data_clear(&store);
3404 return ret;
3407 int git_config_rename_section_in_file(const char *config_filename,
3408 const char *old_name, const char *new_name)
3410 return git_config_copy_or_rename_section_in_file(config_filename,
3411 old_name, new_name, 0);
3414 int git_config_rename_section(const char *old_name, const char *new_name)
3416 return git_config_rename_section_in_file(NULL, old_name, new_name);
3419 int git_config_copy_section_in_file(const char *config_filename,
3420 const char *old_name, const char *new_name)
3422 return git_config_copy_or_rename_section_in_file(config_filename,
3423 old_name, new_name, 1);
3426 int git_config_copy_section(const char *old_name, const char *new_name)
3428 return git_config_copy_section_in_file(NULL, old_name, new_name);
3432 * Call this to report error for your variable that should not
3433 * get a boolean value (i.e. "[my] var" means "true").
3435 #undef config_error_nonbool
3436 int config_error_nonbool(const char *var)
3438 return error(_("missing value for '%s'"), var);
3441 int parse_config_key(const char *var,
3442 const char *section,
3443 const char **subsection, size_t *subsection_len,
3444 const char **key)
3446 const char *dot;
3448 /* Does it start with "section." ? */
3449 if (!skip_prefix(var, section, &var) || *var != '.')
3450 return -1;
3453 * Find the key; we don't know yet if we have a subsection, but we must
3454 * parse backwards from the end, since the subsection may have dots in
3455 * it, too.
3457 dot = strrchr(var, '.');
3458 *key = dot + 1;
3460 /* Did we have a subsection at all? */
3461 if (dot == var) {
3462 if (subsection) {
3463 *subsection = NULL;
3464 *subsection_len = 0;
3467 else {
3468 if (!subsection)
3469 return -1;
3470 *subsection = var + 1;
3471 *subsection_len = dot - *subsection;
3474 return 0;
3477 const char *current_config_origin_type(void)
3479 int type;
3480 if (current_config_kvi)
3481 type = current_config_kvi->origin_type;
3482 else if(cf)
3483 type = cf->origin_type;
3484 else
3485 BUG("current_config_origin_type called outside config callback");
3487 switch (type) {
3488 case CONFIG_ORIGIN_BLOB:
3489 return "blob";
3490 case CONFIG_ORIGIN_FILE:
3491 return "file";
3492 case CONFIG_ORIGIN_STDIN:
3493 return "standard input";
3494 case CONFIG_ORIGIN_SUBMODULE_BLOB:
3495 return "submodule-blob";
3496 case CONFIG_ORIGIN_CMDLINE:
3497 return "command line";
3498 default:
3499 BUG("unknown config origin type");
3503 const char *config_scope_name(enum config_scope scope)
3505 switch (scope) {
3506 case CONFIG_SCOPE_SYSTEM:
3507 return "system";
3508 case CONFIG_SCOPE_GLOBAL:
3509 return "global";
3510 case CONFIG_SCOPE_LOCAL:
3511 return "local";
3512 case CONFIG_SCOPE_WORKTREE:
3513 return "worktree";
3514 case CONFIG_SCOPE_COMMAND:
3515 return "command";
3516 case CONFIG_SCOPE_SUBMODULE:
3517 return "submodule";
3518 default:
3519 return "unknown";
3523 const char *current_config_name(void)
3525 const char *name;
3526 if (current_config_kvi)
3527 name = current_config_kvi->filename;
3528 else if (cf)
3529 name = cf->name;
3530 else
3531 BUG("current_config_name called outside config callback");
3532 return name ? name : "";
3535 enum config_scope current_config_scope(void)
3537 if (current_config_kvi)
3538 return current_config_kvi->scope;
3539 else
3540 return current_parsing_scope;
3543 int current_config_line(void)
3545 if (current_config_kvi)
3546 return current_config_kvi->linenr;
3547 else
3548 return cf->linenr;
3551 int lookup_config(const char **mapping, int nr_mapping, const char *var)
3553 int i;
3555 for (i = 0; i < nr_mapping; i++) {
3556 const char *name = mapping[i];
3558 if (name && !strcasecmp(var, name))
3559 return i;
3561 return -1;