setup: teach discover_git_directory to respect the commondir
[git.git] / config.c
blobe8dbf9e64a36ab77b4814403d291bd95e1c94843
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 "config.h"
10 #include "lockfile.h"
11 #include "exec_cmd.h"
12 #include "strbuf.h"
13 #include "quote.h"
14 #include "hashmap.h"
15 #include "string-list.h"
16 #include "utf8.h"
17 #include "dir.h"
19 struct config_source {
20 struct config_source *prev;
21 union {
22 FILE *file;
23 struct config_buf {
24 const char *buf;
25 size_t len;
26 size_t pos;
27 } buf;
28 } u;
29 enum config_origin_type origin_type;
30 const char *name;
31 const char *path;
32 int die_on_error;
33 int linenr;
34 int eof;
35 struct strbuf value;
36 struct strbuf var;
38 int (*do_fgetc)(struct config_source *c);
39 int (*do_ungetc)(int c, struct config_source *conf);
40 long (*do_ftell)(struct config_source *c);
44 * These variables record the "current" config source, which
45 * can be accessed by parsing callbacks.
47 * The "cf" variable will be non-NULL only when we are actually parsing a real
48 * config source (file, blob, cmdline, etc).
50 * The "current_config_kvi" variable will be non-NULL only when we are feeding
51 * cached config from a configset into a callback.
53 * They should generally never be non-NULL at the same time. If they are both
54 * NULL, then we aren't parsing anything (and depending on the function looking
55 * at the variables, it's either a bug for it to be called in the first place,
56 * or it's a function which can be reused for non-config purposes, and should
57 * fall back to some sane behavior).
59 static struct config_source *cf;
60 static struct key_value_info *current_config_kvi;
63 * Similar to the variables above, this gives access to the "scope" of the
64 * current value (repo, global, etc). For cached values, it can be found via
65 * the current_config_kvi as above. During parsing, the current value can be
66 * found in this variable. It's not part of "cf" because it transcends a single
67 * file (i.e., a file included from .git/config is still in "repo" scope).
69 static enum config_scope current_parsing_scope;
71 static int core_compression_seen;
72 static int pack_compression_seen;
73 static int zlib_compression_seen;
76 * Default config_set that contains key-value pairs from the usual set of config
77 * config files (i.e repo specific .git/config, user wide ~/.gitconfig, XDG
78 * config file and the global /etc/gitconfig)
80 static struct config_set the_config_set;
82 static int config_file_fgetc(struct config_source *conf)
84 return getc_unlocked(conf->u.file);
87 static int config_file_ungetc(int c, struct config_source *conf)
89 return ungetc(c, conf->u.file);
92 static long config_file_ftell(struct config_source *conf)
94 return ftell(conf->u.file);
98 static int config_buf_fgetc(struct config_source *conf)
100 if (conf->u.buf.pos < conf->u.buf.len)
101 return conf->u.buf.buf[conf->u.buf.pos++];
103 return EOF;
106 static int config_buf_ungetc(int c, struct config_source *conf)
108 if (conf->u.buf.pos > 0) {
109 conf->u.buf.pos--;
110 if (conf->u.buf.buf[conf->u.buf.pos] != c)
111 die("BUG: config_buf can only ungetc the same character");
112 return c;
115 return EOF;
118 static long config_buf_ftell(struct config_source *conf)
120 return conf->u.buf.pos;
123 #define MAX_INCLUDE_DEPTH 10
124 static const char include_depth_advice[] =
125 "exceeded maximum include depth (%d) while including\n"
126 " %s\n"
127 "from\n"
128 " %s\n"
129 "Do you have circular includes?";
130 static int handle_path_include(const char *path, struct config_include_data *inc)
132 int ret = 0;
133 struct strbuf buf = STRBUF_INIT;
134 char *expanded;
136 if (!path)
137 return config_error_nonbool("include.path");
139 expanded = expand_user_path(path, 0);
140 if (!expanded)
141 return error("could not expand include path '%s'", path);
142 path = expanded;
145 * Use an absolute path as-is, but interpret relative paths
146 * based on the including config file.
148 if (!is_absolute_path(path)) {
149 char *slash;
151 if (!cf || !cf->path)
152 return error("relative config includes must come from files");
154 slash = find_last_dir_sep(cf->path);
155 if (slash)
156 strbuf_add(&buf, cf->path, slash - cf->path + 1);
157 strbuf_addstr(&buf, path);
158 path = buf.buf;
161 if (!access_or_die(path, R_OK, 0)) {
162 if (++inc->depth > MAX_INCLUDE_DEPTH)
163 die(include_depth_advice, MAX_INCLUDE_DEPTH, path,
164 !cf ? "<unknown>" :
165 cf->name ? cf->name :
166 "the command line");
167 ret = git_config_from_file(git_config_include, path, inc);
168 inc->depth--;
170 strbuf_release(&buf);
171 free(expanded);
172 return ret;
175 static int prepare_include_condition_pattern(struct strbuf *pat)
177 struct strbuf path = STRBUF_INIT;
178 char *expanded;
179 int prefix = 0;
181 expanded = expand_user_path(pat->buf, 1);
182 if (expanded) {
183 strbuf_reset(pat);
184 strbuf_addstr(pat, expanded);
185 free(expanded);
188 if (pat->buf[0] == '.' && is_dir_sep(pat->buf[1])) {
189 const char *slash;
191 if (!cf || !cf->path)
192 return error(_("relative config include "
193 "conditionals must come from files"));
195 strbuf_realpath(&path, cf->path, 1);
196 slash = find_last_dir_sep(path.buf);
197 if (!slash)
198 die("BUG: how is this possible?");
199 strbuf_splice(pat, 0, 1, path.buf, slash - path.buf);
200 prefix = slash - path.buf + 1 /* slash */;
201 } else if (!is_absolute_path(pat->buf))
202 strbuf_insert(pat, 0, "**/", 3);
204 if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
205 strbuf_addstr(pat, "**");
207 strbuf_release(&path);
208 return prefix;
211 static int include_by_gitdir(const struct config_options *opts,
212 const char *cond, size_t cond_len, int icase)
214 struct strbuf text = STRBUF_INIT;
215 struct strbuf pattern = STRBUF_INIT;
216 int ret = 0, prefix;
217 const char *git_dir;
219 if (opts->git_dir)
220 git_dir = opts->git_dir;
221 else if (have_git_dir())
222 git_dir = get_git_dir();
223 else
224 goto done;
226 strbuf_realpath(&text, git_dir, 1);
227 strbuf_add(&pattern, cond, cond_len);
228 prefix = prepare_include_condition_pattern(&pattern);
230 if (prefix < 0)
231 goto done;
233 if (prefix > 0) {
235 * perform literal matching on the prefix part so that
236 * any wildcard character in it can't create side effects.
238 if (text.len < prefix)
239 goto done;
240 if (!icase && strncmp(pattern.buf, text.buf, prefix))
241 goto done;
242 if (icase && strncasecmp(pattern.buf, text.buf, prefix))
243 goto done;
246 ret = !wildmatch(pattern.buf + prefix, text.buf + prefix,
247 icase ? WM_CASEFOLD : 0, NULL);
249 done:
250 strbuf_release(&pattern);
251 strbuf_release(&text);
252 return ret;
255 static int include_condition_is_true(const struct config_options *opts,
256 const char *cond, size_t cond_len)
259 if (skip_prefix_mem(cond, cond_len, "gitdir:", &cond, &cond_len))
260 return include_by_gitdir(opts, cond, cond_len, 0);
261 else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
262 return include_by_gitdir(opts, cond, cond_len, 1);
264 /* unknown conditionals are always false */
265 return 0;
268 int git_config_include(const char *var, const char *value, void *data)
270 struct config_include_data *inc = data;
271 const char *cond, *key;
272 int cond_len;
273 int ret;
276 * Pass along all values, including "include" directives; this makes it
277 * possible to query information on the includes themselves.
279 ret = inc->fn(var, value, inc->data);
280 if (ret < 0)
281 return ret;
283 if (!strcmp(var, "include.path"))
284 ret = handle_path_include(value, inc);
286 if (!parse_config_key(var, "includeif", &cond, &cond_len, &key) &&
287 (cond && include_condition_is_true(inc->opts, cond, cond_len)) &&
288 !strcmp(key, "path"))
289 ret = handle_path_include(value, inc);
291 return ret;
294 void git_config_push_parameter(const char *text)
296 struct strbuf env = STRBUF_INIT;
297 const char *old = getenv(CONFIG_DATA_ENVIRONMENT);
298 if (old && *old) {
299 strbuf_addstr(&env, old);
300 strbuf_addch(&env, ' ');
302 sq_quote_buf(&env, text);
303 setenv(CONFIG_DATA_ENVIRONMENT, env.buf, 1);
304 strbuf_release(&env);
307 static inline int iskeychar(int c)
309 return isalnum(c) || c == '-';
313 * Auxiliary function to sanity-check and split the key into the section
314 * identifier and variable name.
316 * Returns 0 on success, -1 when there is an invalid character in the key and
317 * -2 if there is no section name in the key.
319 * store_key - pointer to char* which will hold a copy of the key with
320 * lowercase section and variable name
321 * baselen - pointer to int which will hold the length of the
322 * section + subsection part, can be NULL
324 static int git_config_parse_key_1(const char *key, char **store_key, int *baselen_, int quiet)
326 int i, dot, baselen;
327 const char *last_dot = strrchr(key, '.');
330 * Since "key" actually contains the section name and the real
331 * key name separated by a dot, we have to know where the dot is.
334 if (last_dot == NULL || last_dot == key) {
335 if (!quiet)
336 error("key does not contain a section: %s", key);
337 return -CONFIG_NO_SECTION_OR_NAME;
340 if (!last_dot[1]) {
341 if (!quiet)
342 error("key does not contain variable name: %s", key);
343 return -CONFIG_NO_SECTION_OR_NAME;
346 baselen = last_dot - key;
347 if (baselen_)
348 *baselen_ = baselen;
351 * Validate the key and while at it, lower case it for matching.
353 if (store_key)
354 *store_key = xmallocz(strlen(key));
356 dot = 0;
357 for (i = 0; key[i]; i++) {
358 unsigned char c = key[i];
359 if (c == '.')
360 dot = 1;
361 /* Leave the extended basename untouched.. */
362 if (!dot || i > baselen) {
363 if (!iskeychar(c) ||
364 (i == baselen + 1 && !isalpha(c))) {
365 if (!quiet)
366 error("invalid key: %s", key);
367 goto out_free_ret_1;
369 c = tolower(c);
370 } else if (c == '\n') {
371 if (!quiet)
372 error("invalid key (newline): %s", key);
373 goto out_free_ret_1;
375 if (store_key)
376 (*store_key)[i] = c;
379 return 0;
381 out_free_ret_1:
382 if (store_key) {
383 free(*store_key);
384 *store_key = NULL;
386 return -CONFIG_INVALID_KEY;
389 int git_config_parse_key(const char *key, char **store_key, int *baselen)
391 return git_config_parse_key_1(key, store_key, baselen, 0);
394 int git_config_key_is_valid(const char *key)
396 return !git_config_parse_key_1(key, NULL, NULL, 1);
399 int git_config_parse_parameter(const char *text,
400 config_fn_t fn, void *data)
402 const char *value;
403 char *canonical_name;
404 struct strbuf **pair;
405 int ret;
407 pair = strbuf_split_str(text, '=', 2);
408 if (!pair[0])
409 return error("bogus config parameter: %s", text);
411 if (pair[0]->len && pair[0]->buf[pair[0]->len - 1] == '=') {
412 strbuf_setlen(pair[0], pair[0]->len - 1);
413 value = pair[1] ? pair[1]->buf : "";
414 } else {
415 value = NULL;
418 strbuf_trim(pair[0]);
419 if (!pair[0]->len) {
420 strbuf_list_free(pair);
421 return error("bogus config parameter: %s", text);
424 if (git_config_parse_key(pair[0]->buf, &canonical_name, NULL)) {
425 ret = -1;
426 } else {
427 ret = (fn(canonical_name, value, data) < 0) ? -1 : 0;
428 free(canonical_name);
430 strbuf_list_free(pair);
431 return ret;
434 int git_config_from_parameters(config_fn_t fn, void *data)
436 const char *env = getenv(CONFIG_DATA_ENVIRONMENT);
437 int ret = 0;
438 char *envw;
439 const char **argv = NULL;
440 int nr = 0, alloc = 0;
441 int i;
442 struct config_source source;
444 if (!env)
445 return 0;
447 memset(&source, 0, sizeof(source));
448 source.prev = cf;
449 source.origin_type = CONFIG_ORIGIN_CMDLINE;
450 cf = &source;
452 /* sq_dequote will write over it */
453 envw = xstrdup(env);
455 if (sq_dequote_to_argv(envw, &argv, &nr, &alloc) < 0) {
456 ret = error("bogus format in " CONFIG_DATA_ENVIRONMENT);
457 goto out;
460 for (i = 0; i < nr; i++) {
461 if (git_config_parse_parameter(argv[i], fn, data) < 0) {
462 ret = -1;
463 goto out;
467 out:
468 free(argv);
469 free(envw);
470 cf = source.prev;
471 return ret;
474 static int get_next_char(void)
476 int c = cf->do_fgetc(cf);
478 if (c == '\r') {
479 /* DOS like systems */
480 c = cf->do_fgetc(cf);
481 if (c != '\n') {
482 if (c != EOF)
483 cf->do_ungetc(c, cf);
484 c = '\r';
487 if (c == '\n')
488 cf->linenr++;
489 if (c == EOF) {
490 cf->eof = 1;
491 cf->linenr++;
492 c = '\n';
494 return c;
497 static char *parse_value(void)
499 int quote = 0, comment = 0, space = 0;
501 strbuf_reset(&cf->value);
502 for (;;) {
503 int c = get_next_char();
504 if (c == '\n') {
505 if (quote) {
506 cf->linenr--;
507 return NULL;
509 return cf->value.buf;
511 if (comment)
512 continue;
513 if (isspace(c) && !quote) {
514 if (cf->value.len)
515 space++;
516 continue;
518 if (!quote) {
519 if (c == ';' || c == '#') {
520 comment = 1;
521 continue;
524 for (; space; space--)
525 strbuf_addch(&cf->value, ' ');
526 if (c == '\\') {
527 c = get_next_char();
528 switch (c) {
529 case '\n':
530 continue;
531 case 't':
532 c = '\t';
533 break;
534 case 'b':
535 c = '\b';
536 break;
537 case 'n':
538 c = '\n';
539 break;
540 /* Some characters escape as themselves */
541 case '\\': case '"':
542 break;
543 /* Reject unknown escape sequences */
544 default:
545 return NULL;
547 strbuf_addch(&cf->value, c);
548 continue;
550 if (c == '"') {
551 quote = 1-quote;
552 continue;
554 strbuf_addch(&cf->value, c);
558 static int get_value(config_fn_t fn, void *data, struct strbuf *name)
560 int c;
561 char *value;
562 int ret;
564 /* Get the full name */
565 for (;;) {
566 c = get_next_char();
567 if (cf->eof)
568 break;
569 if (!iskeychar(c))
570 break;
571 strbuf_addch(name, tolower(c));
574 while (c == ' ' || c == '\t')
575 c = get_next_char();
577 value = NULL;
578 if (c != '\n') {
579 if (c != '=')
580 return -1;
581 value = parse_value();
582 if (!value)
583 return -1;
586 * We already consumed the \n, but we need linenr to point to
587 * the line we just parsed during the call to fn to get
588 * accurate line number in error messages.
590 cf->linenr--;
591 ret = fn(name->buf, value, data);
592 if (ret >= 0)
593 cf->linenr++;
594 return ret;
597 static int get_extended_base_var(struct strbuf *name, int c)
599 do {
600 if (c == '\n')
601 goto error_incomplete_line;
602 c = get_next_char();
603 } while (isspace(c));
605 /* We require the format to be '[base "extension"]' */
606 if (c != '"')
607 return -1;
608 strbuf_addch(name, '.');
610 for (;;) {
611 int c = get_next_char();
612 if (c == '\n')
613 goto error_incomplete_line;
614 if (c == '"')
615 break;
616 if (c == '\\') {
617 c = get_next_char();
618 if (c == '\n')
619 goto error_incomplete_line;
621 strbuf_addch(name, c);
624 /* Final ']' */
625 if (get_next_char() != ']')
626 return -1;
627 return 0;
628 error_incomplete_line:
629 cf->linenr--;
630 return -1;
633 static int get_base_var(struct strbuf *name)
635 for (;;) {
636 int c = get_next_char();
637 if (cf->eof)
638 return -1;
639 if (c == ']')
640 return 0;
641 if (isspace(c))
642 return get_extended_base_var(name, c);
643 if (!iskeychar(c) && c != '.')
644 return -1;
645 strbuf_addch(name, tolower(c));
649 static int git_parse_source(config_fn_t fn, void *data)
651 int comment = 0;
652 int baselen = 0;
653 struct strbuf *var = &cf->var;
654 int error_return = 0;
655 char *error_msg = NULL;
657 /* U+FEFF Byte Order Mark in UTF8 */
658 const char *bomptr = utf8_bom;
660 for (;;) {
661 int c = get_next_char();
662 if (bomptr && *bomptr) {
663 /* We are at the file beginning; skip UTF8-encoded BOM
664 * if present. Sane editors won't put this in on their
665 * own, but e.g. Windows Notepad will do it happily. */
666 if (c == (*bomptr & 0377)) {
667 bomptr++;
668 continue;
669 } else {
670 /* Do not tolerate partial BOM. */
671 if (bomptr != utf8_bom)
672 break;
673 /* No BOM at file beginning. Cool. */
674 bomptr = NULL;
677 if (c == '\n') {
678 if (cf->eof)
679 return 0;
680 comment = 0;
681 continue;
683 if (comment || isspace(c))
684 continue;
685 if (c == '#' || c == ';') {
686 comment = 1;
687 continue;
689 if (c == '[') {
690 /* Reset prior to determining a new stem */
691 strbuf_reset(var);
692 if (get_base_var(var) < 0 || var->len < 1)
693 break;
694 strbuf_addch(var, '.');
695 baselen = var->len;
696 continue;
698 if (!isalpha(c))
699 break;
701 * Truncate the var name back to the section header
702 * stem prior to grabbing the suffix part of the name
703 * and the value.
705 strbuf_setlen(var, baselen);
706 strbuf_addch(var, tolower(c));
707 if (get_value(fn, data, var) < 0)
708 break;
711 switch (cf->origin_type) {
712 case CONFIG_ORIGIN_BLOB:
713 error_msg = xstrfmt(_("bad config line %d in blob %s"),
714 cf->linenr, cf->name);
715 break;
716 case CONFIG_ORIGIN_FILE:
717 error_msg = xstrfmt(_("bad config line %d in file %s"),
718 cf->linenr, cf->name);
719 break;
720 case CONFIG_ORIGIN_STDIN:
721 error_msg = xstrfmt(_("bad config line %d in standard input"),
722 cf->linenr);
723 break;
724 case CONFIG_ORIGIN_SUBMODULE_BLOB:
725 error_msg = xstrfmt(_("bad config line %d in submodule-blob %s"),
726 cf->linenr, cf->name);
727 break;
728 case CONFIG_ORIGIN_CMDLINE:
729 error_msg = xstrfmt(_("bad config line %d in command line %s"),
730 cf->linenr, cf->name);
731 break;
732 default:
733 error_msg = xstrfmt(_("bad config line %d in %s"),
734 cf->linenr, cf->name);
737 if (cf->die_on_error)
738 die("%s", error_msg);
739 else
740 error_return = error("%s", error_msg);
742 free(error_msg);
743 return error_return;
746 static int parse_unit_factor(const char *end, uintmax_t *val)
748 if (!*end)
749 return 1;
750 else if (!strcasecmp(end, "k")) {
751 *val *= 1024;
752 return 1;
754 else if (!strcasecmp(end, "m")) {
755 *val *= 1024 * 1024;
756 return 1;
758 else if (!strcasecmp(end, "g")) {
759 *val *= 1024 * 1024 * 1024;
760 return 1;
762 return 0;
765 static int git_parse_signed(const char *value, intmax_t *ret, intmax_t max)
767 if (value && *value) {
768 char *end;
769 intmax_t val;
770 uintmax_t uval;
771 uintmax_t factor = 1;
773 errno = 0;
774 val = strtoimax(value, &end, 0);
775 if (errno == ERANGE)
776 return 0;
777 if (!parse_unit_factor(end, &factor)) {
778 errno = EINVAL;
779 return 0;
781 uval = labs(val);
782 uval *= factor;
783 if (uval > max || labs(val) > uval) {
784 errno = ERANGE;
785 return 0;
787 val *= factor;
788 *ret = val;
789 return 1;
791 errno = EINVAL;
792 return 0;
795 static int git_parse_unsigned(const char *value, uintmax_t *ret, uintmax_t max)
797 if (value && *value) {
798 char *end;
799 uintmax_t val;
800 uintmax_t oldval;
802 errno = 0;
803 val = strtoumax(value, &end, 0);
804 if (errno == ERANGE)
805 return 0;
806 oldval = val;
807 if (!parse_unit_factor(end, &val)) {
808 errno = EINVAL;
809 return 0;
811 if (val > max || oldval > val) {
812 errno = ERANGE;
813 return 0;
815 *ret = val;
816 return 1;
818 errno = EINVAL;
819 return 0;
822 static int git_parse_int(const char *value, int *ret)
824 intmax_t tmp;
825 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int)))
826 return 0;
827 *ret = tmp;
828 return 1;
831 static int git_parse_int64(const char *value, int64_t *ret)
833 intmax_t tmp;
834 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(int64_t)))
835 return 0;
836 *ret = tmp;
837 return 1;
840 int git_parse_ulong(const char *value, unsigned long *ret)
842 uintmax_t tmp;
843 if (!git_parse_unsigned(value, &tmp, maximum_unsigned_value_of_type(long)))
844 return 0;
845 *ret = tmp;
846 return 1;
849 static int git_parse_ssize_t(const char *value, ssize_t *ret)
851 intmax_t tmp;
852 if (!git_parse_signed(value, &tmp, maximum_signed_value_of_type(ssize_t)))
853 return 0;
854 *ret = tmp;
855 return 1;
858 NORETURN
859 static void die_bad_number(const char *name, const char *value)
861 const char * error_type = (errno == ERANGE)? _("out of range"):_("invalid unit");
863 if (!value)
864 value = "";
866 if (!(cf && cf->name))
867 die(_("bad numeric config value '%s' for '%s': %s"),
868 value, name, error_type);
870 switch (cf->origin_type) {
871 case CONFIG_ORIGIN_BLOB:
872 die(_("bad numeric config value '%s' for '%s' in blob %s: %s"),
873 value, name, cf->name, error_type);
874 case CONFIG_ORIGIN_FILE:
875 die(_("bad numeric config value '%s' for '%s' in file %s: %s"),
876 value, name, cf->name, error_type);
877 case CONFIG_ORIGIN_STDIN:
878 die(_("bad numeric config value '%s' for '%s' in standard input: %s"),
879 value, name, error_type);
880 case CONFIG_ORIGIN_SUBMODULE_BLOB:
881 die(_("bad numeric config value '%s' for '%s' in submodule-blob %s: %s"),
882 value, name, cf->name, error_type);
883 case CONFIG_ORIGIN_CMDLINE:
884 die(_("bad numeric config value '%s' for '%s' in command line %s: %s"),
885 value, name, cf->name, error_type);
886 default:
887 die(_("bad numeric config value '%s' for '%s' in %s: %s"),
888 value, name, cf->name, error_type);
892 int git_config_int(const char *name, const char *value)
894 int ret;
895 if (!git_parse_int(value, &ret))
896 die_bad_number(name, value);
897 return ret;
900 int64_t git_config_int64(const char *name, const char *value)
902 int64_t ret;
903 if (!git_parse_int64(value, &ret))
904 die_bad_number(name, value);
905 return ret;
908 unsigned long git_config_ulong(const char *name, const char *value)
910 unsigned long ret;
911 if (!git_parse_ulong(value, &ret))
912 die_bad_number(name, value);
913 return ret;
916 ssize_t git_config_ssize_t(const char *name, const char *value)
918 ssize_t ret;
919 if (!git_parse_ssize_t(value, &ret))
920 die_bad_number(name, value);
921 return ret;
924 int git_parse_maybe_bool(const char *value)
926 if (!value)
927 return 1;
928 if (!*value)
929 return 0;
930 if (!strcasecmp(value, "true")
931 || !strcasecmp(value, "yes")
932 || !strcasecmp(value, "on"))
933 return 1;
934 if (!strcasecmp(value, "false")
935 || !strcasecmp(value, "no")
936 || !strcasecmp(value, "off"))
937 return 0;
938 return -1;
941 int git_config_maybe_bool(const char *name, const char *value)
943 int v = git_parse_maybe_bool(value);
944 if (0 <= v)
945 return v;
946 if (git_parse_int(value, &v))
947 return !!v;
948 return -1;
951 int git_config_bool_or_int(const char *name, const char *value, int *is_bool)
953 int v = git_parse_maybe_bool(value);
954 if (0 <= v) {
955 *is_bool = 1;
956 return v;
958 *is_bool = 0;
959 return git_config_int(name, value);
962 int git_config_bool(const char *name, const char *value)
964 int discard;
965 return !!git_config_bool_or_int(name, value, &discard);
968 int git_config_string(const char **dest, const char *var, const char *value)
970 if (!value)
971 return config_error_nonbool(var);
972 *dest = xstrdup(value);
973 return 0;
976 int git_config_pathname(const char **dest, const char *var, const char *value)
978 if (!value)
979 return config_error_nonbool(var);
980 *dest = expand_user_path(value, 0);
981 if (!*dest)
982 die(_("failed to expand user dir in: '%s'"), value);
983 return 0;
986 static int git_default_core_config(const char *var, const char *value)
988 /* This needs a better name */
989 if (!strcmp(var, "core.filemode")) {
990 trust_executable_bit = git_config_bool(var, value);
991 return 0;
993 if (!strcmp(var, "core.trustctime")) {
994 trust_ctime = git_config_bool(var, value);
995 return 0;
997 if (!strcmp(var, "core.checkstat")) {
998 if (!strcasecmp(value, "default"))
999 check_stat = 1;
1000 else if (!strcasecmp(value, "minimal"))
1001 check_stat = 0;
1004 if (!strcmp(var, "core.quotepath")) {
1005 quote_path_fully = git_config_bool(var, value);
1006 return 0;
1009 if (!strcmp(var, "core.symlinks")) {
1010 has_symlinks = git_config_bool(var, value);
1011 return 0;
1014 if (!strcmp(var, "core.ignorecase")) {
1015 ignore_case = git_config_bool(var, value);
1016 return 0;
1019 if (!strcmp(var, "core.attributesfile"))
1020 return git_config_pathname(&git_attributes_file, var, value);
1022 if (!strcmp(var, "core.hookspath"))
1023 return git_config_pathname(&git_hooks_path, var, value);
1025 if (!strcmp(var, "core.bare")) {
1026 is_bare_repository_cfg = git_config_bool(var, value);
1027 return 0;
1030 if (!strcmp(var, "core.ignorestat")) {
1031 assume_unchanged = git_config_bool(var, value);
1032 return 0;
1035 if (!strcmp(var, "core.prefersymlinkrefs")) {
1036 prefer_symlink_refs = git_config_bool(var, value);
1037 return 0;
1040 if (!strcmp(var, "core.logallrefupdates")) {
1041 if (value && !strcasecmp(value, "always"))
1042 log_all_ref_updates = LOG_REFS_ALWAYS;
1043 else if (git_config_bool(var, value))
1044 log_all_ref_updates = LOG_REFS_NORMAL;
1045 else
1046 log_all_ref_updates = LOG_REFS_NONE;
1047 return 0;
1050 if (!strcmp(var, "core.warnambiguousrefs")) {
1051 warn_ambiguous_refs = git_config_bool(var, value);
1052 return 0;
1055 if (!strcmp(var, "core.abbrev")) {
1056 if (!value)
1057 return config_error_nonbool(var);
1058 if (!strcasecmp(value, "auto"))
1059 default_abbrev = -1;
1060 else {
1061 int abbrev = git_config_int(var, value);
1062 if (abbrev < minimum_abbrev || abbrev > 40)
1063 return error("abbrev length out of range: %d", abbrev);
1064 default_abbrev = abbrev;
1066 return 0;
1069 if (!strcmp(var, "core.disambiguate"))
1070 return set_disambiguate_hint_config(var, value);
1072 if (!strcmp(var, "core.loosecompression")) {
1073 int level = git_config_int(var, value);
1074 if (level == -1)
1075 level = Z_DEFAULT_COMPRESSION;
1076 else if (level < 0 || level > Z_BEST_COMPRESSION)
1077 die(_("bad zlib compression level %d"), level);
1078 zlib_compression_level = level;
1079 zlib_compression_seen = 1;
1080 return 0;
1083 if (!strcmp(var, "core.compression")) {
1084 int level = git_config_int(var, value);
1085 if (level == -1)
1086 level = Z_DEFAULT_COMPRESSION;
1087 else if (level < 0 || level > Z_BEST_COMPRESSION)
1088 die(_("bad zlib compression level %d"), level);
1089 core_compression_level = level;
1090 core_compression_seen = 1;
1091 if (!zlib_compression_seen)
1092 zlib_compression_level = level;
1093 if (!pack_compression_seen)
1094 pack_compression_level = level;
1095 return 0;
1098 if (!strcmp(var, "core.packedgitwindowsize")) {
1099 int pgsz_x2 = getpagesize() * 2;
1100 packed_git_window_size = git_config_ulong(var, value);
1102 /* This value must be multiple of (pagesize * 2) */
1103 packed_git_window_size /= pgsz_x2;
1104 if (packed_git_window_size < 1)
1105 packed_git_window_size = 1;
1106 packed_git_window_size *= pgsz_x2;
1107 return 0;
1110 if (!strcmp(var, "core.bigfilethreshold")) {
1111 big_file_threshold = git_config_ulong(var, value);
1112 return 0;
1115 if (!strcmp(var, "core.packedgitlimit")) {
1116 packed_git_limit = git_config_ulong(var, value);
1117 return 0;
1120 if (!strcmp(var, "core.deltabasecachelimit")) {
1121 delta_base_cache_limit = git_config_ulong(var, value);
1122 return 0;
1125 if (!strcmp(var, "core.autocrlf")) {
1126 if (value && !strcasecmp(value, "input")) {
1127 auto_crlf = AUTO_CRLF_INPUT;
1128 return 0;
1130 auto_crlf = git_config_bool(var, value);
1131 return 0;
1134 if (!strcmp(var, "core.safecrlf")) {
1135 if (value && !strcasecmp(value, "warn")) {
1136 safe_crlf = SAFE_CRLF_WARN;
1137 return 0;
1139 safe_crlf = git_config_bool(var, value);
1140 return 0;
1143 if (!strcmp(var, "core.eol")) {
1144 if (value && !strcasecmp(value, "lf"))
1145 core_eol = EOL_LF;
1146 else if (value && !strcasecmp(value, "crlf"))
1147 core_eol = EOL_CRLF;
1148 else if (value && !strcasecmp(value, "native"))
1149 core_eol = EOL_NATIVE;
1150 else
1151 core_eol = EOL_UNSET;
1152 return 0;
1155 if (!strcmp(var, "core.notesref")) {
1156 notes_ref_name = xstrdup(value);
1157 return 0;
1160 if (!strcmp(var, "core.editor"))
1161 return git_config_string(&editor_program, var, value);
1163 if (!strcmp(var, "core.commentchar")) {
1164 if (!value)
1165 return config_error_nonbool(var);
1166 else if (!strcasecmp(value, "auto"))
1167 auto_comment_line_char = 1;
1168 else if (value[0] && !value[1]) {
1169 comment_line_char = value[0];
1170 auto_comment_line_char = 0;
1171 } else
1172 return error("core.commentChar should only be one character");
1173 return 0;
1176 if (!strcmp(var, "core.askpass"))
1177 return git_config_string(&askpass_program, var, value);
1179 if (!strcmp(var, "core.excludesfile"))
1180 return git_config_pathname(&excludes_file, var, value);
1182 if (!strcmp(var, "core.whitespace")) {
1183 if (!value)
1184 return config_error_nonbool(var);
1185 whitespace_rule_cfg = parse_whitespace_rule(value);
1186 return 0;
1189 if (!strcmp(var, "core.fsyncobjectfiles")) {
1190 fsync_object_files = git_config_bool(var, value);
1191 return 0;
1194 if (!strcmp(var, "core.preloadindex")) {
1195 core_preload_index = git_config_bool(var, value);
1196 return 0;
1199 if (!strcmp(var, "core.createobject")) {
1200 if (!strcmp(value, "rename"))
1201 object_creation_mode = OBJECT_CREATION_USES_RENAMES;
1202 else if (!strcmp(value, "link"))
1203 object_creation_mode = OBJECT_CREATION_USES_HARDLINKS;
1204 else
1205 die(_("invalid mode for object creation: %s"), value);
1206 return 0;
1209 if (!strcmp(var, "core.sparsecheckout")) {
1210 core_apply_sparse_checkout = git_config_bool(var, value);
1211 return 0;
1214 if (!strcmp(var, "core.precomposeunicode")) {
1215 precomposed_unicode = git_config_bool(var, value);
1216 return 0;
1219 if (!strcmp(var, "core.protecthfs")) {
1220 protect_hfs = git_config_bool(var, value);
1221 return 0;
1224 if (!strcmp(var, "core.protectntfs")) {
1225 protect_ntfs = git_config_bool(var, value);
1226 return 0;
1229 if (!strcmp(var, "core.hidedotfiles")) {
1230 if (value && !strcasecmp(value, "dotgitonly"))
1231 hide_dotfiles = HIDE_DOTFILES_DOTGITONLY;
1232 else
1233 hide_dotfiles = git_config_bool(var, value);
1234 return 0;
1237 /* Add other config variables here and to Documentation/config.txt. */
1238 return 0;
1241 static int git_default_i18n_config(const char *var, const char *value)
1243 if (!strcmp(var, "i18n.commitencoding"))
1244 return git_config_string(&git_commit_encoding, var, value);
1246 if (!strcmp(var, "i18n.logoutputencoding"))
1247 return git_config_string(&git_log_output_encoding, var, value);
1249 /* Add other config variables here and to Documentation/config.txt. */
1250 return 0;
1253 static int git_default_branch_config(const char *var, const char *value)
1255 if (!strcmp(var, "branch.autosetupmerge")) {
1256 if (value && !strcasecmp(value, "always")) {
1257 git_branch_track = BRANCH_TRACK_ALWAYS;
1258 return 0;
1260 git_branch_track = git_config_bool(var, value);
1261 return 0;
1263 if (!strcmp(var, "branch.autosetuprebase")) {
1264 if (!value)
1265 return config_error_nonbool(var);
1266 else if (!strcmp(value, "never"))
1267 autorebase = AUTOREBASE_NEVER;
1268 else if (!strcmp(value, "local"))
1269 autorebase = AUTOREBASE_LOCAL;
1270 else if (!strcmp(value, "remote"))
1271 autorebase = AUTOREBASE_REMOTE;
1272 else if (!strcmp(value, "always"))
1273 autorebase = AUTOREBASE_ALWAYS;
1274 else
1275 return error("malformed value for %s", var);
1276 return 0;
1279 /* Add other config variables here and to Documentation/config.txt. */
1280 return 0;
1283 static int git_default_push_config(const char *var, const char *value)
1285 if (!strcmp(var, "push.default")) {
1286 if (!value)
1287 return config_error_nonbool(var);
1288 else if (!strcmp(value, "nothing"))
1289 push_default = PUSH_DEFAULT_NOTHING;
1290 else if (!strcmp(value, "matching"))
1291 push_default = PUSH_DEFAULT_MATCHING;
1292 else if (!strcmp(value, "simple"))
1293 push_default = PUSH_DEFAULT_SIMPLE;
1294 else if (!strcmp(value, "upstream"))
1295 push_default = PUSH_DEFAULT_UPSTREAM;
1296 else if (!strcmp(value, "tracking")) /* deprecated */
1297 push_default = PUSH_DEFAULT_UPSTREAM;
1298 else if (!strcmp(value, "current"))
1299 push_default = PUSH_DEFAULT_CURRENT;
1300 else {
1301 error("malformed value for %s: %s", var, value);
1302 return error("Must be one of nothing, matching, simple, "
1303 "upstream or current.");
1305 return 0;
1308 /* Add other config variables here and to Documentation/config.txt. */
1309 return 0;
1312 static int git_default_mailmap_config(const char *var, const char *value)
1314 if (!strcmp(var, "mailmap.file"))
1315 return git_config_pathname(&git_mailmap_file, var, value);
1316 if (!strcmp(var, "mailmap.blob"))
1317 return git_config_string(&git_mailmap_blob, var, value);
1319 /* Add other config variables here and to Documentation/config.txt. */
1320 return 0;
1323 int git_default_config(const char *var, const char *value, void *dummy)
1325 if (starts_with(var, "core."))
1326 return git_default_core_config(var, value);
1328 if (starts_with(var, "user."))
1329 return git_ident_config(var, value, dummy);
1331 if (starts_with(var, "i18n."))
1332 return git_default_i18n_config(var, value);
1334 if (starts_with(var, "branch."))
1335 return git_default_branch_config(var, value);
1337 if (starts_with(var, "push."))
1338 return git_default_push_config(var, value);
1340 if (starts_with(var, "mailmap."))
1341 return git_default_mailmap_config(var, value);
1343 if (starts_with(var, "advice."))
1344 return git_default_advice_config(var, value);
1346 if (!strcmp(var, "pager.color") || !strcmp(var, "color.pager")) {
1347 pager_use_color = git_config_bool(var,value);
1348 return 0;
1351 if (!strcmp(var, "pack.packsizelimit")) {
1352 pack_size_limit_cfg = git_config_ulong(var, value);
1353 return 0;
1356 if (!strcmp(var, "pack.compression")) {
1357 int level = git_config_int(var, value);
1358 if (level == -1)
1359 level = Z_DEFAULT_COMPRESSION;
1360 else if (level < 0 || level > Z_BEST_COMPRESSION)
1361 die(_("bad pack compression level %d"), level);
1362 pack_compression_level = level;
1363 pack_compression_seen = 1;
1364 return 0;
1367 /* Add other config variables here and to Documentation/config.txt. */
1368 return 0;
1372 * All source specific fields in the union, die_on_error, name and the callbacks
1373 * fgetc, ungetc, ftell of top need to be initialized before calling
1374 * this function.
1376 static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
1378 int ret;
1380 /* push config-file parsing state stack */
1381 top->prev = cf;
1382 top->linenr = 1;
1383 top->eof = 0;
1384 strbuf_init(&top->value, 1024);
1385 strbuf_init(&top->var, 1024);
1386 cf = top;
1388 ret = git_parse_source(fn, data);
1390 /* pop config-file parsing state stack */
1391 strbuf_release(&top->value);
1392 strbuf_release(&top->var);
1393 cf = top->prev;
1395 return ret;
1398 static int do_config_from_file(config_fn_t fn,
1399 const enum config_origin_type origin_type,
1400 const char *name, const char *path, FILE *f,
1401 void *data)
1403 struct config_source top;
1405 top.u.file = f;
1406 top.origin_type = origin_type;
1407 top.name = name;
1408 top.path = path;
1409 top.die_on_error = 1;
1410 top.do_fgetc = config_file_fgetc;
1411 top.do_ungetc = config_file_ungetc;
1412 top.do_ftell = config_file_ftell;
1414 return do_config_from(&top, fn, data);
1417 static int git_config_from_stdin(config_fn_t fn, void *data)
1419 return do_config_from_file(fn, CONFIG_ORIGIN_STDIN, "", NULL, stdin, data);
1422 int git_config_from_file(config_fn_t fn, const char *filename, void *data)
1424 int ret = -1;
1425 FILE *f;
1427 f = fopen(filename, "r");
1428 if (f) {
1429 flockfile(f);
1430 ret = do_config_from_file(fn, CONFIG_ORIGIN_FILE, filename, filename, f, data);
1431 funlockfile(f);
1432 fclose(f);
1434 return ret;
1437 int git_config_from_mem(config_fn_t fn, const enum config_origin_type origin_type,
1438 const char *name, const char *buf, size_t len, void *data)
1440 struct config_source top;
1442 top.u.buf.buf = buf;
1443 top.u.buf.len = len;
1444 top.u.buf.pos = 0;
1445 top.origin_type = origin_type;
1446 top.name = name;
1447 top.path = NULL;
1448 top.die_on_error = 0;
1449 top.do_fgetc = config_buf_fgetc;
1450 top.do_ungetc = config_buf_ungetc;
1451 top.do_ftell = config_buf_ftell;
1453 return do_config_from(&top, fn, data);
1456 int git_config_from_blob_sha1(config_fn_t fn,
1457 const char *name,
1458 const unsigned char *sha1,
1459 void *data)
1461 enum object_type type;
1462 char *buf;
1463 unsigned long size;
1464 int ret;
1466 buf = read_sha1_file(sha1, &type, &size);
1467 if (!buf)
1468 return error("unable to load config blob object '%s'", name);
1469 if (type != OBJ_BLOB) {
1470 free(buf);
1471 return error("reference '%s' does not point to a blob", name);
1474 ret = git_config_from_mem(fn, CONFIG_ORIGIN_BLOB, name, buf, size, data);
1475 free(buf);
1477 return ret;
1480 static int git_config_from_blob_ref(config_fn_t fn,
1481 const char *name,
1482 void *data)
1484 unsigned char sha1[20];
1486 if (get_sha1(name, sha1) < 0)
1487 return error("unable to resolve config blob '%s'", name);
1488 return git_config_from_blob_sha1(fn, name, sha1, data);
1491 const char *git_etc_gitconfig(void)
1493 static const char *system_wide;
1494 if (!system_wide)
1495 system_wide = system_path(ETC_GITCONFIG);
1496 return system_wide;
1500 * Parse environment variable 'k' as a boolean (in various
1501 * possible spellings); if missing, use the default value 'def'.
1503 int git_env_bool(const char *k, int def)
1505 const char *v = getenv(k);
1506 return v ? git_config_bool(k, v) : def;
1510 * Parse environment variable 'k' as ulong with possibly a unit
1511 * suffix; if missing, use the default value 'val'.
1513 unsigned long git_env_ulong(const char *k, unsigned long val)
1515 const char *v = getenv(k);
1516 if (v && !git_parse_ulong(v, &val))
1517 die("failed to parse %s", k);
1518 return val;
1521 int git_config_system(void)
1523 return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
1526 static int do_git_config_sequence(const struct config_options *opts,
1527 config_fn_t fn, void *data)
1529 int ret = 0;
1530 char *xdg_config = xdg_config_home("config");
1531 char *user_config = expand_user_path("~/.gitconfig", 0);
1532 char *repo_config;
1534 if (opts->git_dir)
1535 repo_config = mkpathdup("%s/config", opts->git_dir);
1536 else if (have_git_dir())
1537 repo_config = git_pathdup("config");
1538 else
1539 repo_config = NULL;
1541 current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1542 if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1543 ret += git_config_from_file(fn, git_etc_gitconfig(),
1544 data);
1546 current_parsing_scope = CONFIG_SCOPE_GLOBAL;
1547 if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
1548 ret += git_config_from_file(fn, xdg_config, data);
1550 if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK))
1551 ret += git_config_from_file(fn, user_config, data);
1553 current_parsing_scope = CONFIG_SCOPE_REPO;
1554 if (repo_config && !access_or_die(repo_config, R_OK, 0))
1555 ret += git_config_from_file(fn, repo_config, data);
1557 current_parsing_scope = CONFIG_SCOPE_CMDLINE;
1558 if (git_config_from_parameters(fn, data) < 0)
1559 die(_("unable to parse command-line config"));
1561 current_parsing_scope = CONFIG_SCOPE_UNKNOWN;
1562 free(xdg_config);
1563 free(user_config);
1564 free(repo_config);
1565 return ret;
1568 int git_config_with_options(config_fn_t fn, void *data,
1569 struct git_config_source *config_source,
1570 const struct config_options *opts)
1572 struct config_include_data inc = CONFIG_INCLUDE_INIT;
1574 if (opts->respect_includes) {
1575 inc.fn = fn;
1576 inc.data = data;
1577 inc.opts = opts;
1578 fn = git_config_include;
1579 data = &inc;
1583 * If we have a specific filename, use it. Otherwise, follow the
1584 * regular lookup sequence.
1586 if (config_source && config_source->use_stdin)
1587 return git_config_from_stdin(fn, data);
1588 else if (config_source && config_source->file)
1589 return git_config_from_file(fn, config_source->file, data);
1590 else if (config_source && config_source->blob)
1591 return git_config_from_blob_ref(fn, config_source->blob, data);
1593 return do_git_config_sequence(opts, fn, data);
1596 static void git_config_raw(config_fn_t fn, void *data)
1598 struct config_options opts = {0};
1600 opts.respect_includes = 1;
1601 if (git_config_with_options(fn, data, NULL, &opts) < 0)
1603 * git_config_with_options() normally returns only
1604 * zero, as most errors are fatal, and
1605 * non-fatal potential errors are guarded by "if"
1606 * statements that are entered only when no error is
1607 * possible.
1609 * If we ever encounter a non-fatal error, it means
1610 * something went really wrong and we should stop
1611 * immediately.
1613 die(_("unknown error occurred while reading the configuration files"));
1616 static void configset_iter(struct config_set *cs, config_fn_t fn, void *data)
1618 int i, value_index;
1619 struct string_list *values;
1620 struct config_set_element *entry;
1621 struct configset_list *list = &cs->list;
1623 for (i = 0; i < list->nr; i++) {
1624 entry = list->items[i].e;
1625 value_index = list->items[i].value_index;
1626 values = &entry->value_list;
1628 current_config_kvi = values->items[value_index].util;
1630 if (fn(entry->key, values->items[value_index].string, data) < 0)
1631 git_die_config_linenr(entry->key,
1632 current_config_kvi->filename,
1633 current_config_kvi->linenr);
1635 current_config_kvi = NULL;
1639 void read_early_config(config_fn_t cb, void *data)
1641 struct config_options opts = {0};
1642 struct strbuf commondir = STRBUF_INIT;
1643 struct strbuf gitdir = STRBUF_INIT;
1645 opts.respect_includes = 1;
1647 if (have_git_dir())
1648 opts.git_dir = get_git_dir();
1650 * When setup_git_directory() was not yet asked to discover the
1651 * GIT_DIR, we ask discover_git_directory() to figure out whether there
1652 * is any repository config we should use (but unlike
1653 * setup_git_directory_gently(), no global state is changed, most
1654 * notably, the current working directory is still the same after the
1655 * call).
1657 else if (!discover_git_directory(&commondir, &gitdir))
1658 opts.git_dir = gitdir.buf;
1660 git_config_with_options(cb, data, NULL, &opts);
1662 strbuf_release(&commondir);
1663 strbuf_release(&gitdir);
1666 static void git_config_check_init(void);
1668 void git_config(config_fn_t fn, void *data)
1670 git_config_check_init();
1671 configset_iter(&the_config_set, fn, data);
1674 static struct config_set_element *configset_find_element(struct config_set *cs, const char *key)
1676 struct config_set_element k;
1677 struct config_set_element *found_entry;
1678 char *normalized_key;
1680 * `key` may come from the user, so normalize it before using it
1681 * for querying entries from the hashmap.
1683 if (git_config_parse_key(key, &normalized_key, NULL))
1684 return NULL;
1686 hashmap_entry_init(&k, strhash(normalized_key));
1687 k.key = normalized_key;
1688 found_entry = hashmap_get(&cs->config_hash, &k, NULL);
1689 free(normalized_key);
1690 return found_entry;
1693 static int configset_add_value(struct config_set *cs, const char *key, const char *value)
1695 struct config_set_element *e;
1696 struct string_list_item *si;
1697 struct configset_list_item *l_item;
1698 struct key_value_info *kv_info = xmalloc(sizeof(*kv_info));
1700 e = configset_find_element(cs, key);
1702 * Since the keys are being fed by git_config*() callback mechanism, they
1703 * are already normalized. So simply add them without any further munging.
1705 if (!e) {
1706 e = xmalloc(sizeof(*e));
1707 hashmap_entry_init(e, strhash(key));
1708 e->key = xstrdup(key);
1709 string_list_init(&e->value_list, 1);
1710 hashmap_add(&cs->config_hash, e);
1712 si = string_list_append_nodup(&e->value_list, xstrdup_or_null(value));
1714 ALLOC_GROW(cs->list.items, cs->list.nr + 1, cs->list.alloc);
1715 l_item = &cs->list.items[cs->list.nr++];
1716 l_item->e = e;
1717 l_item->value_index = e->value_list.nr - 1;
1719 if (!cf)
1720 die("BUG: configset_add_value has no source");
1721 if (cf->name) {
1722 kv_info->filename = strintern(cf->name);
1723 kv_info->linenr = cf->linenr;
1724 kv_info->origin_type = cf->origin_type;
1725 } else {
1726 /* for values read from `git_config_from_parameters()` */
1727 kv_info->filename = NULL;
1728 kv_info->linenr = -1;
1729 kv_info->origin_type = CONFIG_ORIGIN_CMDLINE;
1731 kv_info->scope = current_parsing_scope;
1732 si->util = kv_info;
1734 return 0;
1737 static int config_set_element_cmp(const struct config_set_element *e1,
1738 const struct config_set_element *e2, const void *unused)
1740 return strcmp(e1->key, e2->key);
1743 void git_configset_init(struct config_set *cs)
1745 hashmap_init(&cs->config_hash, (hashmap_cmp_fn)config_set_element_cmp, 0);
1746 cs->hash_initialized = 1;
1747 cs->list.nr = 0;
1748 cs->list.alloc = 0;
1749 cs->list.items = NULL;
1752 void git_configset_clear(struct config_set *cs)
1754 struct config_set_element *entry;
1755 struct hashmap_iter iter;
1756 if (!cs->hash_initialized)
1757 return;
1759 hashmap_iter_init(&cs->config_hash, &iter);
1760 while ((entry = hashmap_iter_next(&iter))) {
1761 free(entry->key);
1762 string_list_clear(&entry->value_list, 1);
1764 hashmap_free(&cs->config_hash, 1);
1765 cs->hash_initialized = 0;
1766 free(cs->list.items);
1767 cs->list.nr = 0;
1768 cs->list.alloc = 0;
1769 cs->list.items = NULL;
1772 static int config_set_callback(const char *key, const char *value, void *cb)
1774 struct config_set *cs = cb;
1775 configset_add_value(cs, key, value);
1776 return 0;
1779 int git_configset_add_file(struct config_set *cs, const char *filename)
1781 return git_config_from_file(config_set_callback, filename, cs);
1784 int git_configset_get_value(struct config_set *cs, const char *key, const char **value)
1786 const struct string_list *values = NULL;
1788 * Follows "last one wins" semantic, i.e., if there are multiple matches for the
1789 * queried key in the files of the configset, the value returned will be the last
1790 * value in the value list for that key.
1792 values = git_configset_get_value_multi(cs, key);
1794 if (!values)
1795 return 1;
1796 assert(values->nr > 0);
1797 *value = values->items[values->nr - 1].string;
1798 return 0;
1801 const struct string_list *git_configset_get_value_multi(struct config_set *cs, const char *key)
1803 struct config_set_element *e = configset_find_element(cs, key);
1804 return e ? &e->value_list : NULL;
1807 int git_configset_get_string_const(struct config_set *cs, const char *key, const char **dest)
1809 const char *value;
1810 if (!git_configset_get_value(cs, key, &value))
1811 return git_config_string(dest, key, value);
1812 else
1813 return 1;
1816 int git_configset_get_string(struct config_set *cs, const char *key, char **dest)
1818 return git_configset_get_string_const(cs, key, (const char **)dest);
1821 int git_configset_get_int(struct config_set *cs, const char *key, int *dest)
1823 const char *value;
1824 if (!git_configset_get_value(cs, key, &value)) {
1825 *dest = git_config_int(key, value);
1826 return 0;
1827 } else
1828 return 1;
1831 int git_configset_get_ulong(struct config_set *cs, const char *key, unsigned long *dest)
1833 const char *value;
1834 if (!git_configset_get_value(cs, key, &value)) {
1835 *dest = git_config_ulong(key, value);
1836 return 0;
1837 } else
1838 return 1;
1841 int git_configset_get_bool(struct config_set *cs, const char *key, int *dest)
1843 const char *value;
1844 if (!git_configset_get_value(cs, key, &value)) {
1845 *dest = git_config_bool(key, value);
1846 return 0;
1847 } else
1848 return 1;
1851 int git_configset_get_bool_or_int(struct config_set *cs, const char *key,
1852 int *is_bool, int *dest)
1854 const char *value;
1855 if (!git_configset_get_value(cs, key, &value)) {
1856 *dest = git_config_bool_or_int(key, value, is_bool);
1857 return 0;
1858 } else
1859 return 1;
1862 int git_configset_get_maybe_bool(struct config_set *cs, const char *key, int *dest)
1864 const char *value;
1865 if (!git_configset_get_value(cs, key, &value)) {
1866 *dest = git_config_maybe_bool(key, value);
1867 if (*dest == -1)
1868 return -1;
1869 return 0;
1870 } else
1871 return 1;
1874 int git_configset_get_pathname(struct config_set *cs, const char *key, const char **dest)
1876 const char *value;
1877 if (!git_configset_get_value(cs, key, &value))
1878 return git_config_pathname(dest, key, value);
1879 else
1880 return 1;
1883 static void git_config_check_init(void)
1885 if (the_config_set.hash_initialized)
1886 return;
1887 git_configset_init(&the_config_set);
1888 git_config_raw(config_set_callback, &the_config_set);
1891 void git_config_clear(void)
1893 if (!the_config_set.hash_initialized)
1894 return;
1895 git_configset_clear(&the_config_set);
1898 int git_config_get_value(const char *key, const char **value)
1900 git_config_check_init();
1901 return git_configset_get_value(&the_config_set, key, value);
1904 const struct string_list *git_config_get_value_multi(const char *key)
1906 git_config_check_init();
1907 return git_configset_get_value_multi(&the_config_set, key);
1910 int git_config_get_string_const(const char *key, const char **dest)
1912 int ret;
1913 git_config_check_init();
1914 ret = git_configset_get_string_const(&the_config_set, key, dest);
1915 if (ret < 0)
1916 git_die_config(key, NULL);
1917 return ret;
1920 int git_config_get_string(const char *key, char **dest)
1922 git_config_check_init();
1923 return git_config_get_string_const(key, (const char **)dest);
1926 int git_config_get_int(const char *key, int *dest)
1928 git_config_check_init();
1929 return git_configset_get_int(&the_config_set, key, dest);
1932 int git_config_get_ulong(const char *key, unsigned long *dest)
1934 git_config_check_init();
1935 return git_configset_get_ulong(&the_config_set, key, dest);
1938 int git_config_get_bool(const char *key, int *dest)
1940 git_config_check_init();
1941 return git_configset_get_bool(&the_config_set, key, dest);
1944 int git_config_get_bool_or_int(const char *key, int *is_bool, int *dest)
1946 git_config_check_init();
1947 return git_configset_get_bool_or_int(&the_config_set, key, is_bool, dest);
1950 int git_config_get_maybe_bool(const char *key, int *dest)
1952 git_config_check_init();
1953 return git_configset_get_maybe_bool(&the_config_set, key, dest);
1956 int git_config_get_pathname(const char *key, const char **dest)
1958 int ret;
1959 git_config_check_init();
1960 ret = git_configset_get_pathname(&the_config_set, key, dest);
1961 if (ret < 0)
1962 git_die_config(key, NULL);
1963 return ret;
1966 int git_config_get_expiry(const char *key, const char **output)
1968 int ret = git_config_get_string_const(key, output);
1969 if (ret)
1970 return ret;
1971 if (strcmp(*output, "now")) {
1972 unsigned long now = approxidate("now");
1973 if (approxidate(*output) >= now)
1974 git_die_config(key, _("Invalid %s: '%s'"), key, *output);
1976 return ret;
1979 int git_config_get_untracked_cache(void)
1981 int val = -1;
1982 const char *v;
1984 /* Hack for test programs like test-dump-untracked-cache */
1985 if (ignore_untracked_cache_config)
1986 return -1;
1988 if (!git_config_get_maybe_bool("core.untrackedcache", &val))
1989 return val;
1991 if (!git_config_get_value("core.untrackedcache", &v)) {
1992 if (!strcasecmp(v, "keep"))
1993 return -1;
1995 error(_("unknown core.untrackedCache value '%s'; "
1996 "using 'keep' default value"), v);
1997 return -1;
2000 return -1; /* default value */
2003 int git_config_get_split_index(void)
2005 int val;
2007 if (!git_config_get_maybe_bool("core.splitindex", &val))
2008 return val;
2010 return -1; /* default value */
2013 int git_config_get_max_percent_split_change(void)
2015 int val = -1;
2017 if (!git_config_get_int("splitindex.maxpercentchange", &val)) {
2018 if (0 <= val && val <= 100)
2019 return val;
2021 return error(_("splitIndex.maxPercentChange value '%d' "
2022 "should be between 0 and 100"), val);
2025 return -1; /* default value */
2028 NORETURN
2029 void git_die_config_linenr(const char *key, const char *filename, int linenr)
2031 if (!filename)
2032 die(_("unable to parse '%s' from command-line config"), key);
2033 else
2034 die(_("bad config variable '%s' in file '%s' at line %d"),
2035 key, filename, linenr);
2038 NORETURN __attribute__((format(printf, 2, 3)))
2039 void git_die_config(const char *key, const char *err, ...)
2041 const struct string_list *values;
2042 struct key_value_info *kv_info;
2044 if (err) {
2045 va_list params;
2046 va_start(params, err);
2047 vreportf("error: ", err, params);
2048 va_end(params);
2050 values = git_config_get_value_multi(key);
2051 kv_info = values->items[values->nr - 1].util;
2052 git_die_config_linenr(key, kv_info->filename, kv_info->linenr);
2056 * Find all the stuff for git_config_set() below.
2059 static struct {
2060 int baselen;
2061 char *key;
2062 int do_not_match;
2063 regex_t *value_regex;
2064 int multi_replace;
2065 size_t *offset;
2066 unsigned int offset_alloc;
2067 enum { START, SECTION_SEEN, SECTION_END_SEEN, KEY_SEEN } state;
2068 int seen;
2069 } store;
2071 static int matches(const char *key, const char *value)
2073 if (strcmp(key, store.key))
2074 return 0; /* not ours */
2075 if (!store.value_regex)
2076 return 1; /* always matches */
2077 if (store.value_regex == CONFIG_REGEX_NONE)
2078 return 0; /* never matches */
2080 return store.do_not_match ^
2081 (value && !regexec(store.value_regex, value, 0, NULL, 0));
2084 static int store_aux(const char *key, const char *value, void *cb)
2086 const char *ep;
2087 size_t section_len;
2089 switch (store.state) {
2090 case KEY_SEEN:
2091 if (matches(key, value)) {
2092 if (store.seen == 1 && store.multi_replace == 0) {
2093 warning(_("%s has multiple values"), key);
2096 ALLOC_GROW(store.offset, store.seen + 1,
2097 store.offset_alloc);
2099 store.offset[store.seen] = cf->do_ftell(cf);
2100 store.seen++;
2102 break;
2103 case SECTION_SEEN:
2105 * What we are looking for is in store.key (both
2106 * section and var), and its section part is baselen
2107 * long. We found key (again, both section and var).
2108 * We would want to know if this key is in the same
2109 * section as what we are looking for. We already
2110 * know we are in the same section as what should
2111 * hold store.key.
2113 ep = strrchr(key, '.');
2114 section_len = ep - key;
2116 if ((section_len != store.baselen) ||
2117 memcmp(key, store.key, section_len+1)) {
2118 store.state = SECTION_END_SEEN;
2119 break;
2123 * Do not increment matches: this is no match, but we
2124 * just made sure we are in the desired section.
2126 ALLOC_GROW(store.offset, store.seen + 1,
2127 store.offset_alloc);
2128 store.offset[store.seen] = cf->do_ftell(cf);
2129 /* fallthru */
2130 case SECTION_END_SEEN:
2131 case START:
2132 if (matches(key, value)) {
2133 ALLOC_GROW(store.offset, store.seen + 1,
2134 store.offset_alloc);
2135 store.offset[store.seen] = cf->do_ftell(cf);
2136 store.state = KEY_SEEN;
2137 store.seen++;
2138 } else {
2139 if (strrchr(key, '.') - key == store.baselen &&
2140 !strncmp(key, store.key, store.baselen)) {
2141 store.state = SECTION_SEEN;
2142 ALLOC_GROW(store.offset,
2143 store.seen + 1,
2144 store.offset_alloc);
2145 store.offset[store.seen] = cf->do_ftell(cf);
2149 return 0;
2152 static int write_error(const char *filename)
2154 error("failed to write new configuration file %s", filename);
2156 /* Same error code as "failed to rename". */
2157 return 4;
2160 static int store_write_section(int fd, const char *key)
2162 const char *dot;
2163 int i, success;
2164 struct strbuf sb = STRBUF_INIT;
2166 dot = memchr(key, '.', store.baselen);
2167 if (dot) {
2168 strbuf_addf(&sb, "[%.*s \"", (int)(dot - key), key);
2169 for (i = dot - key + 1; i < store.baselen; i++) {
2170 if (key[i] == '"' || key[i] == '\\')
2171 strbuf_addch(&sb, '\\');
2172 strbuf_addch(&sb, key[i]);
2174 strbuf_addstr(&sb, "\"]\n");
2175 } else {
2176 strbuf_addf(&sb, "[%.*s]\n", store.baselen, key);
2179 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2180 strbuf_release(&sb);
2182 return success;
2185 static int store_write_pair(int fd, const char *key, const char *value)
2187 int i, success;
2188 int length = strlen(key + store.baselen + 1);
2189 const char *quote = "";
2190 struct strbuf sb = STRBUF_INIT;
2193 * Check to see if the value needs to be surrounded with a dq pair.
2194 * Note that problematic characters are always backslash-quoted; this
2195 * check is about not losing leading or trailing SP and strings that
2196 * follow beginning-of-comment characters (i.e. ';' and '#') by the
2197 * configuration parser.
2199 if (value[0] == ' ')
2200 quote = "\"";
2201 for (i = 0; value[i]; i++)
2202 if (value[i] == ';' || value[i] == '#')
2203 quote = "\"";
2204 if (i && value[i - 1] == ' ')
2205 quote = "\"";
2207 strbuf_addf(&sb, "\t%.*s = %s",
2208 length, key + store.baselen + 1, quote);
2210 for (i = 0; value[i]; i++)
2211 switch (value[i]) {
2212 case '\n':
2213 strbuf_addstr(&sb, "\\n");
2214 break;
2215 case '\t':
2216 strbuf_addstr(&sb, "\\t");
2217 break;
2218 case '"':
2219 case '\\':
2220 strbuf_addch(&sb, '\\');
2221 default:
2222 strbuf_addch(&sb, value[i]);
2223 break;
2225 strbuf_addf(&sb, "%s\n", quote);
2227 success = write_in_full(fd, sb.buf, sb.len) == sb.len;
2228 strbuf_release(&sb);
2230 return success;
2233 static ssize_t find_beginning_of_line(const char *contents, size_t size,
2234 size_t offset_, int *found_bracket)
2236 size_t equal_offset = size, bracket_offset = size;
2237 ssize_t offset;
2239 contline:
2240 for (offset = offset_-2; offset > 0
2241 && contents[offset] != '\n'; offset--)
2242 switch (contents[offset]) {
2243 case '=': equal_offset = offset; break;
2244 case ']': bracket_offset = offset; break;
2246 if (offset > 0 && contents[offset-1] == '\\') {
2247 offset_ = offset;
2248 goto contline;
2250 if (bracket_offset < equal_offset) {
2251 *found_bracket = 1;
2252 offset = bracket_offset+1;
2253 } else
2254 offset++;
2256 return offset;
2259 int git_config_set_in_file_gently(const char *config_filename,
2260 const char *key, const char *value)
2262 return git_config_set_multivar_in_file_gently(config_filename, key, value, NULL, 0);
2265 void git_config_set_in_file(const char *config_filename,
2266 const char *key, const char *value)
2268 git_config_set_multivar_in_file(config_filename, key, value, NULL, 0);
2271 int git_config_set_gently(const char *key, const char *value)
2273 return git_config_set_multivar_gently(key, value, NULL, 0);
2276 void git_config_set(const char *key, const char *value)
2278 git_config_set_multivar(key, value, NULL, 0);
2282 * If value==NULL, unset in (remove from) config,
2283 * if value_regex!=NULL, disregard key/value pairs where value does not match.
2284 * if value_regex==CONFIG_REGEX_NONE, do not match any existing values
2285 * (only add a new one)
2286 * if multi_replace==0, nothing, or only one matching key/value is replaced,
2287 * else all matching key/values (regardless how many) are removed,
2288 * before the new pair is written.
2290 * Returns 0 on success.
2292 * This function does this:
2294 * - it locks the config file by creating ".git/config.lock"
2296 * - it then parses the config using store_aux() as validator to find
2297 * the position on the key/value pair to replace. If it is to be unset,
2298 * it must be found exactly once.
2300 * - the config file is mmap()ed and the part before the match (if any) is
2301 * written to the lock file, then the changed part and the rest.
2303 * - the config file is removed and the lock file rename()d to it.
2306 int git_config_set_multivar_in_file_gently(const char *config_filename,
2307 const char *key, const char *value,
2308 const char *value_regex,
2309 int multi_replace)
2311 int fd = -1, in_fd = -1;
2312 int ret;
2313 struct lock_file *lock = NULL;
2314 char *filename_buf = NULL;
2315 char *contents = NULL;
2316 size_t contents_sz;
2318 /* parse-key returns negative; flip the sign to feed exit(3) */
2319 ret = 0 - git_config_parse_key(key, &store.key, &store.baselen);
2320 if (ret)
2321 goto out_free;
2323 store.multi_replace = multi_replace;
2325 if (!config_filename)
2326 config_filename = filename_buf = git_pathdup("config");
2329 * The lock serves a purpose in addition to locking: the new
2330 * contents of .git/config will be written into it.
2332 lock = xcalloc(1, sizeof(struct lock_file));
2333 fd = hold_lock_file_for_update(lock, config_filename, 0);
2334 if (fd < 0) {
2335 error_errno("could not lock config file %s", config_filename);
2336 free(store.key);
2337 ret = CONFIG_NO_LOCK;
2338 goto out_free;
2342 * If .git/config does not exist yet, write a minimal version.
2344 in_fd = open(config_filename, O_RDONLY);
2345 if ( in_fd < 0 ) {
2346 free(store.key);
2348 if ( ENOENT != errno ) {
2349 error_errno("opening %s", config_filename);
2350 ret = CONFIG_INVALID_FILE; /* same as "invalid config file" */
2351 goto out_free;
2353 /* if nothing to unset, error out */
2354 if (value == NULL) {
2355 ret = CONFIG_NOTHING_SET;
2356 goto out_free;
2359 store.key = (char *)key;
2360 if (!store_write_section(fd, key) ||
2361 !store_write_pair(fd, key, value))
2362 goto write_err_out;
2363 } else {
2364 struct stat st;
2365 size_t copy_begin, copy_end;
2366 int i, new_line = 0;
2368 if (value_regex == NULL)
2369 store.value_regex = NULL;
2370 else if (value_regex == CONFIG_REGEX_NONE)
2371 store.value_regex = CONFIG_REGEX_NONE;
2372 else {
2373 if (value_regex[0] == '!') {
2374 store.do_not_match = 1;
2375 value_regex++;
2376 } else
2377 store.do_not_match = 0;
2379 store.value_regex = (regex_t*)xmalloc(sizeof(regex_t));
2380 if (regcomp(store.value_regex, value_regex,
2381 REG_EXTENDED)) {
2382 error("invalid pattern: %s", value_regex);
2383 free(store.value_regex);
2384 ret = CONFIG_INVALID_PATTERN;
2385 goto out_free;
2389 ALLOC_GROW(store.offset, 1, store.offset_alloc);
2390 store.offset[0] = 0;
2391 store.state = START;
2392 store.seen = 0;
2395 * After this, store.offset will contain the *end* offset
2396 * of the last match, or remain at 0 if no match was found.
2397 * As a side effect, we make sure to transform only a valid
2398 * existing config file.
2400 if (git_config_from_file(store_aux, config_filename, NULL)) {
2401 error("invalid config file %s", config_filename);
2402 free(store.key);
2403 if (store.value_regex != NULL &&
2404 store.value_regex != CONFIG_REGEX_NONE) {
2405 regfree(store.value_regex);
2406 free(store.value_regex);
2408 ret = CONFIG_INVALID_FILE;
2409 goto out_free;
2412 free(store.key);
2413 if (store.value_regex != NULL &&
2414 store.value_regex != CONFIG_REGEX_NONE) {
2415 regfree(store.value_regex);
2416 free(store.value_regex);
2419 /* if nothing to unset, or too many matches, error out */
2420 if ((store.seen == 0 && value == NULL) ||
2421 (store.seen > 1 && multi_replace == 0)) {
2422 ret = CONFIG_NOTHING_SET;
2423 goto out_free;
2426 if (fstat(in_fd, &st) == -1) {
2427 error_errno(_("fstat on %s failed"), config_filename);
2428 ret = CONFIG_INVALID_FILE;
2429 goto out_free;
2432 contents_sz = xsize_t(st.st_size);
2433 contents = xmmap_gently(NULL, contents_sz, PROT_READ,
2434 MAP_PRIVATE, in_fd, 0);
2435 if (contents == MAP_FAILED) {
2436 if (errno == ENODEV && S_ISDIR(st.st_mode))
2437 errno = EISDIR;
2438 error_errno("unable to mmap '%s'", config_filename);
2439 ret = CONFIG_INVALID_FILE;
2440 contents = NULL;
2441 goto out_free;
2443 close(in_fd);
2444 in_fd = -1;
2446 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2447 error_errno("chmod on %s failed", get_lock_file_path(lock));
2448 ret = CONFIG_NO_WRITE;
2449 goto out_free;
2452 if (store.seen == 0)
2453 store.seen = 1;
2455 for (i = 0, copy_begin = 0; i < store.seen; i++) {
2456 if (store.offset[i] == 0) {
2457 store.offset[i] = copy_end = contents_sz;
2458 } else if (store.state != KEY_SEEN) {
2459 copy_end = store.offset[i];
2460 } else
2461 copy_end = find_beginning_of_line(
2462 contents, contents_sz,
2463 store.offset[i]-2, &new_line);
2465 if (copy_end > 0 && contents[copy_end-1] != '\n')
2466 new_line = 1;
2468 /* write the first part of the config */
2469 if (copy_end > copy_begin) {
2470 if (write_in_full(fd, contents + copy_begin,
2471 copy_end - copy_begin) <
2472 copy_end - copy_begin)
2473 goto write_err_out;
2474 if (new_line &&
2475 write_str_in_full(fd, "\n") != 1)
2476 goto write_err_out;
2478 copy_begin = store.offset[i];
2481 /* write the pair (value == NULL means unset) */
2482 if (value != NULL) {
2483 if (store.state == START) {
2484 if (!store_write_section(fd, key))
2485 goto write_err_out;
2487 if (!store_write_pair(fd, key, value))
2488 goto write_err_out;
2491 /* write the rest of the config */
2492 if (copy_begin < contents_sz)
2493 if (write_in_full(fd, contents + copy_begin,
2494 contents_sz - copy_begin) <
2495 contents_sz - copy_begin)
2496 goto write_err_out;
2498 munmap(contents, contents_sz);
2499 contents = NULL;
2502 if (commit_lock_file(lock) < 0) {
2503 error_errno("could not write config file %s", config_filename);
2504 ret = CONFIG_NO_WRITE;
2505 lock = NULL;
2506 goto out_free;
2510 * lock is committed, so don't try to roll it back below.
2511 * NOTE: Since lockfile.c keeps a linked list of all created
2512 * lock_file structures, it isn't safe to free(lock). It's
2513 * better to just leave it hanging around.
2515 lock = NULL;
2516 ret = 0;
2518 /* Invalidate the config cache */
2519 git_config_clear();
2521 out_free:
2522 if (lock)
2523 rollback_lock_file(lock);
2524 free(filename_buf);
2525 if (contents)
2526 munmap(contents, contents_sz);
2527 if (in_fd >= 0)
2528 close(in_fd);
2529 return ret;
2531 write_err_out:
2532 ret = write_error(get_lock_file_path(lock));
2533 goto out_free;
2537 void git_config_set_multivar_in_file(const char *config_filename,
2538 const char *key, const char *value,
2539 const char *value_regex, int multi_replace)
2541 if (!git_config_set_multivar_in_file_gently(config_filename, key, value,
2542 value_regex, multi_replace))
2543 return;
2544 if (value)
2545 die(_("could not set '%s' to '%s'"), key, value);
2546 else
2547 die(_("could not unset '%s'"), key);
2550 int git_config_set_multivar_gently(const char *key, const char *value,
2551 const char *value_regex, int multi_replace)
2553 return git_config_set_multivar_in_file_gently(NULL, key, value, value_regex,
2554 multi_replace);
2557 void git_config_set_multivar(const char *key, const char *value,
2558 const char *value_regex, int multi_replace)
2560 git_config_set_multivar_in_file(NULL, key, value, value_regex,
2561 multi_replace);
2564 static int section_name_match (const char *buf, const char *name)
2566 int i = 0, j = 0, dot = 0;
2567 if (buf[i] != '[')
2568 return 0;
2569 for (i = 1; buf[i] && buf[i] != ']'; i++) {
2570 if (!dot && isspace(buf[i])) {
2571 dot = 1;
2572 if (name[j++] != '.')
2573 break;
2574 for (i++; isspace(buf[i]); i++)
2575 ; /* do nothing */
2576 if (buf[i] != '"')
2577 break;
2578 continue;
2580 if (buf[i] == '\\' && dot)
2581 i++;
2582 else if (buf[i] == '"' && dot) {
2583 for (i++; isspace(buf[i]); i++)
2584 ; /* do_nothing */
2585 break;
2587 if (buf[i] != name[j++])
2588 break;
2590 if (buf[i] == ']' && name[j] == 0) {
2592 * We match, now just find the right length offset by
2593 * gobbling up any whitespace after it, as well
2595 i++;
2596 for (; buf[i] && isspace(buf[i]); i++)
2597 ; /* do nothing */
2598 return i;
2600 return 0;
2603 static int section_name_is_ok(const char *name)
2605 /* Empty section names are bogus. */
2606 if (!*name)
2607 return 0;
2610 * Before a dot, we must be alphanumeric or dash. After the first dot,
2611 * anything goes, so we can stop checking.
2613 for (; *name && *name != '.'; name++)
2614 if (*name != '-' && !isalnum(*name))
2615 return 0;
2616 return 1;
2619 /* if new_name == NULL, the section is removed instead */
2620 int git_config_rename_section_in_file(const char *config_filename,
2621 const char *old_name, const char *new_name)
2623 int ret = 0, remove = 0;
2624 char *filename_buf = NULL;
2625 struct lock_file *lock;
2626 int out_fd;
2627 char buf[1024];
2628 FILE *config_file;
2629 struct stat st;
2631 if (new_name && !section_name_is_ok(new_name)) {
2632 ret = error("invalid section name: %s", new_name);
2633 goto out_no_rollback;
2636 if (!config_filename)
2637 config_filename = filename_buf = git_pathdup("config");
2639 lock = xcalloc(1, sizeof(struct lock_file));
2640 out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2641 if (out_fd < 0) {
2642 ret = error("could not lock config file %s", config_filename);
2643 goto out;
2646 if (!(config_file = fopen(config_filename, "rb"))) {
2647 /* no config file means nothing to rename, no error */
2648 goto commit_and_out;
2651 if (fstat(fileno(config_file), &st) == -1) {
2652 ret = error_errno(_("fstat on %s failed"), config_filename);
2653 goto out;
2656 if (chmod(get_lock_file_path(lock), st.st_mode & 07777) < 0) {
2657 ret = error_errno("chmod on %s failed",
2658 get_lock_file_path(lock));
2659 goto out;
2662 while (fgets(buf, sizeof(buf), config_file)) {
2663 int i;
2664 int length;
2665 char *output = buf;
2666 for (i = 0; buf[i] && isspace(buf[i]); i++)
2667 ; /* do nothing */
2668 if (buf[i] == '[') {
2669 /* it's a section */
2670 int offset = section_name_match(&buf[i], old_name);
2671 if (offset > 0) {
2672 ret++;
2673 if (new_name == NULL) {
2674 remove = 1;
2675 continue;
2677 store.baselen = strlen(new_name);
2678 if (!store_write_section(out_fd, new_name)) {
2679 ret = write_error(get_lock_file_path(lock));
2680 goto out;
2683 * We wrote out the new section, with
2684 * a newline, now skip the old
2685 * section's length
2687 output += offset + i;
2688 if (strlen(output) > 0) {
2690 * More content means there's
2691 * a declaration to put on the
2692 * next line; indent with a
2693 * tab
2695 output -= 1;
2696 output[0] = '\t';
2699 remove = 0;
2701 if (remove)
2702 continue;
2703 length = strlen(output);
2704 if (write_in_full(out_fd, output, length) != length) {
2705 ret = write_error(get_lock_file_path(lock));
2706 goto out;
2709 fclose(config_file);
2710 commit_and_out:
2711 if (commit_lock_file(lock) < 0)
2712 ret = error_errno("could not write config file %s",
2713 config_filename);
2714 out:
2715 rollback_lock_file(lock);
2716 out_no_rollback:
2717 free(filename_buf);
2718 return ret;
2721 int git_config_rename_section(const char *old_name, const char *new_name)
2723 return git_config_rename_section_in_file(NULL, old_name, new_name);
2727 * Call this to report error for your variable that should not
2728 * get a boolean value (i.e. "[my] var" means "true").
2730 #undef config_error_nonbool
2731 int config_error_nonbool(const char *var)
2733 return error("missing value for '%s'", var);
2736 int parse_config_key(const char *var,
2737 const char *section,
2738 const char **subsection, int *subsection_len,
2739 const char **key)
2741 const char *dot;
2743 /* Does it start with "section." ? */
2744 if (!skip_prefix(var, section, &var) || *var != '.')
2745 return -1;
2748 * Find the key; we don't know yet if we have a subsection, but we must
2749 * parse backwards from the end, since the subsection may have dots in
2750 * it, too.
2752 dot = strrchr(var, '.');
2753 *key = dot + 1;
2755 /* Did we have a subsection at all? */
2756 if (dot == var) {
2757 if (subsection) {
2758 *subsection = NULL;
2759 *subsection_len = 0;
2762 else {
2763 if (!subsection)
2764 return -1;
2765 *subsection = var + 1;
2766 *subsection_len = dot - *subsection;
2769 return 0;
2772 const char *current_config_origin_type(void)
2774 int type;
2775 if (current_config_kvi)
2776 type = current_config_kvi->origin_type;
2777 else if(cf)
2778 type = cf->origin_type;
2779 else
2780 die("BUG: current_config_origin_type called outside config callback");
2782 switch (type) {
2783 case CONFIG_ORIGIN_BLOB:
2784 return "blob";
2785 case CONFIG_ORIGIN_FILE:
2786 return "file";
2787 case CONFIG_ORIGIN_STDIN:
2788 return "standard input";
2789 case CONFIG_ORIGIN_SUBMODULE_BLOB:
2790 return "submodule-blob";
2791 case CONFIG_ORIGIN_CMDLINE:
2792 return "command line";
2793 default:
2794 die("BUG: unknown config origin type");
2798 const char *current_config_name(void)
2800 const char *name;
2801 if (current_config_kvi)
2802 name = current_config_kvi->filename;
2803 else if (cf)
2804 name = cf->name;
2805 else
2806 die("BUG: current_config_name called outside config callback");
2807 return name ? name : "";
2810 enum config_scope current_config_scope(void)
2812 if (current_config_kvi)
2813 return current_config_kvi->scope;
2814 else
2815 return current_parsing_scope;